Skip to content

Installing and Deploying Search V2 Authoring

This section provides detailed instructions for manually installing and deploying the Search V2 Authoring application.

Note

Starting from HCL Digital Experience (DX) 9.5 CF227, Search V2 Authoring can be enabled for container-based deployments.

Packaging, installing, and deploying design

Search V2 Authoring is a search integration portlet configured to load static assets such as JavaScript, stylesheets, and HTML markup. It is located above the existing Authoring portlet on the same Authoring page. You can enable or disable it using ConfigEngine tasks for container-based deployments. The enable task deploys and configures the portlet, creates the HTTP outbound proxy policy to allow DX to fetch the assets, then deploys the page.

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

Important

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

Enabling and disabling Search V2 Authoring

This section describes how to enable and disable Search V2 Authoring manually.

The enable-search-v2 config 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 Authoring, you need to enable Practitioner Studio. For more information on how to enable Practitioner Studio, refer to How to enable 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 Authoring using a ConfigEngine task

To enable Search V2 Authoring manually, run the enable-search-v2 config 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.wcm.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.wcm.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.wcm.version=2 -Dsearch.middleware.ui.uri=http://{search.middleware.ui.uri}/dx/ui/search

Important

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

Enabling Search V2 Authoring through Helm deployment

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

# 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 which search is used in wcm authoring
        wcmVersion: "v2"

Disabling Search V2 Authoring using a Config Engine task

To disable Search V2 Authoring manually, run the disable-search-v2 config 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 Authoring using the disable-search-v2 config task, the pre-existing Authoring page is retained, only the Search V2 Authoring header and markup are removed from the same page. To re-enable Search V2 Authoring, execute the enable-search-v2 config task again.

Disabling Search V2 Authoring through Helm deployment

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

# 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 which search is used in wcm authoring
        wcmVersion: "v1"