Object mapping by interface definition - HxGN SDx - Update 64 - Administration & Configuration

When mapping objects using a shared interface definition, you can create mapping for multiple objects simultaneously.

• To create object mappings using interface definitions, you must connect to a target system. Mapping using the Local or Free Text options is not supported.

• Raw Attribute Format is not supported for object mapping by interface definition.

• Summary Map is not displayed for object mapping by interface definition.

The following is an example of creating the object mapping based on interface definition: Maps to Interface ItaggedItem.

1. In the Mappings pane, select the Object Mapping by Interface Definition option in Add New Mapping.

2. Select the Target System tab at the bottom of the Mappings pane.

3. Type *ITaggeditem* in the box, and click Search to search for the required interface definition.

4. Select the ITaggeditem interface definition from the results in the list box, and click Add to add Maps to Interface ItaggedItem to the column header.

5. In the Maps to Interface box, type an interface definition name or select an existing interface definition name to map to from the list.

   In subsequent steps in the Manage Class Definitions wizard, you will be able to select the required class definitions that realize the interface definition for mapping.

6. Select the Object Action for the selected class definitions that realize the interface definition. For a list of object actions, see Actions.

   You can modify the action for a required class definition mapping in the Manage Class Definitions wizard in subsequent steps.

7. To add unique identifiers (UIDS) that match the selected class definitions, such as Tag, Plant Code, or Tag Name, click Create Unique Identifier .

   

   • The unique identifiers set here will be applicable for all the selected class definitions that realize the interface.

   • You can modify the Unique Identifier for each class definition mapping in the Manage Class Definitions wizard in subsequent steps.

   The unique identifiers (UIDs) must be set on all objects that Data Validator exports from the staging area. You must set the correct UID in the import mapping by setting up the UID definitions for any object mapping.

8. Select a column header from the Class Definition to Create Column list.

   This column header contains the target class definition name for identifying the associated class definition mapping related to the mapped interface definition and is used to create the appropriate staging objects while processing the CSV file.

9. Add a prefix for the object type if required, for example TG.

   Do not use MSR or HEX as a prefix, as these are reserved for the delivered mappings and may cause issues due to uniqueness constraints.

10. Select the Mandatory Object option to indicate that the column is required to have a value.

Manage Class Definitions wizard

You can use this wizard to create or update the mapping options for specific class definitions, by selecting the required class definitions from the list of all the class definitions that realize the interface definition.

1. Click Manage Class Definitions to open the Manage Class Definitions wizard.

2. Find the required class definition in the Associated Class Definitions pane, and move it to the Selected Associated Class Definitions pane.

   

   • To remove a class definition from the Selected Associated Class definitions list, select the class definition in the Selected Associated Class Definitions pane, and click Remove .

   • Click Filter to select multiple class definitions using the filter criteria.

3. Click Next.

4. Select the class definition from the Associated Class Definition pane and make the required changes in the Maps to Object pane.

   

   • These changes will override the options specified in the Maps to Interface box for the selected class definition.

   • Clear the Sync with interface map values check box to enable the options to be modified.

5. To add optional interfaces for the selected class definition, click Optional Interfaces .

   This option is available for object mapping with Create Update and Update actions.

   

   • The Select Optional Interfaces option allows you to select optional interfaces that are available for the selected class definition in the target system. The selected optional interfaces are instantiated on the objects during export.

   • If you do object mapping with the document revision class definition, the Select Optional Interfaces dialog box displays the optional interfaces for both the revision and version. If the selected optional interface is available for both the revision and version class definitions, during export the optional interface gets instantiated for both the revision and version objects.

6. Click Finish.

   You can view the realized class definitions in the Maps to Interface box.

7. Click Associated Class Definitions tab for a more detailed view of the class definitions.

8. Click Save.

• The Unique Key definition and Unique ID Definition boxes are populated with values that are configured for the class definition currently being mapped to. Once they are propagated, they are not updated again and must be updated manually by loading the class XML file with the new Unique ID Definition and Unique Key Definition.

• When any cell used to create the unique identifier is blank, an error is included in the validation report indicating which cell or cells are missing values.

• If an object in the target system already exists in the staging area, Data Validator will ask you to rename the object when saving.

• If the Mandatory Object option is selected and the column has no value, an error is included in the validation report.

• A property that has a value in the CSV file will be skipped during import in the following scenario:

  • Both the Ignore properties for blank values and the Is Mandatory options are selected during object mapping.

  • The value specified in the CSV file is a default value specified in the Text values that represent blank option in the System Options wizard.

  Validation errors will not occur during the validation stage.