KPI Matrix Reference Public

Workflows & SOPs

Reference · Workflows Workflows & SOPs The whole module, wired together. Seven end-to-end Standard Operating Procedures — from designing a scorecard to running a full review…

Guide version: r1 Module version: 1.4.0 Updated: 2026-07-22 Estimated time: 7 min 2 views
Reference · Workflows

Workflows & SOPs

The whole module, wired together. Seven end-to-end Standard Operating Procedures — from designing a scorecard to running a full review cycle, entering manual metrics, approving pay steps, and the employee's own self-check. Each names the exact screen and button for every step.

????
How to use this page. Every SOP opens with a purpose box (who does it, what must be true first), the roles involved, then a numbered click-path. New here? Do the four setup steps in Getting Started first, and skim Core Concepts so the Template → Cycle → Assignment → Score flow makes sense.

The master pipeline

Every SOP is a slice of one loop. You design the scorecard, open a period, assign people, calculate, review, and act on the result.

Design
template
Open
review cycle
Assign
employees + manual
Calculate
the engine
Review
dashboards
Act
salary steps
SOPWhoCovers
1 · Design a scorecardAdmin / HRbuild a role template, weights to 100%
2 · Run a full review cycleManager / HRcreate → assign → calculate → review → finalize
3 · Enter manual metricsReviewertype values for metrics that can't auto-compute
4 · Re-score one personManagerfix data, recalculate a single assignment
5 · Approve salary progressionsManager / HRapprove/reject step recommendations
6 · Automate with the nightly jobAdminopt cycles into auto-calculation
7 · Check your own performanceEmployeeread your KPIs profile tab

SOP 1 — Design a role scorecard (Template)

????
Purpose. Decide which metrics count for a role and how much each is weighted, so everyone in that role is scored the same way. Who. An admin/HR owner. Preconditions: the module is enabled and you hold kpi_matrix_manage.
HR AdminDepartment Head
  1. Open the builder

    KPI Matrix → Templates → Add Template. Give it a role-obvious Name and an optional Description.

  2. Pick a starting mix

    Decide from the five built-in profiles (General Staff, Technical/Developer, Customer-Facing, Management, Operations) which weight balance fits — see the profile table.

  3. Enable metrics & set weights

    In each category panel, tick the metrics you want and set the Category Weight. Skip the long tail — aim for 3–8 active drivers. Watch for the Manual badge: only enable a manual metric if you'll maintain it.

  4. Hit 100%

    Make the category weights total exactly 100% — the footer total turns from red to blue. Save.

    ⚠️
    Only category weights must total 100. Metric weights within a category are blended proportionally over whatever produced data, so they needn't pre-sum to anything.
  5. Avoid double-counting conduct

    If you enable policy_adherence, don't also give discipline_score + leave_compliance full weight — Policy Adherence already rolls those up. Pick one approach.


SOP 2 — Run a full review cycle

????
Purpose. Evaluate a team for a period end to end and produce scores + salary recommendations. Who. A manager/HR user. Preconditions: a template exists (SOP 1); the source modules (attendance, tasks, tickets, …) hold data for the period; you hold kpi_matrix_manage.
ManagerHRReviewer

The cycle lifecycle you'll drive:

Draft/Open
created
Assigned
people added
Calculating
engine runs
Review
results ready
Finalized
settled
  1. Create the cycle

    KPI Matrix → Review Cycles → Add Review Cycle. Set Name, Type (cadence), Template, and the Start/End dates of the real evaluation window. Save.

    ⚠️
    The period dates define what the engine counts — set them to the period being reviewed, not today.
  2. Assign the team

    Go to KPI Matrix → Team Matrix → Assign Employees. Pick this cycle and template, multi-select the employees, optionally a Reviewer, and click Assign. Rows appear as Pending.

  3. Enter any manual metrics

    If the template uses manual metrics, follow SOP 3 for each employee before calculating.

  4. Calculate

    Back on Review Cycles, on the Open cycle click Calculate. The engine scores every assignment; the Progress bar fills and the status advances.

    Calculate only works while the cycle is Open. If the button's missing, check the status badge.
  5. Review the results

    Read KPI Overview (distribution + top performers) and Team Matrix (per-person grid). Click any View to open a scorecard; check the Data Sufficiency bar and drill into the category breakdown.

    ℹ️
    Set anyone with a low (amber) sufficiency bar aside — new hires and long-leave staff shouldn't be ranked on thin data.
  6. Act on pay

    Go to SOP 5Recommendations — to approve or reject the salary steps the cycle produced.


