Zoomed Image
USA
800 691 9120
UK
01225 704844

KPI Configuration

xAssets Configuration Guide
KPI Configuration

KPI Configuration

KPIs (Key Performance Indicators) are summary statistics displayed at the top of dashboard pages. They provide at-a-glance metrics such as total asset counts, compliance percentages, and financial totals.

KPI Display

KPIs appear as a horizontal row of large numbers across the top of dashboard pages. Each KPI shows:

  • A label describing the metric
  • A value — the current count or amount
  • Optional colour coding to indicate status (e.g., red for warnings)

For example, the Asset Inventory Dashboard shows KPIs for All Assets, Recently Created Assets, Warranty Expiring 90 Days, Assets with Health Issues, and Software Compliance.

How KPIs Are Configured

KPIs are configured through the dashboard menu category system:

  1. Each dashboard page has a menu category designated as its KPI row
  2. The KPI menu category contains menu items — each menu item becomes one KPI
  3. Each menu item runs a query that returns a single count or value
  4. The displayed number is the row count or calculated value from that query

Editing KPIs

To modify KPIs on a dashboard:

  1. Navigate to Admin > Menus > Menu Categories
  2. Find the KPI category for your dashboard (e.g., "KPI" or named with "KPI" in the category name)
  3. Edit the menu items within that category
  4. Each menu item's command property defines which query runs to calculate the KPI value

Adding a New KPI

  1. Open the KPI menu category for the target dashboard
  2. Add a new menu item
  3. Set the Name to the label text you want displayed
  4. Set the Command to a query that returns the data for counting
  5. Set the Sort Code to control the display position (lower = further left)
  6. Optionally set Formatting to control color (e.g., color:red for warning KPIs)

KPI Queries

KPIs work by running a query and displaying the resulting row count. For more sophisticated KPIs that display a calculated value rather than a count, the query can return a single row with the value in a specific column.

Common KPI patterns:

  • Count — query returns all matching rows, KPI displays the count (e.g., "48 All Assets")
  • Percentage — query calculates a percentage using SQL (e.g., "11% Software Compliance")
  • Currency — query returns a financial total (e.g., "£1,234,567 Total Asset Value")

Tip: KPI queries should be fast. Because KPIs run every time the dashboard loads, slow queries will make the dashboard feel sluggish. Keep KPI queries simple and avoid complex joins or large result sets where possible.

Tip: To make a KPI clickable so users can drill down to the underlying data, configure the KPI menu item's command to also open the full query when clicked.