Important Note

This space contains files and text snippets that are used throughout the Scheer PAS documentation.
This content is not meant to be read independently from the rest of the documentation.

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 313 Next »

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

ChapterNameExcerpt
BPMN Elementsattributes

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

BPMN Elementsattributes_display_name_of_attribute

Display Name of Attribute

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

BPMN Elementsattributes_font

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.

BPMN Elementsattributes_font_color

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:

BPMN Elementsattributes_font_size

Font Size

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

BPMN Elementsattributes_word_wrap

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.

BPMN Elementsboundary_events

Intermediate Event, Message Intermediate Event and Timer Intermediate Event can be used as boundary events along with User Task and Receive Task. When using the events as boundary events, attach the element directly to the border of the corresponding task:

BPMN Elementsbpmn_elements_config_options

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

BPMN Elementsbpmn_elements_font

Font

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

BPMN Elementsbpmn_elements_font_color

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:

BPMN Elementsbpmn_elements_font_size

Font Size

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

BPMN Elementsbpmn_elements_shape_tab

Background Color

If you want to change the background color of 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:

Border Color

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

Opacity

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

BPMN Elementsbpmn_elements_word_wrap

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:

BPMN Elementscreation_of_start_events

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

BPMN Elementsdisplaying_attributes

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.

BPMN Elementsediting_attributes

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.

BPMN Elementsopen_bpmn_elements_menu

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

For detailed information see page The Diagram Pane > The Diagram Context Menus.

BPMN Elementsopen_relation_menu

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

For detailed information see page The Diagram Pane > The Diagram Context Menus.

BPMN Elementsopen_tools_menu

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

For detailed information see page The Diagram Pane > The Diagram Context Menus.

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

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

Designer Administrationclear_compiler_cache

Do not forget to clear the compiler cache when you have updated a library. You will find the button to clear the cache in the model toolbar.

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.

Designer Panel Overviewbridge_base

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.

How to upload your own libraries is explained on page Designer Administration > Libraries.
Detailed information about the Bridge base types can be found in the Bridge documentation.

Designer Panel Overviewdefault_value_attribute

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.

Designer Panel Overviewdefine_timer

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

Designer Panel Overviewhide_panels

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

Designer Panel Overviewhow_to_use_the_timer

If you click icon in the attribute panel, a separate editor will open. Here you can define the settings of your Timer Start Event.

You have two options with different settings:

Scheduler

Use the scheduler if you want to define a pattern for your Timer Start Event, for example to start the model every monday, every hour etc.

SettingDescriptionDefault
Allow Parallel ExecutionsIf checked, each time a scheduler pattern matches, the scheduler activity diagram is executed - even if another execution is already running.
If not checked, the next execution cycle is suppressed if an execution diagram is already being run.		Checked
Year(s)Insert a positive integer or a pattern.*
Month(s)Use numbers 1 to 12 or a pattern.*
Weekdays(s)

Valid input:

  • Mon or Monday
  • Tue or Tuesday
  • Wed or Wednesday
  • Thur or Thursday
  • Fri or Friday
  • Sat or Saturday
  • Sun or Sunday
  • a pattern
*
Day(s)Depending on the month, valid input are numbers from 1 to 31 or a pattern.*
Hours(s)Use 0 to 23 or a pattern.*
Minute(s)Use 0 to 59 or a pattern.0
SecondsUse 0 to 59 or a pattern.0

Timer 

Select the timer if you want to define a cycle for example to start the model after one week, after two hours etc.

SettingDescriptionDefault
Repeat IntervalEnter a valid time duration expression (see page Time Durations in the BRIDGE documentation for detailed information).
This setting defines the time interval between two calls of the timer action.		-
OccurrencesInsert a positive integer to define the count of repetitions. If you want the timer to be endless, check Always (default).Always
First OccurrenceEnter a valid time duration expression (see page Time Durations in the BRIDGE documentation for detailed information).
This setting defines the wait interval after service start before the timer is executed for the first time.		0 seconds
Parallel EventsInsert a positive integer. Defines the count of timer event handlers that are allowed to run in parallel.
If an event cannot be processed within the repeat interval, a new thread will be started that processes the next event - as long as the number of parallel events is less than the value in this box.
1 = no parallel execution (default)		1
Queued EventsInsert a positive integer to define the number of events being queued if an event cannot be processed within the repeat interval.1

Duration Expression Wizard

The settings Repeat Interval and First Occurrence contain the icon .

Click the icon to open a wizard that supports you to define the necessary duration expression.


Insert positive integers in the desired fields.

The result is shown below.

Click Save to close the wizard.

The duration expression is displayed in the corresponding field.

Once you are familiar with the notation of the duration expression, you can also insert it directly in the field.

Designer Panel Overviewpanel_icons

The following icons represent the corresponding panel:

IconPanel
Attributes Panel
Library Panel
Overview Panel
Search Panel
 Styling Panel
Validation Panel

Designer Panel Overviewpanels_general_description

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

