Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt

Use this file to discover all available pages before exploring further.

The Data Retention page (/settings/data-retention) provides controls for defining how long different data types are kept, placing legal holds to prevent data deletion, and reviewing the history of lifecycle events across the organisation.

​
Overview

The page is gated at the route level by pf.data-retention.manage. It renders three tabs: Retention Policies, Legal Holds, and Lifecycle Events. The Retention Policies tab uses useRetentionPolicies and shows each policy’s entity type, scope (global or organisation), retention period in human-readable form, action (archive or delete), and active status. The Legal Holds tab uses useLegalHolds and supports scope at the organisation, entity-type, or specific record level. The Lifecycle Events tab uses useLifecycleEvents to display an immutable audit trail of archived, deleted, hold_placed, and hold_removed events. CRUD operations on policies and holds require pf.data-retention.manage and pf.legal-holds.manage respectively, enforced by inner PermissionGate guards around the action buttons.

​
Who it’s for

Requires permission pf.data-retention.manage. Legal hold mutations also require pf.legal-holds.manage.

​
Before you start

  • You must hold pf.data-retention.manage to access this page.
  • Consult legal and compliance teams before creating, modifying, or removing policies or holds.

​
Steps

1

Open Data Retention

Navigate to /settings/data-retention. The Retention Policies tab is active by default.
2

Add or edit a retention policy

On the Retention Policies tab, click Add Policy (requires pf.data-retention.manage). Fill in the entity type, scope, retention period, and action in the RetentionPolicyDialog.
3

Manage legal holds

Switch to the Legal Holds tab. Click Place Legal Hold to open LegalHoldDialog and specify the scope. To release an active hold, click Remove on the hold row.
4

Review lifecycle events

Switch to the Lifecycle Events tab to see a read-only audit trail of archival, deletion, and hold events with timestamps and reasons.

​
Key concepts

A global scope applies the policy across all organisations (platform-wide). An organisation-scoped policy applies only to the current organisation.
Events are written by platform processes when retention actions execute or holds change. This tab is read-only and cannot be edited.

Platform Foundation

Platform Foundation overview.

Governance & parity

Documentation coverage and governance.
This page documents shipped product behavior. It is not medical, legal, or billing advice. Verify against your organization’s policies and applicable regulations before using it for clinical, compliance, or billing decisions. Protected health information (PHI) shown in the product is governed by your tenant’s access controls and is never exposed in this documentation.
  • src/routes/platform.tsx
  • src/platform/data-retention/pages/DataRetentionPage.tsx
  • src/platform/data-retention/index.ts