1. Overview
The Evaluation module runs organizational performance cycles: behavioral criteria, MBO objectives, KPIs, cycle setup, supervisor scoring, review, final approval, results, reports, and dashboards.
| Area | Capabilities |
|---|---|
| Catalog | Behavioral criteria, job objectives, KPI master |
| Forms | Behavioral templates and MBO templates linked to HR job grades |
| Cycles | Periods, departments, templates by grade, reviewers, exceptions, notifications, schedules |
| Execution | Supervisor scoring, submit, review, return/reject, final approve |
| Insights | Results, reports, dashboards |
This module is supervisor-led, not 360-degree or employee self-scoring. (My evaluations) is the direct supervisor worklist for subordinates. Employees see (Results) after final approval.
There is no calibration / forced-ranking stage in the current product.
Cross-module note: Cycles and templates depend on HR departments, job grades, employees, and user–person links. Cycle notifications can use Communication (in-app and email). Approved scores can be exported for payroll/finance use; there is no automatic Finance posting consumer yet.
2. Getting started
2.1 Recommended setup order
- Prepare HR data: departments, job grades, employees, managers on assignments, and user ↔ Person links.
- Assign Evaluation permissions or seeded roles (direct supervisor, reviewer, final approver).
- Create and activate behavioral criteria.
- Build behavioral templates (weights sum to 100) and link JobGrade categories.
- Create job objectives, then MBO templates (with optional KPI links).
- Maintain KPIs if individual/collective indicators are required.
- Create a cycle: templates by category, departments, reviewer chain, notifications → schedule or activate.
- Supervisors score in My evaluations and submit for review.
- Reviewers complete, return, or reject; final approvers approve.
- Use Results, Reports, and Dashboards for follow-up.
2.2 Main navigation
| Menu | Path | Purpose |
|---|---|---|
| Behavioral criteria | /evaluation/criteria |
Criterion library |
| Behavioral templates | /evaluation/behavioral-templates |
Behavior forms |
| Job objectives | /evaluation/objectives |
Objective library |
| MBO templates | /evaluation/mbo-templates |
Objectives forms |
| Evaluation cycles | /evaluation/cycles |
Periods and lifecycle |
| My evaluations | /evaluation/my-evaluations |
Supervisor worklist |
| Review queue | /evaluation/review |
Reviewer queue |
| Final approval | /evaluation/final-approval |
Final approver queue |
| Browse evaluations | /evaluation/browse |
Search evaluations |
| Results | /evaluation/results |
Approved results view |
| KPIs | /evaluation/kpis |
KPI master and measurements |
| Reports | /evaluation/reports |
Operational reports |
| Dashboards | /evaluation/dashboards |
Monitoring boards |
2.3 Seeded roles
| Role | Focus |
|---|---|
| EvaluationDirectSupervisor | Execute |
| EvaluationReviewer | Review (+ Execute) |
| EvaluationFinalApprover | FinalApprove + Results (+ Execute) |
Admin can receive all Evaluation permissions via seed.
2.4 Actor identity
Evaluators must be linked to an HR person profile. Without a valid PersonId, scoring and review actions fail with a profile-required style error.
3. Behavioral criteria
Path: /evaluation/criteria
Permission: Evaluation.Criteria (+ Create / Update / Delete / Activate)
Purpose
Reusable behavioral standards used inside behavioral templates.
Key points
| Topic | Guidance |
|---|---|
| Classification | Categories come from seeded lookups (for example behavioral, communication) |
| Status | Active / Inactive |
| Usage | Check usage before deactivating criteria used by templates |
Create criteria first; templates reference them. Prefer Activate over delete when a criterion has history.
4. Behavioral templates
Path: /evaluation/behavioral-templates
Permission: Evaluation.Templates
Purpose
Forms that group criteria with weights and a rating scale, then link to HR JobGrade categories so cycles can assign the right form per grade.
Scales
Five-point, ten-point, numeric, or descriptive.
Template statuses
Draft → Active → Inactive. Copy is available for reuse.
Rules of thumb
- Sum of criterion weights should equal 100.
- Link the template to the JobGrade categories that will use it.
- Activate before assigning the template on a cycle.
5. Job objectives
Path: /evaluation/objectives
Permission: Evaluation.Objectives
Purpose
Library of job objectives later placed on MBO templates.
| Attribute | Examples |
|---|---|
| Type | Personal, Administrative, Strategic, Training |
| Direction | Increase or Decrease |
| Unit | Percent, Count, Amount, Duration, Descriptive |
| Source | Internal, External, Strategic |
| Frequency | Monthly, Quarterly, Semi-annual, Annual, On demand |
Objectives are owned by Evaluation (not an external OKR product).
6. MBO templates
Path: /evaluation/mbo-templates
Permission: Evaluation.Templates
Purpose
Objectives forms: selected job objectives, optional per-objective KPIs, axis weight, and JobGrade category links.
Setup tips
- Pick objectives from the library.
- Attach KPIs where measurement is required.
- Align axis weight with the behavioral axis weight configured on the cycle.
- Activate before cycle assignment.
Together, behavioral + MBO templates form the two scoring axes of an evaluation.
7. KPIs
Path: /evaluation/kpis
Permission: Evaluation.Kpis (+ Create / Update / Delete / Activate / Export)
Purpose
Individual or collective performance indicators, with versioning when already in use, department/position assignments, and period measurements.
| Status | Meaning |
|---|---|
| Draft | Not ready for cycles |
| Active | Usable |
| Inactive | Withdrawn |
| Deleted | Soft-removed |
Collective assignment/measurement menu labels may exist in localization without separate dedicated pages; manage assignments and measurements from the KPIs area and APIs.
8. Evaluation cycles
Path: /evaluation/cycles
Permission: Evaluation.Cycles (+ Schedule / Cancel / ViewDetails / Export)
8.1 Wizard steps (typical)
- Basic data (name, type, dates)
- Categories and templates (behavioral + MBO per JobGrade, axis weights)
- Departments in scope
- Reviewers and employee exceptions
- Notifications
- Review and save
Cycle types: Monthly, Quarterly, Semi-annual, Annual, Custom.
8.2 Cycle statuses
| Status | Meaning |
|---|---|
| Draft | Editable setup |
| Scheduled | Waiting to start |
| Active | Evaluations generated; scoring open |
| Suspended | Temporarily paused |
| Closed | Finished |
| Cancelled | Stopped |
Closed and Cancelled cycles are not editable.
8.3 Activation
Activating a cycle generates one evaluation record per employee in the selected departments, applying include/exclude exceptions and any custom template overrides.
8.4 Reviewer roles on the cycle
| Role | Duty |
|---|---|
| DirectSupervisor | Score and submit |
| Reviewer | Complete review, return, or reject |
| FinalApprover | Final approve |
8.5 Exceptions and notifications
- Exceptions can include/exclude employees or apply specific templates/categories.
- Notification rules are stored per cycle; a background worker dispatches in-app and email notifications where Communication is available.
- Recurring schedules can be previewed and managed from the cycles UI (schedule modal).
9. Execute evaluations
Path: /evaluation/my-evaluations
Permission: Evaluation.Execute
Important naming note
My evaluations means evaluations the direct supervisor must fill for their team — not employee self-evaluation.
Scoring model
- Score behavioral criteria on the assigned scale.
- Enter objective results (and KPI actuals when linked).
- System computes a composite score from behavior axis × weight + objectives axis × weight.
- Composite maps to a performance band.
Completion must reach 100% before submit.
Evaluation statuses
| Status | Editable scores |
|---|---|
| Draft | Yes |
| UnderReview | No |
| Returned | Yes |
| Completed | No |
| Approved | No |
| Rejected | Yes |
Supervisor procedure
- Open My evaluations for the active cycle.
- Fill behavioral and MBO/KPI sections.
- Save draft as needed.
- Submit for review when completion is 100%.
Browse (/evaluation/browse) also requires Execute and supports searching evaluations in scope.
10. Review queue
Path: /evaluation/review
Permission: Evaluation.Review
Reviewers process items in UnderReview:
| Action | Result |
|---|---|
| Complete review | Status → Completed (moves to final queue) |
| Return | Status → Returned (supervisor edits again) |
| Reject | Status → Rejected (reason required) |
Scores stay frozen while UnderReview. After return or reject, the supervisor can edit and resubmit.
11. Final approval
Path: /evaluation/final-approval
Permission: Evaluation.FinalApprove
Final approvers act on Completed evaluations and move them to Approved.
After approval:
- Employees with Results permission can see their outcomes.
- Reports and dashboards can include approved performance data.
- Approved scores are available for finance-oriented export endpoints.
12. Browse and results
| Screen | Path | Permission | Audience |
|---|---|---|---|
| Browse | /evaluation/browse |
Execute | Supervisors/admins searching evaluations |
| Results | /evaluation/results |
Results | Viewing approved outcomes |
13. Reports and dashboards
Reports
Path: /evaluation/reports
Permission: Evaluation.Reports (+ Export)
Role-scoped catalog includes types such as:
| Report | Focus |
|---|---|
| Individual results | Per-employee outcomes |
| Department summary | Department rollup |
| Category summary | Job-grade / category view |
| Cycle progress | Cycle completion |
| Incomplete evaluations | Outstanding work |
| Performance distribution | Level bands |
| Objective achievement | MBO attainment |
| KPI status / KPI performance | Indicator health |
| Exception employees | Cycle exceptions |
| Cycle comparison / Annual trend | Multi-cycle insight |
| Training gaps / Compliance | Follow-up themes |
| Top / bottom performers | Ranking lists |
Export formats: CSV, XLSX, PDF when Export is granted.
Dashboards
Path: /evaluation/dashboards
Permission: Evaluation.Dashboards
Typical boards:
- Main dashboard
- Cycle completion rate
- Performance level distribution
- Top and bottom performers
Insight scope follows the signed-in evaluation role.
Settings not on the main menu
| Topic | Status |
|---|---|
| Lookups admin UI | Route may redirect; seeded lookups used at runtime |
| Performance level bands | Configurable via API; no dedicated menu screen |
| Self-evaluation / calibration | Not implemented |
14. Permissions summary
Permission group: Evaluation.
| Area | Permissions |
|---|---|
| Criteria | Default, Create, Update, Delete, Activate |
| Templates | Default, Create, Update, Delete, Activate |
| Objectives | Default, Create, Update, Delete |
| Cycles | Default, Create, Update, Delete, Schedule, Cancel, ViewDetails, Export |
| Execute | Supervisor worklist, browse, scoring, submit |
| Review | Review queue actions |
| FinalApprove | Final approval queue |
| Results | Approved results |
| Kpis | Default, Create, Update, Delete, Activate, Export |
| Reports | Default, Export |
| Dashboards | Default |
| Lookups | Default, Create, Update, Delete |
Parent menu opens when any of the listed Evaluation policies is granted.
Appendix A — Quick procedures
A.1 Launch a new cycle
- Activate behavioral and MBO templates for the required JobGrade categories.
- Create cycle → assign templates and axis weights → select departments.
- Set DirectSupervisor / Reviewer / FinalApprover chain.
- Configure notifications and exceptions.
- Activate → confirm evaluations were generated.
A.2 Complete one employee evaluation
- Supervisor opens My evaluations → scores → submit.
- Reviewer completes review.
- Final approver approves.
- Confirm Results shows Approved.
A.3 Return for correction
- Reviewer chooses Return.
- Supervisor edits in Returned status.
- Resubmit → review again → final approve.
A.4 Pause a running cycle
- Suspend the Active cycle.
- Resume when ready, or Cancel if the cycle must stop.
Appendix B — Operating notes
| Topic | Guidance |
|---|---|
| My evaluations | Supervisor worklist only — not self-eval |
| Person link | Users need HR PersonId to act as evaluators |
| Weights | Template criterion weights and cycle axis weights must be coherent |
| Freeze | Scores locked in UnderReview, Completed, Approved |
| Reject | Requires a reason |
| Communication | Notifications depend on Communication/email availability |
| Finance | Use report/approved-score export; no auto GL sync yet |
| Calibration | Out of scope in current release |
Appendix C — Document control
| Item | Value |
|---|---|
| Title | Evaluation Module User Guide |
| Source of truth | modules/evaluation and frontend/src/app/modules/evaluation |
| Format | Markdown + Mermaid (PDF edition embeds rendered figures) |
| Screenshots | Not included (by design) |
This guide describes functional capabilities of the Evaluation module as implemented in the Vertext ERP codebase. UI labels may appear in English or Arabic depending on language settings.