You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

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

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

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

Expert 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's 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.

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).

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.

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.

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.

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.

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.

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

OptionDescription
Add Parameter

Add a parameter to the operation. Further iniformation see below.

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: .
To open the mapping diagram or the action script editor, use the icon 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.

If you want to create a return parameter, enter return in the parameter name field and confirm with Save.

The return parameter will be created automatically. You can use the Attributes panel to adapt it to your needs.

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.

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.

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:

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:

Use the various functionalities of the BPMN Editor to design your BPMN model:

NameDescription
1 Mapping Editor
The Mapping Editor is where you design your form.
Go to page Working with the Mapping Editor for detailed information about the features of the Mapping Editor.
2 Elements Toolbar
The elements toolbar contains all elements that you can create in the Mapping 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.
Go to page Working with the BPMN Editor for an overview of the available options of the model toolbar.
4 Designer Panels

In the Mapping 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 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 Editor.
    Go to page Searching in the Designer for detailed information.


  • No labels