Synonyms Dashboard Operations - Bloomreach Commerce Experience Cloud - The Headless Digital Experience Platform Built for Commerce

Synonyms Dashboard Operations

The Synonyms page in the Dashboard allows you to create or edit your own synonym rules, and view Bloomreach-generated synonym rules. The Synonyms page can be found under Search & Merchandising > Site Search > Synonyms.

Synonyms page

The Synonyms page lists synonym rules in order by the last modified date, with the most recently created or edited synonym rules at the top. There are two tabs: User created/modified, which contains user created/modified synonym rules, and BR Generated, which contains synonym rules automatically generated by Bloomreach. 

View Synonyms

By default, the Synonyms page displays User created/modified synonym rules. You can navigate to the BR Generated tab to view synonym rules automatically generated by Bloomreach. The User column displays the last user who modified the synonym rule, and the Last Modified column displays the last modified date.

Sync status

The sync status is indicated by the dot on the left. Synonym rules are synced once every hour, every day in the production environment.

There are 4 different sync statuses:

  • Green - Synonym rule is live

  • Grey - Synonym rule status has been disabled or expired

  • Yellow - Synonym rule status has not been synced

  • Red - Sync error

Enable or disable Synonyms

Click the switch in the Enable column to change a synonym rule’s status. A white button to the left indicates that the synonym rule is disabled, while a blue switch to the right indicates it is enabled.

Note: If you disable a BR Generated synonym rule, it will be moved to the User Created/Modified tab, and the synonym type will be changed to User Modified. Read the next section for more information about User Modified synonyms.

User Modified Synonyms

Synonym rules that you create or upload are considered to be User Created synonyms. There are also User Modified synonyms, which are BR Generated synonyms that have been edited or disabled.

User Modified synonym rules cannot be deleted, and will be moved back to the BR Generated tab and re-enabled if you attempt to delete them.

BR Generated Synonyms

The BR Generated tab contains synonym rules that were automatically generated by Bloomreach Personalization. 

There are two types of BR Generated synonyms:

  • Universal synonym - Synonym rules that were generated based on user behavior across all Bloomreach customers
  • Site synonym - Synonym rules that were generated based on user behavior of this site/language
Note: Many operations are unavailable or restricted in the BR Generated tab. This will be called out in the relevant sections.

 

Sort

Note: Sort is only available in the User created/modified tab.

You can sort the synonym rules list by Type, Last Edited By (user), or Last Modified date by clicking the respective column name. Click the column name once to sort in ascending order, and click twice to sort in descending order. By default, the synonym rules list is sorted by Last Modified in descending order (latest modified at the top).

The screenshots below show an example of sorting by Last Modified date in ascending order.

Search

You can search for specific synonym rules by submitting a query in the search box. You can select the search type from the dropdown menu.

There are two types of searches:

  • Rule Contains Term - Searches for matches anywhere in the synonym rule. This is the default search type.

  • Applies to Query - Searches for matches in the left side of one-way synonym rules, or in two-way synonym rules.

Note: Searches only apply to synonym rules within the tab. If you search from the User created/modified tab, then the search only applies to User created/modified synonym rules.

To clear the search filter, click the X in the search box.

Filters

Note: Filters are only available in the User created/modified tab.

You can apply several different filters to the synonym rules list. To select a filter, click Filters on the right.

There are three types of filters:

  • Enable - Filter by Enabled or Disabled synonym rules.

  • Type - Filter by User Modified or User Created.

  • User - Filter by specific user(s) who last modified a synonym rule.

Click the arrows to view the filter values. Multiple filter values may be selected. The count of selected filters will be displayed next to each filter type.

For the User filter, you can use the search box to help find a specific user.

After selecting the filter values, click Apply to apply the filters. Filters will not be applied if you do not click Apply.

To clear any applied filters, click Filters then Clear.

Change row count

By default, up to 10 synonyms are displayed per page. You can select the row count from the dropdown menu at the bottom of the page.

 

Add, Edit, or Delete Synonyms

Click Add to add a new synonym rule. You can add synonyms through individual rules, or you can upload them in bulk. If you have more than 10 rules, it's usually faster and easier to put them in a text file and upload them in bulk.

Note: You cannot add new synonym rules on the BR Generated tab.

Add individual synonyms directly in the Dashboard

You can add individual synonyms from the Input tab. Select 1-way Synonyms or 2-way Synonyms to add that type of synonym rule.

One-way synonym rule

  1. Enter a term under User Entered Synonym. This term is a term that your customers might enter, such as hat.

  2. Enter one or more synonyms under Synonym(s) text box. This term identifies terms to match items that you want to display in search results, such as fascinator.

  3. Click Save button to save and enable the rule.

Two-way synonym rule

  1. Enter a comma-separated list of terms under Add all terms. These terms are synonymous terms that your customers might enter, such as kids, children.

  2. Click Save button to save and enable the rule.

