_designer_excerpts

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

Use the documentation icon to display the documentation of 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.

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.

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

Display Name of Attribute

Activate the checkbox if you also want to display the names of the attributes on the diagram pane.

Font

Use this section to select the font for display of the element's attributes on the diagram pane. You have also several formatting options.

Font Color

You can also adapt the font color of the element's attributes on the diagram pane. Click on the color placeholder, then use the color picker to select a new color or enter the hexadecimal code of the desired color:

Font Size

In this section you can change the font size of the element's attributes on the diagram pane.

Word Wrap

By default, the element's attributes are displayed in a single line on the diagram pane. When the word wrap option is disabled, a placeholder (...) indicates that more text is available but hidden:

In the attribute Description you can also enter line breaks using CTL + Enter. To show the text including your line breaks, activate the word wrap option:

A placeholder (...) indicates that more text is available but hidden. If you want to display the whole text, resize the attribute on the diagram pane. Go to page Resizing BPMN Elements for detailed information.

Font

Use this section to select the font for the text within the element. You have also several formatting options.

Font Color

You can also adapt the font color of text within the element. Click on the color placeholder. Then use the color picker to select a new color or enter the hexadecimal code of the desired color:

Font Size

In this section you can change the font size of the text within the element.

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. 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. Further details are explained on page Adding BPMN Elements.

Word Wrap

By default, element names can only be displayed in a single line. When the word wrap option is activated, the text will fill the available space in the element:

When the option is disabled, a placeholder (...) indicates that more text is available but hidden:

You can display the attributes of an element on the diagram pane: Select the attribute you want to show in the Attributes panel and move it to the pane by using drag & drop.

As soon as you have created an attribute of an element on the diagram pane, the Styling panel will show the tab Attributes. Open this tab to edit the formatting of the displayed attributes.

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 named model_toolbar_show_invalid was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
	Start service	MultiExcerpt named model_toolbar_start_service was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
	Stop service	MultiExcerpt named model_toolbar_stop_service was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
	Open Bridge	MultiExcerpt named model_toolbar_open_bridge was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
	Deploy service	MultiExcerpt named model_toolbar_deploy_service was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
	Export repository	MultiExcerpt named model_toolbar_export_repository was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
	Clear Compiler cache	MultiExcerpt named model_toolbar_clear_compiler_cache was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
	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.

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.

If you want to enlarge the editor, use icon  in the middle of each frame to draw the frame larger or smaller.

With a click on the icon, the window maximizes on this side of the frame.

Managing Panels

	The availability of the Designer Panels varies depending on the editor you are using. You can recognize the different panels by their icons: Icon Panel Availability Attributes Panel BPMN Editor Form Editor Mapping Editor Service Panel BPMN Editor Form Editor Mapping Editor Overview Panel BPMN Editor Search Panel BPMN Editor Mapping Editor Styling Panel BPMN Editor Validation Panel BPMN Editor Form Editor Mapping Editor
	Use the left and the right sidebar in the editor to customize the display of the Designer Panels. You can hide panels that you do not currently need. The icons of hidden panels are displayed in the right upper corner of the editor.
	To show a hidden panel again, click on its icon. Hover over an icon to show the name of the corresponding panel. The panel is inserted at the position where it was last visible.
	Use drag & drop to rearrange panels. You can move panels to already existing columns. The new panel is then shown as a new tab.
	You can also arrange the panels individually. The dashed frame indicates the new position of the panel.
	It is also possible to resize panels by dragging the vertical or horizontal panel borders.

Click here to insert or change attribute Name.

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

To create a model, right click on the Models folder and choose the option Add Model from the context menu.

If you switch back to the explorer tab, the new BPMN model is also displayed in the tree. To open a BPMN model from the explorer tree, use the  icon.

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.

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

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.

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.

A persisted variable can have a default value. If this is the case, you can find the field Default Value in the Attributes panel.

Use the field if you want to change the initial value.

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.

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

If you switch back to the explorer tab, the new form is also displayed in the tree. To open a form from the explorer tree, use the icon.

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

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

The instance overview shows all unfinished instances.

Use icon Refreshto 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. You must select any content in the tree to enable the search box.

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

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

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

Cutting and Pasting

	If you want to use an element at a different position in the tree, select the context menu option Cut Item.
	Open the context menu of the element in which you want to insert the cut element and choose Paste Item. The option Paste Item is only enabled if the elements to be inserted fit into the tree hierarchy. Pasting elements is only possible in the same namespace.
	The element is now displayed on its new place in the tree.

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 new folder is created and displayed in the tree.

The dialog Manage Libraries opens.

Currently unused libraries are displayed on the left side of the window, the libraries that are already available in this project are shown on the right side.

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

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

Each newly created service contains already the folders Libraries, Models and Forms.

The new service is created and displayed in the tree.

You can also remove libraries from the list of used libraries.

Open the dialog Manage Libraries again and click the  icon.

The library will switch back to the Unused Libraries column.

The action is confirmed by a toast message.

Export

	The export is an available option for the following elements: Folder Service Models Single BPMN Model Forms Single Form If you want to export an element, for example to create a backup copy of your model, choose the option Export in the context menu.
	If you choose to export from a Models or a Forms folder as well as from a BPMN Model or a single Form, the export starts directly. During the export the message Generating file... is displayed.
	A toast message also confirms the successful export.

Export

	The export is an available option for the following elements: Folder Service Models Single BPMN Model Forms Single Form If you want to export an element, for example to create a backup copy of your model, choose the option Export in the context menu.
	If you choose to export from a Folder or Service, you have the choice whether or not to include the libraries used in the export. By default, the checkbox Include libraries is activated. Click Export to confirm your choice and start the action.
	During the export the message Generating file... is displayed.
	A toast message also confirms the successful export.

Structuring Your Work

Import

	The import is an available option for the following elements: Namespace Folder Models Forms If you want to import an element, for example to transfer a backup copy to another namespace, choose the option Import in the context menu.
	The pop-up Import will open. Click button Choose File to select the file you want to import.
	The name of the chosen file is displayed. If you want to change your selection, use the button Change File. If the correct file has been selected, start the import by clicking the Import button.
	A toast message confirms the successful import.
	If you import into a namespace or folder, you can use import files that include the necessary libraries. Using an export with included libraries will result in a pop-up notice. Two different notes are possible: Successfully imported: The libraries were not yet available in the namespace and have been imported successfully.
	Already present in the database: The libraries have already been available in the namespace, the import therefore ignores the libraries.
	The imported element is displayed in the tree.

The library is now displayed in the column Used Libraries.

If you have finished, do not forget to Save.

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

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

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.

Supported Form Elements

Align the element in the middle of the element cell.

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

The Bridge Base library is supplied as standard in the Designer and cannot be deleted from the library panel. The library contains the 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 wish 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 in UML. To use your own classes, define them in a library and upload this customized library to the Designer.