Search Results validate_transmitter_info




Overview

APPS.PAY_CA_RL2_CAN_MAG is a Canadian payroll legislative reporting package executed within the Oracle E-Business Suite 12.1.1 and 12.2.2 environments. Its business function is the generation of the RL-2 (Relevé 2) statement, the Quebec provincial tax slip that employers must issue to employees and to Revenu Québec summarizing employment income, Quebec income tax withheld, and related contributions for a given taxation year. The package body carries the version header pycarl2cmg.pkb 120.11.12020000.7, indicating it belongs to the North American payroll legislative layer shipped under the payroll (PAY) application.

The package performs two distinct responsibilities: it extracts the payroll action context that drives a given RL-2 run, and it produces the structured magnetic-media (XML) output required for electronic filing with Revenu Québec. It therefore sits between the standard payroll action framework and the external filing format consumed by the provincial revenue authority.

Key Procedures and Functions

  • GET_REPORT_PARAMETERS — Resolves the run context for a payroll action, returning the period start and end dates, business group, report type, and legislative parameters into the caller's OUT parameters. This is the entry point through which the report identifies which payroll run it is summarizing.
  • VALIDATE_TRANSMITTER_INFO — Confirms that the transmitter record contains complete and valid data, including package type, source of the RL-2 slip, transmitter number, and related attributes, before any file is produced.
  • GET_PARAMETER — Retrieves an individual report parameter value used to configure the output.
  • GET_TRANSMITTER_ITEM and GET_EMPLOYER_ITEM — Return individual data elements for the transmitter and employer segments of the RL-2 submission.
  • XML_TRANSMITTER_RECORD — Emits the transmitter-level XML record that heads the electronic file.
  • XML_EMPLOYER_START and XML_EMPLOYER_RECORD — Emit the employer identification and summary segments of the XML document.
  • XML_EMPLOYEE_RECORD — Emits the per-employee RL-2 detail record containing box amounts reported to the employee.
  • END_OF_FILE — Produces the trailer record that closes the file and carries control totals.
  • RANGE_CURSOR and CREATE_ASSIGNMENT_ACT — Support the driving cursor that selects the population of assignment actions to be reported and materializes assignment action rows as required by the run.
  • VALIDATE_QUEBEC_NUMBER — Validates the Quebec identification number format (for example, the employer or employee Quebec tax identifier) before it is written to the output.
  • CONVERT_SPECIAL_CHAR — Normalizes accented and special characters from the Oracle character set into a representation acceptable to the magnetic-media specification.

Tables Accessed

Payroll action context is read from PAY_PAYROLL_ACTIONS, with dependent rows in PAY_ACTION_INTERLOCKS and PAY_ACTION_INFORMATION, which hold the parameters and run metadata. Assignment-level reporting data is drawn from PAY_ASSIGNMENT_ACTIONS and its _S shadow table, joined to PER_ALL_ASSIGNMENTS_F, PER_ALL_PEOPLE_F, and PER_ADDRESSES for employee identity, assignment, and address details. PER_PEOPLE_EXTRA_INFO and HR_ASSIGNMENT_SET_AMENDMENTS supply legislative detail such as Quebec identifiers and amendments, while HR_ORGANIZATION_INFORMATION supplies employer-level attributes. PAY_REPORT_FORMAT_MAPPINGS_F drives the layout of the report output. DUAL and UTL_RAW are used for scalar evaluation and raw-to-character conversion.

Usage Notes

The package is invoked from the Canadian payroll legislative reporting flow rather than by end users directly. A payroll action of the RL-2 report type is created in the Payroll module; the report driver then calls GET_REPORT_PARAMETERS to bind the period and business group, walks the assignment action population, and streams the transmitter, employer, and employee XML segments. Because it is an APPS-owned package body with no external dependents, it is not referenced by other shipped packages and should be treated as an implementation detail of the RL-2 electronic filing process. Customizations should be limited to concurrent program parameter configuration and the underlying format mappings; direct modification of the package body is not supported.