SOP 3 — Enter manual metrics

????
Purpose. Supply the values for metrics the system can't measure itself (Ticket Satisfaction, Training Hours, etc.). Who. The reviewer/manager. Preconditions: the cycle is Open, the employee is assigned, and the template includes at least one Manual metric.
ReviewerManager
  1. Open the manual-entry modal

    For the assignment, open its manual entries. You'll see one row per manual metric with a Value and a Notes box.

  2. Type the raw values

    Enter each metric's value in its own unit (a 1–5 rating, a count of hours, a percentage) — not a 1–5 score; the engine normalizes it. Add notes for the evidence. Save.

    ⚠️
    Enter manual values before you calculate, or they won't be in the score. If you add them after, use SOP 4 to re-score that person.
  3. No manual metrics?

    If the modal says “No manual metrics configured for this assignment,” the template is fully automatic for this person — nothing to do.


SOP 4 — Re-score one person

????
Purpose. Fix one employee's score after correcting their data or adding a manual entry, without recalculating the whole cycle. Who. A manager. Preconditions: the assignment isn't yet marked completed.
Manager
  1. Fix the underlying data

    Correct the attendance/task/leave record in its own module, or update the manual entry.

  2. Open the assignment detail

    Team Matrix → the person's View (eye) button.

  3. Recalculate

    Click Recalculate in the modal footer. Just this employee is re-scored; the composite, rating and breakdown refresh.


SOP 5 — Approve salary progressions

????
Purpose. Turn performance ratings into pay decisions — with a human check. Who. A manager/HR approver. Preconditions: a cycle has been calculated with salary auto-trigger on; employees are on graded pay; you hold kpi_matrix_manage.
HR ManagerApprover
  1. Open the queue

    KPI Matrix → Recommendations. Filter Status → Pending.

  2. Read each proposal

    For each row check the Score, Rating, Step Change and New Salary. Cross-check against the person's scorecard if in doubt.

  3. Approve or reject

    Approve (green tick) accepts the step — it creates a draft salary-history record that still goes through payroll approval. Reject (red cross) records a reviewed “no change”. Both are audit-logged.

    ⚠️
    Approving does not pay anyone yet — it hands a draft change to payroll. Nothing skips the normal pay approval chain.
  4. Handle the flags

    Watch for manual review (no salary grade), at grade ceiling, PIP flags, and demotion-review flags — these need an HR decision, not just a click.


SOP 6 — Automate with the nightly job

????
Purpose. Have cycles score themselves the moment their period ends, instead of clicking Calculate. Who. An admin. Preconditions: the cron runner is active.
Admin
  1. Opt the cycle in

    Set a cycle's Auto-calculate flag on and leave it Open with its real end date.

  2. Confirm the job

    php erpat cron:list should show auto_calculate_kpi_cycles (runs 01:30 daily).

  3. Let it run

    After the period-end date passes, the next nightly run scores the cycle and moves it Open → Calculating → Review. You review results the next morning.

    php erpat cron:run auto_calculate_kpi_cycles   # or trigger it now

SOP 7 — Check your own performance (Employee)

????
Purpose. See your latest score, your trend, and what drove it. Who. Any employee, for themselves. Preconditions: the module is enabled and your latest cycle has been calculated.
Employee
  1. Open your profile

    Go to your own Team Member profile and click the KPIs tab.

  2. Read your score

    The big number (1–5) and its rating band are your headline. “Not yet calculated” just means the cycle hasn't run.

  3. Read your trend

    The Score Trend line shows you across cycles — direction matters more than any single period.

  4. Read the breakdown

    The Category Breakdown shows which areas lifted or lowered you. Bring it to your one-on-one. Full guide: Your Performance.


Permissions per SOP

SOPModule togglePermission
1 · Design a scorecardmodule_kpi_matrixkpi_matrix_manage
2 · Run a review cyclemodule_kpi_matrixkpi_matrix_manage
3 · Enter manual metricsmodule_kpi_matrixkpi_matrix_manage
4 · Re-score one personmodule_kpi_matrixkpi_matrix_manage
5 · Approve salary progressionsmodule_kpi_matrixkpi_matrix_manage
6 · Nightly automationmodule_kpi_matrixadmin / cron
7 · Check own performancemodule_kpi_matrixnone for self (own profile)
????
Where next? The full Permissions & Roles matrix, the API for integrations, or the FAQ when something looks off.
Was this guide helpful?

Report a content problem