Configuration
The KadaiAdapter is configured via external Spring-Boot-Configurations. Below we will list all configurable and non-spring-standard properties and shortly explain them.
Kernel
Properties
| Property | Required? | Description | Default Value | Sample Value |
|---|---|---|---|---|
| kadai-adapter.kernel.run-as-user | yes | Kadai-name of the user used to interact with Kadai | n.a. | taskadmin |
| kadai-adapter.kernel.scheduler.start-kadai-tasks-interval | no | Interval in milliseconds between runs for retrieving new external tasks and creating them in Kadai | 5000 | 10000 |
| kadai-adapter.kernel.scheduler.check-finished-referenced-tasks-interval | no | Interval in milliseconds between runs for retrieving finished external tasks and finishing them in Kadai | 5000 | 10000 |
| kadai-adapter.kernel.scheduler.complete-referenced-tasks-interval | no | Interval in milliseconds between runs for retrieving completed Kadai-Tasks and completing them in external systems | 5000 | 10000 |
| kadai-adapter.kernel.scheduler.claim-referenced-tasks-interval | no | Interval in milliseconds between runs for retrieving claimed Kadai-Tasks and claiming them in external systems | 5000 | 10000 |
| kadai-adapter.kernel.scheduler.cancel-claim-referenced-tasks-interval | no | Interval in milliseconds between runs for retrieving cancel-claimed Kadai-Tasks and cancel-claiming them in external systems | 5000 | 10000 |
| kadai-adapter.kernel.scheduler.start-kadai-tasks-thread-count | no | Number of threads used for parallel creation of KADAI tasks | 1 | 10 |
| kadai-adapter.kernel.kadai-connector.batch-size | no | Amount of tasks to sync from Kadai to external systems in a single run | 64 | 10 |
| kadai-adapter.kernel.kadai-connector.task-mapping.object-reference.company | no | Default Object-Reference-Company used for mapping of external tasks to Kadai-Tasks | DEFAULT_COMPANY | DEFAULT_COMPANY |
| kadai-adapter.kernel.kadai-connector.task-mapping.object-reference.system | no | Default Object-Reference-System used for mapping of external tasks to Kadai-Tasks | DEFAULT_SYSTEM | DEFAULT_SYSTEM |
| kadai-adapter.kernel.kadai-connector.task-mapping.object-reference.system-instance | no | Default Object-Reference-System-Instance used for mapping of external tasks to Kadai-Tasks | DEFAULT_SYSTEM_INSTANCE | DEFAULT_SYSTEM_INSTANCE |
| kadai-adapter.kernel.kadai-connector.task-mapping.object-reference.type | no | Default Object-Reference-Type used for mapping of external tasks to Kadai-Tasks | DEFAULT_TYPE | DEFAULT_TYPE |
| kadai-adapter.kernel.kadai-connector.task-mapping.object-reference.value | no | Default Object-Reference-Value used for mapping of external tasks to Kadai-Tasks | DEFAULT_VALUE | DEFAULT_VALUE |
| kadai.datasource.jdbcUrl | yes | JDBC-URL of of the Kadai instance the KadaiAdapter is assigned to | n.a. | jdbc:h2:mem:kadai;NON_KEYWORDS=KEY,VALUE;IGNORECASE=TRUE;LOCK_MODE=0;DB_CLOSE_ON_EXIT=FALSE |
| kadai.datasource.driverClassName | yes | Driver-Classname of of the Kadai instance the KadaiAdapter is assigned to | n.a. | org.h2.Driver |
| kadai.datasource.username | yes | Username of of the Kadai instance the KadaiAdapter is assigned to | n.a. | sa |
| kadai.datasource.password | yes | Password of of the Kadai instance the KadaiAdapter is assigned to | n.a. | sa |
| kadai.schemaName | yes | Schema-Name of of the Kadai instance the KadaiAdapter is assigned to | n.a. | KADAI |
Camunda 7 (Plugin)
Properties
For a complete Configuration-Reference of Camunda 7, check out their docs.
| Property | Required? | Description | Default Value | Sample Value |
|---|---|---|---|---|
| kadai-adapter.plugin.camunda7.claiming.enabled | no | Whether to enable synchronization of claims. | false | true |
| kadai-adapter.plugin.camunda7.client.username | no | Username used for basic-auth with Camunda | undefined | demo |
| kadai-adapter.plugin.camunda7.client.password | no | Password used for basic-auth with Camunda | undefined | demo |
| kadai-adapter.plugin.camunda7.outbox.client.username | no | Username used for basic-auth with the Outbox REST-API | undefined | outboxRestUser |
| kadai-adapter.plugin.camunda7.outbox.client.password | no | Password used for basic-auth with the Outbox REST-API | undefined | pwd4OutboxRestUser |
| kadai-adapter.plugin.camunda7.systems | yes | List of Camunda7-Systems as Spring List-Configuration | [] | kadai-adapter.plugin.camunda7.systems[0].system-rest-url=http://localhost:8081/example-context-root/engine-rest, kadai-adapter.plugin.camunda7.systems[0].system-task-event-url=http://localhost:8081/example-context-root/outbox-rest |
| kadai-adapter.plugin.camunda7.lock-duration | no | Duration in seconds used for locking tasks in the Outbox in clustered KadaiAdapter-Environments | 0 | 42 |
| kadai-adapter.plugin.camunda7.xsrf-token | no | XSRF-Token used when communicating with either Camunda or the Outbox REST-API | n.a. | FOO_UNIQUE_TOKEN_123 |
| kadai-adapter.plugin.camunda7.outbox.auth-type | no | Authentication type for the Outbox REST API. BASIC uses username/password; OAUTH2 uses OAuth2 client-credentials. | BASIC | OAUTH2 |
| kadai-adapter.plugin.camunda7.outbox.oauth2.token-uri | no | Token endpoint URI of the OAuth2 authorization server (required when auth-type=OAUTH2) | n.a. | http://localhost:8083/oauth2/token |
| kadai-adapter.plugin.camunda7.outbox.oauth2.client-id | no | OAuth2 client ID (required when auth-type=OAUTH2) | n.a. | kadai-adapter |
| kadai-adapter.plugin.camunda7.outbox.oauth2.client-secret | no | OAuth2 client secret (required when auth-type=OAUTH2) | n.a. | super-secret |
| kadai-adapter.plugin.camunda7.outbox.oauth2.scopes | no | Space-separated list of OAuth2 scopes to request (required when auth-type=OAUTH2) | n.a. | outbox:read outbox:write |
Camunda 8 (Plugin)
Properties
For a complete Configuration-Reference of Camunda 8, check out their docs.
| Property | Required? | Description | Default Value | Sample Value |
|---|---|---|---|---|
| kadai-adapter.plugin.camunda8.claiming.enabled | no | Whether to enable synchronization of claims. | false | true |
| kadai-adapter.plugin.camunda8.completing.enabled | no | Whether to enable synchronization of completes. | true | false |
| camunda.client.mode | no | Client mode to use. | If not set, saas mode is detected based on the presence of a camunda.client.cloud.cluster-id | self-managed |
| camunda.client.enabled | no | Enable or disable the Camunda client. | yes | no |
| camunda.client.rest-address | yes | REST API address of the Camunda instance that the client can connect to. The address must be an absolute URL, including the scheme. This address is used by the KadaiAdapter to communicate with the respective Camunda 8 instance. | An alternative default is set by both camunda.client.mode | http://localhost:8081 |
| camunda.client.grpc-address | no | gRPC address of Camunda that the client can connect to. The address must be an absolute URL, including the scheme. | An alternative default is set by both camunda.client.mode | http://localhost:26500 |
| camunda.client.prefer-rest-over-grpc | no | If true, prefers REST over gRPC for operations supported by both protocols. | true | false |
| camunda.client.worker.defaults.tenant-ids | no | The tenants which all workers (tasklisteners) work for. | [<default>] (the default tenant) | <default>,tenant1,tenant2 |
The listed Camunda 8 properties are the central ones for the KadaiAdapter. There are, however, many more.
See camunda8:properties-reference.
Permissions
The KadaiAdapter requires the following minimal permissions in Camunda 8:
Resource Type: PROCESS_DEFINITION
Resource Key: *
Permissions: UPDATE_USER_TASK, UPDATE_PROCESS_INSTANCE
Although currently not required, we further recommend the following permissions for long-term compatibility:
Resource Type: PROCESS_DEFINITION
Resource Key: *
Permissions: READ_USER_TASK, READ_PROCESS_INSTANCE
All Camunda 8 Orchestration Cluster authorizations are documented at camunda8:identity-and-access-management/orchestration-cluster-authorization.