Create a Collaboration Message Definition

You can create a collaboration message definition for your trading partner.

Take these steps:

  1. In the Collaboration Messaging work area, click Manage Collaboration Message Definitions.

  2. On the Manage Collaboration Message Definitions page, click Actions > Create Collaboration Message Definition.

  3. In the Create Collaboration Message Definition dialog box, enter the required details.

    • The External Message Definition can be an existing message definition or an external message definition that you created.

    • The Collaboration Document determines whether the external message type will be used for inbound or outbound messaging. For an inbound message, these XPath fields appear:

      • Application Partner Code XPath is the XPath expression that identifies the location of the Oracle Fusion application partner code in a trading partner XML payload. This is used to identify the supplier site ID for the message. If you define an application partner code XPath and provide a value for the application partner code in the payload, it's used to find the supplier site ID for the message. If you leave the Application Partner Code XPath field blank, the application retrieves your supplier site ID if you enabled Retrieve supplier site from PO for Process Invoice Inbound and Process Shipment Inbound in Setup and Maintenance > Manage Collaboration Messaging Configuration > Business Process Setup > Configuration Collaboration Documents.

      • Object Key XPath is an XPath expression that identifies the location of the object key in an XML payload. For example, invoice number is the object key in the invoice XML file. You should provide values for the Object Key XPath and for the Object Key in your payload because that information is logged and helps you find associated messages on the Manage Collaboration Messaging History page.

      • Reference Object Key XPath is an XPath expression that identifies the location of the reference object key in an XML payload. For example, the purchase order number is the reference object key in the invoice XML file or in the shipment XML file. You should provide values for the Reference Object Key XPath and for the Reference Object Key in your payload because that information is logged and helps you find associated messages on the Manage Collaboration Messaging History page.

    • Select an XSL File for your collaboration message transformation.

    • Select a Payload Template to be used when validating an inbound or an outbound document set up.

  4. Click Save and Close.

    The message definition name is suffixed with _CUST.

This table describes the fields you need to enter to create a collaboration message definition.

Field

Description

Name

Name of the collaboration message definition.

External Message Definition

An external message definition is a representation of a document type in a specific format, the list displayed may be either user defined or predefined.

Messaging Standard

A unique name for a group of messages defined by an organization or entity, for example, OAG.

Version

Version of the standard being used.

Message Type

A unique XML schema definition for a document type. It's the root element of the payload.

Message Subtype

A unique value to identify a message when many messages have the same root element.

Collaboration Document

The collaboration document to which you map the external message type. It may be inbound or outbound. A collaboration document is the Oracle Fusion definition of a business message.

Description

Description for the collaboration message definition.

Application Partner Code XPath

An XPath expression that identifies the location of the Oracle Fusion application partner code in a trading partner XML payload.

Object Key XPath

An XPath expression that identifies the location of the object key in an XML payload. For example, invoice number is the object key in the invoice XML file.

Reference Object Key XPath

An XPath expression that identifies the location of the reference object key in an XML payload. For example, purchase order number is the reference object key in the invoice inbound XML file or in the shipment inbound XML file.

XSL File

The file used for the transformation.

Payload Template

An XML sample that's used for testing or validating the message set up.