Search Results begin_wrapper




Overview

ITG_BOAPI_WRAPPERS is a PL/SQL package body owned by the APPS schema in Oracle E-Business Suite 12.1.1 and 12.2.2. It belongs to the ITG (Integrated Transaction Gateway) module and is classified as an "OTHER" API within the ETRM repository. The package serves as a wrapper layer that normalizes and encapsulates calls to underlying BOAPI (Business Object API) processing routines used by the supplier-facing and transaction-collaboration integration flows.

A distinguishing feature of this package is its handling of the global state variable g_return_status, which is declared as VARCHAR2(1). This variable mirrors the standard EBS API return-status conventions defined in FND_API (G_RET_STS_SUCCESS, G_RET_STS_ERROR, and G_RET_STS_UNEXP_ERROR). Two helper routines — describe_return_status and check_return_status — exist specifically to translate and validate this value. describe_return_status converts a single-character status code into a human-readable string ("Success", "Error", or "Un-expected error"), while check_return_status coerces any unrecognized value into FND_API.G_RET_STS_UNEXP_ERROR and assigns the result to g_return_status. This makes g_return_status the central status indicator propagated across all wrapper entry points.

Key Procedures and Functions

The package exposes twelve documented procedures. Their names indicate the business-data domains they cover:

  • BEGIN_WRAPPER — Initializes a wrapper session; sets the global return status to success, stores document, client, and organization context, and configures the FND message-level profile. It accepts reference id, organization, XML gateway type/subtype, document id, document type, client type, document, release, and creation date as inputs.
  • END_WRAPPER — Terminates the wrapper session, closing out the transaction context established by BEGIN_WRAPPER.
  • REAP_MESSAGES — Cleans up or reclaims processed inbound/outbound messages associated with the integration.
  • SYNC_FLEXVALUE — Synchronizes descriptive flexfield values, typically for supplier or item records.
  • PROCESS_EXCHANGERATE — Handles currency exchange-rate processing within the collaboration flow.
  • UPDATE_POLINE — Updates purchase-order line data received through the integration channel.
  • SYNC_VENDOR, SYNC_VENDORSITE, SYNC_VENDORCONTACT — Synchronize supplier, supplier site, and supplier contact records respectively.
  • SYNC_ITEM — Synchronizes item master data.
  • PROCESS_PONUMBER — Processes purchase-order number information.
  • SYNC_UOM_ALL — Synchronizes units-of-measure definitions.

Tables Accessed

The ETRM metadata for this package does not enumerate underlying base tables, and it records no direct table references through APPS synonyms. Based on the documented procedure names, the package logically operates against supplier, supplier site, supplier contact, item, unit-of-measure, purchase-order, and exchange-rate entities. These are accessed indirectly through the ITG_SyncSupplierInbound_PVT package (referenced in the source via vinfo_rec_type) and the underlying BOAPI routines rather than through direct DML in this wrapper body.

Usage Notes

ITG_BOAPI_WRAPPERS is not referenced by any other documented package, which indicates it is invoked as a top-level entry point rather than called from within other PL/SQL units. It is typically driven by the ITG integration framework — for example, by concurrent programs or inbound XML gateway processing that must translate external supplier and transaction messages into EBS supplier, item, and purchasing structures. The BEGIN_WRAPPER/END_WRAPPER pairing establishes a consistent execution envelope, and the global g_return_status value should be inspected after each procedure call to determine whether processing succeeded, failed, or encountered an unexpected error. Because the package mutates global package state (g_collaboration_id, g_return_status, g_org, g_doctyp, and similar variables), it should not be treated as re-entrant across concurrent sessions.