Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WDESIGNER and version 24.0

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.

Image Added

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

Image Added

From the quick actions of a class, select Image Added to add a mapping operation.

Image Added

Enter a name for the operation and click Save.

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamenote_service_panel_name_restrictions
PageWithExcerptINTERNAL:_designer_excerpts

Image Added

Alternatively, you can open the context menu of the class and select the option Add Operation.

Image Added

The dialog Add Operation opens.

Select Mapping Diagram from the drop-down list, enter a name for the operation and click Save.

Image Added

The new operation has been added to the class. The corresponding mapping diagram opens automatically in a new Designer tab, where you can directly start modeling your mapping.

Tip

Go to Working with the Mapping Editor for detailed information.

Image Added

Once the mapping operation has been created, you can use the quick actions and the context menu to manage it.

You can:

  • add a parameter
    • 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
Tip

Refer to Implementation and Modeling Data Structures for more information on your options here.

Refer to Modeling Data Structures for more information on 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.

If you want to create your own data model within the Designer, you need to create a Service and a BPMN model in the Explorer first. Open the BPMN model to display the BPMN editor where you can find the Service panel. Within the Service panel, the folder Data Model is displayed.

Adding a Data Model

Image Removed

In each Service panel you can find the Data Model folder.

Image Removed

Right click the folder to open the context menu and create a new Package. Within a package, you can create all further elements.

Tip
titleExpert Advice

Apply the same naming conventions to all your models. This makes reading a model much easier. Go to page Naming Conventions and Containment Tree Organization in the Builder User Guide for an overview on practice-approved naming conventions.

Data Model Elements

On each element in the Data Model folder you can open a context menu. The context menu contains options to create new elements within the current element, and options to edit the current element.

Package

A package is like a directory for the file system. It is used to group data model elements. Packages can have any depth of nesting: To structure your work, you can create packages within packages.

Image Removed

The Package context menu allows you to edit your package and to create further elements.

OptionDescription
Add PackageAdd another package within the existing package.
Add ClassAdd a class within the package.
Add InterfaceAdd an interface within the package.
Edit PackageChange the package name.
Delete PackageDelete the package.
Copy ItemCopy the package to paste it elsewhere in the data model tree.
Cut ItemCut the package to paste it elsewhere in the data model tree.
Paste ItemPaste the package elsewhere in the data model tree. Available when Copy Item or Cut Item option have been used before.

Class

In object-oriented programming, each object belongs to a class. A class is a user defined blueprint from which objects are created. Classes have properties (attributes) and operations (interactions of this class).

Image Removed

The Class context menu allows you to edit your class and to create further elements.

OptionDescription
Add PropertyAdd a property to the class.
Add OperationAdd an operation within the class.
Edit ClassChange the name of the class.
Delete ClassDelete the class.
Copy ItemCopy the class to paste it elsewhere in the data model tree.
Cut ItemCut the class to paste it elsewhere in the data model tree.
Paste ItemPaste the class elsewhere in the data model tree. Available when Copy Item or Cut Item option have been used before.

Image Removed

Classes can be created in two ways:

  • You can create your own classes using the context menu.
  • If you model your own forms within the Designer, each form is added as a class to the Data Model folder in a package Message.

Interface

In contrast to a class, an interface has no implementations. Interfaces are used to define common features of multiple classes in one separate class, and then derive from that class.

Image Removed

The Interface context menu allows you to edit your interface and to create further elements.

OptionDescription
Add OperationAdd an operation within the interface.
Edit InterfaceChange the name of the interface.
Delete InterfaceDelete the interface.
Copy ItemCopy the interface to paste it elsewhere in the data model tree.
Cut ItemCut the interface to paste it elsewhere in the data model tree.
Paste ItemPaste the interface elsewhere in the data model tree. Available when Copy Item or Cut Item option have been used before.

Property

Properties are values that are included within a class. Properties always have a type.

Image Removed

The Property context menu allows you to edit your property. It is not possible to create further elements within a property.

OptionDescription
Edit PropertyChange the name of the property.
Delete PropertyDelete the property.
Copy ItemCopy the property to paste it elsewhere in the data model tree.
Cut ItemCut the property to paste it elsewhere in the data model tree.

Image Removed

Properties are created in two ways:

  • You can create your own properties using the context menu.
  • If you model your own forms within the Designer, each form is added as a class and form elements are added as properties of these classes in the Data Model folder in package Message.

Operation

An operation is an action that is carried out to accomplish a given job. Operations can be defined on classes or interfaces. There are several possibilities to implement an operationsss.

Image Removed

The Operation context menu allows you to edit your operation and to create further elements.

