Skip to content

Installing and deploying Search V2

This section contains instructions on how to install and deploy the Search V2 application manually.

Note

Starting from HCL Digital Experience (DX) 9.5 CF224, you can enable SearchV2 for container-based deployments.

Packaging, installing, and deploying design

Search V2 is an instance of a search integration portlet configured to point to where the static assets such as Javascript, stylesheets, and HTML markup can be loaded from. You can enable or disable it using ConfigEngine tasks for container-based deployments. The enable task would deploy, configure the portlet, create the http outbound proxy policy so DX can fetch the assets, and then deploy the page.

For container-based Helm deployment, you can configure the deployment values.yaml file to enable Search V2 by default.

Important

Before you can enable Search V2, you need to install Search V2. For more information on how to install this feature, refer to Installing Search V2.

Enabling and disabling Search V2

The enable-search-v2 ConfigEngine task is not automatically executed. You can enable and disable this task by running enable-search-v2 and disable-search-v2 respectively. Once enabled, you can also use it after creating a Virtual Portal.

Important

Before manually enabling Search V2, you need to enable Practitioner Studio. For more information on how to enable Practitioner Studio, refer to Enabling Practitioner Studio.

For more information on how to do container-based Helm deployments, refer to Deploying using Helm.

For more information on how to run ConfigEngine tasks on container deployments, refer to Running DX Core configuration tasks.

Enabling Search V2

Apply the following changes to your installation values.yaml file.

# Application configuration
configuration:
# Application specific configuration for Core
core:
    # Settings for SearchV2 UI configuration
    search:
        # Determines if search ui v2 is enabled or not
        uiV2Enabled: true
        # Determines to which search center any input box on DX redirects by default
        inputRedirectVersion: "v2"

To enable Search V2 manually, run the enable-search-v2 ConfigEngine task. You do not need to stop or restart the Portal when running these tasks.

  • AIX: ./ConfigEngine.sh enable-search-v2 -DWasPassword=<WAS admin password> -DPortalAdminPwd=<Portal admin password> -Dsearch.input.redirect.version=2 -Dsearch.middleware.ui.uri=http://{search.middleware.ui.uri}/dx/ui/search
  • Linux: ./ConfigEngine.sh enable-search-v2 -DWasPassword=<WAS admin password> -DPortalAdminPwd=<Portal admin password> -Dsearch.input.redirect.version=2 -Dsearch.middleware.ui.uri=http://{search.middleware.ui.uri}/dx/ui/search
  • Windows: ConfigEngine.bat enable-search-v2 -DWasPassword=<WAS admin password> -DPortalAdminPwd=<Portal admin password> -Dsearch.input.redirect.version=2 -Dsearch.middleware.ui.uri=http://{search.middleware.ui.uri}/dx/ui/search

Important

Replace the {search.middleware.ui.uri} placeholder with the exact search middleware service name in your deployment. For example: http://dx-search-search-middleware-query:3000.

Disabling Search V2

Apply the following changes to your installation values.yaml to disable Search V2.

# Application configuration
configuration:
# Application specific configuration for Core
core:
    # Settings for SearchV2 UI configuration
    search:
        # Determines if search ui v2 is enabled or not
        uiV2Enabled: false
        # Determines to which search center any input box on DX redirects by default
        inputRedirectVersion: "v1"

To disable Search V2 manually, run the disable-search-v2 ConfigEngine task.

  • AIX: ./ConfigEngine.sh disable-search-v2 -DWasPassword=<WAS admin password> -DPortalAdminPwd=<Portal admin password>
  • Linux: ./ConfigEngine.sh disable-search-v2 -DWasPassword=<WAS admin password> -DPortalAdminPwd=<Portal admin password>
  • Windows: ConfigEngine.bat disable-search-v2 -DWasPassword=<WAS admin password> -DPortalAdminPwd=<Portal admin password>

After disabling Search V2 using the disable-search-v2 ConfigEngine task, the Search V2 page is removed. To re-enable Search V2, execute the enable-search-v2 ConfigEngine task again.