User Dialog

The User Dialog element is located in the Activity drawer of the process editor palette.

Element Details

The User Dialog element is used to call a User Dialog from a process. You can both start User Dialogs from a business process as well as from another User Dialog. Input and return parameters for/from the started User Dialog can be mapped using the call and output tabs of this element.

Inscription

Name Tab

The Name Tab is included in the mask of all process elements and contains the name and a description of the element.

Call Tab

The Call tab defines the User Dialog to call and how it should be started. The input parameters for the selected start method can be mapped here.

Dialog

Defines the User Dialog component to be started by its ID.

Selects an existing User Dialog

Creates a new User Dialog and uses it

Uses a dynamically defined ID from a data class attribute

Start

Defines the start method that should be called on the selected User Dialog.

Start Parameters Mapping

Define the input parameters for the called User Dialog.

If the selected start method requires any parameters, those may be mapped here to an param object, which offers a field for each declared start method parameter. You can define each parameter individually from the calling process’s data.

Tip

Alternatively you can define the call parameters in the scripting field below the attribute table, e.g. if you need to perform some calculation in order to define a call parameter. You can also mix the two forms, in which case the table’s definitions will be executed before the scripting block.

Note

The result values of the started User Dialog (if any) are mapped back onto the calling process’s data on the Output tab. They are available as fields on a result variable.

Output Tab

On Output Tab you can configure the output of the element (i.e. the data that leaves the element).

Note

Additionally to the regular variables of the Output Tab you have the following variables available:

result

If the selected start method defines return parameters they will be available as fields of the result variable.

The variable is not available if the start method does not return any values (i.e. void).