Term Sets

Acrolinx has started to phase out support for Term Sets. But don’t worry! We've replaced them with Targets. If you have Targets enabled, you already have an easier way to manage your guidance. See Words and Phrases to learn how Acrolinx now handles term sets.

You might also want to look at our Sunset Policy.

You can use the "Term Sets" page to quickly add new term sets that load terms based on domains. You can also disable or enable existing term sets.

A term set configuration page is available for each of the languages configured in your guidance package.

To open the term set configuration page:

  1. Navigate to Guidance Settings > Term Sets.
  2. In the left-hand navigation menu, a menu item appears for each of the available languages.
  3. The Dashboard displays the term set configuration page for the first language in the list.
  4. To view the term sets for another language, click the relevant menu item.

About the Term Set Configuration Page

The term set configuration page has the following parts:

PartUse To
Term sets tableView term set information and edit existing term sets.

The term set table contains columns with the following functions:

  • Active - Activate or deactivate term sets
  • Delete - Delete term sets
  • Domains - View or edit the domains in the term set
  • Term Set Name - View or edit the term set name
  • Writing Guides - View or edit the writing guides for a term set
  • External Source - View the name of any external source files may define the loading criteria of the term set. You can use an external source as an alternative to specifying domains. One example of an external source is a filter file.
  • Status - View the loading status of the term set
Add Term Set buttonAdd new term sets.
Save buttonSave all changes made on the term set configuration page.
Undo All Changes/Refresh buttonUndo all changes made on the term set configuration page since the last save.

When you have not made any changes since the last save, this button displays as a Refresh button.

If you click Refresh, all the information in the term sets table is refreshed, including the loading statuses.

Preconfigured term set(s)View term sets that have been defined directly in the language configuration file.

Your guidance package is always delivered with at least one preconfigured term set.

Preconfigured term sets cannot be edited or deleted from the term set configuration page. You must edit them in the relevant language configuration file.

However, you can still deactivate or reactivate a preconfigured term set.

You identify preconfigured term sets by looking for rows that have no delete button.

User-defined term set(s)View term sets that have been defined on the term set configuration page.

Rows for user-defined term sets are editable and always have a delete button.

Creating Term Sets

To create a new term set, follow these steps:

  1. Navigate to the term set configuration page for the relevant language.
  2. Click Add Term Set.
  3. In the dialog that appears, select a domain.

    A new row appears in the term sets table.

    • The selected domain appears in the Domain column along with a Choose Domain button.
      To add more domains, click Choose Domain.
    • Term Set Name column has a text field with domain name as the default name for the term set.
      To rename the term set, type the new name in the term set name field.
    • The term set is added to all writing guides by default, and a Choose Writing Guide button appears the Writing Guides column.
      To add the term set to specific writing guides, click Choose Writing Guide.
  4. Click Save.

    A dialog appears which prompts you to choose one of the following options:

    • Reload the language server configuration
    • Continue without reloading

      Tip: If you click Continue Without Reloading, your changes are saved but aren’t available for integration users until you’ve reloaded the language server configuration.

Editing Term Sets

To edit a term set, follow these steps:

  1. Navigate to the term set configuration page for the relevant language.
  2. (Optional) In the Domains column, click Choose Domain to add more domains.
    • To remove a domain, click the domain name.

      In the shortcut menu, click Remove Item.

  3. (Optional) In the Term Set Name column, enter a new name for the term set.
  4. (Optional) In the Writing Guides column, click Choose Writing Guide to add the term set to specific writing guides.
    • To remove a writing guide, click the writing guide name.

      In the shortcut menu, click Remove Item.

  5. Click Save.

    A dialog appears which prompts you to choose one of the following options:

    • Reload the language server configuration
    • Continue without reloading

      Tip: If you click Continue Without Reloading, your changes are saved but aren’t available for integration users until you’ve reloaded the language server configuration.

Activating and Deactivating Term Sets

You can use the checkboxes in the Activate column to control whether the language servers load a term set. This functionality enables you to take a term set offline without deleting it permanently.

To activate or deactivate a term set, follow these steps:

  1. In the relevant term set rows, select or deselect the checkbox in the Active column to activate or deactivate the term set.
  2. Click Save.

    A dialog appears which prompts you to choose one of the following options:

    • Reload the language server configuration
    • Continue without reloading

      Tip: If you click Continue Without Reloading, your changes are saved but aren’t available for integration users until you’ve reloaded the language server configuration.

Deleting Term Sets

To delete a term set, follow these steps:

  1. In the relevant rows click the delete icon  in the Delete column.

    This marks the term set for deletion and the table row becomes inactive.

  2. Click Save.

    A dialog appears which prompts you to choose one of the following options:

    • Reload the language server configuration
    • Continue without reloading

      Tip: If you click Continue Without Reloading, your changes are saved but aren’t available for integration users until you’ve reloaded the language server configuration.

    The row is removed from the table.

About Loading Statuses and Warnings

The term sets table contains a Status column that displays the loading status of each term set. The loading status indicates the availability of the term set to integration users. Domain and writing guide names can also display in red as a warning that changes made outside of the guidance setting have affected the term set.

Loading Statuses

The following table describes the possible loading statuses.

StatusDescription
LoadedThe relevant language servers have loaded the term set and the term set is available to integration users.
LoadingThe relevant language servers are in the process of loading the term set.
Not loadedThe term set has not been loaded by the relevant language servers and isn’t available to integration users. A likely cause for this status is that the term set doesn’t contain any terms.
Changes not loadedThe term set has been edited on the term set configuration page but the changes have not yet been loaded by the relevant language servers.
Language configuration unavailableThe term set was created for a language that is no longer configured. The most likely cause for this status is a missing language configuration file.
Language server unavailableThere’s no running language server configured with the language required by this term set.

Term Set Warnings

  • Domain names display in red if a domain in a term set has been deleted on the category manager page of the Terminology Manager.
  • Writing guide names display in red if a writing guide for a term set has been removed from the relevant language configuration file.

If all the domain or writing guide names in your term set are red, the term set isn’t loaded. You can remove the term set warnings by removing the affected domains or writing guides.