Search Results pay_kw_payroll_register




Overview
Explore in AI Chat

Overview

PAY_KW_PAYROLL_REGISTER is an Oracle E-Business Suite payroll reporting package owned by the APPS schema and classified as an OTHER API in the ETRM repository. Its primary business function is to extract payroll register information for a given payroll, organization, and time period, and to render that data into a structured output suitable for downstream reporting formats such as XML, XFDF (XML Forms Data Format), and PDF. In effect, it acts as the data-gathering and document-generation engine behind the seeded Oracle Payroll "Payroll Register" report, assembling payment and payroll action details into a blob that a reporting or publishing layer can consume.

The package header carries a version marker from the 12.1 development line (pykwpyrg.pkh 120.0.12010000.1), and the same specification is documented against 12.2.2. It is declared AUTHID CURRENT_USER, meaning it executes with the privileges of the calling user and relies on APPS synonyms for cross-schema access.

Key Procedures and Functions

  • GET_PAYROLL_REGISTER_DATA — The central entry point. It accepts a report identifier, organization and organization structure version identifiers, a payroll identifier, an effective date, and up to three sort order parameters, returning the generated output through an XFDF blob out parameter. It drives assembly of the payroll register payload.
  • FETCH_PDF_BLOB — Retrieves a previously stored PDF blob for a named report, allowing callers to obtain the rendered document rather than the intermediate structured data.
  • WRITETOXML and WRITEXMLVALUES — Documented helper routines (shown commented in the source header) for serializing the internal XML record table to file and for writing individual tag/value pairs. These support the XML intermediate representation used by the report.
  • WRITETOCLOB — Produces the report content as a CLOB and converts it to the output blob, integrating with the XML/XFDF pipeline.
  • CLOB_TO_BLOB — Utility conversion routine translating CLOB content into a BLOB with appropriate raw handling, necessary when moving character report data into binary document containers.
  • GET_LOOKUP_MEANING — A lookup resolution function returning the meaning associated with a given lookup type and lookup code, used to translate coded payroll values into display text.

No parameter lists are asserted beyond those present in the documented metadata.

Tables Accessed

The package reads from a range of Oracle HRMS and Payroll tables through APPS synonyms. Payroll and action data come from PAY_ALL_PAYROLLS_F, PAY_PAYROLL_ACTIONS, PAY_ASSIGNMENT_ACTIONS, PAY_ACTION_INFORMATION, and PAY_ACTION_INTERLOCKS. Payment detail draws on PAY_PRE_PAYMENTS. Organizational context is supplied by HR_ALL_ORGANIZATION_UNITS, HR_ORGANIZATION_INFORMATION, and PER_ORG_STRUCTURE_ELEMENTS, while PER_TIME_PERIODS supplies effective period data. FND_LOBS stores and retrieves generated report blobs. Utility access relies on DBMS_LOB, UTL_RAW, DUAL, and PLITBLM.

Usage Notes

PAY_KW_PAYROLL_REGISTER is not intended for direct application code. It is invoked by the seeded Payroll Register concurrent program and related reporting infrastructure, which call GET_PAYROLL_REGISTER_DATA to populate the XFDF blob and FETCH_PDF_BLOB to retrieve the published PDF. The ETRM metadata records zero packages referencing it, confirming its role as a terminal reporting utility rather than a shared API. Customizations should restrict themselves to calling the documented entry points in a read-only fashion, as the package performs no business-data maintenance and is designed solely to produce payroll register output for a specified payroll and effective date.