Weekly Overtime Plus Rule

The Weekly Overtime Plus Rule 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 have worked. The rule can be configured to pay employees different rates at different thresholds, so that employees are paid differently the longer they work.

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

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 Hour Set Description parameter 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, each of which specifies an hour type and a duration in minutes, such as REG=2400, OT1=99999.

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 in these ways:

A number of minutes, representing an interval. The next block of worked time of the specified length is paid at the token’s rate.
See Business Example 1 - Weekly Overtime Plus Rule.
A number of minutes, representing a cumulative value. Any time after the previous token’s duration and up to the specified length is paid at the token’s rate.
See Business Example 2 - Weekly Overtime Plus Rule.
The value of an employee value field or a user-defined field. The rule retrieves the duration from the specified field, which allows you to define different thresholds for different employees.
See Business Example 3 - Weekly Overtime Plus Rule and Business Example 5 - Weekly Overtime Plus Rule.

You can define default values for the fields by typing |# (# is the default value in minutes) after the field name.

See Business Example 3 - Weekly Overtime Plus Rule.

The field’s value can be multiplied by any decimal value by typing (#) (# is the multiplier) after the field name.

See Business Example 5 - Weekly Overtime Plus Rule.

You can also 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.

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 these conditions:

Eligible work details, which 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, which count as worked time but are not eligible to earn overtime. Eligible work details can be defined by time code, hour type, or both.
See Business Example 3 - Weekly Overtime Plus Rule.
Eligible premiums, which count as worked time but are not eligible to earn overtime. Eligible premiums can be defined by time code, hour type, or both.
See Business Example 4 - Weekly Overtime Plus Rule.
By default, premiums are not eligible to earn overtime, but you can apply overtime to premiums by selecting Apply overtime to premiums in the Overtime Allocation parameters.

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 an hour type with a higher rate.

Overtime premiums can be charged against specific labor metrics, such as certain projects or departments.

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.

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.

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.

Overtime Eligibility parameters

This table describes the parameters under Overtime Eligibility.


Parameter	Description
Hour Set Description	Specifies when employees are paid overtime. The value of this parameter is a comma-separated list of tokens. Each token consists of an hour type and a duration in minutes. When employees work beyond the time specified for the first token, they are paid according to the next token's hour type, and so on. Each hour type's duration can be defined by one of these options: =#, where # is any non-negative integer, representing an interval of minutes. See Business Example 1 - Weekly Overtime Plus Rule. =0, only used after the first token, and represents scheduled time. See Business Example 2 - Weekly Overtime Plus Rule. =EMP_VAL#, where # is an employee value field (numbered 1 to 20) that contains a non-negative integer. See Business Example 3 - Weekly Overtime Plus Rule. =EMPDUF~UDFNAME, where UDFNAME specifies the name of a user-defined field containing a non-negative integer. See Business Example 5 - Weekly Overtime Plus Rule. Additional operators can be used with the tokens: * to designate cumulative number of minutes. Generally combined with =0 on the first token, so that unscheduled time up to a certain limit is paid at an overtime rate. See Business Example 2 - Weekly Overtime Plus Rule. \|# to define a default value for UDFs or employee values. See Business Example 3 - Weekly Overtime Plus Rule. (#) to define the UDFs or employee value multiplier. The actual duration becomes the number stored in the specified UDF or employee value field, multiplied by this multiplier. See Business Example 3 - Weekly Overtime Plus Rule or Business Example 5 - Weekly Overtime Plus Rule. If an employee works beyond the duration of the total time in the hour set, the time is ignored.
Work Detail Hour Types	Comma-separated list of 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 field and either changes the hour types to reflect overtime or inserts a corresponding premium. This parameter must contain the same hour types as every threshold but the last in the Hour Set Description field. For example, if you specify hour types REG, OT1, and OT2 for the Hour Set Description field, then REG and OT1 must be specified in the Work Detail Hour Types field.
Work Detail Time Codes	Comma-separated list of 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 field and either changes the hour types to reflect overtime or inserts a corresponding premium. Leave blank to configure the rule to consider all time codes eligible.
Premium Hour Types	Comma-separated list of premium hour types that count toward overtime. By default, premiums are not eligible to earn overtime, but the rule counts premiums with the specified hour types against the threshold values defined in the Hour Set Description field. Note: If the Premium Hour Types field has a value, the Apply overtime as a premium option is disabled.
Premium Time Codes	Comma-separated list of premium time codes that count toward overtime. By default, premiums are not eligible to earn overtime, but the rule counts premiums with the specified time codes against the threshold values defined in the Hour Set Description field. Note: If the Premium Time Codes field has a value, the Apply overtime as a premium option is disabled.
Overtime Period	Specify the range of time over which overtime is calculated. Select one of these options: Week: Calculates overtime on a weekly basis. Select the day on which the week starts from the Day Week Starts list. Select a day of the week, or select Application Default to use the day specified in the DAY_WEEK_STARTS registry parameter. Calendar Month: Calculates overtime on a monthly basis. The rule calculates monthly overtime based on the calendar month, so the first day of the month is the first day of the overtime period, and the last day of the 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 option can affect overall performance as more system resources are required. Pay Period: Calculates overtime on a pay period basis. The overtime period starts on the first day of the pay period and ends on the last day of the pay 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. Specify a start date in the Start Date field and the number of days in the No. of Days field. For example, suppose the start date is June 1 and the number of days is 28. After overtime is applied for the calculation period from June 1 to June 28, the start date of the overtime period is moved forward to June 29. Shift Pattern: Calculates overtime based on the employee's shift pattern. 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 there is a shift pattern offset. Note: You must configure the calculation group's Auto Recalc field 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.
Deduct Breaks from Schedule Duration	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.

Overtime Allocation parameters

Overtime is applied either to work detail records or by inserting premiums. The parameters are different depending on which option you select

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


Parameter	Description
Protected Work Detail Hour Types	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 field, but does not change the hour types of protected work details or insert a corresponding premium. See Business Example 3 - Weekly Overtime Plus Rule. Hour types specified in this parameter must also be specified in the Work Detail Hour Types field. If left blank, no hour types are protected.
Protected Work Detail Time Codes	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 field, but does not change the hour types of protected work details or insert a corresponding premium. See Business Example 3 - Weekly Overtime Plus Rule. Time codes specified in this parameter must also be specified in the Work Detail Time Codes field. If left blank, no time codes are protected.
First hour type changes work detail hour types	If selected, the rule converts eligible work details that fall within the duration of the first hour type specified in the Hour Set Description field to that hour type. For example, if the Hour Set Description field specifies REG=2400, OT1=3000*, OT2=9999, then the hour types of the first 2400 minutes of eligible work details are converted to REG. If this check box is not selected, the rule only converts the hour types of eligible work details beyond the first threshold.
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. See Business Example 4 - Weekly Overtime Plus Rule.
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. 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.
Allocate to Non-Home Department?	Select this option to allocate overtime hours first to an employee's non-home department where the employee is scheduled to work. This option lets employees work in different departments when needed without having the home department incur the extra cost of having the employee fall into overtime. An employee's home department is defined in the Employee Labor Allocation section of the Employee Override page. Employees can be assigned to multiple home departments at different ratios. When selected, the rule uses this overtime allocation logic: The first hour type specified in the Hour Set Description (typically REG) is applied first against time that has been allocated to the employee's home department. If there is any REG time left to give after Step 1, it is applied to time allocated to a non-home department where the employee is scheduled to work. 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 departments. If any time remains after Step 2, it is applied to the remaining home department time based on the definition in the Hour Set Description. If an employee has worked in multiple non-home departments during a pay period, then overtime is allocated to the corresponding department for the amount of time worked. Note: If the employee is not scheduled or scheduled without department information, any overtime is allocated to the employee's home department. To allocate overtime to a non-home department, we recommend that the Allocate overtime based on the schedule parameter is cleared. With this setting, the system looks at hours and labor allocation entered on timesheets to calculate overtime. This parameter is disabled when the Allocate To Non-Home Team? check box is selected. If you want to use both options, configure two rules with the appropriate conditions in each.
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 uses this overtime allocation logic: The first hour type specified in the Hour Set Description (typically REG) is applied first against time that has been allocated to the employee's home team. If there is any REG time left to give after Step 1, it is 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. If any time remains after Step 2, it is applied to the remaining home team time based on the definition in the Hour Set Description. This parameter is disabled when the Allocate To Non-Home Department? check box is selected. If you want to use both options, configure two rules with the appropriate conditions in each.
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? check box is selected.
Apply overtime to premiums	Select this check box to apply overtime to premiums in addition to work details.
Protected Premium Hour Types	Specifies the premium hour types that count toward overtime but are not eligible to earn overtime. Hour types specified in this parameter must also be specified in the Premium Hour Types field. This field is disabled if Apply overtime to premiums is not selected.
Protected Premium Time Codes	Specifies the premium time codes that count toward overtime but are not eligible to earn overtime. Time codes specified in this parameter must also be specified in the Premium Time Codes field. This field is disabled if Apply overtime to premiums is not selected.

This table describes the parameters under Apply overtime as a premium.

Note: If either the Premium Time Code or Premium Hour Type parameter under has a value, this option is disabled.


Parameter	Description
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.
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.
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.
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.
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.
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. 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.
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.

Premium Default Labor Settings parameters

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.

See Business Example 5 - Weekly Overtime Plus Rule and Business Example 6 - Weekly Overtime Plus Rule.


Parameter	Description
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.
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.
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.
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.
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.
Allocate proportionally by FSM attributes	Select to proportion overtime premium hours by FSM attributes.
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.