Search Results ecx_errorlog




Overview
Explore in AI Chat

Overview

APPS.ECX_ERRORLOG is the logging and delivery-tracking engine of the Oracle XML Gateway (product code ECX). Its documented purpose, per the ETRM metadata, is to "track and report message delivery data" for XML Gateway transactions. The package captures the outcome of inbound and outbound message processing, records error messages and error parameters, and persists delivery status reported by both Oracle and non-Oracle messaging transports. It is declared AUTHID CURRENT_USER, so it executes with the privileges of the calling schema, and it is classified as a public, active API with a compatibility rating of S (supported). The source header identifies the shipped version as ECXERRS.pls 120.5, dated November 2005, which remains the baseline for the 12.1.1 and 12.2.2 releases. Because XML Gateway is the integration backbone for inbound documents such as orders, invoices, and receipts, ECX_ERRORLOG is the component that supplies the audit trail and diagnostic detail administrators rely on when a transaction fails or is delayed in delivery.

Key Procedures and Functions

The ETRM metadata documents thirteen procedures. The inbound and outbound engine routines accept a status value, an error message, and error parameters, and are the primary entry points for recording the result of a message processed by the Gateway engine. Notably, the source excerpt confirms that i_status appears in both INBOUND_ENGINE and OUTBOUND_ENGINE, and the user's search term therefore maps directly to these two engine procedures.

  • INBOUND_ENGINE — records the processing status and error information for an inbound XML message against a process identifier.
  • OUTBOUND_ENGINE — records status and error information for an outbound message, associating it with the trigger, outbound message ID, and party type.
  • EXTERNAL_SYSTEM — reports delivery status supplied by an external messaging system; the source shows it accepts an outbound message ID, a status, an error message, a timestamp, error parameters, and returns a return code and return message.
  • SEND_ERROR — emits an error notification or log entry based on a return code.
  • SEND_MSG_API — submits or records a message through the messaging API layer.
  • INBOUND_TRIGGER and OUTBOUND_TRIGGER — record log entries associated with inbound and outbound trigger activity.
  • LOG_DOCUMENT and UPDATE_LOG_DOCUMENT — create and subsequently amend document-level log records in the XML Gateway log tables.
  • GETDOCLOGDETAILS — retrieves document log detail for reporting and troubleshooting.
  • LOG_RESEND — records a resend request for a previously delivered or failed message.
  • OUTBOUND_LOG — writes outbound message logging information.
  • LOG_RECEIVEMESSAGE — logs receipt of a message by the Gateway.

Tables Accessed

The package reads and writes the core XML Gateway logging and configuration tables through APPS synonyms. The principal write targets are ECX_DOCLOGS, ECX_INBOUND_LOGS, ECX_OUTBOUND_LOGS, ECX_EXTERNAL_LOGS, ECX_MSG_LOGS, and ECX_ERROR_MSGS, which collectively hold document-level, direction-specific, external-system, message-level, and error detail rows. ECX_EXTERNAL_RETRY supports retry tracking for externally delivered messages. ECX_TP_HEADERS and ECX_TP_DETAILS supply trading partner definitions used to resolve message context, while ECX_TRANSACTIONS links logs to the underlying business transaction. WF_EVENT_T is referenced for Oracle Workflow event integration, and the sequence objects ECX_ERROR_NO_S, ECX_INLSTN_S, ECX_MSG_LOGS_S, and ECX_TRIGGER_ID_S provide primary key values for the log and trigger records.

Usage Notes

ECX_ERRORLOG is invoked internally by the XML Gateway runtime rather than by end users. The inbound and outbound engine procedures are called as messages are processed by the Gateway concurrent programs and listeners, while EXTERNAL_SYSTEM is called by messaging transports—including non-Oracle middleware—to report final delivery status. The package is referenced by fourteen other packages, confirming its role as a shared logging dependency across the ECX product. Administrators normally interact with its output indirectly through the XML Gateway Message Delivery and transaction monitor screens, where the logged status and error message columns originate from these tables. Custom integrations that need to record delivery outcomes for outbound messages should call EXTERNAL_SYSTEM or the engine routines rather than inserting directly into the log tables, so that sequencing and referential integrity are preserved and the standard diagnostic views remain accurate. Because the status parameter in the engine procedures drives downstream interpretation of message state, callers should pass only the status values recognized by the Gateway when invoking INBOUND_ENGINE or OUTBOUND_ENGINE.