Forms and form templates
A form is used to create interfaces that allow users to enter or select data during the execution of a workflow. Forms can be displayed in two modes. One mode is the dialog mode and the other is the panel mode. You can attach a form to a trigger of the Manual type or to an action from the User interactions section.
A form template is a reusable blueprint that defines the structure, fields, and layout of a form. The form template ensures consistency in form creation, enabling users to easily generate forms without having to start from scratch.
When a template is used on a trigger or action, an independent copy of the form is created. Changes to the template do not affect forms already in use, and vice versa.
Widgets
Widgets are the building blocks of a form. They are organized into three groups in the widget library.
Basic input
Basic input widgets are the interactive input elements that users fill in.
Widget | Description |
|---|---|
Text field | Single-line text input. Used for short answers, names, or codes. |
Text area | Multi-line text input. Used for longer descriptions or comments. |
Check box | A single on/off toggle. Used for yes/no questions or acknowledgments. |
Check box group | A set of related check boxes. Users can select one or more options from a predefined list. |
Combo box | A drop-down list. It can be configured for single or multiple selection from a predefined set of options. |
Number input | A numeric input with increment and decrement buttons. Used for quantities or numeric values. |
Date picker | A calendar and time selector. Used to select a date, a time, or both. |
Link | A clickable link. Used to point users to external resources or documents. |
Users and groups | A picker to select one or more users or user groups from the directory. |
Table | A data table with configurable columns. Users can view and select rows at runtime. Selection behavior (single row, multiple rows) and the mandatory state can be configured. |
Documents | Allows users to attach files or select one or more documents from ARIS document storage. |
Layout
Layout widgets organize the visual structure of the form without collecting input.
Widget | Description |
|---|---|
Spacer | An empty spacer to create vertical separation between other widgets. |
Separator | A horizontal dividing line to visually group related widgets. |
Image | Embeds an image. Used for logos, diagrams, or visual instructions. |
Text | Static read-only text. Used for instructions, section headings, or informational paragraphs. |
Footer
Every form or form template includes default Submit and Cancel footer buttons. The Button widget in the Footer section allows you to add custom buttons for alternative actions, for example, Save as draft or Reject.
The technical name of the button the user clicked on is recorded in the flow data. Subsequent steps can use this value to branch the flow based on which button was pressed.
Widget properties
When a widget is selected on the canvas, its properties appear in the properties panel.
Property | Description |
|---|---|
Label | Name of the field that is displayed to the user. |
Mandatory | If enabled, the user must fill in the widget before submitting the form. |
Read-only | Prevents the user from changing the value. This is useful if a widget is pre-filled via a mapping or by a report. |
Localization | Labels and help text can be entered in multiple languages to match the user's language. |
Widget dependencies
Widget dependencies define conditional rules that control the visibility or state of widgets based on the value of other widgets. For instance, you can display an additional text field only when a specific check box is selected, or make a field mandatory only when a particular option is chosen from a drop-down menu.
Form mapping
When a form is attached to a User interactions action, a form mapping tree is available in the action's properties panel. It maps data from earlier steps in the flow to specific form widget fields, so users see relevant information pre-filled when they open their task. After the user submits the form, the widget values are available as source data for subsequent actions in the flow.
If a widget is deleted from the form, any mappings referencing that widget are removed automatically.