Search Results pay_ca_rl2_reg




Overview
Explore in AI Chat

Overview

PAY_CA_RL2_REG is a Canadian (CA) legislative payroll report-generation package that belongs to the Oracle Payroll family of "RL" range-cursor packages (the RL2 designation refers to a specific Canadian statutory report layout). Its role is to implement the generic range-cursor contract used by Oracle Payroll's assignment-action architecture to produce report output for a defined population of assignments. The package defines a database package with AUTHID CURRENT_USER, meaning that its SQL executes under the privileges of the invoking session rather than the package owner, which is standard for report registry packages that must resolve APPS public synonyms at runtime.

The header change list indicates the package was created on 08-OCT-2002 and subsequently extended: version 115.1 added the get_label function, and version 115.2 (22-Jan-2004) added the get_primary_address function together with the PrimaryAddress record type. This history explains why get_primary_address appears in your search against PAY_CA_RL2_REG: it is the dedicated accessor added specifically to return formatted primary address data for the report output.

Key Procedures and Functions

  • RANGE_CURSOR — the core range-cursor entry point. It accepts a payroll action identifier and returns, via an OUT parameter, the SQL cursor text that defines the population of assignments to be processed. This is the contract every RL-style report package must satisfy so the payroll action framework can iterate the selection.
  • ACTION_CREATION — creates the assignment actions for the range. It receives the payroll action ID together with person range boundaries (start person, end person) and a chunk indicator, allowing large populations to be split into parallel or chunked runs.
  • SORT_ACTION — accepts a payroll action ID and a SQL string (IN OUT), and returns a length, allowing the framework to re-order or sort the generated action output.
  • GET_PARAMETER — retrieves a named parameter value from a supplied parameter list string; declared with PRAGMA RESTRICT_REFERENCES(..., WNDS, WNPS), making it callable from SQL (a pure function with no writes to database state or package state).
  • GET_LABEL — returns the descriptive label for a given lookup type and lookup code combination, used to render human-readable text on the statutory report.
  • GET_PRIMARY_ADDRESS — returns the primary address for the subject of the report. The header comments document its formatting convention: address lines 1, 2 and 3 are normal address lines, and address line 4 is reserved for the city plus additional components. It is paired with the PrimaryAddress record type added in the same release.

Tables Accessed

Usage Notes

PAY_CA_RL2_REG is not intended for direct invocation from application forms. It is registered with the Oracle Payroll action/range-cursor framework and is invoked by the concurrent program that executes the associated Canadian statutory report, with the payroll action ID supplied by that framework. The package is referenced by one other package in the APPS schema, which is consistent with its role as a helper or subordinate registry entry.

From a customization standpoint, get_parameter is callable from SQL statements because of its RESTRICT_REFERENCES pragma, which makes it useful in custom report queries needing parameter resolution. get_label and get_primary_address can be called from custom PL/SQL to reproduce the same lookup labelling and address formatting used by the seeded report, ensuring custom extracts remain consistent with the delivered output.