Chapter | Name | Excerpt | Usage |
---|
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 | |
|
|
|
|
Apache Kafka | kafka_message |
Multiexcerpt |
---|
MultiExcerptName | kafka_message |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| The Apache Kafka documentation speaks of events that contain a message, or of records in more technical parts of the documentation. This documentation summarizes all under the term "message". |
| |
Configuring the Instance List | instance_list_basics
|
Multiexcerpt |
---|
MultiExcerptName | instance_list_basics |
---|
| Each deployed application offers two basic functionalities during execution: The user can start a process (and start a so-called instance of the process) - and 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 dedicated instance list is generated. |
| |
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_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 to hide this column 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. |
| |
Constants and Names | service_types_parameters
|
Multiexcerpt |
---|
MultiExcerptName | service_types_parameters |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
|
Protocol | Parameter | Description |
---|
TCPIP
| RemoteIPAddress | IP address of host that initiated the request. If a proxy is used, this is the IP of the proxy server. | RemotePort | Port number, from which the request was initiated. | RemoteHostName | Name of the host that initiated the request. If not resolvable, the IP address is returned. | LocalIPAddress | IP address of the machine this service runs on. | LocalPort | Port number of this service. | LocalHostName | Name of the host this service runs on. If not resolvable, the IP address is returned. | HTTP
| Method | HTTP method used to invoke this service. Usually, it returns POST. | URI | URI called to invoke this service. | Body | Complete content of the HTTP request invoking this service. | <header> | Any other name will return the value of the HTTP header of the same name, if it exists. | SOAP | Header | Complete source of the SOAP header sent to invoke this service. | Body | Complete source of the SOAP body sent to invoke this service. | fault | Content of the SOAP fault if a request comes with a fault element. | System
| Host | Local host name. This call returns a value for all service types. | IP | IP address of the local host. This call returns a value for all service types. | User | The operating system user who is executing the current service. This user has nothing to do with the external user who might invoke a service. Thus, this call returns a value for all service types. | SystemEnvironment | <environment variable name> | Value of the operating system environment variable. This call returns a value for all service types. Note: the accessible environment variables can be inspected in the start log of the current service (see Server User Guide for more details). | Object
| class | The name of the persistent state class. | ID | The unique technical ID of the of the object as stored to the persistent state database. |
|
| |
Constants and Names | service_types_protocols |
Multiexcerpt |
---|
MultiExcerptName | service_types_protocols |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
|
Service Type / Context | Protocols |
---|
All | | HTTP | | SOAP | | REST | | Persistent State | |
|
| |
Constants and Names | transaction_id |
Multiexcerpt |
---|
MultiExcerptName | transaction_id |
---|
| The Transaction ID identifies a transaction. It is a unique number used to trace service calls through the call stack of multiple service calls. - Clients calling an xUML service can provide a transaction ID in HTTP header X-Transaction-ID or xTransactionId (in JMS context).
- SOAP clients can also use the SOAP headers to provide a transaction ID.
- If an xUML service is called without providing a transaction ID, the Runtime will generate such an ID.
This ID will be passed on through the call stack of the xUML service, so that the whole transaction can be traced. This can be useful, when analyzing the log file in case of error. |
| |
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 Panel Overview | note_service_panel_name_restrictions
|
Multiexcerpt |
---|
MultiExcerptName | note_service_panel_name_restrictions |
---|
|
Info |
---|
title | Restrictions on Element Names |
---|
| A BPMN model name must be unique within one service. In addition, the following name restrictions apply to all service panel elements: Element names... - ... must not be empty.
- ... must not contain spaces.
- ... must not start with numbers.
- ... must not end with a period (.).
- ... 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.
|
|
| |
Designer User Guide | add_horizontal_space |
Multiexcerpt |
---|
MultiExcerptName | add_horizontal_space |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| 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 |
| |
Designer User Guide | add_vertical_space |
Multiexcerpt |
---|
MultiExcerptName | add_vertical_space |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| 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. |
| |
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
|
| |
Designer User Guide | show_invalid |
Multiexcerpt |
---|
MultiExcerptName | show_invalid |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| Activate the icon to highlight all invalid elements. |
| |
Designer User Guide | tip_info_about_roles_in_admin_guide
|
Multiexcerpt |
---|
MultiExcerptName | tip_info_about_roles_in_admin_guide |
---|
|
|
| |
Designer User Guide | toggle_grid |
Multiexcerpt |
---|
MultiExcerptName | toggle_grid |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
| 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. |
| |
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. |
|
| |
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 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 | 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 |
---|
| 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_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. | 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
|
Multiexcerpt |
---|
MultiExcerptName | operation_quick_actions |
---|
|
Quick Action | Description |
---|
| Add an input parameter to the operation. | | Add an output parameter to the operation. | | Add a return parameter to the operation. | | 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. See 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 | 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 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 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. |
| |
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 | http_headers |
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 | http_headers_adapter where is it used? Cannot find it in the Designer Guide or other doc pages |
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. |
|
|
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 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 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 Add Model. |
| |
Modeling BPMN | add_library |
Multiexcerpt |
---|
MultiExcerptName | add_library |
---|
| To add an unused library to the project, click on the icon. |
| |
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 | 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:
|
| |
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, see page 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 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 | 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 | used_libraries |
Multiexcerpt |
---|
MultiExcerptName | used_libraries |
---|
| The library is now displayed in the column Used Libraries. If you have finished, click Save to persist your changes. |
| |
Running Designer Applications | access_app_uis |
Multiexcerpt |
---|
MultiExcerptName | access_app_uis |
---|
| You can access your application UIs directly from the Deployment Controls. |
| |
Running Designer Applications | create_new_instance |
Multiexcerpt |
---|
MultiExcerptName | create_new_instance |
---|
| Choose the process start you want to trigger from the drop-down menu. |
| |
Running Designer Applications | instance_list_content |
Multiexcerpt |
---|
MultiExcerptName | instance_list_content |
---|
| The instance list shows all open 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_concept
|
Multiexcerpt |
---|
MultiExcerptName | instance_list_role_concept |
---|
| If the view of the instance list is associated with a role-based authorization concept, only users with appropriate permissions can access it. |
| |
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. Click a label to view only the instances allowed for that role. For detailed information about role usage in apps, see chapter Role-based Authorization Concept.
|
| |
Running Designer Applications | search_expressions
|
Multiexcerpt |
---|
MultiExcerptName | search_expressions |
---|
|
Info |
---|
| - The percent sign (%) represents zero, one, or multiple characters.
- The underscore sign (_) represents one, single character.
To search for a substring, use the percent sign % as a wildcard for any character and underscore _ for a single arbitrary character. |
|
| |
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 by clicking the corresponding icon. |
| |
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. |
| |
Service Panel | add_libraries_to_folder_cm |
Multiexcerpt |
---|
MultiExcerptName | add_libraries_to_folder_cm |
---|
| Alternatively, you can also add libraries via the context menu. |
| |
Service Panel Modeling BPMN | add_model_via_context_menu
|
Multiexcerpt |
---|
MultiExcerptName | add_model_via_context_menu |
---|
| Alternatively, you can open the context menu of a Process folder and select the option Add Model. |
| |
Service Panel Modeling Forms
| add_form_via_context_menu
|
Multiexcerpt |
---|
MultiExcerptName | add_form_via_context_menu |
---|
| Alternatively, you can open the context menu of a Forms folder and select the option Add Form. |
| |
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 | 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. Content added to attribute Text is shown in the element. If the user does not change the content of the field during form execution, the content of Text will be saved to the database. |
| |
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 | note_on_instance_table
|
Multiexcerpt |
---|
MultiExcerptName | note_on_instance_table |
---|
|
Info |
---|
The Instance List is a special form of the data table which is created for every BPMN model. Go to page Configuring the Instance List for detailed information. |
|
| |
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 to the database. When a user overwrites the placeholder, it disappears and the user's input is saved to attribute Text. Info |
---|
If content is added to both attributes Text and Placeholder, the content of Text is displayed in the element. |
|
| |
Technical Concepts | http_headers |
Multiexcerpt |
---|
MultiExcerptName | http_headers |
---|
| Designer 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(). 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 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. |
| |
Technical Concepts | http_headers_adapter |
Multiexcerpt |
---|
MultiExcerptName | http_headers_adapter |
---|
| With 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. |
| |
Testing and Integration | tip_api_organizations
|
Multiexcerpt |
---|
MultiExcerptName | tip_api_organizations |
---|
|
Tip |
---|
For detailed information about the usage of organizations in API Management, refer to Organizations in the API Management guide. |
|
| |
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)
|
Validating and Testing a Service | validating_intro
|
Multiexcerpt |
---|
MultiExcerptName | validating_intro |
---|
| The Designer supports you during modeling by validating the service and , displaying messages for invalid implementations, and giving you advice on how to fix these errors. |
| |
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 Libraries | note_library_deletion
|
Multiexcerpt |
---|
MultiExcerptName | note_library_deletion |
---|
|
Note |
---|
Be careful when using this option: If you delete a library in the administration, it is no longer available for all services in the namespace. The implementation of the service(s) in the affected namespace may become invalid. |
|
| |
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 | note_explorer_name_restrictions |
Multiexcerpt |
---|
MultiExcerptName | note_explorer_name_restrictions |
---|
|
Info |
---|
title | Restrictions on Element Names |
---|
| The only restriction for folder names is that they must not be empty. To all other elements in the Explorer, the following name restrictions apply: Element names... - ... must not be empty.
- ... must not contain spaces.
- ... must not start with numbers.
- ... must not end with a period (.).
- ... 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.
|
|
| |
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 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 micro service. Services are created in the Explorer tree. The necessary settings for your 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 Service Panel for details. |
| |
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 to an email. |
| |
Working With the Explorer Modeling BPMN | toast_confirmation |
Multiexcerpt |
---|
MultiExcerptName | toast_confirmation |
---|
| The action is confirmed by a toast message. |
| |