Skip to content

Commit

Permalink
feat(components/modeler): add history-time-to-live guidance.
Browse files Browse the repository at this point in the history
  • Loading branch information
toco-cam authored and nikku committed Feb 26, 2024
1 parent f209c92 commit bc73ce1
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 0 deletions.
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)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/components/modeler/reference/sidebar-schema.js
Original file line number Diff line number Diff line change
Expand Up @@ -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",
],
},
Expand Down
20 changes: 20 additions & 0 deletions src/mdx/MarkerGuideline.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,27 @@ export const Valid = () => {
);
};

export const Info = () => {
return (
<svg
className="guideline-mark"
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 32 32"
>
<path
fill="white"
d="M16 8a1.5 1.5 0 11-1.5 1.5A1.5 1.5 0 0116 8zm4 13.875h-2.875v-8H13v2.25h1.875v5.75H12v2.25h8z"
/>
<path
fill="#4589ff"
d="M16 2a14 14 0 1014 14A14 14 0 0016 2zm0 6a1.5 1.5 0 11-1.5 1.5A1.5 1.5 0 0116 8zm4 16.125h-8v-2.25h2.875v-5.75H13v-2.25h4.125v8H20z"
/>
</svg>
);
};

export default {
Valid,
Invalid,
Info,
};

0 comments on commit bc73ce1

Please sign in to comment.