Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table Filter
inversefalse,false,false,false
sparkNameSparkline
limitHeight
sortChapter ⇧,Name ⇧
separatorPoint (.)
labels‚‚‚
default,,,
cell-width,,,
userfilterChapter,Name,Excerpt
datepatterndd M yy
globalFiltertrue
id1580196867002_1215371542
worklog5|8|w d h m|w d h m
isORAND
order0,1,2,3
ChapterNameExcerpt
Designer Administrationcontent_languages
Multiexcerpt
MultiExcerptNamecontent_languages
  • Content Language: The content language is the display language for the elements you create in the Designer. Default languages are:
    • English
    • German
Designer Panel Overviewhide_panels
Multiexcerpt
MultiExcerptNamehide_panels

You can hide panels that you do not currently need. The icons of hidden panels are displayed in the right upper corner.

Modeling Servicesenlarge_canvas
Multiexcerpt
MultiExcerptNameenlarge_canvas

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

Designer Panel Overviewpanel_icons
Multiexcerpt
MultiExcerptNamepanel_icons

The following icons represent the corresponding panel:

IconPanel
Attributes Panel
Library Panel
Objects Panel
Overview Panel
Search Panel
Styling Panel
Validation Panel
Designer Panel Overviewpanels_general_description
Multiexcerpt
MultiExcerptNamepanels_general_description

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

Designer Panel Overviewrearrange_panel_new
Multiexcerpt
MultiExcerptNamerearrange_panel_new

You can also arrange the panels individually.

The dashed frame indicates the new position of the panel.

Designer Panel Overviewrearrange_panel_tab
Multiexcerpt
MultiExcerptNamerearrange_panel_tab

Use drag & drop to rearrange panels.

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

Designer Panel Overviewresize_panels
Multiexcerpt
MultiExcerptNameresize_panels

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

Designer Panel Overviewsearch_panel
Multiexcerpt
MultiExcerptNamesearch_panel

The Search panel helps you to find objects on the canvas. Enter your search term in the box.

  • Use icon to reset the search box.
Designer Panel Overviewsearch_panel_bpmn
Multiexcerpt
MultiExcerptNamesearch_panel_bpmn

Click on a match in the list to focus the element on the canvas. This applies to elements on the BPMN Canvas...

Designer Panel Overviewsearch_panel_execution
Multiexcerpt
MultiExcerptNamesearch_panel_execution

... as well as to elements on the Execution Canvas.

Designer Panel Overviewsearch_panel_hit_list
Multiexcerpt
MultiExcerptNamesearch_panel_hit_list

Enter your search term in the box. The results are displayed in a hit list below.

The list displays the results in the following sections:

  • Objects
  • Execution variables - Persisted
  • Execution variables - Local
  • Execution steps
Designer Panel Overviewshow_panels
Multiexcerpt
MultiExcerptNameshow_panels

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.

Designer Panel Overviewuse_attribute_panel
Multiexcerpt
MultiExcerptNameuse_attribute_panel
Info

Use the Attributes Panel to edit the attributes or to make them visible on the canvas.

Diversetip_library_administration
Multiexcerpt
MultiExcerptNametip_library_administration
Tip

Open menu Libraries in the Designer administration to upload your own libraries.

Managing Projectsbpmn_created
Multiexcerpt
MultiExcerptNamebpmn_created

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.

Managing Projectsbpmn_new_tab
Multiexcerpt
MultiExcerptNamebpmn_new_tab

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

Managing Projectscreate_bpmn
Multiexcerpt
MultiExcerptNamecreate_bpmn

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

Managing Projectscreate_folder
Multiexcerpt
MultiExcerptNamecreate_folder

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

Managing Projectscreate_project
Multiexcerpt
MultiExcerptNamecreate_project

Enter a name for the project in the pop-up window Create New Project. Click Save.

Managing Projectscutting_and_pasting
Multiexcerpt
MultiExcerptNamecutting_and_pasting

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.

