除了基于Bean的覆盖流程引擎配置属性的方法外,还可以通过application.yaml配置文件设置这些属性。 有关如何使用它的说明,可以在Spring Boot Starter Guide中找到。
可用属性如下:
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. | - |