Who this guide is for
System Administrators who manage entitlement pot settings. Requires 'System Admin' role.
Overview
This guide explains how to enable the new Projected tab on the entitlement widget, which shows users their expected future entitlement balance based on time tracking accruals.
How Projected View Works
The Projected tab appears on the entitlement widget and lets a user see the entitlement they are expected to have available to book on a chosen future date. It calculates this by estimating time tracking accruals from the start of the user's current open timesheet up to the projected date, based on their Rota, and adds this to their current available-to-book balance. If the current timesheet is authorised, actual figures are used; if pending or unsubmitted, rota estimate figures are used. Service length, age, and other accrual rule restrictions are respected, and absence types with Time tracking accrues entitlement while absent disabled reduce the projected hours for those periods. The tab is available on the personal dashboard and on the planned and unplanned tab versions of the entitlement widget, but not on the overtime tab. This feature currently works only with accruals awarded via time tracking.
How to Set Up Projected View
- Go to Global.
- Select Entitlements.
- Open the relevant entitlement pot.
- Go to the Advanced section.
- Enable Enable projected accrual display for time tracking accruals.
- Click Save.
- Confirm the Projected tab now appears on the entitlement widget for users assigned to this entitlement pot, on their personal dashboard and on the planned/unplanned widget views.
Additional Information
- Projected date: an input field on the Projected tab that prepopulates with the last day of the current leave year. Users can adjust this to any date up to the last day of the next leave year.
- If a user selects a date in the next leave year, the projected figure assumes all remaining balance from the current year is carried over up to that point.
- This feature is powered by a new v3 API endpoint, GET /v3/entitlement/projected, which returns a projected entitlement figure for a given user, entitlement pot, and date.
- Warning: This setting currently only supports accruals that award via time tracking. The setting label will be updated in a future release once support is extended to other accrual types.
- The Projected tab is not available on the overtime tab of the entitlement widget.
- Requires 'System Admin' role to enable this setting.
- Tip: Use the search function within the platform to quickly find features or settings.