Use > Data Flow Management > Adapter Management > Adapter Configuration > Adapter Management User Interface > Mapping Tool Editor Window

Mapping Tool Editor Window

Enables you to configure value and field mappings in a visualized way for complex integration configurations for data push, population, or federation integration scenarios.

To access

Select Data Flow Management > Adapter Management > Select a specific adapter in the Resources pane > Expand the Configuration Files folder:

  • Click a mapping file and click Yes in the popup window that asks if you want to open the configuration file with the new mapping tool editor
  • Right-click a mapping file and select Open Mapping Tool from the context menu
  • If you chose to open the mapping file with the XML editor, you can switch to the Mapping Tool by clicking the Open Mapping Tool icon at the top of the Script pane

Or, in the Configuration Files pane, double click a mapping file and click Yes in the pop-up window that asks if you want to open the configuration file with the new mapping tool editor.
Important information

The Mapping Tool window title bar includes the actual physical location of the script. For example, the following script is located in

C:\UCMDB\DataFlowProbe\runtime\probeManager\
discoveryConfigFiles/AMPushAdapter/mappings

(or probeGateway\AMPushAdapter/mappings)
See also

User interface elements are described below:

UI Element (A–Z) Description
Save. Saves the changes you made to the mapping file.
Validate Mapping File. Validates the mapping file you created, edited, or modified.
Open XML Editor. Enables you to switch back to the default script editor.
<Panes>

The Mapping Tool Window panes are described below:

Local Query Pane

Displays a hierarchical tree structure of the local TQL query in the CMDB.

Relevant tasks
See also How to Add Query Nodes and Relationships to a TQL Query

User interface elements are described below:

UI Element Description
Query: <Query Name>. Displays the name of the currently selected integration TQL query found in CMDB.
Add TQL Queries. Opens the Add Queries dialog box, enabling you to select and add available integration TQL queries from the Available items pane to the Selected items pane, so that you can map items from them.
Refresh TQL Query Representation. Refreshes the query representation.
Expand All. Expands the entire hierarchical tree structure to display all of the items available under the integration TQL queries.
Collapse All. Collapses the hierarchical tree structure, leaving the top-level integration TQL query showing.
(for Population or Federation scenario) Add Node to Mapping for Population scenario. Enables you to add the selected node to the mapping.
(for Push scenario) Add Node to Mapping for Push and Federation scenarios. Enables you to add the selected node to the mapping.

(Local Query) Attributes Pane

The Attributes pane for the Local Query pane displays attributes of a local integration TQL query.

User interface elements are described below:

UI Element (A–Z) Description
(for Population or Federation scenario)

Add Attribute to Mapping. Enables you to add the selected attribute to the mapping.
(for Push scenario)

Add Attribute to Mapping. Enables you to add the selected attribute to the mapping.
<Attributes table>

The Attributes table contains the following columns:

  • Status. Status of an attribute.
  • Display name. Display name of an attribute.
  • Name.Name of an attribute.
  • Type. Type of an attribute.
  • Description. Detailed description of an attribute.

Visual Mapping Pane

Allows you to establish mappings for items you selected from the Local Query pane and the External Class Model pane in a visual way.

User interface elements are described below:

UI Element (A-Z) Description
Update Info Tag. Opens the Update Info Tag dialog box, enabling you to modify and update the information about the data repositories being integrated, including Name, Version, and Vendor for both source and target data repositories.
Update Import Tag. Opens the Update Import Tag dialog box, enabling you to select and add available items and import new groovy scripts. You can also move up or down the sequence of a script to decide the order of scripts to be imported.

Update Optional Tags. Opens the Update Optional Tags dialog box, enabling you to update optional tags by defining values for the Type, Is Valid, and Is Deleted fields. You can also select the Show Warning check box to display warning messages.

Note: This button is not available for the source_instance element.

Add For Each Tag. Opens the Add For Each Tag dialog box, enabling you to define the source and the index for the tag that you want to add for each child mappings under the current parent entity:

  • Source Entities. Defines the source entities for the tag.
  • Count Index. Defines the start index when iterating over the source entities.
  • Var Name. (Optional) Specifies the variable name for the tag.

Add Variable Tag. Opens the Add Variable Tag dialog box, enabling you to define and add variable tags to the selected variable element:

  • Name. Specifies name for the variable.
  • Type. Select a value from the drop-down list as type of the variable.
  • Value. Specifies a value for the variable.
Note: This button is not available for the source_instance element.
Add Custom Section. Enables you to add an empty mapping element, where you can manually define a new mapping element that may not fall into any of the existing mapping categories.
Revert Changes. Allows you to revert the changes you just made.
Clear Entire Mapping. Enables you to clear the entire mapping.

Remove Node. Enables you to remove a selected node or attribute mapping association from the mapping file.
Expand All. Expands the entire hierarchical tree structure to display all of the mapping elements.
Collapse All. Collapses the hierarchical tree structure, leaving the top-level integration mapping showing.
<Groovy Function Viewer>

Each time you select a target mapping that contains a groovy function, this component is displayed.

Also, when you edit a target mapping and fill in some groovy function, you can preview the code of that function.

Note: The current version supports only one function per line.
<In the Visual Mapping pane>

The visual representation of mapping relationship elements inside the Visual Mapping pane are described below:

  • - Represents the root integration tag in the Visual Mapping pane.
  • - Represents a source_instance root element. The Root Element Name attribute field is editable in the Visual Mapping pane.
  • - Represents a target_entity element. This is the default icon. The icon of any target_entity can be customized at the adapter level. For details, see Configure Icons for Mapping Entities.
  • - Represents a variable mapping element. The Name attribute, Datatype, and Value attribute fields are all editable. When you edit the value in the Value attribute field, the groovy function viewer shows up, allowing you to view the XML script for the groovy function.

  • - Represents an attribute mapping of the target_mapping element.

    • For population and federation scenarios, the name value is read-only, and the Value attribute field is editable.
    • For push scenario, both the Name attribute and Value attribute fields are editable.
  • - Represents a for-each-source-entity tag. You can define values for the Source Entities attribute, Count Index attribute, and Var Name attribute fields.
  • - Represents a custom tag that you define.

External Class Model Pane

Displays a hierarchical tree structure of the external class model.

User interface elements are described below:

UI Element Description
Refresh External Class Model. Refreshes the external class model.
Expand All. Expands the entire hierarchical tree structure to display all of the items available under the external class model.
Collapse All. Collapses the hierarchical tree structure, leaving the top-level external class model showing.

Add New CI Type to External Class Model. Opens the Add New CI Type to External Class Model dialog box, enabling you to define the following properties for a new CI type so as to add the new CI type to the external class model:

  • Name. Specify the name for the new CI type.
  • Description. (Optional) Detailed description of the CI type.
Note: This button is enabled only if the adapter setting enable.classmodel.changes is set to true inside the Adapter Source Editor.
(for Push scenario) Add Node to Mapping. Enables you to add the selected node to the mapping.
(for Population or Federation scenario) Set Node as Root Element. Enables you to set the selected node as root element in the mapping.

(External Class Model) Attributes Pane

The Attributes pane for the External Class Model displays attributes of an external class model.

User interface elements are described below:

UI Element (A–Z) Description
(for Push scenario)

Add Attribute to Mapping. Enables you to add the selected attribute to the mapping.
(for Population or Federation scenario)

Add Attribute to Mapping. Enables you to add the selected attribute to the mapping.

Add New Attribute to Selected External Node. Opens the Add New Attribute dialog box, enabling you to define the following properties for a new attribute so as to add it to the selected external node:

  • Name. Specify the name for an attribute property.
  • Display Label. Specify the display label for an attribute property.
  • Description. (Optional) Detailed description of the attribute property.
  • Type. Select a value from the drop-down list as type of the attribute property.
Note: This button is enabled only if the adapter setting enable.classmodel.changes is set to true inside the Adapter Source Editor.
<Attributes table>

The Attributes table contains the following columns:

  • Status. Status of an attribute. indicates that the concerning attribute is marked as Mandatory inside the adapter configuration.
  • Display name. Display name of an attribute.
  • Name. Name of an attribute.
  • Type. Type of an attribute.
  • Description. Detailed description of an attribute.

XML Editor Pane

User interface elements are described below:

UI Element Description
Find Text. Opens the Find Text dialog box, enabling you to find text in the selected script file. For more information, see Find Text Dialog Box.
Go to Line. Opens the Go To Line dialog box, enabling you to jump to a specific line in the script file. Enter the line number and press Enter.
Save. Saves the changes you made to the mapping configuration file.
<Script Editing Pane> Displays the XML script and allows you to edit the script manually. The script displayed in the XML Editor pane corresponds to the hierarchical tree element you selected in the Mapping UI pane.

Send Help Center feedback