Note: in order to reduce latency impact, synonym rules are only applied if the terms contain less than 4 words. For example, audioover the ear headphones will not be applied since it has 4 words. In such cases, we suggest dropping common words like "the", "of", "in", "with" when adding a synonym. For example, audioover ear headphones works since it contains less than 4 words.

Upload synonym rules in bulk

You can bulk upload synonym rules from the Import tab. Bulk upload only supports one-way synonym rules.

Bulk Upload Format

Creating a plain text file (.txt) and enter each synonym in this format: customer entered term => first term, your second term

For example:

jeans => denim, trouser-style, boyfriend, skinny, straight-leg, bootcut, wide-leg
swimsuit => swim suit, bathing suit, bikini, tankini, maillot
sneakers => athletic shoes, tennis shoes, Converse

The term on the left is the term that your customers might enter, while the terms on the right are the terms that you want to be displayed in response.

Converting two-way synonym rules for bulk upload

Bulk upload only supports one-way synonym rules. You can bulk upload your two-way synonym rules by converting them into multiple one-way synonym rules.

For example, suppose you had a two-way synonym rule "swimsuit, swim suit, bathing suit". This synonym rule has 3 terms, so you could bulk upload it as 3 one-way synonym rules:

swimsuit => swim suit, bathing suit
swim suit => swimsuit, bathing suit
bathing suit => swimsuit, swim suit

Upload Bulk Synonyms File

  1. Click Choose File button and select the synonym file.

  2. Click Upload File and Import button to upload. If the import is successful, the Add New Synonym window will be closed.

If any of your synonyms were formatted incorrectly, you will be shown a failure message and none of the synonyms will be imported. Make sure each synonym follows the format in the Format section above.

Edit or Delete synonyms

Hover over a synonym to display the Edit and Delete icons.

The Edit operation will display a window similar to the Add new synonym window where you can edit the terms used in the synonym rule, or change whether it is a one-way or two-way synonym rule.

For Delete operations, you will be prompted to confirm deletion before it will be performed.

Note: BR Generated synonyms cannot be deleted. If you attempt to delete a User Modified synonym rule, they will be moved back to the BR Generated tab and re-enabled.

For BR Generated one-way synonym rules, only the right-hand terms can be edited. BR Generated two-way synonym rules cannot be edited at all.

 

Bulk Operations

You can bulk enable, disable, or delete multiple synonym rules. To enable bulk operations, click the checkbox to the left of a synonym rule.

After bulk operations are enabled, two dropdown menus will appear: the left dropdown (highlighted in red below) allows you to bulk select specific synonym rules while the right dropdown allows you to select a bulk action.

Bulk selections

Note: All bulk selections apply at the page level and will respect the current search or filters. For example, there are 10 synonym rules per page by default, so bulk selecting All will only select the 10 synonym rules on the current page. Your selection will be saved if you navigate between pages, perform a search, or apply filters.
  • All - selects all synonym rules

  • None - deselects any selected synonym rules

  • User Modified - selects all synonym rules with a User Modified tag

  • User Created - selects all synonym rules without a User Modified tag

Bulk actions

  • Enable

  • Disable

  • Delete

After you have selected the synonym rules and bulk action to perform, click Apply to apply the operation. The Apply button will display the selection count in parentheses. For example, in the screenshot below, the current bulk operation will apply to 2 synonym rules.

 

Multisite Synonyms

If you have a multisite, then the Synonyms page, Add New Synonym, and Edit synonym windows will display an additional dropdown menu to choose a domain.


Synonym operations, including any operations in the BR Generated tab, are applied at the chosen domain level. You can select the Global domain to operate on all of your sites.

Synonyms can be added at either the account or domain level, and they will be applied accordingly. For example, if you have separate domains for each language, you can add language-specific synonyms that will only apply to a specific domain.

BR Generated synonyms behave differently, depending on the type:

  • Universal synonyms are common across all accounts and domains, but they are only generated in English. These will always show up.

  • Site synonyms are generated at the account level and are applicable to all domains within the account. You can disable synonyms and view their sync status at the domain level.

If you choose a domain in the BR Generated tab, you will only see Site synonyms for that language and Universal synonyms. For example, if you choose a French domain, you will only see Site synonyms for French and Universal synonyms. 

 

Best practices

Prevent search performance issues

Only disable an automatically generated synonym rule if there's a clear issue directly tied to it. Disabling automatically generated synonyms reduces the types of products that match the terms, which can cause issues with search performance.

Upload synonym rules in bulk

If you have multiple one-way synonym rules, we suggest using the Import feature to upload a file of them in bulk. This is generally faster and more accurate than adding synonym rules one at a time.

Don't use quotes

Even if a synonym is a phrase, don't wrap the terms in quotes.

 dress
 copper pipe
 "copper pipe"

Capitalization is irrelevant

Bloomreach doesn't consider capitalization when triggering synonym rules. You don't need to create synonym rules for lowercase, capital, nor title capital versions of the same synonyms. For example, all of the following rules work exactly the same:

sofa => couch

Sofa => couch

soFa => COUCH

Just use one version of the rule.

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?