Working with Synonyms

Use of synonyms can help users find values without knowing the exact term they are looking for. When the system detects the term used is part of a synonym list, it will return values that also appear as a synonym, thus improving the probability that the result the user wishes is available. However, it should be noted, that users will see more search results though the entered keyword may not be present.

In prior versions, PeopleSoft enabled you to use synonyms during the search process through a configuration file in the search engine. PeopleSoft delivered a configuration file (synonyms_grammar.txt) that enabled you to add synonyms based on your business requirements. PeopleSoft continues to support the use of the synonyms_grammar.txt file. You should enter synonyms in this file and manually upload this file to the search engine. The file is located at config\analysis\synonym_grammar.txt.

In addition to this functionality, PeopleSoft provides the Synonyms page to manage synonyms. Users can plan to start using the automated manner of maintaining their synonyms through PIA. Users can copy the contents of the synonyms_grammar.txt file and update the synonyms_custom file in PIA.

Synonyms are analyzed during the search process. PeopleSoft uses the synonym token filter of OpenSearch to analyze the synonyms.

Note:

The following documentation is applicable to the use of synonyms managed through the Synonyms page.

Note:

By default, synonym search is enabled.

Considerations for Using Synonyms

You should consider the following before you configure synonyms on the Synonyms page:

  • PeopleSoft supports translation of synonyms that are delivered by PeopleSoft. Therefore, synonym files for related languages are suffixed with language codes. For example, synonyms_psft_eng.txt.

  • Synonym file names are static and should not be changed because the exact file name is defined in the mapping of the index deployment requires .

  • Synonym files are common to all indexes for which synonym search is enabled.

  • In a scenario where an OpenSearch cluster is used for multiple PeopleSoft applications, synonym entries are merged to the same file, but the synonyms are separated by owner ID.

  • In an OpenSearch cluster, synonyms are common for all databases for a specific owner ID.