Results for “iby_ext_wrap_pub”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

IBY_EXT_WRAP_PUB is a public PL/SQL package in the APPS schema that belongs to the Oracle Payments (IBY) module of Oracle E-Business Suite. Its role is to generate extensible aggregation data — the XML payloads that carry payment, invoice, document, and remittance information between Oracle Payments and external systems, or between Payments and the Oracle XML Publisher (BI Publisher) reporting layer. The name reflects its function: EXT_WRAP denotes "external wrapper," and the package wraps the structured payment/document data into a form that downstream XML definitions can consume.

The package is classified as a public (PUB) API, meaning it is intended to be callable from outside the Payments application. It has a declared status of VALID in the ETRM metadata, indicating it compiled cleanly in the documented 12.2.2 environment. Its dependencies are limited: it references PUBLIC.XMLTYPE, SYS.STANDARD, and the XMLTYPE datatype, which confirms that its principal output is XML content rather than relational row sets. No dependency on application tables or other custom packages is recorded, which underscores its narrow, utility-oriented purpose.

Key Procedures and Functions

Five public procedures/functions are documented. Each follows a consistent naming convention — GET_<ENTITY>_EXT_AGG, where "AGG" indicates aggregation of external data into a consolidated XML result.

• GET_INS_EXT_AGG — Produces the external aggregation payload for installment (INS) records associated with a payment. Installments represent the scheduled components that make up a payment transaction.
• GET_PMT_EXT_AGG — Produces the external aggregation payload for payment (PMT) header records. This is the top-level aggregation invoked when a complete payment document must be rendered or transmitted.
• GET_DOC_EXT_AGG — Produces the external aggregation payload for document (DOC) records, covering the payment document as a whole.
• GET_DOCLINE_EXT_AGG — Produces the external aggregation payload for document line (DOCLINE) records, the individual lines or distribution details within a payment document.
• GET_PPR_EXT_AGG — Produces the external aggregation payload for payment process request (PPR) records, the batch-level grouping used by the Payments Process Request framework.

Parameter signatures are not disclosed in the ETRM metadata and should be confirmed against the deployed package specification before invoking these routines directly.

Tables Accessed

The only documented object referenced by IBY_EXT_WRAP_PUB is the XMLTYPE datatype, accessed through APPS synonyms. The package does not directly read or write Payments base tables such as IBY_PAYMENTS_ALL, IBY_DOCS_PAYABLE_ALL, or IBY_PAYMENT_PROCESS_REQUEST. Instead, the calling programs assemble the required data and pass it into these aggregation routines, which return XMLTYPE instances. This design keeps the wrapper package stateless and free of direct SQL against transactional tables, which simplifies dependency management and reduces the risk of invalidations when underlying tables change.

Usage Notes

IBY_EXT_WRAP_PUB is referenced by four database views documented in the ETRM metadata: IBY_XML_FD_DOC_1_0_V, IBY_XML_FD_INS_1_0_V, IBY_XML_FD_PMT_1_0_V, and IBY_XML_FD_PPR_1_0_V. These views expose the package's XML output for the Payments "FD" (format definition) XML templates used by Oracle XML Publisher. This is the principal invocation path: a concurrent program or XML Publisher data definition selects from one of these views, and the view calls the corresponding GET_*_EXT_AGG routine to build the XML at query time.

The package is also referenced by itself (IBY_EXT_WRAP_PUB), indicating internal recursion or helper consolidation within the package body. Direct invocation from custom code is possible because the package is public, but should be reserved for scenarios where the standard Payments XML views do not expose the required aggregation — for example, custom payment formats or bespoke remittance advice documents. When extending or overriding standard output, adhere to the XML schema expected by the consuming publisher template to avoid breaking downstream formatting or transmission.