adding_a_role

Info
title Used on:
Lane Modeling Roles

Multiexcerpt
MultiExcerptName adding_a_role
If When you open the role editor, it already contains an empty line already. Start typing the name of the role your are seaching for in field Role. The field has an autocomplete function: As soon as you start inserting, a drop-down list is displayed containing all available roles that match your input. Select the role you want to use. In the next step you need to assign the rights that will be granted to the role owner. Available options are: Right Description Write A user assigned to this role will be able to see and change the instance data for all process steps in the current lane. Read A user assigned to this role will be able to display the instance data for all process steps in the current lane. This right is assigned by default. List A user assigned to this role will only be able to see the instances in the instance table for all process steps in the current lane. You can continue to add further roles (or create new ones, 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. Tip Go Refer to the Administration Guide > Managing Roles for further information about role management.

create_connector

Info
title Used on:
Connectors Single Connector Using Connectors

Multiexcerpt
MultiExcerptName create_connector shouldDisplayInlineCommentsInIncludes false
Hover with your mouse over the Connectors tree node inthe service panel. Click the icon to create a new connector. Alternatively, you can open the context menu of the Connectors folder and click Add > OpenApiConnector. Image Modified The Manage Connectors dialog is displayed. Select a type of connector from the dropdown list. Image Modified Configure the connector in the Configuration section, e.g. OpenAPI connectors can be configured by simply importing a JSON or YAML description file. Info 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. Find Refer to Adapters for more information about adapters and their related connector configuration on Adapters pp. When you have selected an appropriate file, click Next. Info The Next button is enabled only when you have selected a file. Image Modified 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 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

Info
title Used on:
Lane Modeling Roles

Multiexcerpt
MultiExcerptName creating_a_role
Click button New Role to create a new role and assign it to the lane element. Enter the name of the new role in the pop-up window. The input is mandatory. If the role name is already in use, you will not be able to save. Use the existing role instead (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. Tip Go Refer to the Administration Guide > Managing Roles for further information about role management.

cutting

creating_

and

a_

pasting_explorer

service

Info
title Used on:
Folders Services

Open the context menu of the element in which you want to insert the cut element and select Paste.

Multiexcerpt
MultiExcerptName cuttingcreating_anda_pasting_explorerservice
Image Modified	If you want to use an element at a different position in the tree, select the context menu option Cut.	Image Removed

Info
The 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.

Image Removed

The element is now displayed on its new place in the tree.

designer_development_process

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.

cutting_and_pasting_explorer

Multiexcerpt
MultiExcerptName cutting_and_pasting_explorer
Image Added If you want to use an element at a different position in the tree, select the context menu option Cut. Image Added Open the context menu of the element in which you want to insert the cut element and select Paste. Info 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. Image Added The element is now displayed on its new place in the tree.

designer_development_process

designer_deployed_service

designer_test_service

designer_test_environment_status

designer_test_service_preview

deployment

Multiexcerpt
MultiExcerptName deployment
Image Added Select your deployment target the first time you deploy. Info title 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 Image Added of the deployment properties and choose between Integration Component or Container. Image Added We recommend to enter a version number and increase the number with each deployment. Multiexcerpt include SpaceWithExcerpt INTERNAL MultiExcerptName tip_increasing_version_number PageWithExcerpt _designer_excerpts Save Image Added the deployment properties to continue. Image Added Now use the deployment controls to deploy the service to your chosen target: Icon Description Image Added Use this option to deploy the service to the selected deployment target. Image Added Use this option to open the management UI of the selected deployment target: PAS Administration for Container Integration for Integration Component Image Added Use this option to open the test UI for the service-related API. Image Added Use this option to open the deployed service in a new browser tab.

differences_opening_applications

executing_deployed_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

designer_test_service

Test Service

designer_test_environment_status

The test environment has not yet been started or has expired.

Info
title Used on:
Developing with Designer from Version 23.1Working with the Test Environment Deploying a Service

Multiexcerpt
MultiExcerptName designerexecuting_testdeployed_service_preview
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 serviceAccessing 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 Image Removed and create a new instance. Open the instance overview Image Removed. Image Removed The preview is fully operational. Use it to check functionality, layout and design of your process and its forms.

deployment

executing_deployed_service_example

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

Multiexcerpt
MultiExcerptName deployment
Image Removed	Select your deployment target the first time you deploy. Info title 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 Image Removed of the deployment properties and choose between Integration Component or Container.
Image Removed	We recommend to enter a version number and increase the number with each deployment. Multiexcerpt include SpaceWithExcerpt INTERNAL MultiExcerptName tip_increasing_version_number PageWithExcerpt _designer_excerpts Save Image Removed the deployment properties to continue.
Image Removed
Icon	Description
Image Removed	Use this icon to deploy the service to the selected deployment target.
Image Removed	Use this icon to open the management UI of the selected deployment target: PAS Administration for Container Integration for Integration Component
Image Removed	Use this icon to open the test UI for the service-related API.
Image Removed	Use this icon to open the deployed service in a new browser tab.

differences_opening_applications

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:

executing_deployed_service

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

Image Removed

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.

Example: Test Service vs. Deployed Service

field_config_editor

If you click icon Image Removed the Field Configuration editor opens:

Image Removed

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

Use the Add button to insert new rows.

Enter a Value for your element option.

how_to_use_the_timer

Image Removed

Image Removed

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.

Image Removed

Select the timer if you want to define a cycle for example to start the model after one week, after two hours etc.

field_config_editor

how_to_use_the_timer

Multiexcerpt
MultiExcerptName how_to_use_the_timer
Image Added If you click option Image Added 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) Image Added 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 Image Added 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 Image Added Duration Expression Wizard The settings Repeat Interval and First Occurrence contain the option Image Added. Click this option to open a wizard that supports you to define the necessary duration expression. Image Added Insert positive integers in the desired fields. The result is shown below. Click Save to close the wizard. Image Added The duration expression is displayed in the corresponding field. Tip Once you are familiar with the notation of the duration expression, you can also insert it directly in the field.

lane_handling

Multiexcerpt
MultiExcerptName lane_handling
Image Added For a role-based process model, you need at least one main lane. You can then add sublanes. Image Added To create sublanes, drag the next lane elements onto the header of the main lane element. Drop the new element on the border of an existing lane to position the new sublane. To create a sublane within a sublane, you can drag the element onto the body of an existing lane. Multiexcerpt include SpaceWithExcerpt INTERNAL MultiExcerptName click_to_see_gif PageWithExcerpt _designer_excerpts Image Added Tip To activate the lane element, click its border or icon/header. If the element is active, an indicator is displayed in the lower right corner and the border of the element is thicker. Before Deletion: Image Added After Deletion: Image Added Info title Deletion Behavior of Lane Elements If you delete a lane element, it is erased from your work area  including all content! However, you can use restore the deletion by using Undo in the BPMN toolbar.

open_role_editor

Multiexcerpt
MultiExcerptName open_role_editor
Image Added When you click option Image Added in the attributes panel, a separate editor will open where you can assign existing roles and create new ones. Image Added In the role editor, you have two options: You can add an already existing role. You can create a new role. Info 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

pin_highlighting

validating_error_types

Image Removed

Duration Expression Wizard

The settings Repeat Interval and First Occurrence contain the icon Image Removed.

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

Image Removed

Insert positive integers in the desired fields.

The result is shown below.

Click Save to close the wizard.

Image Removed

The duration expression is displayed in the corresponding field.

lane_handling

Image Removed

Image Removed

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.

Image Removed

open_role_editor

In the role editor, you have two options:

• You can add an already existing role.
• You can create a new role.

Multiexcerpt
MultiExcerptName open_role_editor
Image Removed	When you click icon Image Removed in the attribute panel, a separate editor will open where you can assign existing roles and create new ones.
Image Removed
Info