Within the Data Onboarding solution, a STEP setup entity object called Mapper Configuration is the fundamental object that is responsible for defining the actions of data onboarding. Before being able to create a Mapper Configuration, a one-time initial setup is essential. This setup entails creating a setup group to house the Mapper Configurations. This document provides a detailed guide on the initial setup, which involves setting up the data model in workbench.
Setup entity definitions can be exported as comments and submitted to an external source control system for comparison purposes. For details, refer to the Configuration Management documentation.
By the end of this configuration in the workbench, a setup group called 'Mappings' is created where users can add new Mapper Configurations. Further configuration of the Mapper Configurations can be only done in the Web UI. For information on configuring Mapper configurations in the Web UI, refer to the Configuring Web UI for Data Onboarding Solution topic.
Below are the steps for an initial setup in the workbench.
-
Navigate to System Setup > Object Types & Structures, select then right-click the Setup Group type root node and select New Object Type.
-
In the dialog that displays, enter an ID in the ID parameter (e.g., MapperConfigurations), enter a Name in the Name parameter (e.g., Mapper Configurations), then click the Create button. This creates a setup group object type that will be used for the root node of the Mapper Configurations object to store all mapper configurations below.
The sample below illustrates a hierarchy of setup group object types. A Setup Group named 'Mapper Configurations' has been created.
Once the setup group is made, the 'Mapper Configurations' basic object type must be linked to this newly created node as a child. Later, when new Mapper Configurations are created and added to the system, they will use this object type.
-
Navigate to Object Types & Structures > Basic Object Types > Mapper Configuration, and click the References tab.
Under the Parents flipper, click Add Parent, and in the node selector dialog, specify the Mapper Configurations node that was created in the above step.
The next step is to create a new setup group root, where all Mapper Configurations will be stored below.
Creating a New Setup Group Root
-
To create the setup group root, navigate to Maintain (drop-down menu) > Insert > Setup Group Root....
-
Select the 'Mapper Configurations' object type.
-
Specify the ID and Name for the setup group root object. In this setup, ID and Name value of 'Mappings' is entered.
-
Click Create.
The setup group called 'Mappings' of the object type 'Mapper Configurations' is created. From this newly created node, users can right-click and add new Mapper Configurations.
The Mapper Configurations under the setup group 'Mappings' are stored in STEP as a setup entity that can be exported and imported as STEP <Setup Entity> objects. It cannot be imported through Excel.