Process Engine Configuration
The process engine configuration can be placed in both processes.xml and the bpm-platform.xml files. If the process engine is configured in either or both of those files, it will be bootstrapped by the Camunda BPM platform infrastructure and be made available through BpmPlatform.getProcessEngineService().getProcessEngine("name of process engine")
.
Example
The following example shows an XML snippet which can be placed in both processes.xml and/or bpm-platform.xml.
<process-engine name="default">
<job-acquisition>default</job-acquisition>
<configuration>org.camunda.bpm.engine.impl.cfg.StandaloneProcessEngineConfiguration</configuration>
<datasource>java:jdbc/ProcessEngine</datasource>
<properties>
<property name="history">full</property>
<property name="databaseSchemaUpdate">true</property>
<property name="authorizationEnabled">true</property>
</properties>
</process-engine>
Syntax Reference
Tag name | Parent tag name | Required? | Description |
---|---|---|---|
<process-engine> |
<process-application> or <bpm-platform> |
true |
Container element for the configuration of a process engine.
Attributes:
Text Content: None. |
<job-acquisition> |
<process-engine> |
true |
Assign the process engine to a job acquisition.
Attributes: None. Text Content: The name of the job acquisition to be used for this process engine. Job acquisitions are configured in the bpm-platform.xml file.
Example:
|
<configuration> |
<process-engine> |
false |
Provide the name of the process engine configuration class.
Attributes: None. Text Content: The fully qualified classname of the Process Engine Configuration class to be used for this process engine. The class must be a subclass of ProcessEngineConfigurationImpl ". Default Value: StandaloneProcessEngineConfiguration
Example: |
<datasource> |
<process-engine> |
false |
Provide the JDBC name of the datasource to use for the process engine.
Attributes: None. Text Content: JDBC name of the datasource to use for this process engine. Default Value: null.
Example:
|
<properties> |
<process-engine> , <plugin> |
false |
Container element for providing a set of process engine configuration (or plugin) properties.
Attributes: None. Text Content: None. |
<property> |
<properties> |
false |
Set value for process engine configuration property or of a process engine plugin.
Attributes:
Text Content: The value of the property to be set. Property values are converted into String, Integer or Boolean values, depending on the type of the setter in the process engine configuration (or plugin) class.
Example: |
<plugins> |
<process-engine> |
false |
Container element for providing a set of process engine plugin configurations.
Attributes: None. Text Content: None. |
<plugin> |
<plugins> |
false |
Container element for providing an individual process engine plugin configuration.
Attributes: None. Text Content: None. |
<class> |
<plugin> |
false |
Sets the classname of a process engine plugin.
Attributes: None. Text Content: The fully qualified classname of a process engine plugin. Must be an implementation of ProcessEnginePlugin |
Configuration Properties
The following is a list with the most commonly used process engine configuration properties, along with some explanations. The properties can be used in the <property name="foo">bar</property>
tag, where foo
is the name of the property and bar
is the value of the property.
Property name | Type | Description |
---|---|---|
authorizationEnabled |
Boolean | Activates authorization checks. |
autoStoreScriptVariables |
Boolean |
Controls whether all global script variables should be automatically stored as process variables or not.
Default value is false .
Values: |
databaseSchemaUpdate |
String |
Sets the value for process engine database schema creation.
Values: |
databaseTablePrefix |
String |
Specifies a prefix for any table name included in SQL statements made by the process engine. Can be used to point the engine to a specific schema by setting the value to MY_SCHEMA. or tables with a naming pattern by setting the value to MY_TABLE_PREFIX_PATTERN_ .
|
defaultNumberOfRetries |
Integer |
Specifies how many times a job will be executed before an incident is raised. Default value: 3
|
enableExpressionsInAdhocQueries |
Boolean |
If set to true , expressions can be used when creating and executing adhoc queries. For details, see the section on security considerations for custom code in the user guide.
Default value is false .
Values: |
enableExpressionsInStoredQueries |
Boolean |
If set to true , expressions can be used when creating and executing stored queries. For details, see the section on security considerations for custom code in the user guide.
Default value is true .
Values: |
enableScriptCompilation |
Boolean |
Controls whether the process engine should attempt to compile script sources and cache the compilation result or not. Default value is true .
Values: |
forceCloseMybatisConnectionPool |
Boolean |
Controls whether a Mybatis-managed database connection pool is force closed when the process engine is closed. Closing the pool closes all active and idle database connections.
Values: |
history |
String |
Sets the level of the process engine history.
Values: |
jdbcDriver |
String |
Sets the fully qualified classname of the JDBC driver to use.
This is usually used if the process engine is NOT configured using a |
jdbcPassword |
String |
Sets the password of the JDBC connection.
This is usually used if the process engine is NOT configured using a |
jdbcUrl |
String |
Sets the JDBC url for the database connection.
This is usually used if the process engine is NOT configured using a |
jdbcUsername |
String |
Sets the username of the JDBC connection.
This is usually used if the process engine is NOT configured using a |
jobExecutorAcquireByDueDate |
Boolean |
Controls whether the job executor acquires the next jobs to execute ordered by due date. Default value is false . See the
user guide
for more details on this setting.
Values: |
jobExecutorActivate |
Boolean |
Controls whether the process engine starts with an active job executor or not. For a shared process engine configuration, the default value is true . For an embedded process engine configuration, the default value is false . See the
user guide
for more details on this setting.
Values: |
jobExecutorDeploymentAware |
Boolean |
Controls whether the job executor is deployment aware or not.
Values: |
jobExecutorPreferTimerJobs |
Boolean |
Controls whether the job executor prefers due timer jobs over other job types. Default value is false . See the
user guide
for more details on this setting.
Values: |
tenantCheckEnabled |
Boolean |
Controls whether the process engine performs tenant checks to ensure that an authenticated user can only access data that belongs to one of his tenants. Default value is true .
See the user guide for more details.
Values: |
batchJobsPerSeed |
Integer |
Sets the number of batch execution jobs created per batch seed job
invocation.
See the
user guide for more information on batch execution.
Default value: 100
|
invocationsPerBatchJob |
Integer |
Sets the number of invocations a single batch execution job executes.
See the
user guide for more information on batch execution.
Default value: 1
|
batchPollTime |
Integer |
Sets the poll interval of the batch monitor job to check for batch
completion in seconds.
See the
user guide for more information on batch execution.
Default value: 30
|
batchJobPriority |
Integer |
Sets the default batch job priority.
See the
user guide for more information on job prioritization.
Default value: 0
|
javaSerializationFormatEnabled |
Boolean |
Sets if Java serialization format can be used, when setting variables by their serialized representation. Default value: true
|