Time off consumption
Moves time off periods from “planned” to “used” when their start date arrives, and deducts the corresponding amount from the employee’s balance.
How it works
The consumption job runs daily and processes any planned period whose start date is on or before the run date:
- Identifies due periods — looks for employees whose next planned time off has started
- Records the consumption — one record updates the employee’s time off, their balance, and the related timesheet entries
- Splits long periods — when a planned period spans more than one approval period (e.g. a vacation crossing two months on monthly approval), only the part inside the current period is consumed. The rest stays planned and is consumed when its own part becomes due
Each consumed period stops counting as planned and counts as used in the employee’s balance.
When it runs
The job runs automatically and only triggers on workspaces that have at least one planned period due. Manually triggering it on a quiet workspace returns a “skipped” result.
Parameters
This job has no parameters. The only thing you can set is the run date, which acts as “today” for the purpose of identifying due periods.
Job results
| Metric | Description |
|---|---|
periods_consumed | Number of planned periods that were converted to used |
consumption_errs | Number of periods that failed to consume (logged with details) |
Special cases
- Periods without a time account (time off registered on an activity only, e.g. a parental day that does not draw on a balance) are consumed with an amount of zero. Nothing is deducted, but the period still counts as used
- Back-dated time off is consumed at the moment the request is approved, not by this job — so this job is mainly a safety net, and the trigger for periods that start today
Troubleshooting
| Issue | Solution |
|---|---|
| Period still appears as planned the day after it started | Check that the job ran for the workspace on that day. If it failed, view the job run details and trigger a manual re-run with the correct run date |
| Balance not deducted | Verify the period is linked to a time account. Periods without a time account do not deduct any balance — that’s expected |
| Long time off is partially consumed | Periods are split by the employee’s timesheet approval period. Each part is consumed on its own start date |