Modeling Data Mapping
Data Mapping is a very common task in the integration business. The Designer offers you a powerful tool to define data mappings directly by drawing object flows between the properties of the related classes.
You can create a mapping diagram by creating a mapping operation on a class. The mapping diagram is based on the data model contained in the Implementation folder. It defines mappings between the data structures defined in this data model. You cannot change the data model in the mapping diagram, all attributes are read-only.
Refer to Modeling Data Structures for more details on how to create a class operation.
Adding a Mapping Operation
To add a mapping operation, use the quick action Add Mapping Operation of a classa:
Enter a name for the operation and click Save:
A BPMN model name must be unique within one service.
In addition, the following name restrictions apply to all service panel elements:
Element names...
... must not be empty.
... must not contain spaces. Exception: Spaces are allowed in operation names.
... must not start with numbers.
... must not end with a period (.).
... must not contain one of the following characters: <, >, :, ", /, \, |, ?, *
Furthermore, the following strings must not be used as element names: CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, LPT9.
Alternatively, you can open the context menu of the class and select the option Add Operation:
The dialog Add Operation opens. Select Mapping Diagram from the drop-down list, enter a name for the operation and click Save:
The new operation is added to the class. The corresponding mapping diagram opens automatically in a new Designer tab, where you can directly start modeling your mapping:
Refer to Working with the Mapping Editor for detailed information.
Once the mapping operation has been created, you can use the quick actions and the context menu to manage it:
You can:
add parameters
in
out
return
open the implementation of the mapping diagram
change the implementation from mapping diagram to action script or activity diagram
cut the mapping operation
copy the mapping operation
paste the mapping operation (available if Copy or Cut option have been used before)
rename the mapping operation
delete the mapping operation
Refer to Implementation and Modeling Data Structures for more information on your options and how to create classes and operations.
Mapping Editor Overview
When you create a mapping operation, its corresponding mapping diagram is automatically opened in the Mapping Editor:
Use the various functionalities of the Mapping Editor to create your mapping diagram:
Name | Description | Icon | Description | |
---|---|---|---|---|
(1) | Mapping Editor | The mapping editor is where you draw your data mappings. | - | - |
(2) | Elements Toolbar | The elements toolbar contains all elements that you can create in the mapping editor. | - | - |
(3) | Model Toolbar | The model toolbar of the mapping editor offers two options: | Use this option to highlight the operation in the Service panel. | |
Click on this icon to reload the mapping diagram. | ||||
(4) | Designer Panels | In the mapping editor, the following panels assist you during modeling:
| - | - |
Attributes of a Mapping Operation
Select a mapping operation in the Implementation folder of the service panel to display its attributes in the Attributes panel. You can also edit them there:
Mapping operations have the following attributes:
Attribute | Description | Possible Values / Example | |
---|---|---|---|
Name | Click here to change the Name of the related operation. Mapping operation names must follow certain naming rules. They
| initializeForm_EnterEmployeeData | |
Description | If you want to insert or change a description for the respective mapping operation, click here to open a text editor where you can enter and format your text. | ||
Is static | Specify if the operation is static (default) or not.
For more information, also refer to Adding Operation Calls. | true | The mapping operation is static (default) and can be used outside the context of the related class. |
false | The mapping operation is non-static and needs a self object as an input. | ||
Stereotype | Via button Add Stereotype, you can add a stereotype to a mapping operation. | REST |
Attributes of a Mapping Diagram
When you click on the diagram pane in the mapping editor, the attributes of the current mapping diagram are displayed in the Attributes panel. All attributes are read-only and cannot be edited there:
Mapping diagrams have the following attributes:
Attribute | Description | Possible Values / Example | |
---|---|---|---|
Name | Displays the name of the current mapping diagram. | mapAddress_direct | |
Type | Path within the implementation folder where the corresponding mapping operation resides. | Employee_Self_Service.EmployeeAddress | |
Description | Description of the corresponding mapping operation for documentation purposes. | ||
Is static | Displays if the operation is static (default) or not (see Attributes of a Mapping Operation). For more information, also refer to Adding Operation Calls. | true | The mapping operation is static (default) and can be used outside the context of the related class. |
false | The mapping operation is non-static and needs a self object as an input. |
Simple_Data_Mapping_Example
Click here to download a simple example model that shows how to implement simple mappings in Scheer PAS Designer.
Refer to chapter Mapping Data Structures in the PAS Designer Developer Guide for more mapping examples.