Award Leave Pay Rule

Class Name

com.workbrain.app.ta.quickrules.AwardLeavePayRule

Overview

The Award Leave Pay Rule awards a premium to employees on eligible (non-intermittent) leave of absence.

This rule allows configuration of time codes, hour types, award sources, and distribution methods for awarding leave premiums. This rule is also evaluated per employee per calendar day and generates one premium per matching leave row for that day.
Note: This rule must be used with the Is Employee Eligible Leave Condition rule condition.

See Is Employee Eligible Leave Condition.

Configuration

You can configure several aspects of this rule, including:
  • The source of the time code to be awarded
  • The hour type applied to the premium
  • How the number of premium minutes is determined
  • Which days of the week the award is applied
  • How to distribute minutes when multiple leave rows overlap

Rule Parameters

Parameters marked with an asterisk (*) are required.
Parameter Description
Time Code Source* Determines the source of the time code for the award.
  • Specific Time Code: Click the database lookup and select a time code.
  • Leave Reason Table: Use the time code defined in the Leave Reason table.
Hour Type* Select the hour type to apply to the premiums generated by the Award Leave Pay Rule.
Award Minutes From* Determines how the number of minutes for the premium is calculated.
  • Constant Value: Specify a fixed number of minutes.
  • Employee UDF: Specify a numeric employee user-defined field interpreted as minutes.
  • Employee Value: Specify a numeric employee value, such as Default Minutes.

    Employee Value is also used to multiply the minutes when the Award Minutes From parameter is set to Employee UDF or Employee Value. However, this field is not evaluated when Employee Shift Pattern is selected.

  • FTE Formula – Calculate minutes using the formula: DailyMinutes = (FTE × BASE_FTE_WEEKLY_RATE) ÷ D, where:
    • FTE is from Employee Details.
    • BASE_FTE_WEEKLY_RATE is a registry parameter (minutes per week).
    • D is the number of checked weekdays in Award on Days.
  • Employee Shift Pattern: When this option is selected, only shift segments with hour types that have a non-zero multiplier are included in the premium calculation. Shift segments with hour types that have a multiplier of 0 are excluded.

    For example, an 8-hour shift with a 30-minute unpaid break (hour type multiplier = 0) results in 7 hours and 30 minutes of premium. An 8-hour shift with a 30-minute paid break (non-zero multiplier) results in 8 hours of premium.
Award on Days* Select multiple days (Mon–Sun) on which the award applies. Days not selected are excluded. The number of selected days is used as D in the FTE Formula.
Distribution* Determines how the total daily minutes are distributed when multiple leave rows overlap.
  • Even Distribution: Splits the total day’s minutes equally across overlapping leave rows.
  • Priority Based: Awards all minutes to the highest-priority leave reason. If multiple leaves share the same priority, minutes are split evenly among them.