Installing and configuring Helix Search for Helix DAM

Important

The following information only applies to manual Helix DAM deployment. Do not follow these steps if you are using the automated deployment.

Helix DAM uses Helix Search to search and automatically tag assets.

You must install and configure Helix Search before deploying Helix DAM manually on-premises or in the cloud.

Step 1: Install Helix Search

Follow all installation steps in Install and configure Helix Search in the Helix Core Search Developer Guide.

Important

Do not skip the steps to deploy the Elasticsearch plugin p4search-filter. Helix DAM will not work without it.

When you configure Helix DAM, you need the following information from Helix Search. Note this information during installation for future reference.

  • Helix Search server location
  • User and ticket

Step 2: Configure Helix Search

After installation, configure all Helix Search services. See Configuring Helix Search services in the Helix Core Search Developer Guide.

Make sure the following configurables are set for Helix DAM.

com.perforce.p4search.index.tags=dam_tag,dam_autotag
com.perforce.p4search.index.thumbnail=true

Image auto-tagging

If you want to use auto-tagging for Helix DAM assets, configure it. See Auto-tagging of images in the in the Helix Core Search Developer Guide.

Extension configuration

Enable all extensions. See Extension configuration in the Helix Core Search Developer Guide.

Step 3: Perform the initial index of the Helix Core Server

See Indexing Helix Search in the Helix Core Search Developer Guide.

Indexing the entire Helix Core database can take a long time to complete. When performing the initial index, you should limit indexing based on depot path, user, or changelist number range. Contact Perforce Support for help determining the best way to perform the initial index if you are unsure.

Step 4: Connect Helix DAM to Helix Search

Configure Helix DAM to use data indexed by Helix Search into Elasticsearch. You must have a running Elasticsearch instance and Helix Search configured to connect to the Elasticsearch instance.

Note

Use the Helix TeamHub Admin web UI to configure Helix DAM.

  1. Log in to the Helix TeamHub admin UI. See Logging in to the Helix TeamHub admin UI.

  2. Click Helix DAM.

    The Configure Helix DAM page opens.

  3. In the Helix Search section, verify that Helix Search is configured correctly. The URL should be displayed. Click Status to view the connection status for various components required for Helix Search.

  4. In the Helix DAM configuration for Elasticsearch in Helix Search section, click Configure.

    Helix DAM retrieves the values it needs from Helix Search and they are displayed. Green checkmarks indicate the values match in Helix DAM and Helix Search. The values are also automatically written to the hth.json configuration file. See Helix TeamHub configuration. Click Status to refresh the values.

Tip

Keep in mind that if the Helix Search configuration changes, you need to repeat these steps to update the values in Helix DAM.