- OracleApps Epicenter - http://www.oracleappshub.com -

Oracle XML Gateway

XML Gateway is a set of services that allows for easy integration with the Oracle e-Business Suite to create and consume XML messages triggered by business events.

Oracle XML Gateway supports both Business-to-Business (B2B) and Application-to-Application (A2A) initiatives.

Typically used to integrate with trading partners using XML Document formats that conform to OAG standards

With Oracle XML Gateway services, you are assured consistent XML message implementation when integrating with the Oracle E-Business Suite, thereby lowering integration costs and expediting message implementation while supporting corporate e-business initiatives.

It integrates with Oracle Advanced Queuing to enqueue/dequeue a message which is then transmitted to/from the business partner via any message transport agent.

The Oracle XML Gateway performs the following functions:

Features of XML Gateway

Oracle XML Gateway Architecture

The services supported by Oracle XML Gateway are grouped into three major components as follows:

  • Message Designer - used to Create ‘Message Maps’ between Oracle e-Business Suite and XML standard of choice
  • Message Set Up -used to Configure message implementation by Trading Partner and message
  • Execution Engine -Create or consume well-formed and valid XML messages based on trading partner message map

Figure 1 shows the relationship of these three components:

It interfaces with the following Oracle products:

  • Oracle Transport Agent for message delivery
  • Oracle Advanced Queuing for message propagation, and queue management
  • Oracle Workflow Business Event System to publish and subscribe to business events. Workflow also provides an active e-mail notification to report errors detected by the XML Gateway Execution Engine, Advanced Queuing (AQ), or the transport Agent

Design Time Components

  • Message Designer - is a wizard-guided, repository-based tool used to define message maps which defines mapping between Oracle Application data to OAGIS DTD XML documents. A message map represents the relationship between the source and target data elements.
  • XML Gateway Setup - To implement a message with a trading partner, XML Gateway setup features is used to define the Trading Partner or hub, code conversion values, and internal-to-external transaction name cross-references (Domain value maps)

Run Time Components

  • Execution Engine
    The XML Gateway Execution Engine is responsible for interacting with several Oracle technologies to process and transport XML messages to and from Trading Partners for B2B integration, or other information systems both within and outside the enterprise for A2A integration.
  • Engine run time engine for validate TP in case of B2B integration, create consume XML messages, Interacts with Advanced Queuing (AQ) to enqueue / dequeue messages and used to transform XML documents to Oracle applications. It communicates through AQ. It has Transport agents which can expose using XML gateway services over http or web services

Oracle XML Gateway leverages the Oracle Workflow Business Event System to publish and subscribe to application business events of interest to automatically trigger message creation or consumption.

The XML Gateway Execution Engine interfaces with the Oracle E-Business Suite via business events and event subscriptions to retrieve data from or populate data into the Oracle e-Business Suite tables. The XML Gateway Execution Engine interfaces with Oracle Advanced Queuing to stage outbound XML messages or receive inbound XML messages for processing.

The Oracle Transport Agent interfaces with Oracle Advanced Queuing to deliver outbound messages and to receive inbound messages.

Message Queues
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 Applications products and the XML Gateway.

  • Inbound Queues
    Inbound message queues are used for XML messages inbound into Oracle Applications. Inbound message queues are positioned between the Transport Agent and the Oracle Workflow Business Event System.

The messages must be formatted according to the XML Gateway envelope message format. The envelope message format is discussed under XML Gateway Envelope. Oracle Workflow Business Event System copies the inbound messages to the proper inbound Transaction Queue.

  • Outbound Queues
    Outbound message queues are used for XML messages outbound from Oracle Applications. 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. The Transport Agent dequeues the message and delivers it to the Trading Partner

Web Services
Oracle XML Gateway uses Web Services Description Language (WSDL) to inform trading partners how to communicate with the Oracle E-Business Suite. The Suite also publishes the WSDL to a URL for customers to access. Partners can use any third party
Web service tools to call for Web services.

Integration Flow

The following diagram illustrates the process flow of XML messages through the XML Gateway Execution Engine using all the components mentioned above.

Inbound Integration Flow

  1. The XML Gateway Inbound listeners are actively polling for interested events. The Execution Engine will be triggered once Oracle Workflow Business Event System detects that an inbound message has arrived on the Inbound Queue.
  2. It then Dequeue Message from Inbound Queue
  3. Uses the XML Parser to validate the inbound message to determine if it is well-formed and valid
  4. If the inbound message is both well-formed and valid, the Execution Engine proceeds to validate that the Trading Partner and document are defined in the XML Gateway Setup
  5. It then retrieves the Message Map from Repository
  6. Execute the message Map - If the Trading Partner is valid and the message map exists in the repository, the Execution Engine maps the data in the XML message to its target data fields in Oracle e-Business Suite tables and columns identified in the message map. These are often the Application Open Interface tables.
  7. Raises an Business Event when inbound document is successfully processed, which triggers the corresponding oracle workflow to process the data within oracle e-business suite

where as for outbound Integration Flow

  1. The XML Gateway listeners are actively polling for interested events. The Execution Engine will begin processing once Oracle Workflow Business Event System detects an outbound transaction to be processed
  2. Validate Trading Partner or Hub
  3. Get Message Map from Repository
  4. Execute the Message Map - If the Trading Partner is valid and the message map exists in the repository, the Execution Engine gathers the application data from the Oracle e-Business Suite using the database views and columns identified in the message map.
  5. Create XML message using the message map and the application data
  6. Uses the XML Parser to validate the newly created message to ensure that it is well-formed and valid. Enqueue well-formed and valid message to the Outbound Queue.
  7. Oracle Transport Agent will dequeue the message from the Outbound Queue and deliver it to the trading partner

XML Standards and supportablity

Many standards bodies (for example, EbXML, Rosettanet, SOAP, iFX) exist with published Document Type Definitions (DTD) each claiming to be better than the other. Some standards are strong at managing the message content while others excel at managing both the message content and its related processes.

As a provider of software to support all industries, Oracle has chosen to align with Open Application Group's (OAG) XML standards for broad based message implementation. OAG is also the standard most widely adopted by the Oracle customer base.

There are over 150 OAG implementations involving the key functional areas.

Apart from above, there are an additional 30+ non-OAG implementations. Non-OAG implementations exists for two primary reasons; the required BOD is not supported by OAG or a proprietary BOD better describes the required functionality.

XML Vs eCommerce Gateway

Comparing within two, here are some differences .


XML Gateway
eCommerce Gateway
XML Messages EDI Transactions
Event based processing Batch Processing
XML Standard Compliant ASCII file format
No translator required EDI Translator required