For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

Utilize forms

Beginner Time estimate: 15 minutes

About​

The Camunda Forms feature allows you to easily design and configure forms. Once configured, they can be connected to a user task or start event to implement a task form in your application.

After deploying a diagram with a linked form, Tasklist imports this form schema and uses it to render the form on every task assigned to it.

Quickstart​

Create new form​

To start building a form in Desktop Modeler, click File > New file > Form (Camunda 8).

In this example, you'll build a form to help with a task in obtaining an email message.

Build your form​

Within Forms, you can add text fields, numerical values, checkboxes, radio elements, selection menus, text components, and buttons.

  1. From the Components palette on the left, drag and drop a Text area to the Form definition editor.
  2. Select the Text area.
  3. In the properties panel on the right, open the General section.
  4. Provide the following data:
    • Field label: "Email content"
    • Field description: "The content of the email message"
  5. Deselect the text area, so the form's properties are shown in the properties panel.
  6. In the General section, copy the form's ID. You'll use this when you link the form to a user task.
  7. Click File > Save File As...
  8. Name the file email-form.
tip

Refer to the camunda forms reference to explore all form elements and configuration options in detail.

Implement a task form into a diagram. In tandem, link your form to a user task or start event:

  1. Open the diagram where you'd like to apply your form.
  2. Select the user task requiring the help of a form.
  3. In the properties panel on the right, in the Form section, select type Camunda Form.
  4. For the Form ID, paste the ID you copied when you built your form.
  5. Save your BPMN file.

Deploy and run​

You need to deploy both the form and process before running a process instance.

Deploy your form:

  1. Open your form.
  2. At the bottom of the view, configure a connection, and click the rocket-shaped Deploy icon to deploy your form.
  3. Click Deploy Form.

Deploy your process:

  1. Open your BPMN process.
  2. At the bottom of the view, configure a connection, and click the rocket-shaped Deploy icon to deploy your process.
  3. Click Deploy BPMN.

With both resources deployed, you can run a process instance. Click the play icon, then click Start BPMN process instance.

You can now monitor your instances in Operate. To complete a user task, navigate to Tasklist.

Additional resources​