You can map source and target elements using certain buttons on the Tool Bar. These buttons are explicated as:
- One To One Mapping ( )
- Auto Mapper ( )
- Remove All Mappings ( )
One to One Mapping
If the number of leaf elements of the parent element in the source and target schema is same, then you can use the One to One mapping button to map all the source elements to the corresponding target elements.
Steps to use One to One mapping
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Click and drag the parent element of the source schema to the parent element of the target schema. This will apply template of the source parent element on the target parent element, and activate the One to One Mapping button.
- Click One to One Mapping ( ) button. All the leaf elements of the parent element in the source schema will be mapped to their respective leaf elements of the parent element in the target schema.
Only leaf elements are mapped using this button. It does not map complex elements. To map complex elements, you need to use the drag and drop method.
If multiple schemas are loaded, then dragging a source parent element will map all leaf elements of schemas displayed previous to the current schema.
Moreover, in multiple schemas, mapping can be performed between parents at any level, if the number of their leaf elements is the same.
Auto Mapper
If the hierarchy and the names of the complex elements are similar, then you can use the Auto Mapper option to map the source elements to the corresponding target elements. In case of complex elements, the hierarchy and the name of all elements must be the same.
Steps to use the Auto Mapper
Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes. Additionally, the hierarchy and name of the all elements is the same (see Figure 395).
Figure 395: Same Hierarchy and Element NamesClick Auto Mapper (
) button. The Auto Mapper Options dialog box is displayed (see Figure 396).
Figure 396: Auto Mapper Options- Select the mapping criteria from the Choose the Criteria dropdown list. Its options are listed as:
- Ignore Case: The source and the target elements are mapped even if they are of different case. Their attributes are not mapped.
- Case Sensitive: The source and target elements are mapped only if they are of the same case. Their attributes are not mapped.
- Ignore Case and Include Attributes: The source and target elements and their attributes are mapped even if they are of different case.
- Case Sensitive and Include Attributes: The source and target elements and their attributes are mapped, only if they are of the same case.
- Consider Only Leaf Element Count: The source and target elements are mapped only if the number of leaf elements in the source schema and target schema are the same. It is not necessary that names of source and target elements are similar. Their attributes are not mapped.
- Consider Only Leaf Element Count and Include Attributes: The source and target elements and their attributes are mapped only if the number of leaf elements in the source schema and target schema are the same. It is not necessary that names of source and target elements are similar.
- Click OK button. All elements of the source and target schema will automatically be mapped based on the selected criteria (see Figure 397).
Figure 397: Mapped Elements using Auto Mapper
Remove All Mappings
You can use the Remove All Mappings option to remove all mappings from the Data Mapper.
Steps to remove all mappings between source and target elements
Click Remove all Mapping (
) button. The Remove Options screen is displayed (see Figure 398).This screen displays a list of the properties, variables, custom methods, keys and templates associated with a mapped element, which can be removed with the mapping.Figure 398: Remove Options
You can remove mapping associated with each element individually. For details, refer to the section Remove Mapping of an Element.
Select the checkbox(s) of the options that you want to remove and click OK button. All the selected options and all mappings between source and target elements will be removed.
You can remove mapping associated with each element individually. For details, refer to the section Remove Mapping of an Element.
Custom Auto Map
The Auto Mapper feature can be used only when the elements of source and target schema are at the same hierarchy level and have the same names. However, if you want to automatically map the elements when the names of the elements of source and target schemas are different, you cannot use this feature. For example, if the source schema has elements, EmpFirstName and EmpLastName and the target schema has the elements, firstName and lastName then you cannot define mapping between these two schemas using the Auto Mapper feature.
To define a mapping between the schemas when the elements of source and target schema are at the different hierarchy level (which may include elements at the different parent and child level) and have the different names, you can use the Custom Auto Map feature. This feature enables you to define the mapping between such schemas where elements to be mapped are stored in different parent and child level and in addition elements name are different.
Scope of a Custom Auto Map
You can also select the scope of a Custom Auto Map at the time of defining and saving it. Scope of a Custom Auto Map is the context within which it is defined and is accessible within or across the user groups. A Custom Auto Map can be defined in any of the following scope:
- Global: The Custom Auto Maps defined within Global scope are available within all the mapping activities. Once you create a global Custom Auto Map in a mapping activity, you can use it in all the mapping activities.
- Group: The Custom Auto Maps defined within Group scope are available only within the specific user group.
By default, a Custom Auto Map is saved in the Global scope and in the Parameter Panel; it is added and displayed under the folder Custom Auto Map/Global. If you select to save the Custom Auto Map in the Group scope then in the Parameters Panel, it is added and displayed under the folder Custom Auto Map/Group. You can also change the scope of a Custom Auto Map from Group to Global directly from the Parameters Panel by right-clicking the Custom Auto Map and selecting the Move to Global option. However, you cannot change the scope of a Custom Auto Map from Global to Group.
The high-level steps to use Custom Auto Maps are:
- Defining a Custom Auto Map
- Activating a Custom Auto Map
- Using a Custom Auto Map in Mapping
In addition, you can also manage a Custom Auto Map from the Parameters Panel.
Defining a Custom Auto Map
You can define a Custom Auto Map by both manually providing the names of the source and target elements to be mapped in the Custom Auto Map Dialog screen or by defining the names of source and target elements to be mapped in a CSV file and then loading the CSV file in the Custom Auto Map Dialogscreen. Loading a CSV file is useful when you have a large set of source and target elements to be mapped.
Defining a Custom Auto Map Using a CSV File
Steps to Manually Define a Custom Auto Map
Ensure that the source and target schemas are loaded in the Data Mapper and all their elements are listed under their respective nodes (see Figure 399).
Figure 399: Source and Target Schemas with different Element Names
Click the Custom Auto Map
button on the tool bar or select Custom Auto Map from the Actions menu. The Custom Auto Map Dialog screen is displayed (see Figure 400).Figure 400: Custom Auto Map Dialog screen
- Enter the name of Custom Auto Map in the Name textbox.
Select the scope of the Custom Auto Map. By default, the radio button Global is selected and a Custom Auto Map is saved in the Global scope.
If you want to save the Custom Auto Map within the current user group, select the Group radio button. This will save the Custom Auto Map as the group Custom Auto Map and can be used in any mapping activity within the current user group. In the Parameters panel, the Custom Auto Map will be displayed under the folder hierarchy Custom Auto Map/Group.
- Click the Add button to add a new row for Source Element and Target Element columns. You can also add a row by pressing the Enter key. This will add the row immediately next to the row which is currently selected.
- Enter the name of the source element for which you want to define Custom Auto Map in the Source Element column.
Enter the name of the target element to which you want to map the source element specified in previous step, in the Target Element column (see Figure 401).
Figure 401: Custom Auto Map DialogIf you need to delete any row, select the respective row and click the Delete button.
- Click the Save & Close button to save the Custom Auto Map. This will add the Custom Auto Map in Custom Auto Map hierarchy in theParameter Panel. Similarly you can add more Custom Auto Map (see Figure 402 ).
Figure 402: Parameters Panel
If you need to close the Custom Auto Map without saving it, click the Close button.
Defining a Custom Auto Map Using a CSV File
The Custom Auto Map feature also enables you to load a Comma Separated Values (CSV) file. You can use the set of values from the csv file which are separated by comma as a Map set for your process flow. For example, if you want to map the following source and target elements:
Source Element | Target Element |
EmpFirstName | firstName |
EmpLastName | lastName |
EmpMiddleInitial | middleNames |
Then, you can define the set of values in a csv file as:
- EmpFirstName,firstName
- EmpLastName, lastName
- EmpMiddleInitial, middleNames
Steps to Define a Custom Auto Map Using a CSV File
- In the Custom Auto Map Dialog screen, enter the name of Custom Auto Map in the Name textbox.
Click the CSV
button to load a csv file if you want to map the values using the values defined in the csv file. The server will consider the comma separated pair of values as the source and target elements to be mapped (see Figure 403).Figure 403: Custom Auto Map Dialog: Load CSV
An Open window is displayed.
- Browse and select the respective csv file.
- Click Open to upload the csv file. This will populate the source and target elements columns with the values defined in the CSV file. .
Select the scope of the Custom Auto Map (see Figure 404).
Figure 404: Custom Auto Map Dialog
- Click the Save & Close button to save the Custom Auto Map. This will add the Custom Auto Map value map in Custom Auto Map hierarchy in the Parameter Panel (see Figure 424).
Figure 405: Parameters Panel
Similarly you can add more Custom Auto Maps.
Activating a Custom Auto Map
When you define a Custom Auto Map, by default it is in deactivated state. To use a Custom Auto Map, you need to first activate it. Once you have activated the Custom Auto Map, you can use it in your mapping. Note that only activated Custom Auto Maps can be used in a mapping.
Steps to Activate a Custom Auto Map
- In the Properties Panel, select the Custom Auto Map which you want to activate to use in a mapping.
Right-click the Custom Auto Map and select the option Activate (see Figure 406).
Figure 406: Parameters Panel: Custom Auto Map Activate option
- The status of the Custom Auto Map changes to Active (see Figure 407).
Figure 407: Parameters Panel: Custom Auto Map Status
You can now use this Custom Auto Map in your mapping. Similarly, right-click the Custom Auto Map and select the option Deactivate to deactivate a Custom Auto Map.
Using a Custom Auto Map
After activating a Custom Auto Map, you can use it in your mapping. Note that only one Custom Auto Map can be activated in the current mapping.
Steps to Use the Custom Auto Map in a Mapping
- Load the respective source and target schema.
- Create and activate the Custom Auto Map.
- Map the parent record of the Source schema to the parent record of the Target schema.
Right-click the parent record of the target schema and select Connect Matching Record options (see Figure 408).
Figure 408: Select Connect Matching Children
The Connect Matching Children Dialog window is displayed (see Figure 409).
Figure 409: Connect Matching Children Options
- Select the mapping criteria from the Automap options list. Its options are listed as:
- Ignore Case: The source and the target elements are mapped even if they are of different case. Their attributes are not mapped.
- Ignore Namespace: The source and target elements are mapped, when their names are same but source schema has any namespace prefix.
- Recursive: Elements of parent level as well as all child level with the corresponding target elements.
- Mix Attributes: Attributes of source and target schemas are mapped.
- Select the mapping criteria from the Existing Options list. These options are :
- Retain: If any source and target elements are already mapped, those mapping will not be overwritten.
- Overwrite: Overwrites all the existing mappings.
Click OK. This will map source and target schema as per the criteria selected (see Figure 410)
Figure 410: Source and Target elements are mapped
Managing a Custom Auto Map from Parameters Panel
You can also manage the Custom Auto Map from the Parameters Panel. When you right-click the Custom Auto Map in the Parameters Panel, you can perform the following operations on a Custom Auto Map:
- Edit a Custom Auto Map
- Move a Custom Auto Map from Group to Global
- Delete a Custom Auto Map
Editing a Custom Auto Map
In edit mode, you can edit the name of the Custom Auto Map and the source and target elements to be mapped. Note that you cannot edit the scope of a Custom Auto Map in edit mode. The radio buttons to select the scope becomes non-editable once you save the Custom Auto Map. However, you cannot edit the Custom Auto Map when it has been already been used in the mapping and that mapping has been saved.
Steps to Edit a Custom Auto Map
- In the Properties Panel, select the Custom Auto Map to be edited.
Right-click the Custom Auto Map and select the option Edit (see Figure 406).
Figure 411: Parameters Panel: Custom Auto Map Edit option
The Custom Auto Map is open in Edit mode (see Figure 412).
Figure 412: Custom Auto Map Dialog screen in Edit mode
- Click the Save & Close button to save the Custom Auto Map.
Moving a Custom Auto Map from Group to Global
You can also change the scope of a Custom Auto Map from the Parameters Panel by moving the Custom Auto Map from Group to Global. However, you cannot move a Custom Auto Map if it is in the activated state and has been used in mapping. In addition, you cannot move a Custom Auto Map from Global toGroup.
Steps to Move a Custom Auto Map
- In the Properties Panel, select the Custom Auto Map which you want to move from group to global.
Right-click the Custom Auto Map and select the option Move To Global (see Figure 429).
Figure 413: Parameters Panel: Move to Global option
A warning message is displayed (see Figure 430).
Figure 414: Warning Message- Click Yes to confirm moving the Custom Auto Map from Group to Global (see Figure 431).
Figure 415: Change Scope in Parameters Panel
This will change the scope of the selected Custom Auto Map and now the Custom Auto Map will be displayed under the Global folder.
Deleting a Custom Auto Map
Steps to Delete a Custom Auto Map
- In the Properties Panel, select the Custom Auto Map which you want to delete.
Right-click the Custom Auto Map and select the option Remove (see Figure 406).
Figure 416: Parameters Panel: Custom Auto Map Remove option
A warning message is displayed (see Figure 417).
Figure 417: Parameters Panel: Custom Auto Map Status
- Click Yes to confirm the deletion of selected Custom Auto Map. The selected Custom Auto Map will be deleted.
Using Value Map
The Value Map feature enables you to define a Map set for a particular value of an element. A Map set enables you to define the mapping values that will be used in the target schema against the values of the elements present in the source schema. For example, if you have a source schema, which has an element, Priority. This element stores the priority levels for the incoming emails and can have the values, Low, Medium, and High. You want to create a Map set for these values and want to map the values in the target schema as:
- For the source element 'High' the Map value for the target element will be 'H'.
- For the source element 'Low' the Map value for the target element will be 'L'.
- For the source element 'Medium' the Map value for the target element will be 'M'.
Scope of a Value Map
You can also select the scope of a Value Map at the time of defining and saving it. Scope of Value Map is the context within which it is defined and can be accessible within or across the user groups. A Value Map can be defined in any of the following scope:
- Global: The Value Maps defined within Global scope are available within all the mapping activities. Once you create a global Value Map in a mapping activity, you can use it in all the mapping activities.
- Group: The Value Maps Templates defined within Group scope are available only within the specific user group.
By default, a Value Map is saved in the Global scope and in the Parameter Panel; it is added and displayed under the folder Value Map/Global. If you select to save the Value Map in the Group scope then in the Parameters Panel, it is added and displayed under the folder Value Map/Group. You can also change the scope of a Value Map from Group to Global directly from the Parameters Panel by right-clicking the Value Map and selecting the Move to Global option. However, you cannot change the scope of a Value Map from Global to Group.
This section covers the following tasks:
- Defining a Value Map
- Using a Value Map in Mapping
- Managing a Value Map from the Parameters Panel
Defining a Value Map
You can define a Value Map by either manually providing the mapping values that will be used in the target schema against the values of the elements present in the source schema in the Value Map Dialog screen or by defining the mapping values that will be used in the target schema against the values of the elements present in the source schema in a CSV file and then loading the CSV file. Loading a CSV file is useful when you have a large set of values to be mapped.
Defining a Value Map Manually
Steps to Manually Define a Value Map
Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes (see Figure 418).
Figure 418: Elements of Source and Target Schema
Click the Value Map
button on the toolbar or select the option Value Map from the Actions menu. The Value Map Dialog screen is displayed (see Figure 419).Figure 419: Value Map Options Dialog screen
- Enter the name of Value Map (for example, PriorityMap) in the Name textbox.
Select the scope of the Value Map. By default, the radio button Global is selected and a Value Map is saved in the Global scope.
If you want to save the Value Map within the current user group, select the Group radio button. This will save the Value Map as the group Value Map and can be used in any mapping activity within the current user group. In the Parameters panel, the Value Map will be displayed under the folder hierarchy Value Map/Group.
- Click the Add button to add a new row for Value and Map columns. You can also add the row by pressing the Enter key. This will add the row immediately next to the row which is currently selected.
- You can also provide the default Map value in the Default Value field (for example, Normal). In case if at the source side any value is not provided then the value provided in the Default Value field will be mapped to the target element (see Figure 420). For example, if you want to map the priority of the mail as:
- For the source element 'High' the Map value for the target element will be 'H'.
- For the source element 'Low' the Map value for the target element will be 'L'.
- For the source element 'Medium' the Map value for the target element will be 'M'.
For the source element which is not provided the target element will be mapped to 'Normal' as defined in the Default Value field.
Figure 420: Value Map Select the checkbox Pick from Source if you want to use the source element as the map value for the target element or if you do not want to use the default value as the Map value. For example, if there is a source element 'Normal' then the Map value for the corresponding target element will be 'Normal' and for the source element which is not provided the Map value for the target element will also be a blank.
If you need to delete any row, select the respective row and click the Delete button.
Click the Save & Close
button to save the Value Map. This will add the Value Map in Value Map hierarchy in the Parameter Panel. Similarly you can add more Value Map.
Figure 421: Parameters Panel
If you need to close the Value Map without saving it, click the Close button.
Defining a Value Map Using a CSV File
The Value Map feature also enables you to load a Comma Separated Values (CSV) file. You can use the set of values from the csv file which are separated by comma as a Map set for your process flow. For example, if you want to change the values defined for the priority of mail as:
- For the source element 'High' the Map value for the target element is 'H'.
- For the source element 'Low' the Map value for the target element is 'L'.
- For the source element 'Medium' the Map value for the target element is 'M'.
Then, you can define the set of values in a csv file as:
Low,L
Medium,M
High,H
Steps to Define a Value Map Using a CSV File
- In the Value Map Dialog screen, enter the name of Value Map (for example, PriorityMap_forcsvfile in the Name textbox.
Click the CSV
button to load a csv file if you want to map the values using the values defined in the csv file. The server will consider the comma separated pair of values as the target element and its mapped value (see Figure 422).Figure 422: Value Map Dialog: Load CSV
An Open window is displayed
- Browse and select the respective csv file.
- Click Open to upload the csv file. This will populate the Value and Map columns.
- Select the scope of the Value Map.
Enter the default value in the Default Value field (see Figure 423).
Figure 423: Value Map Dialog screen
- Select the Pick from Source checkbox, if required.
- Click the Save & Close button to save the Value Map. This will add the Value Map value map in Value Map hierarchy in the Parameter Panel. Similarly you can add more Value Maps (see Figure 424).
Figure 424: Parameters Panel
Using a Value Map in a Mapping
Steps to Use the Value Map in a Mapping
- Now to map it, select a target element, for example Priority. The selected target element is shown in Mapping Graph Area.
- Double click on a value map you want to use, from the Value Map hierarchy of Parameter Panel. For example, PriorityMap.
- Now double-click the source element. For example, Priority.
Connect the output of the source element to input of value map and then connect the output of value map to the input of the target element (see Figure 425).
Figure 425: Use Auto Map in a Mapping
- Once you have performed the mapping activity, click Apply Mapping ( ) button to save the mapping. The mapping will be applied (see Figure 426).
Figure 426: Mapping between the Source and Target Schema
Managing a Value Map from Parameters Panel
You can also manage the Value Map from the Parameters Panel. When you right-click the Value Map in the Parameters Panel, you can perform the following operations on a Value Map:
- Edit the Value Map
- Move a Value Map from Group to Global
- Delete a Value Auto Map
Editing a Value Map
In edit mode, you can edit the name of Value Map and the map set for an element value. Note that you cannot edit the scope of a Value Map in edit mode. The radio buttons to select the scope becomes non-editable once you save the Value Map. The radio buttons to select the scope becomes non-editable once you save the Value Map. However, you cannot edit the Value Map when it has been already been used in the mapping and that mapping has been saved.
Steps to Edit a Value Map
- In the Properties Panel, select the Value Map to be edited.
Right-click the Value Map and select the option Edit (see Figure 406).
Figure 427: Parameters Panel: Value Map Edit option
The Value Map is open in Edit mode (see Figure 412).
Figure 428: Value Map Dialog screen in Edit mode
- Click the Save & Close button to save the Value Map.
Moving a Value Map from Group to Global
You can also change the scope of a Value Map from the Parameters Panel by moving the Value Map from Group to Global. However, you cannot move a Value Map if it is has been used in mapping and that mapping has been saved. In addition, you cannot move a Custom Auto Map from Global to Group.
Steps to Move a Value Map
- In the Properties Panel, select the Value Map which you want to move from group to global.
Right-click the Value Map and select the option Move To Global (see Figure 429)
Figure 429: Change Scope in Parameters Panel
A warning message is displayed (see Figure 430).
Figure 430: Warning Message
- Click Yes to confirm the change of scope from Group to Global (see Figure 431).
Figure 431: Change Scope in Parameters Panel
This will add the change the scope of the selected Value Map and now the Value Map will be displayed under the Global folder.
Steps to Delete a Value Map
- In the Properties Panel, select the Value Map which you want to delete.
Right-click the Value Map and select the option Remove (see Figure 406).
Figure 432: Parameters Panel: Value Map Remove option
A warning message is displayed (see Figure 417).
Figure 433: Application MessageClick Yes to confirm the deletion of selected Value Map. The selected Value Map will be deleted.