Search Results ecx_document




Overview
Explore in AI Chat

Overview

ECX_DOCUMENT is the core outbound document generation API within the Oracle E-Business Suite e-Commerce Exchange (ECX) module. Its principal business function is to accept a logical business transaction, resolve the trading partner and communication configuration associated with that transaction, and dispatch the outbound document through the appropriate delivery mechanism. The package has been a stable component of the XML Gateway architecture since the 11i era, as evidenced by its header revision (120.3, dated 2005), and remains present in both EBS 12.1.1 and 12.2.2. In ETRM terms it is classified under the OTHER API category, indicating that it is an internal, infrastructure-oriented package rather than a user-facing transactional API.

The package is the runtime engine behind outbound XML messages. Callers supply a transaction type and subtype (which map to a defined XML Gateway transaction), party and party site identifiers, and a document identifier. The package then determines whether delivery is required, resolves the hub, mapping, and trading partner details, creates a transaction log record, and enqueues an event on the Workflow Business Event System for asynchronous delivery. The trigger_id returned by SEND corresponds to the ECX trigger identifier maintained through the ECX_TRIGGER_ID_S sequence.

Key Procedures and Functions

The documented interface exposes nine procedures and functions:

  • SEND — The primary asynchronous API. It initiates outbound document generation and returns a trigger identifier plus standard retcode/errmsg outputs. It accepts up to five optional user parameters, enabling callers to pass contextual values into the XML mapping.
  • SENDDIRECT — A synchronous variant of SEND, provided specifically to avoid race conditions that can arise when asynchronous processing is interleaved with subsequent operations. It returns an internal message identifier rather than a trigger identifier.
  • ISDELIVERYREQUIRED — A validation routine that determines whether a given transaction type/subtype and party combination actually requires outbound delivery, preventing unnecessary document generation.
  • GETEXTPARTYINFO — Retrieves external trading partner information associated with the supplied transaction context.
  • GET_DELIVERY_ATTRIBS — Returns delivery attributes (such as protocol, destination, and addressing details) for the resolved trading partner.
  • RESEND — Re-drives a previously generated outbound document, typically after a delivery failure.
  • GETCONFIRMATIONSTATUS — Returns the confirmation or acknowledgement status for an outbound transaction.
  • TRIGGER_OUTBOUND — Invokes outbound processing for a trigger; this procedure relates directly to the "outbound_trigger" terminology and is the entry point used when processing is driven from a trigger record rather than a direct SEND call.

The package also declares three named exceptions — ecx_transaction_not_defined, ecx_no_party_setup, and ecx_delivery_setup_error — which signal missing transaction definitions, absent trading partner setup, and delivery configuration faults respectively.

Tables Accessed

The package operates across the ECX configuration and logging schema, all referenced through APPS synonyms:

Usage Notes

ECX_DOCUMENT is invoked from Oracle XML Gateway–enabled application flows, workflow business events, and custom PL/SQL. Standard EBS modules such as Order Management and Purchasing call it indirectly when outbound XML messages are configured. Custom integrations typically call ECX_DOCUMENT.SEND directly, capturing the returned trigger_id for later status or resend operations, or use SENDDIRECT when synchronous confirmation of enqueue is required. The package is referenced by fourteen other packages, reflecting its role as a shared outbound service. Debug output can be enabled through the debug_mode parameter, and the named exceptions should be handled explicitly by calling code to distinguish setup errors from missing transaction definitions.