Weekly Overtime Plus Rule

The Weekly Overtime Plus Rule automatically pays overtime to employees who have worked over a specified amount of time. The rule can be configured to pay overtime on a weekly, monthly, or pay period basis.

Technical Details

com.workbrain.app.ta.quickrules.ConsolidatedWeeklyOvertimeRule

Overview

The Weekly Overtime Plus Rule is used to pay overtime to employees based on the amount of eligible time they worked. The rule can be configured to pay employees different rates at several different thresholds, so that employees are paid differently the longer they work.

The main aspects of the Weekly Overtime Plus Rule’s configuration are:

  • How long do employees have to work before earning overtime?
  • What work is eligible?
  • How is the overtime paid?

How long do employees have to work?

The rule is heavily dependent on the Hour Set Description parameter, which contains an expression that defines at what rates employees are paid for working different lengths of time. The expression is composed of a comma-separated list of tokens, in the format HTYPE=duration, HTYPE=duration.

Employees are paid at the first token’s rate for the specified duration. Employees who work longer are paid at the second token’s rate for the time they worked beyond the first token’s duration. If a third or fourth, or any number, of tokens exists, the employee is paid the different rates of the tokens for the time they work beyond the previous token’s duration.

For example, with the basic expression of REG=2880,OT1=99999, the rule assigns the REG hour type to the first 2880 minutes employees work and then the OT1 hour type to any time worked after that.

The duration of each token can be defined as:

You can define default values for the fields by typing |# (# is the default value in minutes) after the field name. For an example, see Business Example 3 - Weekly Overtime Plus Rule. Also, the field’s value can be multiplied by any decimal value, by typing (#) (# is the multiplier) after the field name. For an example, see Business Example 5 - Weekly Overtime Plus Rule.

Also, you can set the duration of the first token equal to the employee’s scheduled time. With this configuration, the rule pays an overtime rate to any employee who works longer than they are scheduled. For an example, see Business Example 2 - Weekly Overtime Plus Rule.

What work is eligible?

When the rule compares how long an employee has worked to the specified thresholds, the rule bases the employee’s worked time on:

  • Eligible work details, that both count as worked time and are eligible to earn overtime. Eligible work details can be defined by their time code and hour type, or just their hour type.
  • Protected, eligible work details, that count as worked time but are not eligible to earn overtime. The rule does not change the hour types of protected, eligible work details. Eligible work details can be defined by their time code, hour type, or both. For an example, see Business Example 3 - Weekly Overtime Plus Rule.
  • Protected, eligible premiums, that count as worked time but are not eligible to earn overtime. The rule does not change the hour types of protected, eligible premiums. Eligible work details can be defined by their time code, hour type, or both. For an example, see Business Example 4 - Weekly Overtime Plus Rule.

How is overtime paid?

The rule can be configured to pay overtime as a premium or by changing the hour type of eligible work to a higher rate.

Overtime premiums can be charged against specific labor metrics, such as certain projects or departments. For an example, see Business Example 2 - Weekly Overtime Plus Rule.

You can configure the rule to allocate overtime to the end of the overtime period, so that the last eligible work is paid at an overtime rate first. For an example, see Business Example 1 - Weekly Overtime Plus Rule and Business Example 3 - Weekly Overtime Plus Rule.

Or, you can configure the rule to allocate overtime on a schedule basis, so that the rule attempts to convert eligible work outside the employee’s schedule to an overtime rate first. For an example, see Business Example 4 - Weekly Overtime Plus Rule.

You can also configure the rule to allocate overtime based on an employee's team assignment. When configured on team assignment, the rule allocates overtime first to the employee's non-home teams. Any remaining overtime is then allocated to the employee's home team.

Note: This non-home team allocation is only possible when an employee is on a single home team for the entire week.

Configuration

The Weekly Overtime Plus Rule’s behavior is based on the values of the related parameters.

Rule Parameters

Parameters marked with an asterisk (*) are required.

Overtime Eligibility Parameters

