Skip to content

Commit 39c7dc9

Browse files
committed
docs(engine): add skipIsolationLevelCheck flag and update documentation
Related to camunda/camunda-bpm-platform#4516
1 parent 7d3197e commit 39c7dc9

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

content/reference/deployment-descriptors/tags/process-engine.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -506,7 +506,7 @@ The following is a list with the most commonly used process engine configuration
506506
<br><br>
507507
A custom hostname can be generated by providing an implementation of the
508508
{{< javadocref page="org/camunda/bpm/engine/impl/history/event/HostnameProvider.html" text="HostnameProvider" >}}
509-
interface and and setting the engine property `hostnameProvider` to an instance of that class.
509+
interface and and setting the engine property <code>hostnameProvider</code> to an instance of that class.
510510
<br><br>
511511
</td>
512512
</tr>
@@ -551,6 +551,21 @@ The following is a list with the most commonly used process engine configuration
551551
</p>
552552
</td>
553553
</tr>
554+
<tr>
555+
<td><code>skipIsolationLevelCheck</code></td>
556+
<td>Boolean</td>
557+
<td>
558+
If the value of this flag is set to <code>false</code>, a <code>ProcessEngineException</code> will be thrown if the transaction isolation level set for the database is different from the recommended one.
559+
If set to <code>true</code>, no exception will be thrown but a warning message will be logged.
560+
<p>
561+
The default value is <code>false</code>.
562+
</p>
563+
<p>
564+
<strong>Note</strong>: The <a href="{{<ref "/user-guide/process-engine/database/database-configuration.md#isolation-level-configuration" >}}">recommended transaction isolation level</a> that ensures the correct behaviour of the engine is <code>READ_COMMITTED</code>.
565+
</p>
566+
<strong>Values:</strong> <code>true</code>, <code>false</code> (Boolean).
567+
</td>
568+
</tr>
554569
<tr>
555570
<td><code>jdbcBatchProcessing</code></td>
556571
<td>Boolean</td>
@@ -1154,7 +1169,7 @@ The following is a list with the most commonly used process engine configuration
11541169
<td>String</td>
11551170
<td><a href="{{< ref "/user-guide/process-engine/history/history-cleanup.md">}}">History cleanup</a> batch window end time in the format <code>HH:mmZ</code> (Z is for RFC 822 time zone) or <code>HH:mm</code>. E.g., <code>23:00-0300</code> or <code>23:00</code>. In case <code>batchWindowEndTime</code> exceeds <code>batchWindowStartTime</code> it is considered
11561171
to be on the same date (e.g., cleanup runs each day between 20:00 and 23:00). Otherwise it is considered to be on the next calendar day (e.g., cleanup starts each
1157-
day at 20:00 and finishes the next day at 01:00). Default value is `00:00`.</td>
1172+
day at 20:00 and finishes the next day at 01:00). Default value is <code>00:00</code>.</td>
11581173
</tr>
11591174
<tr>
11601175
<td><code>mondayHistoryCleanupBatchWindowStartTime</code></td>

content/user-guide/process-engine/database/database-configuration.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,3 +174,9 @@ Most database management systems provide four different isolation levels to be s
174174
* SERIALIZABLE
175175

176176
The required isolation level to run Camunda with is **READ COMMITTED**, which may have a different name according to your database system. Setting the level to REPEATABLE READS is known to cause deadlocks, so one needs to be careful, when changing the isolation level.
177+
178+
When initializing the engine, a check is performed in order to determine if the transaction isolation level set for the database is different from the recommended one. If it is, an exception will be thrown.
179+
180+
This behaviour can be disabled by setting the `skipIsolationLevelCheck` flag to `true`. Doing this will prevent an exception from being thrown and a warning message will be logged instead.
181+
182+
[See here]({{< ref "/reference/deployment-descriptors/tags/process-engine.md#configuration-properties" >}}) for more details about this and other properties.

0 commit comments

Comments
 (0)