adding_a_role

Used on:

When you open the role editor, it already contains an empty line.

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, see below) 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.

Refer to Administration Guide > Managing Roles for further information about role management.

create_connector

Used on:

Hover with your mouse over the Connectors tree node in the service panel. Click the icon to create a new connector.

Alternatively, you can open the context menu of the Connectors folder and click Add > Connector.

The Manage Connectors dialog is displayed.

Select a type of connector from the dropdown list.

Configure the connector in the Configuration section, e.g. OpenAPI connectors can be configured by simply importing a JSON or YAML description file.

Supported OpenAPI versions are 2.0, 3.0.0, 3.0.1, 3.0.2, and 3.0.3. The OpenApi version 3.1 is not supported at the moment.

Refer to Adapters for more information about adapters and their related connector configuration.

When you have selected an appropriate file, click Next.

The Next button is enabled only when you have selected a file.

If the selected file cannot be loaded, a corresponding error message is displayed in the dialog.

Additionally a (more detailed) toast message is displayed. The following error messages are possible:

Displayed Message	Possible Reason	Solution
The OpenAPI version 'x.y.z' is not supported. Versions 2.0.0, 3.0.0, 3.0.1, 3.0.2, and 3.0.3 are supported.	You have selected a file in a version that is not supported.	Select a file in a version that is supported.
The property 'swagger' or 'openapi' is missing.	The mentioned properties are missing from the file or are misspelled.	Check if the basic structure of the file is correct. For more detailed information about the basic structure of an OpenAPI file refer to OpenAPI Basic Structure.
The file cannot be loaded.	The selected file is corrupt.	Select a valid file.
The file cannot be loaded.	The selected file has the wrong file type.	Select a file of a supported file type, e.g. a YAML description file.

After the selected file has been successfully imported, you can start the actual configuration of the connector.

When everything is configured to your needs, click Next to save the connector.

The connector, his types and interfaces, have been added to your service with the given configuration.

creating_a_role

Used on:

Click 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 (see Adding an Existing Role below).

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, see below) 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.

Refer to Administration Guide > Managing Roles for further information about role management.

creating_a_service

Used on:

	Add a service to manage the necessary settings for your microservice. A service can only be created in folders. To add a service to a folder, right click on the folder and select option Add > Service from the context menu.
	Enter a name for the service in the pop-up window Create New Service. Click Save. If you want to deploy the service to a container later, please note that on container deployment the service name is automatically changed according to certain rules. Naming of Services for Container Deployment Example: Service Name: Janes_First_Service Container Name: janes-first-service The two services in this example would get the same container name... ... so they would overwrite each other.
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.
	The new service is created and displayed in the tree.
	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. To access the service, click on the the explorer tab icon or on the service details area to close the explorer tab. Refer to Service Panel for further information.

cutting_and_pasting_explorer

Used on:

	If you want to use an element at a different position in the tree, select the context menu option Cut.
	Open the context menu of the element in which you want to insert the cut element and select Paste. Option Paste 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.

designer_development_process

Used on:

With PAS 23.1, the development process in the Designer has been optimized. To speed up and simplify the development process, we have decoupled development from deployment: Developers now work in a test environment where they can get constant feedback on their changes and can test them directly against the service preview.

The new approach also improves the work of fusion teams on a microservice: Developers can now make a finished feature or an intermediate state of a service available to other team members for testing while continuing to work independently on the same service.

Your benefits:

You can access a preview of your service without having to deploy it, which speeds up testing and process optimization.
Your test service is constantly compiled and validated. Errors and warnings are displayed in the validation panel and help you create a flawless service.
You only need to deploy your service...
- if you want to give other team members the opportunity to test dedicated features or versions of the service.
- if you want to run regeression tests against your test server.
In the meantime, you continue to develop the service independently of the deployed version.

designer_deployed_service

Deployed Service

	The tester opens the deployed service.
	The tester starts the process to create a new instance.
	The deployed version of the form opens.

designer_test_service

