Weekly Overtime Split Rule

Class Name

com.workbrain.app.ta.quickrules.WeeklyOvertimeSplitRule

Overview

The Weekly Overtime Split Rule calculates weekly overtime based on a specific cut-off time and day. For example, if the start of a week is defined as Sunday 18:00, then the overtime for a work week is calculated from Sunday 18:00 to Sunday 18:00.

You can configure discount time codes and hour types. Work details with these time codes or hour types count toward overtime, but are not considered paid overtime. For example, if an employee starts to earn overtime after working 40 hours a week, but has worked 5 hours with a discount time code, the employee starts gaining overtime after 35 hours, but the employee is not paid overtime for the 5 hours with the discount time codes.

The Weekly Overtime Split Rule must be used in combination with the Split Detail Rule. Configure the Split Detail Rule to run at the end of each run cycle to change the work detail date for any work details that fall outside of the time range.

Parameters

Parameters marked with an asterisk (*) are required.

Parameter Description
*Hour Set Description This parameter defines the conditions that employees earn overtime. The parameter specifies how many hours employees must work at the regular hour type before earning overtime.

Specify a comma-delimited list of tokens. Each token consists of an hour type and duration in minutes in this format: HTYPE=#, HTYPE=#.

For example, specify REG=2880,OT1=9999 to configure the rule to assign the OT1 overtime rate after the employee works 48 hours (2880 minutes). The rule assigns the REG rate to the first 2880 minutes employees work and then the OT1 rate to any time worked after that.

You can specify several tokens in a list to configure the rule to assign different rates when the amount of time employees work in the day reach different thresholds. For example, you can assign overtime after employees work more than 44 hours and double-overtime after employees work more than 60 hours.

Work Detail Time Codes Specify a comma-separated list of time codes that mark time which counts toward earning overtime. The rule includes work details with one of the specified time codes toward the conditions that are specified in the Hour Set Description.
*Eligible Hour Types Specify a comma-separated list of hour types that mark time the rule counts toward earning overtime. The rule includes work details with one of the specified hour types toward the conditions that are specified in the Hour Set Description parameter.

By default, the value is REG.

Premium Time Codes Counted Specify a comma-separated list of premium time codes that count toward overtime. For example, if holidays are paid as premiums, specify the time code that is used by the holiday premium so that time employees work on holidays counts toward overtime.
Discount Time Codes Specify a comma-separated list of time codes that count toward employees earning overtime, but are not paid at the overtime rate, such as the SICK time code.

Work details that are marked with one of the specified time codes are discounted or subtracted from the total amount of time employees must work before earning overtime.

For example, if employees earn overtime after working 9 hours a day, but an employee records 3 hours of work details with a discount time code, the employee earns overtime after working 6 hours.

If the code is included in the Hour Set Description parameter, the code will get paid and the time will be discounted.

Choosing one of the codes is important for proper behavior.

Discount Hour Types Specify a comma-separated list of hour types that count toward employees earning overtime, but are not paid at the overtime rate.

Work details that are marked with one of the specified hour types are discounted or subtracted from the total amount of time employees need to work before earning overtime.

By default, this parameter is blank and the rule assumes all hour types are discount hour types.

*Day Week Starts Select the first day of the week from the drop-down list.
Premium Time Code Inserted Specify a time code to configure the rule to insert a premium for the overtime instead of updating the work detail with the appropriate rate.

By default, this parameter is null and the rule assigns overtime by changing the hour type of work details to an appropriate rate.

When set with a time code, the rule inserts a premium with the specified time code.

When using a premium, the application does not apply hour type betterment.

Assign Better Rate Select this check box to prevent situations that can arise whereby switching an employee to an overtime hour type results in the employee being paid a lower rate.
Hour type For Overtime Work Details Specify the hour type of the overtime work details if the rule inserts a premium. This parameter is used only when a time code is specified in the Premium Time Code Inserted parameter. The hour type marks the work details that produce overtime premiums so that they can be:
  • Excluded/included in other overtime rules
  • Distinguished as details that produced the overtime
24 Hour Start Time This parameter is used by the rule, in conjunction with the employee's day start time, to determine the time the week is split.
*Start Time Day This parameter allows the user to further specify a condition for which day is the start of the week. The start of week can be the day of the week that is specified in Day Week Starts or Previous Day, which sets the start day to the day before the Day Week Starts parameter.

Select either Day Week Starts or Previous Day from the drop-down list.

For example, if the Day Week Starts is set to SUNDAY, HourStartTime is set to 06:00, and Start Time Day is set to Previous Day, then the week ranges from Saturday 06:00 to Saturday 06:00.