Configuring custom synonym files in AEM as a Cloud Service Simplified Index Management

✨ This content is AI generated and could be inaccurate. Generative AI Terms

This article explains how to configure custom synonym files for indexes when migrating to Simplified Index Management in Adobe Experience Manager as a Cloud Service.

Description description

Environment

Adobe Experience Manager as a Cloud Service (all versions)

Symptoms

When migrating custom indexes to Simplified Index Management in AEM as a Cloud Service, there is a need to support a custom synonym file within an index analyzer configuration. The official documentation does not clearly state whether custom synonym files are supported or how to implement them. There are no specific error messages; the issue is related to configuration clarity.

Resolution resolution

Follow the steps below to resolve the issue:

  1. In the index definition’s analyzers → default → filters section, embed the synonym file using a structure similar to the following:
  • Define the synonym filter with a synonyms property referencing the file name (e.g., synonym.txt).

  • Add a synonym.txtnode with the following properties:

    • jcr:primaryType: nt:file
    • jcr:content:
    • jcr:primaryType: nt:resource
    • jcr:mimeType: text/plain
    • jcr:data: The synonym list in plain text format (e.g., car, automobile\n).
  1. The jcr:data property should contain the synonym list in plain text format. You may encode the content as plain text or base64 as needed.
  2. Save the index configuration and deploy it to AEM as a Cloud Service.
  3. Validate that the synonym filter is applied by testing search queries using the defined synonyms.
recommendation-more-help
experience-cloud-kcs-help-kbarticles