Search Results convert_special_char

Overview

APPS.PAY_CA_RL2_MAG is a Canadian payroll legislative reporting package that produces the RL-2 (Relevé 2) tax slip data required by Revenu Québec. It belongs to the payroll family of Canadian mag

netic-media and XML reporting objects and is classified under the API classification OTHER within the ETRM repository. The package is responsible for assembling employee, employer, and transmitter information into a structured report, converting each record into an XML fragment, and exposing the accumulated XML to the calling report program. The header of the package body (pycarl2mg.pkb, version 120.55.12010000.3) indicates that it has been maintained through the 12.1.1 code line and continues to be shipped in the 12.2.2 environment.

The object was located by a search for convert_special_char, an internal utility frequently used within Canadian payroll report packages to replace reserved XML characters such as ampersands, angle brackets, and quotation marks with their escaped equivalents before the data is written into an XML stream. Its function within PAY_CA_RL2_MAG is to sanitize names, addresses and free-form text fields so that the generated RL-2 file remains well-formed.

Key Procedures and Functions

• STORE_FURTHER_INFORMATION / GET_FURTHER_INFORMATION — persist and retrieve auxiliary RL-2 data that is not held on the standard payroll tables, typically transmitter and slip-level attributes entered at submission time.
• GET_REPORT_PARAMETERS — reads the payroll action to obtain the reporting period start and end dates, business group, report type and legislative parameters. Note that the published documentation lists the procedure as GET_REPORT_PARAMETERS while the source excerpt shows the internal name get_report_parameters.
• RANGE_CURSOR / GET_PARAMETER — cursor and parameter accessors used to drive the driving query and supply configuration values to the report.
• VALIDATE_TRANSMITTER_INFO — validates package type, source of the RL-2 slip, transmitter number and transmitter name before the file is created.
• GET_SLIP_SEQ_NO — allocates the sequential slip number used to identify each RL-2 within the submission.
• GET_TRANSMITTER_ITEM, GET_EMPLOYER_ITEM, GET_EMPLOYEE_ITEM — assemblers that supply the data items for each of the three record levels of the RL-2 file.
• XML_TRANSMITTER_RECORD, XML_EMPLOYER_START, XML_EMPLOYER_RECORD, XML_EMPLOYEE_RECORD, XML_REPORT_START, XML_REPORT_END, END_OF_FILE — XML generation routines that build the hierarchical report structure and terminate the stream.
• CREATE_ASSIGNMENT_ACT, FETCH_RL2_XML, GET_FINAL_XML, ARCHIVE_CA_DEINIT — assignment action creation, retrieval of the assembled XML, delivery of the final document and cleanup of temporary data.

Tables Accessed

The package reads payroll action and assignment data from PAY_PAYROLL_ACTIONS, PAY_ASSIGNMENT_ACTIONS and PAY_ASSIGNMENT_ACTIONS_S, and supplementary report values from PAY_ACTION_INFORMATION, PAY_ACTION_INTERLOCKS and PAY_REPORT_FORMAT_MAPPINGS_F. Person and assignment details come from PER_ALL_PEOPLE_F, PER_ALL_ASSIGNMENTS_F and PER_ADDRESSES. Organization, location and organization classification data come from HR_ALL_ORGANIZATION_UNITS, HR_LOCATIONS_ALL and HR_ORGANIZATION_INFORMATION. Writes are directed against PAY_ACTION_INFORMATION and the assignment action tables, with DUAL used for single-row lookups, DBMS_LOB for the XML large object and PLITBLM for PL/SQL table handling.

Usage Notes

PAY_CA_RL2_MAG is invoked by the Canadian RL-2 submission and XML generation concurrent programs rather than directly from a form. The report is submitted through the standard concurrent manager, and the package reads the resulting payroll action identifier to reconstruct the reporting context. It is also referenced by two other packages in the ETRM repository, indicating it is consumed as a subordinate component of the broader Canadian RL-2 processing flow.