Search Results pay_payusear_xmlp_pkg

Overview

APPS.PAY_PAYUSEAR_XMLP_PKG is a generated PL/SQL package body that backs the Oracle EBS Payroll "Pay US Earnings" (or comparable US statutory) XML Publisher report. In Oracle E-Business Suite 12.1.1 and 12.2.2, XML Publisher concurrent programs are typically defined with a PL/SQL package that acts as the report's logic layer; the "PAY" prefix identifies the module as Oracle Payroll, while the "_XMLP_PKG" suffix denotes the auto-generated Oracle Reports-to-XML Publisher bridge package produced during report conversion. The package resides in the APPS schema and is documented as VALID in the ETRM repository.

The business purpose is to gather payroll and statutory tax-unit data and supply the XML Publisher template with a structured dataset, principally for US payroll (the "US" component of the name). It produces the data source (XML) from which the report's RTF template renders the final output.

Key Procedures and Functions

ETRM documents fifteen procedures/functions within the package, each following the standard XML Publisher generated pattern:

• BEFOREREPORT — The entry point invoked before data extraction begins; establishes context and initializes any session-level parameters.
• AFTERREPORT — Executed after the report data is processed, typically for cleanup or finalization.
• G_TAX_UNIT_HEADERGROUPFILTER — A group filter function that controls conditional include/exclude logic on the tax-unit header group.
• TAX_UNIT_ADDRESSFORMULA — A formula column that derives or formats the tax unit address for output.
• C_VALUEFORMULA — A generic computed column formula returning a C-level value.
• C_TAX_UNIT_ADDRESS2_P — A parameter/summary placeholder for the secondary tax-unit address line.
• C_BUSINESS_GROUP_NAME_P — Supplies the business group name for the report header.
• C_CONSOLIDATION_SET_NAME_P — Provides the consolidation set name used in the payroll run selection.
• C_TIME_PERIOD_NAME_P — Supplies the payroll time period name.
• C_PAYROLL_NAME_P — Provides the payroll name.
• C_PAYROLL_ACTION_P — Supplies the payroll action (the run/action identifier).
• C_TAX_UNIT_P — Provides the tax unit identifier.
• C_PERIOD_START_DATE_P — Supplies the period start date boundary.
• C_PERIOD_END_DATE_P — Supplies the period end date boundary.
• C_ELEMENT_TYPE_NAME_P — Provides the payroll element type name (e.g., earnings element).

Tables Accessed

ETRM metadata lists no directly referenced base tables via APPS synonyms for this package. Its documented dependencies are instead on other PL/SQL objects: HR_CHKFMT, HR_REPORTS, HR_US_REPORTS, and the package specification PAY_PAYUSEAR_XMLP_PKG itself, plus SYS.STANDARD. This pattern indicates the package delegates the heavy data retrieval to the Oracle HR/Payroll report helper packages (HR_REPORTS and its US-specific extension HR_US_REPORTS) rather than issuing raw SQL against payroll tables. Consequently, the underlying reads target payroll and tax-unit data through those helper APIs.

Usage Notes

This package is not referenced by any other database object (documented as referenced by zero packages), confirming it is an application entry point rather than a reusable library. It is invoked exclusively by its associated Oracle Payroll XML Publisher concurrent program. Typical invocation is: a user submits the "Pay US Earnings" report from the Payroll responsibility, selecting parameters such as payroll name, consolidation set, tax unit, and period dates. The concurrent manager calls BEFOREREPORT, streams the data rows through the group filters and formula columns, then calls AFTERREPORT. Customization is normally achieved by modifying the RTF template, not the generated package body; direct edits are overwritten on regeneration and are therefore not supported.