Working with Suggested Terms

Available from release V R6 (5.10.x)

The Glossaries > Suggested Terms tab displays candidate terms for your business glossaries suggested by Lexicon.

The terms table has the following information:

  • Term Actual term suggested by Lexicon after analyzing the database names of schemas, tables, and columns.

  • Abbreviations List of all abbreviations that Lexicon has matched to the specific suggested term. An abbreviation is a string found in the names of data objects, which is extended by Lexicon into a full comprehensive word.

  • Related Objects Total number of Related Objects (schemas, tables, or columns).

  • Popularity Normalized value of the sum of popularities of all the data objects which Lexicon considers to be related to the suggested term. Note that suggested terms are pre-ordered by popularity by default.

  • Actions Reject or Add.

You can filter the table using the natural language filter field on top.

Suggested Terms Tab:

../../_images/Lex_SuggestedTerms_Tab.png

Adding Suggested Terms to a Glossary or an Existing Article

You can add a suggested term to an existing article or add it to an existing glossary in a new article. This will add the Related Objects list in this term to the Body of the article (existing or new).

Note

You may view the ability to add suggested terms to articles as a way to bulk-link data objects relevant to the information in the articles.

Adding a suggested term to a glossary creates a new article for that term and attaches it to the glossary you have selected.

Adding a suggested term will always add a section Related Data Objects to the article, both new or existing. On the respective catalog pages of these data objects, the article having the Related Object section will be mentioned in the Relevant Articles field.

Note that as soon as the term is added to a glossary, it disappears from the suggested terms list. However, if the article created for this term is deleted, the term will reappear.

Removing the related objects section from the article also returns the term to the suggested terms list.

Adding a Suggested Term to a Glossary

To add a suggested term to a glossary,

  1. On the Suggested Terms tab, find the term you want to add. For this term, click Add then click As a New Glossary Term:

../../_images/Screen_Shot_2019-08-15_at_3.50.55_PM.png
  1. In the list of glossaries that opens, find a specific glossary you want to add the term to. You can filter the list using the quick filter field:

../../_images/Lex_QuickFilter.png
  1. In the list, click the glossary to that you want to add the term. This action opens a new article page based on the template of this glossary. The title of the article is pre-populated with the suggested term. The new article also includes a Related Data Objects field that lists all the data objects (schemas, tables, and columns), which have names relevant to the term:

../../_images/Lex_Add_to_Glossary.png

Note

If a glossary is associated with multiple templates, you will be able to select which template to apply to the new article created for the suggested term.

Also note that suggested terms can only be added to glossaries that already have at least one template associated with them. It is not possible to add a suggested term to an empty glossary.

Adding a Suggested Term to an Existing Article

To add a suggested term to an existing article,

  1. For this term, click Add then click To Existing Article. This will open the list of articles existing in your catalog. To find a specific article, filter the list using the quick filter field:

../../_images/Screen_Shot_2019-08-15_at_3.51.01_PM.png

Important

Articles can only be linked to a single suggested term: you cannot add multiple suggested terms to the same article. One article can only hold one Related Objects section that points to one suggested term.

2. Click the article to which you want to add the term:

../../_images/Add_To_Existing.png
  1. The name of the article will appear next to the term in the Suggested Terms table. This allows you to instantly undo the addition, if necessary. To un-select the article, click the cross next to the article title:

../../_images/Lex_Cancel_Add.png

When you leave or reload the Suggested Terms page, the addition will be confirmed, and the Related Data Objects field that lists all the relevant data objects (schemas, tables, and columns) will be added as a field to the selected article.

Rejecting Suggested Terms

Rejecting a term removes it from the list of suggested terms. Rejected terms will disappear when the user navigates away from the Suggested Terms tab or reloads the page.

Terms can only be rejected one by one.

To reject a suggested term,

Click Reject for the term:

../../_images/Reject.png

The action name will change to Undo allowing you to instantly cancel the action. However, if you leave or reload the page, the rejected term will disappear from the Suggested Terms list. It will NOT re-appear when the Lexicon job runs the next time.

../../_images/Undo.png

Editing Abbreviations List

You can manually revise the list of abbreviations that Lexicon included in a group by adding other abbreviations or removing some of them. This will revise the list of relevant objects linked to the term.

To edit the list of abbreviations,

  1. On the Suggested Terms tab, hover over the group of abbreviations you want to edit. This will reveal the edit icon to the right:

../../_images/Screen_Shot_2018-10-16_at_2.30.53_PM.png

on the page,

../../_images/Edit_Abbrev1.png
  1. Click the edit icon to open the editor:

../../_images/Edit_Abbrev2.png
  1. To add, hover over the title Abbreviations on the left. This will reveal the add icon:

../../_images/Screen_Shot_2018-10-31_at_2.42.00_PM.png

Click the add icon to open the quick filter. Find the abbreviation you want to add and click it to add to the list:

../../_images/Edit_abbrev3.png
  1. To remove, hover over the abbreviation you want to remove from this list. This will reveal the delete icon on the right:

../../_images/Screen_Shot_2019-10-16_at_7.19.44_PM.png

Click the delete icon to remove the abbreviation:

../../_images/Edit_Abbrev4.png
  1. The list of Related Data Objects on the right of the editor does NOT immediately update. Click Close at the bottom of the dialog to return to Suggested Terms.

Note

Updating the list of abbreviations after a change may take some time and will not be immediately reflected in the list of Related Objects or Suggested Terms. After the change is completed by the system, both the list of abbreviations and related objects will be updated. You can refresh the page to see the updated lists.

Removing Related Data Objects From the Article

Users with the Catalog or Server Admin roles can unlink the related data objects added from a suggested term and the article by removing the Related Data Objects field from this article. Note that when the field is deleted from the articles, the system will return the term to the Suggested Terms table on the Glossaries page.

Removing the Related Data Objects section from an article does NOT detach this article from the glossaries it is associated with.

To remove the related objects from an article,

  1. Hover over the title Related Data Objects. This will reveal the Remove link on the right:

../../_images/Remove_Rel_Objects1.png
  1. Click Remove and in the dialog that opens, confirm the action. The data objects and the article will be unlinked.

Improving the Quality of Suggested Terms

To improve the quality of the Lexicon-suggested terms, you can teach Lexicon to make better matches. For more on Lexicon, see Naming data with Lexicon.