Chapter | Name | Excerpt | Usage |
---|
Modeling Activities | hint_activity_diagram
| Multiexcerpt |
---|
MultiExcerptName | hint_activity_diagram |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| Activities are modeled in activity diagram. Refer to Modeling Activities for more information on how to create an activity diagram. | Configuring the Instance List | instance_list_basics
|
Multiexcerpt |
---|
MultiExcerptName | instance_list_basics |
---|
| Each created app offers two basic functionalities during execution: The user can create process data (so-called instances) - but he can also view the existing instances that have not yet been completed. These "instances in progress" are displayed in the instance list. For each BPMN model, a proper instance list is generated. During modeling, you can freely define which data should be displayed in the instance list. |
| |
Configuring the Instance List Supported Form Elements | add_column
|
Multiexcerpt |
---|
MultiExcerptName | add_column |
---|
| Use the Add button to add a new column. |
| |
Configuring the Instance List Supported Form Elements | column_cancel |
Multiexcerpt |
---|
MultiExcerptName | column_cancel |
---|
| Use the Cancel button to discard your changes. |
| |
Configuring the Instance List Supported Form Elements | column_css |
Multiexcerpt |
---|
MultiExcerptName | column_css |
---|
| Enables a field-acurate layout customization. |
| |
Configuring the Instance List Supported Form Elements | column_drag |
Multiexcerpt |
---|
MultiExcerptName | column_drag |
---|
| Use this area to move the columns by drag and drop. |
| |
Configuring the Instance List Supported Form Elements | column_hidden |
Multiexcerpt |
---|
MultiExcerptName | column_hidden |
---|
| Activate this checkbox and the column will be hidden during execution. |
| |
Configuring the Instance List Supported Form Elements | column_label
|
Multiexcerpt |
---|
MultiExcerptName | column_label |
---|
| The input in this field is displayed as header of the column. |
| |
Configuring the Instance List Supported Form Elements | column_name |
Multiexcerpt |
---|
MultiExcerptName | column_name |
---|
| Technical identifier for data processing. Not visible for the end user. The input in this field is mandatory. |
| |
Configuring the Instance List Supported Form Elements | column_save |
Multiexcerpt |
---|
MultiExcerptName | column_save |
---|
| Use the Save button to save your changes. |
| |
Designer Administration | backup_upload_change_file |
Multiexcerpt |
---|
MultiExcerptName | backup_upload_change_file |
---|
| The name of the selected file is displayed. If you want to select a different file, use the Change File button. The file's name is also displayed in field Name. Info |
---|
If you download a backup file from the Designer administration, the file name is extended by the creation date of the backup (timestamp). |
|
| |
Designer Administration | backup_upload_change_name |
Multiexcerpt |
---|
MultiExcerptName | backup_upload_change_name |
---|
| Change the contents of the Name field of you want to rename the backup before uploading it. The Confirm button is only enabled after you have selected the namespace to which the file is to be uploaded. |
| |
Designer Administration | library_documentation |
Multiexcerpt |
---|
MultiExcerptName | library_documentation |
---|
| If documentation is available, it will be displayed in a separate pop-up. |
| |
Designer Administration Getting Started With Designer | different_admin_views |
Multiexcerpt |
---|
MultiExcerptName | different_admin_views |
---|
| The content of the tree in the administration tab depends on the profile assigned to your account within Scheer PAS Administration . |
| |
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 option to clear the cache in the Controls Panel menu. |
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 User Guide | panel_customization |
Multiexcerpt |
---|
MultiExcerptName | panel_customization |
---|
| You have several options to adjust the diagram pane. When you open the pane for the first time, the default view is displayed: - The Diagram Pane is displayed in the centre at the top
(see chapter Modeling BPMN for further information) - The Execution Pane is displayed below the diagram pane
(see chapter Modeling Execution for further information) - Four Designer Panels are shown in the left sidebar
- The Service Panel
- The Controls Panel
- The Attributes Panel
- The Validation Panel
|
| |
Drawing a Business Process | exclusive_gateway_conditions |
Multiexcerpt |
---|
MultiExcerptName | exclusive_gateway_conditions |
---|
|
Info |
---|
- If you use an exclusive gateway, only one sequence flow is selected.
- If no condition evaluates to true and you have not defined a default flow, the xUML Runtime will throw an exception. We recommend avoiding this scenario.
|
|
| |
Drawing a Business Process | instance_persistent_state |
Multiexcerpt |
---|
MultiExcerptName | instance_persistent_state |
---|
|
Info |
---|
Process instances are kept in the persistent state database: The instances are created on process start and deleted on process end. Go to page xUML Service State Machines for further information. |
|
| |
Form Elements | prepopulation_no |
Multiexcerpt |
---|
MultiExcerptName | prepopulation_no |
---|
| This element cannot be prepopulated. |
| |
Form Elements | prepopulation_yes |
Multiexcerpt |
---|
MultiExcerptName | prepopulation_yes |
---|
| This element can be prepopulated. - You can set a default value in the Attributes panel to be applied before displaying the form. Refer to Changing BPMN Element Attributes for more information on that.
- You can overwrite these defaults dynamically in the Get Data execution of a user task. How to do this is explained on Using Forms.
|
| |
Implementing Your Process | default_value_attribute |
Multiexcerpt |
---|
MultiExcerptName | default_value_attribute |
---|
| Specify a default value for the related variable here. |
| |
Implementing Your Process | 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 Implementation 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.
- How this is done will be explained in this chapter.
|
|
| |
Implementing Your Process | execution_tabs |
Multiexcerpt |
---|
MultiExcerptName | execution_tabs |
---|
| - On Event: The model is executed when the event occurs.
- On Exit: The model is executed after completion of the task/event.
- Decision: The model is executed when the process reached the gateway.
- Get Data: The model is executed when BPMN is waiting in a user task and returns the default values for the form.
|
| |
Implementing Your Process | local |
Multiexcerpt |
---|
| Variables created in section Local are only available for use within the current execution. |
| |
Implementing Your Process | persisted |
Multiexcerpt |
---|
MultiExcerptName | persisted |
---|
| Variables created in section Persisted are usable in all executions of the BPMN model. |
| |
Implementing Your Process | persisted_variable_added |
Multiexcerpt |
---|
MultiExcerptName | persisted_variable_added |
---|
| The variable is added to the execution pane. |
| |
Implementing Your Process | second_persisted_variable |
Multiexcerpt |
---|
MultiExcerptName | second_persisted_variable |
---|
|
Info |
---|
Once a variable is defined as to be persisted, it is available in all executions throughout the BPMN model. If you drag out the same type again, a second persisted variable is created that is independent of the first. A consecutive number is appended to the name automatically as variable names must be unique. |
|
| |
Implementing Your Process Modeling BPMN | class |
Multiexcerpt |
---|
| A class is an aggregation of properties and operations that describes a complex data type from which objects can be created. |
| |
Implementing Your Process Modeling BPMN | implementation_folder
|
Multiexcerpt |
---|
MultiExcerptName | implementation_folder |
---|
| All elements inside the Implementation folder need to be created within packages. Add a new package via the quick action or the context menu. |
| |
Implementing Your Process Modeling BPMN | operation
|
Multiexcerpt |
---|
MultiExcerptName | operation |
---|
| An operation adds behavior to a class or interface. The behavior describes how to process the data given by the parameters. In the context of the Designer, you can implement operations as mapping diagram, action script or activity. |
| |
Implementing Your Process Modeling BPMN | packages
|
Multiexcerpt |
---|
| A package is like a directory for the file system. It is used to group executable data model elements. Packages can have any depth of nesting: To structure your work, you can create packages within packages. Also, packages define a sort of namespace to the contained elements. The name of the package is part of the element path, e.g. Package1.Class is different from Package2.Class. |
| |
Implementing Your Process Modeling BPMN | property |
Multiexcerpt |
---|
| Properties are data fields that describe the structure of the class. |
| |
Implementing Your Process Modeling Data Structures | hint_naming_conventions | | |
Implementing Your Process Modeling Data Structures | interface
|
Multiexcerpt |
---|
MultiExcerptName | interface |
---|
| In contrast to a class, an interface has no properties nor implementations. Interfaces are used to define common operations of multiple classes, and then derive from that interface. Operations of interfaces do not have an implementation but only define the signature (parameters and types). |
| |
Implementing Your Process Modeling Data Structures | parameter
|
Multiexcerpt |
---|
MultiExcerptName | parameter |
---|
| Operations can have parameters that define the input and output objects. Operation parameters can be of simple type (Base Types) or of complex type (class or interface). |
| |
Modeling Activities | hint_activity_diagram
|
Multiexcerpt |
---|
MultiExcerptName | hint_activity_diagram |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| Activities are modeled in activity diagrams. Refer to Modeling Activities for more information on how to create an activity diagram. |
| |
Modeling BPMN | activating_lanes |
Multiexcerpt |
---|
MultiExcerptName | activating_lanes |
---|
|
Tip |
---|
To activate the lane element, click its border or icon/header. If the element is active, an indicator is displayed in the lower right corner. |
|
| |
Modeling BPMN | add_bpmn_elements |
Multiexcerpt |
---|
MultiExcerptName | add_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. |
| |
Modeling BPMN | add_bpmn_model |
Multiexcerpt |
---|
MultiExcerptName | add_bpmn_model |
---|
| In the Process folder you can create your BPMN models. One service can contain several BPMN models. To create a model, hover over the process folder to display the quick start icons and click Add Model. |
| |
Modeling BPMN | add_library |
Multiexcerpt |
---|
MultiExcerptName | add_library |
---|
| To add an unused library to the project, click on the icon. |
| |
Modeling BPMN | adding_a_role |
Multiexcerpt |
---|
MultiExcerptName | adding_a_role |
---|
|
| If you open the role editor, it contains an empty line already. Start typing the name of the role your are seaching for in field Role. The field has an autocomplete function: As soon as you start inserting, a drop-down list is displayed containing all available roles that match your input. Select the role you want to use. | | In the next step you need to assign the rights that will be granted to the role owner. Available options are: Right | Description |
---|
Write | A user assigned to this role will be able to see and change the instance data for all process steps in the current lane. | Read | A user assigned to this role will be able to display the instance data for all process steps in the current lane. This right is assigned by default. | List | A user assigned to this role will only be able to see the instances in the instance table for all process steps in the current lane. |
| | You can continue to add further roles (or create new ones) as multiple roles can be assigned to one lane. When you have finished, save your changes to apply them to the lane. | | The number of roles assigned to a lane is displayed in the attributes panel. | | You have to open the user management, to assign the new role to users.
|
|
| |
Modeling BPMN | bpmn_created |
Multiexcerpt |
---|
MultiExcerptName | bpmn_created |
---|
| The new BPMN model is also displayed in the service panel and you can use icon to open it. |
| |
Modeling BPMN | 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 | 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 | creating_a_role |
Multiexcerpt |
---|
MultiExcerptName | creating_a_role |
---|
|
| Click button New Role to create a new role and assign it to the lane element. | | Enter the name of the new role in the pop-up window. The input is mandatory. | | If the role name is already in use, you will not be able to save. Use the existing role instead. | | Save to create the role. | | The new role is now added to the role editor and assigned to the current lane. | | In the next step you need to assign the rights that will be granted to the role owner. Available options are: Right | Description |
---|
Write | A user assigned to this role will be able to see and change the instance data for all process steps saved in the current lane. | Read | A user assigned to this role will be able to display the instance data for all process steps saved in the current lane. This right is assigned by default. | List | A user assigned to this role will only be able to see the instances in the instance table for all process steps saved in the current lane. |
| | You can continue to create further roles (or add already existing ones) as multiple roles can be assigned to one lane. When you have finished, save your changes to apply them to the lane. | | The number of roles assigned to a lane is displayed in the attributes panel. | | The new role has also been added to the user management. You have to open the user management, to assign the new role to users.
|
|
| |
Modeling BPMN | lane_handling |
Multiexcerpt |
---|
MultiExcerptName | lane_handling |
---|
|
| For a role-based process model, you need at least one main lane. You can then add sublanes. | | To create sublanes, drag the next lane elements onto the header of the main lane element. Drop the new element on the border of an existing lane to position the new sublane. To create a sublane within a sublane, you can drag the element onto the body of an existing lane. Multiexcerpt include |
---|
SpaceWithExcerpt | INTERNAL |
---|
MultiExcerptName | click_to_see_gif |
---|
PageWithExcerpt | _designer_excerpts |
---|
|
| |
Tip |
---|
To activate the lane element, click its border or icon/header. If the element is active, an indicator is displayed in the lower right corner and the border of the element is thicker. |
| Before Deletion: After Deletion: |
Info |
---|
title | Deletion Behavior of Lane Elements |
---|
| If you delete a lane element, it is erased from your work area including all content ! However, you can use restore the deletion by using Undo in the BPMN toolbar. |
|
|
| |
Modeling BPMN | open_role_editor |
Multiexcerpt |
---|
MultiExcerptName | open_role_editor |
---|
|
| If you click icon in the attribute panel, a separate editor will open where you can assign existing roles and create new ones. | | In the role editor, you have two options: |
|
| |
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 | tip_export_import_in_service_panel
|
Multiexcerpt |
---|
MultiExcerptName | tip_export_import_in_service_panel |
---|
|
|
| |
Modeling BPMN | tip_service_panel_options |
Multiexcerpt |
---|
MultiExcerptName | tip_service_panel_options |
---|
|
|
| |
Modeling BPMN Implementing Your Process | attribute_name |
Multiexcerpt |
---|
MultiExcerptName | attribute_name |
---|
| Click here to insert or change the Name of the related element. Generated elements (like e.g. message) cannot be renamed. |
| |
Modeling BPMN Implementing Your Process | create_form |
Multiexcerpt |
---|
MultiExcerptName | create_form |
---|
| Enter a name for the form in the pop-up window Create New Form. Click Save. |
| |
Modeling BPMN Modeling Forms | form_created |
Multiexcerpt |
---|
MultiExcerptName | form_created |
---|
| The new form is also displayed in the service panel and you can use icon to open it. |
| |
Modeling BPMN Modeling Forms | 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.
|
| |
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 BPMN Working With Libaries | show_library_doc |
Multiexcerpt |
---|
MultiExcerptName | show_library_doc |
---|
| Use the documentation icon to display the documentation of a library. You can find it in the Manage Libraries dialog... |
| |
Modeling BPMN Working With Libaries | show_library_doc_in_panel |
Multiexcerpt |
---|
MultiExcerptName | show_library_doc_in_panel |
---|
| ... as well as in the service panel when you hover over a library. |
| |
Modeling BPMN Working With Libraries | add_libraries_to_folder
|
Multiexcerpt |
---|
MultiExcerptName | add_libraries_to_folder |
---|
| If you want to add your own libraries to a service, hover over the Libraries folder in the service panel and click icon Manage Libraries . |
| |
Modeling BPMN Working With Libraries | library_in_service_panel
|
Multiexcerpt |
---|
MultiExcerptName | library_in_service_panel |
---|
| The added library is now displayed in the service panel and you can use it during modeling. |
| |
Modeling BPMN Working With Libraries | manage_libraries |
Multiexcerpt |
---|
MultiExcerptName | manage_libraries |
---|
| The dialog Manage Libraries opens. All libraries that have been uploaded to the current namespace are shown in this dialog: - Currently unused libraries are displayed on the left side of the window.
- The libraries that are already used in this service are shown on the right side.
Expand the drop-down lists to display the details of each library such as versions and dependencies. |
| |
Modeling BPMN Working With Libraries | remove_libraries |
Multiexcerpt |
---|
MultiExcerptName | remove_libraries |
---|
| You can also remove libraries from the service. Open the dialog Manage Libraries again and click the icon. The library will switch back to the Unused Libraries column. Do not forget to confirm the deletion with the Save button. |
| |
Modeling BPMN Working With Libraries | 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. |
| |
Running Designer Applications | access_app_uis |
Multiexcerpt |
---|
MultiExcerptName | access_app_uis |
---|
| You can access your application UIs directly from the controls panel. |
| |
Running Designer Applications | create_new_instance |
Multiexcerpt |
---|
MultiExcerptName | create_new_instance |
---|
| To create a new process instance, click icon . From the drop-down menu, choose the process start you want to trigger. |
| |
Running Designer Applications | instance_list_content |
Multiexcerpt |
---|
MultiExcerptName | instance_list_content |
---|
| The instance list shows all unfinished instances. |
| |
Running Designer Applications | instance_list_progress_view |
Multiexcerpt |
---|
MultiExcerptName | instance_list_progress_view |
---|
| A progress view is displayed... - ... if an open process instance is in a state where no forms have to be filled.
- ... if the instance is in a state that your role is not allowed to see.
You can wait until the process reaches the next form (or the process end) or switch back to the overview and proceed with another instance. |
| |
Running Designer Applications | instance_list_refresh |
Multiexcerpt |
---|
MultiExcerptName | instance_list_refresh |
---|
| Use icon Refresh to update the instance list. |
| |
Running Designer Applications | instance_list_role_label |
Multiexcerpt |
---|
MultiExcerptName | instance_list_role_label |
---|
| If the process is role-based, role labels are displayed - one for each role assigned to your user.
|
| |
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. |
| |
Searching in the Designer Modeling BPMN Working With Libraries Implementing Your Process Validating a Service | tip_panel_management |
Multiexcerpt |
---|
MultiExcerptName | tip_panel_management |
---|
|
|
| |
Searching in the Designer Working With the Explorer | explorer_search |
Multiexcerpt |
---|
MultiExcerptName | explorer_search |
---|
| On top of the explorer tree you can find a search box. Select the part of the explorer tree (namespace, folder or service) you want to search, and enter a search term. |
| |
Supported BPMN Elements | attribute_trigger_events
|
Multiexcerpt |
---|
MultiExcerptName | attribute_trigger_events |
---|
| Trigger Events: Use the attribute Trigger Events in the Attributes Panel to define which button of a form associated to the element triggers the default process flow of a BPMN process. This attribute is only available for boundary events. |
|
|
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 |
---|
| None. 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. When you use the option, Read-only is added to the bottom right of the element:
|
| |
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).
|
| |
Supported Form Elements | grouping_deletion |
Multiexcerpt |
---|
MultiExcerptName | grouping_deletion |
---|
|
Info |
---|
title | Deletion Behavior of Grouping Elements |
---|
| If you delete a grouping element, it is erased from your work area including all content! |
|
| |
Supported Form Elements Modeling Forms | 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. |
|
| |
Tips | click_to_see_gif |
Multiexcerpt |
---|
MultiExcerptName | click_to_see_gif |
---|
|
Tip |
---|
Click the image to see an animated version. |
|
| - Various pages (also in ACADEMY space)
|
Tips | click_to_see_gif_above |
Multiexcerpt |
---|
MultiExcerptName | click_to_see_gif_above |
---|
|
Tip |
---|
Click the image above to see an animated version. |
|
| - Various pages (also in ACADEMY space)
|
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 |
---|
| There are duplicate class names in your model. |
| |
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. |
| |
Working With Libraries | bridge_base |
Multiexcerpt |
---|
MultiExcerptName | bridge_base |
---|
| The Designer provides all necessary base types in a Bridge Base standard library. This library is available in all services and cannot be removed. It contains the following Bridge base types: - Any
- Blob
- Boolean
- DateTime
- Float
- Integer
- String
Most of these base types are only able to hold one single piece of information, like text in a string, true or false in a boolean, or binary data in a blob. Tip |
---|
Refer to the Bridge documentation (Base Types) for more information on the Bridge base types. |
If you want to associate several bits of information, you have to define a complex type that combines a number of independent base types and possibly other complex types. Such complex types are modeled as classes. To use your own types, you can
- define your own data structures in the Implementation folder
- provide them via a library.
|
| |
Working With Libraries | library_concepts |
Multiexcerpt |
---|
MultiExcerptName | library_concepts |
---|
| Libraries are code repositories that are useful to organize your development project into re-usable pieces that can be used in multiple services. They contain predefined classes, interfaces, operations and parameters you can use during modeling by simple drag & drop. Libraries are developed with the Builder. The Designer comes with a standard library which already provides all necessary Base Types and base type operations. |
| |
Working With the Explorer | create_project |
Multiexcerpt |
---|
MultiExcerptName | create_project |
---|
| Enter a name for the service in the pop-up window Create New Service. Click Save. |
| |
Working With the Explorer | folder_created |
Multiexcerpt |
---|
MultiExcerptName | folder_created |
---|
| The new folder is created and displayed in the tree. |
| |
Working With the Explorer | import_limitations
|
Multiexcerpt |
---|
MultiExcerptName | import_limitations |
---|
| - You cannot import newer versions to a system having an older version installed.
- There are no migrations if importing Designer content from versions prior to Designer 21.1.3 (2.0.165). This may result in the imported service not working.
In the future, importing data from a version older than 21.1.3 will be disabled.
|
| |
Working With the Explorer | open_a_service |
Multiexcerpt |
---|
MultiExcerptName | open_a_service |
---|
| To open a service, click on the service name in the explorer tree. - The Service tab will open.
- The service details will be displayed on the right side of the tree.
Tip |
---|
To access the service, click on the the explorer tab icon or on the service details area to close the explorer tab. Go to page Working with the Service Panel for further information. |
|
| |
Working With the Explorer | project_created |
Multiexcerpt |
---|
MultiExcerptName | project_created |
---|
| The new service is created and displayed in the tree. |
| |
Working With the Explorer | tip_profiles_admin_guide |
Multiexcerpt |
---|
MultiExcerptName | tip_profiles_admin_guide |
---|
|
|
| |
Working With the Explorer | version_considerations
|
Multiexcerpt |
---|
MultiExcerptName | version_considerations |
---|
| By exporting and importing, you can transfer Designer contents between PAS installations. These installations may have divergent versions. Info |
---|
As of Designer 21.1.3, import will perform migrations on the imported service if the data to be imported is not older than Designer 21.1.3 (2.0.165). If there is a version gap of more than one version, multiple migrations will be applied if necessary. |
|
| |
Working With the Explorer | whats_a_service
|
Multiexcerpt |
---|
MultiExcerptName | whats_a_service |
---|
| A Service contains one executable service. Services are created in the explorer tree. The necessary settings for your micro service such as the service properties, the BPMN model, the data model, used libraries and forms are managed within the service. You need to open a service to access its contents via the Service panel, see Working with the Service Panel for details. |
| |
Working With the Explorer Modeling BMPN | cutting_and_pasting_explorer |
Multiexcerpt |
---|
MultiExcerptName | cutting_and_pasting_explorer |
---|
|
| 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. |
|
| |
Working With the Explorer Modeling BPMN | cockpit_tip |
Multiexcerpt |
---|
MultiExcerptName | cockpit_tip |
---|
|
Tip |
---|
Further information about the Cockpit, tiles and groups can be found in the BPaaS Guide. |
|
| |
Working With the Explorer Modeling BPMN | create_folder |
Multiexcerpt |
---|
MultiExcerptName | create_folder |
---|
| Enter a name for the folder in the pop-up window Create New Folder. Click Save. |
| |
Working With the Explorer Modeling BPMN | paste_url |
Multiexcerpt |
---|
MultiExcerptName | paste_url |
---|
| You are now able to paste the URL, for example in an email. |
| |
Working With the Explorer Modeling BPMN | toast_confirmation |
Multiexcerpt |
---|
MultiExcerptName | toast_confirmation |
---|
| The action is confirmed by a toast message. |
| |
Working With the Explorer Modeling BPMN Modeling Forms | note_element_restrictions |
Multiexcerpt |
---|
MultiExcerptName | note_element_restrictions |
---|
|
Note |
---|
title | Restrictions on Element Names |
---|
| Element names... - ... must not be empty.
- ... must not contain spaces.
- ... must not start with numbers.
- ... must not end with a period (.).
- ... must be unique in one BPMN model.
- ... must not contain one of the following characters: <, >, :, ", /, \\, |, ?, *
Furthermore, ... - ... 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.
|
|
| |