Oracle XML Gateway User's Guide

Skip Headers

Title and Copyright Information

Send Us Your Comments

Preface

Oracle XML Gateway Overview

Overview of XML Gateway

XML Standards

XML Gateway Introduction

XML Gateway Features

XML Gateway Architecture

XML Messages and EDI Transactions

Conclusion

Message Designer

Message Designer Overview

Message Designer Menus

Message Designer Toolbar

Message Designer Buttons

File > Properties Menu

Message Designer Wizards

Data Definition Creation Wizard Process Flow

Map Creation Wizard Process Flow

Using the Data Definition Creation Wizard

Data Definition Creation Wizard Steps

Message Designer Data Definition Window

Using the Map Creation Wizard

Transaction Map Window

Source Definition

Transaction Map - Target Definition

Transaction Map - Level Mapping Tab

Transaction Map - Element Mapping

Transaction Map - Actions

Map Action Editor

Overview

Map Action Editor - Assignments: Assign Variable Value

Map Action Editor - Assignments: Create Global Variable

Map Action Editor - Database Functions: Assign Next Sequence Value

Map Action Editor - Database Functions: Append Where Clause

Map Action Editor - Database Functions: Insert into Database Table

Map Action Editor - Derivations: Derive Address ID from Location Code

Map Action Editor - Derivations: Derive Parent ID from Location Code

Map Action Editor - Function Call: Execute Function Call

Map Action Editor - Math Functions

OAG Conversions

Map Action Editor - Convert to OAG DATETIME

Map Action Editor - Convert to OAG OPERAMT

Map Action Editor - Convert to OAG QUANTITY

Map Action Editor - Convert to OAG AMOUNT

Map Action Editor - Convert from OAG DATETIME

Map Action Editor - Convert from OAG OPERAMT

Map Action Editor - Convert from OAG Quantity

Map Action Editor - Convert from OAG AMOUNT

Map Action Editor - Other: Exit Program

Map Action Editor - Get Predefined Variable Value

Map Action Editor - Procedure Call: Execute Procedure

Map Action Editor - Return Error Message: Send Error Message

Map Action Editor - String Functions: Perform Concatenation

Map Action Editor - String Functions: Perform Substring

Map Action Editor - XSLT Transformation

How to Extend DTDs

How to Map a Pass-Through Message

How to Map to an API

Loading and Deleting Message Maps and DTDs

Loading/Deleting a Map

Loading and Deleting a DTD

Downloading a Map

Loading and Deleting an XSLT Style Sheet

How to Implement Attachments in XML Messages

Attachments and Oracle E-Business Suite

Attachments and OAG Standard

Attachments and Oracle Transport Agent (OTA)

Attachments and Outbound Documents

Enable Attachments for Unit Test for Outbound Documents

Attachments and Inbound Documents

Enable Attachments for Unit Test for Inbound Documents

XML Gateway Setup

Setup Overview

Define System Profile Options

Assign XML Gateway Responsibility

Define UTL_FILE_DIR Parameter

Hub Definitions Form

Define XML Standards Form

Define Transactions Form

Define Transactions Form Fields

Transaction Type and Transaction Subtype Naming Conventions

Setting VERB and NOUN in OAG Standards

Define Lookup Values

Trading Partner Setup

Required Communications Data

Static and Dynamic Routing

Trading Partner User Security

Code Conversion

Code Categories

Accessing the Code Conversion Values

Standard Code Conversion Form

Trading Partner Code Conversion Form

Execution Engine

Execution Engine Overview

Protocol Type

XML Gateway Envelope

Trading Partner Validation for Inbound Messages

Validation Against Data in the Trading Partner Setup Form

Trading Partner Validation for Outbound Messages

Dynamic Embedding of XML Fragments

How to Implement the OAG Confirmation Business Object Document

Purpose of the Confirmation Message

Structure of the Confirmation Message

XML Gateway Seeded Confirmation Message Maps

E-Business Suite Seeded Events and Event Subscriptions

How to Implement or Disable a Seeded Confirmation Message

Message Queues

Queues

Outbound Queues

Inbound Queues

Oracle Transport Agent Send Inbound HTML Page

XML Gateway Message Format

Integrating Oracle XML Gateway with Oracle Workflow Business Event System

Integrating Oracle XML Gateway with Oracle Workflow Business Event System

Overview

Oracle Workflow Builder - Item Types

Components of an Item Type

XML Gateway Standard Item Type

XML Gateway Error Processing Item Type

E-Business Suite Application Module-Specific Item Type

XML Gateway Standard Item Type

Attributes

Processes

Functions

Events

Lookup Types

XML Gateway Error Processing Item Type

Attributes

Processes

Notifications

Functions

Events

Messages

Lookup Types

Configure Oracle Prebuilt Inbound Messages

Configure Oracle Prebuilt Outbound Messages

Application to Application Integration

Inbound Option

Outbound Option

Manage Workflow Processes

Identify Seeded Item Types

Identify Seeded Business Events and Associated Event Subscriptions

Configure or Delete Seeded Event Subscriptions

View and Respond to Error Notifications

Purge XML Gateway Transactions

Monitor Workflow Processes

Transaction-Level Trace

Monitor Transaction Status

Review XML Message Returned by Generate Functions

Start Agent Listeners

Development Guidelines for Custom Messages for B2B Integration

Development Guidelines for Outbound Messages

