Search Results pay_payrg_pkg




Overview
Explore in AI Chat

Overview

PAY_PAYRG_PKG is an Oracle E-Business Suite Payroll package owned by the APPS schema and validated as VALID in release 12.1.1 and 12.2.2. Its name follows the customary PAY_ prefix used for Payroll objects, and the "_PAYRG" suffix identifies it as the processing engine behind the Payroll Register, the statutory and management report that presents payroll run results by organization, location, assignment and action. In EBS the Payroll Register is delivered as a concurrent program, and PAY_PAYRG_PKG supplies the procedural logic that select the population of assignment actions to report, orders the output, and derives the run-time parameters that drive the report layout. The package therefore sits between the Payroll run model (PAY_PAYROLL_ACTIONS, PAY_ASSIGNMENT_ACTIONS) and the reporting layer, providing the sort, range and parameter services required to generate the register for a given payroll action. Its classification in the ETRM repository is OTHER, meaning it is an internal application package rather than a public, supported business API; nevertheless it is a permanent and referenced component of the Payroll product, invoked indirectly through the standard Payroll Register concurrent request and, in some extensions, through custom reporting code that reproduces the register logic.

Key Procedures and Functions

Five procedures and functions are documented for this package. Their names indicate the following responsibilities:

  • RANGE_CURSOR — constructs and positions the driving cursor that enumerates the assignments and assignment actions eligible for the Payroll Register, applying the payroll action, consolidation set and range criteria supplied to the report.
  • ACTION_CREATION — supports creation of the action rows or action context used by the register; in the Payroll action model this relates to the PAY_ASSIGNMENT_ACTIONS and PAY_PAYROLL_ACTIONS records that define what a payroll run produced.
  • SORT_ACTION — applies the ordering rules for the assignment actions returned by the range cursor, so that register output is sequenced consistently for presentation and reconciliation.
  • GET_PARAMETER — retrieves a report or run parameter value, providing the report logic with the payroll, action, date and organizational selections entered by the user or passed by the concurrent manager.
  • SORT_OPTION — resolves the sort option chosen for the register, determining which of the available ordering schemes is applied to the output.

Parameter lists are not published in the source metadata and should not be assumed; callers should treat these as internal entry points rather than a documented API.

Tables Accessed

The package reads and writes a defined set of Payroll and HR tables through APPS synonyms. Payroll run data comes from PAY_PAYROLL_ACTIONS and PAY_ASSIGNMENT_ACTIONS (with its _S sequence table), which hold the action headers and assignment-level results that the register reports. PAY_ACTION_INTERLOCKS supplies the posting and transfer status used to determine which actions are reportable. Assignment and person detail is drawn from PER_ALL_ASSIGNMENTS_F, HR_ASSIGNMENT_SET_AMENDMENTS, HR_ALL_ORGANIZATION_UNITS and HR_LOCATIONS_ALL, giving the organizational and location breakdowns that make the register meaningful to payroll administrators. PAY_RUN_TYPES_F identifies the run type being reported, PAY_PRE_PAYMENTS supports pre-payment information, PAY_US_RPT_TOTALS provides the US reporting totals used on statutory payroll reports, and DUAL is used for single-row control queries. The companion package PAY_CA_PAYRG_PKG indicates a Canadian localization counterpart, while PAY_PAYACT_PKG is a direct caller, consistent with the register being driven from the payroll action enquiry and processing flows.

Usage Notes

PAY_PAYRG_PKG is normally invoked indirectly. Users submit the Payroll Register concurrent program, and the concurrent manager calls the package to build the report data set; the same logic is reached from the Payroll action enquiry forms where register output is requested. Because the package is referenced by PAY_PAYACT_PKG and PAY_CA_PAYRG_PKG, it forms part of a small internal dependency cluster that should be considered when applying payroll patches or tracing register behaviour. Custom code should not call the individual procedures directly, as no public interface is documented and signatures may change between 12.1.1 and 12.2.2 and in later patch levels. Where custom reporting is required, the supported approach is to query the underlying PAY_ and HR_ tables directly or use published Payroll APIs, and to treat PAY_PAYRG_PKG purely as the engine behind the seeded Payroll Register program.