Parameter Description Valid Values
*Hour Set Description This parameter specifies when employees are paid overtime. The parameter defines the rate employees are paid for different amounts of worked time, defined by a comma-separated list of tokens. Each token consists of an hour type and a duration, in minutes. Durations act as threshold values. Once employees work beyond the threshold, they are paid according to the next token's hour type. Each hour type's duration can be defined by one of these options: Additional operators can be used with the tokens: If an employee works beyond the duration of the total time in the hour set, the time is ignored by the rule. A comma-separated list of tokens in the format HTYPE=duration, HTYPE=duration
*Work Detail Hour Types This parameter specifies the hour types that count toward overtime and are eligible to earn overtime. The rule counts work details with eligible hour types against the threshold values defined in the Hour Set Description parameter and either changes the hour types to reflect overtime or inserts a corresponding premium. Select the eligible hour types. This parameter must contain the same hour types as every threshold but the last in the Hour Set Description parameter. So, if you specify three hour types, such as REG, OT1, and OT2, the first two, REG and OT1 must be specified in the Work Detail Hour Types for the rule to properly calculate overtime. Any valid hour types
Work Detail Time Codes This parameter specifies the time codes that count toward overtime and are eligible to earn overtime. The rule counts work details with eligible time codes against the threshold values defined in the Hour Set Description parameter and either changes the hour types to reflect overtime or inserts a corresponding premium. Select the eligible time codes. Leave blank to configure the rule to consider all time codes eligible. Any valid time codes
Premium Hour Types This parameter specifies the premium hour types that count toward overtime. Premiums are not eligible to earn overtime, however the rule counts premiums with the specified hour types against the threshold values defined in the Hour Set Description parameter. The rule does not change the hour types of premiums or insert overtime premiums for their time. Select the eligible premium hour types. If left blank, only premiums with time codes specified in the Premium Time Codes parameter count toward overtime. If both Premium Hour Types and Premium Time Codes are left blank, the rule ignores premiums when calculating overtime. Overtime is not earned on premiums alone. If an employee has only recorded premiums during an overtime period and no work details, the rule does not pay any overtime. Also, if Premium Hour Types has a value, the Apply overtime as a premium option is disabled. Overtime can only be paid by changing the hour types of eligible work details. Any valid hour types
Premium Time Codes This parameter specifies the premium time codes that count toward overtime. Premiums are not eligible to earn overtime, however the rule counts premiums with the specified time codes against the threshold values defined in the Hour Set Description parameter. The rule does not change the hour types of the premiums or insert overtime premiums for their time. Select the eligible premium time codes. If left blank, only premiums with hour types specified in the Premium Hour Types parameter count toward overtime. If both Premium Time Codes and Premium Hour Types are left blank, the rule ignores premiums when calculating overtime. If Premium Time Codes has a value, the Apply overtime as a premium option is disabled. Overtime can only be paid by changing the hour types of eligible work details. Any valid time codes
Overtime Period Select the range of time for which overtime is calculated. The rule calculates overtime based on the amount of time employees worked during the week, month, pay period, shift pattern, or an explicit date range you configure. Select one of these options:
  • Week: Calculates overtime on a weekly basis.
  • Calendar Month: Calculates overtime on a monthly basis. The rule calculates monthly overtime based on the calendar month, so that the first day of the calendar month is the first day of the overtime period, and the last day of the calendar month is the last day of the overtime period.
    Note: When this option is selected, the rule considers work details from every day of the month when calculating overtime. This parameter will impact overall performance as more system resources are required. The impact is greater when either the Allocate overtime based on the schedule or Insert premiums based on the schedule parameters are selected. In that case, the rule considers the an entire month's schedule details as well as work details during the rule's calculations.
  • Pay Period: Calculates overtime on a pay period basis. If selected, the rule ignores the Day Week Starts parameter. The overtime period starts on the first day of the employee's period and ends on the last day of the period.
  • Explicit Days: Calculates overtime based on a set start date and an explicit number of days from the start date. The start date is moved forward or reset at the end of the calculation period. If selected, you must select a start date in the Start Date parameter and the number of days in the No. of Days parameter.

    For example, assume the start date is June 1 and the number of days is 28. When the timesheet is recalculated, then June 1 is considered as the first day of the calculation period for overtime. After overtime is applied for the calculation period from June 1 to June 28, the start date of the overtime period is then moved forward to June 29.

  • Shift Pattern: Calculates overtime based on the employee's shift pattern. If selected, the rule ignores the Day Week Starts parameter. The overtime period starts on the first day of the employee's shift pattern and ends on the last day of the employee's shift pattern regardless of whether the employee has a shift pattern offset.
