Award Leave Pay Rule

Class Name

com.workbrain.app.ta.quickrules.AwardLeavePayRule

Overview

The Award Leave Pay Rule awards a premium on days when an employee is on an eligible (non-intermittent) leave.

This rule is based on the Award Premium Rule and allows configuration of time codes, hour types, award sources, and distribution methods for awarding leave premiums. This rule is also used to evaluate per employee per calendar day and generates one premium per matching leave row for that day.

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.
  • 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: Specify the day’s minutes from the employee’s shift pattern, ignoring the value on the Award on Days field.
Award on Days* Select multiple days (Mon–Sun) to define when 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.
UDF/Employee Value Multiplier Used to multiply the minutes from a UDF or Employee Value source. Also used to adjust awarded minutes.