Search Results pay_xml_gen_pkg

Overview

PAY_XML_GEN_PKG is an Oracle Payroll package in the APPS schema that generates XML data output for report mapping purposes. Its role within the Oracle E-Business Suite is to act as a bridge between the Payroll application and Oracle XML Publisher (BI Publisher), producing XML payloads that correspond to report data models. The package header carries a header comment dated 2007 and identifies the file as pyxmlgen.pkh, indicating it is part of the payroll XML generation infrastructure shipped with EBS. Its API classification is listed as OTHER, meaning it is not part of the standard public payroll APIs but is used internally by the XML Publisher integration layer.

Key Procedures and Functions

The package exposes a single documented procedure, EXEC_REPORT_MAP_FUNCTION, which is overloaded twice. Both overloads accept the same three input parameters — a function name, a parameter string, and a temporary file name — and differ only in the type of the output parameter p_xml_data: one returns a CLOB, the other returns a BLOB. No parameter descriptions are documented beyond the signature, so the precise semantics of each argument are inferred from their names.

• EXEC_REPORT_MAP_FUNCTION (CLOB overload) — Invokes the report mapping function identified by p_func_name, passing p_parameters, and returns the resulting XML document as a character large object. The p_tempfile_name argument likely identifies a temporary file used during generation, particularly for large payloads that exceed PL/SQL memory limits.
• EXEC_REPORT_MAP_FUNCTION (BLOB overload) — Provides the same behavior but returns the XML data as a binary large object, which is necessary when the report output contains binary content or character sets requiring byte-level handling.

No other procedures or functions are declared in the documented package specification.

Tables Accessed

The package references two objects through APPS synonyms:

• FND_LOOKUP_VALUES — Read to resolve lookup codes used during report mapping, such as configuration values, language settings, or XML generation options.
• DBMS_LOB — The Oracle-supplied LOB package, used to manipulate the CLOB and BLOB output parameters. References here indicate the package writes to or reads from LOB locators rather than performing simple scalar assignments.

No payroll business tables are documented as accessed by this package.

Usage Notes

PAY_XML_GEN_PKG is not exposed through a standard Payroll form or concurrent program in the documented metadata; it is invoked programmatically. Typical invocation occurs within the XML Publisher report generation flow, where a report's data model calls the package to execute a mapping function and retrieve the XML payload. The dual CLOB/BLOB overloads allow callers to select the return type appropriate to the report definition. Because the package is classified as OTHER and is referenced by zero other packages per the ETRM metadata, it should be treated as an internal helper rather than a supported extension point; customizations should avoid direct dependency and instead target the supported XML Publisher data model interfaces. The signature is stable across EBS 12.1.1 and 12.2.2, and no behavioral differences between those releases are documented.