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
| Property | Required? | Description | Default Value | Sample Value |
|---|---|---|---|---|
| kadai.adapter.run-as.user | yes | Kadai-name of the user used to interact with Kadai | n.a. | taskadmin |
| kadai.adapter.scheduler.run.interval.for.start.kadai.tasks.in.milliseconds | no | Interval in milliseconds between runs for retrieving new external tasks and creating them in Kadai | 5000 | 10000 |
| kadai.adapter.scheduler.run.interval.for.check.finished.referenced.tasks.in.milliseconds | no | Interval in milliseconds between runs for retrieving finished external tasks and finishing them in Kadai | 5000 | 10000 |
| kadai.adapter.scheduler.run.interval.for.complete.referenced.tasks.in.milliseconds | no | Interval in milliseconds between runs for retrieving completed Kadai-Tasks and completing them in external systems | 5000 | 10000 |
| kadai.adapter.scheduler.run.interval.for.claim.referenced.tasks.in.milliseconds | no | Interval in milliseconds between runs for retrieving claimed Kadai-Tasks and claiming them in external systems | 5000 | 10000 |
| kadai.adapter.scheduler.run.interval.for.cancel.claim.referenced.tasks.in.milliseconds | no | Interval in milliseconds between runs for retrieving cancel-claimed Kadai-Tasks and cancel-claiming them in external systems | 5000 | 10000 |
| kadai.adapter.sync.kadai.batchSize | no | Amount of tasks to sync from Kadai to external systems in a single run | 64 | 10 |
| 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 |
| kadai.adapter.mapping.default.objectreference.company | no | Default Object-Reference-Company used for mapping of external tasks to Kadai-Tasks | DEFAULT_COMPANY | DEFAULT_COMPANY |
| kadai.adapter.mapping.default.objectreference.system | no | Default Object-Reference-System used for mapping of external tasks to Kadai-Tasks | DEFAULT_SYSTEM | DEFAULT_SYSTEM |
| kadai.adapter.mapping.default.objectreference.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.mapping.default.objectreference.type | no | Default Object-Reference-Type used for mapping of external tasks to Kadai-Tasks | DEFAULT_TYPE | DEFAULT_TYPE |
| kadai.adapter.mapping.default.objectreference.value | no | Default Object-Reference-Value used for mapping of external tasks to Kadai-Tasks | DEFAULT_VALUE | DEFAULT_VALUE |
Camunda 7 (Plugin)
For a complete Configuration-Reference of Camunda 7, check out their docs.
| Property | Required? | Description | Default Value | Sample Value |
|---|---|---|---|---|
| kadai-system-connector-camunda-rest-api-user-name | no | Username used for basic-auth with Camunda | undefined | demo |
| kadai-system-connector-camunda-rest-api-user-password | no | Password used for basic-auth with Camunda | undefined | demo |
| kadai-system-connector-outbox-rest-api-user-name | no | Username used for basic-auth with the Outbox REST-API | undefined | outboxRestUser |
| kadai-system-connector-outbox-rest-api-user-password | no | Password used for basic-auth with the Outbox REST-API | undefined | pwd4OutboxRestUser |
| kadai-system-connector-camundaSystemURLs | yes | List of Camunda-Systems where each system has format: <camundaSystem1-RestURL> | <camundaSystem1-OutboxRestURL> | <camundaSystem1-Id> | n.a. | http://localhost:8081/example-context-root/engine-rest1 | http://localhost:8081/example-context-root/outbox-rest1 | my-system1, http://localhost:8081/example-context-root/engine-rest2 | http://localhost:8081/example-context-root/outbox-rest2 | my-system2 |
| kadai.adapter.events.lockDuration | no | Duration in seconds used for locking tasks in the Outbox in clustered KadaiAdapter-Environments | 0 | 42 |
| kadai.adapter.xsrf.token | no | XSRF-Token used when communicating with either Camunda or the Outbox REST-API | n.a. | FOO_UNIQUE_TOKEN_123 |
Camunda 8 (Plugin)
For a complete Configuration-Reference of Camunda 8, check out their docs.
| Property | Required? | Description | Default Value | Sample Value |
|---|---|---|---|---|
| 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.auth.token-url | no | Authorization server URL from which to request the access token. | A default is set by camunda.client.mode: saas and camunda.client.auth.method: oidc | http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token |
| 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.auth.audience | no | Resource for which the access token must be valid. | A default is set by camunda.client.mode: saas and camunda.client.auth.method: oidc | zeebe-api |