Review Campaigns Module Documentation
Comprehensive documentation for the Neobrain Performance Review Campaigns system.
Overview
The Review Campaigns module is a complete performance evaluation system that enables organizations to conduct structured performance reviews. It supports multi-phase review workflows, customizable forms, multilingual content, and distinct experiences for HR administrators, managers, and employees.
What This Module Does
┌─────────────────────────────────────────────────────────────────┐
│ REVIEW CAMPAIGNS SYSTEM │
├─────────────────────────────────────────────────────────────────┤
│ │
│ HR/ADMIN creates campaigns │
│ ├── Defines timeline and phases │
│ ├── Builds review forms (questions, sections) │
│ ├── Assigns participants │
│ └── Monitors progress │
│ │
│ EMPLOYEES complete reviews │
│ ├── Self-evaluation phase │
│ ├── View manager feedback │
│ ├── Interview day discussion │
│ └── Sign and submit │
│ │
│ MANAGERS evaluate teams │
│ ├── Review employee self-assessments │
│ ├── Complete evaluations │
│ ├── Conduct interviews │
│ └── Finalize reviews │
│ │
└─────────────────────────────────────────────────────────────────┘
Key Concepts
| Concept | Definition |
|---|---|
| Campaign | A performance review initiative with defined dates, participants, and forms |
| Review | An individual evaluation instance for one employee |
| Phase | A stage in the review lifecycle (self-evaluation, reviewer evaluation, interview) |
| Form | The questionnaire structure with sections and questions |
| Section | A logical grouping of related questions within a form |
| Participant | A person involved in a review (employee being reviewed or evaluator) |
Review Lifecycle
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
│ │ │ │ │ │ │ │
│ SELF-EVALUATION │ ──▶ │ REVIEWER │ ──▶ │ INTERVIEW │ ──▶ │ COMPLETED │
│ │ │ EVALUATION │ │ DAY │ │ │
│ │ │ │ │ │ │ │
└─────────────────┘ └─────────────────┘ └─────────────────┘ └─────────────────┘
│ │ │ │
Employee Manager Both Both
completes evaluates discuss & sign &
self-review employee compare finalize
Documentation Structure
For HR Administrators
| Document | Description |
|---|---|
| Core Concepts | Fundamental concepts and terminology |
| Campaign Management | Creating and managing review campaigns |
| Form Builder | Building review questionnaires |
| Participant Management | Managing reviewees and evaluators |
| Monitoring & Reports | Tracking progress and generating reports |
For Employees & Managers
| Document | Description |
|---|---|
| My Reviews (Employee) | Completing self-evaluations |
| Team Reviews (Manager) | Evaluating direct reports |
| Interview Day | The interview phase experience |
| Review Completion | Finalizing and signing reviews |
Reference
| Document | Description |
|---|---|
| Best Practices | Recommendations for effective reviews |
| Common Mistakes | Pitfalls to avoid |
| Quick Reference | Cheat sheets and quick guides |
User Roles
HR Administrator
- Full access to all campaign functions
- Can create, edit, and delete campaigns
- Manages all participants across campaigns
- Views all reviews and analytics
Manager / Evaluator
- Evaluates assigned team members
- Completes reviewer assessments
- Conducts interview discussions
- Can add secondary reviewers (during evaluation phase)
Employee
- Completes self-evaluations
- Views manager feedback (based on visibility settings)
- Participates in interview day
- Signs and submits final reviews
Campaign Statuses
| Status | Description | Visual |
|---|---|---|
| Not Started | Campaign scheduled but not yet active | Gray badge |
| In Progress | Campaign is currently active | Orange badge |
| Completed | All reviews finished | Green badge |
| Cancelled | Campaign was stopped | Red badge |
Participant Statuses
| Status | Description |
|---|---|
| Not Started | Participant hasn't begun their part |
| In Progress | Participant is actively completing the form |
| Standby | Participant has submitted, waiting for next phase |
| Done | Participant has fully completed and/or signed |
Supported Languages
The Review Campaigns module supports multilingual forms:
| Code | Language |
|---|---|
en | English (default) |
fr | French |
Additional languages can be configured per campaign.
Getting Started
As HR Administrator
- Create a Campaign → Campaign Management
- Build the Review Form → Form Builder
- Add Participants → Participant Management
- Monitor Progress → Monitoring & Reports
As Employee
- Check My Reviews → My Reviews (Employee)
- Complete Self-Evaluation → My Reviews (Employee)
- Attend Interview → Interview Day
- Sign Review → Review Completion
As Manager
- View Team Reviews → Team Reviews (Manager)
- Complete Evaluations → Team Reviews (Manager)
- Conduct Interviews → Interview Day
- Finalize Reviews → Review Completion
Screenshots
Screenshots for each section are stored in the screenshots/ folder:
- Campaign list and detail views
- Form builder interface
- Employee review experience
- Manager evaluation experience
- Interview day interface
Version Information
| Item | Value |
|---|---|
| Documentation Version | 1.0 |
| Last Updated | 2024 |
| Application Framework | React 19, TypeScript |
| Design System | Neobrain |
Related Documentation
- User Management Documentation - Users, Groups, Roles, Permission Scopes
Need Help?
- Start with Core Concepts for fundamental understanding
- Check Quick Reference for step-by-step guides
- Review Common Mistakes for troubleshooting