Customize the Term Browser Translation View

Adding a Custom Image to the Start Page

You can add a custom image to the start page of the translation view of the Term Browser. The image is displayed whenever a user opens the translation view. For example, you can display an image with short instructions for Term Browser users. These instructions are especially helpful for new users.

To add a custom image to the start page of the translation view, follow these steps:

  1. Create the image and save it as trans-browser-welcome.jpg
  2. Copy the image to the following location: %ACROLINX_CONFIGURATION_ROOT%\server\www\gwt\images

    If this location doesn’t yet exist, create the required subdirectories first.

  3. Open the translation view of the Term Browser to verify that the image is displayed.

Configuring the Translation View Properties

You can use the translation view properties to adapt the appearance of the translation view to the requirements of the Term Browser users in your organization.

The Acrolinx Server administrator is responsible for setting and maintaining the translation view properties. To change the translation view properties, you must access to the termbrowser.properties file in the Acrolinx Server configuration directory.

To configure the translation view properties, follow these steps:

  1. Open your overlay of the following file: termbrowser.properties 

    If you haven’t yet created an overlay of this file, create a new version of the file at the following location:

    %ACROLINX_CONFIGURATION_ROOT%\data\
  2. Add one or more the following properties: 

    Propertytranslationview.searchForm.searchableFields
    Use toConfigure a list of additional search criteria that appear on the search form.

    Enter the values as a comma-separated list of field names. When entering the values, use the name defined for the field in the field manager component of the Acrolinx Terminology Manager. The field name appears in the first field of the Edit Custom Field dialog.

    The fields appear on the search form in the order that they’re listed in the property.

    Example:

    translationview.searchForm.searchableFields=conceptStatus,termType,definition

    Propertytranslationview.searchForm.defaultSourceLanguages
    Use to

    Configure the default source language or source language pair. When you search for terms, the Term Browser looks for terms in the configured source languages.

    If your organization works in two main languages, you can configure both of them as source languages. For example, you can search for source terms in English and German at the same time. When you enter a search term, the Term Browser suggests matching terms from both languages.

    Example:

    translationview.searchForm.defaultSourceLanguages=en,de

    When you configure two source languages, Term Browser users can select two search languages from two search language dropdowns.

    You can’t configure any more than two source languages. Also make sure that your configured source languages are included in the property translationview.searchForm.searchLanguages as well.

    Propertytranslationview.columnSelector.initialColumns
    Use toDefine the columns that you'll see in the search results grid. The columns term name, status, language, and linked terms appear by default.

    Enter the values as a comma-separated list of field names. When entering the values, use the name defined for the field in the field manager component of the Acrolinx Terminology Manager. The field name appears in the first field of the Edit Custom Field dialog.

    The columns appear on the search form in the order that they’re listed in the property.

    Example:

    translationview.columnSelector.initialColumns=termType,definition

    Propertytranslationview.searchResultList.translationStatusRestriction

    translationview.searchResultList.synonymStatusRestriction

    Use toConfigure the linked terms column to only display translations or synonyms that have a specific status. By default, all translations and synonyms are displayed in the linked terms column regardless of status.

    Enter the values as a comma-separated list of status names.

    Example:

    translationview.searchResultList.translationStatusRestriction=preferred,admitted

    translationview.searchResultList.synonymStatusRestriction=preferred,admitted

    Propertytranslationview.searchResultList.singleResult
    Use toConfigure Term Browser to jump directly to the term help page if your search finds only one term. By default, Term Browser displays a single search result in the search results grid.

    Enter a Boolean value.

    Example:

    translationview.searchResultList.singleResult=false

    Propertytranslationview.searchForm.allowMultipleTargetLanguages
    Use toConfigure whether users can select multiple target languages when searching for terms.

    If set to true, the search form contains a multiple selection menu to filter for multiple target languages.

    If set to false, the search form contains dropdown menu to filter for one target language at a time.

    When this property isn’t set, the default behavior is true.

    Enter a Boolean value.

    Example:

    translationview.searchForm.allowMultipleTargetLanguages=false

    Propertytranslationview.searchResultList.displaySynonyms
    Use toShow or hide synonyms in the linked terms column.

    When this property isn’t set, the default behavior is true

    Enter a Boolean value.

    Example:

    translationview.searchResultList.displaySynonyms=false

    Propertytranslationview.searchForm.searchLanguages
    Use toRestrict the range of search languages available to users in the search language dropdown.

    If this property contains one language value only, the search language dropdown is hidden from the search form, and the defined language becomes the default search language for all searches.

    Example:

    translationview.searchForm.searchLanguages=en,de

    Propertytranslationview.searchForm.targetLanguages
    Use toRestrict the range of target languages available to users in the target language menu or dropdown.

    If this property contains one language value only, the target language selection menu is hidden from the search form, and the defined language becomes the default target language for all searches.

    Example:

    translationview.searchForm.targetLanguages=fr,ja,it,es

    Propertytranslationview.searchForm.restrictions.<FIELD_NAME>
    Use to

    Restrict the range of options available to users in other list fields that you’ve configured to appear in the search form.

    Enter the values as a comma-separated list of list item names. When entering the values, use the name for the list item as defined in the category manager component of the Acrolinx Terminology Manager. In the category manager, the list item name is displayed in parentheses next to the display name. All values are case-sensitive.

    Examples:

    translationview.searchForm.restrictions.domain=Switches,acrolinx

    translationview.searchForm.restrictions.termType=fullForm,acronym

  3. Save your changes and restart the core server.
  4. Reload the Term Browser.

System Field Names

When adding a field to the Term Browser properties or the term help template, you’re required to enter the name defined for the field in the field manager component of the Acrolinx Terminology Manager.

However, since the field manager doesn’t currently provide information about system fields, you can use the following list as a reference when entering system field names as values:


Term Help TemplateTerm Browser Translation View
Field NameConfigurable as Template Variable?Configurable as Custom Search Field?Configurable as a default Column?
statusyesyesyes
domainyesyesyes
morphosyntacticRestrictionyesyesyes
idyesnoyes
databaseIdyesno (can be entered into the term name field)yes
uuidyesno (can be entered into the term name field)yes
entryIdyesno (can be entered into the term name field)yes
entryUuidyesno (can be entered in the term name field)yes
termNameyesno (already a default search field)yes
languageyesno (already a default search field)yes
isHeadTermyesnoyes
frequencyyesnoyes
creationDateyesnoyes
creatoryesnoyes
linkedTermsyesnoyes