If you want to create your own data model within the Designer, you need to create a Service first. In the Service panel resides a folder Implementation where you can add your own data model to.

Go to the Implementation folder in the service panel of your service.

All elements inside the Implementation folder need to be created within packages. Add a new package via the quick action or the context menu. Refer to Service Panel for more information on how to create elements in the service panel.

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 Guide for an overview on practice-approved naming conventions.

Implementation Elements

To model your own data structures, you have the following elements available:

ElementDescriptionDetails
Package

A package is like a directory for the file system. It is used to group executable data model elements. Packages can have any depth of nesting: To structure your work, you can create packages within packages.
Also, packages define a sort of namespace to the contained elements. The name of the package is part of the element path, e.g. Package1.Class is different from Package2.Class .


Class

A class is an aggregation of properties and operations that describes a complex data type from which objects can be created.


Property

Properties are data fields that describe the structure of the class.

Operation

An operation adds behavior to a class or interface. The behavior describes how to process the data given by the parameters. In the context of the Designer, you can implement operations as mapping, action script or activity.


Parameter

Operations can have parameters that define the input and output objects. Operation parameters can be of simple type (Base Types) or of complex type (class or interface).

Interface

In contrast to a class, an interface has no properties nor implementations. Interfaces are used to define common operations of multiple classes, and then derive from that interface.
Operations of interfaces do not have an implementation but only define the signature (parameters and types).





Interface

Interfaces can have sub-interfaces and sub-classes.


Class
Operation
Operations and parameters for interfaces are the same as for classes. The difference is that they have no implementation but only define the signature for the dependent classes to derive from.

Parameter

Each element of the Implementation folder has a context menu and quick actions. The context menu contains options to create new elements to the selected element, and to edit the current element. Via the quick actions, you can access the most used menu items directly with a single click.

Package

A package is like a directory for the file system. It is used to group executable data model elements. Packages can have any depth of nesting: To structure your work, you can create packages within packages.
Also, packages define a sort of namespace to the contained elements. The name of the package is part of the element path, e.g. Package1.Class is different from Package2.Class .

The quick actions of a package allow for the creation of packages, classes and interfaces.

Quick ActionDescription
Add another package within the existing package.
Add a class to the package.
Add an interface to the package.

The context menu of a package allows you to change the name of the package, and to create further elements.

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

Package Message is a generated package that contains all classes that are related to the forms you have already created to your Forms folder. This package is locked - you cannot change the generated form classes.

Class

A class is an aggregation of properties and operations that describes a complex data type from which objects can be created.

 


The quick actions of a class allow for the creation of properties as well as operations with different types of implementation.

Quick ActionDescription
Add a mapping operation to the class.
Add an action script operation to the class.
Add an activity operation to the class.
Add an operation to the class. The implementation is to be defined later.
Add a property to the class.

The context menu of a class allows you to change the name of the class, and to create further elements.

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

Property

Properties are data fields that describe the structure of the class.

The context menu of a property allows you to change the name of the property. It is not possible to create further elements below a property.

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

Operation

An operation adds behavior to a class or interface. The behavior describes how to process the data given by the parameters. In the context of the Designer, you can implement operations as mapping, action script or activity.

The quick actions of an operation allow for the creation of parameters with different directions, and to jump to the implementation of the operation.

Quick ActionDescription
Add an input parameter to the operation.
Add an output parameter to the operation.
Add a return parameter to the operation.
Open the implementation of the selected operation in a separate tab.

The context menu of an operation allows you to change the name of the operation, and to create further elements.

Menu ItemDescription
Add Parameter

Add a parameter to the operation. See below for more information.

Create Implementation

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

Available if the operation has no implementation, yet.

Open Implementation

Open the implementation of the selected operation in a separate tab.

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

Parameter

Operations can have parameters that define the input and output objects. Operation parameters can be of simple type (Base Types) or of complex type (class or interface).

The context menu of a parameter allows you to change the name of the parameter as well as to change the order of parameters. It is not possible to create further elements below 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 direction, select the parameter and change attribute Direction in the Attributes panel:

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

Interface

In contrast to a class, an interface has no properties nor implementations. Interfaces are used to define common operations of multiple classes, and then derive from that interface.
Operations of interfaces do not have an implementation but only define the signature (parameters and types).

The quick action of an interface allows for the creation of operations.

Quick ActionDescription
Add an operation to the interface. Operations of interfaces have no implementation, they only describe the signature of the operation.

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

OptionDescription
Add Class
Add a class or sub-class to the interface. Classes within interfaces can be nested.
Add Interface
Add another interface to the interface. Interfaces can be nested.
Add OperationAdd an operation to the interface.
Operations of interfaces do not have an implementation but only define the signature (parameters and types).
Edit InterfaceChange the name of the interface.
Delete InterfaceDelete the interface.
Copy ItemCopy the interface to paste it elsewhere to the data model tree.
Cut ItemCut the interface to paste it elsewhere to the data model tree.
Paste ItemPaste the interface elsewhere to the data model tree. Available when Copy Item or Cut Item option have been used before.
  • No labels