Process Engine Configuration
The auto starter uses the org.camunda.bpm.engine.impl.cfg.ProcessEnginePlugin
mechanism to configure the engine.
The configuration is divided into sections. These sections are represented by the marker interfaces:
org.camunda.bpm.spring.boot.starter.configuration.CamundaProcessEngineConfiguration
org.camunda.bpm.spring.boot.starter.configuration.CamundaDatasourceConfiguration
org.camunda.bpm.spring.boot.starter.configuration.CamundaHistoryConfiguration
org.camunda.bpm.spring.boot.starter.configuration.CamundaHistoryLevelAutoHandlingConfiguration
org.camunda.bpm.spring.boot.starter.configuration.CamundaJobConfiguration
org.camunda.bpm.spring.boot.starter.configuration.CamundaDeploymentConfiguration
org.camunda.bpm.spring.boot.starter.configuration.CamundaJpaConfiguration
org.camunda.bpm.spring.boot.starter.configuration.CamundaAuthorizationConfiguration
org.camunda.bpm.spring.boot.starter.configuration.CamundaFailedJobConfiguration
org.camunda.bpm.spring.boot.starter.configuration.CamundaMetricsConfiguration
Default Configurations
The following default and best practice configurations are provided by the starter and can be customized or overridden.
DefaultProcessEngineConfiguration
Sets the process engine name and automatically adds all ProcessEnginePlugin
beans to the configuration.
DefaultDatasourceConfiguration
Configures the Camunda data source and enables transaction integration. By default, the primary DataSource
and PlatformTransactionManager
beans are wired with the process engine configuration.
If you want to configure more than one datasource and don’t want to use the
@Primary
one for the process engine, then you can create a separate data source with name camundaBpmDataSource
that will be automatically wired with Camunda instead.
@Bean
@Primary
@ConfigurationProperties(prefix="datasource.primary")
public DataSource primaryDataSource() {
return DataSourceBuilder.create().build();
}
@Bean(name="camundaBpmDataSource")
@ConfigurationProperties(prefix="datasource.secondary")
public DataSource secondaryDataSource() {
return DataSourceBuilder.create().build();
}
Make sure to provide a corresponding transaction manager in that case:
@Bean
public PlatformTransactionManager transactionManager(@Qualifier("camundaBpmDataSource") DataSource dataSource) {
return new DataSourceTransactionManager(dataSource);
}
The wired data source and transaction manager beans must match, i.e. make sure that the transaction manager actually manages the Camunda data source. If that is not the case, the process engine will use auto-commit mode for the data source connection, potentially leading to inconsistencies in the database.
DefaultHistoryConfiguration
Applies the history configuration to the process engine. If not configured, the history level FULL is used.
If you want to use a custom HistoryEventHandler
, you just have to provide a bean implementing the interface.
@Bean
public HistoryEventHandler customHistoryEventHandler() {
return new CustomHistoryEventHanlder();
}
DefaultHistoryLevelAutoHandlingConfiguration
As camunda version >= 7.4 supports history-level auto
, this configuration adds support for versions <= 7.3.
To have more control over the handling, you can provide your own
org.camunda.bpm.spring.boot.starter.jdbc.HistoryLevelDeterminator
with namehistoryLevelDeterminator
IMPORTANT: The default configuration is applied after all other default configurations using the ordering mechanism.
DefaultJobConfiguration
Applies the job execution properties to the process engine.
To have more control over the execution itself, you can provide your own
org.camunda.bpm.engine.impl.jobexecutor.JobExecutor
org.springframework.core.task.TaskExecutor
namedcamundaTaskExecutor
beans.
IMPORTANT: The job executor is not enabled in the configuration.
This is done after the spring context successfully loaded (see org.camunda.bpm.spring.boot.starter.runlistener
).
DefaultDeploymentConfiguration
If auto deployment is enabled (this is the case by default), all processes found in the classpath are deployed. The resource pattern can be changed using properties (see properties).
DefaultJpaConfiguration
If JPA is enabled and a entityManagerFactory
bean is configured, the process engine is enabled to use JPA (see properties).
DefaultAuthorizationConfiguration
Applies the authorization configuration to the process engine. If not configured, the camunda
default values are used (see properties).
Overriding the Default Configuration
Provide a bean implementing one of the marker interfaces. For example to customize the datasource configuration:
@Configuration
public class MyCamundaConfiguration {
@Bean
public static CamundaDatasourceConfiguration camundaDatasourceConfiguration() {
return new MyCamundaDatasourceConfiguration();
}
}
Adding Additional Configurations
You just have to provide one or more beans implementing the org.camunda.bpm.engine.impl.cfg.ProcessEnginePlugin
interface
(or extend from org.camunda.bpm.spring.boot.starter.configuration.impl.AbstractCamundaConfiguration
).
The configurations are applied ordered using the spring ordering mechanism (@Order
annotation and Ordered
interface).
So if you want your configuration to be applied before the default configurations, add a @Order(Ordering.DEFAULT_ORDER - 1)
annotation to your class.
If you want your configuration to be applied after the default configurations, add a @Order(Ordering.DEFAULT_ORDER + 1)
annotation to your class.
@Configuration
public class MyCamundaConfiguration {
@Bean
@Order(Ordering.DEFAULT_ORDER + 1)
public static ProcessEnginePlugin myCustomConfiguration() {
return new MyCustomConfiguration();
}
}
Or, if you have component scan enabled:
@Component
@Order(Ordering.DEFAULT_ORDER + 1)
public class MyCustomConfiguration implements ProcessEnginePlugin {
@Override
public void preInit(ProcessEngineConfigurationImpl processEngineConfiguration) {
//...
}
...
}
or
@Component
@Order(Ordering.DEFAULT_ORDER + 1)
public class MyCustomConfiguration extends AbstractCamundaConfiguration {
@Override
public void preInit(SpringProcessEngineConfiguration springProcessEngineConfiguration) {
//...
}
...
}
Camunda Engine Properties
In addition to the bean-based way of overriding process engine configuration properties, it is also possible
to set those properties via an application.yaml
configuration file. Instructions on how to use it
can be found in the Spring Boot Starter Guide.
The available properties are as follows:
Prefix | Property name | Description | Default value |
---|---|---|---|
General | |||
camunda.bpm |
.enabled |
Switch to disable the Camunda auto-configuration. Use to exclude Camunda in integration tests. | true |
.process-engine-name |
Name of the process engine | Camunda default value | |
.generate-unique-process-engine-name |
Generate a unique name for the process engine (format: 'processEngine' + 10 random alphanumeric characters) | false | |
.generate-unique-process-application-name |
Generate a unique Process Application name for every Process Application deployment (format: 'processApplication' + 10 random alphanumeric characters) | false | |
.default-serialization-format |
Default serialization format | Camunda default value | |
.history-level |
Camunda history level | FULL | |
.history-level-default |
Camunda history level to use when history-level is auto , but the level can not determined automatically |
FULL | |
.auto-deployment-enabled |
If processes should be auto deployed. This is disabled when using the SpringBootProcessApplication | true |
|
.default-number-of-retries |
Specifies how many times a job will be executed before an incident is raised | 3 |
|
.job-executor-acquire-by-priority |
If set to true, the job executor will acquire the jobs with the highest priorities | false |
|
.license-file |
Provides a URL to your Camunda license file and is automatically inserted into the DB when the application starts (but only if no valid license key is found in the DB). Note: This property is only available when using the camunda-bpm-spring-boot-starter-webapp-ee | By default, the license key will be loaded:
|
|
.id-generator |
Configure idGenerator. Allowed values: simple , strong , prefixed . prefixed id generator is like strong , but uses a Spring application name (${spring.application.name} ) as the prefix for each id. |
strong |
|
.version |
Version of the process engine | Read only value, e.g., 7.4.0 | |
.formatted-version |
Formatted version of the process engine | Read only value, e.g., (v7.4.0) | |
.deployment-resource-pattern |
Location for auto deployment | classpath*:**/*.bpmn, classpath*:**/*.bpmn20.xml, classpath*:**/*.dmn, classpath*:**/*.dmn11.xml, classpath*:**/*.cmmn, classpath*:**/*.cmmn10.xml, classpath*:**/*.cmmn11.xml |
|
Job Execution | |||
camunda.bpm.job-execution |
.enabled |
If set to false , no JobExecutor bean is created at all. Maybe used for testing. |
true |
.deployment-aware |
If job executor is deployment aware | false |
|
.core-pool-size |
Set to value > 1 to activate parallel job execution. | 3 |
|
.keep-alive-seconds |
Specifies the time, in milliseconds, for which threads are kept alive when there are no more tasks present. When the time expires, threads are terminated so that the core pool size is reached. | 0 |
|
.lock-time-in-millis |
Specifies the time in milliseconds an acquired job is locked for execution. During that time, no other job executor can acquire the job. | 300000 |
|
.max-jobs-per-acquisition |
Sets the maximal number of jobs to be acquired at once. | 3 |
|
.max-pool-size |
Maximum number of parallel threads executing jobs. | 10 |
|
.queue-capacity |
Sets the size of the queue which is used for holding tasks to be executed. | 3 |
|
.wait-time-in-millis |
Specifies the wait time of the job acquisition thread in milliseconds in case there are less jobs available for execution than requested during acquisition. If this is repeatedly the case, the wait time is increased exponentially by the factor waitIncreaseFactor . The wait time is capped by maxWait . |
5000 |
|
.max-wait |
Specifies the maximum wait time of the job acquisition thread in milliseconds in case there are less jobs available for execution than requested during acquisition. | 60000 |
|
.backoff-time-in-millis |
Specifies the wait time of the job acquisition thread in milliseconds in case jobs were acquired but could not be locked. This condition indicates that there are other job acquisition threads acquiring jobs in parallel. If this is repeatedly the case, the backoff time is increased exponentially by the factor waitIncreaseFactor . The time is capped by maxBackoff . With every increase in backoff time, the number of jobs acquired increases by waitIncreaseFactor as well. |
0 |
|
.max-backoff |
Specifies the maximum wait time of the job acquisition thread in milliseconds in case jobs were acquired but could not be locked. | 0 |
|
.backoff-decrease-threshold |
Specifies the number of successful job acquisition cycles without a job locking failure before the backoff time is decreased again. In that case, the backoff time is reduced by waitIncreaseFactor . |
100 |
|
.wait-increase-factor |
Specifies the factor by which wait and backoff time are increased in case their activation conditions are repeatedly met. | 2 |
|
Datasource | |||
camunda.bpm.database |
.schema-update |
If automatic schema update should be applied, use one of [true, false, create, create-drop, drop-create] | true |
.type |
Type of the underlying database. Possible values: h2 , mysql, mariadb, oracle, postgres, mssql, db2. |
Will be automatically determined from datasource | |
.table-prefix |
Prefix of the camunda database tables. Attention: The table prefix will not be applied if you are using schema-update ! |
Camunda default value | |
.schema-name |
The dataBase schema name | Camunda default value | |
.jdbc-batch-processing |
Controls if the engine executes the jdbc statements as Batch or not. It has to be disabled for some databases. See the user guide for further details. | Camunda default value: true | |
Eventing | |||
camunda.bpm.eventing |
.execution |
Enables eventing of delegate execution events. See the user guide for further details. | true |
.history |
Enables eventing of history events. See the user guide for further details. | true |
|
.task |
Enables eventing of task events. See the user guide for further details. | true |
|
JPA | |||
camunda.bpm.jpa |
.enabled |
Enables jpa configuration | true . Depends on entityManagerFactory bean. |
.persistence-unit-name |
JPA persistence unit name | - | |
.close-entity-manager |
Close JPA entity manager | true |
|
.handle-transaction |
JPA handle transaction | true |
|
Management | |||
camunda.bpm.management |
.health.camunda.enabled |
Enables default camunda health indicators | true |
Metrics | |||
camunda.bpm.metrics |
.enabled |
Enables metrics reporting | Camunda default value |
.db-reporter-activate |
Enables db metrics reporting | Camunda default value | |
Webapp | |||
camunda.bpm.webapp |
.enabled |
Switch to disable the Camunda Webapp auto-configuration. | true |
.index-redirect-enabled |
Registers a redirect from / to camunda's bundled index.html .
If this property is set to false , the
default
Spring Boot behaviour is taken into account. |
true |
|
.application-path |
Changes the application path of the webapp.
When setting to / , the legacy behavior of Camunda Spring Boot Starter <= 3.4.x is restored.
|
/camunda |
|
camunda.bpm.webapp.csrf |
|||
.target-origin |
Sets the application expected deployment domain. See the user guide for details. | Not set | |
.deny-status |
Sets the HTTP response status code used for a denied request. See the user guide for details. | 403 |
|
.random-class |
Sets the name of the class used to generate tokens. See the user guide for details. | java.security.SecureRandom |
|
.entry-points |
Sets additional URLs that will not be tested for the presence of a valid token. See the user guide for details. | Not set | |
.enable-secure-cookie |
If set to true , the cookie flag Secure is enabled.
|
false |
|
.enable-same-site-cookie |
If set to false , the cookie flag SameSite is disabled. The default value of the SameSite cookie is LAX and it can be changed via same-site-cookie-option configuration property.
|
true |
|
.same-site-cookie-option |
Can be configured either to STRICT or LAX .Note:
|
Not set | |
.same-site-cookie-value |
A custom value for the cookie property. Note:
|
Not set | |
.cookie-name |
A custom value to change the cookie name. Note: Please make sure to additionally change the cookie name for each webapp (e. g. Cockpit ) separately. |
XSRF-TOKEN |
|
camunda.bpm.webapp.header-security |
|||
.xss-protection-disabled |
The header can be entirely disabled if set to true . Allowed set of values is true and false .
|
false |
|
.xss-protection-option |
The allowed set of values:
|
BLOCK |
|
.xss-protection-value |
A custom value for the header can be specified. Note:
|
1; mode=block |
|
.content-security-policy-disabled |
The header can be entirely disabled if set to true . Allowed set of values is true and false .
|
false |
|
.content-security-policy-value |
A custom value for the header can be specified. Note: Property is ignored when .content-security-policy-disabled is set to true
|
base-uri 'self' |
|
.content-type-options-disabled |
The header can be entirely disabled if set to true . Allowed set of values is true and false .
|
false |
|
content-type-options-value |
A custom value for the header can be specified. Note: Property is ignored when .content-security-policy-disabled is set to true
|
nosniff |
|
Authorization | |||
camunda.bpm.authorization |
.enabled |
Enables authorization | Camunda default value |
.enabled-for-custom-code |
Enables authorization for custom code | Camunda default value | |
.authorization-check-revokes |
Configures authorization check revokes | Camunda default value | |
.tenant-check-enabled |
Performs tenant checks to ensure that an authenticated user can only access data that belongs to one of his tenants. | true |
|
Admin User | |||
camunda.bpm.admin-user |
.id |
The username (e.g., 'admin') | - |
.password |
The initial password | =id |
|
.firstName , .lastName , .email |
Additional (optional) user attributes | Defaults to value of 'id' | |
Filter | |||
camunda.bpm.filter |
.create |
Name of a "show all" filter. If set, a new filter is created on start that displays all tasks. Useful for testing on h2 db. | - |
Generic Properties
The method of configuration described above does not cover all process engine properties available. To override any process engine configuration property that is not exposed (i.e. listed above) you can use generic-properties.
camunda:
bpm:
generic-properties:
properties:
...
Note:
Overriding an already exposed property using the generic-properties
keyword does not effect the process engine configuration. All exposed properties
can only be overridden with their exposed identifier.
Examples
Override configuration using exposed properties:
camunda.bpm:
admin-user:
id: kermit
password: superSecret
firstName: Kermit
filter:
create: All tasks
Override configuration using generic properties:
camunda:
bpm:
generic-properties:
properties:
enable-password-policy: true
Session Cookie
You can configure the Session Cookie for the Spring Boot application via the application.yaml
configuration file.
Camunda Spring Boot Starter versions:
<= 2.3 (Spring Boot version 1.x)
server:
session:
cookie:
secure: true
http-only: true # Not possible for versions before 1.5.14
>= 3.0 (Spring Boot version 2.x)
server:
servlet:
session:
cookie:
secure: true
http-only: true # Not possible for versions before 2.0.3
Configuring Spin DataFormats
The Camunda Spring Boot Starter auto-configures the Spin Jackson Json DataFormat when the
camunda-spin-dataformat-json-jackson
dependency is detected on the classpath. To include a
DataFormatConfigurator
for the desired Jackson Java 8 module, the appropriate dependency needs
to be included on the classpath as well. Note that camunda-engine-plugin-spin
needs to be included as a dependency as well for the auto-configurators to work.
Auto-configuration is currently supported for the following Jackson Java 8 modules:
- Parameter names (
jackson-module-parameter-names
) - Java 8 Date/time (
jackson-datatype-jdk8
) - Java 8 Datatypes (
jackson-datatype-jsr310
)
Heads Up!
The Spin Jackson Json DataFormat auto-configuration is disabled when using
camunda-spin-dataformat-all
as a dependency. The camunda-spin-dataformat-all
artifact shades the
Jackson libraries, which breaks compatibility with the regular Jackson modules. If usage of
camunda-spin-dataformat-all
is necessary, please use the standard method for
Spin Custom DataFormat configuration.
For example, to provide support for Java 8 Date/time types in Spin, the following dependencies, with their
appropriate version tags, will need to be added in the Spring Boot Application’s
pom.xml
file:
<dependencies>
<dependency>
<groupId>org.camunda.bpm</groupId>
<artifactId>camunda-engine-plugin-spin</artifactId>
</dependency>
<dependency>
<groupId>org.camunda.spin</groupId>
<artifactId>camunda-spin-dataformat-json-jackson</artifactId>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jdk8</artifactId>
</dependency>
</dependencies>
Spring Boot also provides some nice configuration properties, to further
configure the Jackson ObjectMapper
. They can be found here.
To provide additional configurations, the following actions need to be performed:
- Provide a custom implementation of
org.camunda.spin.spi.DataFormatConfigurator
; - Add the appropriate key-value pair of the fully qualified classnames of the interface and the
implementaion to the
META-INF/spring.factories
file; - Ensure that the artifact containing the configurator is reachable from Spin’s classloader.