Open navigation

Available Leave Advanced Setup Guide

Available Leave can be set up to suit your organization’s needs. As an administrator, you can set:

Which Leave to Include
Determine which leave displays. You can display different codes for employees based on their pay group.

Display Options
Tailor the icons and colours to suit your different types of leaves. You can set the names that display, along with whether the amounts display in dollars or units.

Display Additional Information
You can display relevant information on Available Leave, formatted using HTML. You can create different messages in English and French.

How to Set Which Leave Displays

You’ll need to set which deduction/benefit codes display in Available Leave. You can display different codes for employees based on their pay group.

Additional Information
The calendar includes earnings tied to these deduction/benefit codes with an Earning Type of Take Leave or Vacation.

For information to appear in Available Leave, the Deduction/Benefit Code must be active, with the code active on the employee’s Profile.

Important Information
The same codes display in Available Leave on Avanti Go and Entitlements on ASSP. If you’re already using these, updating these settings will impact what’s displayed there.

Step 1: Identify the Deduction/Benefit Codes you’d like to use for each pay group in the Avanti Desktop. You’ll only use the first three digits of the codes.
By default, this can be found in Canadian Payroll >> Employer Payroll Tables.

Additional Information
The type selected for the Deduction/Benefit Code must be: 

  • Accrued Vacation

  • Banked Time 

  • Accrued Sick Leave

Step 2: Open Administration Settings on ASSP and select Company Settings. 
By default, this can be found in Administration. 

Step 2: Enter EntitlementsSettings in the Search.

Step 3: Select Edit for EntitlementsSettings.AllowedBenefitCodesForPayGroup.

Step 4: In Value, enter a comma-separated list of the code numbers and select Save.

Additional Information 
This is your generic setting, which will be used for all pay groups unless otherwise specified. You’ll want to enter the codes you want to display for most pay groups. 

If you display the same deduction/benefit codes for all your employees, skip to Step 9.

Step 5: Select Copy for EntitlementsSettings.AllowedBenefitCodesForPayGroup.

Step 6: Add the three-digit code for the Pay Group to the end of the Key.

Additional Information
This should be a pay group with different deduction/benefit codes than the ones you created in Step 4. An deduction/benefit code only displays if the code is active on the employee’s Employee Profile.

Step 7: In Value, enter a comma-separated list of the Deduction/Benefit Codes you want to display and select Save.

Additional Information 
Keep in mind that employees will only see the codes that are active on their Employee Profile.

Step 8: Repeat Steps 5 to 7 for each pay group that should have different codes.

Step 9: Select Reload Settings.

How to Adjust the Display Options

You’ll want to review the codes you want to display to ensure they’ll correctly display in either dollars or units, along with the names you’d like:

If any of your employees have more than one leave of same type, such as different ways to bank time, you may want to change the icon and colour to differentiate them. By default:

  • Vacation time is green with a plane.

  • Banked time is blue with a bank.

  • Sick time is yellow with a sick emoji.

Before you can get started updating the web settings, you’ll need to know:

  • Whether you’d like each leave to display in dollar amounts or units.

  • The name you’d like to display for each leave.

  • The earning codes that take from each leave.

Step 1: Open Deduction/Benefit Code in the Avanti Desktop Application.
By default, this can be found in Canadian Payroll >> Employer Payroll Tables.

Step 2: Select the code you want to update and click Modify.

Step 3: Review the Full Name and, if your company displays ASSP in French, the French Name. Adjust if desired.

This will display here:

Step 4: On the Entitlements tab, confirm the Display in is what you’d like to display in the card. Adjust it, if desired; you can select either:

  • Units

  • Hours

Step 5: Review the Entitlement Icon and Entitlement Colour. Adjust them, if desired, then select OK.

Step 6: Repeat Steps 2 to 5 for each code you want to update.

Step 7: Open Earning Codes in the Avanti Desktop Application.
By default, this can be found in Canadian Payroll >> Employer Payroll Tables.

Step 8: Select the take leave code you want to review and click Modify.

Step 9: Review the Short Name and, if your company displays ASSP in French, the French abbrev. Adjust, if desired, then select OK.

This will display on the calendar:

Step 10: Repeat Steps 8 to 9 for each take leave you will display.

How to Display Additional Information

You can display any relevant information you’d like to include on Available Leave. Different messages can be created in English and French.

Additional Information 
You can use HTML to format the text, but if you do, the information won’t display on Avanti Go; HTML cannot be supported on mobile apps. Be sure to exclude HTML formatting if you want the message displayed on Avanti Go. 

Important Information
This information displays in Available Leave on Avanti Go and Entitlements. If you’re using these, updating these settings will impact what employees see there. 

If you don’t want to add or adjust the information displayed, skip to How to Add Available Leave to the Menu.

Step 1: Open Administration Settings on ASSP and select Company Settings.
By default, this can be found in Administration. 

Step 2: Enter EntitlementsSettings.DisclaimerText in the Search.

image-20240301-151710.png

Step 3: Select Edit for EntitlementsSettings.DisclaimerText.

image-20240301-151506.png

Step 4: In Value, enter the text you want to display when people access this information, then select Save.

Additional Information
You can format the text using HTML. Be aware that if you use HTML formatting, the message won’t display on Avanti Go; HTML isn’t compatible on mobile apps.

If you don’t have French enabled, skip to Step 7.

Step 5: Select Edit for EntitlementsSettings.DisclaimerTextFr.

image-20240301-151304.png

Step 6: In Value, enter the text you’d like to display when people access this information in French. Then select Save.

Additional Information
You can format the text using HTML. Be aware that if you use HTML formatting, the message won’t display on Avanti Go; HTML isn’t compatible on mobile apps.

Step 7: Select Reload Settings.

image-20240301-151958.png

How to Add Available Leave to the Menu

All that’s needed now is to add Available Leave to the menu. Only Regular users with the Admin user group can set up Available Leave.

Step 1: Select System Configuration.

Step 2: Under System, select New Experience.

Step 3: Select Start Setup.

Step 4: Select Continue to bypass the security.

Step 5: Select Available Leave if it’s not already selected.

By default, everyone will have access to Available Leave. If you’d like everyone to view their Available Leave, skip to Step 10.

Step 6: If Edit doesn’t automatically open, select Edit.

Step 7: Select a Role Type.

Important Information
Since employees can only view their own information, Role Type
 won’t change your managers’ access.

Step 8: Adjust the User Groups. Anyone in one of the selected User Groups can access their Available Leave.

Additional Information
Only users in one of the selected User Groups can access Available Leave unless * is selected. If * is selected, everyone can access Available Leave.

Step 9: Select Save.

Step 10: Select Finish.

Step 11: Select Exit Configuration.

Great! Available Leave is all set up, and employees can access it from Personal.

If Entitlements is currently available to employees, you may not want it to display anymore. You’ll need to update the allowed user groups for Entitlements on the Web Menu. You can do this from the Avanti Desktop.


Are you already using the mobile app, Avanti Go? You can add Available Leave on Avanti Go too. Go to Available Leave on Avanti Go Setup Guide to learn more.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.