Add attributes to an entity

Entities have a set of properties, called Attributes. These attributes can be either:

  • Simple Attributes using built-in types, user-defined types or lists of values created in the model.

  • Complex Attributes using complex types created in the model.

Add a simple attribute

To add a simple attribute:

  1. Expand the entity node, right-click the Attributes node and select Add Simple Attribute…. The Create New Simple Attribute wizard opens.

  2. In the Create New Simple Attribute wizard, check the Auto Fill option and then enter the following values:

    • Name: Internal name of the object.

    • Label: User-friendly label for this object. Note that as the Auto Fill box is checked, the Label is automatically filled in. Modifying this label is optional.

    • Physical Column Name: This name is used to name the physical column that will be created to store values for this attribute.

    • Type: Select the type of the attribute. This type can be a built-in type, a user-defined type or a list of values.

    • Length, Precision, Scale. Size for this definition attribute. The fields available depend on the built-in type selected. For example a String built-in type will only allow entering a Length. If a list of values or a user-defined type was selected, these values cannot be changed.

    • Mandatory: Check this box to make this attribute mandatory.

    • Mandatory Validation Scope: This option is available if the Mandatory option was selected. Select whether this attribute should be checked for null values pre and/or post consolidation.

    • LOV Validation Scope: This option is available if the selected type is a list of values. It defines whether the attribute’s value should be checked against the codes listed in the LOV.

  3. Click Finish to close the wizard. The Simple Attribute editor opens.

  4. In the Description field, optionally enter a description for the simple attribute.

  5. In the Documentation field, optionally enter the user-facing documentation for this attribute. Use plain text or the Markdown syntax for rich text. This text provides detailed documentation for the attribute and appears in the documentation side nav.

  6. For a mandatory attribute, optionally define a custom Error Message. This message appears instead of a default message when this attribute is left empty.

  7. Select the Searchable option to use this attributes when performing a full-text search on this entity.

  8. Press Control+S (or Command+S on macOS) to save the editor.

Add a complex attribute

To add a complex attribute:

  1. Expand the entity node, right-click the Attributes node and select Add Complex Attribute…. The Create New Complex Attribute wizard opens.

  2. In the Create New Complex Attribute wizard, check the Auto Fill option and then enter the following values:

    • Name: Internal name of the object.

    • Label: User-friendly label for this object. Note that as the Auto Fill box is checked, the Label is automatically filled in. Modifying this label is optional.

    • Physical Prefix: This name is used to prefix the physical column that will be created to store values for this complex attribute. The column name is <Physical Prefix>_<Definition Attribute Physical Column Name>

    • Complex Type: Select the complex type of the attribute.

    • Mandatory Validation Scope: This option is available if the Mandatory option was selected for at least one of the definition attributes of the selected complex type. Select whether the mandatory definition attributes of the complex type should be checked for null values pre and/or post consolidation.

    • LOV Validation Scope: This option is available if at least one of the definition attributes of the complex type is a list of values. It defines whether the definition attribute’s value should be checked against the codes listed in the LOV.

  3. Click Finish to close the wizard. The Complex Attribute editor opens.

  4. In the Description field, optionally enter a description for the complex attribute.

  5. In the Documentation field, optionally enter the user-facing documentation for this attribute. Use plain text or the Markdown syntax for rich text. This text provides detailed documentation for the attribute and appears in the documentation side nav.

  6. Press Control+S (or Command+S on macOS) to save the editor.

Work with attributes

It is possible to edit, order or delete attributes in an entity from the Attributes list in the entity editor.

To order the attributes in an entity:

  1. Open the editor for the entity.

  2. Select the Attributes item in the sidebar.

  3. Select an attribute in the Attributes list and use the Move Up and Move Down buttons to order this attribute in the list.

To delete attributes from an entity:

  1. Open the editor for the entity.

  2. Select the Attributes item in the sidebar.

  3. Use the Delete buttons to remove the attribute from the list.

  4. Click OK in the confirmation dialog.