The ROE XML interface file will be generated according to IDIF set up for each field. Please refer to following description of each field on the interface file.
Note that the description below is only to explain how UPROEF retrieves the information from the system, this is not the full XML file content, user should refer to government website for the complete layout of the ROE XML file. http://www.esdc.gc.ca/en/ei/roe/user_requirements/appendix_d.page
Column Heading:
ROE block no. / Field Name - from ROE publication description
Tag Name - XML Tag Name of the ROE XML file
INF LEX Value - from lexicon X_INF_VARIABLE_NAME for this Interface type
Variable Name - explains the default variables provided by the system - user may change the variable name from look up values
| Rec block no./Field Name | Tag Name | INF LEX Value | Variable Name | ||
|---|---|---|---|---|---|
| Print Language for ROE form | PrintingLanguage | 353128 | Language Code (EID) | ||
| ROE Draft or To be Submitted | Issue | 353395 | ROE process meth (ROE) - from UPROEF parameter ‘ROE Process Method’ of each run - user may run ROE for Draft or for Submission in each run | ||
| Block 2 – Serial Number of ROE amended or replaced | B2 | Block 2 – Serial Number of ROE amended or replaced | - IEEI UDF: ‘ROE AMEND SERIAL’ - Optional, but if completed: - Must be 9 alphanumeric characters First character must be “W” followed by 8 numbers | ||
| Block 3 – Employer Payroll Reference | B3 | 353101 | Person Code (EID) - using eid.id to retrieve Employee’s Location Code [350201] to concatenate Person Code [353100] - may change to other Variable Name e.g. Entity code, Dept code, Group Code etc. | ||
| Block 5 – CRA BN Number | B5 | ||||
| OrgNum | OrgNum | 358039 | - IDGR UDF: ‘ROE ORGNUM’ | ||
| FolderCD | FolderCD | 358039 | - IDGR UDF: ‘ROE FOLDERCD’ | ||
| CRA BN Number | 350800 | Govt Regist Number (IDGV) -derived from Pay Headers Group code | |||
| Block 6 – Pay Period Type | B6 | 353390 | Pay Frequency (ROE) - from IPCL.PAY_FREQUENCY first character or IPCL UDF ‘ROE PAY FREQUENCY; | ||
| Block 8 – Social Insurance Number | B8 | 353102 | Government Code (IEID) | ||
| Block 9 – Employee info | B9 | ||||
| Employee First Name | FN | 353103 | First Name (EID) | ||
| Employee Last Name | LN | 353105 | Last Name (EID) | ||
| Employee Address line 1 | A1 | 353220 | Mail Address Line 1 (EPS) - should set up to use Mailing address - if Mailing address does not exist, the primary address will automatically be used | ||
| Employee Address line 2 | A2 | 353222 | Mail Ln2 + Locality (EPS) | ||
| Employee Prov. Country | A3 | 353224/353225 | Mail State+Cntry (EPS) | ||
| Employee Postal Code | PC | 353226 | Mail State+Cntry+Postal (EPS) | ||
| Block 10 – First day worked | B10 | 353391 | First day worked (ROE) - from IEEI UDF ‘ROE 1st Work Date Override:’ if specified, otherwise from EEM first_work_date - If employee has issued ROE before (i.e. IEEI UDF Prev ROE Upto is not null), then - the First Day Worked is retrieved from the earliest pay line start_date of the first Regular Pay Header that is with Pay Period after 'Prev ROE Upto' pay period | ||
| Block 11 – Last day for which paid | B11 | 353392 | Last day paid (ROE) - from IEEI UDF ‘ROE Last Work Date Override:’ if specified, otherwise from EEM last_work_date | ||
| Block 12 – Final Pay Period Ending Date | B12 | 353393 | Final period end (ROE) - from Last pay period end date being paid | ||
| Block 13 – Employee occupation | B13 | 353523 | Assignment Title (EASD) | ||
| Block 14 – Expected Recall Information | B14 | ||||
| Block 14 – Expected recall code | CD | 353314 | Rehire Status (EEM) - REHIRE_STATUS lexicon values are: 00 – No Decision Made 01 – Would Rehire 02 – Would Not Rehire 03 – Has Been Rehired 04 – Recall Expected 05 – Recall Not Expected - use ‘Derivation Expression’ to return value to print on ROE: Y – Date of recall N – Not returning U – Unknown S – Unspecified decode(~,'02','N','04','Y','05','N','U') - this means: substitute with the value from EMPLOYMENT.REHIRE_STATUS - if value of = ‘02’, then return ‘N’, then if value of = ‘04’, then return ‘Y’, then if value of = ‘05’, then return ‘N’, otherwise return ‘U’ | ||
| Expected date of recall | DT | 353315 | Expected Return Date (EEM) | ||
| Block 15A – Total Insurable hours (Box 15A) | B15A | 358021 | Internal Total for Amt 1 - Box 15A and 15C are derived by UPROEF according to the number of Pay Periods required by the ROE specification for each Pay Frequency - rounded to nearest hours, no decimals/ /- For each Pay Header of the qualified reporting Pay Period, the EI Hours is retrieved from the Pay Component with PC Usage '5022' EI Hours (PPE), then the Total EI Hours are accumulated | ||
| Block 15B – Total Insurable earnings (Box 15B) | No need to report for ROE XML file | ||||
| Block 15C – Insurable Earnings | B15C | ||||
| Earnings for Pay Period 1 | <PP nbr="1"> | -1 | |||
| Earnings for Pay Period 1 | AMT | 358013 | Internal Table Amt 3 - the number of pay periods to be reported is defined by Pay Frequency - Box 15C is retrieved from Internal Table Amt 2 and 3 - if a Pay Period has zero amount, then 0.00 is reported, otherwise Null/ /- For each Pay Header of the qualified reporting Pay Period, the EI Earnings is retrieved from the Pay Component with PC Usage '5021' EI Earnings (PPE), then the Total EI Earnings are accumulated for one pay period/ /- For Period 1 (this is usually the Final Pay or the most recent pay period that was paid), the EI Earnings should have been paid in UPCALC/UPCLOZ to include the Vacation pays, Statutory Holiday pays, Other monies and any Special Payments that should be reported in Box 17 and Box 19 | ||
| Earnings for Pay Period 2 | <PP nbr="2"> | -1 | |||
| Earnings for Pay Period 1 | AMT | 358013 | Internal Table Amt 3 | ||
| Earnings for Pay Period 3 | <PP nbr="3"> | -1 | |||
| Earnings for Pay Period 3 | AMT | 358013 | Internal Table Amt 3 | ||
| Earnings for Pay Period 4 | <PP nbr="4"> | -1 | |||
| Earnings for Pay Period 4 | AMT | 358013 | Internal Table Amt 3 | ||
| Earnings for Pay Period 5 | <PP nbr="5"> | -1 | |||
| Earnings for Pay Period 5 | AMT | 358013 | Internal Table Amt 3 | ||
| Earnings for Pay Period 6 | <PP nbr="6"> | -1 | |||
| Earnings for Pay Period 6 | AMT | 358013 | Internal Table Amt 3 | ||
| Earnings for Pay Period 7 | <PP nbr="7"> | -1 | |||
| Earnings for Pay Period 7 | AMT | 358013 | Internal Table Amt 3 | ||
| Earnings for Pay Period 8 | <PP nbr="8"> | -1 | |||
| Earnings for Pay Period 8 | AMT | 358013 | Internal Table Amt 3 | ||
| Earnings for Pay Period 9 | <PP nbr="9"> | -1 | |||
| Earnings for Pay Period 9 | AMT | 358013 | Internal Table Amt 3 | ||
| Earnings for Pay Period 10 | <PP nbr="10"> | -1 | |||
| Earnings for Pay Period 10 | AMT | 358013 | Internal Table Amt 3 | ||
| Earnings for Pay Period 11 | <PP nbr="11"> | -1 | |||
| Earnings for Pay Period 11 | AMT | 358013 | Internal Table Amt 3 | ||
| …. Continue up to the # of PP by Pay Frequency: Biweekly – last 27 periods Monthly – Last 13 Periods SM – Last 25 periods Weekly – Last 53 periods | |||||
| Earnings for Pay Period 53 | <PP nbr="53"> | -1 | |||
| Earnings for Pay Period 53 | AMT | 358013 | Internal Table Amt 3 | ||
| Block 16 – Reason for issuing ROE | B16 | ||||
| Block 16 – Reason for Issue ROE | CD | 353394 | Reason issue (ROE) - Effective 2016 ROE XML file reporting, ROE Reason is changed from 1 character to 3 characters - from IEEI UDF ‘ROE REASON CODE’ if specified, otherwise from IEEI ROE_LETTER concatenate with ‘00’, e.g. ‘K’ is reported as ‘K00’ - if IEEI does not specify the ROE Reason, then when employee is terminated, the IEEI EMPLOYMENT specifies a Termination Reason - the ‘Termination Reason’ is defined on IDTR screen - then from IDTR UDF ‘ROE REASON CODE’ of the Termination Reason, if specified, use it, otherwise from IDTR ROE_LETTER concatenate with ‘00’, e.g. ‘K’ is reported as ‘K00’ - otherwise ROE Reason is Null | ||
| Block 16 – Contact Person First Name | FN | 350003 | Constant Value - enter your company contact | ||
| Block 16 – Contact Person Last Name | LN | 350003 | Constant Value - enter your company contact | ||
| Block 16 – Contact Person Phone Area code | AC | 350003 | Constant Value - enter your company contact | ||
| Block 16 – Contact Person Phone Number | TEL | 350003 | Constant Value - enter your company contact | ||
| Block 16 – Contact Person Phone Extn | EXT | 350003 | Constant Value - enter your company contact | ||
| Block 17A – Vacation Pay information | B17A | ||||
| Vacation Pay Information | <VP nbr="1"> | ||||
| Block 17A – Vacation Pay Code | CD | 358031 | - from IEEI UDF: ‘ROE VACN CODE’ , Lexicon: X_ROE_VACN_CODE | ||
| Block 17A – Vacation Pay Start Date | SDT | 358031 | - IEEI UDF: ‘ROE VACN STARTDT’ | ||
| Block 17A – Vacation Pay End Date | EDT | 358031 | - IEEI UDF: ‘ROE VACN ENDDT’ | ||
| Block 17A – Vacation Pay Amount | AMT | 358014 | Internal Table Amt 4 of Index 1700 - from IEEI UDF: ‘ROE VACN PAY’ if exists, otherwise from Element ‘ROE VACN PAY’ of the Final Pay or Last Pay | ||
| Block 17B – Statutory Holiday | B17B | ||||
| Statutory Holiday 1 | <SH nbr="1"> | ||||
| Statutory Holiday Date 1 | DT | 358031 | - IEEI UDF: ‘ROE STATHOL1 DATE’ | ||
| Statutory Holiday 1 Amount | AMT | 358014 | Internal Table Amt 4 of Index 1721 - from IEEI UDF: ‘ROE STATHOL1 AMT’ if exists, otherwise from Element ‘ROE STATHOL1 AMT’ of the Final Pay or Last Pay | ||
| Statutory Holiday 2 | <SH nbr="2"> | ||||
| Statutory Holiday Date 2 | DT | 358031 | - IEEI UDF: ‘ROE STATHOL2 DATE’ | ||
| Statutory Holiday 2 Amount | AMT | 358014 | Internal Table Amt 4 of Index 1721 - from IEEI UDF: ‘ROE STATHOL2 AMT’ if exists, otherwise from Element ‘ROE STATHOL2 AMT’ of the Final Pay or Last Pay | ||
| …. Continued up to/ Statutory Holiday 10 | |||||
| Statutory Holiday 10 | <SH nbr="10"> | ||||
| Statutory Holiday Date 10 | DT | 358031 | - IEEI UDF: ‘ROE STATHOL10 DATE’ | ||
| Statutory Holiday 10 Amount | AMT | 358014 | Internal Table Amt 4 of Index 1721 - from IEEI UDF: ‘ROE STATHOL10 AMT’ if exists, otherwise from Element ‘ROE STATHOL10 AMT’ of the Final Pay or Last Pay | ||
| Block 17C – Other Monies | B17C | ||||
| Other Monies 1 | <OM nbr="1"> | ||||
| Other Monies Code 1 | CD | 358031 | - IEEI UDF: ‘ROE OTHER1 CODE’ | ||
| Other Monies Start Date 1 | SDT | 358031 | - IEEI UDF: ‘ROE OTHER1 STARTDT’ | ||
| Other Monies End Date 1 | EDT | 358031 | - IEEI UDF: ‘ROE OTHER1 ENDDT’ | ||
| Other Monies Amount 1 | AMT | 358014 | Internal Table Amt 4 of Index 1751 - from IEEI UDF: ‘ROE O THER1 AMT’ if exists, otherwise from Element ‘ROE OTHER1 AMT’ of the Final Pay or Last Pay | ||
| …. Continue up to/ Other Monies 3 | |||||
| Block 18 – Comments | B18 | 353396 | ROE Comment line 1 (ROE) | ||
| Block 19 – Special Payments | B19 | ||||
| Special Payment Code 1 | <OM nbr="1"> | 358031 | - IEEI UDF: ‘ROE SPEC PYMT1 CODE’ | ||
| Special Payment 1 Start Date | SDT | 358031 | - IEEI UDF: ‘ROE SPEC PYMT1 STARTDT’ | ||
| Special Payment 1 End Date | EDT | 358031 | - IEEI UDF: ‘ROE SPEC PYMT1 ENDDT’ | ||
| Special Payment 1 Amount | AMT | 358014 | Internal Table Amt 4 of Index 1751 - from IEEI UDF: ‘ROE SPEC PYMT1 AMT’ if exists, otherwise from Element ‘ROE SPEC PYMT1 AMT’ of the Final Pay or Last Pay | ||
| Special Payment 1 Period | PRD | 358031 | - IEEI UDF: ‘ROE SPEC PYMT1 ENDDT’ | ||
| …. Continue up to/ Special Payment 4 | |||||
| Block 20 – Issuer Communication Language | N | 350114 | Language Code (DED) |