Development Guidelines for Inbound Messages

Common Questions

Message Delivery Status

How Other Messaging Systems Use XML Message Delivery Callback

Oracle Transport Agent

Oracle Transport Agent Overview

OTA Message Propagation Flow

Oracle Transport Agent Post Message

Oracle Transport Agent Response Message

OTA and Attachments

Authentication Methods

Implementation of Client Authentication

Sequence of Events

Enabling Client Authentication

Setup Parameters

Parameters Set Through AutoConfig

Parameters Not Set Through AutoConfig

Connecting to Non-OTA Servers

Code Connection Samples

Troubleshooting

HTTP Status Codes

Web Services

Overview

Web Services Components and Features

Web Service Security

Understanding XML Gateway Web Services

Enabling Strongly-Typed XML Gateway Services through SOA Provider

Accessing Generic XML Gateway Services through Web Service Provider

Process Flows

Inbound Process Flow

Setup Steps for Invoking XML Gateway Web Services

Example of Using an XML Gateway Inbound Service

Using XML Gateway Inbound Services at Design Time

Creating a New BPEL Project

Creating a Partner Link

Adding a Partner Link for File Adapter

Adding Invoke Activities

Adding Assign Activities

Deploying and Testing the BPEL Process at Run Time

Deploying the BPEL Process

Prerequisite Files

Diagnostics

XML Gateway B2B Transactions Using JMS Queues

Java Messaging Service (JMS) Overview

Oracle XML Gateway and B2B Transactions Integration Points

Oracle XML Gateway and JMS Integration

Integration Features

JMS Inbound and Outbound Messages

Impacts on the Trading Partner Setup and Seed Data

Creating Custom JMS Queues

Steps to Create Custom JMS Queues for Outbound B2B Transactions

Steps to Create Custom JMS Queues for Inbound B2B Transactions

Collaboration History

Understanding Collaboration History

Using the Collaboration History

Using the Collaboration History Window

Using Collaboration History Simple Search

Using Collaboration History Advanced Search

Viewing the Collaboration History Search Results

Using the Collaboration Events Window

Viewing the Collaboration Event Messages

Viewing the Collaboration Event XML Payload

Using the Collaboration Event Definitions Window

Creating a Collaboration Event Definition

Updating a Collaboration Event Definition

Using the Collaboration Final Event Definitions Window

Creating a Collaboration Final Event Definition

Updating a Collaboration Final Event Definition

Using Collaboration Properties

Creating a Collaboration Property

Updating a Collaboration Property

Using the Collaboration Display Setup

Creating a Collaboration Display Label Header

Updating the Collaboration Display Header and Details

Using the Notification Definition Window

Creating a Notification Definition

Updating a Notification Definition

Using the Notification Action Definitions Window

Creating a Notification Action Header

Updating a Notification Action Header

Creating and Updating Notification Action Details

Viewing Notification Action Definition Details

Viewing Action Definition Details

Setting Up Collaborations

Setting Up New Collaborations

Designing the Collaboration

Creating Message Maps

Setting Up FND Lookup Codes and Messages

Setting Up Collaboration Events and Collaboration Final Events

Adding the Workflow Events

Implementing Notification Processing for New Collaborations

Setting Up Trading Partners and Confirmation Messages

Setting Profile Options

Troubleshooting and Debugging Collaboration History

Setting Up Notification Processing for New Collaborations

Setting Up Customized Collaborations

Notify Administrator

Notify Trading Partner

Raise Business Event

Start Workflow

Call API

Map Analysis Guidelines

Map Analysis Overview

Map Analysis Guidelines for Outbound Messages

Map Analysis Guidelines for Outbound Messages Checklist

Compare Database Views (Source) to DTD (Target)

Map Analysis Guidelines for Inbound Messages

Map Analysis Guidelines for Inbound Messages Checklist

Compare Database Views (Source) to DTD (Target)

Identifying Source and Target Document Levels

Collapsing Levels

Expanding Levels

Recommending DTD Additions or Changes to OAG

Special Considerations for Custom Messages

Seeded Code Categories

XML Gateway Seeded Code Categories

Supported Actions

XML Gateway Supported Actions

Naming Conventions

XML Gateway Naming Conventions Summary

Timezone Values

XML Gateway Valid Time Zone Values

APIs

XML Gateway APIs

Execution Engine APIs

APIs Defined in ECX_STANDARD

APIs Defined in ECX_ERRORLOG

Message Designer APIs

APIs Defined in ECX_STANDARD

APIs Defined in ECX_DOCUMENT

APIs Defined in ECX_CONDITIONS

APIs Defined in ECX_TRADING_PARTNER_PVT

APIs Defined in ECX_ERRORLOG

APIs Defined in ECX_ACTIONS

APIs Defined in ECX_ATTACHMENT

APIs Defined in ECX_ENG_UTILS

Troubleshooting

Troubleshooting Your XML Gateway Installation

Automated Troubleshooting Script

Transaction Monitor

Transaction Monitor Search Page

Search Results Page

Transaction Monitor Details Page

Manual Troubleshooting Steps

XML Gateway Engine-Level Messages

XML Gateway API-Level Messages

XML Gateway Version Validation

Common SSL Issues

Oracle Diagnostic Tests

XML Gateway Tests

Collaboration Setup Worksheet

Collaboration Setup Worksheet

Index

Oracle XML Gateway User's Guide

Contents