Configuring the Attributes of a Custom Field

The custom field window is displayed when you edit or create a custom field. The following table describes the fields displayed in this window.

Fields in the Custom Field Window

Field NameDescription
Field NameThe full text identifier for a field. The field name appears as a column or element name in an exported terminology file. External applications may also reference the field name when integrating with the Terminology Manager.
Important: If you want to import your terminology data into another system, make sure your field name adheres to the field name constraints of that system. A general best practice is to avoid spaces and commonly recognized illegal characters.
Display NameThe human friendly label for a field that appears in the Terminology Manager interface.
Field TypeDetermines the location of the field on the Term Edit Page.

Select one of the following field levels:

  • Select Conceptual to add a field that stores conceptual information.

    When you update a conceptual field, the information is updated for all linked terms because they all describe the same concept. For example, if you change the image for the English term "cross-head screwdriver", your new image also appears when users open terms that are translations of "cross-head screwdriver".

  • Select Term-specific to add a field that stores information that is specific to each term.
Input Type
Determines the input type of the field. For example, you might have one field where users can enter any text and another field where users have to select an item from a list.

Choose one of the following input types:

  • Text - add a field that accepts any text string
  • List - single choice - add a dropdown field that allows users to select one value from a list of items defined in a category.

    Before you create a field with the data type List, make sure that you’ve created the necessary category in the category manager.

  • List - multiple choice - add a list box that allows users to select several values from a list of items defined in a category.

    Before you create a field with the data type List, make sure that you’ve created the necessary category in the category manager.

  • Image - add a field that enables users to upload an image or enter a URL to an image at an external location.
  • HTML - add a field that accepts HTML code.

    Due to security issues, only the following HTML tags are permitted in HTML fragments.
    <a>, <p>, <br>, <b>, <em>, <i>, <h1>, <h2>, <h3>, <h4>, <h5>,
    <h6>, <hr>,<ul>, <ol>, <li>, 
    All other HTML tags are automatically stripped out when the field content is displayed. Additionally, you can only enter standard links for <a> tags. Any <a> tags that contain non-standard content such as Javascript are blocked.

The data types Image URL and HTML are intended for fields that are added to term help templates. When a user opens a term help page in a web browser, the content of fields with the data type Image URL or HTML are parsed by the web browser and rendered to the page.

Text Field Size

Determines how large the field appears on the Term Edit Page.

The Text Field Size field only appears when you select the data type Text or HTML.

Category

Required for fields with data type Category. Use this field to choose the category that populates the dropdown list.

The Category field only appears when you select the data type Category.

Default Value (Optional)The initial value that the field displays.
Send to Plug-in Shortcut Menu

For Classic Edition Integrations only. For the Sidebar, see Customize Terminology Information in the Sidebar.

This option can be useful to provide brief help information about a terminology issue without requiring Acrolinx Integration users to open the full term help web page.

If you’ve selected this option, you must reload the relevant language server configuration before Acrolinx Integration users can see the new field. See the Core Platform Administration Guide for more information about reloading a language server configuration.

This option isn’t available for fields with the data type Image.

Because the Acrolinx Integration shortcut menu has a limited amount of space, avoid using this option for fields that accept more than 30 characters. Also, remember that even though you can add HTML content to several fields, the integration shortcut menu can’t always display HTML content correctly.