-
Notifications
You must be signed in to change notification settings - Fork 190
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(components/modeler): add history-time-to-live guidance.
Related to camunda/camunda-modeler#4062
- Loading branch information
Showing
4 changed files
with
48 additions
and
0 deletions.
There are no files selected for viewing
27 changes: 27 additions & 0 deletions
27
docs/components/modeler/reference/modeling-guidance/rules/history-time-to-live.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
id: history-time-to-live | ||
title: History time to live | ||
description: Reference for the `history-time-to-live` rule. | ||
--- | ||
|
||
import MarkerGuideline from "@site/src/mdx/MarkerGuideline"; | ||
|
||
<span class="badge badge--platform">Camunda 7 only</span> | ||
|
||
Each execution of a model resource (BPMN, DMN, and CMMN) generates historic data during execution that is stored in the database. In Camunda 7 [history cleanup](https://docs.camunda.org/manual/latest/user-guide/process-engine/history/) removes this historic data from the database based on a defined history time to live (HTTL). | ||
|
||
Starting [from Camunda 7.20](https://docs.camunda.org/manual/develop/update/minor/719-to-720/#enforce-history-time-to-live) you must configure HTTL must in one of the following ways: | ||
|
||
- Define HTTL per model directly in the Camunda Desktop Modeler. | ||
- Set a default HTTL via an engine configuration. | ||
- Switch off the HTTL check via an engine configuration if history cleanup is not used. | ||
|
||
## <MarkerGuideline.Info /> History time to live not configured | ||
|
||
![History time to live not configured](./img/history-time-to-live/info.png) | ||
|
||
## References | ||
|
||
- [History documentation](https://docs.camunda.org/manual/latest/user-guide/process-engine/history/) | ||
- [Camunda 7.20 migration](https://docs.camunda.org/manual/develop/update/minor/719-to-720/#enforce-history-time-to-live) | ||
- [Rule source](https://github.com/camunda/bpmnlint-plugin-camunda-compat/blob/main/rules/camunda-platform/history-time-to-live.js) |
Binary file added
BIN
+49.7 KB
...nts/modeler/reference/modeling-guidance/rules/img/history-time-to-live/info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters