Performance Tracker

Tracking — Scheduled KPI data fetches for contract performance monitoring
🎯 Purpose

The Performance Tracker module monitors KPI metrics over time and displays trend charts with target lines and variance analysis directly on contracts. Unlike SLAs (which produce a point-in-time RAG status), Performance Trackers show the historical trajectory — whether metrics are improving, degrading, or stable. This supports data-driven contract reviews and renewal decisions.

👤 Roles & Access
RoleAccess
AdminFull access — create, edit, delete trackers. Configure schedules.
Super UserCreate and edit trackers. Assign to contracts.
End UserView trend charts on contracts they can see.
CustomerNo access.
SupplierNo access.
🔗 Dependencies
Upstream (requires)
KPIs must exist (with Data Connector). Active contract to assign the tracker to.
Downstream (feeds into)
Contract — Trend charts are embedded in the contract detail view.
🚀 Related Flows
Performance Tracking — Steps 3–4 — tracker is configured and linked to contract.

1. Overview

The Performance Tracker module defines scheduled data fetches that pull KPI metric values from external databases and store the results for viewing in the contract's Performance Tracking tab. Each Performance Tracker links a KPI to a computation method and a schedule, creating a recurring data pipeline that feeds performance data into contracts.

How It Works

  1. Admin creates a Performance Tracker by selecting a KPI and a Compute method.
  2. A Schedule is configured to define how often data is fetched.
  3. On each scheduled run, the system reads data from the KPI's Data Connector, applies the Compute method, and stores the result.
  4. The results appear in the contract's Performance Tracking tab for monitoring and trend analysis.

Prerequisites

2. Performance Tracker Listing

  1. In the left navigation, under Tracking, click Performance Tracker.
  2. The listing shows all Performance Trackers with their Name and linked KPI.
  3. Use the filter dropdowns and Search button to locate a tracker.
  4. Click Add Performance Tracker to create a new one.
Performance Tracker Listing

Performance Tracker Listing

2.1 Listing Columns

ColumnDescription
NameThe Performance Tracker name.
KPIThe KPI this tracker is linked to.

3. Adding a Performance Tracker

  1. On the Performance Tracker listing, click Add Performance Tracker.
  2. Enter a Name (required) — a descriptive name for this tracker (e.g. "Docman External", "Daily Delivery Count").
  3. Click the Schedule button to configure how often the system fetches and computes data. See the Schedule Configuration section for full details on scheduling options (interval, daily, weekly, monthly, yearly).
  4. Enter a Description — optional notes about the tracker.
  5. Select a KPI (required) — the KPI whose data source this tracker reads from. The KPI determines which Data Connector and metric field are used.
  6. Select a Compute method (required) — the computation to apply to the KPI's data. The dropdown lists the columns available from the KPI's Data Connector table in two forms:
    • Column name (e.g. "Deliveries") — fetches individual/raw values from the column. Each scheduled run records the current value as a data point.
    • Sum-Column name (e.g. "Sum-Deliveries") — aggregates (sums) all values in the column. Each scheduled run records the cumulative total, producing a growing trend line over time.
  7. Click Save.
Performance Tracker

Performance Tracker

3.1 Form Fields

FieldRequiredDescription
NameYesA descriptive name for the Performance Tracker.
ScheduleButton to configure the data fetch frequency. Uses the same Schedule popup as SLA and other modules.
DescriptionNoFree text description.
KPIYesThe KPI to track. Dropdown lists all KPIs created in the KPI module.
ComputeYesThe computation method. Lists each column from the KPI's Data Connector table in two forms: raw (individual values per fetch) and Sum (cumulative aggregation). For example, "Deliveries" tracks each fetch as a separate value, while "Sum-Deliveries" tracks a running total.

4. How Performance Tracker Connects to Other Modules

The Performance Tracker sits in a data pipeline that flows from external databases to contract-level performance views:

StepModuleWhat Happens
1Data ConnectorDefines the external database, database instance, and table to read from.
2KPIDefines which column (metric field) to measure and optional filters.
3Performance TrackerApplies a Compute method and runs on a schedule to fetch and store data.
4Contract → Performance Tracking tabDisplays the tracked results for monitoring and trend analysis.

5. Tips

6. Troubleshooting

IssueResolution
KPI dropdown is emptyNo KPIs have been created. Navigate to Tracking → KPI and create at least one.
Compute dropdown is emptySelect a KPI first — the Compute options are derived from the KPI's Data Connector table columns.
No data appearing in contract PT tabCheck the Schedule is configured and the tracker is within its active period. Verify the KPI's Data Connector is connected and the table has data.
Tracker not running on scheduleEnsure the Schedule is configured (click the Schedule button and submit). Check with the system administrator if the scheduler service is running.