Configuring Synonym Engine After Upgrading From Pre-8.1 to Post 8.1 Version of Knowledgebase

THIS ARTICLE APPLIES TO:

Knowledgebase versions 8.0.x (or earlier) to 8.1.1 (or later)

ISSUE DESCRIPTION:

If you have been using a version of Knowledgebase prior to 8.1 and use the Synonym Engine feature, you are familar with a layout showing a Word and a Synonym like so:


But after upgrading to version 8.1(or later), you find that your Synonym page shows a list of only Synonyms like this:

ROOT CAUSE:

When upgrading from a version of Knowledgebase that uses the Microsoft Indexing Service to a version that uses the Autonomy search engine (Knowledgebase 8.1 and later), there is a fundemental change in the way terms are associated within the Synonym Engine feature.

In Knowlegebase versions prior to 8.1, using the Indexing Service, synonymous terms were created by entering the terms in separate fields Word and Synonym.


 


In Knowledgebase version 8.1.1 and later, the Autonomy search engine is used and requires the synonymous terms to be entered as a comma-separated string.



There is no longer a multi-field association between words in which you enter the terms in separate fields upon creation of the synonym in the KB Admin Panel (as was used under the Indexing Service). Under the Autonomy search engine the association between terms is dependant upon them being within the same field in a comma-separated string. 

If you enter the associated terms in a comma-separated string (with no spaces between terms) like so: search,seek,find,look,hunt then those terms will be associated and any search for one will also pull results for the others. This change does require a manual adjustment to the Synonym Engine lists after upgrade as the upgrade process ensures the terms are moved over into the new version, but is not built to read the associations and build the comma-separated strings.

SOLUTION OR WORK AROUND:

The change in search engines between versions (and the resulting change in the formatting of the synonyms) requires a manual adjustment to your existing Synonym Engine lists after upgrade. This is because the upgrade process ensures the terms are moved over into the new version, but is not designed to read the associations and build the comma-separated strings required in the later version. Our Developers have recommended the following steps to correct this issue:
  1. Log into the KB Admin Control Panel using an administrator-level account.
  2. Click the Administration Tab
  3. Click Synonym Engine in the left pane
  4. You will see a list of the current individual terms.
  5. It is recommended that you review this list in preparation for consolidating the terms. Unlike your previous version, there is no longer a two word limit. You may associate as many terms as you like in a comma-separated string. So you will be able to consolidate many words into a single entry. Once you have reviewed the list and are prepared to consolidate the terms, proceed to the next step.
  6. Click the pencil icon next to the desired term.
  7. You will see the Synonym field.
  8. Since synonymous terms are associated within comma-separated strings you can enter all related terms in this field separated by comma with no spaces.
  9. Click Save
  10. Continue through the list until all terms are associated to their synonyms in a comma-separated string.



AFFECTED SYSTEMS & USERS:

Knowledgebase Administrators who have upgraded from version 8.0 (or earlier) to version 8.1.1 (or later).

ADDITIONAL INFORMATION:

ESCALATION PROCEDURE:

If you require any further assistance after performing these steps, please contact our Support group at 877-373-7848 or via email at cimsupport@moxiesoft.com.