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 Document Analytics dashboard (/documents/analytics) displays aggregated metrics for all documents in the organisation — including count by category and status, total storage, version counts, and documents expiring soon or already expired.

​
Overview

The page is gated by pf.documents.analytics-view, enforced inside useDocumentAnalytics — the hook returns hasPermission: false when the user lacks the permission and the component renders an access-denied message. When data is available, four summary cards show total document count (with version count), storage usage (formatted from bytes), documents expiring within 30 days, and the count of already-expired documents. Two charts follow: a pie chart of documents by category and a bar chart of documents by status, both rendered using Recharts with CSS variable-based theme colours.

​
Who it’s for

Requires permission pf.documents.analytics-view.

​
Before you start

  • You must hold pf.documents.analytics-view.
  • Analytics are calculated across all documents visible to the current organisation.

​
Steps

1

Open Document Analytics

Navigate to /documents/analytics. The dashboard loads four summary cards and two charts automatically.
2

Review summary cards

Check total document count, storage usage, expiring soon, and expired counts.
3

Analyse by category

The Documents by Category pie chart breaks down the document library by category type.
4

Analyse by status

The Documents by Status bar chart shows counts for each document status (draft, in_review, published, archived, etc.).
5

Act on expiring or expired documents

Navigate to the Documents library to locate expiring or expired documents and take appropriate action.

​
Key concepts

Statuses tracked include draft, in_review, published, archived, pending_approval, approved, and rejected.
Total storage is the sum of total_storage_bytes across all documents and is displayed in human-readable units (B, KB, MB, GB).
“Expiring Soon” counts documents with an expiry date within 30 days of today. “Expired” counts documents past their expiry date.

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/documents/pages/DocumentAnalyticsDashboard.tsx
  • src/platform/documents/hooks/useDocumentAnalytics.ts