Search Results get_ins_ext_agg

Overview

IBY_FD_EXTRACT_EXT_PUB is a public PL/SQL package owned by the APPS schema in Oracle E-Business Suite Releases 12.1.1 and 12.2.2. Its purpose is to provide an extension mechanism for the Funds Disbursement (payment) extract process managed by the Payments module. Standard payment extract formats generated by Oracle Payments contain a fixed set of elements at the payment instruction, payment, document payable, and document payable line levels. When an organization requires additional data elements beyond this standard content, it implements the functions exposed by IBY_FD_EXTRACT_EXT_PUB to supply those elements as XML fragments, which the extract engine then merges into the outbound payment file.

The package is declared AUTHID CURRENT_USER, so its functions execute with the privileges of the invoking user, and it defines a debug module constant (G_DEBUG_MODULE) for logging. Because the package is classified as PUB (public), its signature constitutes a supported extension interface; customers and partners are expected to create their own implementing package bodies or wrapper code rather than modify Oracle-owned objects. The source header indicates a base version of 120.2, and the package is referenced by two other packages within the Payments schema, confirming its role as a callback point during extract generation.

Key Procedures and Functions

The package documents six functions, one of which (GET_PPR_EXT_AGG) is present in the metadata but absent from the supplied source excerpt. Each function returns an XMLTYPE aggregate containing the extension elements for its respective level of the payment extract.

• GET_INS_EXT_AGG – Invoked once per payment instruction. The implementor constructs extension elements at the payment instruction level as a SQLX XML aggregate and returns that aggregate. The documentation includes a sample implementation that concatenates name/value pairs from a customer table keyed by payment instruction identifier.
• GET_PMT_EXT_AGG – Invoked once per payment. The implementor constructs and returns the payment-level extension XML aggregate.
• GET_DOC_EXT_AGG – Invoked once per document payable. The implementor constructs and returns the document-level extension XML aggregate.
• GET_DOCLINE_EXT_AGG – Invoked once per document payable line. The implementor constructs and returns the line-level extension XML aggregate.
• GET_PPR_EXT_AGG – Documented in ETRM metadata as an additional extract extension function, corresponding to a further extract level supported by the Payments extract framework.

Parameter lists are deliberately excluded from this summary; callers should treat the published interface as defined by Oracle and never assume or invent additional parameters beyond those Oracle documents.

Tables Accessed

The only documented table reference associated with this package is XMLTYPE, which is an Oracle-supplied object type rather than an application table. This reflects the package's design: IBY_FD_EXTRACT_EXT_PUB does not itself query or write business data. Instead, each function returns an XMLTYPE value that the extract engine consumes. The sample implementation in the source comments illustrates the intended pattern—a cursor selects from a customer-defined extension table keyed by the appropriate identifier (for example, payment instruction identifier) and wraps the columns in XMLConcat and XMLElement calls. All actual business data access therefore occurs in customer code that implements the extension functions, not in the Oracle-owned package body.

Usage Notes

IBY_FD_EXTRACT_EXT_PUB is invoked automatically by the Oracle Payments extract process, not directly by end users. During generation of a payment instruction extract, the engine calls each extension function at the corresponding point in processing—once per payment instruction, once per payment, and so on—and inserts the returned XML aggregate into the output document according to the extract format definition. Typical implementation work involves creating a custom package that mirrors these function signatures, querying custom extension tables populated by the organization, and registering that package so the Payments extract uses it. Because the package is public and referenced by other Payments packages, changes should only be made through Oracle-supported extension patterns. Developers debugging extract output should confirm that extension functions return well-formed XML and that the element names match those expected by the extract format's mapping configuration; malformed aggregates can cause the entire extract run to fail. The initialization of logging via G_DEBUG_MODULE assists in tracing extension calls within the iby.plsql debug framework.