| |
Designer User Guide | toggle_grid |
Multiexcerpt |
---|
MultiExcerptName | toggle_grid |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| Use this option 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. |
| |
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. Refer to xUML Service State Machines for further information. |
|
| |
Filesystem Adapter | hint_backslash_in_path |
Multiexcerpt |
---|
MultiExcerptName | hint_backslash_in_path |
---|
| When using the Windows style with backward slashes "\" you have to be aware that you need to escape this character. The escape character is also the "\". To avoid this, use forward slashes with Windows as well. |
| pp. |
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.
- You can overwrite these defaults dynamically in the Get Data execution of a user task. How to do this is explained on Using Forms.
|
| |
General | designer_working_steps_documentation
|
Multiexcerpt |
---|
MultiExcerptName | designer_working_steps_documentation |
---|
|
Info |
---|
title | Guidance for Designer Documentation |
---|
| Creating and running services in Designer consists of several steps, all of which are explained in detail in the documentation: Working Step in the Designer | Related Documentation |
---|
Service Development | | Service Validation and Testing | | Service Deployment | | Service / Application Execution | |
|
|
| |
General | tip_increasing_version_number
|
Multiexcerpt |
---|
MultiExcerptName | tip_increasing_version_number |
---|
|
Tip |
---|
| By default, each newly created service gets number 0.1.0 assigned. We recommend to increase the version number before redeploying each time you have made relevant changes to the service. You can change the version number in section General of the Deployment Properties. Follow the concept of semantic versioning. In case of deployment problems, comparing the version number and the number of the deployed version can help to find out which version of the service is running. |
|
| |
Implementing Your Process | confirm_deletion_parameter
|
Multiexcerpt |
---|
MultiExcerptName | confirm_deletion_parameter |
---|
| Confirm the security prompt in the pop-up window with Yes to delete the selected parameter from the operation. |
| |
Implementing Your Process | default_value_attribute |
Multiexcerpt |
---|
MultiExcerptName | default_value_attribute |
---|
| Specify a default value for the related variable here. |
| |
Implementing Your Process | deleting_parameters_service_panel
|
Multiexcerpt |
---|
MultiExcerptName | deleting_parameters_service_panel |
---|
| You can delete a parameter in the implementation folder of the service panel using the Delete option of the context menu or the Del key. |
| |
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.
Refer to Modeling Data Mapping for further information. - You can import a library that provides additional types and operations.
Refer to 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 | info_add_parameters
|
Multiexcerpt |
---|
MultiExcerptName | info_add_parameters |
---|
|
Info |
---|
You can add parameters only to custom operations, not to operations of Connectors and Libraries. |
|
| |
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 APIs | add_action_script
|
Multiexcerpt |
---|
MultiExcerptName | add_action_script |
---|
| Add an action script operation to the class. |
| |
Implementing Your Process Modeling APIs | add_activity_operation
|
Multiexcerpt |
---|
MultiExcerptName | add_activity_operation |
---|
| Add an activity operation to the class. |
| |
Implementing Your Process Modeling APIs | add_interface
|
Multiexcerpt |
---|
MultiExcerptName | add_interface |
---|
| Add an interface to the class. |
| |
Implementing Your Process Modeling APIs | add_mapping_operation
|
Multiexcerpt |
---|
MultiExcerptName | add_mapping_operation |
---|
| Add a mapping operation to the class. |
| |
Implementing Your Process Modeling APIs | add_operation
|
Multiexcerpt |
---|
MultiExcerptName | add_operation |
---|
| Add an operation to the class. The implementation is to be defined later. |
| |
Implementing Your Process Modeling APIs | add_operation_cm
|
Multiexcerpt |
---|
MultiExcerptName | add_operation_cm |
---|
| Add an operation to the class. |
| |
Implementing Your Process Modeling APIs | add_sub_class
|
Multiexcerpt |
---|
MultiExcerptName | add_sub_class |
---|
| Add a sub-class to the class. |
| |
Implementing Your Process Modeling APIs | copy_class
|
Multiexcerpt |
---|
MultiExcerptName | copy_class |
---|
| Copy the class to paste it elsewhere to the API or Implementation folder. |
| |
Implementing Your Process Modeling APIs | cut_class
|
Multiexcerpt |
---|
MultiExcerptName | cut_class |
---|
| Cut the class to paste it elsewhere to the API or Implementation folder. |
| |
Implementing Your Process Modeling APIs | delete_class
|
Multiexcerpt |
---|
MultiExcerptName | delete_class |
---|
| Delete the class. |
| |
Implementing Your Process Modeling APIs | interface_context_menu
|
Multiexcerpt |
---|
MultiExcerptName | interface_context_menu |
---|
|
Menu Item | Description |
---|
Add Class | Add a class or sub-class to the interface. Classes within interfaces can be nested. | Add Interface | Add another interface to the interface. Interfaces can be nested. | Add Operation | Add an operation to the interface. Operations of interfaces do not have an implementation but only define the signature (parameters and types). | Cut | Cut the interface to paste it elsewhere to the API or Implementation folder. | Copy | Copy the interface to paste it elsewhere to the API or Implementation folder. | Paste | Paste the interface elsewhere to the API or Implementation folder. Available if Copy or Cut option have been used before. | Rename | Change the name of the interface. | Delete | Delete the interface. |
|
| |
Implementing Your Process Modeling APIs | interface_quick_action
|
Multiexcerpt |
---|
MultiExcerptName | interface_quick_action |
---|
|
Quick Action | Description |
---|
Image Added | Add an operation to the interface. Operations of interfaces have no implementation, they only describe the signature of the operation. |
|
| |
Implementing Your Process Modeling APIs | 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, action script or activity. |
| |
Implementing Your Process Modeling APIs | operation_context_menu
|
Multiexcerpt |
---|
MultiExcerptName | operation_context_menu |
---|
|
Menu Item | Description |
---|
Add Parameter in | Add an input parameter to the operation. | Add Parameter out | Add an output parameter to the operation. | Add Parameter return | Add a return parameter to the operation. | Add Operation (Suboperation)
| Add a suboperation to the operation. | Open (Implementation) | Open the implementation of the selected operation in a separate tab. Available if the operation has an implementation, yet. | Change (Implementation) | Change the type of implementation or remove the implementation. Available if the operation has an implementation, yet. | Anchor |
---|
| create_implementation |
---|
| create_implementation |
---|
| Create (Implementation) | You can choose between three different types of implementation for your class operations: Available if the operation has no implementation, yet. | Cut | Cut the operation to paste it elsewhere to the API or Implementation folder. | Copy | Copy the operation to paste it elsewhere to the API or Implementation folder. | Paste | Paste the operation elsewhere to the API or Implementation folder. Available if Copy or Cut option have been used before. | Rename
| Change the name of the operation. | Delete
| |
|
| |
Implementing Your Process Modeling APIs | operation_quick_actions
Check if anchor link can be kept - if so, add info box from _designer_excerpts_big here as well |
Multiexcerpt |
---|
MultiExcerptName | operation_quick_actions |
---|
|
Quick Action | Description |
---|
Image Added | Add an input parameter to the operation. | Image Added | Add an output parameter to the operation. | Image Added | Add a return parameter to the operation. | Image Added | Open the implementation of the operation in a separate tab. Info |
---|
If you have not yet selected an implementation, a dialog opens first, which allows you to select the desired implementation. Refer to Create Implementation for more information. |
|
|
| |
Implementing Your Process Modeling APIs | parameter_context_menu
|
Multiexcerpt |
---|
MultiExcerptName | parameter_context_menu |
---|
|
Menu Item | Description |
---|
Move up | Change the order of parameters. | Move down | Cut | Cut the parameter to paste it elsewhere to the API or Implementation folder. | Copy | Copy the parameter to paste it elsewhere to the API or Implementation folder. | Paste
| Paste the parameter elsewhere to the API or Implementation folder. Available if Copy or Cut option have been used before. | Rename
| Change the name of the parameter. | Delete
| Delete the parameter. |
|
| |
Implementing Your Process Modeling APIs | paste_class
|
Multiexcerpt |
---|
MultiExcerptName | paste_class |
---|
| Paste the class elsewhere to the API or Implementation folder. Available if Copy or Cut option have been used before. |
| |
Implementing Your Process Modeling APIs | rename_class
|
Multiexcerpt |
---|
MultiExcerptName | rename_class |
---|
| Change the name of the class. |
| |
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 | 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 BPMN Modeling Forms | undo_last_action
|
Multiexcerpt |
---|
MultiExcerptName | undo_last_action |
---|
| Undo the previous action you performed in... - ... one of the Designer editors (except mapping editor).
- ... the Implementation folder of the service panel.
|
| |
Implementing Your Process Modeling BPMN Modeling Forms | redo_last_action
|
Multiexcerpt |
---|
MultiExcerptName | redo_last_action |
---|
| Redo your previous action (after undo). |
| |
Implementing Your Process Modeling Data Structures | hint_naming_conventions Jira |
---|
server | Scheer PAS Support |
---|
columnIds | issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution |
---|
columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution |
---|
serverId | 43cf5183-ee34-3307-86f2-7c936fe077f7 |
---|
key | PASDOC-1658 |
---|
|
| | |
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). |
| |
Implementing Your Process Modeling Activities | literal_supported_types
|
Multiexcerpt |
---|
MultiExcerptName | literal_supported_types |
---|
|
Info |
---|
Literals can only be connected with output parameters, return parameters and operation input pins of base type Boolean, DateTime, Float, Integer and String. |
|
| |
Managing the Service Details | enable_angular_build |
Multiexcerpt |
---|
MultiExcerptName | enable_angular_build |
---|
| Activate this option to enable the possibility to export your service as an Angular project for further pro-code development. You can find the export option in the additional menu of the controls panel. If the option is enabled, an Angular project will be created for all forms and for the instance table. Deactivate to disable the export. If the Angular build is disabled, it also will not build the Angular project on deployment. By default, this option is activated. Tip |
---|
| If your process does not contain user tasks with assigned forms and if you do not need the instance table, we recommend to disable this option. The deployment will be much faster and the repository file much smaller. |
|
| |
Managing the Service Details | enable_validation |
Multiexcerpt |
---|
MultiExcerptName | enable_validation |
---|
| Activate this option to enable automatic compilation with each change in the respective model. Deactivate to disable the automatic compilation. If you chose this option, you can trigger the compilation manually via Start validation Image Added in the controls panel. The corresponding service is also compiled during a deployment, an export of the repository or similar actions, even if automatic compilation is disabled. By default, this option is activated. |
| |
Managing the Service Details | info_unique_alias_name
|
Multiexcerpt |
---|
MultiExcerptName | info_unique_alias_name |
---|
|
Info |
---|
Alias names must be unique within the service. |
|
| |
Managing the Service Details | info_semantic_versioning
|
Multiexcerpt |
---|
MultiExcerptName | info_semantic_versioning |
---|
|
Info |
---|
The version of the service must follow Semantic Versioning 2.0.0: Major.Minor.Patch. A pre-release tag is optional. A version numbering that deviates from this will lead to errors during deployment. |
|
| |
Managing the Service Details | info_service_not_deployed
|
Multiexcerpt |
---|
MultiExcerptName | info_service_not_deployed |
---|
|
Info |
---|
If this button is greyed out, the service has not been deployed yet. |
|
| |
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 Activities | info_get_attribute_limitations
|
Multiexcerpt |
---|
MultiExcerptName | info_get_attribute_limitations |
---|
|
Info |
---|
title | Limitations of Attribute Get |
---|
| Using the Get attribute it is only possible to access properties of complex types. The following is not supported: - Multiple transformation flows to the same input pin.
- Adding Action Script statements to the Get attribute.
- Accessing single array elements, e.g. with myArray[0].
|
|
| |
Modeling Activities Drawing an Activity Diagram | description_guard
|
Multiexcerpt |
---|
MultiExcerptName | description_guard |
---|
| Control flows that are starting from a decision node need to have a guard expression. A guard expression is an expression that evaluates totrue or false, and specifies which control flow branch to follow from the decision node on. One of the guard expressions must be else to define the branch to follow when none of the guard expressions are true. |
| |
Modeling Activities Drawing an Activity Diagram | description_order
|
Multiexcerpt |
---|
MultiExcerptName | description_order |
---|
| If a decision node branches the control flow into multiple branches, order defines the order in which the guard expressions (see Guard above) should be evaluated. This is necessary in case multiple guard expressions evaluate to true. The else expression does not need to have an order. |
| |
Modeling APIs | api |
Multiexcerpt |
---|
MultiExcerptName | api |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| An API is the entrance port of your service. It can be used to communicate with the service from the outside. There are different kinds of APIs (e.g. REST API, SOAP API, ...) that describe different communication standards. |
| |
Technical Concepts Constants and Names | |
Multiexcerpt |
---|
MultiExcerptName | http_headers_adapter |
---|
| With xUML service adapter calls, the xUML Runtime adds the following outgoing HTTP headers containing correlation information to the request: - X-Transaction-Id or xTransactionId (in JMS context)
This header identifies the transaction the call belongs to. You can set the transaction id manually with setTransactionID. If not set, the Runtime will generate one. This header will be passed through the callstack to identify all service calls that belong to a transaction. - X-Request-Id
This header identifies the unique request. The Runtime generates a unique number for each adapter call. - X-Sender-Host and X-Sender-Service
These headers contain the sender host resp. the sender service. They are set by the Runtime automatically.
Transaction id and request id will be logged to the transaction log on the adapter call. Having this information, you can use this for error analysis or usage metrics. |
| Technical Concepts Constants and Names |
Modeling APIs Technical Concepts | |
Multiexcerpt |
---|
MultiExcerptName | http_headers |
---|
| xUML services read the following incoming HTTP headers containing correlation information: - X-Transaction-Id or xTransactionId (in JMS context)
This header identifies the transaction the call belongs to. You can set the transaction id manually with setTransactionID. This header will be passed through the callstack to identify all service calls that belong to a transaction. - X-Request-Id
This header should identify the unique request. - X-Sender-Host and X-Sender-Service
These headers should contain the sender host resp. the sender service.
These headers will be all logged to the transaction log. Having this information, you can use this for error analysis or usage metrics. |
| Modeling APIs Technical Concepts |
Modeling APIs | httpHeaderMap |
Multiexcerpt |
---|
MultiExcerptName | httpHeaderMap |
---|
| Header information as a map. The map contains arrays of header value strings whereas the header name is the key of the map. - Header names are lowercase and treated case insensitive.
- Multiple headers with the same name are treated as arrays.
Refer to HTTP Header Support for more information on the standard xUML HTTP headers. |
| |
Modeling APIs | maxrequestbodysize
|
Multiexcerpt |
---|
MultiExcerptName | maxrequestbodysize |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| Specifies the maximum size of the request in KB (1 KB = 1024 Bytes). This can be used to prevent DoS or similar attacks. When the payload of the service exceeds the given maximum, incoming request are rejected. |
| |
Modeling APIs | maxrequestheadersize
|
Multiexcerpt |
---|
MultiExcerptName | maxrequestheadersize |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| Specifies the maximum size of the request header in KB (1 KB = 1024 Bytes). This can be used to prevent DoS or similar attacks. When the header payload of the service exceeds the given maximum, incoming request are rejected. |
| |
Modeling APIs | port
|
Multiexcerpt |
---|
MultiExcerptName | port |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| Ports are elements of the UML modeling standard. A port defines an entrance point to the service and connects the API to an interface or class. |
| |
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 bpmn 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 Image Added Add Model. |
| |
Modeling BPMN | add_library |
Multiexcerpt |
---|
MultiExcerptName | add_library |
---|
| To add an unused library to the project, click Add library Image Added. |
| |
Modeling BPMN | bpmn_created |
Multiexcerpt |
---|
MultiExcerptName | bpmn_created |
---|
| The new BPMN model is also displayed in the service panel and you can use option Open model Image Added 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 | no_role_assigned_to_lane
|
Multiexcerpt |
---|
MultiExcerptName | no_role_assigned_to_lane |
---|
|
Info |
---|
If no roles are assigned to a lane, the process steps inside the lane can be executed by all users. |
|
| |
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: Image Added |
| |
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 |
---|
|
Tip |
---|
For detailed explanations of the item options in the Service panel, such as cut, copy, rename, and delete, refer to Service Panel. |
|
| |
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 |
|