Skip to content

Commit a95f47f

Browse files
committed
Update README Documentation; add Case Retention Info
1 parent ebe3c70 commit a95f47f

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -439,6 +439,26 @@ How to use icon: <i class="fp-my-jonas-custom-icon" />
439439
npm run dev-font
440440
```
441441

442+
# Case Retention Tier (CASE_RETENTION_TIER)
443+
444+
The case retention policy controls how long cases are stored before they are automatically and permanently deleted. The **CASE_RETENTION_TIER** environment variable determines which retention periods customers can select when configuring a process. Each tier exposes a different set of options in the UI; options for higher tiers are visible but disabled so users see what is available at higher tiers.
445+
446+
### Supported tiers
447+
448+
| Tier | Retention options available |
449+
|------|----------------------------|
450+
| **1** | Six months, One year |
451+
| **2** | Six months, One year, Three years |
452+
| **3** | Six months, One year, Three years, Five years |
453+
454+
Set the variable in your `.env` file:
455+
```env
456+
CASE_RETENTION_POLICY_ENABLED=true
457+
CASE_RETENTION_TIER=1
458+
```
459+
Use `1`, `2`, or `3`. The default is `1` if not set. The default retention period shown in the UI for Tier 1 is one year.
460+
461+
442462

443463
# Prometheus and Grafana
444464

0 commit comments

Comments
 (0)