XML Gateway: Inbound Purchase Orders to Oracle Order Management – A Technical Overview Jason Morrill NCOAUG Training Day February, 2008

NCOAUG Training Day Feb, 2008

2

Jason Morrill Background

 Oracle Technical consultant with O2Works  12 years experience extending, enhancing and customizing Oracle Applications.

 Contact information: – [email protected]

– 414-559-8944 NCOAUG Training Day - Feb, 2008

3

Agenda

       What is XML Gateway?

Why use XML Gateway?

Components of XML Gateway Overview of XML Gateway Architecture Overview of Oracle’s XML Message Designer Walk through the setups for XML Gateway Overview of XML Gateway Execution Engine NCOAUG Training Day - Feb, 2008

What is XML Gateway?

4

   Oracle XML Gateway is the XML message enabler for the Oracle E-Business Suite.

XML Gateway provides an generic framework to send information as an outbound transaction or to receive the information as an inbound transaction between Trading Partners and the Oracle e-Business Suite.

Oracle XML Gateway uses the message propagation feature of Oracle Advanced Queuing to integrate with the Oracle Transport Agent to deliver messages to and receive messages from business partners. NCOAUG Training Day - Feb, 2008

5

Why use XML Gateway ?

     XML Gateway is Event Based, Real-Time.

Messages tend to be based on a single transaction.

Oracle XML Gateway supports all DTD (Document Type Definition) based XML standards.

Flexible enough to accommodate all your Trading Partners.

Oracle XML Gateway creates or consumes standards compliant XML messages without the use of a 3 rd Party translator.

NCOAUG Training Day - Feb, 2008

Components of XML Gateway

6

• Message Designer • A wizard-guided, repository-based tool used to create XML message maps • The Message Designer can support map creation for any business document as long as the document conforms to a Document Type Definition (DTD).

• Modify the Oracle prebuilt message maps • Create your own message maps based on a (DTD) • XML Gateway Execution Engine • Picks up messages (orders) from the inbound queue • Validates message as well-formed XML per the DTD • Executes the message map • Sends business event to predefined workflow process NCOAUG Training Day - Feb, 2008

7

Components cont…

• XML Gateway Setups • Steps consist of setting Profile Options and performing setups using the admin forms within the XML Gateway Responsibility.

• Other Products Interfacing with Execution Engine • 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.

NCOAUG Training Day - Feb, 2008

XML Gateway – Architecture

8

   Transport Agent API delivers message to inbound queue Advanced Queuing Processes Message to Execution Engine.

Workflow Business Event System calls Order Import to process order that has been placed in Order Import Interface tables by the Execution Engine and message map.

NCOAUG Training Day - Feb, 2008

Message Designer – Step 1

9

NCOAUG Training Day - Feb, 2008

Build Message Map – Step 2

10

NCOAUG Training Day - Feb, 2008

Build Message Map – Step 3

11

NCOAUG Training Day - Feb, 2008

Build Message Map – Step 4

12

NCOAUG Training Day - Feb, 2008

Build Message Map – Step 5

13

NCOAUG Training Day - Feb, 2008

Build Message Map – Step 6

14

NCOAUG Training Day - Feb, 2008

Build Message Map – Step 7

15

NCOAUG Training Day - Feb, 2008

Build Message Map – Step 8

16

NCOAUG Training Day - Feb, 2008

Build Message Map – Step 9

17

NCOAUG Training Day - Feb, 2008

Build Message Map – Step 10

18

NCOAUG Training Day - Feb, 2008

Finished! You are now ready to modify your attributes.

19

NCOAUG Training Day - Feb, 2008

Source Definition

20

NCOAUG Training Day - Feb, 2008

Target Definition

21

NCOAUG Training Day - Feb, 2008

Level Mapping

22

NCOAUG Training Day - Feb, 2008

Element Mapping

23

NCOAUG Training Day - Feb, 2008

Map Action Editor

24

• Pre-Process - A preprocess action is executed before the message is created or consumed. The Create Global Variable action is an example of a preprocess action. The variable must be defined before you can use • it.

In-process – The action is executed during message creation or consumption. The Math and String Functions are examples of in-process actions used to perform a computation or to manipulate a value.

• Post Process - A post process action is executed after the message is created or consumed. The Insert into Database Table action is an example of a post process action. The row cannot be inserted into the database until all the data for the row has been processed.

NCOAUG Training Day - Feb, 2008

Loading Map and DTD to Database

25

Object Name Order.dtd

Object Type Command DTD java oracle.apps.ecx.loader.LoadDTDToClob \ apps apps_password \ auohsmwac27.oracleoutsourcing.com:10710:DMWACI \ Order \ $XBOL_TOP/xml/xCBL35/Order.dtd map_name.xgm

