src/pages/appraisal/README.md

Employee Appraisal Module

This folder contains all the pages for the Employee Appraisal Module of the PM Tool.

Module Pages

1. my-appraisals.tsx - Displays a list of the employee's own appraisals
2. appraisal-view.tsx - Detailed view for a single appraisal
3. cycles.tsx - Manage appraisal cycles (Admin/HR only)
4. assessment-areas.tsx - Manage assessment areas (Admin/HR only)
5. competencies.tsx - Manage competencies (Admin/HR only)
6. manager-dashboard.tsx - Dashboard for managers to review team appraisals
7. role-questions.tsx - Manage role assessment questions (Admin/HR only)
8. hr-remarks.tsx - Manage HR remarks (HR only)
9. management-remarks.tsx - Manage management remarks (Management/HR only)

Requirements

The appraisal module requires these features to be added to the database:

• Feature ID 28: My Appraisals
• Feature ID 29: Appraisal Cycles
• Feature ID 30: Assessment Areas
• Feature ID 31: Competencies
• Feature ID 32: Manager Appraisals
• Feature ID 36: Role Assessment Questions
• Feature ID 37: HR Remarks
• Feature ID 38: Management Remarks

Adding Features

To ensure all required features exist in the database, either:

1. Navigate to the Features page in the admin panel and click "Add Appraisal Features"
2. Run the script add-appraisal-features.js located in the scripts directory

Roles and Permissions

• All employees can access "My Appraisals"
• HR and HR Manager roles can access all features
• Managers can access relevant appraisals for their teams

Troubleshooting

If the sidebar is not visible when navigating to appraisal pages, verify that:

1. The pages are using the proper layout structure with Header and Sidebar components
2. The navigation paths are correct (should be /appraisals/... not /appraisal/...)
3. The required features exist in the database

Workflow

1. Admin/HR creates appraisal cycles
2. Appraisals are assigned to employees with their managers
3. Employees fill out self-assessment and submit
4. Managers review and provide feedback
5. HR finalizes the appraisal
6. Final report can be downloaded