Search Results notifiy_xmlg_in_error




Overview
Explore in AI Chat

Overview

CLN_XMLG_EVENT_HANDLER_PKG is an Oracle E-Business Suite PL/SQL package owned by APPS and classified under the ETRM schema as an OTHER API. Its business purpose, as stated directly in the package body header, is to capture events raised by Oracle XML Gateway and update the collaboration history maintained by the CLN (Collaboration) module. The package acts as the bridge between low-level XML Gateway inbound processing errors and the higher-level collaboration tracking framework, ensuring that failures encountered while processing inbound XML documents are recorded against the appropriate collaboration history record. This allows trading partner collaboration messages to be audited and retried or reconciled when XML Gateway reports errors. The package body carries a header revision identifying it as ECXXMLGB.pls, version 120.1, last modified in 2005, with a creation history dating to May 2002 by Viswanthan Umapathy. A package-level debug flag is initialized from the profile option CLN_DEBUG_LEVEL, defaulting to 5, and is used to gate diagnostic tracing through ECX_CLN_DEBUG_PUB.

Key Procedures and Functions

The ETRM metadata documents three procedures or functions in this package:

  • CLN_XMLG_PROCESSING_ERROR_F — Handles errors raised by XML Gateway during the processing of an inbound document, updating the collaboration history so that the failure is captured against the relevant collaboration record.
  • CLN_XMLG_SETUP_ERROR_F — Addresses setup-related errors encountered by XML Gateway, such as missing or misconfigured trading partner, transaction type, or standard definitions required before inbound processing can proceed.
  • CLN_XMLG_EVENT_SUB_F — Serves as the event subscription entry point, invoked when the XML Gateway business event is raised, and routes the event to the appropriate error-handling logic.

The package body excerpt further documents a procedure named NOTIFIY_XMLG_IN_ERROR (note the original spelling), whose stated purpose is to update the collaboration history whenever XML Gateway encounters an error in an inbound document. It accepts an XML Gateway message identifier, an error code, and an error description, and returns a status and message data. Internally it resolves collaboration, party, trading partner, application, document direction, document number, transaction type, subtype, document identifier, and application reference identifier, then determines whether a collaboration record already exists. The field l_app_ref_id corresponds to the application reference identifier that users frequently search for as "get_data_area_refid"; this identifier is derived during the resolution logic before the collaboration history is updated.

Tables Accessed

The package reads and writes the following tables through APPS synonyms:

Usage Notes

This package is not intended for direct invocation by end users or custom code. It is invoked internally by Oracle XML Gateway and Oracle Workflow when inbound collaboration documents raise business events or encounter processing and setup errors. The event subscription function is registered against the XML Gateway event so that Workflow dispatches control to this package automatically. The debug output is controlled by the CLN_DEBUG_LEVEL profile option and written by ECX_CLN_DEBUG_PUB. In Oracle EBS 12.1.1 and 12.2.2, the package is referenced by zero other packages according to the ETRM metadata, confirming that it sits at the outer boundary of the collaboration stack rather than being called by other PL/SQL APIs. Customizations should not modify this package; instead, extend collaboration error handling through supported XML Gateway and Workflow configuration.