Who this guide is for: System administrators. Requires 'Entitlements' permission.
Overview:
This guide explains how to configure accrual patterns necessary for creating or editing accrual rules. Accrual pattern help configure when an award is intended to run and also has settings that determine how it will run when it does.
P.S - All accrual rules run based on scheduled tasks for your system, however they will not run retrospectively. If you create a new rule that should have run historically, the entitlement will need to be added to users manually for the current year, and then it will run naturally next time it is scheduled for.
How to Set up Accrual patterns:
- Navigate to Admin Tools > Admin Panel > Global > Entitlement Setup
- Click on Accrual patterns in the top right corner
- To edit an existing accrual pattern, search for the accrual pattern in question and click on Edit
- To create a new accrual pattern, click on + Add new in the top right corner
- Configure the settings and click on Save
Entitlement accrual pattern details:
- Description - the name of your accrual pattern. This can be as short as Long service or Monthly award, or as long as you wish - just needs to be something to help differentiate from the other accrual patterns.
- Enable projected annual total - this determines whether the accrual will award for all the periods it is set to award in for the first time it runs on the user's profile. This can be used in a scenario, where you have a monthly accrual, but wish for all months' entitlements to be displayed at once. P.S - the user will be able to book all the entitlement that gets projected.
- Prorate award - this determines whether the accrual rule upon running takes into consideration the user's FTE. For example, if the award rule is configured to give 5 days, but the user is on FTE of 0.8, the system will give the user 4 days (5 * 0.8 = 4).
- Award in year - this determines for when the award will display on the user's entitlement, either Current year or Next year. If you select Current year, it will display all the entitlement accrued in the current leave year for the user. If you select Next year, it will display all the entitlement accrued in the next leave year for the user.
Recurrence pattern:
- Single occurrence - select a specific day for this to run. It will not run the award again following this, unless the date of the pattern gets amended.
- Daily - the award will run every day. This is mainly used in scenarios when you want an accrual to be awarded as soon as the user fills a specific criteria determined by the accrual rule, and frequently is configured to only run once only in the rule.
- Weekly - the award will run on a specified day of the week selected in this. You are able to select multiple days between Sunday - Saturday.
- Monthly - the award will run on specified day(s) of specified month(s). For example, if you need an award to run at the start of every month, you would configure it as All months, and select 1 as the specific day. Alternatively, you can also configure it as a Day occurrence and select it to run say on every second Friday.
- Leave year start date - the award will run on the date specified in the user's Leave year day & month settings found under the User settings tab.
- Employment start date - the award will run on the date specified in the user's Employment start date setting found under the Profile tab.
- Continuous start date - the award will run on the date specified in the user's Continuous start date setting found under the Profile tab after clicking on Advanced under Personal details.
- Birth date - the award will run on the date specified in the user's Date of birth setting found under the Profile tab.
Additional Information:
- Key Terms:
- Accrual pattern: determines when and how an award runs
- Accrual rule: determines the amount awarded and the terms for awarding the set amount
- Permissions: 'Entitlements' role required
- Tip: Create separate accrual patterns for each configuration required
- Search Tip: Use the search bar for "Entitlements" or "Accrual pattern"