Form flows

Form flows are multi-step form wizards that guide users through a sequence of forms. They enable complex data collection by chaining multiple forms together, with support for conditional navigation, branching logic, and step transitions.

In the context of building blocks, form flows allow you to package reusable wizard-style interactions that can be linked to user tasks in BPMN processes.

Form flows of a building block are edited in the same form flow editor as case form flows, with a JSON editor tab (the default) and a visual Editor (beta) tab. The Form dropdown of a step lists the forms of the building block. See the form flow editor documentation for how to configure steps, transitions and actions.

---

Configuring form flows

1

Navigate to Admin > Building blocks and select a building block

2

Click the Form flows tab

Form flows tab showing the list of form flows

The form flows list displays all form flows defined within this building block:

Column	Description
Key	Unique identifier for the form flow
Version	Current version number (or - if not versioned)
Read only	Whether the form flow can be edited

Adding a form flow

1

Click Create new form flow

2

Enter a unique key for the form flow

Create new form flow modal

3

Click Create to open the JSON editor

Property	Description
Key	Unique identifier for the form flow within this building block. Use lowercase with hyphens (e.g., my-form-flow)

Editing a form flow

Click on a form flow row to open the form flow editor, which opens on the JSON editor tab. The editor provides syntax highlighting and validation against the form flow JSON schema.

Form flow JSON editor

Form flows are defined in JSON with the following structure:

Property	Description
key	Unique identifier matching the form flow key
startStep	Key of the first step to display
steps	Array of step definitions

Each step contains:

Property	Description
key	Unique step identifier
type	Step type configuration (e.g., form to display a form)
onComplete	Array of expressions to execute when the step completes

Deleting a form flow

1

Click the overflow menu (three dots) on the form flow row

2

Select Delete

3

Confirm the deletion in the dialog

Form flows marked as read-only cannot be deleted.

---

Form flow scope

Form flows in a building block can reference forms defined within the same building block.