Page History

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.

A notification indicates a successful upload.

The uploaded file is added to the list of backups under the chosen name.

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.

When you open a service for the first time, the default view is displayed:

• The BPMN pane is displayed in the center at the top
  (see Working with the BPMN Editor for details).
• The Execution pane is displayed below the BPMN pane
  (see Working with the Execution Editor for further information).
• The default Designer panels are displayed in the left sidebar:
  
  • the Service Panel
  • the Controls Panel
  • the Attributes Panel
  • the Validation Panel

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 in the database. When a user overwrites the placeholder, it disappears and the user's input is saved in attribute Text.

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.

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

Use this icon to clear your Compiler cache.
You need to clear your Compiler cache after you have updated a library.

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 to deploy the service.

Open your Scheer PAS Bridge with a click on this icon.

Activate the icon to highlight all invalid elements.

Click on this icon to start your service.

Stop the service by clicking on this icon.

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

The variable is added to the execution pane.

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

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.

In the Process folder you can create your BPMN model which is equivalent to an executable service.

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 an Existing Role

	If you open the role editor, it contains an empty line already. Start typing the name of the role your are seaching for in field Role. The field has an autocomplete function: As soon as you start inserting, a drop-down list is displayed containing all available roles that match your input. Select the role you want to use.
	In the next step you need to assign the rights that will be granted to the role owner. Available options are: Right Description Write A user assigned to this role will be able to see and change the instance data for all process steps in the current lane. Read A user assigned to this role will be able to display the instance data for all process steps in the current lane. This right is assigned by default. List A user assigned to this role will only be able to see the instances in the instance table for all process steps in the current lane.
	You can continue to add further roles (or create new ones) as multiple roles can be assigned to one lane. When you have finished, save your changes to apply them to the lane.
	The number of roles assigned to a lane is displayed in the attributes panel.
	You have to open the user management, to assign the new role to users. Tip Go to the Administration Guide > Managing Roles for further information about role management.

If you want to insert a description for your element, click here to enable edit mode and enter your text.

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

The elements toolbar contains all BPMN elements that you can create on the diagram pane.

	By default, the elements toolbar only displays the icons of the available BPMN elements. But you can also expand the toolbar by using the icon.
	In its expanded version, the names of all elements are also displayed. Tip In chapter Supported BPMN Elements all elements and their specific properties are described.
	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. Tip Further details are explained on page Adding BPMN Elements.

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 New Role

	Click button New Role to create a new role and assign it to the lane element.
	Enter the name of the new role in the pop-up window. The input is mandatory.
	If the role name is already in use, you will not be able to save. Use the existing role instead.
	Save to create the role.
	The new role is now added to the role editor and assigned to the current lane.
	In the next step you need to assign the rights that will be granted to the role owner. Available options are: Right Description Write A user assigned to this role will be able to see and change the instance data for all process steps saved in the current lane. Read A user assigned to this role will be able to display the instance data for all process steps saved in the current lane. This right is assigned by default. List A user assigned to this role will only be able to see the instances in the instance table for all process steps saved in the current lane.
	You can continue to create further roles (or add already existing ones) as multiple roles can be assigned to one lane. When you have finished, save your changes to apply them to the lane.
	The number of roles assigned to a lane is displayed in the attributes panel.
	The new role has also been added to the user management. You have to open the user management, to assign the new role to users. Tip Go to the Administration Guide > Managing Roles for further information about role management.

Enter your text in the editor. Various formatting tools are provided.

Click Save and Close to confirm your text or Cancel to abort the action.

The model toolbar assists you during modeling on the diagram pane:

The following table explains the available tools:

Tool Icon	Tool Name	Description
	Export	Use this icon to export your BPMN model in JSON format.
	Report	Click the Report icon to print your model. You have two options: You can send your model directly to a printer or save it as a Word document. See page Creating Diagram Reports for details.
	Share	If you click the Share icon, the URL of your BPMN model is copied to the clipboard and you can paste it elsewhere, for example in an email.
	Publish to cockpit	If you want direct access to your BPMN model in your Cockpit, click on the icon Publish to cockpit. If you open your cockpit the next time, an external link tile grants you direct access to the model.
	Hide execution pane	Use this icon to hide the execution pane. This allows to gain more space during modeling.
	Toggle grid	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.
	Show invalid	Multiexcerpt include SpaceWithExcerpt INTERNAL MultiExcerptName model_toolbar_show_invalid PageWithExcerpt _designer_excerpts
	Start service	Multiexcerpt include SpaceWithExcerpt INTERNAL MultiExcerptName model_toolbar_start_service PageWithExcerpt _designer_excerpts
	Stop service	Multiexcerpt include SpaceWithExcerpt INTERNAL MultiExcerptName model_toolbar_stop_service PageWithExcerpt _designer_excerpts
	Open Bridge	Multiexcerpt include SpaceWithExcerpt INTERNAL MultiExcerptName model_toolbar_open_bridge PageWithExcerpt _designer_excerpts
	Deploy service	Multiexcerpt include SpaceWithExcerpt INTERNAL MultiExcerptName model_toolbar_deploy_service PageWithExcerpt _designer_excerpts
	Export repository	Multiexcerpt include SpaceWithExcerpt INTERNAL MultiExcerptName model_toolbar_export_repository PageWithExcerpt _designer_excerpts
	Clear Compiler cache	Multiexcerpt include SpaceWithExcerpt INTERNAL MultiExcerptName model_toolbar_clear_compiler_cache PageWithExcerpt _designer_excerpts
	Insert/Remove horizontal space	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.
	Insert/Remove vertical space	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.
	Undo	If you want to cancel your last action on the diagram pane, use this icon.
	Redo	Use this icon to restore the action that you had previously undone.

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:

You can also arrange the panels individually.

The dashed frame indicates the new position of the panel.

Use drag & drop to rearrange panels.

You can move panels to already existing columns. The new panel is then shown as a new tab.

It is also possible to resize panels by dragging the vertical or horizontal panel borders.

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.

If you want to resize the editor, drag the handle in the middle of each border to make the editor pane larger or smaller.

If you want your model to fit to the screen, use the  icon at the bottom of the editor.

Click icon  to scale the model to 100 %.

You can open a second sidebar on the right side of the editor. Use both sidebars to manage the Designer Panels.

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.

Double-click the handle to maximize the editor to this side of the application.

To define the timer settings, click the icon  and an editor will open. For detailed explanations see How to Use the Scheduler/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 iconManage 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.

Create an export of the Designer service repository by clicking this icon.

Use the export:
a) If you want to deploy the repository to another Bridge.
b) If you want to analyze the service with the Analyzer.

You can access your application UIs directly from the service settings area.

To create a new process instance, click icon . From the drop-down menu, choose the process start you want to trigger.

The instance overview shows all unfinished instances.

Use icon Refresh to update the instance list.

Select the process for which you want to create a new instance.

Instances for which the process is finished are only displayed shortly. They then disappear from the list.

The Designer panels can be displayed on the left and right side of the panes and support the user during modeling.

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.

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

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.
Info 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. Note 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.

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.

Align the element in the middle of the element cell.

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

The validation panel reads
REST interface classes: urn.AddressImplementation.Address.Public.Address, urn.Data_Model.com.Address share common class name 'Address' but class names in REST interface must be unique.

Class names must be unique.

Your BPMN model name (in our example: Address ) and a class of a BPMN message (in our example com.Address ) have the same name. Rename the BPMN or message class.

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.

Using libraries has several advantages for developers:

• You can provide additional data types and operations via libraries.
• You can reuse implementations you have already developed with the Builder.
• You can use libraries for modularization:
  • Implementations can be recycled in various processes via libraries.
    
  • Multiple developers can contribute to the same process implementation by working on different libraries.
• You can add features to the Designer, for example access to backend systems, via libraries.
• You can use different versions of the same library as the library administration supports versioning.

Libraries help you to make your BPMN process executable. 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.

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 Working with the Service Panel for details.

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.