Info

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.
Managing Projectsdescription_editor
Multiexcerpt
MultiExcerptNamedescription_editor

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

Managing Projectsdescription_editor_save
Multiexcerpt
MultiExcerptNamedescription_editor_save

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

Managing Projectsexplorer_search
Multiexcerpt
MultiExcerptNameexplorer_search

On top of the explorer tree you can find a search box. If you have not selected any content in the tree, the box is grayed out.

Managing Projectsfolder_created
Multiexcerpt
MultiExcerptNamefolder_created

The new folder is created and displayed in the tree.

Managing Projectsinfo_libraries_mandatory
Multiexcerpt
MultiExcerptNameinfo_libraries_mandatory
Info

The folders Libraries and Models are mandatory parts of a project, therefore users cannot delete them.

Managing Projectsnote_element_restrictions
Multiexcerpt
MultiExcerptNamenote_element_restrictions
Note
titleRestrictions on Element Names
  • Element names must not be empty.
  • Element names must be unique in one BPMN model.
  • The following characters are not allowed in element names: <, >, :, ", /, \\, |, ?, *
  • Element names must not end with a period (.).
  • The following strings must not be used as element names: CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, LPT9.
  • Furthermore, only project names may not contain spaces.
Managing Projectspaste_url
Multiexcerpt
MultiExcerptNamepaste_url

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

Managing Projectsproject_content
Multiexcerpt
MultiExcerptNameproject_content

Each newly created project contains already a folder Libraries and a folder Models.

Managing Projectsproject_created
Multiexcerpt
MultiExcerptNameproject_created

The new project is created and displayed in the tree.

Managing Projectstip_profiles_admin_guide
Multiexcerpt
MultiExcerptNametip_profiles_admin_guide
Tip

For further information on namespaces visit the Administration Guide.

Managing Projectstoast_confirmation
Multiexcerpt
MultiExcerptNametoast_confirmation

The action is confirmed by a toast message.

Managing Projectstree_export
Multiexcerpt
MultiExcerptNametree_export

Export

The export is an available option for the following elements:

  • Folder
  • Project
  • Model
  • BPMN model

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.

The export starts directly. During the export the message Generating file... is displayed.
A toast message also confirms the successful export.

Managing Projects

tree_import
Multiexcerpt
MultiExcerptNametree_import

Import

The import is an available option for the following elements:

  • Namespace
  • Folder
  • Model

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.
The imported element is displayed in the tree.
Managing Projects / Modeling Servicesadd_library
Multiexcerpt
MultiExcerptNameadd_library

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

Managing Projects / Modeling Servicesmanage_libraries
Multiexcerpt
MultiExcerptNamemanage_libraries

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.

Managing Projects / Modeling Servicesremove_libraries
Multiexcerpt
MultiExcerptNameremove_libraries

You can also remove libraries from the list.

Open the dialog Manage Libraries again and click the  icon.

The library will switch back to the Unused Libraries column.

Managing Projects / Modeling Servicesused_libraries
Multiexcerpt
MultiExcerptNameused_libraries

The library is now displayed in the column Used Libraries.

If you have finished, do not forget to Save.

Modeling Servicescreate_bpmn_objects
Multiexcerpt
MultiExcerptNamecreate_bpmn_objects

Drag the object you want to create from the toolbar and drop it on the canvas.

You can also double click an object in the toolbar to create it on the canvas.

To cancel the operation, press the Esc key.

As soon as you have created a first element, you can also use the objects context menu to create further elements.

Click on an object or hover over an active element to open the context menu.

Info

A start event can only be created via the objects toolbar.

If you mark an element on the canvas before you create a new element, a relation is automatically created between both elements.

Double click the name of the object to enable edit mode and change the content.

The name of an object must be unique in a BPMN model. Your input is validated.

Info

The validation is case insensitive.

Tip

Open the Styling Panel to change the formatting of an object.