MAP java oracle.apps.ecx.loader.LoadMap \ apps apps_password \ auohsmwac27.oracleoutsourcing.com:10710:DMWACI \ $XBOL_TOP/xml/map_name.xgm

NCOAUG Training Day - Feb, 2008

Define System Profile Options

26

NCOAUG Training Day - Feb, 2008

Profile Options – Con’t…

27

• ECX: Log File Path - Log File Path where the XML messages and • runtime log are stored (Required) ECX: Maximum XML Size - Specifies the maximum size of an • outbound XML document (Not Required) ECX: Server Time Zone – The time zone in which the database • server is running (Required) ECX: System Administrator Email Address – XML Gateway System • Administrator e-mail address (Required) ECX: XML Suppress Empty Tags – Suppresses Empty Tags in XML • file ECX: XML Validate Flag - Specifies whether an outbound document should continue to be parsed by the engine after the ECX: Maximum • XML Size has been met.

ECX: XSLT File Path – Set to the same as the ECX: Log File Path NCOAUG Training Day - Feb, 2008

Define Transaction – Purchase Order Inbound

28

NCOAUG Training Day - Feb, 2008

29

Define Transaction – Con’t…

The ONT/POI transaction is a seeded within Oracle XML Gateway and requires no additional setup. Values are as follows… • • • • • • • • • Party – Customer Transaction Type – ONT Transaction SubType – POI Transaction Description – Purchase Order Inbound Standard Code – OAG Direction – In External Transaction Type – PO External Transaction Subtype Queue – Process – APPS.ECX_IN_OAG_Q

NCOAUG Training Day - Feb, 2008

Trading Partner Setup

30

NCOAUG Training Day - Feb, 2008

Trading Partner Setup – Con’t…

31

NCOAUG Training Day - Feb, 2008

Trading Partner Setup – Con’t…

32

The Trading Partner Setup is the component that will enable a message to be processed through the XML Gateway engine. The Trading Partner setup form is used to… • Enable messages for the trading partner by identifying the internal and external transaction and transaction subtype codes, and the XML standard associated with the message.

• Access the Trading Partner User setup form (Security) • Access the Trading Partner Code Conversion form • Select a Message Map for the trading partner • Define Source Trading Partner Location Code. This is your trading partner’s location code (PARTY_SITE_ID) because they are the source of the XML message.

NCOAUG Training Day - Feb, 2008

Trading Partner Setup – Con’t…

• Set your level of document confirmation. Document Confirmation is the indicator for the confirmation level that this Trading Partner would like to send or receive a confirmation.

33

NCOAUG Training Day - Feb, 2008

Trading Partner Setup – Con’t…

Code Conversion - The Oracle XML Gateway code conversion function provides a method to cross-reference the codes defined in Oracle E-Business Suite to codes used by your trading partners.

34

NCOAUG Training Day - Feb, 2008

35

XML Gateway Execution Engine

 The XML Gateway Execution Engine can process messages properly after the following .

• • • • • • Message maps are created and loaded into the repository along with their associated DTDs Trading Partners are defined.

Code Conversions are defined.

Transactions are defined.

Oracle Workflow Business Event System events are published by the Oracle E-Business Suite and subscriptions to those events are defined. (Already done with seeded Transaction Types) Engine and listeners are started.

(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, or that an inbound message has arrived on the queue) NCOAUG Training Day - Feb, 2008

36

What does the Execution Engine Do?

 During processing the XML Gateway Execution Engine performs the following tasks .

• • • • • • Dequeue message from inbound queue.

Uses the XML Parser to validate the inbound message to determine if it is well-formed and valid based on the DTD stored in the DTD directory.

Gets the message map from the repository that is defined for the transaction type.

Executes the message map.

Applies Actions and Code Conversions.

Detects and reports processing errors .

NCOAUG Training Day - Feb, 2008

XML Message Process Flow

37

NCOAUG Training Day - Feb, 2008

Summary

38

 Oracle XML Gateway has a number of valuable features that allow you to: • • • Employ a common, standards-based approach for XML integration between the Oracle E-Business Suite and third party applications, both inside and outside of your enterprise.

Develop custom maps using the Message Designer for message processing.

Employ a variety of transaction types and subtypes to facilitate inbound and outbound messaging.

NCOAUG Training Day - Feb, 2008

THANK YOU

Questions and Answers

Presenter

: Jason Morrill [email protected]

Contact: 414-559-8944

O2Works LLC

Dallas – Chicago - Denver NCOAUG Training Day Feb, 2008

40

Sources

• • • XML Gateway User’s Guide, Release 11i Part No. B10665 03 Oracle XML Gateway 11i Datasheet.

Understanding the Oracle Transport Agent Messaging Protocol, An Oracle White Paper NCOAUG Training Day - Feb, 2008