task-form-embedded

Embedded Task Forms

This quickstart demonstrates how to use the Embedded Forms feature. Embedded Forms are plain HTML5 documents which can be loaded from your app and rendered embedded inside the camunda Tasklist:

Overview

This example uses Jakarta API. It is compatible with the latest releases of Camunda Tomcat and WildFly distributions.

Where are embedded taskforms added?

Embedded Forms can be added to the web resources of a web application. As we use maven, they are added to the src/main/webapp folder of your project.

How are embedded taskforms referenced?

Embedded Taskforms are referenced using the camunda:taskKey property of a BPMN <startEvent> or a BPMN <userTask>:

<startEvent id="startEvent" camunda:formKey="embedded:app:start-form.html" name="Loan Request Received">
  ...
</startEvent>

The attribute can also be set through the properties panel using the camunda Modeler:

Which form controls are used in this quickstart?

This quickstart demonstrates the use of most of the supported form controls. See start-form.html for the complete example.

Input Text

<input id="inputFirstname"
       required
       type="text"
       cam-variable-name="firstname"
       cam-variable-type="String"
       placeholder="John"
       ng-minlength="2"
       ng-maxlength="20" />

Input Number

<input id="inputLoanAmount"
       required
       type="number"
       cam-variable-name="loanAmount"
       cam-variable-type="Double"
       min="1000" />

Select Box

<select id="selectLoanType" required cam-variable-name="loanType" cam-variable-type="String">
  <option value="mortage" checked>Mortage Loan (5%)</option>
  <option value="cashAdvance">Cash Advance (10%)</option>
</select>

Textarea

<textarea id="inputAddress"
          cam-variable-name="address"
          cam-variable-type="String"
          rows="4"></textarea>

Custom Javascript

<script cam-script type="text/form-script">
...
</script>

How to use it?

1. Checkout the project with Git
2. Build the project with maven
3. Deploy the war file to a Camunda Platform distribution
4. Go the Tasklist and start a process instance for the process named "Embedded Forms Quickstart"