Shift Premium Zone Rule
The Shift Premium Zone Rule automatically pays premiums to employees as extra compensation for working under certain circumstances. The rule relies on the configuration of shift premium zones, which determine when and how the premium is paid.
Technical Details
com.workbrain.app.ta.quickrules.ShiftPremiumZoneRule
Overview
The Shift Premium Zone Rule is used to pay premiums to employees, according to the configuration of a shift premium zone. A shift premium zone is a range of time, during which eligible employees earn premiums for eligible work.
Premiums can be paid based on a variety of factors, such as the employee’s schedule, the hours the employee works, or if the employee worked unscheduled time. Premiums can be limited to employees working specific jobs or projects, or to employees who work a minimum amount of time.
The main aspects of premiums, controlled by shift premium zones, are:
- Which employees are eligible to earn the premium?
- What work earns employees the premium?
- How is the premium amount calculated?
- What is the maximum employees can earn in a premium?
Which employees are eligible?
You define which employees are eligible to earn the premium by applying the rule to their calculation group. Only the employees in the calculation groups to which the rule is applied are eligible to earn the zone’s premium.
The list of eligible employees, drawn from the calculation groups, can be further refined based on:
- The employee’s shift or shift pattern. Premiums can be limited to employees who are assigned to specific shifts or shift patterns. For an example, see Business Example 1 - Shift Premium Zone.
- The employee being scheduled during a specific range of time. For an example, see Business Example 3 - Shift Premium Zone.
- The employee’s shift starting or ending before or after specific times. For examples, see Business Example 2 - Shift Premium Zone and Business Example 4 - Shift Premium Zone.
What work earns a premium?
The initial factor that determines whether an employee's work earns a premium is when the work occurred. The worked time must occur during the time range defined by the shift premium zone's start and end time. These times define the range of time during which eligible work is paid a premium.
Work details are records in the application with a start and end time, associated time codes, hour types, labor metrics, and other information, which describe what an employee was doing for a period of time. If a work detail occurs during the shift premium zone, the work detail potentially earns the employee a premium, but the work detail must pass the zone's conditions. If a work detail in the zone passes all the zone's conditions, the work detail is considered eligible work and earns the employee a premium.
You can define what work details are eligible to earn premiums based on:
- The time code. You must define what time codes are considered eligible work so that employees are only paid premiums for appropriate activities. For an example, see Business Example 1 - Shift Premium Zone.
- The hour type. Eligible work can be limited to time paid at the employee's regular rate, time and a half, or any specific hour type. For an example, see Business Example 1 - Shift Premium Zone.
- The associated labor metrics. Eligible work can be limited to time spent working in specific departments or on specific jobs. For an example, see Business Example 3 - Shift Premium Zone.
- Whether the worked time was scheduled. For an example, see Business Example 3 - Shift Premium Zone.
- Whether the worked time was unscheduled. For an example, see Business Example 5 - Shift Premium Zone.
- The amount of time the employee worked during the zone. You can configure the minimum amount of time an employee must work during the zone before earning a premium. For an example, see Business Example 1 - Shift Premium Zone.
- The work starting or stopping before or after specific times. For examples, see Business Example 2 - Shift Premium Zone and Business Example 4 - Shift Premium Zone.
In addition to eligible work, the rule can also be configured to pay premiums on work premiums (for example, when an employee receives premium time that must be included in the employee's calculated shift premium monies owed). For an example, see Business Example 6 - Shift Premium Zone.
How is the premium amount calculated?
The basic premium amount is calculated as the premium's rate multiplied by the duration of the premium. The zone's start and end times define the duration of the zone and set the boundaries during which premiums can be earned.
You configure how the premium duration is determined. The premium duration can be:
- Equal to the duration of the eligible work details in the zone. For examples, see:
- A constant duration for all eligible employees, regardless of the duration of eligible time worked in the zone. For an example, see Business Example 4 - Shift Premium Zone.
Also, you configure how the premium rate is calculated. The premium rate can be:
- A dollar amount as an hourly rate. For examples, see Business Example 1 - Shift Premium Zone and Business Example 4 - Shift Premium Zone.
- A percentage of the employee's base rate. For examples, see Business Example 2 - Shift Premium Zone and Business Example 5 - Shift Premium Zone.
- A percentage of the worked rate.
What is the maximum employees can earn?
The maximum amount employees can earn from a premium can be controlled by several parameters. The maximum amount is partially controlled by the duration of the shift premium zone. The larger the zone, the longer employees can perform eligible work, and the larger the premiums.
The rule can be configured to insert premiums of a constant duration. So this duration, multiplied by the premium's rate, defines how much employees can earn.
You can also limit how much employees can earn from premiums by:
- Setting the maximum duration of the premium, in minutes, employees can earn in a day. For an example, see Business Example 5 - Shift Premium Zone.
- Setting the maximum dollar amount employees can earn in a day. For an example, see Business Example 3 - Shift Premium Zone.
Configuration
The Shift Premium Zone Rule's behavior is based on the values of the rule's parameters, the conditions assigned to the rule, and the parameters of the shift premium zones the rule implements.
The majority of the configuration involves the shift premium zone. Add shift premium zones through
.Rule Parameters
Parameter | Description | Valid Values |
---|---|---|
Shift Premium Zone | The names of the shift premium zones to which the rule applies. You can select one or multiple zones. If left blank, the rule applies all shift premium zones that are set up in the application. | Either:
|
Shift Premium Zone Parameters
Parameters marked with an asterisk (*) are required.
Fields marked with ++ are not displayed, by default, on versions of the application that were upgraded to the 5.0.5.0 release. See Upgrade information.
Parameter | Description | Valid Values |
---|---|---|
*Zone Name | Specify the name of the shift premium zone. | Any text |
Zone Description | Specify a brief description. | Any text |
*Zone Start Time | Specify the start time of the shift premium zone. Only eligible work details on or after this time, and before the Zone End Time, earn a premium. Zones can span midnight, such as from 22:00 to 2:00 the following day. If the start time is greater than the end time, the application assumes the zone crosses midnight and the Zone End Time occurs on the next day. If you specify the same time for the Zone Start Time and Zone End Time parameters, the zone covers a 24-hour period, starting at the time specified and ending at the same time the next day. For an example, see Business Example 5 - Shift Premium Zone. | A time value, in HH:mm format |
*Zone End Time | Specify the end time of the shift premium zone. Only eligible work details after the Zone Start Time and before this time earn a premium. | A time value, in HH:mm format |
Time Code | Select the premium's time code. When employees earn
premiums, the premium record is inserted on their timesheet with the
specified time code. Note: The time code is required unless the Labor Metrics
Method parameter is set to Update Details
Directly. If the Labor Metrics Method parameter is set to
Update Details Directly, then
the rule updates the affected work details directly instead of creating a
premium record. With this configuration, if a time code is specified in
this field, the time code value is updated in the work details to which
the shift premium zone applies. If left blank, the time code value of the
affected work details remains unchanged.
|
Any valid time code |
Hour Type | Select the premium's hour type. When employees earn
premiums, the premium record is inserted on their timesheet with the
specified hour type. The specified hour type's multiplier (the value of the
Multiple
field on the related configuration page) is also used with the Apply Hour
Type Multiplier to the Rate parameter, if selected. If left blank, the rule
uses the hour type of the work detail that earned the employee the premium.
If multiple eligible work details have different hour types, the rule
inserts one premium for each work detail with a different hour type. Note: If the Labor Metrics Method parameter is set to
Update Details Directly, then
the rule updates the affected work details directly instead of creating a
premium record. With this configuration, if an hour type is specified in
this field, the hour type value is updated in the work details to which
the shift premium zone applies. If left blank, the hour type value of the
affected work details remains unchanged. When updating the affected work
details directly, the Apply Hour Type Multiplier to the Rate parameter
can also be used.
|
Any valid hour type |
*Labor Metrics Method++ | Select what the premium's labor metrics are based on
from the drop-down list. When employees earn premiums, they are charged
against labor metrics, such as specific departments or jobs. The premium's
labor metrics can be based on one of these options:
When Update Details Directly is selected, then the Apply Hour Type Multiplier to Hours, Insert Lump Sum of Minutes, and Populate Premium Time Fields parameters are ignored. |
One of the drop-down list selections |
Job++ | Select which job the premium is charged against. This
selection overrides any job labor metric that is inserted using the Premium
Labor Metrics Method parameter. If left blank, the premium's job labor
metric is determined by the Premium Labor Metrics Method parameter. If the Labor Metrics Method parameter is set to Update Details Directly, then the rule updates the affected work details directly instead of creating a premium record. With this configuration, if a job is specified in this field, the job value is updated in the work details to which the shift premium zone applies. If left blank, the job value of the affected work details remains unchanged. |
Any valid job |
Department++ | Select which department the premium is charged
against. This parameter overrides any department labor metric that is
inserted using the Premium Labor Metrics Method parameter. If left blank,
the premium's department labor metric is determined by the Premium Labor
Metrics Method parameter. If the Labor Metrics Method parameter is set to Update Details Directly, then the rule updates the affected work details directly instead of creating a premium record. With this configuration, if a department is specified in this field, the department value is updated in the work details to which the shift premium zone applies. If left blank, the department value of the affected work details remains unchanged. |
Any valid department |
Project++ | Select which project the premium is charged against.
This parameter overrides any project labor metric that is inserted using the
Premium Labor Metrics Method parameter. If left blank, the premium's project
labor metric is determined by the Premium Labor Metrics Method parameter. If the Labor Metrics Method parameter is set to Update Details Directly, then the rule updates the affected work details directly instead of creating a premium record. With this configuration, if a project is specified in this field, the project value is updated in the work details to which the shift premium zone applies. If left blank, the project value of the affected work details remains unchanged. |
Any valid project |
Docket++ | Select which docket the premium is charged against.
This parameter overrides any docket labor metric that is inserted using the
Premium Labor Metrics Method parameter. If left blank, the premium's docket
labor metric is determined by the Premium Labor Metrics Method parameter. If the Labor Metrics Method parameter is set to Update Details Directly, then the rule updates the affected work details directly instead of creating a premium record. With this configuration, if a docket is specified in this field, the docket value is updated in the work details to which the shift premium zone applies. If left blank, the docket value of the affected work details remains unchanged. |
Any valid docket. |
Quantity++ | Specify the premium's quantity value that the premium
is charged against. This value overrides any quantity labor metric that is
inserted using the Premium Labor Metrics Method parameter. If left blank,
the premium's quantity labor metric is determined by the Premium Labor
Metrics Method parameter. If the Labor Metrics Method parameter is set to Update Details Directly, then the rule updates the affected work details directly instead of creating a premium record. With this configuration, if a quantity is specified in this field, the quantity value is updated in the work details to which the shift premium zone applies. If left blank, the quantity value of the affected work details remains unchanged. |
Any valid quantity |
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 worked time that
earns the premium. 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, or if the Insert Lump Sum of Minutes parameter is used, the
premium's start and end times are not displayed. This parameter is not applicable when the Labor Metrics Method parameter is set to Update Details Directly. |
Selected or cleared |
*Rate | Specify the rate at which the premium is paid. When
the Rate is a Percentage? parameter is selected, this number is a percentage
of the employee's base rate or worked rate (as indicated in the Rate to Use
parameter). Otherwise, this number is a dollar amount, representing an hourly rate. If the Labor Metrics Method parameter is set to Update Details Directly, then the rule updates the affected work details directly instead of creating a premium record. With this configuration, the calculated rate is used to update the rate value of the work details to which the shift premium zone applies. |
Any integer. You can specify up to 2 decimal places. 20.55 represents 20.55% or $20.55 an hour. |
Rate is a Percentage? | When selected, the value in the Rate parameter represents a percentage of the employee's base rate or the worked rate (as indicated in the Rate to Use parameter). When cleared, the Rate value is a dollar amount. | Selected or cleared |
*Rate to Use | Select whether the premium is calculated as a
percentage of the employee's base rate or the worked rate:
This parameter is only used when the Rate is a Percentage? parameter is selected. |
One of the drop-down list selections |
Apply Hour Type Multiplier to the Rate++ | Select to multiply the rate by the premium's hour type
multiplier. If the premium's hour type has a multiplier of 0, the rule
inserts premiums with a rate of 0. If the Labor Metrics Method parameter is set to Update Details Directly, then the rule updates the affected work details directly instead of creating a premium record. With this configuration, if this option is selected, then the hour type multiplier is applied to the rate value that is updated in the work details to which the shift premium zone applies. |
Selected or cleared |
Apply Hour Type Multiplier To Hours | Select to multiply the premium's duration by the hour
type multipliers of the work details that earned the premium. For an
example, see Business Example 5 - Shift Premium Zone. This parameter is ignored if the Insert
Lump Sum of Minutes parameter has a value. If this parameter is selected but
the Hour Type parameter is blank, the rule uses the hour type multiplier of
the premium's time code. This parameter is not applicable when the Labor Metrics Method parameter is set to Update Details Directly. |
Selected or cleared |
Insert Lump Sum of Minutes | Leave this parameter blank to configure the rule to
calculate the duration of the premium to be proportionate to the duration of
eligible work details in the zone. Specify the duration, in minutes, of the
premium that employees earn if they report any eligible work during the
shift premium zone. Regardless of the amount of eligible time employees work
during the zone, the premium duration is the specified value. If you specify
a value, the rule ignores the Apply Hour Type Multiplier to Hours? and
Premium Maximum Minutes per Day parameters. Also, the rule uses the
employee's default labor allocations. This parameter is not applicable when the Labor Metrics Method parameter is set to Update Details Directly. |
Blank or any integer, representing minutes |
Premium Maximum Minutes per Day | Specify the maximum number of premium minutes an employee can earn per day for eligible work in the zone. The maximum duration only takes into account premiums earned from this shift premium zone. | Any positive integer, representing minutes |
Premium Maximum Dollars per Day | Specify the maximum dollar amount employees can earn in premiums, per day, for eligible work in the zone. The maximum dollar amount only takes into account premiums earned from this shift premium zone. | Any positive integer, representing dollars |
Eligible Time Codes | Select the time codes that define eligible work. Time without the selected time codes does not earn employees a premium, even if the time falls within the zone. If left blank, all time codes are considered eligible work. | Any valid time code |
Eligible Hour Types | Select the hour types that define eligible work. Time without the selected hour types does not earn employees a premium, even if the time falls within the zone. If left blank, all hour types are considered eligible work. | Any valid hour type |
Eligible Shift Patterns | Select the eligible shift patterns. Employees not working the selected shift patterns do not earn premiums, even if they work during the zone. If left blank, employees can be assigned to any shift pattern and be eligible. | Any valid shift pattern |
Day Type | Select on which days employees can earn premiums:
|
One of the drop-down list selections |
Eligible Shifts | Select the eligible shifts. Employees not working the selected shifts do not earn premiums, even if they work during the zone. If left blank, employees can be assigned to any shift and be eligible. The value of the Base Shift Eligibility on parameter impacts what the rule considers as the employee's shift. | Any valid shift |
Eligible Jobs++ | Select the jobs that define eligible work. Time worked for other jobs does not earn employees a premium, even if the time falls within the zone. If left blank, work in any job is considered eligible work. | Any valid job |
Eligible Departments++ | Select the departments that define eligible work. Time worked for other departments does not earn employees a premium, even if the time falls within the zone. If left blank, work in any department is considered eligible work. | Any valid department |
Eligible Projects++ | Select the projects that define eligible work. Time worked for other projects does not earn employees a premium, even if the time falls within the zone. If left blank, work in any project is considered eligible work. | Any valid project |
Eligible Dockets++ | Select the dockets that define eligible work. Time worked for other dockets does not earn employees a premium, even if the time falls within the zone. If left blank, work in any docket is considered eligible work. | Any valid docket |
Quantity is Greater Than or Equal To++ | Specify the quantity value that defines eligible work. A work detail is eligible if the related quantity is greater than or equal to the specified value. If left blank, eligible work can have any quantity value. If this parameter has any value, work details with a quantity of -1000 are not considered eligible as this value is the application default for a null value. | A numeric value. |
Quantity is Less Than or Equal To++ | Specify the quantity value that defines eligible work. A work detail is eligible if the related quantity is less than or equal to the specified value. If left blank, eligible work can have any quantity value. If this parameter has any value, work details with a quantity of -1000 are not considered eligible, as this value is the application default for a null value. | A numeric value |
*Type of Time Eligible for Premium | Select whether scheduled worked time, unscheduled
worked time, or both, is used to determine eligible worked time. Select one
of these options:
|
One of the drop-down list selections |
*Base Shift Eligibility on | Select the schedule the rule examines when determining
shift eligibility. The rule can be configured to only pay premiums to
employees who work specific shifts, or shifts that start or end before or
after specified times. This shift eligibility can be based on an employee's:
|
One of the drop-down list selections |
Shift Must Start On or After | Specify the scheduled time that employee shifts must start on or after, for the employee to be eligible to earn a premium. | A time value, in HH:mm format |
Shift Must Start On or Before | Specify the scheduled time that employee shifts must start on or before, for the employee to be eligible to earn a premium. | A time value, in HH:mm format |
Shift Must End On or After | Specify the scheduled time that employee shifts must end on or after, for the employee to be eligible to earn a premium. | A time value, in HH:mm format |
Shift Must End On or Before | Specify the scheduled time that employee shifts must end on or before, for the employee to be eligible to earn a premium. | A time value, in HH:mm format |
Scheduled Range Start++ | Specify the time employees must be scheduled to be eligible to earn a premium. Employees who are not scheduled at the specified time are not eligible to earn a premium, even if they work eligible time during the zone. If you specify a time in the Schedule Range End parameter, the rule checks a time range between the start and end times. As long as employees are scheduled during part (or all) of the range, they are eligible to earn a premium. The schedule range can span midnight. If the start time is greater than the end time, the application assumes the range crosses midnight and the Schedule Range End occurs on the next day. | A time value, in HH:mm format |
Scheduled Range End++ | Specify the end of the time range during which employees must be scheduled to be eligible to earn a premium. | A time value, in HH:mm format |
Minimum Number of Minutes Worked | Specify the minimum number of minutes of eligible time an employee must work within the zone to be eligible to earn a premium. Eligible time is defined by the zone's eligibility parameters. | A positive integer, representing minutes |
Must Start Work On or After Time++ | Specify the time employees must start work on or
after, to be eligible to earn a premium. By default, the date from the work detail start time is used when comparing the specified time against the work detail start time. To use a different date, configure the Date for Start Time parameter. |
A time value, in HH:mm format |
Must Start Work On or Before Time | Specify the time employees must start work on or
before, to be eligible to earn a premium. By default, the date from the work detail start time is used when comparing the specified time against the work detail start time. To use a different date, configure the Date for Start Time parameter. |
A time value, in HH:mm format |
Must End Work On or After Time | Specify the time employees must end work on or after,
to be eligible to earn a premium. By default, the date from the work detail end time is used when comparing the specified time against the work detail end time. To use a different date (for example, to accommodate overnight shifts), configure the Date for End Time parameter. |
A time value, in HH:mm format |
Must End Work On or Before Time++ | Specify the time employees must end work on or before,
to be eligible to earn a premium. By default, the date from the work detail end time is used when comparing the specified time against the work detail end time. To use a different date, configure the Date for End Time parameter. |
A time value, in HH:mm format |
Must Work Minutes | Defines the minimum amount of eligible time an
employee must work, as either a number of minutes or a percentage, to be
eligible to earn a premium. Eligible time is defined by the zone's
eligibility parameters. The parameter accepts these values:
|
A positive integer, ending with either S, %S, T, or %T |
Must Work Minutes Start | Specify the start of the time range that is used with the Must Work Minutes parameter. | A time value, in HH:mm format |
Must Work Minutes End | Specify the end of the time range that is used with the Must Work Minutes parameter. | A time value, in HH:mm format |
*Type of Eligible Detail | Specify whether the rule considers eligible work
details or work premiums, or both:
If an eligible premium does not have start and end times, then all of the premium time is considered. If an eligible premium has start and end times, then only the portion of the premium that falls within the defined zone start and end times is considered. For an example, see Business Example 6 - Shift Premium Zone. |
One of the drop-down list selections |
Date for Start Time | Select the date that is used for the time specified in
the "Must Start Work On or After Time" and "Must Start Work On or Before
Time" parameters:
|
One of the drop-down list selections |
Date for End Time | Select the date that is used for the time specified in
the "Must End Work On or After Time" and "Must End Work On or Before Time"
parameters:
|
One of the drop-down list selections |