Search Results pay_ca_mag_roe




Overview
Explore in AI Chat

Overview

PAY_CA_MAG_ROE is an Oracle E-Business Suite payroll package owned by the APPS schema, classified in the ETRM repository as an "OTHER" API rather than a public or private PL/SQL API. It supports the Canadian Payroll magnetic media (MAG) processing flow, specifically the generation of Record of Employment (ROE) data. The package header carries the RCS identifier pycaremg.pkh 115.2, dated 2004, confirming it is part of the long-standing Canadian payroll (PYCA) module and shipped as a header-only specification with an accompanying body implementation.

The package declares AUTHID CURRENT_USER, meaning its SQL executes with the privileges of the invoking user rather than the definer, a common pattern for internal payroll utilities that query and update APPS-owned tables through synonyms. It exposes two documented entry points, RANGE_CURSOR and CREATE_ASSIGNMENT_ACT, and is therefore intended to be driven by the Oracle payroll action framework rather than called directly by end users. The declared cursor cur_mag_roe and the char240_data_type_table collection type indicate it serves as a supporting utility within the broader magnetic media driver chain.

Key Procedures and Functions

Two procedures are documented for this package:

  • RANGE_CURSOR — Produces the SQL text used to select the population of assignment actions to be processed for a given payroll action. It follows the standard Oracle Payroll range-cursor contract, where a calling program supplies the payroll action identifier and receives a SQL string that drives the processing chunking mechanism. No public parameter list is documented beyond the ETRM metadata, and the specification should be consulted before invoking it from custom code.
  • CREATE_ASSIGNMENT_ACT — Creates the assignment action records required for the ROE magnetic media run. Its declaration sits adjacent to the ROE cursor, which selects ASSIGNMENT_ACTION_ID values from the action interlock tables. This procedure is the substantive processing entry point of the package and is the object referenced by the search term create_assignment_act.

Tables Accessed

The documented table references reflect the payroll action and interlock model that underpins range-based processing:

Usage Notes

PAY_CA_MAG_ROE is not intended for direct invocation from PL/SQL application code. It is invoked by the Canadian Payroll magnetic media concurrent programs, which call RANGE_CURSOR to obtain the driving SQL and then call CREATE_ASSIGNMENT_ACT within the multi-threaded action-processing framework as each chunk is processed. The ETRM metadata records zero referencing packages, indicating it is a leaf-level utility called from the payroll processing engine or from concurrent program registration rather than from other APIs. Because AUTHID CURRENT_USER is specified and the procedures are not declared as a formal public API, any custom extension should treat the package as internal, verify the signature against the installed version, and avoid assuming parameter stability across patch levels. The package name prefix PAY_CA scopes it strictly to Canadian payroll legislation-driven processing.