Leave Packages
Leave packages bundle multiple leave categories together with specific day allocations. Assign packages to roles to automatically grant leave entitlements to employees.
Understanding Packages
A leave package is a collection of leave categories with defined allocations. When assigned to a role:
- All employees with that role automatically receive the leave entitlements
- Balances are initialized based on join date and package allocations
- Changes to packages can affect all associated employees
Creating a Package
Navigate to Leave Packages
Go to Attendance → Settings → Leave Packages
Click Add Package
Click the + Add Package button.
Enter Package Details
Provide a name (e.g., "Coach Leave Package") and optional description.
Select Target Roles
Choose which roles will receive this package. Multiple roles can share the same package.
Add Category Allocations
For each leave category, specify the annual days allocated.
Save Package
Click Create Package to save.
Package Fields
| Field | Description | Required |
|---|---|---|
| Name | Descriptive name for the package | Yes |
| Description | Details about who this package is for | No |
| Applicable Roles | Roles that will receive this package | Yes |
| Is Active | Whether the package is currently in use | Yes (default: true) |
| Category Allocations | Days allocated for each leave category | At least one |
Example Packages
Full-Time Coach Package
| Leave Category | Days/Year | Type |
|---|---|---|
| Casual Leave | 12 | Monthly Accrual |
| Medical Leave | 10 | Given Upfront |
| Earned Leave | 15 | Monthly Accrual |
Part-Time Staff Package
| Leave Category | Days/Year | Type |
|---|---|---|
| Casual Leave | 6 | Monthly Accrual |
| Medical Leave | 5 | Given Upfront |
Package Assignment Flow
When an employee is assigned a role (e.g., COACH), the system automatically looks for active packages applicable to that role and initializes the employee's leave balances.
- Admin creates leave categories
- Admin creates package with category allocations
- Admin assigns package to role(s)
- Employee is assigned the role
- System automatically initializes leave balances
- Employee can view and use their leave
Managing Packages
Editing a Package
Changes to package allocations affect how new balances are calculated. Existing balances may need to be re-initialized.
If you modify allocations in an active package, use the initialize_leave_balances --force command to recalculate balances. Existing used/pending leave will be preserved.
Multiple Packages per Role
If multiple active packages are assigned to the same role, the system will use the most recently updated package. It's recommended to have only one active package per role to avoid confusion.
Best Practices
- Create separate packages for different employment types (full-time vs. part-time)
- Use clear, descriptive package names
- Document your leave policies alongside package configurations
- Review packages annually and update as needed
- Consider creating a "Standard Package" that can serve as a baseline