Configuration Data Definitions
Configuration data definitions allow advanced data exports, by defining the relevant entity attributes along with rules to mitigate duplication, referential integrity, versioning, business statuses, etc. on the destination environment at import. Thus, the data can be shared between different environments quickly and easily.
After creating a configuration data definition, you can include it in Configuration Data Packages where you can select which records matching your configuration data definition you wish to export.
In general, configuration data definitions and configuration data packages are used by digital developers to transfer business configurations from one environment to another (e.g. a new version of a banking product, a new sales campaign, etc.).
To create a configuration data definition:
- In FintechOS Studio, go to Main Menu > Configuration Management> Configuration Data Definitions to open the Configuration Data Definitions list.
- Click Insert to open the General configuration page.
- Fill in the following fields:
Field Description Name Name of the Configuration Data Definitions settings. Display Name Name shown in the user interface. Master Entity The entity on which the data export is built. This entity must have a unique constraint set (for details, see Entity Unique Constraints).
The unique constraint is used to identify the records and determine imported records that overlap with existing records on the target environment.
Mirror Collection This option replaces data on the target environment with an exact copy of the export.
For example, if the checkmark is not ticked, and in the source entity there is an attribute called cash and in the target entity there is an attribute called card, after the import, the target entity will have both attributes cash and card.
If the checkmark is ticked, the cash attribute is imported the card attribute is removed.
Include Business Unit Includes the security elements set for the data. Include Business Status When using Business Workflows to assign statuses to entity records, the record statuses will be also exported.NOTE
This setting is mutually exclusive with Is Versionable.
Is Versionable If the master entity is versionable, you can mark this in the configuration data definition (see Entity Versioning for details).
If checked, on import, depending on the matching records found on the destination environment (records with the same unique constraints), the following apply:
- If no matching record is found, a new record in the Draft state is created.
- If a matching record in the Draft or Version Draft state is found, the import fails.
- If a matching record in the Approved state is found, a new record in the Version Draft state is created.
This setting is mutually exclusive with Include Business Status.
Endpoint Name Allows you to trigger a server side script with the specified endpoint name on the destination environment on import. The IDs of the inserted master entity records will be passed to the script through the
context.Data.packageVersionIdsobject, for example:Copy
var packageVersionIds = context.Data.packageVersionIds;
for (var i = 0; i < packageVersionIds.Count; i++)
var id = packageVersionIds[i];
Description Insert details about the configuration data definition here.
- Click Save and Reload and open the Definition tab to configure the master entity's relationships.
- If the master entity's data model has changed since the last time you edited the configuration data definition, click Regenerate to update the grid.
- Click the Edit button at the right side of each attribute, and fill in the following information:
Field Description Name This is the name of the attribute. Type This is the type of attribute:
- Root - Master entity.
- Lookup Attribute - Lookup attribute with a Dictionary lookup relationship type.
- Details Collection - Lookup attribute with a IsChildOf lookup relationship type.
- N-to-N - Many-to-many relationship.
- Parent - Entity that references the master entity.
Entity name Name of the referenced entity (including the master entity). Include Tick if you wish to include the attribute in the export. Internal name It is made up of the Name + "v"+Version + exportDate. Update only reference This field is mandatory for parent-child relationship between entities. Is Hierarchy When referencing an entity with an IsChildOf relationship type, if the referenced entity includes a self-referencing lookup attribute, this box is automatically checked. Hierarchy Levels When the Is Hierarchy box is checked, use this field to set up how many levels of self-referencing are allowed for the referenced entity. Default: 4. Identification constraint name Select the constraint created earlier. For more information, see Entity Unique Constraints.NOTE
If the entity has lookup attributes to or is a child of a different entity, the referenced attributes must be included in the import. Otherwise those attributes will appear in the file, but on import will be empty (reference as none).
- Click Save to add the attribute or click Cancel to cancel the process.
Repeat for as many attributes as needed.
You can now use Configuration Data Packages to export the records.