Camunda¶

Camunda is a process engine using BPM models. 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).

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).

In Open Forms, navigate to: Configuration > Camunda configuration
In the Camunda root field, fill out the protocol and domein (and optional port) of the API root.
In the REST api path field, fill out the path of the REST API root, relative to the Camunda root URL.
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, you will receive validation errors.