Test Service

	The developer opens the test service.
	The developer starts the process to create a new instance.
	The adapted form opens.

designer_test_environment_status

Used on:

When you create a new service or open an existing one, you are automatically working in the test environment. Its status is displayed in the Controls panel.

The test environment is automatically started and stopped:

It is started...
- when you open a service and start working on it.
- when you select option Open application .
- when you trigger a manual validation via option Start validation .
It is stopped...
- when you have not worked on your service for a certain amount of time. Default setting is 2 hours.
- when the corresponding project is deleted.

Status Message	Description
	The test environment has not yet been started or has expired.
	The Designer is preparing the test environment.
	The test environment is ready. You can access the application preview.

designer_test_service_preview

Used on:

Accessing the test service is possible without deployment. Open the service preview via the controls panel and the service start page will open in a new tab:

	You have direct access to your service(s): Start your process and create a new instance. Open the instance overview .
	The preview is fully operational. Use it to check functionality, layout and design of your process and its forms.

deployment

Used on:

Select your deployment target the first time you deploy.

Prerequisites

Container deployment: Your user must be assigned the xuml_container_admin profile.
Integration (Bridge) deployment: You user must be assigned the integration_user profile and he must have an integration user account created by an integration administrator.

Refer to Administration Guide > Overview of Standard Profiles.

Enable edit mode of the deployment properties and choose between Integration Component or Container.

We recommend to enter a version number and increase the number with each deployment.

Expert Advice

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.

Save the deployment properties to continue.

Now use the deployment controls to deploy the service to your chosen target:

Icon	Description
	Use this option to deploy the service to the selected deployment target.
	Use this option to open the management UI of the selected deployment target: PAS Administration for Container Integration for Integration Component
	Use this option to open the test UI for the service-related API.
	Use this option to open the deployed service in a new browser tab.

differences_opening_applications

Used on:

Test and deployed service are both fully functional. The handling of an application is the same for both service types. The only difference is the way how to access the applications start page:

Test Service	Deployed Service
Open the application via the Controls Panel :	Open the application via the Deployment Controls on the service details page: Of course, to open the deployed service, you must first deploy it. Refer to Deploying a Service for more information.

executing_deployed_service

Used on:

The deployed service is accessible via option Open Application in the deployment controls section. The start page of the deployed service looks exactly the same as that of the test service:

The handling of the deployed service is also the same:

Users can create new instances and execute the process.
Users can access the instance overview.

The difference is: The deployed version does not change, even if the developer changes the service in the test environment.

executing_deployed_service_example

Used on:

	A developer created a simple test application, containing only a user task with an assigned test form.
	The test form contains two input fields and a button.
	The developer deploys this version.
	After the deployment of this version, he starts to extend the test form.

field_config_editor

Used on:

If you click icon the Field Configuration editor opens:

Use the editor to add and manage the content of your element:

Option	Description
	Click Add to insert new rows.
	Use option Drag to change the order of the rows.
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. 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.
	Use this option to set the element option as default.
	Use this option to delete the element option.
	Click Save to save your changes.
	Click Cancel to discard your changes.

how_to_use_the_timer

Used on:

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

You have two options with different settings:

Scheduler (see below)
Timer (see below)

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 below). Refer to 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 below). Refer to 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

Duration Expression Wizard

The settings Repeat Interval and First Occurrence contain the option .

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

Insert positive integers in the desired fields.

The result is shown below.

Click Save to close the wizard.

The duration expression is displayed in the corresponding field.

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

lane_handling

Used on:

	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. Click the image to see an animated version.
	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:	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.

open_role_editor

Used on:

	When you click option in the attributes panel, a separate editor will open where you can assign existing roles and create new ones.
	In the role editor, you have two options: You can add an already existing role. You can create a new role. If no roles are assigned to a lane, the process steps inside the lane can be executed by all users and a corresponding note is displayed.

permission_administration

