Search Results ecx_workflow_html




Overview
Explore in AI Chat

Overview

ECX_WORKFLOW_HTML is a diagnostic and presentation utility package owned by the APPS schema in Oracle E-Business Suite 12.1.1 and 12.2.2. It is classified under the ETRM metadata as an OTHER API object, reflecting that it is not an end-user business API but an internal helper for Oracle Workflow-based XML/EDI transactions. Its principal business function is to render HTML reports of the contents of Advanced Queuing (AQ) message queues used by Oracle EDI/XML Gateway. The package is declared AUTHID CURRENT_USER, so all SQL executed within it runs under the privileges of the invoking session rather than the defining schema — an important consideration for both security and synonym resolution.

The ECX prefix denotes the XML Gateway / e-commerce transaction schema family. Messages handled by this family are held in AQ queues in the form of rich ADTs (Abstract Data Types) such as ECXMSG and ECX_INENGOBJ. Administrators troubleshooting stalled, unprocessed, or failed XML Gateway transactions need a human-readable view of those messages; ECX_WORKFLOW_HTML exists to supply exactly that.

Key Procedures and Functions

The package exposes two documented procedures, listed in ETRM as:

  • LISTECXMSGQUEUEMESSAGES — Lists message contents for the ECXMSG ADT in a specified queue. Its documented input filters are the queue name, the ECX transaction type, the ECX document number, the party site identifier, the message status, and the message ID. This is the general-purpose report for standard XML Gateway message queues.
  • LISTECX_INENGOBJQUEUEMESSAGES — Lists message contents for the ECX_INENGOBJ ADT. Its documented input filters are the queue name, the message status, and the ECX message ID. This corresponds to the object area the user search term, "listecx_inengobjqueuemessages", targets.

Both procedures default their filtering parameters to NULL, except the message status which defaults to 'ANY'. Passing no filters therefore returns all messages in the relevant queue, whereas supplying a message ID or document number narrows the report to a specific transaction. The procedures generate HTML output directly, using the Oracle Web Toolkit PL/SQL packages, rather than returning a value or a ref cursor.

Tables Accessed

ETRM records the following objects referenced through APPS synonyms:

  • ALL_QUEUES — the data dictionary view listing AQ queue definitions. It resolves the physical queue name and queue table backing the report.
  • HTF and HTP — the Oracle Web Toolkit HTML function and procedure packages. HTP emits HTML tags and text; HTF supplies the equivalent returning functions.
  • OWA_UTIL — the Web Toolkit utility package, used here for HTML escape/formatting helpers so that message payload text containing markup characters is rendered safely.

The actual message data is read from the AQ queue tables associated with the ADTs named in the procedure calls; ALL_QUEUES provides the mapping to those underlying tables.

Usage Notes

Because the procedures emit HTML, they are intended to be invoked from an environment that can receive a web page — most commonly Oracle Workflow's notification and diagnostics pages, or a custom servlet/PLSQL script that calls the procedure and streams the result to a browser. In practice, EBS administrators invoke them when investigating EDI or XML Gateway processing problems: verifying that a message was enqueued, inspecting its payload, confirming its status, or tracing a transaction by document number or message ID.

ETRM shows the package is referenced by zero other packages, confirming it is a leaf-level diagnostic utility with no downstream dependents. Any change to it therefore carries low regression risk. Two cautions apply. First, since the package is AUTHID CURRENT_USER, callers require direct execute and read privileges on the referenced APPS synonyms. Second, the header comment block carries the older editor name ListECXMSGQueueMessages from an earlier revision; the procedures as shipped are the two listed above, and custom code should target those names.