Search Results pay_ca_rl2_can_mag
Overview
PAY_CA_RL2_CAN_MAG is an Oracle E-Business Suite PL/SQL package owned by the APPS schema that supports Canadian legislative year-end reporting. Its specific purpose, as stated in the package header, is to support the generation of RL2 magnetic tape cancellation records required by Canada Revenue Agency (CRA) and Revenu Québec (RQ) legislative requirements. The package name reflects this scope: PAY (Payroll), CA (Canadian), RL2 (the RL-2 year-end slip format used in Québec), and MAG (magnetic media output).
The package is part of the Canadian Payroll year-end processing framework. When an employer must submit RL-2 information electronically, Oracle Payroll produces a formatted output file using the record layouts encoded in this package. Its procedures assemble the transmitter, employer, and employee record segments that comprise the RL2 file, including cancellation output when amendments or reversals are required. The package is declared AUTHID CURRENT_USER, meaning it executes with the privileges of the calling user rather than the definer, which affects how EXECUTE grants must be managed.
Key Procedures and Functions
The thirteen documented units fall into three functional groups:
- Record assembly: XML_TRANSMITTER_RECORD, XML_EMPLOYER_RECORD, XML_EMPLOYER_START, XML_EMPLOYEE_RECORD, and END_OF_FILE build the individual segments that constitute the RL2 output file. These are the core routines that emit each record type in the required positional or delimited layout. GET_TRANSMITTER_ITEM and GET_EMPLOYER_ITEM retrieve individual field values for those segments.
- Reporting framework integration: GET_REPORT_PARAMETERS, RANGE_CURSOR, GET_PARAMETER, and CREATE_ASSIGNMENT_ACT support the Action Parameter and range-based concurrent processing model. GET_PARAMETER retrieves runtime parameter values, typically through calls to the PAY_MAGTAPE_GENERIC utility, while RANGE_CURSOR and CREATE_ASSIGNMENT_ACT handle the assignment-action ranges processed by the concurrent request. GET_REPORT_PARAMETERS supplies the user-facing parameter list.
- Data validation and conversion: VALIDATE_QUEBEC_NUMBER verifies the format and check digit of Québec identification numbers, and CONVERT_SPECIAL_CHAR transliterates or replaces characters that are not permitted in the magnetic tape character set, such as accented letters in French-Canadian names.
The package header declares several cursors, including MAG_RL2_TRANSMITTER, MAG_RL2_EMPLOYER, and MAG_RL2_EMPLOYEE, which drive the selection of payroll action, assignment action, and person/assignment rows for the output. Cursor logic distinguishes transmitter and employer actions using parameter markers such as PAYROLL_ACTION_ID=P and PAYROLL_ACTION_ID=C. Notably, the commented-out variant of MAG_RL2_TRANSMITTER shows intent to include linked correction actions (report types RL2 and CAEOY_RL2_AMEND_PP with action status 'C'); the active code restricts selection to the single payroll action identified by the PAY_ACT parameter.
Tables Accessed
The package reads from and writes to the following tables through APPS synonyms:
- PAY_PAYROLL_ACTIONS and PAY_ASSIGNMENT_ACTIONS (plus PAY_ASSIGNMENT_ACTIONS_S): the primary driving entities for payroll runs and their assignment-level rows, used to identify the actions to report and to create assignment actions via CREATE_ASSIGNMENT_ACT.
- PAY_ACTION_INTERLOCKS: identifies related action pairs, supporting amendment and cancellation scenarios where a correction run is linked to an original run.
- PER_ALL_PEOPLE_F, PER_ALL_ASSIGNMENTS_F, PER_ADDRESSES, and PER_PEOPLE_EXTRA_INFO: source the employee name, address, and statutory identifiers required on RL-2 slips.
- HR_ORGANIZATION_INFORMATION and HR_ASSIGNMENT_SET_AMENDMENTS: supply employer-level business numbers and assignment set amendment context.
- PAY_ACTION_INFORMATION and PAY_REPORT_FORMAT_MAPPINGS_F: parameter storage and format-mapping definitions used during file layout generation.
- DUAL and UTL_RAW: used for constant-row selection and raw-format character conversion respectively.
Usage Notes
PAY_CA_RL2_CAN_MAG is not intended for direct invocation by end users. It is called from the Canadian Payroll year-end concurrent programs that produce RL2 magnetic media output—typically the Magnetic Media (RL-2) submission process—and from the corresponding XML record generators. It may also be referenced by the CAEOY_RL2_AMEND_PP amendment process, as evidenced by the interlocks logic in the transmitter cursor. Developers extending Canadian year-end output should treat the record-assembly routines as the extension point for layout changes, and the validation routines (VALIDATE_QUEBEC_NUMBER, CONVERT_SPECIAL_CHAR) as reusable utilities for Québec-specific data hygiene. No other packages in the documented set reference this package, so its API surface is stable and confined to the year-end reporting framework.
-
PACKAGE: APPS.PAY_CA_RL2_CAN_MAG
12.2.2
owner:APPS, object_type:PACKAGE, object_name:PAY_CA_RL2_CAN_MAG, status:VALID,
-
PACKAGE BODY: APPS.PAY_CA_RL2_CAN_MAG
12.2.2
owner:APPS, object_type:PACKAGE BODY, object_name:PAY_CA_RL2_CAN_MAG, status:VALID,
-
PACKAGE: APPS.PAY_CA_EMP_ADDRESS_DTLS
12.2.2
owner:APPS, object_type:PACKAGE, object_name:PAY_CA_EMP_ADDRESS_DTLS, status:VALID,
-
PACKAGE: APPS.PAY_CA_RL2_CAN_MAG
12.2.2
-
PACKAGE: APPS.PAY_CA_RL1_CAN_MAG
12.2.2
owner:APPS, object_type:PACKAGE, object_name:PAY_CA_RL1_CAN_MAG, status:VALID,
-
PACKAGE: APPS.PAY_CA_RL2_MAG
12.2.2
owner:APPS, object_type:PACKAGE, object_name:PAY_CA_RL2_MAG, status:VALID,
-
VIEW: APPS.PAY_CA_EOY_RL2_FOOTNOTE_INFO_V
12.2.2
owner:APPS, object_type:VIEW, fnd_design_data:PAY.PAY_CA_EOY_RL2_FOOTNOTE_INFO_V, object_name:PAY_CA_EOY_RL2_FOOTNOTE_INFO_V, status:VALID,
-
VIEW: APPS.PAY_CA_EOY_RL2_FURTHER_INFO_V
12.2.2
owner:APPS, object_type:VIEW, object_name:PAY_CA_EOY_RL2_FURTHER_INFO_V, status:VALID,
-
VIEW: APPS.PAY_CA_EOY_RL2_EMPLOYEE_INFO_V
12.2.2
owner:APPS, object_type:VIEW, fnd_design_data:PAY.PAY_CA_EOY_RL2_EMPLOYEE_INFO_V, object_name:PAY_CA_EOY_RL2_EMPLOYEE_INFO_V, status:VALID,
-
PACKAGE: APPS.PAY_CORE_FILES
12.2.2
owner:APPS, object_type:PACKAGE, object_name:PAY_CORE_FILES, status:VALID,
-
VIEW: APPS.PAY_CA_EOY_RL2_TRANS_INFO_V
12.2.2
owner:APPS, object_type:VIEW, fnd_design_data:PAY.PAY_CA_EOY_RL2_TRANS_INFO_V, object_name:PAY_CA_EOY_RL2_TRANS_INFO_V, status:VALID,
-
SYNONYM: APPS.PAY_REPORT_FORMAT_MAPPINGS_F
12.2.2
owner:APPS, object_type:SYNONYM, object_name:PAY_REPORT_FORMAT_MAPPINGS_F, status:VALID,
-
PACKAGE: APPS.PAY_MAGTAPE_GENERIC
12.2.2
owner:APPS, object_type:PACKAGE, object_name:PAY_MAGTAPE_GENERIC, status:VALID,
-
SYNONYM: APPS.PAY_ACTION_INTERLOCKS
12.2.2
owner:APPS, object_type:SYNONYM, object_name:PAY_ACTION_INTERLOCKS, status:VALID,
-
PACKAGE: SYS.UTL_RAW
12.2.2
owner:SYS, object_type:PACKAGE, object_name:UTL_RAW, status:VALID,
-
SYNONYM: APPS.HR_ASSIGNMENT_SET_AMENDMENTS
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_ASSIGNMENT_SET_AMENDMENTS, status:VALID,
-
SYNONYM: PUBLIC.UTL_RAW
12.2.2
owner:PUBLIC, object_type:SYNONYM, object_name:UTL_RAW, status:VALID,
-
SYNONYM: APPS.PER_PEOPLE_EXTRA_INFO
12.2.2
owner:APPS, object_type:SYNONYM, object_name:PER_PEOPLE_EXTRA_INFO, status:VALID,
-
PACKAGE: APPS.PAY_CORE_UTILS
12.2.2
owner:APPS, object_type:PACKAGE, object_name:PAY_CORE_UTILS, status:VALID,
-
PACKAGE: APPS.HR_NONRUN_ASACT
12.2.2
owner:APPS, object_type:PACKAGE, object_name:HR_NONRUN_ASACT, status:VALID,
-
SYNONYM: APPS.PAY_ASSIGNMENT_ACTIONS_S
12.2.2
owner:APPS, object_type:SYNONYM, object_name:PAY_ASSIGNMENT_ACTIONS_S, status:VALID,
-
APPS.PAY_CA_RL2_CAN_MAG dependencies on PAY_CA_RL2_CAN_MAG
12.2.2
-
SYNONYM: APPS.PER_ADDRESSES
12.2.2
owner:APPS, object_type:SYNONYM, object_name:PER_ADDRESSES, status:VALID,
-
SYNONYM: APPS.PAY_ACTION_INFORMATION
12.2.2
owner:APPS, object_type:SYNONYM, object_name:PAY_ACTION_INFORMATION, status:VALID,
-
SYNONYM: APPS.PAY_ASSIGNMENT_ACTIONS
12.2.2
owner:APPS, object_type:SYNONYM, object_name:PAY_ASSIGNMENT_ACTIONS, status:VALID,
-
SYNONYM: APPS.PAY_PAYROLL_ACTIONS
12.2.2
owner:APPS, object_type:SYNONYM, object_name:PAY_PAYROLL_ACTIONS, status:VALID,
-
12.2.2 DBA Data
12.2.2
-
12.2.2 DBA Data
12.2.2
-
SYNONYM: APPS.PER_ALL_ASSIGNMENTS_F
12.2.2
owner:APPS, object_type:SYNONYM, object_name:PER_ALL_ASSIGNMENTS_F, status:VALID,
-
VIEW: APPS.HR_LOOKUPS
12.2.2
owner:APPS, object_type:VIEW, fnd_design_data:PER.HR_LOOKUPS, object_name:HR_LOOKUPS, status:VALID,
-
SYNONYM: APPS.PER_ALL_PEOPLE_F
12.2.2
owner:APPS, object_type:SYNONYM, object_name:PER_ALL_PEOPLE_F, status:VALID,
-
SYNONYM: APPS.HR_ORGANIZATION_INFORMATION
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_ORGANIZATION_INFORMATION, status:VALID,
-
VIEW: APPS.PER_PEOPLE_F
12.2.2
owner:APPS, object_type:VIEW, fnd_design_data:PER.PER_PEOPLE_F, object_name:PER_PEOPLE_F, status:VALID,
-
VIEW: APPS.PER_ASSIGNMENTS_F
12.2.2
owner:APPS, object_type:VIEW, fnd_design_data:PER.PER_ASSIGNMENTS_F, object_name:PER_ASSIGNMENTS_F, status:VALID,
-
PACKAGE: APPS.FND_NUMBER
12.2.2
owner:APPS, object_type:PACKAGE, object_name:FND_NUMBER, status:VALID,
-
PACKAGE BODY: APPS.PAY_CA_RL2_CAN_MAG
12.2.2
-
PACKAGE: APPS.HR_GENERAL
12.2.2
owner:APPS, object_type:PACKAGE, object_name:HR_GENERAL, status:VALID,
-
SYNONYM: PUBLIC.DUAL
12.2.2
owner:PUBLIC, object_type:SYNONYM, object_name:DUAL, status:VALID,
-
PACKAGE: APPS.FND_GLOBAL
12.2.2
owner:APPS, object_type:PACKAGE, object_name:FND_GLOBAL, status:VALID,
-
12.2.2 DBA Data
12.2.2
-
12.2.2 DBA Data
12.2.2
-
PACKAGE: APPS.HR_UTILITY
12.2.2
owner:APPS, object_type:PACKAGE, object_name:HR_UTILITY, status:VALID,