The job of this console
Publish retention for each family, place a hold when legal asks, and understand what purge will touch before it runs. Coordinate with jobs that actually execute purge.
Admin · Compliance
Data Retention
Retention schedules, purge windows, and compliance holds for operational records.
Scroll to Flowcharts. Scenario: Set a retention schedule.
Keep, hold, purge
Schedules and legal holds on operational records
Data retention is the schedule of keep windows, purge eligibility, and compliance holds for operational records. A hold freezes purge; it does not freeze the live business record from legitimate edits.
Admin → Data retention
Route
/admin/data-retention
Org flag dataRetentionEnabled
HR Admin · Org Admin
Seat at the table
Administrators with compliance duty. Employees never set their own retention. Developers do not add ad-hoc deletes that bypass these windows.
The working rhythm
Open a family, set the window, save, place or lift a hold, then confirm scheduled jobs. Spot-check audit after a purge window elapses.
Moments that bring you here
A litigation hold. GDPR-style deletion request that still must respect a hold. After a new module starts writing records with no schedule. Year-end policy review.
ⓘ
Holds beat purge
A compliance hold keeps records even when the calendar says they are eligible. Jobs honor this console; do not script around it.
Flowcharts
1 — Update a retention schedule
Pick an entity family, set the window, then save.
flowchart TD
A[Open Data retention] --> B[Select a schedule]
B --> C[Set window / hold]
C --> D[Save]
D --> E[Jobs honor schedule]
E --> F[Audit the change]
- 1Open Data retentionAdmin → Data retention.
- 2Select a familyTimesheet, audit, documents, and related records.
- 3Set windowRetention days plus optional legal hold.
- 4Confirm jobsScheduled jobs execute purge — do not delete by hand.
Overview
Retention is policy over existing source tables. It does not introduce a parallel archive of business truth.
How to use
1. Legal holds first
Holds block purge even when the window elapsed.
2. Pair with compliance export
Export evidence before shortening a window.
3. Do not purge production blindly
Preview job impact on Scheduled jobs.