Used on:

	In the pop-up window Permission Administration you can invite single colleagues or whole groups to access the element. By default, the creator of the element and everyone sharing the current namespace has write permissions. To limit access to the element you can remove the group Everyone completely, or give it read-only permission. If you want to restore permissions for Everyone, select option Invite Group, search for group Everyone and add it again.
	If you want to add other users, first select one of the options: Invite Group: Allow whole user groups to access your element. Available groups are all distribution lists that have been created as a Role in the user management. Invite People: Add single users to your element and grant them read or write permission. Refer to Administration Guide > Managing Roles for detailed information about roles.
	Enter the name or email address of the group or person to the search field. Matching results are shown in a list. Select the entry you want to use.
	Click option to add the selected user or group.
	Once the user or group has been added, you can specify whether the user or the group should have read or write permission. Save your changes.

pin_highlighting

Used on:

While dragging the object flow, the color of the pins changes to assist you with finding matching connection points.

	When you start dragging an object flow, all pins of the same type and multiplicity are marked blue. Blue pins indicate that this pin is a valid target for the object flow.
	White connection points of variables indicate that you are trying to connect variables that do not have the same type or multiplicity. The connection point is marked in white when you have reached it with the mouse pointer.
	It is possible to draw an object flow to an invalid connection point but the relation will be invalid and displayed in red.
	A pin turns red if an object flow cannot be created at all. You cannot connect a local variable with another local variable connect a persisted variable with another persisted variable draw a connection to a pin that already has an incoming object flow.

validating_error_types

Used on:

Different types of validation messages are displayed. Both, warnings and errors, are reported by the xUML Compiler, and refer to the implemented execution:

Icon	Error Type	Description
	Warning	If the compiler reports a warning, you can deploy the service nevertheless. However, you should check the reported items in your service.
	Error	If an error is reported, deployment is not possible. Check the mentioned parts of the service, and eliminate the cause of the error to enable model execution.

validating_main

Used on:

The validation results are displayed in the Validation panel. It is available in all editors:

BPMN Editor
Execution Editor
Mapping Editor
Form Editor

If you use the panel preset, the validation panel is the second tab in the lower left corner. To return to the panel preset, go to the user preferences, open the Designer Options and select option Reset Panels.

Refer to Customizing Editors and Panels for detailed information about panel management in general.

In the Validation panel, validation findings of a service are displayed. The icon in the panel header indicates if there are any validation issues:

	Everything is fine. The service is ready to be executed in the test environment or to be deployed via the service details page.
	The validation is in progress. Wait to get the result.
	There are validation issues. You need to resolve these issues before being able to test or deploy the service.

The list is sorted by error types:

Error: xUML Compiler errors
Warning: xUML Compiler warnings

You cannot test or deploy a service that still has validation errors. You need to resolve them first.

validating_using_diplayed_info

Used on:

	Validation messages describe the error, and also provide information on how to solve the problem.
	The items in the validation panel are links. If you click on a message... ...the related editor opens if not already open. ...the affected element is selected on the diagram pane. ...all other messages concerning this element are highlighted. If the message refers to an element on the execution pane, the associated BPMN element on the BPMN diagram pane is also selected.
	This also works vice versa: Click an element on the pane to highlight all messages concerning this element.
	The handling in the Mapping Editor works the same way: Click a message to highlight the affected element or object flow in the editor.

validating_sharing_validation_messages

Used on:

Sometimes you want to share a validation message with another developer.

Select the displayed message (or the part you want to share) with your mouse or a double-click. Now you can copy and paste the highlighted content, e.g. to an email or a chat.

On this Page:

Page tree

_designer_excerpts_big

adding_a_role

create_connector

creating_a_role

creating_a_service

cutting_and_pasting_explorer

designer_development_process

designer_deployed_service

designer_test_service

designer_test_environment_status

designer_test_service_preview

deployment

differences_opening_applications

executing_deployed_service

executing_deployed_service_example

field_config_editor

how_to_use_the_timer

lane_handling

open_role_editor

permission_administration

pin_highlighting

validating_error_types

validating_main

validating_using_diplayed_info

validating_sharing_validation_messages