Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

3324 retro review #3414

Merged
merged 2 commits into from
Mar 12, 2024
+5 −3
Merged

3324 retro review #3414

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff5462c
style(formatting): technical review 3324
christinaausley Mar 5, 2024
7965a40
clarify screenshot
christinaausley Mar 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/components/modeler/reference/modeling-guidance/rules/history-time-to-live.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,20 @@ 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).
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 in one of the following ways:
From [Camunda 7.20](https://docs.camunda.org/manual/develop/update/minor/719-to-720/#enforce-history-time-to-live) onwards, you must configure HTTL in one of the following ways:

- Define HTTL per model directly in the Camunda Desktop Modeler.
- Define HTTL per model directly in 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)

In the screenshot above, note that the time to live must be defined under **History cleanup** in the properties panel.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For accessibility purposes and to explain the screenshot, I added the following sentence. WDYT @toco-cam ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@christinaausley It is unfortunately not that easy, as there are three options to set the HTTL which are valid (Listed above the pic):

  • Define HTTL per model directly in 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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Who added the screenshot? The screenshot and your text only make sense for this bullet point "Define HTTL per model directly in Desktop Modeler."

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @toco-cam -- this is actually based on your PR, if you'd like to make additional changes.

Copy link
Member

@toco-cam toco-cam Mar 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @christinaausley, ok, now it makes sense to me - all modeling guidance does have a screenshot displaying how the linting looks in the Modeler.

None of the other guidance has a caption - I would recommend not having one here, neither.


## References

- [History documentation](https://docs.camunda.org/manual/latest/user-guide/process-engine/history/)
Expand Down
Loading