Browser version scriptSkip Headers

Oracle XML Gateway User's Guide
Release 12.1
Part Number E12954-04
Go to contents  page
Contents
Go to previous page
Previous

Index

A

Acknowledge_PO link
ACKNOWLEDGE_PO BOD link
acknowledgment link
Actions link
  append where clause link
  assign next sequence value link
  assign variable value link
  convert from OAG amount link
  convert from OAG datetime link
  convert from OAG OPERAMT link
  convert from OAG quantity link
  convert to OAG amount link
  convert to OAG datetime link
  convert to OAG OPERAMT link
  convert to OAG quantity link
  create global variable link
  derive target address ID from location code link
  derive target parent ID from location code link
  execute function call link
  execute procedure link
  exit program link
  get predefined variable value link
  insert into database table link
  math functions link
  perform concatenation link
  perform substring link
  send error message link
  XSLT transformation link

Add message link
Add Message Event link
Adding a Message Event
  oracle.apps.cln.ch.collaboration.addmessage link

Adding the FND Lookup Codes
  Application ID link link
  APPLICATION_ID link
  CLN_APPLICATION_ID link
  CLN_COLLABORATION_DOC_TYPE link
  CLN_COLLABORATION_TYPE link
  Collaboration Document Type link
  Collaboration History Detail link
  Collaboration Tracking link
  Collaboration Type link link
  Document Type link
  FND Lookup Types link
  Message Payloads link
  MESSAGE_TYPE link

Adding the FND Messages
  Collaboration History Details link
  Collaboration Setup Worksheet link
  FND Message ID link
  Message link

Adding the Workflow Events
  ECX workflows link
  oracle.apps.cln.ch.collaboration.addmessage link
  oracle.apps.cln.ch.collaboration.create link
  oracle.apps.cln.ch.collaboration.update link
  Raising Events link

Adding Workflow Events link
Advanced Queue link link
Agent Activity link
Agent Listeners link
  enabling and disabling link

API link link
API Return Codes link
API-level error messages link
APIs
  ECX_ACTIONS.set_error_exit_program link
  ECX_ATTACHMENT.formulate_content_id link
  ECX_ATTACHMENT.register_attachment link link link
  ECX_CONDITIONS.getLengthForString link
  ECX_CONDITIONS.getPositionInString link
  ECX_CONDITIONS.getSubString link
  ECX_DOCUMENT.get_delivery_attribs link
  ECX_ENG_UTILS.convert_from_cxml_datetime link
  ECX_ENG_UTILS.convert_to_cxml_date link
  ECX_ENG_UTILS.convert_to_cxml_datetime link
  ECX_ERRORLOG.external_system link
  ECX_ERRORLOG.getDoclogDetails link
  ECX_STANDARD.generate link
  ECX_STANDARD.getEventDetails link
  ECX_STANDARD.getEventSystem link
  ECX_STANDARD.getReferenceID link
  ECX_STANDARD.perform_xslt_transformation link
  ECX_STANDARD.setEventDetails link
  ECX_TRADING_PARTNER_PVT APIs link link link link link
  how to map to link

Application link
Application Programming Interface link
Application to Application integration
  inbound option link
  outbound option link

Application-to-Application
  example link

approved link
AQ link
Architecture, XML Gateway
  diagram link

Attachments link
  OTA link
  Web services link

ATTRIBUTE3
  in dynamic routing link

ATTRIBUTE3 Field link link
Attributes
  Item type link
  Workflow Item Type link

Authentication link
  client authentication link
  sequence of events link
  server authentication link

AutoConfig
  client authentication parameters link

B

B2B link link link
booked link
Business Event System
  common questions link

Business Events link
Business events
  identifying seeded link
  registering new link

business events link
business rule link
Business-to-Business
  example link

business-to-business link
business-to-business gateway link
Buttons
  Message Designer link
  Message Designer Wizards link

buyer link

C

Call API link
  Call API Parameters link
  COLLABORATION_ACCESS.SECURITY_VIOLATED link
  IP_10 link
  Mode of Execution link
  Procedure Name link
  Procedure Signature link
  Security Error link
  wf_parameter_list_t link

Callback link link
  how other messaging systems use link

Cancel Order link link
CBOD
  purpose link

change order link
Change Order Notification link link
Client Authentication link link
Client authentication link
  AutoConfig parameters link
  enabling link
  parameters not set through AutoConfig link
  setup parameters link

CLN
  DEBUG LEVEL link
    capture the log messages link
    Error link
    Event link
    Exception link
    fdllov() link
    Procedure link
    Statement link
    Unexpected link
  Debug Log Directory link
    place the log file link

CLN_APPLICATION_ID link
CLN_COLLABORATION_TYPE link link link
Code categories link
  seeded link

Code Conversion link
  inbound transaction table access link
  one to multiple external codes link
  outbound transaction table access link
  Standard Code Conversion Form link
  Trading Partner Code Conversion Form link

Code Conversion Errors link
Code Conversion Values
  key access link
  order of table search link

Collaboration Design link link
  Collaboration Name link
  Oracle E-Business Suite link

Collaboration Detail link link link
Collaboration Display Setup link
Collaboration Event Definitions link link
Collaboration Event Details link link
Collaboration Event Payload link
Collaboration Events link
Collaboration Final Event Definitions link link
Collaboration History link
Collaboration Setup Worksheet link link link link
Collaboration Type link
Collaborations link
Conditional Node Mapping link
Confirm_BOD link
Confirmation BoD errors link
Confirmation Business Object Document link
  disabling link
  implementing link
  seeded events and subscriptions link
  seeded message maps link
  structure link

Consume XML Document Function link
Correlation ID and Protocol Type link
Create Collaboration Display Header link
Create Collaboration Event Definition link
Create Collaboration Final Event Definition link link
Create Collaboration Property link
Create Notification Action Header link
Create Notification Definition link
Creating a Collaboration Event Definition link
Creating a Collaboration Final Event Definition link
creating new notifications link
Cross-Reference Transaction Identifiers link
Custom Messages
  considerations for link

Custom messages
  B2B integration link

Customer Order link

D

Debugging Oracle E-Business Suite link
  set the debug level link

Debugging Workflow link
Default Error Process link
define any new notifications link
Define Lookup Values link
define new notifications for the B2B gateway link
define the notification actions link
Define Transactions Form link
Define Transactions form fields link
Define UTL_FILE_DIR Parameter link
Define XML Gateway Responsibility link
Define XML Standards Form link
Delivery status link
Deploying and Testing the BPEL Process at Run Time
  deploy link
  test link

Designing the Collaboration link
determine the events in the collaboration link
Development guidelines
  inbound messages link
  outbound messages link

Diagnostics link
  XML Gateway test group link

Discontinuous Nodes
  source definition link
  target definition link

Document Confirmation link
Document Levels
  collapsing levels link
  expanding levels link
  identifying source and target link

Downloading maps link
draw a picture of the message flow link
DTDs
  how to extend link
  loading link

Dynamic Routing link

E

E-Business Suite Application Module-Specific Item Type link
ECX Engine Notification Process link
ECX Event Message (FYI) link
ECX Event Notification (FYI) link
ECX External Event Message (FYI) link
ECX External Event Notification link
ECX Main Error Process link
ECX Main Inbound Error Process link
ECX Main Outbound Error Process link
ECX Reprocess Inbound Function link
ECX Resend Outbound Message Function link
ECX Standard Processes link
ECX Timeout Value Function link
ECX: Log File Path profile option link
ECX: Maximum Retries link
ECX: Maximum XML Size profile option link
ECX: Notification Timeout link
ECX: OAG_LOGICAL_ID profile option link
ECX: Server Time Zone profile option link
ECX: System Administrator Email Address profile option link
ECX: XML Validate Flag profile option link
ECX: XSLT File Path profile option link
ECX_ACTIONS link
ECX_ATTACHMENT link
ECX_CONDITIONS link
ECX_DOCLOGS table link link link
ECX_DOCUMENT link
ECX_ENG_UTILS link
ECX_ERRORLOG link link
ECX_IN_OAG_Q link
ECX_INBOUND queue link
ECX_OUTBOUND Queue link
ECX_STANDARD link
ECX_TRADING_PARTNER_PVT link
ECXOTAInbound.html File link
ecxver.sql script link
EDI Transactions
  compared to XML messages link

Element Mapping link
  applying actions link
  guidelines link
  icons link

Enable User Security profile option link
Engine-Level Error Messages
  error code link
  error type link

Enqueue a message with Non-Oracle messaging system link
Enqueue/Dequeue Errors link
Envelope link
  components of link

Error Handling
  for inbound messages link link
  for outbound messages link

Error Handling Processes link
  relationship link

Error Messages
  engine-level link

Error notifications link
Error Queue link
Error Still Active Function link
Event
  oracle.apps.cln.ch.collaboration.addmessage link
  oracle.apps.cln.ch.collaboration.create link
  oracle.apps.cln.ch.collaboration.update link

Event Location link
Event Message link
Event subscriptions
  configuring link
  deleting link

Events link
  XML Gateway Error Processing Item Type link
    Message Delivery Error link
    Receive Error link
    Receive Send Notification link
    Receive the inbound subscription error link
    Receive the inbound subscription processing error link
  XML Gateway Standard Item Type link
    Generic Receive Event link
    Raise Document Delivery Event link
    WF Send link

events link
Execution Engine
  functions link
  process flow link
  required setup link
  trading partner validation for inbound messages link
  trading partner validation for outbound messages link

Execution engine
  APIs link

Execution Engine Processing Sequence link

F

FND Lookup link
FND Message ID link
Forecast link link
Forms
  Define Lookup Values link
  Define Transactions link
  Define XML Standards link
  Hub Definitions link
  Standard Code Conversion link
  Trading Partner Code Conversion link
  Trading Partner Setup link

Functions (Workflow)
  XML Gateway Error Processing Item Type link
    ECX Reprocess Inbound link
    ECX Resend Outbound Message link
    ECX Timeout Value link
    Error Still Active link
    Get ECX In Error Details link
    Get ECX Out Error Details link
    Get System Administrator Role link
    Get Trading Partner Role link
    Get Transaction Owner Role link
  XML Gateway Standard Item Type link
    Consume XML Document link
    Generate Trading Partner XML Document link
    Generate XML Document link
    Send Document link
    Transaction Delivery Required link

FYI Delivery Error Process link

G

General processing errors link
Generate Trading Partner XML Document link
Generate XML Document Function link
Generic Receive Event link
Get ECX In Error Details Function link
Get ECX Out Error Details Function link
Get System Administrator Role Function link
Get Trading Partner Role Function link
Get Transaction Owner Role Function link

H

HTTP status codes link
Hub Definitions Form link
Hub Entity Code link
Hub Errors link

I

Implementation Checklist link
Implementing Notification Processing for a New Collaboration link
Inbound Message Queue link link
inbound messages
  required communications data link

Inbound processing errors link
Inbound Trading Partner Message link
Inbound Transaction Queue link link
Internal Control Number link
inventory report link
IP_08 link
item master link
Item Type
  components of link
  identifying seeded link

Item Types
  E-Business Suite Application Module-Specific Item Type link
  XML Gateway Error Processing Item Type link
  XML Gateway Standard Item Type link link

L

Level Mapping Guidelines
  collapsing levels link
  discontinuous nodes link link
  expanding levels link
  OAG DTDs link

Level Mapping Tab link
Lookup Types
  XML Gateway Error Processing Item Type
    ECX Inbound Error Actions link
    ECX Outbound Error Actions link
    ECX Outbound Error Types link
  XML Gateway Standard Item Type
    send mode link

Lookup Values
  defining link

M

Map Action Editor link
  action level and action stage combinations link
  invoking link

Map analysis
  compare database views to DTD link
  supported actions link

Map Analysis Guidelines
  inbound messages link
  outbound messages link

Map analysis guidelines
  comparing database views to DTD link
  inbound message checklist link

Map Analysis Guidelines for outbound messages link
Map Analysis overview link
Maps
  downloading link

Menus
  Message Designer
    help menu link

Menus
  Message Designer link

Menus, Message Designer
  file menu link
  Message Designer
    File Menu, properties option link
  view menu link

Message Correlation Error link
Message Delivery Callback link
  block mode link

Message delivery callback link
  how other messaging systems use link

Message Delivery Error (FYI) link
Message Delivery Error Event link
Message Designer
  APIs link

Message Envelope link
Message Format link
message identification number link
Message map and DTD errors link
Message Maps
  loading link

Message Payloads link link link
Messages
  development guidelines for outbound link
  XML Gateway Error Processing Item Type link
    ECX Event Message (FYI) link
    ECX External Event Message (FYI) link
    Inbound Trading Partner Message link
    message template attributes link
    Outbound Trading Partner Message link

messages link
  development guidelines inbound link
  inbound
    required communications data link
  outbound
    required communications data link

Multiple Organizations link

N

Naming Conventions
  transaction type and transaction subtype link

Naming conventions link
Non-OTA servers
  connecting to link

notification link
Notification Action Definitions link link
Notification Actions link
Notification Code
  IP-05 link
  SO_IN03 link

Notification Definition link
Notification Types link
Notifications link
  XML Gateway Error Processing Item Type link
    ECX Event Notification (FYI) link
    ECX External Event Notification link
    Message Delivery Error (FYI) link
    Trading Partner Inbound Error Notification link
    Trading Partner Outbound Error Notification link
    Transaction Owner Inbound Error Notification link

Notify Administrator link
  CLN_ADMINISTRATOR link
  default notification action link
  E-Mail Format link
  User/Roles link

Notify Trading Partner link
  E-Mail Format link

Noun
  setting in OAG standards link

O

OAG link
  recommending changes link

OAG conversions table link
OAG message link
Oracle Applications Manager link
Oracle Business Event System link
Oracle E-Business Suite AQ link
Oracle Purchasing link
Oracle Transport Agent (OTA) link
Oracle XML Gateway link
Oracle XML Gateway Transactions Setup link link link link
oracle.apps.cln.ch.collaboration.addmessage
  Collaboration Detail ID link
  Event Parameters link
  key parameters link

oracle.apps.cln.ch.collaboration.create
  Document Creation Date link
  Document Number link
  Document Owner link
  Document Release Number link
  Document Revision Date link
  Document Revision Number link
  Event Parameters link
  forecast number link
  internal key link
  key parameters link
  Organization ID link
  Partner Document Number link

oracle.apps.cln.ch.collaboration.update
  Collaboration Detail link
  Disposition link
  Doc_Status link
  Document Creation Date link
  Document Number link
  Document Owner link
  Document Release Number link
  Document Revision Date link
  Document Revision Number link
  Event Parameters link
  FND message ID link
  key parameters link
  MSG_Text link
  Organization ID link
  Partner Document Number link

order taker link
OTA
  attachments link
  code connection samples link
    connection over HTTP link
    connection over HTTPS link
  troubleshooting link

OTA message propagation flow link
OTA Protocol link
Outbound Message Queue link link
outbound messages
  required communications data link

Outbound Trading Partner Message link
overview link
owner of the document link

P

parameters link
Pass-Through Messages
  execution engine processing of link
  how to map link

payloads link
PL/SQL link
planner link
Post message
  OTA link

preconfigured notifications link
predefined notification link
preseeded notifications link
PROCESS_PO link
Process_PO message link
Processes
  XML Gateway Error Processing Item Type link
  XML Gateway Standard Item Type link

Profile Options link
  ECX: Log File Path link
  ECX: Maximum XML Size link
  ECX: OAG_LOGICALID link
  ECX: Server Time Zone link
  ECX: System Administrator Email Address link
  ECX: XML Validate Flag link
  ECX: XSLT File Path link
  Enable User Security link
  Maximum Retries link
  Notification Timeout link

Properties Menu Option link
Protocol Type
  and correlation ID link
  in Trading Partner setup link

Protocol types link
Purchase Order link
purchase order link link link link
Purchase Order Approval link
purchase order release link
Purging transaction link

Q

Queues
  definition link
  error link
  inbound link
  inbound message link
  inbound transaction link
  outbound link
  outbound message link
  used by XML Gateway link

R

Raise Business Event link
  ATTRIBUTE1 link
  ATTRIBUTE14 link
  collaboration ID link
  description link
  notification code link
  PARAMETER1 link link
  PARAMETER14 link link
  Standard parameters link
  wf_parameter_list_t link

Raise Document Delivery Event link
Raising Events
  CLN Create Collaboration event link
  Collaboration History Update event link
  ECX Receive Workflow Process link
  Initial Event link
  PO Approval Workflow link
  Raise XML PO event link
  Subsequent Events link

Reading the Debug File link
  CLN debug files link

Receive Error Event link
Receive Send Notification Event link
Receive the inbound subscription error event link
Receive the inbound subscription processing error event link
Response message
  OTA link

Retry link
Routing link
  dynamic link
  static link
  static and dynamic link

Rule Function, Workflow Default link
Rule Function, XML Gateway link

S

Send Document Function link
Server Authentication link
Set up the collaboration events
  Collaboration Event Definition link

Set up the collaboration events and final events
  Collaboration History link

set up the collaborations link
Setting Up a Trading Partner for the Collaboration link
Setting Up Collaboration Events link
Setting Up Collaboration Events and Final Events link
Setting Up Collaborations link
Setting Up Customized Collaborations link
Setting Up Final Collaboration Event
  Collaboration Final Event Definition link

Setting Up FND Lookup Codes and Messages link
  Adding the FND Lookup Codes link
  Adding the FND Messages link

Setting Up New Collaborations link
Setting Up Notification Processing for New Collaborations link
SOAP link
SOAP servlet link
Source Definition Overview link
Source Definition Tab link
SSL
  how to configure for Web services link

Standard Code Conversion Form link
standards used by XML Gateway link
Start Workflow link
  APPLICATION_ID link
  APPLY_HOLD link
  attributes link
  availability of the workflow link
  COLLABORATION_ID link
  COLLABORATION_TYPE link
  defining the notification action link
  HEADER_DESCRIPTION link
  initiate a predefined workflow link
  IP_07 link
  NOTIFICATION_CODE link
  NOTIFICATION_DESCRIPTION link
  REFERENCE_ID link
  STATUS link
  TPA Identification error link
  TRADING_PARTNER_ID link
  TXN_HOLD link
  Workflow Item Type link
  Workflow Process link

Static and Dynamic Routing link
Static Routing link
Status Monitor link
Stylesheets
  loading and deleting link

Supported actions
  map analysis link

System Profile Options link
system.ecxmsg data type link

T

Target Definition link
Target Definition Tab link
Time zones
  set up link
  values for profile option link

Toolbar
  Message Designer link

Trace link
trading partner link link link link
Trading Partner Code Conversion Form link
Trading Partner Errors link
Trading Partner Inbound Error Notification link
Trading Partner Outbound Error Notification link
Trading Partner Setup Form link
  data validation link

Trading Partner User Security link
Trading Partner Validation
  inbound messages link
  outbound messages link

Transaction Delivery Required Function link
Transaction Monitor link
  calling from other applications link
  Details page link

Transaction Owner Inbound Error Notification link
Transaction status
  monitoring link

transaction type link
Troubleshooting
  API-level messages link
  engine-level error messages link
  engine-level errors
    code conversion errors link
    Confirmation BoD errors link
    enqueue/dequeue errors link
    general processing errors link
    hub errors link
    inbound processing errors link
    message map and DTD errors link
    trading partner errors link
    UTL_FILE errors link
    Workflow Business Event System errors link
  HTTP Status Codes link
  manual troubleshooting steps link
  running the ecxver.sql script link
  SSL issues link
  transaction monitor link
  version validation link

Troubleshooting and Debugging Collaboration History link
  debug the workflow link
  debugging a collaboration link
  debugging messages link

U

Understanding Collaboration History link
Understanding XML Gateway Services
  XML Gateway services through SOA Provider link
  XML Gateway services through Web Service Provider link

unique collaboration link
Update Collaboration Event Definition link
Update Collaboration Final Event Definition link
Update Collaboration Property link link
Update Notification Action Header link
Update Notification Definition link
Updating a Collaboration Event Definition link
Updating a Collaboration Final Event Definition link
Using Collaboration History Advanced Search link
Using Collaboration History Simple Search link
Using JMS Queues
  Custom Inbound JMS Queues link
  Custom JMS Queues link
  Custom Outbound JMS Queues link
  Integration Points link
  JMS Integration link
  Overview link

Using the Collaboration Event Definitions Window link
Using the Collaboration Event Details Window link
Using the Collaboration Final Event Definitions Window link
Using XML Gateway Inbound by SOA Provider
  Adding Assign Activities link
  Adding Invoke Activities link
  Adding Partner Links for File Adapter link
  Creating a New BPEL Project link
  Creating a Partner Link link

UTL_FILE errors link

V

Validation
  trading partner for inbound messages link
  trading partner for outbound messages link

Verb
  setting in OAG standards link

