Data Mapper is a visual data-mapping tool used for mapping elements in advanced data integration projects. This tool allows you to specify source and target schemas and to map data fields from source schema to target schema.
...
This is the default and most commonly used method for mapping source and target elements.
Steps to map elements using Drag and Drop approach
...
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
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.Info 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.
Info 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.Anchor automapper automapper
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
...
| Anchor | ||||
|---|---|---|---|---|
|
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
Info The Remove Mapping, Remove Comments, Remove For Each and Remove Local Variables options are always enabled. The other options are enabled only if they have been defined for the mapped 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.
Info You can remove mapping associated with each element individually. For details, refer to the section Remove Mapping of an Element.
Anchor CustomAutoMap CustomAutoMap Anchor _Toc226191056 _Toc226191056 Anchor _Toc315524635 _Toc315524635
Custom Auto MapThe 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.Anchor _Toc315524907 _Toc315524907
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.Anchor _Toc344890217 _Toc344890217 Anchor _Toc385441547 _Toc385441547 Anchor _Toc387747386 _Toc387747386 Anchor _Toc387748659 _Toc387748659
Scope of a Custom Auto MapYou 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:Anchor _Toc401308956 _Toc401308956
...
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
...
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).
...
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
...
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 to Group.
Steps to Move a Custom Auto Map
...
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
...
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
...
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
...
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
...
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
...
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
Click a target element. The target element node is displayed in the Mapping Graph Area (see Figure 439).
Figure 439: Select Target Element
Double-click a source element. The source element is displayed in the Mapping Graph Area (see Figure 440).
Figure 440: Select Source Element
Info You can double-click more source elements if required. This will display the selected source elements in the Mapping Graph Area (see Figure 441).
Figure 441: Select Second Source Element- Click the desired mapping function. This displays a list of sub-functions associated with the selected mapping function.
- Select the desired sub-function and use it to map the displayed source and target elements.
Once you have performed the mapping activity, click Apply Mapping (
) button to save the mapping.Info Once you have mapped source and target elements, you can view and validate the generated mapping XSL, from the Data Mapper screen. You can also view the target XML and view and validate mapping output from this screen.
For details on using these mapping functions, refer to the section Using Mapping Functions.
While mapping elements, certain suffixes are displayed next to source and target elements in the Source and Target Panels. These suffixes are explained in the table below.Anchor suffixestable suffixestable Anchor _Toc144313774 _Toc144313774 Anchor _Toc144827052 _Toc144827052 Anchor _Toc156195256 _Toc156195256 Anchor _Toc177878233 _Toc177878233 Anchor _Toc208651128 _Toc208651128
Table 8: Suffixes of Source and Target ElementsAnchor _Toc315524507 _Toc315524507 Suffix
Description
(C)
Target element can be cloned to create another target element.
(CM)
Comments have been added for the target element.
(F)
For Each property has been applied for the target element.
(LV)
A local variable has been declared to the target element.
Info More than one suffix can be displayed next to a source and target element.
Anchor _Toc131572369 _Toc131572369 Anchor _Toc134848108 _Toc134848108 Anchor savemapping savemapping Anchor _Toc144023031 _Toc144023031 Anchor _Toc144314277 _Toc144314277 Anchor _Toc177977117 _Toc177977117 Anchor _Toc184405098 _Toc184405098 Anchor _Toc226191060 _Toc226191060 Anchor _Toc315524640 _Toc315524640 Anchor _Toc315524912 _Toc315524912 Anchor _Toc344890226 _Toc344890226 Anchor _Toc385441556 _Toc385441556 Anchor _Toc387747395 _Toc387747395 Anchor _Toc387748668 _Toc387748668
Save Mapping and Exit Data MapperOnce you have mapped source and target elements, you can save the mapping and exit the Data Mapper.Anchor _Toc401308965 _Toc401308965
Steps to save the mapping and exit the Data Mapper- Click the File menu and select Save to save the mapping. Alternately, you can click the Save (
) button on the toolbar. The server first validates the mapping activity. If successful, it displays a dialog box confirming that the mapping has been saved successfully. If the Comments property is enabled, then clicking Save will display a screen where you need to enter comments related to the mapping. (see Figure 442).
...
- Click the Save To Server button to save the mapping object to the Adeptia Suite. A screen is displayed where you need to enter comments related to the mapping. (refer to Figure 442).
- Enter comments in the Specify comments for mapping object <object name> field.
- Click OK to save the comments. This displays a confirmation dialog box stating that the mapping has been saved successfully. The control returns to the Manage Data Mapping screen, where a list of mapping activities is displayed.
Refresh the Internet browser to view the saved mapping activity.
You can view and validate the generated mapping XSL, view the mapping XML and view and validate mapping output, before saving the mapping activity.
At times, on saving a mapping activity, the memory usage may exceed its actual capacity depending on the JVM and the operating system.
Anchor _Hlt131564978 _Hlt131564978 Anchor _Toc131572370 _Toc131572370 Anchor _Toc134848109 _Toc134848109 Anchor _Toc144023032 _Toc144023032 Anchor _Toc144314278 _Toc144314278 Anchor viewvalidateXSL viewvalidateXSL Anchor _Hlt147205458 _Hlt147205458 Anchor _Toc177977118 _Toc177977118 Anchor _Hlt184625356 _Hlt184625356 Anchor _Hlt184625437 _Hlt184625437 Anchor _Hlt184625564 _Hlt184625564 Anchor _Hlt184625613 _Hlt184625613 Anchor _Toc226191061 _Toc226191061 Anchor _Toc315524641 _Toc315524641
View and Validate Generated Mapping XSLAnchor _Toc315524913 _Toc315524913
This is a very useful feature of the Data Mapper. It enables you to validate and test the generated XSL before saving the mapping activity.Anchor _Hlt147205454 _Hlt147205454
Steps to view and validate the generated mapping XSL- Click the XSL tab on the Tabs Panel to view the generated mapping XSL. The generated XSL code with line numbers is displayed (see Figure 445).
...
Click the Action menu and select Validate XSL option to validate the generated XSL. A dialog box is displayed confirming that the XSL is valid.
If generated XSL is invalid, then an error is displayed as a selected line. Error details are displayed in the XSL Errors Pane. It displays one error at a time.
Click OK to close the above dialog box.
You can also validate the generated XSL from the Create Data Mapping screen. For more details, refer to the section Splitting Source Data.
Anchor viewtargetXML viewtargetXML Anchor _Toc131572371 _Toc131572371 Anchor _Toc134848110 _Toc134848110 Anchor _Toc144023033 _Toc144023033 Anchor _Toc144314279 _Toc144314279 Anchor _Toc177977119 _Toc177977119 Anchor _Toc226191062 _Toc226191062 Anchor _Toc315524642 _Toc315524642
View Mapping XMLThe Data Mapper allows you to view the generated XML code, before saving the mapping activity.Anchor _Toc315524914 _Toc315524914
Steps to view Mapping XML- Click the View menu and select View Mapping XML option. This displays the generated XML code with line numbers, in read-only mode (see Figure 446).
...
Once you have mapped source and target schema elements, you can view and validate the output of the mapping activity. This feature enables you to test the data and make modifications to the mapping activity, before saving it.
Steps to view and validate mapping output
- Click the Debugger tab on the tabs panel to view and validate the output of the mapping activity. The Debugger is displayed on the Data Mapper screen (see Figure 447).
...
Schema | Tree View | Grid View |
|---|---|---|
Adv. Text Schema | ? | X |
Excel Schema | ? | ? |
Hierarchical Excel Schema | ? | X |
Text Schema | ? | ? |
XML Schema | ? | X |
Adv. Positional Schema | ? | X |
Positional Schema | ? | ? |
Steps to use Data Viewer
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Map source and target elements and apply the mapping rule as per your need.
- To use Data Viewer, click the Data Viewer tab. The Data Viewer panel is displayed (see Figure 450).
...
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
Steps to view mapping activity in PDF format
- On the Adeptia Suite homepage, go to Configure > Services > Data Transform and then click Data Mapping.
...
If you have read-only rights, you can still view a mapping activity. You can view the applied mapping, create new mapping rules, edit existing mapping rules and run simulation. However, you cannot save the mapping activity.
Steps to view mapping in read-only mode
- On the Adeptia Suite homepage, go to Develop > Services > Data Transform and then click Data Mapping.
...
Splitting feature enables you to process large files. You must use splitting if your source file is huge. If you do not use splitting in this case, then Data Mapper may not be able to map it. If the data in the source file is huge, you can split the source data into different chunks. You can specify the size of the chunks in terms of the number of records or data streams. In the output, however, only one file is generated at the location specified in the target activity.
Steps to split the source data
- Click Advanced Properties on the Create Data Mapping screen to expand the advanced properties of the new Mapping activity (see Figure 465).
...
| |
| -R1C1 |
| -R1C2 |
| |
| -R2C1 |
| -R2C2 |
It is advised to always split the file and set the Splitter XPath if the file size is greater than 30 MB. This enhances the performance and increases data reliability, as in some cases such execution of large data can fail and generate errors. |
Steps to set Splitter XPath
- Ensure that all the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Right-click the source schema element that you want to split and select the Set as Splitter XPath option. A screen showing the Splitter XPath details is displayed (see Figure 466).
...
Click OK. This splits and sets the Splitter XPath on the selected source element.
Once a Splitter XPath is set for a source element, the letter (S) is displayed next to that source element. This signifies that the source element has been split and the Splitter XPath has been set. Refer to Table of Suffixes for details on suffixes displayed next to an element.
Once you have set a Splitter XPath, you can view it in the Output XML.Anchor _Toc226191069 _Toc226191069 Anchor _Toc315524649 _Toc315524649 Anchor _Toc315524921 _Toc315524921 Anchor _Toc344890232 _Toc344890232 Anchor _Toc385441562 _Toc385441562 Anchor _Toc387747401 _Toc387747401 Anchor _Toc387748674 _Toc387748674
Enabling Quick SplittingAnother way of splitting source data is to enable the quick splitting feature. This splits the source and sets the Splitter Xpath.Anchor _Toc401308971 _Toc401308971
Steps to split data by enabling quick splitting- Ensure that all the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Select Actions menu and select Enable Quick Splitting option. Alternately, you can press <Ctrl> + <Q>. This splits the data and displays the splitter Xpath details (see Figure 467).
...
Once a Splitter XPath is set for a source element, the letter (S) is displayed next to that source element. This signifies that the source element has been split and the Splitter XPath has been set. Refer to Table of Suffixes for details on suffixes displayed next to an element. |
Steps to view Splitter XPath
- Click View menu and select View Mapping XML. The Mapping XML window is displayed. The Splitter XPath details are displayed with a $Input tag prefixed to Source XPath code (see Figure 468).
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
You can remove a Splitter XPath that has been set for a source element.
Steps to remove Splitter XPath
- Right-click the source schema element whose Splitter XPath you want to remove and select the Remove Splitter XPath option. A screen showing the Splitter XPath details is displayed (see Figure 469).
...
Once you have split the source data by setting the Splitter XPath on a source element, you need to merge the split data at the target end. For this, you need to set the Merger XPath on a target element.
Setting the Merger XPath is largely dependent upon the Splitter XPath. You need to ensure that the number of Splitter XPaths and the Merger XPaths at the source and target schemas respectively are the same.
Steps to set Merger XPath
- Ensure that all the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Ensure that a Splitter XPath has been set for a source schema element.
- Right-click the target schema element on which you want to merge the split data and select the Set as Merger XPath option. A screen showing the Merger XPath details is displayed (see Figure 470).
...
Click OK. This merges the split data and sets the Merger XPath on the selected target element.
Once a Merger XPath is set for a target element, the letter (S) is displayed next to that target element. This signifies that the split data has been merged on the target element and the Merger XPath has been set. Refer to Table of Suffixes for details on suffixes displayed next to an element.
You can view Merger XPath details in the output XML. A $ input tag is prefixed to the line containing the Splitter XPath details.
When using Enable Quick Splitting feature, the Merger Xpath is also automatically set when this feature is selected.
- Once you have set a Merger XPath, you can view it in the Output XML.
Steps to view Merger XPath
- Click View menu and select View Mapping XML. The Mapping XML window is displayed. The Merger XPath details are displayed with Target XPath code (refer to Figure 468).
You can remove a Merger XPath that has been set for a target element.
Steps to remove Merger XPath
- Right-click the target schema element whose Merger XPath you want to remove and select the Remove Merger XPath option. A screen showing the Merger XPath details is displayed (see Figure 471).
...
When mapping multiple source and target schema elements, you need to assign streams to the root element of the target schema structures.
Steps to assign data streams
- Ensure that all the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Right-click the root element of a target schema structure and select the Assign Stream option. The Assign Streams dialog box is displayed (see Figure 472).
...
You can remove mapping associated with a particular element.
Steps to remove mapping of a particular element
- Ensure that all the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Right-click the target element whose mapping you want to remove and select the Remove Mappings option.
- The Remove Options window is displayed (see Figure 473).
...
First of all you need to create context schema definition. Context schema definition contains name of the context variable that you want to map to other element. While creating context schema definition, you can create context variables or you can import it from the process flow within which you want to use this mapping activity.
Steps to create Context Schema Definition
- In Data Mapper applet, from the Action menu and select Create Context Schema Definition. The Create Context Schema Definition Dialog window is displayed ( see Figure 474 ).
...
Once you have created the context schema, you need to load it at source or target end depending on your need.
Steps to Load Context Schema Definition
- To load the Context Schema at source end, click the Open Source Schema button in the source panel. Select Schema dialog box is displayed ( see Figure 477).
...
Once you created the mapping activity using context schema you need to changes its streaming properties while creating process flow using this mapping activity.
If Context Schema is loaded at source side then there is no need to provide the source (dummy source) stream to the Mapping activity. Similarly if Context schema is loaded at target side then Mapping activity will not generate any output stream, so there is no need to attach dummy target. To achieve this Generate Stream and Consume Stream property has been added to Data Mapper activity in the Process Designer. User can disable these properties based on whether Context schema is loaded at source or target side.
Steps to disable input and output stream of mapping activity
- While designing the process flow, double click the mapping activity that you have created using context schema definition. Properties of the mapping activity are displayed (see Figure 479 )
...
Change the value of Consume Stream or Generate Stream property to false.
If Context Schema is used at source side, then at run time the actual value of these context variables will be used in the Data mapping. Similarly if Context Schema is used at target side then the output of the data mapping will be parsed and corresponding new value of these context variables will be set.
Anchor _Using_Mapping_Functions_1 _Using_Mapping_Functions_1 Anchor _Toc315524658 _Toc315524658 Anchor _Toc315524930 _Toc315524930 Anchor _Toc344890237 _Toc344890237 Anchor _Toc385441567 _Toc385441567 Anchor _Toc387747406 _Toc387747406 Anchor _Toc387748679 _Toc387748679
Using Mapping FunctionsYou can map source and target schema elements using the various mapping functions built-in the Data Mapper. All these mapping functions comprise of sub-functions, which are used to map elements.Anchor _Toc401308976 _Toc401308976
Some mapping functions require use of constant values for mapping elements. For this, you need to add the constant node to the Mapping Graph Area.Anchor addconstant addconstant Anchor _Toc131572379 _Toc131572379 Anchor _Toc134848118 _Toc134848118 Anchor _Toc144023041 _Toc144023041 Anchor _Toc144314287 _Toc144314287 Anchor _Toc177977129 _Toc177977129 Anchor _Toc226191074 _Toc226191074 Anchor _Toc315524659 _Toc315524659
Adding a ConstantSteps to add a ConstantAnchor _Toc315524931 _Toc315524931 - Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Ensure that the source and target elements to be mapped are selected and displayed in the Mapping Graph Area.
- Right-click the blank space in the Mapping Graph Area and select the Constants option. A Constant node is displayed in the Mapping Graph Area (see Figure 480).
...
You can use the required sub-function of Math mapping function to map elements. The process of using the Math function is the same for all its sub-functions. Thus, the mapping process using one sub- function is outlined below.
Steps to map elements using the 'Division' Math Mapping Function
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Ensure that the source and target elements to be mapped are selected and displayed in the Mapping Graph Area.
You need to add a constant value for using this function. Once it is added, a Constant node with its value is displayed in Mapping Graph Area.Anchor defineconstant defineconstant - Click Math function menu and select the Division sub-function. A div node is displayed in the Mapping Graph Area (see Figure 482).
...
You can use the required sub-function of String mapping function to map elements. The process of using the String function is the same for all its sub-functions. Thus, the mapping process using one sub- function is outlined below.
Steps to map elements using the 'Concat' String Mapping Function
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
Ensure that the source and target elements to be mapped are selected and displayed in the Mapping Graph Area.
You need to load two source elements for using this mapping function.
Anchor _Ref184549363 _Ref184549363 Anchor _Toc208650665 _Toc208650665 Anchor _Toc239872343 _Toc239872343 Anchor _Toc315524205 _Toc315524205
Figure 484: Add Concat Sub-Function NodeAnchor _Toc401308546 _Toc401308546 - Create a link from the output of the first Source element to the first input of the concat node.
- Create a link from the output of the second Source element to the second input of the concat node.
- Create a link from the output of the concat node to input of the target element node (see Figure 485).
...
You can use the required sub-function of Date mapping function to map elements. The process of using the Date function is the same for all its sub-functions. Thus, the mapping process using one sub- function is outlined below.
Steps to map elements using the 'Date-Difference' Date Mapping Function
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Ensure that the source and target elements to be mapped are selected and displayed in the Mapping Graph Area.
You need to add a constant value for using this function. Once it is added, a Constant node with its value is displayed in Mapping Graph Area.
This function requires four inputs. The first input represents the value of Date1. The second input represents the value as the format of Date1. The third input represents the value as Date2. The fourth input represents the value as format of Date2. The Date1 and Date2 values can either be in the form of constants or XPath values. The formats of Date1 and Date2 are however always in the form of constants.
- Click Date mapping function and select Date-Difference sub-function. A date-difference node is displayed in the Mapping Graph Area (see Figure 486).
...
You can use the required sub-function of Aggregation mapping function to map elements. The process of using the Aggregation function is the same for all its sub-functions. Thus, the mapping process using one sub- function is outlined below.
Steps to map elements using the 'Sum' Aggregation Mapping Function
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Ensure that the source and target elements to be mapped are selected and displayed in the Mapping Graph Area.
- Click Aggregation function and select the Sum sub-function. A Sum node is displayed in the Mapping Graph Area (see Figure 488).
...
You can use the required sub-function of Conditional mapping function to map elements. The process of using the Conditional function is the same for all its sub-functions. Thus, the mapping process using one sub- function is outlined below.
| Anchor | ||||
|---|---|---|---|---|
|
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Ensure that the source and target elements to be mapped are selected and displayed in the Mapping Graph Area.
Click Boolean function menu and then select the >=Greater than Equal operator. A >= node is displayed in the Mapping Graph Area (see Figure 490).Anchor booleanmapping booleanmapping
...
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
Steps to pass output of mapping function or condition to a local variable
- Ensure that the [source and target schemas are loaded and all their elements are listed under their respective nodes.
- Click Node tab displayed in the Mapping Graph Area. All tabs of the Node tab are displayed.
- Click the Local Variables tab. The Local Variable pane is displayed. (refer to Figure 527).
- Click any target element to declare the local variable in the Local Variable pane.
- Click Local Variable Name text field and enter the name of the local variable you want to create (e.g.
BolSalary8K). Press the Tab or Enter key. This takes the control to the Local Variable Value field.Anchor OLE_LINK3 OLE_LINK3 - Enter the value of the local variable in the Local Variable Value field. In this example, you have to specify the WHEN condition as displayed in Figure 494.
...
- Click the Save Local Variable (
) button to save the declared local variable.
Steps to map Set-Context function using local variable
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Click the Node tab displayed in the Mapping Graph Area. All tabs of the Node tab are displayed.
- Click the Local Variables tab. The Local Variable pane is displayed. (refer to Figure 527).
- Click any target element to declare the local variable in the Local Variable pane.
- Click Local Variable Name text field and enter the name of the local variable you want to create (e.g. Var1). Press the Tab or Enter key. This takes the control to the Local Variable Value field.
- Click Context mapping function menu and select Set-Context sub-function. Syntax for Set-Context function is displayed in Local Variable Value field.
- Enter the process flow variable name you want to create (e.g. ContextVar) in the first argument of the Set-Context function.
- Enter the value of the variable in the second argument of the Set-Context function (see Figure 495).
...
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
Steps to declare Set-Context function globally
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Click the Global tab displayed in the Mapping Graph Area. All tabs of the Global tab are displayed.
- Click the Context Variables tab. The Context Variables pane is displayed (see Figure 496).
...
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
Steps to map Set-Context function to a target element
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Select the target element that you want to map with Set-Context function.
- Click Context mapping function menu and select Set-Context sub-function. A set-context node is displayed in the Mapping Graph Area (see Figure 498).
...
- Click the Apply Mapping (
) button. This maps the Set-Context function to the target element. The defined variable (index) is passed to the process flow with the value 100. If you shift focus to another node, or click any of the Mapping Rules, Textual Rules, Node, Properties, XSL or Debugger tabs, without applying the mapping, an alert message is displayed (refer to Figure 522). Click No to apply the mapping and shift focus to the other object. If you click Yes, then the mapping activity is cleared and is replaced by the previous mapping in the Mapping Graph Area and the focus is shifted to the other object.
At times the mapping is too large and the applet memory may exceed 256M. In such cases, the mapping will fail and return an error of insufficient memory. You can overcome this situation by increasing the applet memory. For details, refer to Appendix A in the Administrator Guide.
Anchor _Toc125446729 _Toc125446729 Anchor _Toc131572389 _Toc131572389 Anchor _Toc134848129 _Toc134848129 Anchor usingDBfunction usingDBfunction Anchor _Toc177977138 _Toc177977138 Anchor _Hlt184625530 _Hlt184625530 Anchor _Toc226191083 _Toc226191083 Anchor _Toc315524668 _Toc315524668 Anchor _Toc315524940 _Toc315524940 Anchor _Toc385441568 _Toc385441568 Anchor _Toc387747407 _Toc387747407 Anchor _Toc387748680 _Toc387748680
Using DB FunctionAnchor _Toc401308977 _Toc401308977 The DB function enables you to get data from the database, based on a condition. It comprises of a sub-function, which is listed in the table below.
Anchor _Toc177878245 _Toc177878245 Anchor _Toc208651141 _Toc208651141
Table 21: Sub-Function of DB Mapping FunctionAnchor _Toc315524520 _Toc315524520 Mapping Function
Sub-Functions
Description
Example
DB
DBQuery
Returns data from the database, based on a query.
DBQuery( 'select EmpID from EMP where EMPID=1035', var1, 'true') returns all the records from the EMP table, where EMPID is 1035.
Here, 'var1' is the Connection Info variable.
If you change the last boolean argument from true to false, only the first record is returned.PreparedQuery
Returns data from the database, based on a query.
PreparedQuery ('SELECT EMPID FROM EMP WHERE EMPNAME=? AND EMPCITY=? AND EMPISMALE=?, $oracle_databaseserver, true ,('Smith','Chicago','true')').
Here, '=?' is the variable name that you pass in the braces.
The '$oracle_databaseserver' is the name of the Connection Info variable.
If you change the last boolean argument from true to false, only the first record is returned.
You can use this sub-function of DB mapping function to get data from the database. The process of using this sub-function is outlined below.
Steps to get data from the database using the 'DBQuery' DB Mapping Function- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
Ensure that a Connection Info variable is created for the DBQuery and is listed in the Parameters Panel.
For details on creating a Connection Info variable, refer to the Declaring Connection Info Variable section.
- Double-click the target element that you want to map with the DBQuery. It is displayed in the Mapping Graph Area.
- Click the DB function and select the DBQuery sub-function. A DBQuery node is displayed in the Mapping Graph Area (see Figure 500).
...
- Click the Apply Mapping ( ) button. This maps the DBQuery function to the target element. The defined query is passed to the database where a connection is created using the Connection Info variable. If the Boolean value is set as 'True' then the database fetches all the values that match the query. If the value is 'False', then the database fetches only the first matching value. If you shift focus to another node, or click any of the Mapping Rules, Textual Rules, Node, Properties, XSL or Debugger tabs, without applying the mapping, an alert message is displayed (refer to Figure 522).
Click No to apply the mapping and shift focus to the other object. If you click Yes, then the mapping activity is cleared and is replaced by the previous mapping in the Mapping Graph Area and the focus is shifted to the other object.
At times the mapping is too large and the applet memory may exceed 256M. In such cases, the mapping will fail and return an error of insufficient memory. You can overcome this situation by increasing the applet memory. For details, refer to Appendix A in Administrator Guide.
Steps to get data from the database using the 'PreparedQuery' DB Mapping Function- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
Ensure that a Connection Info variable is created for the PreparedQuery and is listed in the Parameters Panel.
For details on creating a Connection Info variable, refer to the Declaring Connection Info Variable section.
- Double-click the target element that you want to map with the PreparedQuery. It is displayed in the Mapping Graph Area.
- Click the DB function and select the PreparedQuery sub-function. A PreparedQuery node is displayed in the Mapping Graph Area (see Figure 503).
...
Click No to apply the mapping and shift focus to the other object. If you click Yes, then the mapping activity is cleared and is replaced by the previous mapping in the Mapping Graph Area and the focus is shifted to the other object.
At times the mapping is too large and the applet memory may exceed 256M. In such cases, the mapping will fail and return an error of insufficient memory. You can overcome this situation by increasing the applet memory. For details, refer to Appendix A in Administrator Guide.
Anchor _Toc177977139 _Toc177977139 Anchor _Toc184405107 _Toc184405107 Anchor _Toc226191084 _Toc226191084 Anchor _Toc315524669 _Toc315524669 Anchor _Toc315524941 _Toc315524941 Anchor _Toc344890238 _Toc344890238 Anchor _Toc385441569 _Toc385441569 Anchor _Toc387747408 _Toc387747408 Anchor _Toc387748681 _Toc387748681
Using Textual RulesTextual Rules are used for mapping source elements, mapping functions or constants to target elements, by defining the elements in syntax form.Anchor _Toc401308978 _Toc401308978
Steps to map elements using the Concat function using Textual Rules- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Select the target element that you want to map. It is displayed in the Mapping Graph Area.
- Click the Textual Rules tab in the Mapping Graph Area.
- Click String mapping function and select Concat sub-function. The syntax for the Concat sub-function is displayed in the Mapping Graph Area (see Figure 507).
...
Namespace allows you to add, view, edit, and remove the namespace in the XSL. All the Namespaces present in the source and target XSD's are automatically placed in the XSL generated. These Namespaces can be viewed using View Namespace option in the Namespace submenu.
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
Steps to add a Namespace in the XSL
- Click the Actions menu and select Namespace.
- Click the Namespace submenu and select Add Namespace. The Namespace dialog box is displayed (see Figure 509).
...
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
Steps to edit a Namespace in the XSL
- Click the Actions menu and select Namespace.
- Click the Namespace submenu and select Edit Namespace. The Select Namespace screen is displayed (see Figure 510).
...
- Mapping Rules: Enables you to use the predefined mapping functions.
- XSL Rules: Enables you to define the XSL Template code to use the defined parameters.
Steps to Create an XSL template using the XSL Rules
- Click XSL Template option displayed next to mapping functions on the Mapping Functions Panel.
- Select Manage XSL Template option or click the Manage XSL Template
icon in the toolbar (Figure 511).
...
Once you have created a XSL template, you can use it to map elements. On the Manage XSL Template screen, by default the XSL Rules tab is selected. To create a XSL template using the Mapping Rules, click the Mapping Rules tab.
Steps to create an XSL template using the XSL Rules
- On the Manage XSL Template screen, click the Mapping Rules tab.
- Enter the name of the new XSL template that you want to create in the Name field.
- Select the scope of the XSL Template. The default scope of the XSL template is Local.
- Click the Add
icon to add parameters for the new XSL template. - Enter the name of the parameter you want to add, in the Parameter Name field.
- Click the Add icon again to add the required parameters or press the Enter key to insert a new row. This will add a row immediately next to the row which is currently selected.
- Select the required Mapping Function. For example, select the mapping function, Math > Add (see Figure 515).
...
Map Elements using XSL Template
Steps to map elements using an XSL Template
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Ensure that the source and target elements to be mapped are selected and displayed in the Mapping Graph Area.
- Click the XSL template that you want to use for performing the required function, from the Templates list in the Parameters Panel. A Call XSL Template node is displayed in the Mapping Graph Area (see Figure 518).
...
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
Steps to declare a Global Variable
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Click the Global tab in the Mapping Graph Area. All tabs of the Global tab are displayed.
- Click the Global Variables tab. The Global Variable pane is displayed in the Mapping Graph Area (see Figure 520).
...
| Anchor | ||||
|---|---|---|---|---|
|
Once the global variable is added to the Parameters Panel, you can edit it or delete it anytime from this Panel itself.
Steps to manage a Global Variable from the Parameters Panel
- Right-click the global variable that you want to edit or delete. This displays the right dropdown menu (see Figure 524).
...
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
Map Global Variable to Target Element
Once you have created a global variable, you can map it to a target element.
Steps to map Global Variable to target element
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Click the Node tab displayed in the Mapping Graph Area. All tabs of the Node tab are displayed. Click Mapping Rules tab.
- Select a target element. This displays the selected target element node in the Mapping Graph Area.
Anchor _Hlt118001218 _Hlt118001218
Double-click the required global variable under Global Variables in the Parameters Panel. The selected global variable node is displayed in the Mapping Graph Area (see Figure 526).Anchor _Hlt123365867 _Hlt123365867
...
- Create a link from the output of the global variable to the input of the target element.
- Click the Apply Mapping ( ) button. This maps the global variable to the target element. If you shift the focus to another target element, or click any of the Node, XSL or Debugger tabs, without applying the mapping, then an alert message is displayed. (refer to Figure 522).
Click No to apply the mapping and then shift the focus to the other object. If you click Yes, then the mapping activity is cleared and is replaced by the previous mapping in the Mapping Graph Area and the focus is shifted to the other object.
Once a global variable is mapped to a target element, the letter (M) is displayed next to the mapped target element. This signifies that a target element has been mapped. Refer to Table of Suffixes for details on suffixes displayed next to a target element.
Save the mapping activity and exit the Data Mapper.
You can view and validate the generated mapping XSL, view the target XML and view and validate mapping output, before saving the mapping activity.
Anchor _Using_Local_Variable _Using_Local_Variable Anchor _Toc125446732 _Toc125446732 Anchor _Toc131572403 _Toc131572403 Anchor _Toc134848143 _Toc134848143 Anchor _Toc144023054 _Toc144023054 Anchor _Toc144314300 _Toc144314300 Anchor _Toc177977147 _Toc177977147 Anchor _Toc184405111 _Toc184405111 Anchor _Toc226191092 _Toc226191092 Anchor _Toc315524677 _Toc315524677 Anchor _Toc315524949 _Toc315524949 Anchor _Toc344890242 _Toc344890242 Anchor _Toc385441573 _Toc385441573 Anchor _Toc387747412 _Toc387747412 Anchor _Toc387748685 _Toc387748685
Using Local VariableLocal variables are used for mapping source elements, mapping functions or constants to a specific target element. They are declared and used only for the specific target element or attribute for which they are declared.Anchor _Toc401308982 _Toc401308982
To use a local variable in a mapping activity, you need to map it to the specific target element or attribute. This will successfully execute the local variable when you execute the specific mapping activity in the process flow.Anchor createlocalvar createlocalvar Anchor _Toc131572404 _Toc131572404
Declare Local VariableAnchor _Toc134848144 _Toc134848144
Steps to declare a Local Variable- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Click Node tab displayed in the Mapping Graph Area. All tabs of the Node tab are displayed.
- Click the Local Variables tab. The Local Variable pane is displayed in the Mapping Graph Area (see Figure 527).
...
Enter comments for the local variable in the Add Comment field (see Figure 528). For example, if the local variable value contains complex XSLT logic, you can enter its description in this field.
The Comments field is resizable.
Anchor _Ref184622314 _Ref184622314 Anchor _Toc208650701 _Toc208650701 Anchor _Toc239872379 _Toc239872379 Anchor _Toc315524241 _Toc315524241
Figure 528: Enter Name, Value and Comment for Local VariableAnchor _Toc401308590 _Toc401308590 To select a Custom Method as the value of a local variable, double click the desired Custom Method under Custom Methods in the Parameters Panel. The selected Custom Method is displayed in the Variable Definition field.
To learn how to declare a Custom Method, refer to section Using Custom Method.Click the Save Local Variable (
) button to save the local variable for the selected target element. This local variable is added to the list of existing variables in the Local Variable Name field. It is also displayed under Local Variables in the Parameters Panel. If you shift the focus to another node, or click any of the Mapping Rules, Textual Rules, Global Variables, Properties, XSL or Debugger tabs, without saving the local variable, an alert message is displayed (refer to alertmsg Figure 522). The comments added for the local variable are saved and displayed above the local variable declaration in the Mapping XSL (refer to Figure 523).The alert message is also displayed when shifting focus between Global and Node tabs.
Click No to save the local variable and shift the focus to the other object. If you click Yes, then the defined local variable is cleared and the focus is shifted to the other object.
Once the local variable is saved, it is categorized as Current Variable or Ancestor Variable in the Parameters Panel. If it is created for a child node, then it is saved as a Current Variable. If it is created for a parent's parent node, then it is saved as an Ancestor Variable.
You can rearrange the local variables by dragging it up or down in the list.
Steps to manage a Local Variable from the Parameters Panel- Right-click the local variable that you want to edit or delete. This displays the right dropdown menu.
- Select Edit to edit the variable. This displays the selected local variable in Edit mode. You can edit the value of the local variable in the Local Variable Value field. You can also edit the name of the local variable in the Local Variable Name field (see Figure 529).
...
Click OK to save the changes.
To remove a local variable, select the local variable and click Remove selected local variable (
) button.
To remove all local variables, click Remove all local variables (
) button.
Alternately, you can delete a local variable from the Parameters Panel itself. For details, refer to the Managing a Global Variable from Parameter Panel section.Anchor _Toc131572405 _Toc131572405
Map Local Variable to Target ElementAnchor _Toc134848145 _Toc134848145
Once you have created a local variable, you can map it to the specific target element or attribute.
Steps to map Local Variable to specific target element- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Click the Node tab displayed in the Mapping Graph Area. All tabs of the Node tab are displayed. Click Mapping Rules tab.
- Select a target element. This displays the selected target element node in the Mapping Graph Area.
- Double-click the required local variable under Local Variables in the Parameters Panel. The selected local variable node is displayed in the Mapping Graph Area (see Figure 531).
...
- Create a link from the output of the local variable to the input of the target element.
- Click the Apply Mapping ( ) button. This maps the local variable to the selected target element. If you shift the focus to another target element, or click any of the Global, XSL or Debugger tabs, without applying the mapping, then an alert message is displayed (refer to Figure 522).
Click No to apply the mapping and then shift focus to the other object. If you click Yes, then the mapping activity is cleared and is replaced by the previous mapping in the Mapping Graph Area and the focus is shifted to the other object.
Once a local variable is mapped to a target element, the letter (LV) is displayed next to the mapped target element. This signifies that a local variable has been mapped to the target element. The letter (M) is also displayed indicating the target element has been mapped. Refer to Table of Suffixes for details on suffixes displayed next to a target element.
Local variables do not allow duplicate names at the same level. You need to right-click to edit the local variable, where you can select the source.
Save the mapping activity and exit the Data Mapper.
You can view and validate the generated mapping XSL, view the target XML and view and validate mapping output, before saving the mapping activity.
Anchor _Toc86096303 _Toc86096303 Anchor _Toc88470445 _Toc88470445 Anchor _Hlt100911085 _Hlt100911085 Anchor _Toc112820685 _Toc112820685 Anchor _Hlt113171956 _Hlt113171956 Anchor _Hlt113171959 _Hlt113171959 Anchor _Toc114994144 _Toc114994144 Anchor _Hlt118000635 _Hlt118000635 Anchor _Toc125446733 _Toc125446733 Anchor usingcustommethod usingcustommethod Anchor _Toc131572406 _Toc131572406 Anchor _Toc134848146 _Toc134848146 Anchor _Toc144023055 _Toc144023055 Anchor _Toc144314301 _Toc144314301 Anchor _Toc177977148 _Toc177977148 Anchor _Toc184405112 _Toc184405112 Anchor _Toc226191093 _Toc226191093 Anchor _Toc315524678 _Toc315524678 Anchor _Toc315524950 _Toc315524950 Anchor _Toc344890243 _Toc344890243 Anchor _Toc385441574 _Toc385441574 Anchor _Toc387747413 _Toc387747413 Anchor _Toc387748686 _Toc387748686
Using Custom MethodsA custom method is used to call a function from a custom Java class in a package. It is declared and used globally for all target elements.Anchor _Toc401308983 _Toc401308983
To use a custom method in a mapping activity, you need to map it to a target element. This will successfully execute the custom method when you execute the mapping activity in the process flow.
Prerequisites
- The package containing the custom java class must be copied in the folder <InstallFolder>/ServerKernel/customClasses.
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
Steps to declare a Custom Method
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Click the Global tab displayed in the Mapping Graph Area. All tabs of the Global tab are displayed.
- Click the Custom Methods tab. The Custom Methods pane is displayed (see Figure 532).
...
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
Once you have created a custom method, you can map it to a target element.
Steps to map Custom Method to target element
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Click the Node tab displayed in the Mapping Graph Area. All tabs of the Node tab are displayed. Click Mapping Rules tab.
- Select a target element. This displays the selected target element node in the Mapping Graph Area.
- Double-click the required custom method under Custom Methods in the Parameters Panel. The selected method node is displayed in the Mapping Graph Area (see Figure 536).
...
- Click the Apply Mapping ( ) button. This maps the custom method to the target element.
Save the mapping activity and exit the Data Mapper.
You can view and validate the generated mapping XSL, view the target XML and view and validate mapping output, before saving the mapping activity.
Anchor _Toc177977149 _Toc177977149 Anchor _Toc184405113 _Toc184405113 Anchor _Toc226191094 _Toc226191094 Anchor _Toc315524679 _Toc315524679 Anchor _Toc315524951 _Toc315524951 Anchor _Toc344890244 _Toc344890244 Anchor _Toc385441575 _Toc385441575 Anchor _Toc387747414 _Toc387747414 Anchor _Toc387748687 _Toc387748687
Dynamically Loading Custom MethodsAdeptia supports dynamic loading of custom methods in the Data Mapper. It loads the custom methods available in the Custom Classes folder, under the Global Methods node in the Parameters Panel. This enables you to access any custom method from the Data Mapper itself, without any need to specify method parameters, such as class name, method name and the number of arguments in the Data Mapper applet.Anchor _Toc401308984 _Toc401308984
Steps to dynamically load Custom MethodsCopy all the class files in the Custom Classes folder and then restart the kernel.
The current implementation of Global Methods does not support package hierarchy. So all class files that are directly placed in the Custom Classes folder, will be visible through the Global Methods node in the Parameters Panel.
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes. The Global Methods node is already displayed in the Parameters Panel, each time Data Mapper is opened (see Figure 538).
...
Once the Key function is created, you need to pass the value to the Key function that will be used to match the Key Use defined for source2 and map the output to the target element. For this, you need to use the Key mapping function. The syntax of the Key Mapping is :
key( , )
This function accepts 2 parameters. The first parameter is the name of the Key function (Key1) to be used and the second parameter is the actual value that will be passed to the Key function to perform the match on source2. The parameters will be:
key( 'key1', 25 )
Once XSLT transformer finds a mapping it will call the Key function Key1 and pass the value 25 to that function. The Key function Key1 on receiving the mapping will pick this value 25 and start scanning EmpID of the source2 inside each record of source2. Whenever EmpID= 25, the Key function will pass that record (Root/Record) as output.
The Key function always executes inside current context or nearest For Each that is applied to the target element where Key function is mapped. So if the For Each is applied is for source2 on the target element, then the Key function will use source2 as the data source on which EmpID scanning will be performed . So the For Each applied, helps the Key function to decide which data source to use, to perform the scanning and fetch the output.
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
For example, there are two source schemas: Schema_EmpDetails and Schema_Emp_incrementalDetails. There is one target schema: Schema_EmpCompleteDetails. The objective is to map the fields EmpName, EmpID ,Age, Salary, City and Email from Schema_EmpDetails and map the field Address from Schema_Emp_incrementalDetails to the target schema. The Address from the Schema_Emp_incrementalDetails is fetched using Key function and using EmpID as Key Use.
The parameters are defined as:
...
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
Steps to create a key
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Click the Global tab displayed in the Mapping Graph Area. All tabs of the Global tab are displayed.
- Click the Key Functions tab. A list of existing keys is displayed in the Key Functions pane (see Figure 541).
...
If you shift focus to another node, or click any of the Mapping Rules, Textual Rules, Properties, XSL or Debugger tabs, without saving the key, an alert message is displayed (refer to Figure 522).
The alert message is also displayed when shifting focus between the Global and Node tabs.
Click No to save the key and shift the focus to the other object. If you click Yes, then the defined key is cleared and focus is shifted to the other object.
You can rearrange the keys by dragging it up or down in the list.
You can edit or delete a key from the Parameters Panel itself. For details, refer to the Managing a Global Variable from Parameter Panel section.
Anchor _Mapping_the_Key_with target element _Mapping_the_Key_with target element Anchor _Toc226191097 _Toc226191097 Anchor _Toc315524683 _Toc315524683 Anchor _Toc315524955 _Toc315524955 Anchor _Toc344890247 _Toc344890247 Anchor _Toc385441578 _Toc385441578 Anchor _Toc387747417 _Toc387747417 Anchor _Toc387748690 _Toc387748690
Mapping the Key with Target ElementSteps to use the Key FunctionAnchor _Toc401308987 _Toc401308987 - Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Map source and target elements as displayed in figure below (see Figure 543).
...
- Connection Info variables are used as a parameter in the DBQuery function, when extracting information from the database.
Steps to declare a Connection Info Variable
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Click the Global tab in the Mapping Graph Area. All tabs of the Global tab are displayed.
- Click the Connection Info tab. The Connection Info Variable pane is displayed in the Mapping Graph Area (see Figure 546).
...
- Click the Save Connection Variable ( ) button to save the Connection Info variable. This Connection Info variable is added to the list of existing variables in the Connection Variable Name field. It is also displayed under Connection Info in the Parameters Panel. If you shift the focus to another node, or click any of the Mapping Rules, Textual Rules, Local Variables, Properties, XSL or Debugger tabs, without saving the Connection Info variable, an alert
message is displayed (refer to Figure 522).Anchor _Hlt238278196 _Hlt238278196 Click No to save the Connection Info variable and shift the focus to the other object. If you click Yes, then the defined Connection Info variable is cleared and the focus is shifted to the other object.
You can rearrange the Connection Info variables by dragging it up or down in the list.
You can edit or delete a Connection Info variable from the Parameters Panel itself. For details, refer to the Managing a Global Variable from Parameter Panel section.
Anchor _Toc177977153 _Toc177977153 Anchor _Toc184405117 _Toc184405117 Anchor _Setting_Target_Element _Setting_Target_Element Anchor _Toc226191099 _Toc226191099 Anchor _Toc315524685 _Toc315524685 Anchor _Toc315524957 _Toc315524957 Anchor _Toc344890249 _Toc344890249 Anchor _Toc385441580 _Toc385441580 Anchor _Toc387747419 _Toc387747419 Anchor _Toc387748692 _Toc387748692
Setting Target Element PropertiesYou can set various properties of a target element.Anchor _Toc401308989 _Toc401308989
Steps to set target element properties- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Click the target element for which you want to set properties.
- Click the Node tab displayed in the Mapping Graph Area. All tabs of the Node tab are displayed.
- Click the Properties tab. The Properties pane is displayed (see Figure 548)
...
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
The For Each property is used to repeat the occurrences of a target element or node, depending on the total occurrences of a source element or a node in the source file.
For example, an XML schema with a node customer has three elements, first_name, last_name, and state. This schema is used both at the source and at the target end.
Supposing, the source file has 10 occurrences of the customer. Applying the For Each property on the target node customer, for the source node customer, generates an output file containing 10 occurrences of the customer in it.
If For Each property is not used, an output file is generated with only one occurrence of customer in it. |
Steps to set the For Each property
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Click the target element for which you want to set the For Each property.
- Click the Node tab displayed in the Mapping Graph Area. All tabs of the Node tab are displayed.
- Click Properties tab. The Properties pane is displayed (refer to Figure 548).
- Click the For Each property field and then double-click the source element using which you want to apply the For Each property. This displays the entire path of the source element in the For Each field (see Figure 549).
...
- Click Save Properties. This applies the For Each property for the selected target element. If you shift focus to another node, or click any of the Mapping Rules, Textual Rules, Global Variables, Properties, XSL or Debugger tabs, without saving the For Each property, an alert message is displayed (refer to Figure 522).
Click No to save the For Each property and shift focus to the other object. If you click Yes, then the defined For Each property is cleared and the focus is shifted to the other object.
Once the For Each property is applied to a target element, the letter (F) is displayed next to the target element. Refer to Table of Suffixes for details on suffixes displayed next to a target element.
To remove the For Each property from the target element, right-click target element and select Remove Mappings option. This displays the Remove Mapping Options dialog box. Select the Remove For Each checkbox and click OK.
Anchor _Toc86096305 _Toc86096305 Anchor _Toc88470448 _Toc88470448 Anchor _Toc112820688 _Toc112820688 Anchor _Toc114994147 _Toc114994147 Anchor _Hlt118287913 _Hlt118287913 Anchor _Toc125446738 _Toc125446738 Anchor addcomments addcomments Anchor _Toc131572413 _Toc131572413 Anchor _Toc134848153 _Toc134848153 Anchor _Toc144023060 _Toc144023060 Anchor _Toc144314306 _Toc144314306 Anchor _Toc177977155 _Toc177977155 Anchor _Toc226191101 _Toc226191101 Anchor _Toc315524687 _Toc315524687 Anchor _Toc315524959 _Toc315524959
Adding Comments to Target Schema Elements
Comments are used to provide additional information to target nodes and elements. Comments are displayed as tool tips and are reflected in the XSL generated under the XSL tab.
Steps to add a comment to the target element- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Click the target element for which you want to add a comment.
- Click the Node tab displayed in the Mapping Graph Area. All tabs of the Node tab are displayed.
- Click the Properties tab. The Properties pane is displayed (refer to Figure 548).
- Click the Comments property field and enter the comment for the selected target element (see Figure 550)
...
- Click Save Properties. This adds the comment and displays it next to the target element. If you shift focus to another node, or click any of the Mapping Rules, Textual Rules, Global Variables, Properties, XSL or Debugger tabs, without saving the comments, an alert message is displayed (refer to Figure 522).
Click No to save the comments and shift focus to the other object. If you click Yes, then the defined comments are cleared and the focus is shifted to the other object.
Once a comment is added to a target element, the letter (CM) is displayed next to the target element. This signifies that a comment has been created for the target element. Refer to Table of Suffixes for details on suffixes displayed next to a target element.
Anchor setsortingrules setsortingrules Anchor _Toc131572414 _Toc131572414 Anchor _Toc134848154 _Toc134848154 Anchor _Toc144023061 _Toc144023061 Anchor _Toc144314307 _Toc144314307 Anchor applysortingrules applysortingrules Anchor _Toc177977156 _Toc177977156 Anchor _Toc226191102 _Toc226191102 Anchor _Toc315524688 _Toc315524688
Setting Sorting RulesAnchor _Toc315524960 _Toc315524960
You can set sorting rules for a target element. It is used to sort value of elements in the generated output. While generating the output XML, the value of elements can be sorted either in ascending or descending order. For example, records of the employee can be sorted based on their salaries. Figure 551 shows input XML before sorting.<?xml version="1.0" encoding="UTF-8" ?>
- <employees>
- <employee attribute="14" attribute1="15">
<TESTCASENO>TESTCASENO1</TESTCASENO>
<DESCRIPTION>DESCRIPTION1</DESCRIPTION>
<NAME>John</NAME>
<ADDRESS>Address1</ADDRESS>
<EMAILID>EMAILID1</EMAILID>
<PHONENO>PHONENO1</PHONENO>
<DOB>DOB1</DOB>
<DEPT>DEPT1</DEPT>
<SALARY>10000</SALARY>
<DOJ>DOJ1</DOJ>
<DESIGNATION>DESIGNATION1</DESIGNATION>
<AGE>34</AGE>
</employee>
- <employee attribute="14" attribute1="15">
<TESTCASENO>TESTCASENO2</TESTCASENO>
<DESCRIPTION>DESCRIPTION2</DESCRIPTION>
<NAME>David</NAME>
<ADDRESS>ADDRESS2</ADDRESS>
<EMAILID>EMAILID2</EMAILID>
<PHONENO>PHONENO2</PHONENO>
<DOB>DOB2</DOB>
<DEPT>DEPT2</DEPT>
<SALARY>8000</SALARY>
<DOJ>DOJ2</DOJ>
<DESIGNATION>DESIGNATION2</DESIGNATION>
<AGE>45</AGE>
</employee>
- <employee attribute="14" attribute1="15">
<TESTCASENO>TESTCASEN3</TESTCASENO>
<DESCRIPTION>DESCRIPTION3</DESCRIPTION>
<NAME>Ricky</NAME>
<ADDRESS>ADDRESS3</ADDRESS>
<EMAILID>EMAILID3</EMAILID>
<PHONENO>PHONENO3</PHONENO>
<DOB>DOB3</DOB>
<DEPT>DEPT3</DEPT>
<SALARY>15000</SALARY>
<DOJ>DOJ3</DOJ>
<DESIGNATION>DESIGNATION3</DESIGNATION>
<AGE>36</AGE>
</employee>
</employees>Anchor _Toc123365651 _Toc123365651 Anchor _Toc131271534 _Toc131271534 Anchor _Toc134263447 _Toc134263447 Anchor _Toc144312869 _Toc144312869 Anchor _Toc144313555 _Toc144313555 Anchor _Ref144629252 _Ref144629252 Anchor _Ref144733625 _Ref144733625 Anchor _Toc177976683 _Toc177976683 Anchor _Ref184623399 _Ref184623399 Anchor _Toc208650722 _Toc208650722 Anchor _Toc239872400 _Toc239872400 Anchor _Toc315524262 _Toc315524262
Figure 551: Sample Input XMLAnchor _Toc401308613 _Toc401308613
Figure 552 shows the Output XML after sorting.
<?xml version="1.0" encoding="UTF-8" ?>Anchor outputxml outputxml
- <employees xmlns:java="http://xml.apache.org/xslt/java" xmlns:str="http://exslt.org/strings">
- <employee attribute="" attribute1="">
<TESTCASENO>TESTCASEN3</TESTCASENO>
<DESCRIPTION>DESCRIPTION3</DESCRIPTION>
<NAME>Ricky</NAME>
<ADDRESS>ADDRESS3</ADDRESS>
<EMAILID>EMAILID3</EMAILID>
<PHONENO>PHONENO3</PHONENO>
<DOB>DOB3</DOB>
<DEPT>DEPT3</DEPT>
<SALARY>15000</SALARY>
<DOJ>DOJ3</DOJ>
<DESIGNATION>DESIGNATION3</DESIGNATION>
<AGE>36</AGE>
</employee>
- <employee attribute="" attribute1="">
<TESTCASENO>TESTCASENO1</TESTCASENO>
<DESCRIPTION>DESCRIPTION1</DESCRIPTION>
<NAME>John</NAME>
<ADDRESS>Address1</ADDRESS>
<EMAILID>EMAILID1</EMAILID>
<PHONENO>PHONENO1</PHONENO>
<DOB>DOB1</DOB>
<DEPT>DEPT1</DEPT>
<SALARY>10000</SALARY>
<DOJ>DOJ1</DOJ>
<DESIGNATION>DESIGNATION1</DESIGNATION>
<AGE>34</AGE>
</employee>
- <employee attribute="" attribute1="">
<TESTCASENO>TESTCASENO2</TESTCASENO>
<DESCRIPTION>DESCRIPTION2</DESCRIPTION>
<NAME>David</NAME>
<ADDRESS>ADDRESS2</ADDRESS>
<EMAILID>EMAILID2</EMAILID>
<PHONENO>PHONENO2</PHONENO>
<DOB>DOB2</DOB>
<DEPT>DEPT2</DEPT>
<SALARY>8000</SALARY>
<DOJ>DOJ2</DOJ>
<DESIGNATION>DESIGNATION2</DESIGNATION>
<AGE>45</AGE>
</employee>
</employees>Anchor _Toc134263448 _Toc134263448 Anchor _Ref144022821 _Ref144022821 Anchor _Toc144312870 _Toc144312870 Anchor _Toc144313556 _Toc144313556 Anchor _Ref144733658 _Ref144733658 Anchor _Toc177976684 _Toc177976684 Anchor _Ref184623428 _Ref184623428 Anchor _Toc208650723 _Toc208650723 Anchor _Toc239872401 _Toc239872401 Anchor _Toc315524263 _Toc315524263
Figure 552: Output XMLAnchor _Toc401308614 _Toc401308614 The Sorting rules can be set only for record where For Each Mapping or Apply Template is used. The <xsl:apply-templates> element applies a template to the current element or to the child nodes of the current element, when the parent elements of source and target schemas are mapped.
Anchor _Hlt123365400 _Hlt123365400
Steps to set Sorting Rules- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Ensure that the source and target elements to be mapped are selected and displayed in the Mapping Graph Area.
- To use Apply template, click Employee (parent) element in the source panel and drag the mouse pointer to the Employee (parent) element in the target panel.
...
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
Steps to filter using Apply Filter Checkbox
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Right-click the target element that you want to filter, and mark the Apply Filter checkbox as checked (see Figure 555). By default, this checkbox is disabled.
...
This selection will filter the selected element from the target output XML data. You can uncheck this checkbox anytime to display the element in the target data.
You can apply this filtering option on the element or attribute levels.
Once the filter is applied on the target element, the letters (FL) are displayed next to each filtered target element. This signifies that the filter has been applied for the target element. Refer to Table of Suffixes for details on suffixes displayed next to an element.
Anchor _Toc177977159 _Toc177977159 Anchor _Toc184405119 _Toc184405119 Anchor _Toc226191105 _Toc226191105 Anchor _Toc315524691 _Toc315524691 Anchor _Toc315524963 _Toc315524963 Anchor _Toc344890251 _Toc344890251 Anchor _Toc385441582 _Toc385441582 Anchor _Toc387747421 _Toc387747421 Anchor _Toc387748694 _Toc387748694
Creating Clone of Target ElementCloning means generating replicas of the target elements or nodes. You can create clones of all target elements.Anchor _Toc401308991 _Toc401308991
Steps to create a clone- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Right-click the target element and select the Clone Node option.
...
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
Steps to remove a clone
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Right-click the cloned element that you want to remove and select the Remove Clone option. A screen is displayed confirming the removal of the selected clone (see Figure 556).
...
Click Yes to remove the clone. This removes the selected clone from the target schema.
If more than one clone has been created for an element, then you need to remove the clones in descending order.
Anchor _Toc131572417 _Toc131572417 Anchor _Toc134848157 _Toc134848157 Anchor _Toc144023064 _Toc144023064 Anchor _Toc144314310 _Toc144314310 Anchor _Toc177977161 _Toc177977161 Anchor _Toc184405120 _Toc184405120 Anchor _Toc226191107 _Toc226191107 Anchor _Toc315524693 _Toc315524693 Anchor _Toc315524965 _Toc315524965 Anchor removeschema removeschema Anchor _Toc344890252 _Toc344890252 Anchor _Toc385441583 _Toc385441583 Anchor _Toc387747422 _Toc387747422 Anchor _Toc387748695 _Toc387748695
Adding a Character Data ( CData) SectionAnchor _Toc401308992 _Toc401308992 The XML parsers normally parse the complete text in an XML document i.e., when an XML element is parsed, the text data between the XML tags is also parsed. Consider the following example:,
<message>This text will also be parsed</message>
In this example, the message between the <message> and </message> text will normally be parsed by the XML parser. Consider another example:
<name><first>Hello</first><last>User!</last></name>
In this example also, the XML parser will break the XML tags and parse the text data as Hello User!
The text data that is parsed by the XML parser is termed as Parsed Character Data or PCData.
However, the user may require to add some text data that should not be parsed by the XML parser. The Character Data or CData is the text data that should not be parsed by the XML parser. CData is also termed as Unparsed Data.
Adeptia Suite enables you to add a CData section with the target schema. The text data inside a CDATA section is ignored by the parser.
A CDATA section starts with "<![CDATA[" and ends with "]]>". CDATA sections are useful for writing XML code as text data within an XML document.A CDATA section cannot contain the string "]]>" and therefore it is not possible for a CDATA section to contain nested CDATA sections.
You can use multiple CDATA sections by splitting each occurrence of the "]]>"just before the ">".
Steps to add a CData section- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Click Actions menu and select the option CData Section Elements (see Figure 559).
...
You can remove a schema from the source or target panels. If a source or target schema is removed, everything associated with the mapping of the schema such as Mapping Graph Area, Connection Lines or For Each property is removed.
Steps to remove a schema
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Right-click the root element of the schema that you want to remove and select the Remove Schema option. A screen is displayed confir
ming the removal of the selected schema (see Figure 559).Anchor _Hlt184625293 _Hlt184625293
...
Click Yes to remove the schema. This removes the selected clone from the target schema.
A schema can be removed only from the root element. Thus, the Remove Schema option is displayed as active only for the root element.
Anchor _Toc177977162 _Toc177977162 Anchor _Toc184405121 _Toc184405121 Anchor _Toc226191108 _Toc226191108 Anchor _Toc315524694 _Toc315524694 Anchor _Toc315524966 _Toc315524966 Anchor _Toc344890254 _Toc344890254 Anchor _Toc385441585 _Toc385441585 Anchor _Toc387747424 _Toc387747424 Anchor _Toc387748697 _Toc387748697
Adding Custom XSLAt times, you may want to add some additional specialized XSL to a target element, or at the top or bottom of the mapping XSL. You can do this by adding custom XSL code.Anchor _Toc401308994 _Toc401308994
Steps to add custom XSL code for a Target Element- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Right-click the target element and select the Custom XSL Before option (see Figure 560).
...
Click Save to save the XSL code and close the screen. Alternately, click Clear to clear the XSL code, or Cancel to close the screen without saving the changes.
Similarly, you can add custom XSL code after a target element, by selecting Custom XSL After option from the right menu (refer to Figure 560).
Anchor _Toc131572418 _Toc131572418 Anchor _Toc134848158 _Toc134848158 Anchor _Toc144023065 _Toc144023065 Anchor _Toc144314311 _Toc144314311
Steps to add global custom XSL code- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Click the Actions menu and select Global Custom XSL Before option (see Figure 562).
...
Click Save to save the XSL code and close the screen. Alternately, click Clear to clear the XSL code, or Cancel to close the screen without saving the changes.
Info Similarly, you can add global custom XSL code after mapping XSL, by selecting Global Custom XSL After option from the Actions menu (refer to Select Global Custom XSL Before Option screen).
- Once you have entered the custom XSL code, it is saved in the Mapping XSL screen (see Figure 564).
Anchor
Figure 564: Custom XSL Code in Mapping XSL
...
You can change the root element when XML schemas are loaded. The root element always appears as a tag in the Output section on the Debugger screen. You can change this tag by selecting the desired root element.
Steps to select root element of a schema
- Ensure that the source and target schemas are loaded and all their elements are listed under their respective nodes.
- Right-click the root element of the schema whose root element you want to change and select the Select Root option.
- The Select Root Element screen is displayed.
- This screen displays a list of existing root elements for the selected schema in a dropdown list (see Figure 565).
...
...
Figure 565:
...
Select Root Element
All elements that are declared as global in the XSD are listed in this dropdown list. |
...
You can add a namespace prefix to a target element. This prefix is displayed next to the target element in the target schema, and is automatically displayed in the Output section on the Debugger screen.
Steps to add a namespace prefix to a target element
...