The UBRETRO facility was designed to calculate retro on benefit deductions when an employee receives a pay increase.  

;[Retro_Benefit_Calculations_Based_On_Earnings]
When an employee receives a retroactive pay increase, their benefit deductions may need to be recalculated to include the retro earnings.

The standard retroactive pay program [UPRETRO] will calculate the difference between the old and new wage rates and insert a pay line into the current period's pay header for each pay line that was evaluated.  

!Set Up Requirements
;[Pay_Component]
The program will only process for pay components attached to benefit plans that have a 'Retro' pay component attached to the 'Retro Pay' tab on [IPPC].  It is important to update the appropriate element if new 'retro' pay components are created

;[Custom_Functions]
The following custom functions are required - P2K_CF_WAGE_RATE and P2K_CF_PREMIUM.  The function 'P2K_CF_WAGE_RATE' will pass the wage rate from the employee's assignment as of the date found in the Global Variable 'CF WAGE DATE';  

The function 'P2K_CF_PREMIUM' will pass the value of an employee's premium from their assignment as of the date found in the Global Variable 'CF PREMIUM DATE' and for the premium type defined in the Global Variable 'CF PREMIUM TYPE'.

Review the lexicon [IMLN] X_UC_FUNCTIONS.  These functions may be manually added if not already there.

;[User_Calculation]:
Global Variables are needed to invoke the new custom function logic available in UserCalcs.  The must be named exactly as shown:  CF WAGE DATE, CF PREMIUM DATE, CF PREMIUM TYPE

Usercalc Example:  Capture wage rate and premium rate as of pay issue date
The following UserCalc was written to capture the employee's wage rate and premium rates as per the Pay Issue Date and return the combined amounts to be used in the benefit calculation.  This is a 'Function' type UserCalc and will return the value of the wage rate plus premium rate to the appropriate benefit component.

||LINE || CMD|| TYPE 1|| OPERAND 1|| OPER|| TYPE 2|| OPERAND 2         || TYPE 3|| OPERAND 3||IF GO TO|| ELSE GO TO||NOTES||
|100  | LET |  $G    |CF WAGE DATE|  EQ |   DB   |  PPH.PAY_ISSUE_DATE|        |           |   110   |            |       |

   









In order to ensure that retro wages are used in the benefit calculation and are picked up in the correct period a UserCalc (as shown below) is required to capture the retro earnings.  This usercalc sample would be associated to the benefit plan [IBPN] as B0320


||LINE||CMD ||TYPE 1||OPERAND 1     ||OPER||TYPE 2||OPERAND 2   ||TYPE 3||OPERAND 3||IF GO TO||ELSE GO TO||NOTES          ||
| 100 | LET | V     | Base Earnings | EQ  | EC    | PT_STD_EARN |       |          |  110    |           | The purpose of this usercalc is to capture the earnings used in part time pension calculations.  Only retro earnings that have dates within the pay period should be processed.  Retro earnings should be used to calculate 'retro' benefits for the pay period they are earned in
| 110 | LET | V     | ELPL.BEGIN_DATE| EQ | $S     | PERIOD_START_DATE|  |          |  120    |           |
| 120 | LET | V     | ELPL.END_DATE  | EQ | $S     | PERIOD_END_DATE  |  |          |  130    |           |
| 130 | LET | V     | RETRO EARNINGS | ELPL|ET     | RETRO EARNINGS   |  |          |  140    |           |
| 140 | LET | V     | TOTAL EARNINGS | ADD |V      | BASE EARNINGS    |V | RETRO EARNINGS| 99999|         |
|99999| RET | V     | TOTAL EARNINGS |     |       |                  |  |          |         |           |

!!Processing Information

;[Entity]:
            This is a required field the user must select the correct entity to process
;[Payroll]:
            This is a required field the user must select the correct payroll to process
;[Pay_Period]:
            This is a required field the user must select the correct pay period to process.  This represesents the pay period for the batch where the retro lines will be inserted.  There should only be one pay header available to be sued.  -NOTE - if there is no pay header available for the employee, the retro amount will not be calculated-