Camunda Forms Reference

Support for Camunda Forms

The Camunda Forms feature was added with the 7.15.0 release of Camunda Platform and the 4.7.0 release of the Camunda Modeler.

Camunda Forms allow you to easily design and configure forms and then embed them in the Camunda Tasklist.

  • Camunda Forms are created in the Camunda Modeler. You can find out how in the Camunda Modeler documentation.
  • Camunda Forms can easily be embedded in the Camunda Tasklist. You can find out how in the User Task Forms guide.
  • Camunda Forms are powered by the open source bpmn-io form-js library. Visit the open source repository to find out how to render a form using plain JavaScript in a custom application (note that this also requires you to to fetch the form from the respective BPMN 2.0 element and provide data as needed to the form).

Components

Use the Camunda Modeler to configure your Camunda Form. The following form elements are currently supported.

Text Field

A text field allowing the user to read and edit textual data.

A text field can be configured using the following configuration properties:

  • Field Label: Label displayed on top of the text field.
  • Field Description: Description provided below the text field.
  • Key: Identifier used to map data to the text field (see Mapping components to Process Variables).
  • Validation: Given that one of the following properties is set, the form will only submit when the respective condition is fulfilled. Otherwise a validation error will be displayed.
    • Required: Text field must contain a value.
    • Minimum Length: Text field must have at least x characters.
    • Maximum Length: Text field must not have more than x characters.
    • Regular Expression Pattern: Text field value must match the provided Regular Expression pattern.

Number

A number field allowing the user to read and edit numeric data.

A number can be configured using the following configuration properties:

  • Field Label: Label displayed on top of the number field.
  • Field Description: Description provided below the number field.
  • Key: Identifier used to map data to the number field (see Mapping components to Process Variables).
  • Validation: Given that one of the following properties is set, the form will only submit when the respective condition is fulfilled. Otherwise a validation error will be displayed.
    • Required: Number field must contain a value.
    • Minimum Length: Number field must have at least x characters.
    • Maximum Length: Number field must not have more than x characters.

Checkbox

A checkbox allowing the user to read and edit boolean data.

A checkbox can be configured using the following configuration properties:

  • Field Label: Label displayed on top of the checkbox.
  • Field Description: Description provided below the checkbox.
  • Key: Identifier used to map data to the checkbox (see Mapping components to Process Variables).

Radio

A radio button allowing the user to select one of multiple radio button entries.

A radio button can be configured using the following configuration properties:

  • Field Label: Label displayed on top of the checkbox.
  • Field Description: Description provided below the checkbox.
  • Key: Identifier used to map data to the checkbox (see Mapping components to Process Variables).
  • Values: A list of values, each representing one radio button which the user can click. Click the Plus icon to add a new value and the Trash icon to remove a value.
  • Validation: Given that one of the following properties is set, the form will only submit when the respective condition is fulfilled. Otherwise a validation error will be displayed.
    • Required: One radio option must be selected.

Select

A select allowing the user to select one of multiple entries from a dropdown menu.

A select can be configured using the following configuration properties:

  • Field Label: Label displayed on top of the select.
  • Field Description: Description provided below the select.
  • Key: Identifier used to map data to the select (see Mapping components to Process Variables).
  • Values: A list of values, each representing one select option which the user can select. Click the Plus icon to add a new value and the Trash icon to remove a value.
  • Validation: Given that one of the following properties is set, the form will only submit when the respective condition is fulfilled. Otherwise a validation error will be displayed.
    • Required: One select entry must be selected.

Text

A text component allowing to display static information to the user.

A text component can be configured using the following configuration properties:

  • Text: Either Markdown or basic HTML which will be rendered in the Form. Please note that dangerous HTML elements will not be rendered so to prevent the risk of cross-site scripting using Camunda Forms.

    • Example for Markdown:
    • ```

      This is a heading

    This shows an image: alternative image text

    ## This is a sub-heading

    Text can be shown for example using bold, or italic font.

    • This is an unordered list…
    • …with two list items
    1. This is an ordered list…
    2. …with two list items ```
    3. Example for HTML:
    4. ```

      This is a heading

    This shows an image: alternative image text

    This is a sub-heading

    Text can be shown for example using bold, or italic font.

    • This is an unordered list…
    • …with two list items

    1. This is an ordered list…
    2. …with two list items
    ```

Button

A button allowing the user to submit or reset the form.

A button can be configured using the following configuration properties:

  • Field Label: Label to be displayed on top of the button.
  • Action: The button can either trigger a Submit or a Reset action.
    • Submit: Submit the form (given there are no validation errors).
    • Reset: Reset the form, all user inputs will be lost.

Mapping components to Process Variables

Each Camunda Forms component which allows data manipulation has a Key attribute. This attribute is used as an identifier to map data of the respective field (1) during initial loading of the form, and (2) during submission of the form.

When a form is referenced by a User Task or Start Event and viewed in the Camunda Tasklist, the key will be used to refer to a Process Variable. This means that the value of the Process Variable will be used to populate the respective component initially and that the value of the component will be saved in the Process Variable during submission of the form.

On this Page: