Chapter | Name | Excerpt | Usage |
---|
Troubleshooting | class_name_unique_problem | Multiexcerpt |
---|
MultiExcerptName | class_name_unique_problem |
---|
| 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. |
|
|
Troubleshooting | class_name_unique_reason | Multiexcerpt |
---|
MultiExcerptName | class_name_unique_reason |
---|
| Class names must be unique. |
|
|
Troubleshooting | class_name_unique_solution | Multiexcerpt |
---|
MultiExcerptName | class_name_unique_solution |
---|
| 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. |
|
|
Designer Administration Structuring Your Work | library_documentation | Multiexcerpt |
---|
MultiExcerptName | library_documentation |
---|
| If documentation is available, it will be displayed in a separate pop-up. |
| |
Designer Administration Structuring Your Work | show_library_doc | Multiexcerpt |
---|
MultiExcerptName | show_library_doc |
---|
| Use the documentation icon to display the documentation of a library. |
| |
Designer Administration Working With Libraries | clear_compiler_cache | Multiexcerpt |
---|
MultiExcerptName | clear_compiler_cache |
---|
| Note |
---|
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.
|
| |
Diverse | form_elements_placeholder | Multiexcerpt |
---|
MultiExcerptName | form_elements_placeholder |
---|
| 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. Info |
---|
If content is added to both attributes Text and Placeholder, the content of Text is displayed in the element. |
|
| |
Modeling BPMN | attribute_description | Multiexcerpt |
---|
MultiExcerptName | attribute_description |
---|
| If you want to insert a description for your element, click here to enable edit mode and enter your text. |
| |
Modeling BPMN | attributes_display_name_of_attribute | Multiexcerpt |
---|
MultiExcerptName | attributes_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. |
| |
Modeling BPMN | attributes_font | Multiexcerpt |
---|
MultiExcerptName | attributes_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. |
| |
Modeling BPMN | attributes_font_color | Multiexcerpt |
---|
MultiExcerptName | attributes_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:
|
| |
Modeling BPMN | attributes_font_size | Multiexcerpt |
---|
MultiExcerptName | attributes_font_size |
---|
| Font Size In this section you can change the font size of the element's attributes on the diagram pane. |
| |
Modeling BPMN | attributes_word_wrap | Multiexcerpt |
---|
MultiExcerptName | attributes_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. Go to page Resizing BPMN Elements for detailed information. |
| |
Modeling BPMN | bpmn_elements_font | Multiexcerpt |
---|
MultiExcerptName | bpmn_elements_font |
---|
| Font Use this section to select the font for the text within the element. You have also several formatting options. |
| |
Modeling BPMN | bpmn_elements_font_color | Multiexcerpt |
---|
MultiExcerptName | bpmn_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:
|
| |
Modeling BPMN | bpmn_elements_font_size | Multiexcerpt |
---|
MultiExcerptName | bpmn_elements_font_size |
---|
| Font Size In this section you can change the font size of the text within the element. |
| |
Modeling BPMN | bpmn_elements_shape_tab | Multiexcerpt |
---|
MultiExcerptName | bpmn_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. |
|
| |
Modeling BPMN | bpmn_elements_toolbar | Multiexcerpt |
---|
MultiExcerptName | bpmn_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. | | 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. |
|
| |
Modeling BPMN | bpmn_elements_word_wrap | Multiexcerpt |
---|
MultiExcerptName | bpmn_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:
|
| |
Modeling BPMN | create_bpmn_elements | Multiexcerpt |
---|
MultiExcerptName | create_bpmn_elements |
---|
| | 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. | | 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. Info |
---|
Start events 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. Info |
---|
The validation is case insensitive. |
| | Tip |
---|
Open the Styling panel to change the formatting of an element. Go to page Styling BPMN Elements for detailed information. |
|
|
| |
Modeling BPMN | displaying_attributes | Multiexcerpt |
---|
MultiExcerptName | displaying_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. |
| |
Modeling BPMN | editing_attributes | Multiexcerpt |
---|
MultiExcerptName | editing_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. |
| |
Modeling BPMN | model_toolbar | Multiexcerpt |
---|
MultiExcerptName | model_toolbar |
---|
| 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. |
|
| |
Modeling BPMN | other_background_color | Multiexcerpt |
---|
MultiExcerptName | other_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:
|
| |
Modeling BPMN | rearrange_panel_new | Multiexcerpt |
---|
MultiExcerptName | rearrange_panel_new |
---|
| You can also arrange the panels individually. The dashed frame indicates the new position of the panel. |
|
|
Modeling BPMN | rearrange_panel_tab | Multiexcerpt |
---|
MultiExcerptName | rearrange_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. |
|
|
Modeling BPMN | relations_shape_tab | Multiexcerpt |
---|
MultiExcerptName | relations_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. |
|
| |
Modeling BPMN | resize_panels | Multiexcerpt |
---|
MultiExcerptName | resize_panels |
---|
| It is also possible to resize panels by dragging the vertical or horizontal panel borders. |
|
|
Modeling BPMN Modeling Data Mapping Modeling Execution | fit_model_to_pane | Multiexcerpt |
---|
MultiExcerptName | fit_model_to_pane |
---|
| If you want your model to fit to the screen, use the icon at the bottom of the editor. |
| |
Modeling BPMN Modeling Data Mapping Modeling Execution | scale_model | Multiexcerpt |
---|
MultiExcerptName | scale_model |
---|
| Click icon to scale the model to 100 %. |
| |
Modeling BPMN Modeling Data Mapping Modeling Execution | second_sidebar | Multiexcerpt |
---|
MultiExcerptName | second_sidebar |
---|
| You can open a second sidebar on the right side of the editor. Use both sidebars to manage the Designer Panels. |
| |
Modeling BPMN Modeling Data Mapping Modeling Forms Modeling Execution | enlarge_pane | Multiexcerpt |
---|
MultiExcerptName | enlarge_pane |
---|
| If you want to enlarge the editor, use icon in the middle of each frame to draw the frame larger or smaller. |
| |
Modeling BPMN Modeling Data Mapping Modeling Forms Modeling Execution | hide_sidebar | Multiexcerpt |
---|
MultiExcerptName | hide_sidebar |
---|
| With a click on the icon, the window maximizes on this side of the frame. |
| |
Modeling BPMN Modeling Data Mapping Modeling Forms Modeling Execution | panel_management | Multiexcerpt |
---|
MultiExcerptName | panel_management |
---|
| 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 | | | Search Panel | - BPMN Editor
- Mapping Editor
| | Styling Panel | | | 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. |
|
| |
Modeling BPMN Modeling Data Mapping Modeling Forms Modeling Execution | state_of_pane | Multiexcerpt |
---|
MultiExcerptName | state_of_pane |
---|
| Info |
---|
The state of the editor is saved for each user. |
|
| |
Modeling BPMN Modeling Execution | attribute_name | Multiexcerpt |
---|
MultiExcerptName | attribute_name |
---|
| Click here to insert or change attribute Name. |
| |
Modeling BPMN Structuring Your Work | add_bpmn_model | Multiexcerpt |
---|
MultiExcerptName | add_bpmn_model |
---|
| 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. |
| |
Modeling BPMN Structuring Your Work | bpmn_created | Multiexcerpt |
---|
MultiExcerptName | bpmn_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. |
| |
Modeling BPMN Structuring Your Work | bpmn_new_tab | Multiexcerpt |
---|
MultiExcerptName | bpmn_new_tab |
---|
| When you create a new model, it opens automatically in a new tab and you can directly start modeling. |
| |
Modeling BPMN Structuring Your Work | create_bpmn | Multiexcerpt |
---|
MultiExcerptName | create_bpmn |
---|
| Enter a name for the BPMN model in the pop-up window Create New Model. Click Save. |
| |
Modeling BPMN Supported BPMN Elements | define_timer | Multiexcerpt |
---|
MultiExcerptName | define_timer |
---|
| To define the timer settings, click the icon and an editor will open. For detailed explanations see How to Use the Scheduler/Timer. |
| |
Modeling BPMN Supported BPMN Elements | how_to_use_the_timer | Multiexcerpt |
---|
MultiExcerptName | how_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. Setting | Description | Default |
---|
Allow Parallel Executions | If 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 | Seconds | Use 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. Setting | Description | Default |
---|
Repeat Interval | Enter 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. | - | Occurrences | Insert a positive integer to define the count of repetitions. If you want the timer to be endless, check Always (default). | Always | First Occurrence | Enter 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 Events | Insert 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 Events | Insert a positive integer to define the number of events being queued if an event cannot be processed within the repeat interval. | 1 |
Anchor |
---|
| duration_expression |
---|
| duration_expression |
---|
|
| | 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. Tip |
---|
Once you are familiar with the notation of the duration expression, you can also insert it directly in the field. |
|
|
| |
Modeling BPMN Supported BPMN Elements | set_timeout | Multiexcerpt |
---|
MultiExcerptName | set_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.
|
| |
Modeling Data Mapping | model_toolbar_clear_compiler_cache | Multiexcerpt |
---|
MultiExcerptName | model_toolbar_clear_compiler_cache |
---|
| 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.
|
| |
Modeling Data Mapping | model_toolbar_deploy_service | Multiexcerpt |
---|
MultiExcerptName | model_toolbar_deploy_service |
---|
| Use this icon to deploy the service. |
| |
Modeling Data Mapping | model_toolbar_export_repository | Multiexcerpt |
---|
MultiExcerptName | model_toolbar_export_repository |
---|
| 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. |
| |
Modeling Data Mapping | model_toolbar_open_bridge | Multiexcerpt |
---|
MultiExcerptName | model_toolbar_open_bridge |
---|
| Open your Scheer PAS Bridge with a click on this icon. |
| |
Modeling Data Mapping | model_toolbar_show_invalid | Multiexcerpt |
---|
MultiExcerptName | model_toolbar_show_invalid |
---|
| Activate the icon to highlight all invalid elements. |
| |
Modeling Data Mapping | model_toolbar_start_service | Multiexcerpt |
---|
MultiExcerptName | model_toolbar_start_service |
---|
| Click on this icon to start your service. |
| |
Modeling Data Mapping | model_toolbar_stop_service | Multiexcerpt |
---|
MultiExcerptName | model_toolbar_stop_service |
---|
| Stop the service by clicking on this icon. |
| |
Modeling Execution | default_value_attribute | Multiexcerpt |
---|
MultiExcerptName | default_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. |
| |
Modeling Execution | execution_preliminaries | Multiexcerpt |
---|
MultiExcerptName | execution_preliminaries |
---|
| Info |
---|
You need to perform two steps to implement executional parts to your model: - Provide all necessary data types and operations for the implementation of your process. These types and operations reside in the Service panel of the BPMN editor.
- You can use the Base Types that are provided with the Designer.
- You can create other necessary types yourself in the Data Model section.
Go to Modeling Data Mapping for further information. - You can import a library that provides additional types and operations.
See chapter Designer Administration > Libraries for further information.
- In the second step, select data types and operations from the Service panel, and add them to your process at the right places.
|
|
| |
Modeling Execution | info_message_section | Multiexcerpt |
---|
MultiExcerptName | info_message_section |
---|
| Info |
---|
Section Message is shown for all BPMN elements that need an incoming message: See page Modeling Execution for further details. |
|
| |
Modeling Execution | local | Multiexcerpt |
---|
| Variables created in section Local are only available for use within the current execution. |
| |
Modeling Execution | persisted | Multiexcerpt |
---|
MultiExcerptName | persisted |
---|
| Variables created in section Persisted are usable in all executions of the BPMN model. |
| |
Modeling Execution | persisted_variable_added | Multiexcerpt |
---|
MultiExcerptName | persisted_variable_added |
---|
| The variable is added to the execution pane. |
| |
Modeling Execution | second_persisted_variable | Multiexcerpt |
---|
MultiExcerptName | second_persisted_variable |
---|
| Note |
---|
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 Forms Structuring Your Work | create_form | Multiexcerpt |
---|
MultiExcerptName | create_form |
---|
| Enter a name for the form in the pop-up window Create New Form. Click Save. |
| |
Modeling Forms Structuring Your Work | form_created | Multiexcerpt |
---|
MultiExcerptName | form_created |
---|
| 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. |
| |
Modeling Forms Structuring Your Work | form_new_tab | Multiexcerpt |
---|
MultiExcerptName | form_new_tab |
---|
| When you create a new form, it opens automatically in a new tab and you can directly start designing. |
| |
Running Designer Applications | access_app_uis | Multiexcerpt |
---|
MultiExcerptName | access_app_uis |
---|
| You can access your application UIs directly from the service settings area. |
| |
Running Designer Applications | instance_list_content | Multiexcerpt |
---|
MultiExcerptName | instance_list_content |
---|
| The instance overview shows all unfinished instances. |
| |
Running Designer Applications | instance_list_refresh | Multiexcerpt |
---|
MultiExcerptName | instance_list_refresh |
---|
| Use icon Refreshto update the instance list. |
| |
Running Designer Applications | select_process_to_create_instance | Multiexcerpt |
---|
MultiExcerptName | select_process_to_create_instance |
---|
| Select the process for which you want to create a new instance. |
| |
Running Designer Applications | view_instance_overview | Multiexcerpt |
---|
MultiExcerptName | view_instance_overview |
---|
| Instances for which the process is finished are only displayed shortly. They then disappear from the list. |
| |
Searching in the Designer | panels_general_description | Multiexcerpt |
---|
MultiExcerptName | panels_general_description |
---|
| The Designer panels can be displayed on the left and right side of the panes and support the user during modeling. |
| |
Searching in the Designer Modeling BPMN Working With Libraries Modeling Execution Validating a Service | tip_panel_management | Multiexcerpt |
---|
MultiExcerptName | tip_panel_management |
---|
| |
| |
Searching in the Designer Structuring Your Work | explorer_search | Multiexcerpt |
---|
MultiExcerptName | explorer_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. |
| |
Structuring Your Work | add_library | Multiexcerpt |
---|
MultiExcerptName | add_library |
---|
| To add an unused library to the project, click on the icon. |
| |
Structuring Your Work | cockpit_tip | Multiexcerpt |
---|
MultiExcerptName | cockpit_tip |
---|
| Tip |
---|
Further information about the Cockpit, tiles and groups can be found in the BPaaS Guide. |
|
| |
Structuring Your Work | create_folder | Multiexcerpt |
---|
MultiExcerptName | create_folder |
---|
| Enter a name for the folder in the pop-up window Create New Folder. Click Save. |
| |
Structuring Your Work | create_project | Multiexcerpt |
---|
MultiExcerptName | create_project |
---|
| Enter a name for the service in the pop-up window Create New Service. Click Save. |
| |
Structuring Your Work | cutting_and_pasting
| Multiexcerpt |
---|
MultiExcerptName | cutting_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. | |
| |
Structuring Your Work | description_editor | Multiexcerpt |
---|
MultiExcerptName | description_editor |
---|
| Enter your text in the editor. Various formatting tools are provided. |
| |
Structuring Your Work | description_editor_save | Multiexcerpt |
---|
MultiExcerptName | description_editor_save |
---|
| Click Save and Close to confirm your text or Cancel to abort the action. |
| |
Structuring Your Work | folder_created | Multiexcerpt |
---|
MultiExcerptName | folder_created |
---|
| The new folder is created and displayed in the tree. |
| |
Structuring Your Work | info_libraries_mandatory | Multiexcerpt |
---|
MultiExcerptName | info_libraries_mandatory |
---|
| Info |
---|
The folders Libraries, Models and Forms are mandatory parts of a Service folder, therefore users cannot delete them. |
|
| |
Structuring Your Work | manage_libraries | Multiexcerpt |
---|
MultiExcerptName | manage_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. |
| |
Structuring Your Work | paste_url | Multiexcerpt |
---|
MultiExcerptName | paste_url |
---|
| You are now able to paste the URL, for example in an email. |
| |
Structuring Your Work | project_content | Multiexcerpt |
---|
MultiExcerptName | project_content |
---|
| Each newly created service contains already the folders Libraries, Models and Forms.
|
| |
Structuring Your Work | project_created | Multiexcerpt |
---|
MultiExcerptName | project_created |
---|
| The new service is created and displayed in the tree. |
| |
Structuring Your Work | remove_libraries | Multiexcerpt |
---|
MultiExcerptName | remove_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. |
| |
Structuring Your Work | tip_profiles_admin_guide | Multiexcerpt |
---|
MultiExcerptName | tip_profiles_admin_guide |
---|
| |
| |
Structuring Your Work | toast_confirmation | Multiexcerpt |
---|
MultiExcerptName | toast_confirmation |
---|
| The action is confirmed by a toast message. |
| |
Structuring Your Work | tree_export | Multiexcerpt |
---|
MultiExcerptName | tree_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. |
|
| |
Structuring Your Work | tree_export_with_library | Multiexcerpt |
---|
MultiExcerptName | tree_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. |
|
| |
| tree_import | Multiexcerpt |
---|
MultiExcerptName | 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. |
|
| |
Structuring Your Work | used_libraries | Multiexcerpt |
---|
MultiExcerptName | used_libraries |
---|
| The library is now displayed in the column Used Libraries. If you have finished, do not forget to Save. |
| |
Structuring Your Work Modeling BPMN Modeling Forms | note_element_restrictions | Multiexcerpt |
---|
MultiExcerptName | note_element_restrictions |
---|
| Note |
---|
title | 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.
|
|
| |
Supported BPMN Elements | boundary_events | Multiexcerpt |
---|
MultiExcerptName | boundary_events |
---|
| |
| |
Supported BPMN Elements | creation_of_start_events | Multiexcerpt |
---|
MultiExcerptName | creation_of_start_events |
---|
| Info |
---|
A start event can only be created via the elements toolbar. |
|
| |
Supported BPMN Elements | editing_and_styling | Multiexcerpt |
---|
MultiExcerptName | editing_and_styling |
---|
| - 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.
|
| |
Supported BPMN Elements | execution_other_elements | Multiexcerpt |
---|
MultiExcerptName | execution_other_elements |
---|
| The content of this element is ignored during execution. |
| |
Supported Form Elements | field_config_editor | Multiexcerpt |
---|
MultiExcerptName | 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. | 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. |
|
| |
Supported Form Elements | form_elements_cssClass | Multiexcerpt |
---|
MultiExcerptName | form_elements_cssClass |
---|
| Enables a field-acurate layout customization. |
| |
Supported Form Elements | form_elements_cssClass_value | Multiexcerpt |
---|
MultiExcerptName | form_elements_cssClass_value |
---|
| A valid CSS class. |
| |
Supported Form Elements | form_elements_description | Multiexcerpt |
---|
MultiExcerptName | form_elements_description |
---|
| A commentary field for the developer. The content is invisible to users and its sole purpose is internal documentation. |
| |
Supported Form Elements | form_elements_editing | Multiexcerpt |
---|
MultiExcerptName | form_elements_editing |
---|
| Go to page Modeling Forms for further information regarding editing of form elements using the context menu. |
| |
Supported Form Elements | form_elements_label | Multiexcerpt |
---|
MultiExcerptName | form_elements_label |
---|
| Field name shown in the form. |
| |
Supported Form Elements | form_elements_mandatory | Multiexcerpt |
---|
MultiExcerptName | form_elements_mandatory |
---|
| The element must be filled or used if the checkbox is activated. |
| |
Supported Form Elements | form_elements_mandatory_false | Multiexcerpt |
---|
MultiExcerptName | form_elements_mandatory_false |
---|
| Element may remain empty (default). |
| |
Supported Form Elements | form_elements_mandatory_true | Multiexcerpt |
---|
MultiExcerptName | form_elements_mandatory_true |
---|
| Element must be filled. |
| |
Supported Form Elements | form_elements_name | Multiexcerpt |
---|
MultiExcerptName | form_elements_name |
---|
| Technical identifier for data processing and not visible for the end user. |
| |
Supported Form Elements | form_elements_name_value | Multiexcerpt |
---|
MultiExcerptName | form_elements_name_value |
---|
| Alphanumercial characters and underscore. Info |
---|
It is not allowed to start the name with a number. |
|
| |
Supported Form Elements | form_elements_read-only | Multiexcerpt |
---|
MultiExcerptName | form_elements_read-only |
---|
| This field is write-protected. |
| |
Supported Form Elements | form_elements_read-only_false | Multiexcerpt |
---|
MultiExcerptName | form_elements_read-only_false |
---|
| User can enter values (default). |
| |
Supported Form Elements | form_elements_read-only_true | Multiexcerpt |
---|
MultiExcerptName | form_elements_read-only_true |
---|
| User cannot enter values. |
| |
Supported Form Elements | form_elements_symbolType | Multiexcerpt |
---|
MultiExcerptName | form_elements_symbolType |
---|
| Displays the type of the form element in read-only mode. |
| |
Supported Form Elements | form_elements_text | Multiexcerpt |
---|
MultiExcerptName | form_elements_text |
---|
| In this field, you can enter text. |
| |
Supported Form Elements | form_elements_vertical_alignment | Multiexcerpt |
---|
MultiExcerptName | form_elements_vertical_alignment |
---|
| 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. |
| |
| form_elements_vertical_alignment_bottom | Multiexcerpt |
---|
MultiExcerptName | form_elements_vertical_alignment_bottom |
---|
| Align the element at the bottom of the element cell.
|
| |
Supported Form Elements | form_elements_vertical_alignment_center | Multiexcerpt |
---|
MultiExcerptName | form_elements_vertical_alignment_center |
---|
| Align the element in the middle of the element cell. |
| |
Supported Form Elements | form_elements_vertical_alignment_top | Multiexcerpt |
---|
MultiExcerptName | form_elements_vertical_alignment_top |
---|
| Align the element on top of the element cell (default).
|
| |
Tips | click_to_see_gif | Multiexcerpt |
---|
MultiExcerptName | click_to_see_gif |
---|
| Tip |
---|
Click the image to see an animated version. |
|
|
|
Tips | click_to_see_gif_above | Multiexcerpt |
---|
MultiExcerptName | click_to_see_gif_above |
---|
| Tip |
---|
Click the image above to see an animated version. |
|
|
|
Working With Libraries | bridge_base | Multiexcerpt |
---|
MultiExcerptName | bridge_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. |
| |
Working With Libraries | tip_library_administration | Multiexcerpt |
---|
MultiExcerptName | tip_library_administration |
---|
| |
| |