Version validation link
Viewing Action Definition Details link
Viewing the Collaboration Event Message link
Viewing the Collaboration Event XML Payload link

W

Web services link
  attachments link
  components link
  Design Time link
  diagnostic tests
    class loader test link
  diagnostics link
  example link
  Prerequisite files link
  process flow link
    inbound link
  Run Time link
  setup steps link
  SOAP servlet link
  WSDL link
  XML Gateway Web services link

WF Send Event link
WF_ERROR Queue link
Wizards
  data definition creation link
  map creation link

Workflow link link
Workflow Administrator link
Workflow Builder
  components of an item type link
  E-Business Suite Application Module-Specific Item Type link
  item types link
  XML Gateway Error Processing Item Type link
  XML Gateway Standard Item Type link link

Workflow Business Event System
  overview of integration link

Workflow Business Event System errors link
Workflow Default Rule Function
  and Trading Partner validation for outbound messages link

Workflow Error Queue link link
Workflow Manager link
Workflow Processes
  monitoring link

workflows link
Working with Key Parameters link
  APPLICATION_ID link
  Collaboration Type link
  Create Collaboration Event link
  Document Direction link
  Document Type link
  DOCUMENT_DIRECTION link
  Internal Control Number link
  TRADING_PARTNER_ID link
  TRADING_PARTNER_SITE link
  TRADING_PARTNER_TYPE link
  UNIQUEID1-5 link
  Update Collaboration Event link
  XML Gateway Message ID link
  XML_INTERNAL_CONTROL_NUMBER link
  XML_INTERNAL_TXN_TYPE link
  XMLG_DOCUMENT_ID link
  XMLG_INTERNAL_TRANSACTION_SUBTYPE link
  XMLG_MESSAGE_ID link

Working with the Collaboration History Events link
  Add message link
  CLN_CH_EVENT_SUBSCRIPTION_PKG.ADDMESSGE_EVENT_SUB link
  CLN_CH_EVENT_SUBSCRIPTION_PKG.CREATE_EVENT_SUB link
  CLN_CH_EVENT_SUBSCRIPTION_PKG.UPDATE_EVENT_SUB link
  Collaboration History Standard Events item type link
  Create link
  Update link
  Workflow Builder link

write into workflow log tables link
WSDL link
  schema structure type link

X

XML Fragment link
XML Gateway link
XML Gateway Error Processing Item Type link link
  events link
    Message Delivery Error link
    Receive Error link
    Receive Send Notification link
    Receive the inbound subscription error link
    Receive the inbound subscription processing error link
  functions link
    ECX Reprocess Inbound link
    ECX Resend Outbound Message link
    ECX Timeout Value link
    Error Still Active link
    Get ECX In Error Details link
    Get ECX Out Error Details link
    Get System Administrator Role link
    Get Trading Partner Role link
    Get Transaction Owner Role link
  lookup types link
    ECX Inbound Error Actions link
    ECX Outbound Error Actions link
    ECX Outbound Error Types link
  message template attributes link
  messages link
    ECX Event Message (FYI) link
    ECX External Event Message (FYI) link
    Inbound Trading Partner Message link
    Outbound Trading Partner Message link
  notifications link
    ECX Event Notification (FYI) link
    ECX External Event Notification link
    Message Delivery Error (FYI) link
    Trading Partner Inbound Error Notification link
    Trading Partner Outbound Error Notification link
    Transaction Owner Inbound Error Notification link
  processes
    Default Error Process link
    ECX Engine Notification Process link
    ECX Error Process for Timeout link
    ECX Main Error Process link
    ECX Main Inbound Error Process link
    ECX Main Outbound Error Process link
    Error Handling for Inbound Messages link
    Error Handling for Outbound Messages link
    FYI Delivery Error Process link

XML Gateway Rule Function
  and Trading Partner validation for outbound messages link

XML Gateway services
  Enabling steps through SOA Provider link
  SOAP Header for XML Gateway Messages through SOA Provider link
  SOAP Header for XML Gateway Messages through Web Service Provider link

XML Gateway Standard Item Type link link
  events link
    Generic Receive Event link
    Raise Document Delivery Event link
    WF Send link
  functions link
  lookup types link
    send mode link

XML message
  reviewing outbound link

XML Payloads link
XSLT stylesheets
  loading and deleting link