Message Queues

This chapter covers the following topics:

Queues

Queues

Queues are tables on a database that are managed by Oracle Advanced Queuing.

The XML Gateway uses queues specifically at two points in the process, as well as employing a general error queue. The first point is at the transport agent level between the transport agent module and the XML Gateway. The second point is at the transaction level between base Oracle E-Business Suite products or other source process, and the XML Gateway. Details about these queues are provided in the table below.


Queue Name	Description	Level and Position in Process
ECX_INBOUND	Inbound Message Queue: Holds all messages that enter the process through the Transport Agent, or are placed directly on the queue by an API.	Transport Agent Level Between the Transport Agent and the Inbound Transaction Queue
ECX_OUTBOUND	Outbound Message Queue: XML Gateway enqueues all outbound messages that it formatted on this queue.	Transport Agent Level Between the XML Gateway and the Transport Agent
ECX_IN_OAG_Q	Inbound Transaction Queue: Holds inbound messages that originated from the ECX_INBOUND queue, then enqueued on this queue by Oracle Workflow These messages will be processed by the XML Gateway.	Intermediate Level After the message is received through the Transport Agent (Transport Agent Level above), Oracle Workflow enqueues the message in this queue for the XML Gateway to process.
WF_ERROR	Workflow Error Queue: For errors detected by XML Gateway or WF BES. Notifications are sent to a Trading Partner contact or the System Administrator.	Transaction Level

Refer to the Oracle Database 10g title Oracle Streams Advanced Queuing User's Guide and Reference for details on checking the status and contents of the queues. Also, see XML Gateway B2B Transactions Using JMS Queues chapter in this book for details on JMS queues.

Outbound Queues

Outbound Message Queues

the picture is described in the document text

The outbound Message Queue is positioned between the XML Gateway and the Transport Agent.

The XML Gateway creates XML messages, then enqueues them on this queue.

Next Step: The Transport Agent dequeues the message and delivers it to the Trading Partner.

Inbound Queues

Inbound Message Queue

the picture is described in the document text

Inbound messages are first queued on the Inbound Message Queue.

The inbound Message Queue is positioned between the Transport Agent and the Oracle Workflow Business Event System.

There are two methods for placing a message on the Inbound Message Queue:

The Transport Agent enqueues the message.
An API writes directly to the queue.

Refer to the Oracle Database 10g title Oracle Streams Advanced Queuing User's Guide and Reference for details. Also, see XML Gateway B2B Transactions Using JMS Queues chapter in this book for details on JMS queues.

The full message must be formatted according to the XML Gateway envelope message format described in the Execution Engine section. See XML Gateway Envelope for details.

Next Step: Oracle Workflow Business Event System will copy the inbound messages to the proper inbound Transaction Queue. One queue is seeded, but you may define other queues to meet your business needs. See information below.

Inbound Transaction Queue

This is the second queue for an inbound message.

After the message is received through the inbound Message Queue, Oracle Workflow Business Event System enqueues the message to this queue for the XML Gateway to process.

Next Step: The XML Gateway will process the inbound messages placed in this queue.

Error Queue

When an error is detected by Oracle XML Gateway or Oracle Workflow Business Event System the message is enqueued on to the error queue. A Workflow listener dequeues the error and sends a notification to the Trading Partner contact for data errors or to the System Administrator contact for system or process errors.

Oracle Transport Agent Send Inbound HTML Page

To verify that a message can be placed on a queue after setup, use the Oracle Transport Agent Send Inbound page. This page allows you to send an Inbound HTML document to the Oracle Transport Agent running on the same Web server as the HTML page.

The ECXOTAInbound.html file included with the Oracle Transport Agent allows you to send XML documents inbound from a Web server. The document will be received by OTA and placed on the ECX_INBOUND queue. This HTML file is included for testing purposes and should not be used in a production environment.

To use the ECXOTAInbound.htm page, open a Web browser and enter the following URL:

http://<server name>:<port>/OA_HTML/US/ECXOTAInbound.htm

The page will prompt you for the input parameters used by the OTA messaging protocol. Refer to the Oracle Transport Agent chapter for information about the OTA messaging protocol parameters.


Column Name	Description
TRANSPORT_PROTOCOL	Defaults to OXTA.
TRANSPORT_PROTOCOL_VERSION	Defaults to 1.0.
REQUEST_TYPE	Select "Send".
MESSAGE_ID	Enter the unique reference number that identifies the transaction.
MESSAGE_TYPE	Defaults to XML.
MESSAGE_STANDARD	Defaults to OAG.
TRANSACTION_TYPE	(Required) Enter the type of transaction, such as PO for Purchase Order Inbound.
TRANSACTION_SUBTYPE	(Required) Enter the subtype of the transaction.
DOCUMENT_NUMBER	Enter the document number.
PARTYID	(Optional) Enter the trading partner ID for the sender.
SOURCE_TP_LOCATION_CODE	(required) Enter the Source Trading Partner Location Code (should match the Trading Partner Details column of the same name).
PROTOCOL_TYPE	Not required for inbound messages.
PROTOCOL_ADDRESS	Required only if REQUEST_TYPE is EME.
USERNAME	(Required) Enter a valid user name for the receiving system.
PASSWORD	(Required) Enter the password for the user name entered.
ATTRIBUTE1	Optional
ATTRIBUTE2	Optional
ATTRIBUTE3	Required for pass-through transactions only.
ATTRIBUTE4	Optional
ATTRIBUTE5	Optional
PAYLOAD	Enter the message payload.

XML Gateway Message Format

XML messages that are enqueued or dequeued for processing by XML Gateway must conform to the system.ecxmsg data type.

The system.ecxmsg data type consists of the following:


Name	Type
MESSAGE_TYPE	VARCHAR2(80)
MESSAGE_STANDARD	VARCHAR2(80)
TRANSACTION_TYPE	VARCHAR2(80)
TRANSACTION_SUBTYPE	VARCHAR2(80)
DOCUMENT_NUMBER	VARCHAR2(80)
PARTYID	VARCHAR2(80)
SOURCE_TP_LOCATION_CODE	VARCHAR2(80)
PARTY_TYPE	VARCHAR2(80)
PROTOCOL_TYPE	VARCHAR2(200)
PROTOCOL_ADDRESS	VARCHAR2(200)
USERNAME	VARCHAR2(200)
PASSWORD	VARCHAR2(200)
ATTRIBUTE1	VARCHAR2(200)
ATTRIBUTE2	VARCHAR2(200)
ATTRIBUTE3	VARCHAR2(200)
ATTRIBUTE4	VARCHAR2(200)
ATTRIBUTE5	VARCHAR2(200)
PAYLOAD	CLOB

Refer to XML Gateway Envelope for a description of each field.

Non-Oracle messaging systems can enqueue an XML message for the Oracle E-Business Suite to process. This is done by defining an object of the same data type, populating the object, then calling an Advanced Queuing enqueue API to enqueue the object. The Oracle E-Business Suite Transport Agent will receive the object and deposit it onto the ECX_OUTBOUND agent. From there, the standard inbound agent listener assumes control of the process.