Configuration Guide
This guide walks you through the complete setup process for Leave Management. Follow these steps in order to properly configure leave policies for your organization.
You must have SYSADMIN role to configure leave management settings. Ensure the Attendance Management module is enabled in your organization's marketplace.
Step 1: Enable the Module
Navigate to Marketplace
Go to your organization dashboard and click on Marketplace in the sidebar.
Find Attendance Management
Locate the Attendance Management module in the list.
Enable the Module
Click the Enable button. The module will appear in your sidebar immediately.
Step 2: Create Leave Categories
Leave categories define the types of leave available. Common examples include:
| Category Name | Recommended Type | Paid/Unpaid | Description |
|---|---|---|---|
| Casual Leave | Monthly Accrual | Paid | Personal time off that accrues monthly |
| Medical Leave | Given Upfront | Paid | For illness and medical appointments |
| Earned Leave | Monthly Accrual | Paid | Can be accumulated and carried forward |
| Maternity Leave | Given Upfront | Paid | Extended leave for new mothers |
| Leave Without Pay | Given Upfront | Unpaid | Additional leave without salary |
Creating a Leave Category
Navigate to Categories
Go to Attendance → Settings → Leave Categories
Click Add Category
Click the + Add Category button in the top right.
Fill in Details
Enter the category name, select the leave type, and choose paid/unpaid status.
Select Applicable Roles
Choose which roles can use this leave type (e.g., COACH, STAFF, SYSADMIN).
Save
Click Create Category to save.
- Full entitlement is available from the start of fiscal year
- New joiners get proportional allocation based on months remaining
- Good for: Medical leave, maternity leave
- Leave is earned progressively (1/12th each month)
- Employees can only use what they've earned
- Good for: Casual leave, earned leave
Step 3: Create Leave Packages
Leave packages bundle categories together with specific allocations. Each package is assigned to one or more roles.
Example Package: Full-Time Coach Package
| Category | Days Allocated |
|---|---|
| Casual Leave | 12 days/year |
| Medical Leave | 10 days/year |
| Earned Leave | 15 days/year |
Navigate to Packages
Go to Attendance → Settings → Leave Packages
Click Add Package
Click the + Add Package button.
Enter Package Details
Give the package a name (e.g., "Full-Time Coach Package") and description.
Select Applicable Roles
Choose which roles will receive this package (e.g., COACH).
Add Category Allocations
Select categories and specify the number of days for each.
Save
Click Create Package to save.
Step 4: Initialize Leave Balances
After creating packages, you need to initialize leave balances for existing employees. This can be done automatically or manually.
Automatic Initialization
The system automatically initializes balances when:
- A new employee is assigned a role with a leave package
- A package is first assigned to a role
Manual Initialization (Admin Command)
For bulk initialization or re-initialization, use the management command:
The --force flag will reinitialize balances but preserve existing used and pending leave data. Only use this if you need to recalculate pro-rata entitlements.
Step 5: Configure Shifts (Optional)
If your organization has specific work hours, configure shifts:
Create Shifts
Define work periods with start time, end time, and break duration.
Assign Employees
Assign employees to shifts with effective dates.
Configure Split Shifts (if needed)
For employees with multiple work periods, use the split shift feature.
Step 6: Set Up Holidays
Configure organizational and public holidays:
Fetch Public Holidays
Use the automatic fetch feature to import state-specific holidays.
Add Custom Holidays
Add organization-specific holidays manually.
Mark Optional/Mandatory
Specify whether each holiday is optional or mandatory for all employees.
Configuration Checklist
Before Going Live
- Module enabled in marketplace
- Leave categories created
- Leave packages created and assigned to roles
- Employee balances initialized
- Shifts configured (if applicable)
- Holidays imported/added
- Test leave application workflow