Search Results store_further_information

Overview

PAY_CA_RL1_CAN_MAG is a Canadian payroll tax reporting package within the Oracle E-Business Suite Payroll (PAY) module. Its name reflects its purpose: it produces the Relevé 1 (RL1) magnetic media and XML output for the province of Quebec. The RL1 is the Quebec equivalent of the federal T4 slip, summarizing employment income and provincial tax deductions for each employee. This package encapsulates the logic required to format that data for electronic transmission to Revenu Québec, including employer-level and employee-level record generation, transmitter context setup, and end-of-file control records.

The package is declared AUTHID CURRENT_USER, meaning it executes with the privileges of the invoking user rather than its owner. The header carries a version marker ($Header: pycarlcmg.pkh 120.1.12020000.2 2012/11/21), confirming it is a shipped, supported Oracle object present in both EBS 12.1.1 and 12.2.2.

Key Procedures and Functions

• GET_REPORT_PARAMETERS — Retrieves the report or concurrent request parameters needed to drive the RL1 generation run, such as the payroll action identifier.
• GET_PARAMETER — Wraps the standard parameter lookup so that subsequent cursors can obtain a single named value from the running concurrent request.
• STORE_FURTHER_INFORMATION — Populates the package-level collection (g_further_info_list) with supplementary code/amount pairs. This collection is typed by other_info_rec and other_info_tab and is used to pass additional reporting detail between processing stages.
• GET_FURTHER_INFORMATION — The accessor corresponding to the search term. It returns the stored further-information list so that downstream cursors and record builders can reference additional RL1 codes and amounts previously stashed by STORE_FURTHER_INFORMATION.
• RANGE_CURSOR — Defines the driving cursor that selects the population of employees or assignments to be reported.
• CREATE_ASSIGNMENT_ACT — Creates an assignment action record, linking an assignment to the payroll action for reporting purposes.
• VALIDATE_QUEBEC_NUMBER — Validates a Quebec identification number, ensuring the value conforms to the format required on the RL1 slip.
• GET_ARCH_VAL — Retrieves archived values, supporting amended or historical RL1 reporting.
• XML_TRANSMITTER_RECORD — Generates the transmitter (submitter) record for the XML RL1 file.
• XML_EMPLOYER_START — Emits the opening employer-level XML segment.
• XML_EMPLOYER_RECORD — Produces the employer detail record within the XML output.
• XML_EMPLOYEE_RECORD — Produces the per-employee record containing income and tax amounts.
• END_OF_FILE — Writes the file trailer, including record counts and totals.

Tables Accessed

The package reads and writes a broad set of HRMS and Payroll tables through APPS synonyms:

• PAY_PAYROLL_ACTIONS, PAY_ASSIGNMENT_ACTIONS (and _S), PAY_ACTION_INTERLOCKS, PAY_ACTION_INFORMATION — resolve the payroll action, assignment actions, action interlocks, and stored action information that define the reporting run and link locked actions to their source.
• PER_ALL_ASSIGNMENTS_F, PER_ALL_PEOPLE_F — supply employee, assignment, and effective-dated person attributes for each RL1 slip.
• PER_ADDRESSES, PER_PEOPLE_EXTRA_INFO, HR_ORGANIZATION_INFORMATION — provide addresses, extra person information, and employer/organization details required on the slip and transmitter records.
• HR_ASSIGNMENT_SET_AMENDMENTS — supports amended RL1 processing.
• FF_ARCHIVE_ITEMS, FF_DATABASE_ITEMS — used by GET_ARCH_VAL to read archived and database fast-formula item values.
• PLITBLM and DUAL — auxiliary constructs used for list handling and singleton lookups.

Usage Notes

PAY_CA_RL1_CAN_MAG is invoked by the Canadian RL1 magnetic media / XML concurrent programs rather than directly by end users. The mag_rl1_transmitter cursor demonstrates the standard entry point: it derives the payroll action identifier from pay_magtape_generic.get_parameter_value('PAY_ACT'), and the original header notes it expected the linked action's report_type to be 'RL1' or 'CAEOY_RL1_AMEND_PP' with action_status = 'C' (completed). A later revision simplified that cursor, reflecting defect fixes (Bug 14701466, Bug 9142143).

Custom code should treat this package strictly as a report-generation engine and avoid calling its internal procedures out of sequence. Any extension must preserve the tax unit context established by the transmitter cursor, since subsequent cursors restrict employee selection to the employer being reported. Because it is referenced by one other package and ships in both 12.1.1 and 12.2.2, compatibility is generally stable, but version header differences should be verified before patching.