Quick Setup Steps
...
Step 1 of Leave Method Setup | |||||||
| Field Name | Selection Options | Description | |||||
|---|---|---|---|---|---|---|---|
| Assign Level | Global | Select this option if the accrual method applies to a group of employees based on common attribute(s) from an employee record, | |||||
| Employee | Select this option to assign this method directly to an employee | ||||||
| Active | ✅ | if the accrual method is active | |||||
| ⏹️ | If the method is inactive | ||||||
| Name | Enter a name to identify the accrual method. This field is limited to 100 characters. | ||||||
| Time Code Group | Select the time code group where the hours are accrued | ||||||
| Method Start Date | The date the method goes into effect | ||||||
Accrual Based On V8.2 Base Accrual Rate Calculation | Accrual - By Day | If the accrual is calculated based on the number of days specified in the Day of Accrual field times the accrual rate specified in the Base Accrual Rate field | |||||
| Accrual - By Period | If the accrual is calculated based on the reporting period defined in user's employee profile and the accrual rate specified in the Base Accrual Rate field. | ||||||
| By Day Prorated by FTE | If the accrual is calculated based on the number of days specified in the Day of Accrual field times the accrual rate specified in the Base Accrual Rate field times the FTE of an employee type assigned to a user (or an FTE defined in the Override Setting in the user setup) | ||||||
| By Period Prorated by FTE | If the accrual is calculated based on the reporting period defined in user's employee profile and the accrual rate specified in the Base Accrual Rate field multiplied by the standard working hours per day by FTE defined in the Location field employee type assigned to the user, divided by the 8 standard hours and multiplied by FTE a user (or the FTE and Location standard working Hours defined in the Override Setting in the user setup) | ||||||
| By Period Prorated by Standard hours | If the accrual is calculated based on the accrual rate specified in the Base Accrual Rate field, the number of specific type of hours worked specified in the Time Code(s) selected field, prorated by the number of total standard working hours within a reporting period, calculated based on the reporting period of a user and the type of the days selected in the Day of Accrual field. The formula is Accrual Rate * Number of worked hours/total working hours within a period. This field takes into account the daily standard working hours defined in employee's Location field. (or standard working Hours defined in the Override Setting in the user setup) | ||||||
| Comp Time - Fixed Rate | If the accrual is earned based on each hour worked (charged to a specific time code). The type of worked time that would qualify a user for accrual is defined in the Time Code(s) selected field. The accrual rate for each hour worked is defined in the Base Accrual Rate field. As an example each hour charged to ST time code earns a user 0.10 of benefit time. | ||||||
| Comp Time - Prorated Rate | If the accrual is earned based on each hour worked (charged to a specific time code). The type of worked time that would qualify a user for accrual is defined in the Time Code(s) selected field. The accrual rate needs to be defined per period in the Base Accrual Rate field. The rate is then divided by total standard hours per period to calculate the actual comp rate per hour. (Defined in the Location field or in the Override Setting in the employee setup) | ||||||
| Comp Time Based on OT-Fixed Rate | |||||||
| Fixed Accrual | If the accrual is a fixed amount not dependent on by day, period, or pro-ration. | ||||||
| Fixed Accrual Prorated by FTE | The fixed accrual rate multiplied by the FTE of an employee type assigned to a user (or the FTE defined in the Override Setting in the user Setup) | ||||||
| |||||||
Day of Accrual | Days of Accrual field is used in the following 2 cases: a. If the accrual is calculated by period, and an employee starts or is terminated in the middle of the period, the rate is prorated based on the number of days specified in this option. All Days, Working Days or Working Days+Holidays b. If the accrual is by day, this field is used to analyze which days to count towards the accrual, since the accrual is always calculated by period behind the scenes, this field allows us to know the number of days to be used as a multiplier. | All days | Working Days Only | If holidays and weekends are to be excluded from the accrual In addition the system is checking the setting in the following field:Hire/Term Employee Rate Options (Version 8.3 and higher), if the rate is proportional, then the Day of Accrual field will be used in order to understand what days to include in the calculation of the rate. | |||
| All days | |||||||
| Working Days Only | If holidays and weekends are to be excluded from the accrual rate calculation | ||||||
| Working Days + Holidays | If all days except weekends are to be included in the accrual rate calculation | ||||||
| Time Codes For Paid Days Limit |
| ||||||
Prorate Net Accrual (Does not apply to | fixed Fixed Rate accrual) | 0-if less than limit | If the total hours to be prorated in a timesheet is less than or equal the limit defined in the Paid Days Limit field, the accrual is 0. For the methods based on the comp time if total hours for proration in a timesheet exceed the Paid Days limit, the accrual rate per period is Comp Rate x (comp hours-limit) | Limit earned hours worked | This options looks at the actual timesheet and the number of hours worked Prorates total accrual based on the time entered on the timesheets If the setup is by standard or by total it applies to any rate- timesheet hours worked (using specific time codes in the method) on the timesheet comparing against the standard or total hours. Prorate Net Accrual Only gets calculated after the timesheet is updated with hours, on an empty timesheet the accrual is based the option "Apply Full Rate On Missing Period", if enabled then it gets calculated on the assumption of the period and the base accrual rate, but once the hours are entered, the additional Paid Days Limit and Time Code for Paid Days Limit fields are taken into account, as well as the net Prorate Net Accrual setting. | ||
| 0-if less than limit | If the actual hours worked to be prorated in a timesheet is less than or equal the limit (number of hours) defined in the ACCRUAL_RATE_3 field, the accrual is 0. For the methods based on the comp time if total hours for proration in a timesheet exceed the limit set in the ACCRUAL_RATE_3, the accrual is only calculated for the exceeded number of hours at regular comp time rate. | ||||||
| Limit earned hours worked | Limit earned hours worked - Used for COMP Time Only (for any other option it will be ignored) If a user EARNED more than the limit defined in the ACCRUAL_RATE_3 field, the accrual will only receive the hours defined in the limit. Assuming the the Base Accrual rate is 0.5 and the limit defined in ACCRUAL_RATE_3 is 20 then the following example would be correct:
| ||||||
| No Proration | No proration applied to the accrued hours in the balance table | ||||||
| Prorate based on standard hours work | This Applies to all rate types except fixed rate. This field is one of the elements in calculating accrued hours when calculating overall Ending Balance of a user. The formula for calculating users ending balance is the following: Ending Balance=Start Balance + Accrued Hours + Manually Adjusted Hours (if applicable in the employee profile)+ Bank Hours (if applicable and manually added by admin in employee profile - leave taken within the period - hours over the accrual limit. From the formula above the Prorate Based On Standard Hours Worked is used in the Accrued Hours calculation as follows: Accrued Hours = Base Accrual Rate x (for comp time it is the number of hours you would have earned in the period) x Number of hours charged to the time codes selected in Time Code for Prorate Accrual Based on field divided by Standard Working Hours The rate cannot exceed the base rate | ||||||
| Prorate based on total hours work | This field is one of the elements in calculating accrued hours when calculating overall Ending Balance of a user. The formula for calculating users ending balance is the following: Ending Balance=Start Balance + Accrued Hours + Manually Adjusted Hours (if applicable in the employee profile)+ Bank Hours (if applicable and manually added by admin in employee profile)- leave taken within the period- hours over the accrual limit. From the formula above the Prorate Based On Total Hours Worked is used in the Accrued Hours calculation as follows: Accrued Hours = Base Accrual Rate x (for comp time it is the number of hours you would have earned in the period) x Number of hours charged to the time codes selected in Time Code for Prorate Accrual Based on field divided by Total Hours Work The rate cannot exceed the base rate | ||||||
| |||||||
Time Code For Prorate Accrual Based On (V8.2 Time codes for Net Accrual Proration) | The time codes selected for Prorate Accrual Based On calculation | ||||||
Paid Days Limit (May only apply to rate by period and by day) |
| ||||||
| Enable Cumulative Accrual | Yes | This field is only applicable if the Number of Months Before Accrual Available is more than zero. If enabled then the number of hours a user would have accumulated for the number of months specified in the Number of Months Before Accrual Available field become available after this period | |||||
| No | This field is only applicable if the Number of Months Before Accrual Available is more than zero. If not enabled then the user starts accumulating the hours from zero starting at number of months specified in the Number of Months Before Accrual Available | ||||||
| Base Accrual Rate | Enter the starting accrual rate for users with 0 years of service. Additional rates will be entered in a later step | ||||||
| Daily Base Prorate Hours | This option is used only for Accrual Based on rate type By Period Prorated by Standard hours For this rate type prorated rate is computed as base rate*FTE* hours in day per location/Daily Base Prorate Hours | ||||||
| Hire/Term Employee Rate Options (Version 8.3 and higher) | This option is available for accrual methods in Version 8.3 and higher. Applies only when one of the following Base Accrual Calculation options are used: Accrual By Period, By Period Prorated by FTE, By Period Prorated by Standard Hours. In all other cases a selection in this field will be ignored. This is used in case the accrual rate for the period needs to be prorated further by the number days in any period based on the employee hire and termination dates, in cases where an employee is hired or terminated in the middle of the period and an employer does not want the end user to accrue for the full rate for that period. | ||||||
| Hire - Full, Term-Full | Use this option if an employee earns the full accrual rate for both the timesheet reporting period in which they were hired and the period in which they were terminated | ||||||
| Hire - Full, Term-no | Use this option if an employee earns the full accrual rate for the timesheet reporting period in which they were hired and 0 accrual for the period in which they were terminated | ||||||
| Hire - Full, Term-proportional | Use this option if an employee earns the full accrual rate for the timesheet reporting period in which they were hired and proportional accrual rate based on the number of days until termination for the period in which they were terminated (proportional rate is calculated based on the percentage of the days that the user worked multiplied by the rate by period) | ||||||
| Hire - no, Term-Full | Use this option if an employee earns 0 accrual rate for the timesheet reporting period in which they were hired and a full accrual rate for the period in which they were terminated | ||||||
| Hire - no, Term-no | Use this option if an employee earns 0 accrual rate for the timesheet reporting period in which they were hired and 0 accrual for the period in which they were terminated | ||||||
| Hire - no, Term-proportional | Use this option if an employee earns 0 accrual rate for the timesheet reporting period in which they were hired and proportional accrual rate based on the number of days until termination for the period in which they were terminated | ||||||
| Hire - proportional Term-Full | Use this option if an employee earns an accrual rate proportional to the number of days worked within the hire period and full accrual rate for the period in which they were terminated | ||||||
| Hire - proportional Term-no | Use this option if an employee earns an accrual rate proportional to the number of days worked within the hire period and 0 accrual for the period in which they were terminated | ||||||
| Hire - proportional Term-proportional | Use this option if an employee earns an accrual rate proportional to the number of days worked within the hire period and proportional accrual rate based on the number of days until termination for the period in which they were terminated | ||||||
| Number of Months Before Accrual Available | Enter number of months after which the leave hours should become available to a new employee. See Enable Cumulative Accrual field for additional options | ||||||
| Initial Balance For New Employees | Starting balance granted to the user at the beginning of the employment | ||||||
| Number Of Months Before Initial Balance Available | Number of months at which the Initial Balance For New Employees becomes available to a user | ||||||
| Set Leave Balance To Zero For Terminated Employees | Yes | If this option is selected, if a user has an ending balance at termination date the ending balances will be reduced to zero | |||||
| No | If this option is selected, if a user has an ending balance at termination date the ending balances will remain in the system | ||||||
| Keep Accrual | Yes | This option only applies if Hours Limit options is set. If selected, in case a user balances has reached the max Hours Limit, the system will continue tracking any balances above the limit, as soon as the hours taken are below the limit the balances will be re-filled up to the available balance. | |||||
| No | This option only applies if Hours Limit options is set. If No is selected, in case a user balances has reached the max Hours Limit, user will continue the accrual at a regular rate after the taken leave has reduced the balance below Hours Limit | ||||||
| Start Accrual Based On | January - December | This option overrides the option selected on the Reporting Period and Time Code Group. It defines the start of accrual year based on the specific month for the selected time code group in this method. | |||||
| Based on Employee previous date of service | This option overrides the option selected on the Reporting Period and Time Code Group. It defines the start of accrual year based on the Employee original hire month, this field is located in the Employee setup screen and is called Previous Date of Service (in case an employee was refired) for the selected time code group in this method. | ||||||
| Based on Employee Start Date | This option overrides the option selected on the Reporting Period and Time Code Group. It defines the start of accrual year based on the Employee Start Date for the selected time code group in this method. | ||||||
| Disabled and Enable only at the Time Code Group. | This option points to Time Code Group to define the start of the accrual year. | ||||||
Fixed Rate Options *This only applies to accrual set up based on calendar year and or starting month other than Jan. The option will be ignored if the accrual is based on employee anniversary. V8.2 New Hire Fixed Rate | Accrual Full Fixed Rate in regards of start date. | This option only applied if Fixed Accrual or Accrual Prorated by FTE options are selected in Accrual Based on field. The full fixed rate is granted regardless of the start date of the hire. | |||||
| Based on Scheduled Absolute Value | When the accrual rate is fixed per year and an employee is hired in the middle of the year, the rate can be prorated based on the number of hours defined in the New Hire Fixed Rate tab. In this table the admin needs to define the number of month and the corresponding fixed rate per month, based on the number of months that has already passed in the accrual year. The rate for a full year is defined in the Base Accrual Rate field and the fractions of that rate based on the number of months worked are defined in the New Hire Fixed Rate tab in the accrual method setup screen. These tabs will only appear if one of the Scheduled Fixed Rate Options are selected. | ||||||
| Based on Schedule Percent | The same as above, except the rate is defined as the percentage of the Base Accrual Rate instead of an absolute value | ||||||
| No accrual on employee start date for Fixed Rate only. | This option only applied if Fixed Accrual or Accrual Prorated by FTE options are selected in Accrual Based on field. User starts with zero fixed rate until the new accrual year. | ||||||
| Prorated based on number of months employee works in a year from start date. | This option only applied if Fixed Accrual or Accrual Prorated by FTE options are selected in Accrual Based on field. The fixed accrual rate is taken and prorated based on the number of months the employee has worked. The month when employee starts is included. | ||||||
| Accrual New Year Starts | Based on the Start of the Accrual Period (Default) | When an old year transitions into a new accrual year and the first date of the new accrual year falls in the middle of the timesheet. Start the new accrual year on the timesheet that contains first day of the new year. | |||||
| Reporting Next following period in the New Year | When an old year transitions into a new accrual year and the first date of the new accrual year falls in the middle of the timesheet. Start the new accrual year from the next reporting period, where the first date of the timesheets falls into the new year. | ||||||
| Balance Rounding | Disabled | When calculating the ending balance the hours are not rounded | |||||
| Round Down | When calculating the accrued hours the hours are rounded down using the increments specified in the reporting period setup | ||||||
| Round Up | When calculating the accrued hours the hours are rounded up using the increments specified in the reporting period setup | ||||||
| To the nearest | When calculating the accrued hours the hours are rounded to the nearest decimal using the increments specified in the reporting period setup | ||||||
| Apply Full Rate On Missing Period | Yes | This option overrides the setting in case Prorate Accrual Based On is being used and the accrual is based on the number of hours worked. If enabled the system will insert the full accrual rate if a timesheet is missing (A timesheet is considered in a New Timesheet status or a timesheet has no hours) | |||||
| No | The accrual rate for the missing timesheets will be zero (A timesheet is considered in a New Timesheet status or a timesheet has no hours) | ||||||
| Description | Enter text to further identify the function. This field is limited to 255 characters. | ||||||
...
Step 5 Accrual Limit | ||
| Field Name | Description | |
|---|---|---|
Years of Employment: | Specify a number of year in case different Hours Limits apply based on the years of employment (Note: if the Years of Employment is set to "-1" this limit will be ignored) | |
Hours Limit | This field is used to limit the leave balance on a reporting period. Number of hours that can be used in any specific reporting period. The limit applied to the usage of leave hours per reporting period. Users can only take off the hours up to the limit during each reporting period regardless of the available accrued balance. Note: The hours limit may be calculated based on the user's FTE:
| |
| Limit Flag (v7.6+ only) | Absolute Value: The hours limit will be the value in the previous field | |
| Absolute Value prorated by FTE: The hours limit will be prorated by the user's FTE | ||
| ||
...
Once the set up steps above are completed Administrators must schedule a profile jobs as follows:
- Expand Data Piping by clicking on the plus sign.
- Click on All Profile Task
- Click Add to create a profile
- Name* - Enter in a name for the profile like below
- Profile Type* - Select Update Employee Leave Balance
- Description - Enter in a description for the profile (Optional)
- Click Save
- Click the Parameters tab and fill out the field options
...