Analytics & BI
Goal
Monitor business health and define KPIs that read only from approved datasets — without writing SQL. Accounting Financial Reports remain the authoritative statements.
Who it is for
Managers with analytics.view. Creating KPIs and capturing snapshots needs analytics.manage. Module: analytics_bi. Dataset listing uses accounting.view under the hood.
Preconditions
- Module analytics_bi enabled.
- Permission
analytics.view(else Dashboard redirect). - At least one approved dataset available from
GET /reports/datasetsif you want to create KPIs. - Optional admin: Analytics BI setup (
analytics.admin) for templates/settings — separate screen.
Open the screen
Reporting → Analytics & BI (path /analytics). Title: Analytics & BI. Subtitle: Dashboards, KPIs and business health over approved datasets — no SQL.
Steps
- Read Business health — numeric score and tag Healthy / Watch / At risk (
GET /analytics/health). - Review Approved datasets — KPIs and cards may query only these; ledger reports stay authoritative.
- Open the KPIs table: Name · Dataset · Target · Period. Empty: No KPIs defined yet.
- With
analytics.manage, choose New KPI. Fill Key, Name (translatable), Dataset, Aggregation (sum|count|avg|min|max), Target, Direction (higher_better|lower_better), Period (Day / Week / Month / Quarter / Year). Save → toast KPI saved. - Use the snapshot camera on a KPI (when manage-capable) → toast Snapshot captured.
Result
Health score and KPI definitions persist for the tenant. Values resolve against approved datasets only.
Hard stops
- Save without a dataset → client toast Select an approved dataset for this KPI.
- Page load failure →
common.loadError. - Missing module /
analytics.view→ Dashboard redirect. - This page is not the home Dashboard widget canvas; do not document page-widgets here.
- Export APIs (
analytics.export) and dashboard builder endpoints exist but are not the primary controls on this view.