Balance Payout Rule

Class Name

com.workbrain.app.ta.quickrules.PremiumFromBalancePayoutRule

Overview

The Balance Payout Rule pays employees for all or some of their remaining balances.

You can configure several aspects of the rule, including:

What balances to pay out
Whether to pay the balances out until they reach a defined number or to deduct and pay out a specified amount from the balances
How long of a premium to create for each unit of balance.

Parameters

Parameters marked with an asterisk (*) are required.


Parameter	Description
*Balance Names	Specify a comma-separated list of balances to pay out. Since the rule converts the balance units to a defined number of minutes when the rule creates the pay out premiums, you must select balances with the same type of units. For example, you can select the VAC and SICK balances if they are both measured in days so that when you specify the Minutes Per Balance Unit value, you can specify the number of minutes a day is worth.
*Balance Decremented	This parameter determines whether the rule decrements balances directly as the rule pays them out. By default, the check box is cleared and balances are decremented through their association to the time codes, not directly by the rule. The associated time codes are defined in the Premium Time Code parameter. For the rule to function, the time codes that are inserted by the rule when balances are paid out must be configured to decrement the balance. For the rule to decrement the balances, select the check box. Ensure the associated time code is not set to decrement the balance too; otherwise, the balances will be decremented twice.
*Payout Approach	This parameter determines how to pay out the balances: either to a specified level, or by a specified amount. For example, the rule can pay out the SICK balance until the balance reaches zero. If an employee has a balance of five days, the employee is paid out for five sick days. Another employee, with a balance of two days, is only paid out for two sick days. If the rule is configured to pay only 2 days out of the SICK balance, the first employee is paid for 2 sick days and left with a balance of 3. The second employee is left with a balance of 0. The Payout Approach parameter has two options: Fixed value: Pays out the Payout Approach Value from each specified balance. If a balance does not have the Payout Approach Value, no payout occurs. For example, if the Payout Approach Value is 5 and five units are available, the rule deducts 5 units from the balances and pays the balance out. No units are deducted from a balance with less than 5 units. To final value: Pays out balances until the Payout Approach Value is reached. When determining how many units of each balance to pay out, the rule considers the balance minimums. If the balance is at or below the minimum (or zero), the rule does not decrement the balance and no payout occurs.
*Payout Approach Value	Specify any decimal, non-negative number. The Payout Approach parameter uses this amount to determine how to pay out the balance.
Minutes Per Balance Unit	Specify a decimal, non-negative number. This parameter is the number of minutes that are associated with the balance unit. For example, if the rule pays out balances that are measured in days, specify 480 to set a day to be worth 480 minutes, or 8 hours. Therefore, if the rule pays out 3 SICK days, the rule pays the employee a 24 hour premium.
*Premium Time Code	Specify a comma-separated list of time code names to which balances are paid out. The rule can either: Pay out all the specified balances to a single time code Pay out each balance to a specific time code You must specify either one time code (used for all balances) or the same number of time codes as the balances that are specified in the Balance Names parameter. If you are using different time codes for each balance, specify the time codes in the same order as their corresponding balances in the Balance Names parameter.
*Premium Hour Type	Specify a comma-separated list of hour type names to which balances are paid out. The rule can either: Pay out all the specified balances to a single hour type Pay out each balance to a specific hour type You must specify either one hour type (used for all balances) or the same number of hour types as the balances that are specified in the Balance Names parameter. If you are using different hour types for each balance, specify the hour types in the same order as their corresponding balances in the Balance Names parameter.
Additional Premium Field Values	To store additional information with the payout for future processing or reporting purposes, specify a comma-separated list of premium fields and their associated values in the form `Name=Value`. Only comments, messages, UDFs, FLAGs, and labor metric fields are accessible. For example, specify WRKD_COMMENTS=Balance pay out.