Search Results pay_paygbpay_xmlp_pkg




Overview
Explore in AI Chat

Overview

PAY_PAYGBPAY_XMLP_PKG is a PL/SQL package owned by the APPS schema in Oracle E-Business Suite, classified under the API classification OTHER. It is the generated database-side companion package for the Oracle Payroll UK "PAYGBPAY" XML Publisher (BI Publisher) report — a statutory payment report used by Oracle Payroll for United Kingdom legislation. In the Oracle EBS Report Publishing architecture, every XMLP-based concurrent report has a corresponding PL/SQL package that acts as the data model: it declares the report parameters, supplies group-level and report-level formulas, computes running totals, and defines the SQL query that produces the XML data source consumed by the RTF template. The package is marked VALID in both 12.1.1 and 12.2.2 and the metadata confirms the presence of a package specification, a package body, and embedded SQL statements.

Key Procedures and Functions

The 12.2.2 documented metadata lists twelve functions and procedures:

  • BEFORE_REPORT_TRIGGER — the standard XML Publisher report trigger executed once before the report data set is generated, typically used to initialise session state and report-level variables.
  • AFTERREPORT — the corresponding end-of-report trigger, used to release resources and finalise report-level accumulators after the rows have been processed.
  • CF_CALCULATE_RUNNING_TOTALFORM — a column formula that calculates the running total of amounts across the report as rows are emitted.
  • CF_RUNNING_TOTAL_NUMBER_PAIDFO — a column formula that maintains the running count of payment entries processed.
  • CP_RUNNING_TOTAL_NUMBER_PAID_P — the data-model parameter returning the accumulated number of paid items for display in the template.
  • CP_RUNNING_TOTAL_AMOUNT_PAID_P — the data-model parameter returning the accumulated paid amount.
  • CP_BUSINESS_GROUP_NAME_P — exposes the business group name associated with the payroll run being reported.
  • CP_PAYROLL_NAME_P — exposes the payroll name for the selected payroll.
  • CP_CONSOLIDATION_SET_NAME_P — returns the name of the payroll consolidation set used as a report selection criterion.
  • CP_CONSOLIDATION_SET_LINE_P — returns the consolidation set line detail, allowing the report to present the constituent payrolls within a set.
  • CP_EARLIEST_PAYMENT_P — returns the earliest payment date identified within the report data set.
  • CP_LATEST_PAYMENT_P — returns the latest payment date identified within the report data set.

Tables Accessed

The documented dependency list shows a single table referenced via an APPS synonym: PAY_CONSOLIDATION_SETS. This table stores payroll consolidation set definitions, which group multiple payrolls so that they can be processed and paid together. The package reads it to resolve the consolidation set name and consolidation set line used both as report parameters and as selection criteria for the underlying payroll payment query. The dependency listing also shows references to SYS.STANDARD, indicating the package body uses standard PL/SQL built-in functions; the report query itself relies on the standard Oracle Payroll payment and assignment views reached through the same synonym layer.

Usage Notes

This package is not a public application programming interface and should not be called directly from custom code. It is generated and maintained automatically by Oracle Payroll, and Oracle's guidance is that it be regenerated rather than patched. The documented metadata records zero referencing packages, confirming that it is a leaf module invoked only by the XML Publisher framework itself.

Typical invocation occurs when the PAYGBPAY concurrent program is submitted: the concurrent manager calls the package as the report's data model, which runs BEFORE_REPORT_TRIGGER, executes the query against the payroll tables (filtered by the consolidation set values resolved through CP_CONSOLIDATION_SET_NAME_P and related parameters), evaluates the CF_ running-total column formulas row by row, and finishes with AFTERREPORT. The resulting XML is passed to the RTF template, which renders the UK payment report including the earliest and latest payment dates and the total number and amount paid. Because parameter values are exposed as CP_ functions, the template can reference them directly by their XML tag names. Any customisation should be performed by copying the report definition into a custom XML Publisher data template, leaving the seeded APPS package untouched.