OptionDescription
Add ParameterAdd a parameter to the operation.
Create Implementation

You can choose between two different types of implementation for your class operations:

  • Action Script: Go to page Using Action Script for detailed information.
  • Mapping Diagram: The usage of a mapping diagram is explained in this chapter.

If an implementation has been added for an operation, the operation icon changes: Image Removed.
To open the mapping diagram or the action script editor, use the icon Image Removed that is shown if you hover over the operation.

Edit OperationChange the name of the operation.
Delete OperationDelete the operation.
Copy ItemCopy the operation to paste it elsewhere in the data model tree.
Cut ItemCut the operation to paste it elsewhere in the data model tree.
Paste ItemPaste the operation elsewhere in the data model tree. Available when Copy Item or Cut Item option have been used before.

Parameter

Each operation can have parameters that define the input and output objects. Operation parameters may not only be of complex types but also of base types.

Image Removed

The Parameter context menu allows you to edit your parameter. It is not possible to create further elements within a parameter.

OptionDescription
Edit Parameter

Change the name of the parameter.

Tip

Per default, parameters are created as input parameters. If you want to change the parameter direction, select the parameter and change the attribute Direction in the Attributes panel:

Image Removed

Move Parameter upChange the order of parameters.
Delete ParameterDelete the parameter.
Copy ItemCopy the parameter to paste it elsewhere in the data model tree.
Cut ItemCut the property to paste it elsewhere in the data model tree.

Using the Mapping Editor

When you create a new mapping diagram, it is automatically opened in the Mapping Editor:

Image Modified

Use the various functionalities of the BPMN Mapping Editor to design create your BPMN modelmapping diagram:

NameDescription
1 Mapping Editor
The Mapping Editor mapping editor is where you design draw your formdata mappings.
Go to page Working with the Mapping Editor for detailed information about the features of the Mapping Editoreditor.
2 Elements Toolbar
The elements toolbar contains all elements that you can create in the Mapping Editormapping editor.
Go to page Working with the Mapping Editor for further details about the usage of the toolbar.
3 Model Toolbar

The model toolbar

assists you during modeling in the Mapping Editor

of the mapping editor offers the following:

IconDescription
Image Added
Click on this icon to highlight the operation in the Service panel.
Go to page
Working with the BPMN Editor for an overview of the available options of the model toolbar
Service Panel for further information about this panel.
Image Added
Click on this icon to reload the mapping diagram.
4 Designer Panels

In the Mapping Editormapping editor, the following panels assist you during modeling:

  • Service Panel: In the Service panel you can access your libraries and your data model.
    Go to page Working With Libraries for detailed information.
  • Attributes Panel: Use the Attributes panel to change the settings of the date data model elements.
  • Validation Panel: The Validation panel supports you during modelling by displaying notes for invalid actions in your models or forms. It also gives advice on how to fix the errors.
    Go to page Validating a Service
    for detailed information.
  • Search Panel: Use the Search panel to find elements in the Mapping Editormapping editor.
    Go to page Searching in the Designer for detailed information.

Attributes of a Mapping Operation

Image Added

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:

AttributeDescriptionPossible Values / Example
Name

Click here to change the Name of the related operation.

Mapping operation names must follow certain naming rules. They

  • must not contain blanks
  • must not start with a number
  • must not contain special characters
initializeForm_EnterEmployeeData
DescriptionIf 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.

  • Static mapping operations can be called without creating an instance of the related class. They get all necessary data via their input parameters.
  • Wanting to call a non-static mappingoperation, you need to create a local instance of the related class, and call the operation on that object. This is called self context.

For more information, also refer to Adding Operation Calls.

trueThe mapping operation is static (default) and can be used outside the context of the related class.
falseThe 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.
By adding a stereotype, you can extend the attributes of a mapping operation with additional properties.

REST

Attributes of a Mapping Diagram

Image Added

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:

AttributeDescriptionPossible Values / Example
NameDisplays the name of the current mapping diagram. mapAddress_direct
TypePath within the implementation folder where the corresponding mapping operation resides. Employee_Self_Service.EmployeeAddress
DescriptionDescription 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.

trueThe mapping operation is static (default) and can be used outside the context of the related class.
falseThe mapping operation is non-static and needs a self object as an input.
Panel
titleOn this Page:
Table of Contents

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameSimple_Data_Mapping_Example
PageWithExcerptINTERNAL:_designer_examples

Go to chapter Mapping Data Structures in the PAS Designer Developer Guide for more mapping examples.

Panel
titleRelated Pages:

Otp
Floatingfalse
maxHLevel3

rp