Modeling Servicesenlarge_canvas
Multiexcerpt
MultiExcerptNameenlarge_canvas

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

Modeling Serviceshide_sidebar
Multiexcerpt
MultiExcerptNamehide_sidebar

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

Modeling Servicesexecution_context_menus
Multiexcerpt
MultiExcerptNameexecution_context_menus

The following table explains the available options:

Objects Context Menu

If you right click on an object, the tools context menu opens. Use it to edit the current object.

The following options are available:

  • = Delete the object.
  • = Go to library. Click on this icon to open mark the current object in the library panel.
You can use the objects context menu on all objects on the execution canvas.
Execution Canvas Context Menu

A right click on the execution canvas opens another context menu including the following options:

  • = Undo the last action.
  • = Redo the last action.
  • = Show parameter name. Use this icon to show or hide the parameter names of operations on the execution canvas.
Modeling Servicesinfo_styling_attributes_tab
Multiexcerpt
MultiExcerptNameinfo_styling_attributes_tab
Info

The tab is displayed by default only for the objects Message Start EventEnd Event and Exclusive Gateway as well as for a Relation of an exclusive gateway. These objects are already created on the canvas including the attribute Name.

For the other objects the Attributes tab is displayed as soon as you create one of its attributes on the canvas (see Attributes Panel for further information).

Modeling Servicesmodel_toolbar
Multiexcerpt
MultiExcerptNamemodel_toolbar

The model toolbar assists you during modeling on the BPMN canvas. The following table explains the available tools:

Tool IconTool NameDescription
ExportUse this icon to export your BPMN model in JSON format.
ReportClick 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 a Report for details.
ShareIf 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 cockpitIf you want direct access to your BPMN model in your Scheer PAS 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 areaUse this icon to hide the execution canvas. This allows to gain more space during modeling.
Toggle gridUse this icon to enable or disable the grid on the BPMN canvas. The grid supports you during modeling: If the grid is enabled, objects snap to the grid points.
Show invalidActivate the icon to display all invalid elements.
Service Handling

Use this icon to open the submenu that contains all options for managing your service:

  • = Deploy the service.
  • = Start the service.
  •  = Stop the service.
  •  = Open your Scheer PAS BRIDGE.
  • = Create an export of the Designer service repository.
    • Use the export
      a) If you want to deploy the repository to another Bridge.
      b) If you want to analyze the service with Scheer PAS Analyzer.
  • = Clear your Compiler cache.
    • You need to clear your Compiler cache, when you 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.
Free textClick the text icon to create a text box on the BPMN canvas.
Add imageIf you want to add an image on the BPMN canvas, click the Image icon and create an empty frame on the canvas. To upload a picture into the frame, use the attribute Image in the Attributes Panel.
Insert/Remove horizontal spaceUse this icon if you need more or less space on the canvas. Click on the canvas 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 spaceUse this icon if you need more or less space on the canvas. Click on the canvas 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.
UndoIf you want to cancel your last action on the BPMN canvas, use this icon.
RedoUse this icon to restore the action that you had previously undone.
Modeling Servicesobjects_toolbar
Multiexcerpt
MultiExcerptNameobjects_toolbar

The objects toolbar contains all BPMN elements that you can create on the canvas.

By default, the objects toolbar only displays the icons of the BPMN objects.

But you can also expand the toolbar by using the icon.

In its expanded version, the names of all objects are also displayed.

Tip

In chapter Supported BPMN Elements all elements and their specific properties are described.

Drag the object you want to create from the toolbar and drop it on the canvas.

You can also double click an object in the toolbar to create it on the canvas.

To cancel the operation, press the Esc key.

Tip

Further details are explained on page Creating BPMN Objects.

Other Elementsexecution_other_elements
Multiexcerpt
MultiExcerptNameexecution_other_elements

The content of this element is ignored during execution.

Other Elementsother_background_color
Multiexcerpt
MultiExcerptNameother_background_color

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:

Other Elementsother_border_color
Multiexcerpt
MultiExcerptNameother_border_color

Border Color

To select a background color for the object, 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.

Supported BPMN Elementsattributes
Multiexcerpt
MultiExcerptNameattributes

All available attributes of an object are displayed in the Attributes Panel.

Supported BPMN Elementsattributes_display_name_of_attribute
Multiexcerpt
MultiExcerptNameattributes_display_name_of_attribute

Display Name of Attribute

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

Supported BPMN Elementsattributes_font
Multiexcerpt
MultiExcerptNameattributes_font

Font

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

Supported BPMN Elementsattributes_font_color
Multiexcerpt
MultiExcerptNameattributes_font_color

Font Color

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

Supported BPMN Elementsattributes_font_size
Multiexcerpt
MultiExcerptNameattributes_font_size

Font Size

In this section you can change the font size of the object's attributes on the canvas.

Supported BPMN Elementsattributes_word_wrap
Multiexcerpt
MultiExcerptNameattributes_word_wrap

Word Wrap

By default, the object's attributes are displayed in a single line on the canvas. 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 canvas.

Supported BPMN Elementsdisplaying_attributes
Multiexcerpt
MultiExcerptNamedisplaying_attributes

You can display the attributes of an object on the BPMN canvas: Select the attribute you want to show in the Attributes Panel and move it to the canvas by using drag&drop.

Supported BPMN Elementsediting_attributes
Multiexcerpt
MultiExcerptNameediting_attributes

As soon as you have created an attribute of an object on the canvas, the Styling Panel will show the tab Attributes. Open this tab to edit the formatting of the displayed attributes.

Supported BPMN Elementsobjects_config_options
Multiexcerpt
MultiExcerptNameobjects_config_options

Open the Styling Panel to use the configuration options of the element.

Supported BPMN Elementsobjects_font
Multiexcerpt
MultiExcerptNameobjects_font

Font

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

Supported BPMN Elementsobjects_font_color
Multiexcerpt
MultiExcerptNameobjects_font_color

Font Color

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

Supported BPMN Elementsobjects_font_size
Multiexcerpt
MultiExcerptNameobjects_font_size

Font Size

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

Supported BPMN Elementsobjects_shape_tab
Multiexcerpt
MultiExcerptNameobjects_shape_tab

Background Color

If you want to change the background color of the object, click on the color placeholder.

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

Border Color

If you want to change the border color of the object, click on the color placeholder to display the color picker.

Opacity

Changes of the opacity apply equally to background and border color.

Supported BPMN Elementsobjects_word_wrap
Multiexcerpt
MultiExcerptNameobjects_word_wrap

Word Wrap

By default, object 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:

Supported BPMN Elementsopen_objects_menu
Multiexcerpt
MultiExcerptNameopen_objects_menu

Click on the element to open the objects context menu which supports you in creating new objects:

For detailed information see page BPMN Canvas.

Supported BPMN Elementsopen_relation_menu
Multiexcerpt
MultiExcerptNameopen_relation_menu

If you right click an arrow the relation context menu opens allowing you to edit the relation:

For detailed information see page BPMN Canvas.

Supported BPMN Elementsopen_tools_menu
Multiexcerpt
MultiExcerptNameopen_tools_menu

If you right click an element, the tools context menu opens allowing you to edit the current object:

For detailed information see page BPMN Canvas.

Supported BPMN Elementsrelations_shape_tab
Multiexcerpt
MultiExcerptNamerelations_shape_tab

Line Color

If you want to change the color of the arrow, click on the color placeholder to display the color picker.

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

Line Style

You have three options for the style of the arrow line. Use the drop-down list to select the desired option.

Arrow at Start

Open the drop-down list to select the styling for the arrow head.

Arrow at End

Open the drop-down list to select the styling for the arrow end.

Line Width

Use this option to change the width of the arrow line.

Supported BPMN Elementsset_timeout
Multiexcerpt
MultiExcerptNameset_timeout

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.