Award Premium Rule
The Award Premium Rule is used to pay employees premiums under the specific conditions you define.
Technical Details
com.workbrain.app.ta.quickrules.AwardPremiumRule
Overview
The Award Premium Rule is used to pay premiums to employees as extra compensation for a variety of conditions. You can use any condition in the conditions library to define when premiums are paid, as the rule only 'fires' when all of the conditions associated to the rule evaluate to true.
When the rule fires, the rule pays employees a premium for the day. The rule's configuration determines what the premium's time code and hour type, as well as what labor metrics the rule is paid against.
The rule can be configured to pay premiums with a specified, constant duration or the rule can base the premium's duration off the value of any employee UDF or employee value field.
If you base premium durations off UDF or employee value fields, the premium duration is employee specific, and can vary from employee to employee, depending on the value stored in the specified field. Also, the rule can be configured to multiply this stored value by a multiplier.
Configuration
The Award Premium Rule's behavior is based on the values of the rule's parameters and assigned conditions.
Rule Parameters
Parameters marked with an asterisk (*) are required.
| Parameter | Description | Valid Values |
|---|---|---|
| *Time Code | Select the premium's time code. | Any valid time code |
| *Hour Type | Select the premium's hour type. | Any valid hour type |
| Rate | Specify the rate at which the premium is paid, or leave blank to use the employee's base rate. | Blank or any non-zero integer |
| Apply Hour Type multiplier to the Rate | Select to multiply the rate by the premium's hour type multiplier. | Selected or cleared |
| *Generate premium minutes from |
This parameter defines the duration of the premiums the rule inserts. You can configure the rule to insert the same, specified duration for all employees, or base the premium's duration off the values in an employee or work detail UDF or an employee value field. Select one of these options:
With this configuration, when the rule fires the rule examines the day for any work details with the specified work detail UDF populated. The rule then sums the values and uses the result as the premium's duration. When the premium's length is based off of a UDF or employee value field, the rule will not pay a premium if the value in the specified field is zero. |
One of the options |
| UDF/Employee Value Multiplier |
Specify a decimal number to specify a UDF or employee value multiplier. When specified, the rule multiplies the selected UDF or field by this multiplier value when the rule determines the premium's duration. If left blank, the rule does not apply a multiplier. This value can be a negative number. |
Any positive or negative decimal value, with a precision of up to 5 decimal places |
|
Premium Labor Settings parameters: These parameters define which labor metrics premiums are paid against. By default, the labor metrics specified in the employee's default labor allocation are used. Any labor metrics you specify override the employee's default labor allocations. The employee's default team is always used. |
||
| Job | This parameter determines what job premiums are charged against. Select a job or leave blank to use the employee's default labor allocation. | Blank or any valid job |
| Department | This parameter determines what department premiums are charged against. Select a department or leave blank to use the employee's default labor allocation. | Blank or any valid department |
| Project | This parameter determines what projects premiums are charged against. Select a project or leave blank to use the employee's default labor allocation. | Blank or any valid project |
| Docket | This parameter determines what dockets premiums are charged against. Select a docket or leave blank to use the employee's default labor allocation. | Blank or any valid docket |
| Quantity |
Specify the premium's quantity value. If left blank, the premium does not have a quantity value. |
Any valid quantity |