This page (revision-26) was last changed on 31-Aug-2022 10:30 by Karen Parrott

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

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
26 31-Aug-2022 10:30 23 KB Karen Parrott to previous
25 26-Nov-2021 10:22 22 KB Meg McFarland to previous | to last
24 26-Nov-2021 10:22 22 KB ihowie to previous | to last
23 26-Nov-2021 10:22 22 KB kparrott to previous | to last
22 26-Nov-2021 10:22 22 KB kparrott to previous | to last
21 26-Nov-2021 10:22 22 KB kparrott to previous | to last

Page References

Incoming links Outgoing links
UPCAPERSXML
UPCAPERSXML

Version management

Difference between version and

At line 4 changed one line
The CalPERS organization has defined a new file format (XML) for submissions. This interface will replace that which was created by the [UPCAPERS] program in the application. [UPCAPERS] will be deprecated and may eventually become obsolete. [UPCAPERS] can still be used to produce reports. Note Nov 2017 UPCAPERS is not longer available in version 5.04.xx
The CalPERS organization has defined a new file format (XML) for submissions. This interface will replace that which was created by the [UPCAPERS] program in the application. [UPCAPERS] will be deprecated and may eventually become obsolete. [UPCAPERS] can still be used to produce reports
At line 15 removed 8 lines
!!Function Preference Setup
There is a new 'Function Preference' called [SCHED HRS ALIAS|SCHED HRS ALIAS(System_Preference)]. By default the regular 'Scheduled Hours' is taken from IEAS. If it should be taken from DJB or DPS then this preference can have a value of exactly 'DPS' or 'DJB'.
Scheduled Full Time Hours ( <n1:ScheduledFullTimeHoursPerWeek>) is now taken from one of three new columns (depending on the Preference setup).
It is taken in order by EASD.REPORT_HOURS_PER_WEEK if populated, then DPD.REPORT_HOURS_PER_WEEK, and then DJD.REPORT_HOURS_PER_WEEK.
This upgrade was primarily to handle Part Time Employees properly.
At line 24 changed one line
To facilitate reporting through UPCAPERSXML, certain elements have been defined. The following elements may be defined to include the pay components that reflect the different categories of information. Unless otherwise identified below, these elements must all be set up, even if they are empty.
To facilitate reporting through UPCAPERSXML, certain elements have been defined. The following elements may be defined to include the pay components that reflect the different categories of information. If one of these categories is not used, then the element does not need to be set up.
At line 38 changed 8 lines
|PERSRPT LOAN|After tax loan payment - This element is optional
|PERSADJ RSA EE|Employee Retro Earnings Contribution
|PERSADJ RSA ER|Employer Retro Earnings Contribution
|PERSADJ RSC EE|Employee Retro Special Compensation Earnings Contribution
|PERSADJ RSC ER|Employer Retro Special Compensation Earnings Contribution
|PERSRPT EE SIP2|(Optional) SIP2 Employer Contributions.457 Plan - This element should only be populated if the CalPERS Plan has 457 Supplemental Income associated with it.
|PERSRPT ER SIP2|(Optional) SIP2 Employer Contributions. 457 Plan - This element should only be populated if the CalPERS Plan has 457 Supplemental Income associated with it.
|PERSRPT LN SIP2|(Optional) SIP2 Loan
|PERSRPT LOAN|After tax loan payment
At line 50 removed 2 lines
Recent changes have allowed some of these fields to be instead referenced directly via database columns, but not all UDF's have been replaced at this time.
At line 57 changed 3 lines
|POSTED UPCAPERS|PPH|A flag that is used to indicate if the pay header has been posted to CalPERS or not. A value of “Y” means that it has and it will not be processed by subsequent UPCAPERSXML runs. A value of “N” or null means that it has not yet been processed and is eligible to be picked up.\\ \\%%information Note that this UDF has a space in the name not an underscore.%%\\ \\This is for compatibility with prior versions of CalPERS reporting. \\ \\This User Defined Field has been replaced by the database column POSTED_RETIREMENT as of the 4.10 release.
|CALPERS_ID|EID|the CalPERS-generated unique CalPERS ID for the participant\\ \\The CalPERS ID will be ten digits in length and used in place of a Social Security Number in contribution files. Prior to system “go-live”, CalPERS will send employers a file with the CalPERS ID for each of their existing employees. This is for compatibility with prior versions of CalPERS reporting. \\ \\This User Defined Field has been replaced by the database column EXTERNAL_RETIREMENT_ID as of the 4.10 release.
|APPOINTMENT_ID|EASD|The code representing the appointment into which the employee has been hired\\ \\Prior to system implementation, CalPERS will provide employers a list of their member’s Appointment IDs. After system implementation, employers can run a report online to generate a list of Appointment IDs.\\ \\If multiple appointments exists with the reporting employer, Appointment ID must be provided or the payroll record will error. \\ \\This User Defined Field has been replaced by the database column EXTERNAL_APPOINTMENT_ID as of the 4.10 release.
|POSTED UPCAPERS|PPH|A flag that is used to indicate if the pay header has been posted to CalPERS or not. A value of “Y” means that it has and it will not be processed by subsequent UPCAPERSXML runs. A value of “N” or null means that it has not yet been processed and is eligible to be picked up.\\ \\%%information Note that this UDF has a space in the name not an underscore.%%\\ \\This is for compatibility with prior versions of CalPERS reporting.
|CALPERS_ID|EID|the CalPERS-generated unique CalPERS ID for the participant\\ \\The CalPERS ID will be ten digits in length and used in place of a Social Security Number in contribution files. Prior to system “go-live”, CalPERS will send employers a file with the CalPERS ID for each of their existing employees.
|APPOINTMENT_ID|EASD|The code representing the appointment into which the employee has been hired\\ \\Prior to system implementation, CalPERS will provide employers a list of their member’s Appointment IDs. After system implementation, employers can run a report online to generate a list of Appointment IDs.\\ \\If multiple appointments exists with the reporting employer, Appointment ID must be provided or the payroll record will error.
At line 72 changed one line
Retired Annuitants may be identified either through their Employment Status (on [IEAS]) or via enrollment in a CALPERS plan. These employees will appear with a transaction type of "EPN" on the file.
Retired Annuitants may be identified either through their Employment Status (on [IEAS]) or via enrollment in a CALPERS plan.
At line 79 removed 11 lines
!Semi-Monthly payrolls
Note that for semi-monthly payrolls, the user has to run UPCAPERSXML for the __SECOND__ period in the month. Semi-monthly payrolls are reported on a monthly basis and therefore only one out of the two pay periods are used for reporting (the second pay period in the month).
!!Transaction Types
Retroactive Pay (RSA) is determined by the 'Pay Category Type' of RETRO.
If the Pay is NOT RETRO then the Pay is considered a Current Period Contribution (EPR) if the Pay is in the Current Pay Period.
If the Pay is NOT RETRO then the Pay is considered a Prior Period Contribution (PPA) if the Pay dated before the Current Pay Period.
At line 91 changed one line
My CalPERS requires that any Retroactive Pay be reported in separate ‘Transaction Types’. To accommodate this, Retroactive Pay must be created with [UPRETRO] and be stored into a pay category that has the Pay Category type of ’07-Reto Pay’.
My|CalPERS requires that any Retroactive Pay be reported in separate ‘Transaction Types’. To accommodate this, Retroactive Pay must be created with [UPRETRO] and be stored into a pay category that has the Pay Category type of ’07-Reto Pay’.
At line 94 changed 5 lines
A user-defined lexicon (CALPERS_SC) has been created to cross-reference the CalPERS Special Compensation codes, their categories and the pay components or elements that reflect the value for that special compensation. If you will use Special Compensation codes, you must run the script __''create_CALPERS_SC_lexicon.sql''__ which is included with the 4.10 Backend release. This will create the structure as noted below. Any records that do not pertain to your operation can then be deleted. Any changes made will be kept unless that script is run again.
The lexicon is CALPERS_SC and has the following structure in [IMLN]:
|SAVED VALUE|Special Compensation Type - which is a value from the list provided by the CalPERS agency\\ \\e.g. DST - Dictation/Shorthand/Typing Premium\\e.g. PFP - Physical Fitness Program
|DISPLAYED_VALUE|This is the Pay Component code or Element name (if it starts with E- (eg E-EARNS23)) that contains the value for the special compensation
|MEANING|This is the Compensation Category (from CalPERS Agency). This must be one of ICP, EDP, PPP, SAP, SSI, SCL or UNK. If the category is not specified, the compensation will be lumped in with UNK.\\ \\ICP - Incentive Pay\\EDP - Educational Pay\\PPP - Premium Pay\\SAP - Special Assignment Pay\\SSI - Statutory Items\\UNK - Unknown\\SCL - Sp Comp Legacy
A user-defined lexicon (CALPERS_SC) has been created to cross-reference the CalPERS Special Compensation codes, their categories and the pay components or elements that reflect the value for that special compensation. If you will use Special Compensation codes, you must run the script create_CALPERS_SC_lexicon.sql
which is included with the 4.10 Backend release. This will create the structure as noted below. You can then delete any records that do not pertain to your operation. Any changes you make, will be kept unless you run that script again.
The lexicon is CALPERS_SC and has the following structure in IMLN:
|SAVED VALUE|Special Compensation Type - which is a value from the List provided by the CalPERS agency
e.g. DST - Dictation/Shorthand/typing Premium
e.g. PFP - Physical Fitness Program
|DISPLAYED_VALUE|This is the Pay Component Code or Element name (if it starts with E- (eg E-EARNS23)) that contains the value for the special compensation
|MEANING|This is the Compensation Category (from CalPERS Agency) - must be one of ICP, EDP, PPP, SAP, SSI, SCL or UNK. if not specified will be lumped in with UNK
ICP - Incentive Pay
EDP - Educational Pay
PPP - Premium Pay
SAP - Special Assignment Pay
SSI - Statutory Items
UNK - Unknown
SCL - Sp Comp Legacy
At line 100 changed one line
%%information The table at the bottom of this page can be used to aid in filling out this lexicon value set. If you are not using a particular special compensation code, you can leave it with its initial value or delete the record from [IMLN].%%
You can use the table at the end of this document to aid in filling out this lexicon value set. If you are not using a particular special compensation code, you can leave it with its initial value or delete the record from IMLN.
At line 103 changed 16 lines
To create the CalPERS file, the UPCAPERSXML function must be launched. This is a batch process that could be scheduled as well. The following parameters have significance for the purposes of the CalPERS interface file generation:
!Report Parameters & Filters
||Report Parameters||
|Entity|Mandatory, LOV available\\One entity is allowed only per execution. Employer CalPERS ID is unique per entity.
|Pay Calendar|Mandatory, LOV available\\This field limits the process to the pay calendar specified. Only one pay calendar (frequency) is allowed per execution.
|(CPE) Pay Period|Mandatory, LOV available\\This identifies which Pay goes to the CPE (California Public Employees' Retirement System) Report.
|Beginning Pay Period|Mandatory, LOV available\\This identifies the starting pay period of the current CalPERS Reporting Cycle. Any transactions that are dated previous to the Period Begin date of this period are considered adjustments.
|Ending Pay Period|Mandatory, LOV available\\This identifies the ending pay period of the current CalPERS Reporting Cycle. Any transactions that are dated after the Period End date of this period are considered adjustments.
|Combine Start End PP|Optional\\If set to "Yes", report will combine Start and End Pay Periods.
|Incl RSA in ADJ|Optional\\If set to "Yes", report will include RSA (Retroactive Salary Adjustment) in ADJ report type.
|Directory Name|Mandatory, Text\\This is the directory on the data base server that you want to have the file created in. This must be a directory (or directory object) that is write-enabled for the data base process.
|CPE File Name|Mandatory, Text\\This is the name of the actual file you want created, for Payroll & Retirement submission. Note that CalPERS expects files that will be submitted to be in a specific naming format.
|SP2 File Name|Optional, Text\\The name of the actual file you want created, for SIP2 submission. If this file name is provided __and__ there are SIP2 entries to be made, they will be written to this file, instead of the CPE file. Note that this file name is optional.
|Test Report|Mandatory, LOV available\\If set to “No”, the POSTED UPCAPERS field will be updated with a “Y” so the pay header being processed does not get picked up again in a subsequent run. The generated XML file will be marked as a valid file.\\ \\If set to “Yes” the generated XML file will be marked as a ‘Test Run’ and the POSTED UPCAPERS field will not be updated.
|Exception Level|Optional, [Exception Level|X_TRACE_LEVEL] lexicon available\\This field defines the exception level (report messages) required. A ‘trace’ report of exception messages may be produced to assist in the testing phase. If necessary, choose from 0 – 9 (highest) level of trace. Please note that this is a voluminous report and will cause very slow performance.
|User Comments |Optional, Text \\This field holds the user-supplied comment which will appear in the header of all pages of the report. This is useful during testing phases to identify similar reports from each other.
To create the CalPERS file, you must launch the UPCAPERSXML function. This is a batch process that could be scheduled as well. The following parameters have significance for the purposes of the CalPERS interface file generation:
;Entity Code:One Entity is allowed only per execution. Employer CalPERS ID is unique per Entity
;Pay Calendar:Only one Pay Calendar (Frequency) per execution
;Pay Period:This identifies the Pay Period of the current CalPERS Reporting Cycle. Any transactions that are dated previous to the Period Begin Date of this period are considered adjustments.
;Directory Name:This is the directory on the data base server that you want to have the file created in. This must be a directory (or directory object) that is write-enabled for the data base process.
;CPE File Name:The name of the actual file you want created, for Payroll & Retirement submission. Note that CalPERS expects files that will be submitted to be in a specific naming format.
;SP2 File Name:The name of the actual file you want created, for SIP2 submission. If this file name is provided AND there are SIP2 entries to be made, they will be written to this file, instead of the CPE file. Note that this file name is optional.
;Test Report:If set to “No” will update the POSTED UPCAPERS field with a “Y” so the pay header being processed does not get picked up again in a subsequent run. The generated XML file will be marked as a valid file.
If set to “Yes” the generated XML file will be marked as a ‘Test Run’ and the POSTED UPCAPERS field will not be updated.
;Filters:These filters can be used to further narrow down the list of pay headers that you wish to process. Typically Entity, Payroll and Pay Run Number are used to filter to a specific pay run, or Person may be used to run tests against a subset of employees.
At line 120 removed 15 lines
||Report Filters||
These filters can be used to further narrow down the list of pay headers that you wish to process. Typically 'Entity', 'Payroll' and 'Pay Run Number' are used to filter to a specific pay run, or 'Person' may be used to run tests against a subset of employees.
|Person List Code|Optional, Multiple selections, LOV available\\This field limits the report to the person lists specified.
|Person|Optional, Multiple selections, LOV available\\This field limits the report to the persons specified.
|Unit|Optional, Multiple selections, LOV available\\This field limits the report to the units specified.
|Group|Optional, Multiple selections, LOV available\\This field limits the report to the groups specified.
|Payroll|Optional, Multiple selections, LOV available\\This field limits the report to the payrolls specified.
|Payrun Number|Optional, Multiple selections, LOV available\\This field limits the report to the payrun numbers specified.
|Department|Optional, Multiple selections, LOV available\\This field limits the report to the departments specified.
|Org Level Type|Optional, Multiple selections, LOV available\\This field limits the report to the org level types specified.
|Org Level|Optional, Multiple selections, LOV available\\This field limits the report to the org levels specified.
|Authorization|Optional, Multiple selections, LOV available\\This field limits the report to the authorizations specified.
|Location|Optional, Multiple selections, LOV available\\This field limits the report to the locations specified.
|Status|Optional, Multiple selections, LOV available\\This field limits the report to the status specified.
At line 137 changed one line
The “Report List” will indicate all the pays, as seen on [IPPH] that will be processed by the UPCAPERSXML program.
The “Report List” will indicate all the Pays, as seen on IPPH that will be processed by the UPCAPERSXML program.
At line 140 changed 3 lines
|SAVED VALUE|Special Compensation Type - which is a value from the list provided by the CalPERS agency.\\ \\e.g. DST - Dictation/Shorthand/Typing Premium\\e.g. PFP - Physical Fitness Program
|DISPLAYED_VALUE|This is the Pay Component code or Element name (if it starts with E- eg E-EARNS23) that contains the value for the special compensation.\\ \\For example, if for Educational Incentive Pay (EEI) you are computing/entering this in pay component 6543, you would update the displayed value for the EEI entry from PC or E-Element to 6543.\\ \\For example, if you had an element called EDUC_INCENT which contained all the pay components going into this special compensation category, you would update the displayed value from PC or E-Element to E-EDUC_INCENT – the E- at the beginning is the trigger to identify the value as an element.
|MEANING |This is the Compensation category (from CalPERS Agency). The category must be one of ICP, EDP, PPP, SAP, SSI, SCL or UNK. If the category is not specified, the compensation will be lumped in with UNK.\\ \\ICP - Incentive Pay\\EDP - Educational Pay\\PPP - Premium Pay\\SAP - Special Assignment Pay\\SSI - Statutory Items\\UNK - Unknown\\SCL - Sp Comp Legacy
|SAVED VALUE|Special Compensation Type - which is a value from the List provided by the CalPERS agency
e.g. DST - Dictation/Shorthand/typing Premium
e.g. PFP - Physical Fitness Program
|DISPLAYED_VALUE|This is the Pay Component Code or Element name (if it starts with E- (eg E-EARNS23)) that contains the value for the special compensation
For example, if for Educational Incentive Pay (EEI) you are computing/entering this in pay component 6543, you would update the displayed value for the EEI entry from PC or E-Element to 6543.
For example, if you had an element called EDUC_INCENT which contained all the pay components going into this special compensation category, you would update the displayed value from PC or E-Element to E-EDUC_INCENT – the E- at the beginning is the trigger to identify the value as an element
|MEANING |This is the Compensation Category (from CalPERS Agency) - must be one of ICP, EDP, PPP, SAP, SSI, SCL or UNK. if not specified will be lumped in with UNK
At line 109 added 8 lines
ICP - Incentive Pay
EDP - Educational Pay
PPP - Premium Pay
SAP - Special Assignment Pay
SSI - Statutory Items
UNK - Unknown
SCL - Sp Comp Legacy
At line 156 changed one line
!Educational Pay (EDP)
Educational Pay (EDP)
At line 175 changed one line
!Premium Pay (PPP)
Premium Pay (PPP)
At line 179 changed one line
!Special Assignment Pay (SAP)
Special Assignment Pay (SAP)
At line 256 changed one line
!Statutory Items (SSI)
Statutory Items (SSI)
At line 262 changed 2 lines
!Unknown (UNK)
||Type||Long Name||PC Code||Element Code
||Unknown||(UNK)
This page (revision-26) was last changed on 31-Aug-2022 10:30 by Karen ParrottTop