Camunda 7

Camunda is a process orchestrator with a DMN engine. Open Forms supports Camunda 7.x

Note

This service requires a connection to an external Camunda instance, offered or maintained by a service provider.

What does the Open Forms administrator need?

The values for these parameters should be provided to the Open Forms administrator by the service provider.

Parameter

Description

Camunda instance

Camunda root

The domain where the Camunda instance runs.

REST api path

The path where the API of the above Camunda instance can be found.

Username

Username for the REST API user (Basic Auth)

Password

Password for the REST API user (Basic Auth)

Permissions within Camunda

List process definitions

Open Forms must be able to read the available process definitions to connect a form to a process.

Start process instances

Open Forms must be able to start process instances of the selected process definition(s).

What does the service provider need?

The values for these parameters should be provided to the service provider by the Open Forms administrator.

Parameter

Description

Security

IP address

The IP address of the Open Forms server (optional, for whitelisting).

Plugin configuration

  1. In the Open Forms admin, navigate to: Configuration > Camunda configuration

  2. In the Camunda root field, fill out the protocol and domain (and optional port) of the API root.

  3. In the REST api path field, fill out the path of the REST API root, relative to the Camunda root URL.

  4. Under Auth, fill out the username and password. Note that the password is never displayed, even if filled out correctly.

The configuration page tests the connection, if any mistakes are made, validation errors will be shown.

Camunda Admin

In order to deploy a new decision definition and then evaluate it, users should be created with:

  • The CREATE authorization for the Deployment resource.

  • The READ and CREATE_INSTANCE authorization for the Decision Definition.

To configure this, log in into the Camunda Admin with a user with admin rights. Then, follow the following instructions:

  1. Creating groups

    Click on Groups on the navigation bar and click on Create new group +. Fill in Deployers as the Group ID and then fill the other required fields. Then click on Create new group.

    Create then another group with Group ID DecisionTableEvaluators.

  2. Creating users

    Click on Users on the navigation bar and click on Add user +. Fill in deployer as the UserID and then fill the other required fields. Then click on + Create new user.

    Create then another user with UserID openForms.

    Now that the users are created, they need to be added to the right group. Click on the user deployer and then on the left hand side navigate to Groups. Click on Add to a group and add the user to the Deployers group.

    Then, go back to the Users page and click on the user openForms. Add this user to the group DecisionTableEvaluators.

  3. Updating authorizations

    Click on Authorizations on the navigation bar.

    On the left hand side, navigate to Deployment. Click on + Create new authorization. In the User / Group column, fill in Deployers. Click on the check icon to save.

    On the left hand side, navigate to Decision Definition. Click on + Create new authorization. In the User / Group column, fill in DecisionTableEvaluators. Click on the pen icon to update the permissions. Uncheck everything, except READ and CREATE_INSTANCE. Click on the check icon to save.

Now, the credentials for the user deployer can be used in the Camunda modeller when deploying a decision definition. The credentials for the user openForms can be used in the Open Forms admin under the Configuration > Camunda Configuration page.

Form configuration

In the form designer page in the admin, navigate to the Logic tab. Then:

  1. Add a new logic rule (can be simple or advanced) with a trigger that should determine when the decision table should be evaluated.

  2. Add a new action and select the value Evaluate DMN in the drop down.

  3. Click on the ‘Configure’ button next to the drop down. This opens a modal with more settings to configure.

Action configuration:

  1. Select the plugin that should be used to evlauate the decision table, in this case Camunda 7.

  2. After selecting the plugin, the drop down Decision Definition ID will be populated with the decision tables available in the configured Camunda instance. Select the desired decision definition to evaluate.

  3. If the selected definition has multiple versions, you can select a specific version in the drop down Decision definition version.

  4. The Input mapping table maps Open Forms variables to DMN input variables. Only the data of the variables specified in the mapping will be sent to the decision table for evaluation.

  5. The Output mapping table maps DMN output variables to Open Forms variables. After evaluation of the decision table, the logic action will update the specified Open Forms output variable(s) with the values returned by Camunda.

  6. Save the settings.

For an example form, see Formulier met Camunda en DMN evaluatie.

Technical

Camunda version

Test status

7.12

Manually verified

7.13

Untested

7.14

Untested

7.15

Untested

7.16

Tested in CI