_designer_excerpts

The Apache Kafka documentation speaks of events that contain a message, or of records in more technical parts of the documentation. This documentation summarizes all under the term "message".

Each deployed application offers two basic functionalities during execution: The user can start a process (and start a so-called instance of the process) - and he can also view the existing instances that have not yet been completed. These "instances in progress" are displayed in the instance list. For each BPMN model, a dedicated instance list is generated.

Use the Add button to add a new column.

Use the Cancel button to discard your changes.

Use this area to move the columns by drag and drop.

Activate this checkbox to hide this column during execution.

The input in this field is displayed as header of the column.

Technical identifier for data processing. Not visible for the end user. The input in this field is mandatory.

Use the Save button to save your changes.

The Transaction ID identifies a transaction. It is a unique number used to trace service calls through the call stack of multiple service calls.

• Clients calling an xUML service can provide a transaction ID in HTTP header X-Transaction-ID or xTransactionId (in JMS context).
• SOAP clients can also use the SOAP headers to provide a transaction ID.
• If an xUML service is called without providing a transaction ID, the Runtime will generate such an ID.

This ID will be passed on through the call stack of the xUML service, so that the whole transaction can be traced. This can be useful, when analyzing the log file in case of error.

The name of the selected file is displayed. If you want to select a different file, use the Change File button.

The file's name is also displayed in field Name.

Change the contents of the Name field of you want to rename the backup before uploading it.

The Confirm button is only enabled after you have selected the namespace to which the file is to be uploaded.

If documentation is available, it will be displayed in a separate pop-up.

The content of the tree in the administration tab depends on the profile assigned to your account within Scheer PAS Administration .

Example:

• In a BPMN model, a library lib is used in version 1.0.0 from January.
• In the library administration, lib 1.0.0 is replaced with 1.0.0 from February.
• The user has to clear the Compiler cache to get 1.0.0 from February.

Use this icon if you need more or less space on the diagram pane. Click on the pane to display the start line, the second click marks the end line and defines the size of the area to be added. To add space, click from left to right to define the area. If you want to delete a horizontal space, click from right to left to define the area

Use this icon if you need more or less space on the diagram pane. Click on the pane to display the start line, the second click marks the end line and defines the size of the area to be added. To add space, click from top to bottom to define the area. If you want to delete a vertical space, click from bottom to top to define the area.

You have several options to adjust the diagram pane. When you open the pane for the first time, the default view is displayed:

• The Diagram Pane is displayed in the centre at the top
  (see chapter Modeling BPMN for further information)
• The Execution Pane is displayed below the diagram pane
  (see chapter Modeling Execution for further information)
• Four Designer Panels are shown in the left sidebar
  
  • The Service Panel
  • The Controls Panel
  • The Attributes Panel
  • The Validation Panel

Activate the icon to highlight all invalid elements.

Use this icon to enable or disable the grid on the diagram pane. The grid supports you during modeling: If the grid is enabled, elements snap to the grid points.

This element cannot be prepopulated.

This element can be prepopulated.

• You can set a default value in the Attributes panel to be applied before displaying the form. Refer to Changing BPMN Element Attributes for more information on that.
• You can overwrite these defaults dynamically in the Get Data execution of a user task. How to do this is explained on Using Forms.

Specify a default value for the related variable here.

• On Event: The model is executed when the event occurs.
• On Exit: The model is executed after completion of the task/event.
• Decision: The model is executed when the process reached the gateway.
• Get Data: The model is executed when BPMN is waiting in a user task and returns the default values for the form.

Variables created in section Local are only available for use within the current execution.

Variables created in section Persisted are usable in all executions of the BPMN model.

The variable is added to the execution pane.

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

All elements inside the Implementation folder need to be created within packages. Add a new package via the quick action or the context menu.

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.

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 .

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

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.

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

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

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 sub-class to the class.

Add an interface to the class.

Add an operation to the class.

Cut the class to paste it elsewhere to the API or Implementation folder.

Copy the class to paste it elsewhere to the API or Implementation folder.

Paste the class elsewhere to the API or Implementation folder. Available if Copy or Cut option have been used before.

Change the name of the class.

Delete the class.

Activities are modeled in activity diagrams. Refer to Modeling Activities for more information on how to create an activity diagram.

An API is the entrance port of your service. It can be used to communicate with the service from the outside. There are different kinds of APIs (e.g. REST API, SOAP API, ...) that describe different communication standards.

Ports are elements of the UML modeling standard. A port defines an entrance point to the service and connects the API to an interface or class.

xUML services read the following incoming HTTP headers containing correlation information:

• X-Transaction-Id or xTransactionId (in JMS context)
  This header identifies the transaction the call belongs to. You can set the transaction id manually with setTransactionID. If not set, the Runtime will generate one.
  This header will be passed through the callstack to identify all service calls that belong to a transaction.
• X-Request-Id 
  This header should identify the unique request.
• X-Sender-Host and X-Sender-Service
  These headers should contain the sender host resp. the sender service.

These headers will be all logged to the transaction log. Having this information, you can use this for error analysis or usage metrics.

