Holiday Pay Rule
Class Name
com.workbrain.app.ta.quickrules.HolidayPay
Overview
Holidays are considered the days on which employees are entitled to time off from work. Employees are paid for the holidays even though the employees are not required to work. If employees work on holidays, they are paid at an increased rate of pay. Typically, if employees are not scheduled to work on the holiday, they are entitled to take the holiday on a different day. Employees may also be able to bank the holiday and take the holiday later in the year.
Within the application, holiday days are controlled by OVERRIDE records of type 900-999. The creation and assignment of holidays is controlled through holiday calendars. See Holiday Management.
The Holiday Pay Rule controls how employees are paid for a holiday by automatically inserting premiums of a defined length and rate. The rule relies on the Is Holiday Condition, Is Specific Holiday Condition, and Holiday Condition to determine if a given day is a holiday. If the day is a holiday, the rule executes and pays employees according to the values that are specified in the rule parameters.
Parameters
| Parameter | Description |
|---|---|
| Time Code List | Select the time codes that represent time employees
spend working. These time codes are used to determine the length of
time the employee worked on the holiday, which is used with the
MustWork parameters of the Holiday Condition. See Holiday Condition. The selected time codes are also converted to the value of the Work Convert Code parameter if the parameter is set. The default value is WRK. |
| Holiday Premium Time Code | Select the time code that is used when the rule inserts premiums for holiday pay. The rule does not insert a premium if no time code is selected. |
| Holiday Premium Hour Type | Select the hour type that is used when the rule inserts premiums for holiday pay. |
| Holiday Premium Minutes | Specify the length of the premium the rule inserts for holiday pay. If the Is Percentage parameter is selected, this number represents a percentage of total scheduled hours; otherwise, this number represents minutes. |
| Is Percentage | Select the check box to configure the rule to pay
holiday premiums as a percentage of the employee's scheduled hours.
The value of the Holiday Premium Minutes parameter determines the
percentage value. For example, with this configuration:
When this field is not selected, the value of the Holiday Premium Minutes parameter is the length of the premium, in minutes. |
| Work Convert Code | Select a time code to use for all worked time that is
recorded on a holiday. If a time code is selected, the rule converts all the
work details on a holiday with one of the time codes that is selected in the
Time Code List parameter to the selected time code.
This parameter allows supervisors to see all the hours that are worked on a holiday, summarized under one special time code. |
| Remove Time Codes | Select the time codes that are used to remove work details from the
timesheet if the employee does not record any work time. Work
details are only removed when both the Time Code List and Work
Convert Code parameters are left blank. By default, only UAT work details are removed from the day on which the rule is applied. For employees with scheduled breaks, this leaves the break-related work details on the timesheet. Using this parameter, you can configure the rule to remove any unwanted work details. For example, if this parameter is set to UAT,BRK and the Inclusive parameter is selected, then the rule removes both UAT and BRK work details.If this parameter is set to GAP and the Inclusive parameter is cleared, then the rule removes all work details except GAP work details. |
| Inclusive | Specify whether the time codes listed in the Remove Time Codes
parameter are inclusive (selected) or exclusive (cleared). If this check box is selected, all work details with these time codes are removed. If this check box is not selected, all work details with time codes not listed in the Remove Time Codes parameter are removed. |
Example: Pay premium as percentage of an employee's scheduled hours
In this example, the rule has been configured to pay a premium of 50% of the employee's scheduled hours.
Condition: Is Holiday
Parameters:
| Parameter | Value |
|---|---|
| Time Code List | WRK, TRN |
| Holiday Premium Time Code | HOL |
| Holiday Premium Hour Type | REG |
| Holiday Premium Minutes | 50 |
| Is Percentage | Selected |
An employee scheduled for 4 hours on the holiday who records 2 hours with the WRK time code and 2 hours with the TRN time code is paid a premium of 2 hours (50% of 4 scheduled hours) with the HOL time code and REG hour type. The employee is also paid their default rate for 4 hours.
An employee scheduled for 8 hours on the holiday who does not work is only paid a premium of 4 hours (50% of 8 scheduled hours).
An employee who is not scheduled to work on the holiday, but records 5 hours with the WRK time code, is not paid a premium. The employee is only paid their default rate for 5 hours.
Example: Convert all work time that is recorded on a holiday
In this example, the rule has been configured to pay a premium of one hour. All WRK and TRN time is converted to the HPY time code.
Condition: Is Holiday
Parameters:
| Parameter | Value |
|---|---|
| Time Code List | WRK, TRN |
| Holiday Premium Time Code | HOL |
| Holiday Premium Hour Type | REG |
| Holiday Premium Minutes | 60 |
| Is Percentage | Cleared |
| Work Convert Code | HPY |
An employee scheduled for 4 hours on the holiday who records 2 hours with the WRK time code and 2 hours with the TRN time code is paid a premium of 1 hour (60 minutes) with the HOL time code and REG hour type. Although the employee is paid their default rate for the 2 hours of WRK and 2 hours of TRN, the rule converts the time to use the HPY time code.
An employee scheduled for 8 hours on the holiday who does not work is only paid a premium of 1 hour.
An employee who is not scheduled to work on the holiday, but records 5 hours with the WRK time code, is paid a premium of 1 hour. The employee is also paid their default rate for 5 hours.
Example: Remove work details from the timesheet
In this example, the rule has been configured to remove both BRK and UAT work details if the employee does not record any work time. The rule pays a premium of 100% of the employee's scheduled hours.
Condition: Is Holiday
Parameters:
| Parameter | Value |
|---|---|
| Time Code List | <blank> |
| Holiday Premium Time Code | HOL |
| Holiday Premium Hour Type | REG |
| Holiday Premium Minutes | 100 |
| Is Percentage | Selected |
| Work Convert Code | <blank> |
| Remove Time Codes | UAT,BRK |
| Inclusive | Selected |
The employee had these work details before the rule was applied:
| Start Time | End Time | Duration | Time Code | Hour Type |
|---|---|---|---|---|
| 08:00 | 12:00 | 4.0 | UAT | UNPAID |
| 12:00 | 13:00 | 1.0 | BRK | UNPAID |
| 13:00 | 17:00 | 4.0 | UAT | UNPAID |
After the rule is applied, no work details remain on the day; only the premium generated by the rule is present:
| Start Time | End Time | Duration | Time Code | Hour Type |
|---|---|---|---|---|
| 00:00 | 00:00 | 8.0 | HOL | REG |