Search Results get_xmldoc_clob

Overview

PAY_PAYROLL_EXTRACT is an Oracle E-Business Suite PL/SQL package owned by the APPS schema. In Oracle EBS 12.1.1 and 12.2.2 it forms part of the Oracle Payroll extraction infrastructure, providing the technical mechanism by which payroll run results are serialised into an XML document representation. The package name reflects its role as the extraction layer that converts structured payroll data held in the Oracle Payroll schema into a portable, self-describing XML format suitable for downstream consumption — for example, transmission to third-party payroll providers, statutory reporting bodies, bank payment processors, or archival repositories.

The object is documented in ETRM as VALID and is classified as an OTHER API, indicating that it is not part of the supported public interfaces published by Oracle, but rather an internal technical component. Its dependencies are limited to the SYS-owned STANDARD package, and it is not referenced by any other package, which confirms its role as a terminal component invoked directly by concurrently executing code rather than being called programmatically by peer packages.

Key Procedures and Functions

ETRM documents a single entry point for this package:

• GET_XMLDOC_CLOB — Returns the generated XML document as a Character Large Object. This function is the sole documented interface of the package. Its purpose is to construct and hand back the complete XML representation of the payroll extract in CLOB form, allowing the calling process to persist, stream, or transmit the document. Because ETRM does not publish a parameter list for this procedure, no signature is asserted here; consumers should treat the function as returning a CLOB value and should not assume a specific argument sequence without inspecting the deployed package source in the target environment.

The absence of additional documented procedures indicates that the package is narrowly scoped. Any internal helper routines are not exposed through the ETRM registry and should be regarded as private implementation details subject to change between patch levels.

Tables Accessed

ETRM records that PAY_PAYROLL_EXTRACT references the following objects through APPS synonyms:

• DBMS_LOB — The Oracle-supplied large object manipulation package. It is used to allocate, populate, and manage the CLOB that carries the XML output, consistent with the GET_XMLDOC_CLOB return type.
• DBMS_XMLGEN — The Oracle-supplied XML generation package, which converts the results of a SQL query into a canonical XML document. This is the engine that produces the structure of the payroll extract.

The package therefore relies on dynamic query text assembled at runtime and rendered by DBMS_XMLGEN, rather than performing direct DML against payroll base tables. No payroll application tables appear in the documented dependency list, which is characteristic of an extraction utility that delegates data selection to an internally constructed query.

Usage Notes

PAY_PAYROLL_EXTRACT is typically invoked from Oracle Payroll concurrent programs and from internal payroll processing logic rather than from Oracle Forms or from customer-written code. Because it is classified as OTHER and is not referenced by any other package, it should be treated as a private technical component of the payroll extraction stack.

Typical invocation patterns include being called by a concurrent program that writes the resulting CLOB to a file or temporary table, or by internal PL/SQL that consumes the XML directly for further transformation. Customers performing upgrades from 12.1.1 to 12.2.2 should note that internal utilities of this kind may be modified, replaced, or retitled by Oracle patches without notice, and no custom code should be built to depend on the package signature. Where a supported extraction interface is required, the documented Oracle Payroll APIs and seeded concurrent programs should be used in preference to direct calls against this package.