Search Results fetch_rtf_blob

Overview

PAY_US_XDO_REPORT is an Oracle E-Business Suite PL/SQL package owned by the APPS schema that prepares the XML data and supporting template structures required by the Oracle Payroll United States GTN (Gross-to-Net) report. The package header carries the source identifier payusxml.pkh and is declared AUTHID CURRENT_USER, meaning its database objects are resolved using the privileges of the invoking user rather than the package owner. First created in December 2004 by sgajula (version 115.0), the package was subsequently revised in April 2006 (version 115.1, bug 5148084) to remove a procedure named FETCH_RTF_BLOB. Within the ETRM classification framework the package is categorized as OTHER rather than as a formal public API, reflecting its role as an internal reporting utility rather than a general-purpose integration interface.

The central task of the package is the transformation of payroll report content between large object datatypes — assembling the report payload, writing it into a CLOB, and converting that CLOB into the binary BLOB representation that Oracle XML Publisher (XDO) requires when merging XML data with a report template. Because the search that surfaced this object was clob_to_blob, the conversion routine described below is the element most directly relevant to callers investigating character-to-binary LOB handling in this package.

Key Procedures and Functions

The documented interface exposes three procedures, all reflected in the package header. No parameter signatures are reproduced here beyond those visible in the supplied source.

• POPULATE_GTN_REPORT_DATA — Described in the header as the main procedure which returns the generated XML. It is the entry point for the GTN report data generation, accepting a payroll action finder identifier and returning the report content in a BLOB output parameter.
• WRITE_TO_CLOB — Documented as the procedure that places data into a CLOB. It provides the character-mode staging of report content prior to conversion, taking the BLOB as an output parameter.
• CLOB_TO_BLOB — Documented as the procedure that converts a CLOB value to a BLOB value. This is the routine associated with the clob_to_blob search term and implements character-to-binary LOB conversion for the generated report, using an input CLOB and an IN OUT NOCOPY BLOB destination.

The header also declares the record type XMLREC, holding a single xmlstring VARCHAR2 element, and the collection type tXMLTable as a table of XMLREC indexed by BINARY_INTEGER. These types support the internal assembly of XML fragments before the final LOB conversion.

Tables Accessed

The documented table references, resolved through APPS synonyms, include:

• PAY_CONSOLIDATION_SETS — Supplies consolidation set definition data used to scope and organize the payroll report content.
• PAY_PAYROLL_ACTIONS — Provides the payroll action context that identifies the run the GTN report describes, consistent with the payroll action finder parameter of the main procedure.
• PAY_US_RPT_TOTALS — Holds the United States payroll report totals that constitute the substantive gross-to-net figures presented in the report.
• DBMS_LOB, PLITBLM, and UTL_RAW — Oracle-supplied packages used for LOB manipulation, PL/SQL table handling, and raw datatype processing, which together underpin the CLOB-to-BLOB conversion path.

Usage Notes

PAY_US_XDO_REPORT is invoked in the context of XML Publisher-based payroll reporting rather than as a standalone concurrent program. Typical invocation is from another PL/SQL package or from report generation code that needs the GTN report payload shaped as an XML data source. The metadata records that the package is referenced by one other PL/SQL package, indicating a single upstream consumer within the application. The absence of a formal public API classification, combined with the dated header comment and the removal of FETCH_RTF_BLOB in the 115.1 revision, means the package should be treated as an internal implementation artifact. Custom code requiring the same functionality should call the documented procedures rather than any undocumented or subsequently removed routine, and should account for the NOCOPY parameter semantics in the BLOB output path.