diff --git a/docs/components/modeler/reference/modeling-guidance/rules/history-time-to-live.md b/docs/components/modeler/reference/modeling-guidance/rules/history-time-to-live.md new file mode 100644 index 00000000000..f2a07137e9f --- /dev/null +++ b/docs/components/modeler/reference/modeling-guidance/rules/history-time-to-live.md @@ -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"; + +Camunda 7 only + +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. + +## 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) diff --git a/docs/components/modeler/reference/modeling-guidance/rules/img/history-time-to-live/info.png b/docs/components/modeler/reference/modeling-guidance/rules/img/history-time-to-live/info.png new file mode 100644 index 00000000000..e6ea38f401f Binary files /dev/null and b/docs/components/modeler/reference/modeling-guidance/rules/img/history-time-to-live/info.png differ diff --git a/docs/components/modeler/reference/sidebar-schema.js b/docs/components/modeler/reference/sidebar-schema.js index cb68b4f4b55..ba92ccaf0ad 100644 --- a/docs/components/modeler/reference/sidebar-schema.js +++ b/docs/components/modeler/reference/sidebar-schema.js @@ -13,6 +13,7 @@ module.exports = { "components/modeler/reference/modeling-guidance/rules/error-reference", "components/modeler/reference/modeling-guidance/rules/escalation-reference", "components/modeler/reference/modeling-guidance/rules/feel", + "components/modeler/reference/modeling-guidance/rules/history-time-to-live", "components/modeler/reference/modeling-guidance/rules/message-reference", ], }, diff --git a/src/mdx/MarkerGuideline.js b/src/mdx/MarkerGuideline.js index d364fa7baea..c70dbfaae05 100644 --- a/src/mdx/MarkerGuideline.js +++ b/src/mdx/MarkerGuideline.js @@ -35,7 +35,27 @@ export const Valid = () => { ); }; +export const Info = () => { + return ( + + + + + ); +}; + export default { Valid, Invalid, + Info, };