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

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

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
32 26-Nov-2021 10:22 14 KB JEscott to previous
31 26-Nov-2021 10:22 14 KB JEscott to previous | to last
30 26-Nov-2021 10:22 14 KB JEscott to previous | to last
29 26-Nov-2021 10:22 14 KB JEscott to previous | to last
28 26-Nov-2021 10:22 14 KB JEscott to previous | to last
27 26-Nov-2021 10:22 14 KB JEscott to previous | to last
26 26-Nov-2021 10:22 14 KB JEscott to previous | to last
25 26-Nov-2021 10:22 14 KB JEscott to previous | to last
24 26-Nov-2021 10:22 14 KB JEscott to previous | to last
23 26-Nov-2021 10:22 14 KB JEscott to previous | to last
22 26-Nov-2021 10:22 14 KB JEscott to previous | to last
21 26-Nov-2021 10:22 14 KB JEscott to previous | to last

Page References

Incoming links Outgoing links
UBEF APA INTERFACE
UBEF APA INTERFACE

Version management

Difference between version and

At line 1 removed 2 lines
[{TableOfContents }]
At line 5 changed one line
The Generate Benefit/Payroll Interface (UBEF) screen may be used to generate a pension interface file for the province of Alberta.
The Generate Benefit/Payroll Interface (UBEF) screen may be used to generate a pension interface file for the province of Alberta. The following describes the necessary set up required in order to create this type of interface.
At line 7 changed 2 lines
!!Required Set Up
The following describes the necessary set up required in order to create this type of interface.
!!Step 1 - Define Plan Type in [IBPT]
A plan type must be set up for the Alberta Pension Administration (APA) system. The plan type may be defined by the user, but all pension plans associated with APA must be identified as being in this plan type. The following example illustrates the set up of 'PENSION' plan type in the system.
At line 10 changed 2 lines
!Step 1 - Define Plan Type in [IBPT]
A plan type must be set up for the Alberta Pension Administration (APA) system. The plan type may be defined by the user, but all pension plans associated with APA must be identified as being in this plan type. An example would be 'PENSION'.
!!Step 2- Define Plan Definitions in [IBPN]
Each APA pension plan must be set up and identified with a 'PENSION' plan type (as illustrated in this document). The plan code can be defined by the users, but keep in mind that the 4th-7th characters of the plan name will be used to report to the Alberta Pension Administration.
At line 13 changed 2 lines
!Step 2- Define Plan Definitions in [IBPN]
Each APA pension plan must be set up and identified with a 'PENSION' plan type. The plan code can be defined by the users, but keep in mind that the 4th-7th characters of the plan name will be used to report to the Alberta Pension Administration.
There are currently three pension plans being supported, they are PSPP, MEPP, and MSRP plans. Since this system passes only the 4-7th characters of the plan code to the Alberta Pension Board, therefore it is mandatory that those positions of the Plan code includes eitherPSPP, MEPP, or MSRP as appropriate.
At line 16 removed 2 lines
There are currently three pension plans being supported, they are PSPP, MEPP, and MSRP plans. Since this system passes only the 4-7th characters of the plan code to the Alberta Pension Board, therefore it is mandatory that those positions of the Plan code includes either PSPP, MEPP, or MSRP as appropriate.
At line 20 changed one line
Due to different contribution rules which apply to different employment statuses, each of these pension plans should have four coverage codes. The currently supported coverage codes are 'Active', 'LTD', 'Leave', and 'Leave No-cont'.
Due to different contribution rules which apply to different employment statuses, each of these pension plans should have four coverage codes. The currently supported coverage codes are 'Active', 'LTD', 'Leave', and 'Leave No-cont'. (See UBEF Processing section 5.11 for further details of each Coverage).
At line 24 changed 2 lines
!Step 3 - Define User Fields in [IMUF]
A new '[PN Employer Number|PN-EMPLOYER NUMBER (UDF)]' user-defined field must be set up for each APA pension plans. This employer number is assigned by the Alberta Pension Administration.
!!Step 3 - Define User Fields in [IMUF]
A new 'PN-EMPLOYER NUMBER' user-defined field must be set up for each APA pension plans. This employer number is assigned by the Alberta Pension Administration.
At line 27 removed 11 lines
The '[PN Employer Number|PN-EMPLOYER NUMBER (UDF)]' UDF must be defined in [IMUF] for the table [P2K_BE_PLAN_DEFINITIONS] with the following fields:
[User Field|USER_FIELD_NAME]:PN-EMPLOYER NUMBER
[Prompt|FIELD_PROMPT]:PN Employer Number
[Type|FIELD_TYPE]:Char
[Format|FORMAT_MASK]:999
At line 40 changed 2 lines
!Step 4 - Define Pay Elements in [IPPE]
A number of [pay elements|PAY ELEMENTS] must be set up for the APA pension system. These [pay elements|PAY ELEMENTS] will be used in the [IDIF] definition in order to obtain the correct Pensionable Salary and Contributions. (This list contains suggested [Pay Element|PAY ELEMENTS] names that are used in the standard supplied [IDIF] definitions. These [Pay Element|PAY ELEMENTS] names can be modified, and new ones added, as long as the corresponding [IDIF] definition is also modified accordingly).
!!Step 4 - Define Pay Elements in [IPPE]
A number of pay elements must be set up for the APA pension system. These pay elements will be used in the IDIF definition in order to obtain the correct Pensionable Salary and Contributions. (This list contains suggested Pay Element names that are used in the standard supplied IDIF definitions. These Pay Element names can be modified, and new ones added, as long as the corresponding IDIF definition is also modified accordingly).
At line 43 changed one line
The [APA Elements|APA ELEMENTS] page displays the list of necessary [pay elements|PAY ELEMENTS] required.
[APA ELEMENTS]
At line 45 changed 2 lines
!Step 5 - Define Usercalcs in [IMUC]
A number of [UserCalcs|USERCALC] may be required to process any exceptions to the standard function. You are responsible for writing and maintaining your own [UserCalcs|USERCALC].
!!Step 5 - Define Usercalcs in [IMUC]
A number of UserCalcs may be required to process any exceptions to the standard function. You are responsible for writing and maintaining your own UserCalcs.
At line 48 changed 2 lines
!Step 6 - Define Interface Format in [IDIF]
[HL$ABPERS-184] is provided in the [IDIF] screen as an example of a Pipe Delimited interface file for generating Record Type 18-4 for the Alberta Pension Administration.
!!Step 6 - Define Interface Format in [IDIF]
HL$ABPERS-184 is provided in the IDIF screen as an example of a Pipe Delimited interface file for generating Record Type 18-4 for the Alberta Pension Administration.
At line 51 changed one line
[HL$ABPERS-184C] is also provided in [IDIF] as an example of a Comma Delimited file for generating an audit report of Record Type 18-4.
HL$ABPERS-184C is also provided in IDIF as an example of a Comma Delimited file for generating an audit report of Record Type 18-4.
At line 53 changed one line
Standard [IDIF] definitions are provided for the other supported record types ([HL$ABPERS-18A] and [HL$ABPERS-18AC] for record type 18-A; [HL$ABPERS-18L] and [HL$ABPERS-18LC] for record type 18-L; [HL$ABPERS-18M] and [HL$ABPERS-18MC] for record type 18-M; [HL$ABPERS-18W] and [HL$ABPERS-18WC] for record type 18-W).
Standard [IDIF] definitions are provided for the other supported record types (HL$ABPERS-18A and HL$ABPERS-18AC for record type 18-A; HL$ABPERS-18L and HL$ABPERS-18LC for record type 18-L; HL$ABPERS-18M and HL$ABPERS-18MC for record type 18-M; HL$ABPERS-18W and HL$ABPERS-18WC for record type 18-W).
At line 41 added one line
[IDIF FIELD DEFINITIONS|UBEF APA IDIF DEFINITIONS]
At line 58 changed one line
The interface file layout for the Alberta Pension Administration is constructed so that the file is pipe delimited. Each file contains one header record and multiple detail records. The Transaction code and Detail type for the header record is always '94-1' for all files, while the Transaction code and Detail type for the detail records can be either '18-4', '18-A', '18-L', '18-M', or '18-W'.
!!Interface File Layout for the Alberta Pension Administration
The file is pipe delimited
At line 46 added one line
Each file contains one header record and multiple detail records. The Transaction code and Detail type for the header record is always '94-1' for all files, while the Transaction code and Detail type for the detail records can be either '18-4', '18-A', '18-L', '18-M', or '18-W'.
At line 61 changed 3 lines
;Supported Transaction Types for the Province of Alberta
||Transaction Type|| Description
|94-1 |Batch Header Record, a record of this type will be created together with all other transaction types in the file.
[UBEF APA Interface File Layout|UBEF APA INTERFACE FILE LAYOUT]
!Supported Transaction Types for the Province of Alberta
||Transaction\\Type|| Description
|94-1 |Batch Header Record, a record of this type will be created \\together with all other transaction types in the file.
At line 66 changed one line
|18-L| Reports the Leave of Absence detail, or adjustments to this detail, where the member has continued to contribute while on leave
|18-L| Reports the Leave of Absence detail, or adjustments to this \\detail, where the member has continued to contribute\\ while on leave
At line 68 changed one line
|18-W| Reports the Parenting Leave of Absence detail, or adjustment to this detail, where the member has continued to contribute while on leave.
|18-W| Reports the Parenting Leave of Absence detail, or adjustment\\ to this detail, where the member has continued to contribute \\while on leave.
At line 70 changed 2 lines
The user is now ready to run the UBEF to create an APA interface file
----
!!Step 7 - Run UBEF To Create APA Interface File
At line 80 changed one line
----
At line 85 changed one line
This example shows some example [UserCalcs|USERCALC] that are required to be written and maintained by user.
This example shows some example UserCalcs that are required to be written and maintained by user.
At line 87 changed one line
This PN-PSPP plan example will have three example coverage codes: CONTRIBUTION, LTD and NO-CONTRIBUTION. The [PC codes|PAY COMPONENTS], [Pay Element|PAY ELEMENTS] names, and [UserCalc|USERCALC] names used in this example are for illustration purpose only and should be modified as required.
This PN-PSPP plan example will have three example coverage codes: CONTRIBUTION, LTD and NO-CONTRIBUTION. The PC codes, Pay Element names, and UserCalc names used in this example are for illustration purpose only and should be modified as required.
At line 89 changed 5 lines
;PN-PSPP - CONTRIBUTION Coverage
*For Pension calculation earnings will be derived from the following [element|PAY ELEMENTS]:
**PEN EARN TOTAL - this [element|PAY ELEMENTS] is a complex element that contains [elements|PAY ELEMENTS] PEN-PD-EARNS and PEN-UNPD-EARNS
**Each of these [elements|PAY ELEMENTS] has a corresponding Hours Element which is required for reporting
*Not included in calculation but needed for report are the following [elements|PAY ELEMENTS]: PEN NC EARN and PEN NC HOURS
;PN-PSPP: CONTRIBUTION Coverage
*For Pension calculation earnings will be derived from the following element:
**PEN EARN TOTAL - this element is a complex element that contains elements PEN-PD-EARNS and PEN-UNPD-EARNS
**Each of these elements has a corresponding Hours Element which is required for reporting
*Not included in calculation but needed for report are the following elements: PEN NC EARN and PEN NC HOURS
At line 101 changed one line
* A [UserCalc|USERCALC] (suggested name BE-PENS-CAP) will have to be written to cap the employee's earnings at 4320.00
* A UserCalc (suggested name BE-PENS-CAP) will have to be written to cap the employee's earnings at 4320.00
At line 106 changed one line
* A [UserCalc|USERCALC] will be written to automatically set the expire date to be:
* A UserCalc will be written to automatically set the expire date to be:
At line 109 changed one line
** PC 980 (PSPP-Con-Hours) - this is calculated via a [UserCalc|USERCALC] PR-PENCONT-HRS and is based on the amount in PC 1980 being greater than 0
** PC 980 (PSPP-Con-Hours) - this is calculated via a UserCalc PR-PENCONT-HRS and is based on the amount in PC 1980 being greater than 0
At line 112 changed 2 lines
** The Employer amount is stored in a [Pay Component|PAY COMPONENTS]
** The Member (EE) amount is stored in a [Pay Component|PAY COMPONENTS]
** The Employer amount is stored in a Pay Component
** The Member (EE) amount is stored in a Pay Component
At line 116 changed 36 lines
;:''Example 1:''
;:''Maximum Biweekly Cap 1 = 1580.77''
;:''Maximum Biweekly Cap 2 = 4320.38''
;:''Premium rate up to Cap 1= 0.0617''
;:''Premium Rate up to Cap 2 = 0.0881''
;:''Employee's Biweekly Earnings = 1200.00''
;:''Premium = (1200.00 * 0.0617) = 74.04''
;:''Employer pays 74.04''
;:''Member (EE) pays 74.04''
\\
;:''Example 2:''
;:''Maximum Biweekly Cap 1 = 1580.77''
;:''Maximum Biweekly Cap 2 = 4320.38''
;:''Premium rate up to Cap 1= 0.0617''
;:''Premium Rate up to Cap 2 = 0.0881''
;:''Employee's Biweekly Earnings = 2000.00''
;:''Premium 1 = (1580.77 * 0.0617) = 97.53''
;:''Premium 2 = (419.23 *0.0881) = 36.93''
;:''Total Premium = 97.53 + 36.93 = 134.46''
;:''Employer Pays = 134.46''
;:''Member (EE) Pays = 134.46''
\\
;:''Example 3:''
;:''Maximum Biweekly Cap 1 = 1580.77''
;:''Maximum Biweekly Cap 2 = 4320.38''
;:''Premium rate up to Cap 1= 0.0617''
;:''Premium Rate up to Cap 2 = 0.0881''
;:''Employee's Biweekly Earnings = 5000.00''
;:''Premium 1 = (1580.77 * 0.0617) = 97.53''
;:''Premium 2 = (2739.61 *0.0881) = 241.36''
;:''The amount of 2739.61 was derived from the following: Maximum Biweekly Cap 2 -Maximum Biweekly Cap 1 = 4320.38-1580.77 = 2739.61''
;:''Total Premium = 338.89''
;:''Employer Pays = 338.89''
;:''Member (EE) Pays = 338.89''
\\
;PN-PSPP - LTD Coverage
;Example 1:
;:Maximum Biweekly Cap 1 = 1580.77
;:Maximum Biweekly Cap 2 = 4320.38
;:Premium rate up to Cap 1= 0.0617
;:Premium Rate up to Cap 2 = 0.0881
;:Employee's Biweekly Earnings = 1200.00
;:Premium = (1200.00 * 0.0617) = 74.04
;:Employer pays 74.04
;:Member (EE) pays 74.04
;Example 2:
;:Maximum Biweekly Cap 1 = 1580.77
;:Maximum Biweekly Cap 2 = 4320.38
;:Premium rate up to Cap 1= 0.0617
;:Premium Rate up to Cap 2 = 0.0881
;:Employee's Biweekly Earnings = 2000.00
;:Premium 1 = (1580.77 * 0.0617) = 97.53
;:Premium 2 = (419.23 *0.0881) = 36.93
;:Total Premium = 97.53 + 36.93 = 134.46
;:Employer Pays = 134.46
;:Member (EE) Pays = 134.46
;Example 3:
;:Maximum Biweekly Cap 1 = 1580.77
;:Maximum Biweekly Cap 2 = 4320.38
;:Premium rate up to Cap 1= 0.0617
;:Premium Rate up to Cap 2 = 0.0881
;:Employee's Biweekly Earnings = 5000.00
;:Premium 1 = (1580.77 * 0.0617) = 97.53
;:Premium 2 = (2739.61 *0.0881) = 241.36
;:The amount of 2739.61 was derived from the following: Maximum Biweekly Cap 2 -Maximum Biweekly Cap 1 = 4320.38-1580.77 = 2739.61
;:Total Premium = 338.89
;:Employer Pays = 338.89
;:Member (EE) Pays = 338.89
;PN-PSPP: LTD Coverage
At line 156 changed one line
* PC 982 (PSPP-LTD-Hours) - this is calculated via a [UserCalc|USERCALC] PR-PEN-CONTHRS and is based on the amount in PC 1982 being greater than 0
* PC 982 (PSPP-LTD-Hours) - this is calculated via a UserCalc PR-PEN-CONTHRS and is based on the amount in PC 1982 being greater than 0
At line 158 changed 2 lines
\\
;PN-PSPP - NO-CONTRIBUTION Coverage
;PN-PSPP: NO-CONTRIBUTION Coverage
At line 164 changed one line
* An [element|PAY ELEMENTS] called 'PEN NC EARN' is used to determine the eligible earnings amount
* An element called 'PEN NC EARN' is used to determine the eligible earnings amount
At line 166 changed one line
* PC 981 is populated via a [UserCalc|USERCALC] PR-PEN-CONT-HRS and is based on the amount in PC 1981
* PC 981 is populated via a UserCalc PR-PEN-CONT-HRS and is based on the amount in PC 1981
At line 173 changed 2 lines
----
!!Report Parameters & Filters
!!Report Parameters
At line 176 changed 34 lines
|Entity| Mandatory. You must enter an entity
|From Date| Mandatory. Enter a Pay Period Begin Date
|To Date| Mandatory. Enter a Pay Period End Date
|Interface Code| Mandatory. Enter the Interface code from the [IDIF] screen
|Interface Level |Mandatory. Specify the level for the Interface file to be produced; this must be '10'. Lexicon [X_INTERFACE_LEVEL] values are:\\01 - EEM + EASD (not applicable for UBEF processing) \\02 - EEM + EASD + Contacts (not applicable for UBEF processing) \\10 - BE Plans \\11 - BE + Contacts (not applicable for UBEF processing)
|ER Addr Location| Optional. This allows you to enter an overridden location to retrieve the employer’s address. If this is not specified, the entity's location address is used.
|Sort by Active/Inactive| Optional. Check this toggle to sort inactive employees first.
|Sort Employees By|Optional. You should sort employees by Last Name/First Name, however, you may sort by the employee's pay destination or sort by Person code
|Create File |Optional. This field provides an option to create the file
|Directory Name |Optional. Enter a valid directory name
|File Name|Optional. Enter a file name or use the default file name from [IDIF] screen
|Exception Level |Optional. You should always run with the Exception level unless for tracing. In Trace Level 1, the employee header with Person Code and Employee Name are displayed with performance time, this can be used for Progress bar or to locate employee with problem. In Trace Level 2, the BE plans are displayed after employee header information
||Report Filters||
|People List Code| Optional. Please specify if People list is to be used
|Person Code| Optional. Enter one or more Person Codes
|Location| Optional. Enter one or more Location codes
|Authorization| Optional. Enter one or more Authorization Areas
|Department| Optional. Enter one or more Department Codes
|Org Level Type|Optional. Enter one or more Org Level Types
|Org Level |Optional. Enter one or more Org Level within Org Level Types
|Unit| Optional. Enter one or more Unit codes
|Group |Optional. Enter one or more Group codes
|Payroll| Optional. Enter one or more Payroll Codes
|Employment Status| Optional. Enter one or more Employment Statuses
|Termination Reason| Optional. Enter one or more Termination Reasons
|Plan Type| Optional. This field is applicable if Interface Level = 'BE plans'
|Plan| Optional. This field is applicable if Interface Level = 'BE plans'
----
![Notes|Edit:Internal.UBEF+APA+INTERFACE]
[{InsertPage page='Internal.UBEF+APA+INTERFACE' default='Click to create a new notes page'}]
|Entity| You must enter an entity \\Mandatory
|From Date| Enter a Pay Period Begin Date
|To Date| Enter a Pay Period End Date
|Interface Code| Enter the Interface code from the IDIF screen\\Mandatory
|Interface Level |Specify the level for the Interface file to be produced; \\this must be '10'. \\Mandatory \\Lexicon X_INTERFACE_LEVEL values are:\\01 - EEM + EASD (not applicable for UBEF processing) \\02 - EEM + EASD + Contacts (not applicable for UBEF processing) \\10 - BE Plans \\11 - BE + Contacts (not applicable for UBEF processing)
|ER Addr Location| This allows you to enter an overridden location to retrieve the employer’s address.\\If this is not specified, the entity's location address is used. \\Optional
|Sort by Active/Inactive| Check this toggle to sort inactive employees first.
|Sort Employees By| You should sort employees by Last Name/First Name, however, you may sort by the\\ employee's pay destination or sort by Person code
|Create File |This field provides an option to create the file
|Directory Name |Enter a valid directory name
|File Name| Enter a file name or use the default file name from IDIF screen
|Exception Level |You should always run with the Exception level unless for tracing\\In Trace Level 1, the employee header with Person Code and Employee Name are\\displayed with performance time, this can be used for Progress bar or to locate\\employee with problem\\In Trace Level 2, the BE plans are displayed after employee header information\\People List Code Please specify if People list is to be used (Optional)
|Person Code| Enter one or more Person Codes (Optional)
|Location| Enter one or more Location codes(Optional)
|Authorization| Enter one or more Authorization Areas (Optional)
|Department| Enter one or more Department Codes (Optional)
|Org Level Type| Enter one or more Org Level Types (Optional)
|Org Level |Enter one or more Org Level within Org Level Types (Optional)
|Unit| Enter one or more Unit codes (Optional)
|Group |Enter one or more Group codes (Optional)
|Payroll| Enter one or more Payroll Codes (Optional)
|Employment Status| Enter one or more Employment Statuses (Optional)
|Termination Reason| Enter one or more Termination Reasons (Optional)
|Plan Type| This field is applicable if Interface Level = 'BE plans' (Optional)
|Plan| This field is applicable if Interface Level = 'BE plans' (Optional)
This page (revision-32) was last changed on 26-Nov-2021 10:22 by JEscottTop