4.7. Forms

A form is a layout definition for a page (defined as HTML) that is displayed as a dialog window to the user on a
  • process instantiation or a
  • task instantiation.
The form is then respectively referred to as a Process form or a Task form. It serves for acquiring data for the Element instance execution, be it a Process or Task, from a human user: a Process form can take as its input and output Process variables; a Task form can take as its input DataInputSet variables with assignment defined, and as its output DataOutputSet variables with assignment defined.
For example, you could ask the user to provide the input parameters needed for Process instantiation and display any variable data connected to the Process; or using a Human Task show information and request input for further Process execution.
This data can be mapped to the Task as DataInputSet and used as the Task's local variables and to DataOutputSet to provide the data to the parent Process instance (refer to Section 4.12, “Assignment”).

4.7.1. Defining Process form

A Process form is a form that is displayed at Process instantiation to the user who instantiated the Process.
To create a Process form, do the following:
  1. Open your Process definition in the Process Designer.
  2. In the editor toolbar, click the Form ( ) icon and then Edit Process Form.
  3. Select the editor to use to edit the form. Note that this document deals only with the Graphical Modeler option.
Note that the Form is created in the root of your current Project and is available from any other Process definitions in the Projects.

4.7.2. Defining Task form

A Task form is a form that is displayed at User Task instantiation, that is, when the execution flow reaches the Task, to the Actor of the User Task.
To create a Task form, do the following:
  1. Open your Process definition with the User Task in the Process Designer.
  2. Select the Task on the canvas and click the Edit Process Form ( ) in the User Task menu.
  3. In the displayed Form Editor, define the Task form.

4.7.3. Defining form fields

Once you have created a form definition, you need to define its content: that is its fields and the data they are bound to. You can add either the pre-defined field types to your form, or define your own data origin and use the custom field types in your form definition.

Note

Automatic form generation is not recursive, which means that when custom data objects are used, only the top-level form is generated (no subforms). The user is responsible for creating forms that represent the custom data objects and link them to the parent form.