Designer Panel Overviewrearrange_panel_new

You can also arrange the panels individually.

The dashed frame indicates the new position of the panel.

Designer Panel Overviewrearrange_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

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

Designer Panel Overviewsearch_panel

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

  • Use icon to reset the search box.

Designer Panel Overviewsearch_panel_bpmn

Click on a match in the list to focus the element on the pane. This applies to elements on the diagram pane...

Designer Panel Overviewsearch_panel_execution

... as well as to elements on the execution pane.

Designer Panel Overviewsearch_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:

  • Elements
  • Execution variables - Persisted
  • Execution variables - Local
  • Execution steps

Designer Panel Overviewshow_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

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

Diversetip_library_administration

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

Form Elementsform_elements_text

A text may be entered in this field.

Form Elementsform_elements_placeholder

The content of the field is displayed in the element as a placeholder. As soon as the line is labeled, the placeholder disappears and the actual text is taken over.

Form Elementsform_elements_vertical_alignment

The option is used to vertically align smaller fields next to higher fields.Align element on top (default).Align element centered between top and bottom of cell.Align element at the bottom.

Managing Projectsbpmn_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

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

Managing Projectscreate_bpmn

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

Managing Projectscreate_folder

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

Managing Projectscreate_project

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

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

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

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

Managing Projectsdescription_editor_save

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

Managing Projectsexplorer_search

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.

Managing Projectsfolder_created

The new folder is created and displayed in the tree.

Managing Projectsinfo_libraries_mandatory

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

Managing Projectsnote_element_restrictions

Restrictions 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 Service names may not contain spaces.

Managing Projectspaste_url

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

Managing Projectsproject_content

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

Managing Projectsproject_created

The new service is created and displayed in the tree.

Managing Projectstip_profiles_admin_guide

Go to the Administration Guide for further information on the creation of namespaces.

Managing Projectstoast_confirmation

The action is confirmed by a toast message.

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

Managing Projectstree_export_with_library

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.

Managing Projects

tree_import

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.

Managing Projects / Modeling Servicesadd_library

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

Managing Projects / Modeling Serviceslibrary_documentation

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

Managing Projects / Modeling Servicesmanage_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

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.

Managing Projects / Modeling Servicesshow_library_doc

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

Managing Projects / Modeling Servicesused_libraries

The library is now displayed in the column Used Libraries.

If you have finished, do not forget to Save.

Modeling Servicesbpmn_elements_toolbar

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.

To cancel the operation, press the Esc key.

Further details are explained on page Adding BPMN Elements.

Modeling Servicescreate_bpmn_elements

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

To cancel the operation, press the Esc key.

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

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

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

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

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

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

The validation is case insensitive.

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

Modeling Servicesenlarge_pane

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

Modeling Servicesexecution_preliminaries

You need to perform two steps to implement executional parts to your model:

  1. You need to import a library that provides all necessary data types and operations for the implementation of your process.
    Variables always have a type. The types to be used can be basic types, or must be provided with a library.
    (see chapter Designer Administration > Libraries for further information)
  2. In the second step you have to select data types and operations from the imported library and add them to your process at the right places.

Modeling Servicesfit_model_to_pane

If you want your model to be completely visible, use the  icon at the bottom of the pane.

Modeling Serviceshide_sidebar

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

Modeling Servicesinfo_message_section

Section Message is shown for all BPMN elements that need an incoming message:

See page Modeling Execution for further details.

Modeling Servicesinfo_styling_attributes_tab

The tab is displayed by default only for the elements Message Start Event, Timer Start Event, End Event and Exclusive Gateway as well as for a Relation of an exclusive gateway. These elements are already created on the diagram pane including their attribute Name.

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

Modeling Serviceslocal

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

Modeling Servicesmodel_toolbar

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

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 paneUse this icon to hide the execution pane. This allows to gain more space during modeling.
Toggle gridUse 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 invalidActivate the icon to highlight all invalid elements.
Start serviceClick on this icon to start your service.
Stop serviceStop the service by clicking on this icon.
Open Bridge

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

Deploy service

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 Scheer PAS Analyzer.


Use this icon to 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.
Insert/Remove horizontal spaceUse 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 spaceUse 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.
UndoIf you want to cancel your last action on the diagram pane, use this icon.
RedoUse this icon to restore the action that you had previously undone.

Modeling Servicespersisted

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

Modeling Servicespersisted_variable_added

The variable is added to the execution pane.

Modeling Servicesscale_model

Click icon   to scale the model to 100 %.

Modeling Servicessecond_persisted_variable

Once a variable has been added to the Persisted section, it is available in all executions of the BPMN model. If you add the variable again from within the library, a second persisted variable is created that is independent of the first. This is indicated by a new name.

Modeling Servicessecond_sidebar

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

Modeling Servicesstate_of_pane

The state of the pane is saved for each user.

Other Elementsexecution_other_elements

The content of this element is ignored during execution.

Other Elementsother_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

Border Color

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




  • No labels