The “Settings” tab describes the main parameters of the entity/lookup entity.
To configure properties:
Make sure that the “Settings” tab is active.
In the “Main” group, fill in the fields (Figure 1):
“Name”. System name of the entity/lookup entity. The name must begin with a letter and can only contain Latin letters, numbers, the symbols “-“, “_”. Cannot contain spaces. Not editable after saving.
“Display name”. Name of the entity/lookup entity that will be displayed to all users. The display name can consist of both Latin and Cyrillic letters, as well as spaces. It is recommended to use a human-identifiable name. Can be edited after saving the entity/lookup entity.
“Description”. Any additional information about the entity/lookup entity.
“Additional parameters”. List of parameters (the “name” – “value” pair) that contain additional text information. Parameters can be referenced by custom extensions, and parameters can also contain non-standard information from external systems.
In the “Advanced” parameter group, if necessary, set user-defined limits of validity periods. When creating a lookup entity, you can also specify that the lookup entity will be hierarchical.
In the “External Key Generation Method” parameter group, select the desired generation method. For more information, see below.
Save the changes. Click “Save” in the upper-right corner of the screen.
Go to the “Attributes” tab to add and configure attributes.
Figure 1. Entity/lookup entity properties
“Hierarchical” parameter. Available only for lookup entities.
The property is only specified when you create the lookup entity, and it is locked after saving. It is not possible to change the property for published lookup entities.
Hierarchical lookup entities in the “Data” section are displayed in tree view and can be switched to tabular view.
Record search does not work in the tree view, so the tabular view of the lookup entity will be enabled when searching for records.
If the lookup entity is specified as hierarchical, the “Limits of validity periods” property is not available. For hierarchical lookup entities, the limits are equal to the limits specified globally in the Unidata MDM configuration.
For hierarchical record attributes of the lookup entity, the Quality Rules work, setting values into record attributes and from lookup entity attributes. Record filtering and security labels are temporarily unavailable.
“Limits of validity periods” parameter. Selects the validity boundaries of the object to be created. Contains a checkbox that allows you to activate the setting and fields for specifying the validity period limits.
Important conditions for setting the limits:
A period boundary may not be changed when data is present;
Boundaries of linked objects should overlap, otherwise it will be impossible to link between data model objects.
When you enable this option, the “Accuracy of the validity period”, “Beginning of period” and “End of period” options become available.
Accuracy of the validity period - selection from the drop-down list: date, or date and time.
The specified accuracy will be displayed on all screens of the steward interface where validity periods appear.
The setting is made for each entity/lookup entity separately.
The selection affects the entity/lookup entity records and the validity periods of the entity relation.
Relation between entities with different accuracy of validity periods is correct.
In the related record (link or relation) selection screens, the validity periods are displayed with the entity setting at the right end of the link/relation.
Generating External Key¶
The Unidata system uses a unique record ID (external key) - External ID, which is used when importing records. If the record does not have a external key when importing, then such a record will not be loaded.
It is possible to create external keys in the process of importing records using the external ID generation function. In this case, the external key can be generated in one of the following ways:
Unset. The generation isn’t performed. The external keys of the records will be imported from a third-party system. Records with a missing external key will be discarded during the validation process.
If the records were imported from Excel, the external key will be generated in any case. The keys are generated using the same algorithm as when creating records in the user interface.
Auto (GUID). The external key is generated by creating a string with a random value. During import, keys will be generated for records that do not have them. If the keys are missing, they will be generated.
Merge. The foreign key is generated by combining the attributes specified in the configuration into a single string (Figure 2). The generation strategy involves attributes that have the “Required” property. During the import, all foreign keys will be replaced with new ones. If keys are missing, they will be generated. The following data types are available: String, Integer, Link to lookup entity. You must also fill in the following parameters:
“Show attribute names”. You must select the attributes that will be combined into a single string.
“Delimiter”. You must enter a character or set of characters that will delimit the attributes in the generated string.
Custom. The external key is generated according to the algorithm set by the user. Fill in the following parameters:
Name of the custom generation method.
Library. Select a .jar library file from the list of previously downloaded.
Java class. Select the class that is contained in the library file.
Maximum length of the external key is limited to 512 characters.
External key is not rewritten if it is already in the record or came in the context of insertion.
Attributes involved in generating the external key become mandatory. When preparing an import to Excel, you must also fill in the attributes. If at least 1 of the attributes for the imported record is not filled in, this record will be omitted when trying to generate the external key.