Work with enumerations

Assign enumerations

Enumerations are sets of possible value options for record attributes. A simple example of enumerations is the order status: waiting for payment, formed, delivered, reserved.

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

Create enumerations

To create enumeration:

  • Go to the “Enumerations” section, if it is not currently open.
  • Click the “Create” button located in the lower-left corner of the screen of the enumerations list.
  • A window with enumeration parameters will open.
  • Fill in the main properties:
    • Name. This is a logical name. Use Latin alphabet during input. The name cannot be changed after saving.
    • Display name.
    • Custom properties. A list of parameters (the “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 the “Add value” button located at the bottom of the “Enumeration structure” 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 has no set value.
    • Add more enumerations if necessary.
  • Click “Save” in the upper-right corner.

To edit enumeration:

  • Select the desired enumeration from the list in the left part of the screen.
  • A window with enumeration parameters will open.
  • Select the desired line and edit it. Add or remove any items, if necessary.
    • The Name field cannot be edited because it is a system field (required for the data model).
  • Click “Save” in the upper-right corner.

To delete enumeration:

  • Select the desired enumeration from the list in the left part of the screen.
  • Click Delete in the upper-right corner.
  • Confirm the action.

Section overview

Figure 1. Section overview

Section legend

Figure 2. Section legend