One of the drop-down list selections
Note: You must configure the calculation group's Auto Recalc parameter in the Quick Rule Editor to either ENTIRE WEEK, ENTIRE PAY PERIOD, or ENTIRE MONTH, matching this parameter's value (for example, select ENTIRE WEEK if Overtime Period is Weekly). Overtime is not properly applied for the overtime period, unless that entire period has been recalculated every time the rule fires.
Day Week Starts Select the day on which the weekly overtime period starts:
  • Application Default: The rule uses the value of the DAY_WEEK_STARTS registry parameter.
  • One of the days of the week, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday.
This parameter is only used when you select Week from the Overtime Period drop-down list. 		One of the drop-down list selections
Start Date Select the starting date of the overtime period from the calendar.

This parameter is only used when you select Explicit Days from the Overtime Period drop-down list.

 Any valid date
No. of Days Specify the number of days in the overtime period.

This parameter is only used when you select Explicit Days from the Overtime Period drop-down list.

 Any positive integer, representing days
Deduct Breaks from Schedule Duration This parameter indicates whether to exclude break minutes from the schedule duration. Select one of these options:
  • No: Includes breaks in the schedule duration. This is the default.
  • Unpaid Breaks: Excludes unpaid breaks from the schedule duration.
  • All Breaks: Excludes all breaks from the schedule duration.

For example, an employee is scheduled from 8:00 to 15:30 with a scheduled break from 12:00 to 12:30. By default, the break is included in the schedule duration, so the rule uses a duration of 7.5 hours in its calculations. If you configure the rule to exclude the break from the schedule duration, the rule would instead use a duration of 7 hours.

 One of the drop-down list selections

Overtime Allocation Parameters

Overtime is applied either to work detail records or by inserting premiums. When applying overtime to work detail records, the parameters associated with applying overtime as a premium are not considered. The reverse is also true.

Select Apply overtime to work detail records to use these parameters:

Parameter Description Valid Values
Protected Work Detail Hour Types This parameter specifies the hour types that count toward overtime but are not eligible to earn overtime. The rule counts work details with protected hour types against the threshold values defined in the Hour Set Description parameter, but does not change the hour types of protected work details or insert a corresponding premium. For an example, see Business Example 3 - Weekly Overtime Plus Rule. Hour types specified in this parameter must also be specified in the Work Detail Hour Types as well. Select the protected hour types. If left blank, no hour types are protected. Overtime is not earned on protected work details alone. On any day that an employee has only recorded protected work details, the rule does not pay any overtime or premiums. Any valid hour types
Protected Work Detail Time Codes This parameter specifies the time codes that count toward overtime but are not eligible to earn overtime. The rule counts work details with protected eligible time codes against the threshold values defined in the Hour Set Description parameter, but does not change the hour types of protected work details or insert a corresponding premium. For an example, see Business Example 3 - Weekly Overtime Plus Rule. Time codes specified in this parameter must also be specified in the Work Detail Time Codes as well. Select the protected eligible time codes. If left blank, no time codes are protected. Overtime is not earned on protected work details alone. On any day that an employee has only recorded protected work details, the rule does not pay any overtime or premiums. Any valid time codes
First hour type changes work detail hour types This parameter is selected by default and the rule converts eligible work details that fall within the duration of the first hour type's threshold in the Hour Set Description to that hour type. So, if Hour Set Description is set to REG=2400, OT1=3000*, OT2=9999 the hour types of the first 2400 minutes of eligible work details are converted to REG. Clear the check box to configure the rule to only convert the hour types of eligible work details above the first threshold. Selected or cleared
Allocate overtime based on the schedule This parameter determines how overtime is applied. When cleared, the rule applies overtime starting at the end of the overtime period, working backwards until all overtime is applied to eligible time. When selected, the rule attempts to apply overtime to eligible work during unscheduled time. Scheduled time is only paid at an overtime rate if an employee is scheduled beyond the overtime threshold. When an employee earns overtime during unscheduled time, as is most often the case, the rule ensures that the eligible work details that occur during scheduled time have the REG hour type (or the first hour type in the Hour Set Description); also, the first eligible work details in unscheduled time have this hour type when the first overtime threshold is beyond the employee's scheduled time. For example, with an Hour Set Description of REG=2520, OT1=9999 and an employee who is scheduled for 40 hours (2400 minutes), but works 50, earns 8 hours of overtime. The 40 hours of scheduled time and the first 2 hours of eligible work details during the overtime period have the REG hour type. The rest is assigned the OT1 hour type. For another example, see Business Example 4 - Weekly Overtime Plus Rule. Selected or cleared
Assign equal or better hour type to eligible work details Select to ensure the rule does not pay overtime at an equal or lower rate to the employee's original rate. When selected, the rule does not convert eligible hour types to overtime hour types with equal or lower multipliers. For an example, see Business Example 1 - Weekly Overtime Plus Rule. When the check box is cleared, the rule converts eligible hour types according to the related configuration, without comparing the overtime hour type to existing hour types. Selected or cleared
Allocate To Non-Home Team? Select this option to allocate overtime hours first to an employee's non-home team assignment. This option lets teams loan out employees to alternate locations without having to incur the extra cost of having the employee fall into overtime.