With xUML service adapter calls, the xUML Runtime adds the following outgoing HTTP headers containing correlation information to the request:

• X-Transaction-Id or xTransactionId (in JMS context)
  This header identifies the transaction the call belongs to. You can set the transaction id manually with setTransactionID. If not set, the Runtime will generate one.
  This header will be passed through the callstack to identify all service calls that belong to a transaction.
• X-Request-Id
  This header identifies the unique request. The Runtime generates a unique number for each adapter call.
• X-Sender-Host and X-Sender-Service
  These headers contain the sender host resp. the sender service. They are set by the Runtime automatically.

Transaction id and request id will be logged to the transaction log on the adapter call. Having this information, you can use this for error analysis or usage metrics.

Specifies the maximum size of the request in KB (1 KB = 1024 Bytes). This can be used to prevent DoS or similar attacks. When the payload of the service exceeds the given maximum, incoming request are rejected.

Specifies the maximum size of the request header in KB (1 KB = 1024 Bytes). This can be used to prevent DoS or similar attacks. When the header payload of the service exceeds the given maximum, incoming request are rejected.

Header information as a map. The map contains arrays of header value strings whereas the header name is the key of the map.

• Header names are lowercase and treated case insensitive.
• Multiple headers with the same name are treated as arrays.

Refer to HTTP Header Support for more information on the standard xUML HTTP headers.

Drag the element you want to create from the toolbar and drop it on the diagram pane.

Another way to create a form element is to click on the element in the toolbar, switch to the editor and click again.

To cancel the operation, press the Esc key.

In the Process folder you can create your BPMN models. One service can contain several BPMN models.

To create a model, hover over the Process folder to display the quick start icons and click Add Model.

To add an unused library to the project, click on the  icon.

adding_a_role

The new BPMN model is also displayed in the service panel and you can use icon to open it.

When you create a new model, it opens automatically in a new tab and you can directly start modeling.

Enter a name for the BPMN model in the pop-up window Create New Model. Click Save.

creating_a_role

lane_handling

open_role_editor

Background Color

If you want to select a background color, activate the checkbox and click on the color placeholder that will appear.

Then use the color picker to select a new color or enter the hexadecimal code of the desired color:

Click here to insert or change the Name of the related element. Generated elements (like e.g. message) cannot be renamed.

Enter a name for the form in the pop-up window Create New Form. Click Save.

The new form is also displayed in the service panel and you can use icon to open it.

When you create a new form, it opens automatically in a new tab and you can directly start designing.

To define the timer settings, click the icon  and an editor will open. For detailed explanations see How to Use the Scheduler/Timer.

how_to_use_the_timer

To set the duration of the timer, the event should be trigged by a persisted property of type integer or datetime. You have two options to set the timeout in the attributes panel:

• Integer: Define the number of seconds the event has to wait.
• Datetime: Define the absolute datetime when the event should fire.

Use the documentation icon to display the documentation of a library.

You can find it in the Manage Libraries dialog...

... as well as in the service panel when you hover over a library.

If you want to add your own libraries to a service, hover over the Libraries folder in the service panel and click icon Manage Libraries .

The added library is now displayed in the service panel and you can use it during modeling.

The dialog Manage Libraries opens.

All libraries that have been uploaded to the current namespace are shown in this dialog:

• Currently unused libraries are displayed on the left side of the window.
• The libraries that are already used in this service are shown on the right side.

Expand the drop-down lists to display the details of each library such as versions and dependencies.

You can also remove libraries from the service.

Open the dialog Manage Libraries again and click the icon.

The library will switch back to the Unused Libraries column.

Do not forget to confirm the deletion with the Save button.

The library is now displayed in the column Used Libraries.

If you have finished, do not forget to Save.

You can access your application UIs directly from the controls panel.

C hoose the process start you want to trigger from the drop-down menu.

The instance list shows all open instances.

A progress view is displayed...

• ... if an open process instance is in a state where no forms have to be filled.
• ... if the instance is in a state that your role is not allowed to see.

You can wait until the process reaches the next form (or the process end) or switch back to the overview and proceed with another instance.

Use icon Refresh to update the instance list.

If the view of the instance list is associated with a role-based authorization concept, only users with appropriate permissions can access it.

If the process is role-based, role labels are displayed - one for each role assigned to your user. Click a label to view only the instances allowed for that role.

Select the process for which you want to create a new instance by clicking the corresponding icon.

On top of the explorer tree you can find a search box. Select the part of the explorer tree (namespace, folder or service) you want to search, and enter a search term.

Alternatively, you can open the context menu of a Forms folder and select the option Add Form.

Alternatively, you can open the context menu of a Process folder and select the option Add Model.

Trigger Events: Use the attribute Trigger Events in the Attributes Panel to define which button of a form associated to the element triggers the default process flow of a BPMN process. This attribute is only available for boundary events.

• Go to Working with the BPMN Editor for further information regarding editing of BPMN elements using the different context menus on the diagram pane.
• Go to Styling BPMN Elements for further information regarding styling possibilities for BPMN elements, for example how to change the background color, the font style and size etc.

None. The content of this element is ignored during execution.

field_config_editor

If you click icon the Field Configuration editor opens:

Use the editor to add and manage the content of your element:

Option	Description
	Use the Add button to insert new rows.
	Use icon Drag to change the order of the rows.
You can enter the options for this element as value pairs. When entering value pairs, always the first value (Value) is saved as key in the data container. The second value (Label) is used as notification to the user. The label is displayed in the form. Value pairs may also contain numbers, so that a user can chose a text option, but in the background a calculation is carried out.
	Enter a Value for your element option. It is not possible to assign the same value to different labels.
	Enter a Label for your element option. The label is displayed in the form.
	Click on this icon to set the option as default.
	Use this icon to delete the option.
	Use the Save button to save your changes.
	Use the Cancel button to discard your changes.

Enables a field-acurate layout customization.

A valid CSS class.

A commentary field for the developer. The content is invisible to users and its sole purpose is internal documentation.

Go to page Modeling Forms for further information regarding editing of form elements using the context menu.

Field name shown in the form.

The element must be filled or used if the checkbox is activated.

Element may remain empty (default).

Element must be filled.

Technical identifier for data processing and not visible for the end user.

Alphanumercial characters and underscore.

This field is write-protected. When you use the option, Read-only is added to the bottom right of the element:

User can enter values (default).

User cannot enter values.

Displays the type of the form element in read-only mode.

In this field, you can enter text. Content added to attribute Text is shown in the element. If the user does not change the content of the field during form execution, the content of Text will be saved to the database.

The attribute is used to adjust the position of a form element in context to a bigger neighboring element.

Example: The Radio Button Group Color is much bigger than the Button Next, but the button should be shown at the bottom of the form. Therefore, the button's attribute Vertical Alignment is set to Bottom.

Supported Form Elements

Align the element in the middle of the element cell.

Align the element on top of the element cell (default).

The content of this attribute is displayed in the element when attribute Text has not been filled. The placeholder is a sample value, it is not saved to the database. When a user overwrites the placeholder, it disappears and the user's input is saved to attribute Text.

Designer services read the following incoming HTTP headers containing correlation information:

• X-Transaction-Id or xTransactionId (in JMS context)
  This header identifies the transaction the call belongs to. You can set the transaction id manually with setTransactionID(). If not set, the Runtime will generate one.
  This header will be passed through the callstack to identify all service calls that belong to a transaction.
• X-Request-Id 
  This header should identify the unique request.
• X-Sender-Host and X-Sender-Service
  These headers should contain the sender host resp. the sender service.

These headers will be all logged to the transaction log. Having this information, you can use this for error analysis or usage metrics.

With adapter calls, the xUML Runtime adds the following outgoing HTTP headers containing correlation information to the request:

• X-Transaction-Id or xTransactionId (in JMS context)
  This header identifies the transaction the call belongs to. You can set the transaction id manually with setTransactionID. If not set, the Runtime will generate one.
  This header will be passed through the callstack to identify all service calls that belong to a transaction.
• X-Request-Id
  This header identifies the unique request. The Runtime generates a unique number for each adapter call.
• X-Sender-Host and X-Sender-Service
  These headers contain the sender host resp. the sender service. They are set by the Runtime automatically.

Transaction id and request id will be logged to the transaction log on the adapter call. Having this information, you can use this for error analysis or usage metrics.

The Designer provides all necessary base types in a Bridge Base standard library. This library is available in all services and cannot be removed. It contains the following Bridge base types:

• Any
• Blob
• Boolean
• DateTime
• Float
• Integer
• String

Most of these base types are only able to hold one single piece of information, like text in a string, true or false in a boolean, or binary data in a blob.

If you want to associate several bits of information, you have to define a complex type that combines a number of independent base types and possibly other complex types. Such complex types are modeled as classes. To use your own types, you can

• define your own data structures in the Implementation folder
• provide them via a library.

Libraries are code repositories that are useful to organize your development project into re-usable pieces that can be used in multiple services. They contain predefined classes, interfaces, operations and parameters you can use during modeling by simple drag & drop.
Libraries are developed with the Builder. The Designer comes with a standard library which already provides all necessary Base Types and base type operations.

Enter a name for the service in the pop-up window Create New Service. Click Save.

The new folder is created and displayed in the tree.

• You cannot import newer versions to a system having an older version installed.
• There are no migrations if importing Designer content from versions prior to Designer 21.1.3 (2.0.165). This may result in the imported service not working.
  In the future, importing data from a version older than 21.1.3 will be disabled.

To open a service, click on the service name in the explorer tree.

1. The Service tab will open.
2. The service details will be displayed on the right side of the tree.

The new service is created and displayed in the tree.

By exporting and importing, you can transfer Designer contents between PAS installations. These installations may have divergent versions.

A Service contains one executable service. Services are created in the explorer tree. The necessary settings for your micro service such as the service properties, the BPMN model,  the data model, used libraries and forms are managed within the service. You need to open a service to access its contents via the Service panel, see Service Panel for details.

cutting_and_pasting_explorer

Enter a name for the folder in the pop-up window Create New Folder.

Click Save.

You are now able to paste the URL, for example in an email.

The action is confirmed by a toast message.