Work with Enumerations

Enumerations section. Data administrator interface

Description

Enumeration is a set of possible value options for record attributes. For example, an order status: waiting for payment, completed, delivered.

Ready-made enumerations are used in the “Data model” section when configuring entities/lookup entities. The attribute is marked with the “Enumeration” type and a specific enumeration from the list is specified. After the data model is published, you will need to select a value from the list in a record card to fill the enumeration attribute.

How to Create/Delete

To create an enumeration:

  • Go to the “Enumerations” section.
  • Click “Create” in the lower-left corner of the screen.
  • Fill in the main properties:
    • Name. A logical name of the enumeration. Use Latin alphabet during input. The name cannot be changed after saving.
    • Display name. A name that will be displayed to users.
    • Custom properties. A list of parameters (“name” – “value” pair) that contain additional text information. Parameters can be referenced by custom extensions and can also contain non-standard information from external systems.
  • Add enumeration values (Figure 1):
    • Click “Add value” at the bottom of the “Enumeration content” area.
    • Enter the ID and display name of the enumeration. The ID is required to keep all values inside the enumeration unique. The ID is filled in with Latin characters and numbers and can have any values.
    • Add more enumerations, if necessary.
  • Click “Save” in the upper-right corner.

To edit an enumeration:

  • Select the required enumeration from the list.
  • Make changes: add or remove any items, if necessary.
    • The Name field cannot be edited as it is a system field (required for the data model).
  • Click “Save” in the upper-right corner.

To delete an enumeration:

  • Select the required enumeration from the list.
  • Click “Delete” in the upper-right corner.
  • Confirm the action.

Section overview

Figure 1. Section overview

Section legend

Figure 2. Section legend