Updated on 2024-12-30 GMT+08:00

Dictionaries

Dictionaries enable you to efficiently manage business-related information, such as mobile numbers, state/province and city codes, and supplier regions. Dictionaries can be displayed in list and tree modes.

Adding a Dictionary

  1. Log in to the administrator portal.
  2. On the top navigation bar, choose Settings > Dictionaries.
  3. On the Dictionaries page, click at the bottom of the page.
  4. In the Add Dictionary dialog box, enter dictionary information and click Save. The dictionary then appears in the list.

    Table 1 Adding a dictionary

    Parameter

    Description

    * Dictionary Code

    The dictionary code must be unique. To facilitate dictionary management, set this parameter by following a unified rule.

    * Dictionary Name

    The dictionary name must be unique.

    Tree Structure

    Indicates whether to display the dictionary in list or tree mode. If you select this option, the dictionary is displayed in tree mode. Otherwise, the dictionary is displayed in list mode.

    Description

    Describes the usage and application scenarios of the dictionary.

  5. Select a dictionary in the left pane.

    • Dictionary items are subsets of a dictionary. Create a dictionary before adding dictionary items.
    • Only dictionaries for which you have configured dictionary items can be used when you add custom user attributes.

  6. On the right of the Dictionaries page, click Add Dictionary Item. In the displayed dialog box, enter the dictionary item information.

    Table 2 Adding a dictionary item

    Parameter

    Description

    * Dictionary Name

    Parent node of the dictionary item. This parameter is not editable.

    * Dictionary Item Code

    Unique identifier of the dictionary item. To facilitate dictionary management, set this parameter by following a unified rule.

    * Dictionary Item Name

    Name of the dictionary item. Different dictionary items can have the same name.

    Description

    Describes the usage and application scenarios of the dictionary item.

  7. Click Save. The dictionary item then appears in the list.

Modifying a Dictionary

If the user attribute associated with a dictionary changes, you can modify the dictionary to adapt for the change.

  • Modifying a dictionary

    The dictionary code and whether to display the dictionary in tree mode cannot be modified.

    1. Log in to the administrator portal.
    2. On the top navigation bar, choose Settings > Dictionaries.
    3. On the right side of the target dictionary, click and select Edit from the drop-down list. The Modify Dictionary dialog box is displayed.
    4. Modify the dictionary name and description, and click Save.

      The dictionary code and whether to display the dictionary in tree mode cannot be modified.

  • Modifying a dictionary item
    1. Log in to the administrator portal.
    2. On the top navigation bar, choose Settings > Dictionaries.
    3. Click the target dictionary. On the right side of the dictionary item list, click Modify in the Operation column of the dictionary item to be modified.
    4. Modify the dictionary item name and description, and click Save.

Deleting a Dictionary

Before you delete a dictionary, ensure that it is not associated with any user attributes.

  1. Log in to the administrator portal.
  2. On the top navigation bar, choose Settings > Dictionaries.
  3. On the right side of the target dictionary, click and select Delete from the drop-down list.
  4. In the displayed dialog box, click OK.