This page (revision-99) was last changed on 26-Nov-2021 10:22 by jlawler

This page was created on 26-Nov-2021 10:22 by mhodgins

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Page revision history

Version Date Modified Size Author Changes ... Change note
99 26-Nov-2021 10:22 12 KB jlawler to previous
98 26-Nov-2021 10:22 12 KB jlawler to previous | to last
97 26-Nov-2021 10:22 12 KB jlawler to previous | to last
96 26-Nov-2021 10:22 11 KB khiggs to previous | to last
95 26-Nov-2021 10:22 11 KB khiggs to previous | to last
94 26-Nov-2021 10:22 11 KB khiggs to previous | to last
93 26-Nov-2021 10:22 10 KB mhodgins to previous | to last
92 26-Nov-2021 10:22 10 KB mhodgins to previous | to last
91 26-Nov-2021 10:22 10 KB mhodgins to previous | to last
90 26-Nov-2021 10:22 10 KB mhodgins to previous | to last
89 26-Nov-2021 10:22 10 KB mhodgins to previous | to last
88 26-Nov-2021 10:22 12 KB mhodgins to previous | to last
87 26-Nov-2021 10:22 12 KB mhodgins to previous | to last
86 26-Nov-2021 10:22 12 KB mhodgins to previous | to last
85 26-Nov-2021 10:22 11 KB mhodgins to previous | to last
84 26-Nov-2021 10:22 11 KB mhodgins to previous | to last
83 26-Nov-2021 10:22 11 KB mhodgins to previous | to last
82 26-Nov-2021 10:22 11 KB mhodgins to previous | to last
81 26-Nov-2021 10:22 11 KB mhodgins to previous | to last

Page References

Incoming links Outgoing links
UBRETRO
UBRETRO

Version management

Difference between version and

At line 1 changed one line
!!__RETROACTIVE BENEFIT EARNINGS AMOUNTS__
The UBRETRO facility was designed to calculate retro amounts on benefit deductions when an employee receives a pay increase.
At line 3 added 2 lines
!!Custom Functions
New Custom Functions - P2K_CF_WAGE_RATE and P2K_CF_PREMIUM. These new custom functions have been created to be used with UserCalcs which allow us to determine an employee's wage rate and premium rate based on dates defined in the UserCalc. These new functions are defined in the lexicon 'X_UC_FUNCTIONS'. If the functions are not listed in X_UC_FUNCTIONS lexicon, they can be manually added to the lexicon in {IMLN}
At line 4 changed 2 lines
!__Features__
The UBRETRO facility was designed to calculate retro amounts on benefit deductions when an employee receives a pay increase. Benefit deductions may need to be recalculated to include the retro earnings.
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';
At line 7 removed 27 lines
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.
!__UPRETRO/UBRETRO key processing differences__
[UPRETRO] and UBRETRO work differently with regards to pay header requirements.
In the case of [UPRETRO] the program will include all the old pays that are to have retro calculated. Prior to launching UPRETRO all the pay’s that will be processed will be displayed using the “List” button on [UPRETRO].
[UPRETRO] will create a new pay if there is no applicable pay header or will update an existing pay header if no applicable pay header can be found.
UBRETRO behaves differently in that it does not create a pay header. Instead prior to processing, UBRETRO requires the creation of a single "To Be Audited" pay for the specific pay period in which the retro amounts are to appear.
Therefore the “[Trigger BE Retro|TRIGGER_BE_RETRO]" toggle found on [IEAS] must be enabled on a EASD record that has effective and expiry dates that fall within the specified pay period start and end dates on the pay header selected.
If there are no "To Be Audited" pays that fall in period specified on the EASD records, than UBRETRO will not process.
!!New Custom Functions
Two New Custom Functions
* P2K_CF_WAGE_RATE\\
* P2K_CF_PREMIUM\\
These new custom functions have been created to be used with UserCalcs which allow us to determine an employee's wage rate and premium rate based on dates defined in the UserCalc. These new functions are defined in the lexicon 'X_UC_FUNCTIONS'. If the functions are not listed in X_UC_FUNCTIONS lexicon, they can be manually added to the lexicon in [IMLN]
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'.
At line 38 changed 4 lines
The Global Variables must be named and created exactly as shown below:\\
CF PREMIUM DATE - this is a 'DATE' type global variable\\
CF PREMIUM TYPE - this is a 'CHAR' type global variable\\
CF WAGE DATE - this is a 'DATE' type global variable\\
The Global Variables must be named and created exactly as shown below:
CF PREMIUM DATE - this is a 'DATE' type global variable
CF PREMIUM TYPE - this is a 'CHAR' type global variable
CF WAGE DATE - this is a 'DATE' type global variable
At line 45 changed 4 lines
Global Variables are needed to invoke the new custom function logic available in UserCalcs. They must be named exactly as shown below:\\
* CF WAGE DATE\\
* CF PREMIUM DATE\\
* CF PREMIUM TYPE
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
At line 50 changed one line
Usercalc Example: Capture wage rate and premium rate as of pay issue date\\
Usercalc Example: Capture wage rate and premium rate as of pay issue date
At line 76 changed one line
The function UBRETRO was developed to process retro calculation amounts on benefit components. Benefit amounts requiring a retro calculation must have been generated during the benefit process in UPCALC in order for UBRETRO to process and re-calculate the retro benefit amounts. Pay components requiring a retro calculation [must|] have a "Retro PC' defined. These retro pay components may need to be added to elements (i.e. Total Deductions, Pre Tax Elements, etc..)
The function UBRETRO was developed to process retro calculation amounts on benefit components. Benefit amounts requiring a retro calculation must have been generated during the benefit process in UPCALC in order for UBRETRO to process and re-calculate the retro benefit amounts. Pay components requiring a retro calculation must have a "Retro PC' defined. These retro pay components may need to be added to elements (i.e. Total Deductions, Pre Tax Elements, etc..)
At line 81 changed 4 lines
* A pay header at a 'To Be Audited' stage must be created for the employee before you can run the UBRETRO process\\
*A report parameter __Post Negative Retro__ controls if negative amounts should be posted to IPPH. If set to __NO__ the negative amounts are not recorded; however, exception messages will still be logged.
*Reversals and pays that have been reversed are ignored
*Unit and Group information is obtained from the assignment, not the from the __old__ pay header being evaluated.
* A pay header at a 'To Be Audited' stage must be created for the employees before you can run the UBRETRO process\\
At line 54 added 2 lines
When the UBRETRO process is run in 'Update' mode, a User Defined Field on the IPPH called 'Posted UBRETRO' is updated with a value of 'Y'.
At line 89 changed one line
*Cancel the Pay Header(s) manually or run UPCBAT and run UPAUDT to delete the Pay Headers. You may then create a new Pay
*Cancel the Pay Header(s) manually or run UPCBAT and run UPAUDT to delete the Pay Headers. You can then create a new Pay
At line 95 changed 3 lines
!!Set Up Requirements
;[Pay_Components]
The UBRETRO program will only process for pay components attached to benefit plans that have a 'Retro' PC attached to the 'Retro Pay' tab on [IPPC]. It is important to update the appropriate element if new 'retro' pay components are created.
!!Retroactive Benefit Calculation Program
At line 99 changed 3 lines
;__High Line Recommendations:__\\
* Create unique pay components to store the retro amount
* Create unique pay components for adjustments
Report Parameters
;[Entity]
Select the entity for which you wish to run this process for
;[Payroll]
Select the payroll for which you wish to run this process for
;[Pay_Period]
This represents the current pay period for the batch where the Retro Lines will be "inserted". There should only be one pay header available to be used.\\ __Note: if there is no pay header available for the employee, the retro amount will not be calculated.__
;[Retro_Start_Period]
This represents the starting retro pay period for which the calculations will be processed
;[Retro_End_Period]
This represents the ending retro pay period for which the calculations will be processed
;[Triggered_Employees]
This restricts the list of employees to those who have the 'Trigger BE Retro' toggle 'On' at the assignment. Once UBRETRO has been run in the Non Trial mode, the toggles will be turned 'Off'
;[Benefit_Plans]
This represents the benefit plans to be processed. Multiple plans may be selected
;[Plan_Coverages]
This represents the coverages to be processed; the list of coverages will be restricted based on the benefit plans selected above
;[Trial]
If the value of this field is 'Yes', then the process will be run in trial mode and the data will not be saved to the database. If Trial is set to 'No', then the process will be run in update mode and the changes will be saved to the database.
At line 103 changed 2 lines
!Retro Benefit Calculations Based on Earnings\\
When an employee receives a retroactive pay increase, their benefit deductions may need to be re-calculated to include the retro earnings.
__NOTE: It is always recommended to run the program in TRIAL first and verify the results before running it in update mode.__
At line 106 changed one line
The standard retroactive pay program (UPRETRO) will calculate the difference between the old and new wage rates and will insert a pay line into the current period's pay header for each pay line that was evaluated. 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.
;[Exception_Level]
The program can be run with various levels of exceptions and depends on the level of detail required; the higher the exception level, the greater the amount of detail.
;[User_Comment]
This field allows users to enter a short comment that will be visible on the first page of the report
;[Report_Filters]
The following report filters are used to restrict who in the batch should be reviewed and/or updated\\
* __People List Code__\\
People lists can be used to select groups of employees based on specific criteria\\__NOTE: This filter looks at the
employee's assignment details based on the pay period end date of the pay period defined in the 'Pay Period'
parameter__\\
* __Person__\\
Individual employees can be selected for processing\\
* __Batch Number__\\
Individual batch numbers can be selected for processing\\
* __Department__\\
Individual departments can be selected for processing\\
__NOTE: This filter looks at the employee's assignment details based on the pay period end date of the pay period
defined in the 'Pay Period' parameter__\\
* __Unit__\\
Individual units can be selected for processing\\
__NOTE: This filter looks at the employee's assignment details based on the pay period end date of the pay period
defined in the 'Pay Period' parameter__\\
* __Group__\\
Individual groups can be selected for processing\\
__NOTE: This filter looks at the employee's assignment details based on the pay period end date of the pay period
defined in the 'Pay Period' parameter__\\
At line 108 removed one line
The UserCalc example listed below us the Part Time Pension calculation and is associated to B0320 on the PT_PENS plan
At line 110 removed 7 lines
||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 | | | | | | | |
At line 118 changed one line
!!Retroactive Benefit Calculation Program
;[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.
At line 121 added one line
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.
At line 121 changed 13 lines
||Report Parameters||
| Entity | Mandatory, LOV Available
| Payroll | Mandatory, LOV Available
| Pay Period | Mandatory, Date LOV Available\\ If there is no pay header available for the employee, the retro amount will not be calculated
| Retro Start Period | Mandatory, LOV Available
| Retro End Period | Mandatory, LOV Available
| Triggered Employees| Mandatory. Yes/No\\Restricts the list of employees to only those who have the 'Trigger BE Retro' toggle 'On' at the assignment level
| Plan Coverages | Mandatory, Lexicon Available
| Benefit Plans | Mandatory, Lexicon Available
| Trial | Optional, Toggle\\If 'Off' then the update is committed\\If 'On' the update is not committed and UBRETRO may be processed again\\
|Post Negative Retro| Optional, Toggle\\If 'Yes' then negative amounts will be posted on the pay header\\If 'No' the negative amounts will not be posted\\In both cases exception messages will appear on the report
| Exception Level | Mandatory, LOV Available\\Defaults to ‘Exceptions Only’, may be changed to allow users to view higher-level exception messages (if problems occur, or to assist in set up and testing).
| User Comment | Allows users to enter a short comment that will be visible on the report
!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
At line 136 removed 7 lines
||Report_Filters||
| People List Code | People Lists may be used to select groups of employees based on specific data\\__NOTE: This filter looks at the employee's assignment details based on the pay period end date of the pay period defined in the 'Pay Period' parameter__
| Person | Individual employees may be selected for processing
| Batch Number | Individual bath numbers may be selected for processing
| Department | Individual departments may be selected for processing\\__NOTE: This filter looks at the employee's assignment details based on the pay period end date of the pay period defined in the 'Pay Period' parameter__
| Unit | Individual units may be selected for processing\\__NOTE: This filter looks at the employee's assignment details based on the pay period end date of the pay period defined in the 'Pay Period' parameter__
| Group | Individual groups may be selected for processing\\__NOTE: This filters looks at the employee's assignment details based on the pay period end date of the pay period defined in the 'Pay Period' paramater
At line 144 changed 3 lines
----
![Notes|Edit:Internal.UBRETRO]
[{InsertPage page='Internal.UBRETRO' default='Click to create a new notes page'}]
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
At line 132 added 7 lines
||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 | | | | | | | |
At line 140 added one line
!!Processing Information
At line 151 changed one line
;[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-
This page (revision-99) was last changed on 26-Nov-2021 10:22 by jlawlerTop