When selected, the rule will use this overtime allocation logic:

  1. The first hour type specified in the Hour Set Description (typically REG) will be applied first against time that has been allocated to the employee's home team.
  2. If there is any REG time left to give after Step 1, it will be applied to time allocated to a non-home team, in chronological order. After all REG time has been exhausted, the subsequent hour types defined in the Hour Set Description are applied to the remaining hours worked on the employee's non-home teams.
  3. If any time remains after Step 2, it will be applied to the remaining home team time based on the definition in the Hour Set Description.
 Selected or cleared
Use Loose Home-Team Logic? When selected, the rule does not consider a team to be a borrowing team if any of these conditions are true:
  • The employee's home team and the non-home team have the same immediate parent team.
  • The employee's home team is the parent of the non-home team.
  • The non-home team is the parent of the employee's home team.
When cleared, any team that is not the employee's home team is considered a borrowing team.
Note: This parameter can only be used when the Allocate to Non-Home Team? parameter is also selected.
Selected or cleared

The rule can be configured to insert overtime premiums instead of changing the hour types of work details. If either the Premium Time Code or Premium Hour Type parameters has a value, this option is disabled.

Select Apply overtime as a premium to use these parameters:

Parameter Description Valid Values
Insert a premium for the first hour type in the hour set description Select to configure the rule to insert a premium for eligible work that satisfies the first threshold. The rule inserts a premium of equal length to the time the employee worked in the first threshold of the Hour Set Description parameter. Clear the check box to configure the rule to only insert premiums for eligible time employees work beyond the first threshold. Selected or cleared
Insert premiums based on the schedule This parameter determines how overtime premiums are inserted. When cleared, the rule inserts overtime premiums matching the eligible work that earned the premium, starting at the end of the overtime period and working backwards until all overtime has been paid out as premiums. When selected, the rule attempts to insert overtime premiums matching eligible work during unscheduled time. Premiums are only paid for eligible scheduled time if an employee is scheduled beyond the overtime threshold. When an employee earns overtime during unscheduled time, overtime premiums are inserted to match the first eligible work outside of the schedule that earned the employee overtime. For example, with an Hour Set Description of REG=2520, OT1=9999 and an employee who is scheduled for 40 hours (2400 minutes), but works 50, 8 hours of overtime premiums are inserted. The first 2 hours of unscheduled eligible work details during the overtime period do not earn the employee overtime. Overtime premiums are paid to match the next 8 hours of unscheduled eligible work. Selected or cleared
Populate premium time fields Select to populate the Start Time and End Time fields on the Daily Timesheet and the Work Details pop-up with the premium's start and end time. When selected, the premium is coupled to the earned work time. If the eligible work is from 20:00 to 22:00, the resulting 2-hour premium is also from 20:00 to 22:00. If the parameter is not selected the premium's start and end times are not displayed. Selected or cleared
Calculate Rate This parameter determines the hour type multiplier that is used to calculate the premium rate.

