Defining and Working with Synonyms

Use the Synonym Definitions page to specify and manage synonyms for your terms.

Prerequisites

To work in the Synonym Definitions you need Read and Update rights to Synonym Dictionary. By default, Admin roles already have the rights.

Context

To help users with their queries in Search to Insight you can define synonyms for measure and dimension names in your searchable data. These synonyms can in turn be used when querying for insights. The synonyms will be suggested in the search field auto complete, and in be part of consequent results and visualizations if used in a query.

Procedure

Defining Synonyms

  1. Go to Start of the navigation path (Main Menu) Next navigation step  System Next navigation step Administration Next navigation step Synonym DefinitionsEnd of the navigation path

    The Synonym Definitions page is displayed.

  2. Select + New Term.
    An entry field is created under the General Synonyms list.
  3. Under Terms type the name of the term for which you want to define synonyms.
  4. Under Synonyms type the alternate name(s) (synonyms) of the term specified in Step 3.
    Note
    A term can have multiple synonyms.
  5. Repeat steps 2-4 for all your terms. When ready select (Save).

    The terms and corresponding synonyms are saved in the system.

    Using the term Income Statement in the above image as an example, the synonym inc stmt will be suggested and used as an alternate term when entering a query in Search to Insight:

    If a synonym is used to generate a search result, you can hover the synonym within the result title to display information on the target term as used in the data source.

    The steps below are for maintaining the Synonym Definitions page.

  6. To delete terms, select the entries for terms you want to delete, Choose (Delete) from the toolbar.
  7. Select the Deploy Synonym Definitions icon to choose one of the following:
    • Import File: to import a CSV file containing terms and corresponding synonyms.
    • Export File: to export a CSV file of your current synonym definitions for deployment in another system.
    Currently these are the limitations to working with synonyms:
    • A system cannot support more than 10,000 term-synonym pairs.
    • The maximum character length for a term and synonym is 100.
    • Currently only a single synonym dictionary per system is supported.
    • Dimension or measures in the chart might use the synonyms from the latest result rather than of the correct synonyms. Note: The dimension and measure names are shown when hovering over a data point in the chart.
Related Information