1 Overview
KPI & Metrics is the Business Intelligence feature used to track a single measure from a dataset against a target, so its current status — on track, Warning, or Critical — is visible at a glance, optionally alongside its trend over time.
A KPI is built directly from a dataset (see Section 7) — a Measure Field is aggregated (Sum, Count, Average, Min, or Max) and compared against a Target Value, with Warning and Critical thresholds marking how far the current value can drop before it needs attention.
Navigate to: Business Intelligence → KPI & Metrics → Add KPI
Step 1 – Define the KPI
- KPI Name – descriptive name for the KPI.
- Description – what the KPI measures and its business purpose.
- Select Dataset – the dataset the KPI reads from, e.g. Sale_Invoice, SaleInvoiceandPayment, or invoices_by_client_paid.
- Measure Field – the numeric field from the selected dataset to track, e.g. total, days_to_due.
- Aggregation – how the Measure Field is summarized into a single value:
- SUM – total of all values.
- COUNT – number of records.
- AVG – average value.
- MIN – smallest value.
- MAX – largest value.
Step 2 – Trend Settings
• Time Field (Optional for Trend) – a date/datetime-type field loaded from the selected Dataset (e.g. date or duedate), used to plot the KPI's history over time. Leave it as None for a single current-value KPI with no trend chart.
• Frequency – how the trend is bucketed when a Time Field is set: Daily, Weekly, Monthly, or Yearly.
Step 3 – Target Settings
- Target Value – the value the aggregated Measure Field is compared against.
- Warning Threshold (%) – the percentage of the Target Value below which the KPI is flagged Warning.
- Critical Threshold (%) – the percentage of the Target Value below which the KPI is flagged Critical
Step 4 – Save KPI and Preview
Click Save Report to save the KPI. render the KPI card (and trend chart, if a Time Field is set) using the current settings. Opening a saved KPI from the KPI List ( Edit KPI) show the same layout as Add KPI, but the Preview panel is now populated with live data instead of the "Configure KPI settings to see preview" placeholder.
- KPI card - show the KPI Name, the current aggregated value, and a status badge - ON TRACK, WWARNING, or CRITICAL - computed by comparing the current value against Target Value and the two thresholds, plus the Target value underneath.
- Trend chart - show below the KPI card whenever a Time Field and Frequency were set; it plots the aggregated Measure Field once per period, e.g. one point per month