When selected, the premium rate is calculated as the employee base rate multiplied by the premium hour type multiplier.

When cleared, the premium rate is calculated as the employee base rate multiplied by the hour type multiplier of the first EDLA record. This is the default behavior.

 Selected or cleared
Premium Hour Type This parameter determines the hour types of overtime premiums. There are two options:
  • Select Assign hour type according to the Hour Set Description to use the hour types provided in the Hour Set Description parameter. The rule inserts premiums with the same hour types as the specified thresholds.
  • Select Allocate proportionally by hour type to proportion overtime premium hours by hour type. The rule inserts premiums with hour types in the same ratio as the eligible work.
One of the options
Hour type marker for work details with overtime Select an hour type to configure the rule to mark work details which earn employees an overtime premium. The rule changes the hour types of the details that trigger an overtime premium to the selected hour type. The specified hour type should also be specified in the Work Detail Hour Types parameter. For an example, see Business Example 2 - Weekly Overtime Plus Rule and Business Example 5 - Weekly Overtime Plus Rule. If left blank, the rule does not change the hour types of the details that trigger overtime premiums. Selected or cleared
Premium Time Code This parameter determines the time codes of overtime premiums. There are two options:
  • Select Assign time code and select a time code using the lookup to specify the time code of inserted premiums. Every premium the rule inserts uses the specified time code.
  • Select Allocate proportionally by time code to proportion overtime premium hours by time code. The rule inserts premiums with time codes in the same ratio as the eligible work.
One of the options
Override Premium Default Labor Settings parameters (click '+' to expand):

These parameters define which labor metrics overtime premiums are paid against. By default, the labor metrics specified in the employee's default labor allocation are used. You can either specify labor metrics, or configure the rule to proportion overtime hours against the labor metrics of the eligible work.

For an example of allocating overtime premiums proportionally by the labor metrics, see Business Example 5 - Weekly Overtime Plus Rule and Business Example 6 - Weekly Overtime Plus Rule.

Premium Job This parameter determines what job overtime premiums are charged against. There are two options:
  • Select Assign job to specify the job. Select which job the premium is charged against using the lookup or leave the lookup blank and the premium's job labor metric is determined by the employee's default labor allocation.
  • Select Allocate proportionally by job to proportion overtime premium hours by job, in the same ratio as the eligible work. The rule pays the premium against the same jobs as the eligible work, in the same ratio.
One of the options
Premium Department This parameter determines what department overtime premiums are charged against. There are two options:
  • Select Assign department to specify the department. Select which department the premium is charged against using the lookup, or leave the lookup blank and the premium's department labor metric is determined by the employee's default labor allocation.
  • Select Allocate proportionally by department to proportion overtime premium hours by department, in the same ratio as the eligible work. The rule pays the premium against the same departments as the eligible work, in the same ratio.
One of the options
Premium Project This parameter determines what projects overtime premiums are charged against. There are two options:
  • Select Assign project to specify the project. Select which project the premium is charged against using the lookup, or leave the lookup blank and the premium's project labor metric is determined by the employee's default labor allocation.
  • Select Allocate proportionally by project to proportion overtime premium hours by project, in the same ratio as the eligible work. The rule pays the premium against the same projects as the eligible work, in the same ratio.
One of the options
Premium Docket This parameter determines what dockets overtime premiums are charged against. There are two options:
  • Select Assign docket to specify the docket. Select which docket the premium is charged against using the lookup, or leave the lookup blank and the premium's docket labor metric is determined by the employee's default labor allocation.
  • Select Allocate proportionally by docket to proportion overtime premium hours by docket, in the same ratio as the eligible work. The rule pays the premium against the same dockets as the eligible work, in the same ratio.
One of the options
Allocate proportionally by team Select to proportion overtime premium hours by team, in the same ratio as the eligible work. The rule pays the premium against the same teams as the eligible work, in the same ratio. Selected or cleared
Assign Premium Quantity Specify the premium's quantity value. If left blank, the premium's quantity labor metric is determined by the employee's default labor allocation. Any valid quantity