Checking Glossary Compliance

When you enable the use of glossary terms for your object naming conventions, additional model checks help you monitor glossary compliance for object names and automate the replacement of unapproved synonyms with approved glossary terms. You can restrict the scope of your compliance efforts by disabling the checks for certain object types on a model-by-model basis.

The following checks are enabled for all model objects when you select Use glossary for autcompletion and compliance checking for your naming conventions (see Naming Conventions):

Check

Description and Correction

Name/Code contains terms not in glossary

[if glossary enabled] Names and codes must contain only approved terms drawn from the glossary.
  • Manual correction - Modify the name or code to contain only glossary terms.
  • Automatic correction - None.

To disable this check for a given object type, clear its check box in the tree in the Check Model Parameters dialog. To reduce its severity from Error to Warning, right-click the check and select Warning. The check icon changes to a warning sign.

Name/Code contains synonyms of glossary terms

[if glossary enabled] Names and codes must not contain synonyms of glossary terms.
  • Manual correction - Modify the name or code to contain only glossary terms.
  • Automatic correction - Replaces synonyms with their associated glossary terms.

To enable the automatic replacement of synonyms with approved glossary terms for a given object type, right-click the check in the Check Model Parameters dialog, and select Automatic Correction. A small overlay with a red cross appears at the bottom-right of the check icon.

In addition, the following check is enabled for models and packages to allow administrators to add terms used in object names to the glossary:

Check

Description and Correction

List of missing terms in object names/codes in package

[if glossary enabled] This special check lists all the terms that are used in the names or codes of all the objects contained in the model or package.
  • Manual correction - An administrator with write permission on the glossary can double-click the line for this check in the Result List to open a merge window in which you can select to add some or all of these missing terms, as appropriate, to the glossary.
  • Automatic correction - None.