13Collaboration Messaging

This chapter contains the following:

Use Oracle Fusion Collaboration Messaging Framework to enable Oracle Applications Cloud establish business-to-business (B2B) messaging capabilities with trading partners.

Using this framework, you can send and receive real-time transactional messages without building new SOA components. You can use the existing B2B functionality to exchange messages with collaborators such as suppliers either directly or using an intermediary agency such as a B2B Service Provider.

The framework supports transformation of a B2B document, such as a purchase order, between the Oracle Applications Cloud format and an external message format supported by the trading partner. When you send messages to partners or receive messages from them, the framework performs the required transformation.

The following figure illustrates how Collaboration Messaging Framework delivers a message to the intended recipient.

A representation of the Collaboration Messaging
Framework functionality.

Using collaboration messaging involves performing the following high-level tasks:

  • Setting up external (B2B) trading partners and their messaging capabilities.

  • Cross-referencing the Oracle Applications Cloud definition of a trading partner (such as a supplier) with the external trading partner definition setup earlier. Also, selecting the messages that must be enabled with the partner.

  • Configuring the message delivery method for the partner.

To open the Collaboration Messaging Framework Overview page, click the Navigator menu and select Collaboration Messaging.

Use the Collaboration Messaging Framework Overview page to:

  • Manage undelivered collaboration messages

  • Reprocess failed collaboration messages

  • Manage collaboration messaging history

  • Validate inbound and outbound collaboration messaging setup

Collaboration Messaging Configuration

Define Message Processing and Delivery Method Parameters

By default, Collaboration Messaging Framework stores all source and transformed outbound and inbound documents. This facilitates auditing the documents and reprocessing or resending them when required. So you need to configure how to process outbound messages and types of delivery methods:

  1. In the Setup and Maintenance work area, go to the Manage Collaboration Messaging Configuration task.

  2. In the General Setup tab's Outbound Message Processing section, specify values for:

    Field Description

    Global Sender ID

    Identifies the sender of all outbound messages.

    Global Sender ID Type

    Type of identifier of the Global Sender ID, for example D-U-N-S.

    Maximum attachment size

    Determines the maximum size of embedded attachments that can be included in a message.

    Note: You can set up only invoice and purchase orders to send attachments. Collaboration Messaging Framework takes into account only the size of the attachments, not the size of the message.

    When Collaboration Messaging Framework doesn't send attachments because they exceed the maximum size, the buyer associated with the purchase order is notified that all attachments weren't sent.

  3. In the Delivery Method Types section, specify a value for Maximum Message Size MB for your Delivery Method Type.

    Here, the maximum value specified refers to the size of the message plus the size of the attachment. Collaboration Messaging Framework doesn't process messages that exceed the maximum size for a delivery method. It logs the status as Error/Failed.

  4. Click Save and Close.

    If you need to stop storing the source and transformed outbound and inbound documents according to your business requirements, disable the options that you do not need in the Message Storage section in the General Setup tab.

    Note that if you disable the Store outbound source document check box, you can't reprocess existing messages.

Set Up a Business Process

You can enable Oracle Fusion Collaboration Messaging Framework for these business processes:

  • Procure to Pay

  • Supply Chain Operations

  • Order to Cash

  • Brazil Electronic Invoicing

    The collaboration business processes are enabled by default and have collaboration documents associated with them. For the collaboration documents, you can configure additional details. For example, you can enable embedding attachments in an XML message for a purchase order outbound message.

    1. In the Setup and Maintenance work area, go to the Manage Collaboration Messaging Configuration task in the Suppliers or Customers functional area, and then to the Business Process Setup tab.

    2. Select a collaboration business process and an associated collaboration document and, in the Configure Collaboration Documents section, click Configure Additional Details.

      Note: If you disable a business process then the application does not send or receive outbound and inbound messages

Inbound Collaboration Messages

After you set up an application partner, such as a supplier site, you can send a test inbound message to verify if the setup is appropriate for messaging. Use the Validate Inbound Collaboration Messaging Setup task on the Collaboration Messaging Overview page to validate an inbound message.

All messages that go through the validation process queue up and appear on the Collaboration Messaging History page. There you can examine the details of each processed message to check if it was transformed and processed as intended.

  1. On the Overview page, click the tasks icon to view the tasks, and select the Validate Inbound Collaboration Messaging Setup task.

  2. Select the service provider and the partner ID from whom you expect to receive the collaboration message.

  3. Click Next.

  4. On the Validate Inbound Collaboration Messaging Setup page, enter the required details.

    For Processing Service, if your external message standard is OAGIS, select any processing service from the drop-down list per your requirement. If the standard is not OAGIS, select CollaborationMessageV2.Process or CollaborationMessageV2.ProcessAsync per your requirement.

  5. Click Next.

  6. Click Create Message Payload. The message payload is generated in XML format and appears in the text box.

  7. Update the generated payload or replace it with the XML payload that you want to test.

  8. Examine the elements of the message payload. The following table contains an example of the mapping between the elements and actual data for OAGIS messages.

    XML Element Corresponding Information

    <Sender>

    The ID of the partner who sent the document.

    <Intermediary>

    Contains the ID of the service provider.

    <Receiver>

    Contains the ID of the recipient.

    <BODID>

    An ID that the sender assigns to the message.

  9. Click Process. A confirmation message appears. Click Next.

  10. The Collaboration Message page appears. Click Refresh, if the required.

  11. Click Done.

To view the processed message again, search for it on the Manage Collaboration Messaging History page. In the search results, click the generated message ID to view its details.

Outbound Collaboration Messages

After you set up an application partner, such as a supplier site, you can send a test outbound message to verify if the setup is appropriate for messaging. Use the Validate Outbound Collaboration Messaging Setup task on the Collaboration Messaging Framework Overview page to validate an outbound collaboration message.

All messages that go through the validation process queue up and appear on the Collaboration Messaging History page. There you can examine the details of each processed message to check if it was transformed and processed as intended.

  1. On the Collaboration Messaging Framework Overview page, click the tasks icon to view the tasks, and select the Validate Outbound Collaboration Messaging Setup task.

  2. On the Validate Outbound Collaboration Messaging Setup page, select the relevant document. The related details appear.

  3. Select the supplier. The related details, such as the supplier site and service provider appear.

  4. Click Create Message Payload. The message payload is generated in XML format and appears in the text box.

  5. Update the generated payload or replace it with the XML payload that you want to test.

  6. Click Process. The generated message ID appears on the page.

  7. Click View Collaboration Message to view the processed message.

  8. Click Done.

To view the processed message again, search for it on the Manage Collaboration Messaging History page. In the search results, click the message ID to view its details.

Tip: If the message processing fails, you can view the reason for it on the Manage Failed Collaboration Messages page.

Any inbound or outbound message that isn't processed because of some error, remains undelivered. You can view the undelivered messages on the Collaboration Messaging Framework Overview page. For each undelivered message, you can diagnose the errors, take corrective action, and resubmit a request to deliver it again.

To reprocess an undelivered messages:

  1. On the Collaboration Messaging Framework Overview page, click the tasks icon to view the tasks, and select the Manage Undelivered Collaboration Messages task.

  2. On the Manage Undelivered Collaboration Messages page, search for the undelivered message. The message is listed in a table.

  3. Click the message row to view the reason for delivery failure. The details appear in Processing History.

    Tip: Click the message ID link to view the setup details of the message.
  4. Take the required corrective action and return to the Collaboration Messaging Framework Overview page.

  5. Select the specific message and click Reprocess. If there are no further problems, the message is submitted for delivery.

Collaboration Messages

To configure a message for a predefined service provider, do the following:

  1. Open the Manage Collaboration Messaging Service Providers page and search for a predefined service provider.

  2. Click Actions > Edit.

  3. On the Edit Collaboration Messaging Service Provider page, do one of the following:

    • On the Outbound Collaboration Messages tab, click Duplicate Outbound Collaboration Message.

    • On the Inbound Collaboration Messages tab, click Duplicate Inbound Collaboration Message.

  4. Change the status of the pre-seeded message to Inactive so that you can make active or loopback the duplicate message.

  5. Change the duplicate message's status to Active or Loopback, based on business rule.

  6. Click Save and Close.

  7. Click the Manage B2B Trading Partners task.

  8. Create or edit a trading partner.

  9. Set up the document corresponding to the pre-seeded message that you duplicated.

  10. Click the Manage Customer Collaboration Configuration or the Manage Supplier Collaboration Configuration task.

  11. Search for the relevant customer or supplier and associate the service provider with your trading partner.

  12. Associate the document with your customer or supplier.

  13. Validate the configuration.

After validating the configuration, go to Manage Collaboration Messaging History > Configuration > Transformation and confirm that User Defined is selected in Collaboration Definition in the Transformation section.

To configure a message for a predefined service provider, do the following:

  1. In the Collaboration Messaging Framework work area, click Manage Collaboration Messaging Service Providers in the Tasks panel.

  2. Open the Manage Collaboration Messaging Service Providers page and click Actions > Create.

  3. On the Create Collaboration Messaging Service Provider dialog box, enter the required details, and click Save and Close.

  4. Search for the service provider that you created, select it, and click Actions > Edit.

  5. On the Edit Collaboration Messaging Service Provider page, in the delivery Methods tab, click Actions > Add Row.

  6. Enter the name of the delivery method, select the delivery method type, and enter the other required details. Optionally, specify an alternate delivery method to be used if the maximum size for the primary delivery method type may exceed its limit.

  7. If the Delivery Method Type is Web Service, do the following:

    • In the service Name column, for a predefined message template select Collaboration Message.Process or Collaboration Message.ProcessAsync. For a user-defined message template select Collaboration MessageV2.Process or Collaboration MessageV2.ProcessAsync.

    • Select the Security Policy.

  8. On the Outbound Collaboration Messages tab, click Actions > Add Row, and add the outbound collaboration message details.

  9. On the Inbound Collaboration Messages tab, click Actions > Add Row, and add the inbound collaboration message details.

  10. Click Save and Close.

  11. Click the Manage B2B Trading Partners task.

  12. Create or edit a trading partner.

  13. Set up the document corresponding to the message that you created.

  14. Click the Manage Customer Collaboration Configuration or the Manage Supplier Collaboration Configuration task.

  15. Search for the relevant customer or supplier and associate the service provider with your trading partner.

  16. Associate the document with your customer or supplier.

  17. Validate the configuration.

After validating the configuration, go to Manage Collaboration Messaging History > Configuration > Transformation and confirm that User Defined is selected in Collaboration Definition in the Transformation section.

A service provider is an intermediary for exchanging messages between Oracle Applications Cloud and trading partner. Whenever you set up a trading partner, you can link it with a service provider.

Note: You must be signed in as a supplier and must have access to the Supplier task.
  1. In the Procurement work area, go to Suppliers.

  2. On the Supplier Overview page, navigate to the Supplier Business Classifications section and click the supplier.

  3. On the Edit Supplier page, switch to the Sites tab and click the required site.

  4. On the Edit Site page, select Collaboration Messaging Framework as the channel for B2B Communication.

  5. In Associated Collaboration Documents, click Manage Trading Partners.

  6. On the Manage Trading Partners dialog box, click Create > Create Trading Partner with Service Provider.

  7. On the Create Trading Partner dialog box, fill the required details.

  8. Click Actions > Add Row and fill the details to associate collaboration documents with the trading partner. You may add multiple documents.

    Note: To enable exchange of messages, you must set the collaboration document status to Active.
  9. Click Save and Close.

  10. On the Manage Trading Partners dialog box, click OK.

  11. On the Edit Site page, click Save and Close.

  12. On the Edit Supplier page, click Save and Close.

To update the details for a trading partner, use the edit option on the Manage Trading Partners dialog box.

You can exchange messages with a trading partner directly, without using a service provider.

Note: You must be signed in as a supplier and must have access to the Supplier task.
  1. On the Supplier Overview page, navigate to the Supplier Business Classifications section and click the supplier.

  2. On the Edit Supplier page, switch to the Sites tab and click the required site.

  3. On the Edit Site page, select Collaboration Messaging Framework as the channel for B2B Communication.

  4. In Associated Collaboration Documents, click Manage Trading Partners.

  5. On the Manage Trading Partners dialog box, click Create > Create Trading Partner without Service Provider.

  6. On the Create Trading Partner dialog box, fill the required details.

    Note: By default, the Service Provider is set to None because this setup doesn't involve a service provider.
  7. Click Actions > Add Row and fill the delivery method, outbound collaboration message, and inbound collaboration message details on the respective tabs.

    Note: The following table contains some tips on filling the important information on each tab.
    Tab Details

    Delivery Methods

    • Provide the endpoint URL and the associated authentication credentials to initiate the collaboration messaging web service. It must be in the format http://<server>:<port>/<context>, where <context> contains the name of the web service as defined in the application.

    Outbound Collaboration Messages

    • Specify a unique name and select the collaboration message. The associated details automatically appear in the row.

    • Select a delivery method.

    • Set the outbound collaboration document status to Active or Loopback.

    Inbound Collaboration Messages

    • Specify a unique name and select the collaboration message. The associated details automatically appear in the row.

    • Specify an XPath that identifies the application partner in the inbound collaboration document.

    • Set the inbound collaboration document status to Active or Loopback.

  8. Click Save and Close.

  9. On the Manage Trading Partners dialog box, click OK.

  10. On the Edit Site page, click Save and Close.

  11. On the Edit Supplier page, click Save and Close.

To update the details for a trading partner, use the edit option on the Manage Trading Partners dialog box.

User-Defined Messages

You can use the collaboration message service, CollaborationMessageV2.Process, to process user-defined inbound messages.

Process User-Defined Messages

Here's what you need to do to process user-defined inbound messages:

  1. Create an external message type definition.

  2. Create a collaboration message definition.

  3. Create a trading partner.

  4. Set up an application partner.

  5. Run the inbound collaboration messaging process, CollaborationMessageV2.Process.

To set up collaboration messaging, you must associate the supplier site with a trading partner, and select the documents you want to exchange with that partner. The documents that you set up here are associated with trading partners or the service providers of those trading partners.

Note: You must be signed in as a supplier and must have access to the Supplier task.
  1. On the Supplier Overview page, navigate to the Supplier Business Classifications section and click the supplier link.

  2. On the Edit Supplier page, switch to the Sites tab and click the required site.

  3. On the Edit Site page, select Collaboration Messaging Framework as the channel for B2B Communication.

  4. In Associated Collaboration Documents, click Edit.

  5. On the Edit Associated Collaboration Documents dialog box, click Add Row and fill the details required to set up the document. The read-only particulars appear based on the selected details.

  6. Click Save and repeat the steps to add more documents or click Save and Close to return to the previous page.

  7. On the Edit Site page, click Save and Close.

  8. On the Edit Supplier page, click Save and Close.

Enable or Disable Processing of Attached Documents

You can globally enable or disable processing of documents attached to emails that can be sent to or received by trading partners. Do the following:

  1. In the Setup and Maintenance work area, go to the following:

    • Offering: Manufacturing and Supply Chain Materials Management

    • Functional Area: Suppliers

    • Task: Manage Collaboration Messaging Configuration

  2. On the Manage Collaboration Messaging Configuration page, click the Business Process Setup tab.

  3. Select the relevant collaboration business process, for example, Procure to Pay or Order to Cash.

  4. On the same page, in the Configure Collaboration Documents section, select the relevant document and click Configure Additional Details.

    The document must be enabled for additional configuration.

  5. In the window that appears, enable the Embed Attachments in the XML Message check box and click OK.

  6. The application returns to the Manage Collaboration Messaging Configuration page. Click Save and Close.

  7. Create or edit a trading partner and associate the trading partner with a supplier site.

  8. Validate the outbound collaboration messaging setup.

This is how you can set up a user-defined external message type definition:

  1. Create an external message definition.

  2. Add a message standard lookup code.

  3. Create a collaboration message definition for your trading partner.

  4. Create a generic XSLT file for message transformation.

Create an External Message Type Definition

Here's what you can do to create an external message type definition:

  1. In the Collaboration Messaging Framework work area, click Manage External Message Definitions from the Tasks pane.

  2. On the Manage External Message Definitions page, click Actions > Add Row and enter the required details, which are described in the next table.

    • Select an existing messaging standard or, if you want to use a different one, you can add it.

    • If you leave the Identification XPath field blank, when the root element is the same for more than one message, Collaboration Messaging Framework searches for the Identification XPath for the location of the document subtype in the payload to process the message. If the XPath is blank, the message isn't processed and an error is logged.

    • If you leave the Message Identifier XPath field blank, Collaboration Messaging Framework doesn't log the value for the sender's message identifier.

  3. Click Save and Close.

    Note: After you create an external message type definition, you create a collaboration message definition and upload an XSLT file for message transformation from the new external message type definition to the collaboration document. You can do this using the Manage Collaboration Message Definition task.

This table describes the fields you use to create an external message type definition.

Field Description

Name

The name of your external message type definition.

User Defined

Indicates that you created the external message definition.

Document Type

Standards-neutral representation of a message, for example, the document created or received by Oracle Fusion applications such as Process Purchase Order.

Message Type

The root element of the XML payload. It's associated with a messaging standard and version.

Messaging Standard

List of accepted message formats. You can add your own standards.

  • OAGIS (Open Applications Group Integration Specification)

  • OAG (Open Applications Group)

  • Oracle Collaboration Messaging (to send and receive messages using a standard web service)

  • SEFAZ (standard format defined by the Brazil tax authority for tax compliance)

  • UBL

  • cXML

Document Subtype

The type of the root element that defines the XML format of the message, for example, the root element of the payload could be Collaboration Message and the document subtype could be ProcessPurchaseOrder.

Version

The version of the messaging standard.

Identification XPath

The XPath to navigate to the document subtype specified in the XML payload. You need to specify this when the message type or root element of the XML payload is the same for more than one message.

Message Identifier XPath

The XPath to navigate to the sender's message ID in the XML payload. Collaboration Messaging Framework logs the sender's message ID, which appears on the Manage Collaboration Messaging History page.

Add a Message Standard Lookup Code

Here's how you add a message standard lookup code:

  1. In the Setup and Maintenance work area, go to the Manage Standard Lookups page and search for the Lookup Type ORA_CMK_EXT_MESSAGE_STANDARD.

  2. In the ORA_CMK_EXT_MESSAGE_STANDARD: Lookup Codes section, click Actions > New and add your message standard.

  3. Click Save and Close.

Create a Collaboration Message Type Definition for Your Trading Partner

Here's what you do to create a collaboration message type definition for your trading partner:

  1. In the Collaboration Messaging Framework 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 type definition or the message type definition that you created.

    • The Collaboration Document field determines whether the external message will be inbound or outbound. If it's an inbound message:

      • Application Partner Code XPath is an XPath expression that identifies the Oracle Fusion application partner code in a trading partner XML payload.

      • Object Key XPath is an XPath expression that identifies the object key in an XML payload. For example, Invoice number is the object key in the invoice XML file and the original message ID in Confirm Bod Messages.

      • Reference Object Key XPath is an XPath expression that identifies 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.

    • Select an XSLT file for your collaboration message transformation.

    • Select a payload template to validate inbound or outbound documents.

  4. Click Save and Close.

Create a Generic XSLT File for Message Transformation

This is how you create a generic transformation XSLT file for message transformation:

  1. In the Collaboration Messaging Framework work area, click Manage Collaboration Message Definitions from the Tasks panel.

  2. On the Manage Collaboration Message Definitions page, search for the message type definition you created for your trading partner.

  3. Select the message type definition and click Actions > Export Transformation Package.

  4. Add the CollaborationMessagingCommonComponents.xsd and ProcessOutboundCollaborationMessage.xsd files into the xsd/target folder and delete the other XSDS files.

  5. Copy the new B2B standard message XSD file into the xsd/target folder.

  6. Open the root transformation package folder and then the xsl folder.

    • Rename the XSL file appropriately.

    • Rename the XSD file, per the file you copied into the xsd/target folder, in the target schema location.

  7. Delete all the content under <xsl:template match="/"> and all templates that were created outside <xsl:template match="/">.

  8. Close </xsl:template>.

    You can ignore any additional namespace declarations.

  9. Open the XSL style sheet in a development environment tool such as Oracle JDeveloper and map the required elements.

Overview of Importing Collaboration Messaging Setup Data

You can import Collaboration Messaging Framework setup data or you can migrate your Oracle B2B setup data into Collaboration Messaging Framework for trading partners that use a service provider. The service provider, with delivery method, and inbound and outbound collaboration messages, must already be set up in the environment into which you import the data.

If you want to import your Collaboration Messaging Framework setup data, you need to create a ZIP file that contains two CSV files with these names:

  • CmkConfigImportPartners.csv: This file contains information about trading partners.

  • CmkConfigImportDocs.csv: This file contains the documents that are set up for the trading partner.

You need to upload both the files to the scm$/B2BConfigurationImport$/import$ account and then follow the procedure in the Import Collaboration Messaging Setup Data section.

You can migrate your Oracle B2B setup data and update Oracle Fusion application setup in these scenarios:

  • Data of Oracle Supplier Network Trading Partners

  • Data of non-Oracle Supplier Network Trading Partners (a single trading partner, set up with many B2B Supplier site codes)

  • Data of non-Oracle Supplier Network Trading Partners (many trading partners, each with a single B2B Supplier site code)

To migrate the data you have to first export your B2B configuration data using the B2B export feature, which creates a compressed file that contains all the B2B set up data, and upload the file into the scm$/B2BConfigurationImport$/import$ account.

Then you need to use two scheduled processes to create a collaboration messaging setup data import file and then import the collaboration messaging setup data. And then you need to review the imported data using the Manage Collaboration Messaging Setup Data Import task.

Using this task, you can associate a customer account with an existing trading partner and select the collaboration messaging documents to be exchanged with the customer.

To configure collaboration messaging for a customer:

  1. On the Collaboration Messaging Overview page, click the Tasks icon, and select the Manage Customer Collaboration Configuration task.

  2. Search for the customer account, select the row, and click Edit Collaboration Configuration.

  3. In Associated Service Providers, click Actions - Add Row and fill the details of the service provider and the trading partner.

  4. Click Actions - Add Row and select at least one collaboration document.

  5. Set the Association Status to Active to enable messaging with the selected service provider.

  6. Click Save and Close.

To identify the address of the ship-to and bill-to site for inbound order processing, you can enter a location code for the address of each of your customer sites.

Add a B2B Location Code

Here's how you can add a B2B location code:

  1. In the Collaboration Messaging Framework work area, click Manage Customer Collaboration Configuration in the Tasks panel.

  2. Select Order to Cash as the Collaboration Business Process, enter a Customer Name or a Customer Number, and search for your customer.

  3. Select the row for the customer you want to associate with a trading partner and click Manage B2B Location Codes.

  4. On the Manage B2B Location Codes page, click Add Locations.

    The page displays customer sites that don't already have a location code associated with them.

  5. Select the site you want and click Add.

  6. Click Save and Close.

Edit a B2B Location Code

To edit a B2B location code for a customer site, click Manage B2B Location Codes, delete the row for your customer site, and add it again with a new B2B Location Code value.

Import B2B Location Codes

As an alternative to adding B2B location codes using the Manage B2B Location Codes tab, you can also import B2B locations using a CSV file.

The CSV file must have three columns of data with these column headers specified:

Column Header Description

CustomerNumber

Identifies the customer number

PartySiteNumber

Identifies the customer site number

LocationCode

Identifies the B2B location code

Collaboration Messaging Framework identifies the columns regardless of the order in which you enter them.

Here's how you upload the CSV file to import B2B locations:

  1. In the Collaboration Messaging Framework work area, click the Manage Customer Collaboration Configuration task.

  2. Click Import B2B Location Codes.

  3. Browse and select the CSV file, and click OK.

    A message displays the scheduled process identifier, which you can use to review the status of the import process from Scheduled Processes.

  4. On the Manage Customer Collaboration Configuration page, click Done.

    Note: You can submit the process for importing B2B location codes only by using the Manage Customer Collaboration Configuration task > Import B2B Location Codes.

Using this task, you can configure a customer account to setup delivery of XML payload for the outbound messages and receive confirmation for the inbound messages.

To configure collaboration messaging for a customer account:

  1. On the Collaboration Messaging Overview page, click the Tasks icon, and select the Manage Customer Account Collaboration Configuration task.

  2. Search for the business process, select the customer account row, and click Edit Collaboration Configuration.

  3. In Associated Service Providers, click Actions - Add Row and fill the details of the service provider and the trading partner.

  4. In Collaboration Documents for Service Provider, click Actions - Add Row and select at least one collaboration document.

    Note: To select a collaboration document for the service provider, the associated trading partner must have either process invoice outbound document or confirm message receipt inbound document configured.
  5. Set the Association Status to Active to enable messaging with the selected service provider.

  6. Click Save and Close.

Send an Outbound Message to Multiple Trading Partners

To send an outbound message to multiple trading partners, that is, suppliers or service providers, you must associate the trading partners with the outbound message and ensure that only one of them is the primary recipient of the message. Do the following:

  1. On the Collaboration Messaging Overview page, click the Tasks icon, and then click one of the following:

    • Manage Customer Collaboration Configuration

    • Manage Supplier Collaboration Configuration

    • Manage Customer Account Collaboration Configuration

  2. Enter the required values and click Search.

  3. From the search results, select a customer or supplier and click Edit Collaboration Configuration.

  4. On the page that opens, using the Edit Associated Collaboration Documents dialog box, set up multiple associated service providers and associate the relevant document with the service providers.

  5. Select the service provider that you want as the primary recipient and then in the Collaboration Documents for Service Provider section, select the Primary Recipient check box.

  6. Click Save and Close.

  7. Validate the configuration.

The OAGIS XML B2B message can be delivered as an email attachment to your trading partners. Using this task, you can configure the subject and body of the email.

To configure email properties for an outbound message:

  1. In the Collaboration Messaging Overview work area, click Manage Collaboration Message Definitions in the Tasks panel.

  2. Search for the outbound messages, select the collaboration message row, and click Actions > Configure Email Properties.

  3. On the Configure Email Properties dialog box, fill the required details. such as the default text for the subject line, the XPath that identifies the email ID of the recipient, and the header and column titles in the email body.

    Note: The email body content can be configured to have only header, only column table, or both header and column table.

    The following figure is a sample email format.

    A sample email format.
  4. Click Save and Close.

How Documents are Sent as Email Attachments to Trading Partners

You can send documents as email attachments to trading partners, with or without service providers. To do so, you have to do the following high-level tasks:

  1. Configure email properties of collaboration messages for trading partners.

  2. Configure email properties for the trading partner.

  3. Associate collaboration documents with the trading partner.

  4. Validate the outbound message configuration.

Configure Email Properties of Collaboration Messages for Trading Partners

To configure messaging email properties for trading partners, do the following:

  1. In the Collaboration Messaging work area, click the Manage Collaboration Message Definitions task from the Tasks panel.

  2. On the Manage Collaboration Message Definitions page, search for the outbound message definition with the following criteria:

    • Direction: Outbound

    • Name: AnyType_PO_CollabMsg

  3. In the Collaboration Message Definitions section, select the message definition and click Actions > Configure Email Properties.

  4. In the Configure Email Properties window, enter My email as the Default Subject Line, leave Recipient Email ID XPath blank, and then click Save and Close.

  5. On the Manage Collaboration Message Definitions, page. Click Done.

Configure Email Properties for the Trading Partner

To configure email properties for a trading partner, do the following:

  1. In the Collaboration Messaging work area, click the Manage B2B Trading Partners task from the Tasks panel.

  2. On the Manage B2B Trading Partners page, click Actions > Create.

  3. In the Create Trading Partner window, specify the following details:

    • Service Provider: None

    • Trading Partner ID: For example, AnyTypeEmailNone_TPA

    • Partner ID Type: Generic

  4. Click Save and Close.

  5. On the Edit Trading Partner page, click Actions > Add Row in the Delivery Methods tab.

  6. Specify the following values:

    • Name: For example, AnyTypeEmailNone_TPA

    • Delivery Method Type: Email

    • Recipient Email ID: A valid email address, for example, my.email@oracle.com.

      Enable Attach XML Message.

  7. Open the Outbound Collaboration Messages tab, click Actions > Add Row, and then specify the following values:

    • Name

    • Collaboration Message: For example, AnyTypeEmailNone_TPA

    • Delivery Method Name: For example, AnyTypeEmailNone_TPA1

  8. Click Save and Close.

Associate Collaboration Documents with the Trading Partner

To associate collaboration documents with a trading partner, do the following:

  1. In the Collaboration Messaging work area, click one of the following, as required, from the Tasks pane:

    • Manage Customer Collaboration Configuration

    • Manage Supplier Collaboration Configuration

    • Manage Customer Account Collaboration Configuration

  2. Search for a, customer, supplier, or site to configure using the Business Process or Customer Name, or Supplier or Site name fields.

  3. Select the relevant customer or supplier, click Edit Collaboration Configuration, and specify the following values:

    • Service Provider: None

    • Trading Partner ID = For example, AnyTypeEmailNone_TPA

  4. On the same page, in the Collaboration Documents for Service Provider section, add the document PROCESS_PO_OUT and set Association Status to Enabled.

  5. Click Save and Close.

You can specify a default value or identify a field as required for any outbound or inbound message setup for a trading partner.

Configure Rules for a Trading Partner Without a Service Provider

For a direct trading partner:

  1. In the Collaboration Messaging work area, click Manage B2B Trading Partners in the Tasks panel.

  2. On the Manage B2B Trading Partners page, select Service Provider as None and click Search.

  3. Select a row in the search results and click Actions > Edit.

  4. On the Edit Trading Partner page, select Item: Outbound Collaboration Messages or Item: Inbound Collaboration Messages.

  5. Select the message you want to edit and click Actions > Manage Message Processing Rules.

  6. In the Manage Message Processing Rules dialog box, do the following.

    1. Specify:

      Name: The name of the message rule.

      NodeXPath: The XPath of the message payload.

    2. Either select the Required check box or enter a value in the Default Value field.

    If you select the Required check box, Oracle Applications Cloud ensures that the XPath location is present in the message payload.

    If you enter a value in the Default Value field, Oracle Applications Cloud uses the value while processing if the message does not contain any value for the specified XPath location.

Configure Rules for a Service Provider

You can configure processing rules for transforming business-to-business (B2B) documents accurately.

For a service provider:

  1. In the Collaboration Messaging work area, click Manage B2B Trading Partners in the Tasks panel.

  2. On the Manage B2B Trading Partners page, select a Service Provider and click Search.

  3. On the Edit Trading Partner page, select a document and click Actions > Manage Message Processing Rules.

  4. In the Manage Message Processing Rules dialog box, do the following.

    1. Specify:

      Name: The name of the message rule.

      NodeXPath: The XPath of the message payload.

    2. Either select the Required check box or enter a value in the Default Value field.

    If you select the Required check box, Oracle Applications Cloud ensures that the XPath location is present in the message payload.

    If you enter a value in the Default Value field, Oracle Applications Cloud uses the value while processing if the message does not contain any value for the specified XPath location.

Message Transformation Rules

For external partner messages, you can add user-defined transformation rules such as default values and cardinality to specify whether it's required or optional. For example, to ensure that messages have a response Email address, you can specify it as required or add a default value.

You can setup transformation rules for each message exchanged with a trading partner. These rules are always setup at the trading partner level, and not for the service provider.

Note: Collaboration Messaging Framework processes the rules after transformation for outbound messages and before transformation for inbound messages.

To setup a rule for a trading partner, on the Collaboration Messaging Overview page, click the Tasks panel tab, and select the Manage B2B Trading Partners task. Select the trading partner to edit and click Actions - Manage Message Processing Rules.

The transformation rules specified on the messages are processed as follows:

  • If the message field is configured to use a default value:

    • Uses the value if it exists, otherwise uses the default value.

    • Triggers an error if the default value is missing.

  • If the message field is configured as required:

    • Uses the value if it exists, otherwise triggers an error that a required value is missing.

    • Triggers an error if the required value node is missing.

The following flow illustrates how the transformation rules are processed:

Transformation rules for outbound and inbound messages

Export or Import Collaboration Messaging Configuration Setup Data

To export or import collaboration messaging configuration setup data, you have to do the following. Use your test environment to export the configuration data and use your production environment for the import.

  1. Create an implementation project and add the task name.

  2. Create a configuration package that will use the implementation project for exporting and importing collaboration messaging configuration setup data.

Create an Implementation Project

To create an implementation project, do the following:

  1. In the Setup and Maintenance work area, go to the following:

    • Offering: Manufacturing and Supply Chain Materials Management

    • Task: Manage Implementation Projects

  2. Click Actions > Create, enter the required details, and click Save and Open Project

  3. On the Implementation Project page, click Actions > Select and Add.

  4. In the Select and Add: Task Lists and Tasks dialog box, enter Manage Collaboration Messaging Configuration in the Name field and click Search.

  5. Select the task from the results, click Apply, and then click Done.

  6. On the Implementation Project page, click Done.

Create a Configuration Package

Do the following:

  1. In the Setup and Maintenance work area, go to the following:

    • Offering: Manufacturing and Supply Chain Materials Management

    • Task: Manage Configuration Packages

  2. On the Manage Configuration Packages page, click Actions > Create.

  3. On the Create Configuration Package page, from the Name menu, select the implementation project that you created.

  4. Click Yes on the warning message.

  5. Click Submit.

  6. Click Yes on the warning message.

    The configuration package is added to the Manage Configuration Packages page in the Export and Import Processes section.

Export the Configuration Package

To export the configuration package, do the following:

  1. On the Manage Configuration Packages page, click the Download icon and then click Download Configuration Package.

  2. Extract the content.

  3. Open the folder named businessObjectData.

  4. Decompress the ORA_CMKCOLLAB_MSG_BUS_PROCESS.zip file, and open the ORA_CMKCOLLAB_MSG_BUS_PROCESS folder. It contains three XML files:

    • CollaborationMessagingBusinessProcess.xml: Collaboration Messaging Framework uses this file to configure the collaboration business process.

    • CollaborationMessagingParameters.xml: Collaboration Messaging Framework uses this file to configure collaboration messaging storage.

    • CollaborationMessagingParamsData.xml: Collaboration Messaging Framework uses this file to configure collaboration documents.

Import the Configuration Package

After you complete exporting the configuration package, do the following in your production environment:

  1. Create an Implementation project and configuration package.

  2. Upload the downloaded configuration data (compressed file) using the following XML files. The compressed file to be uploaded should have the exact package structure as the downloaded compressed file.

    • CollaborationMessagingBusinessProcess.xml

    • CollaborationMessagingParameters.xml

    • CollaborationMessagingParamsData.xml

Retrieve Supplier Site Details from a PO for a Procure to Pay Inbound Message: Procedure

You can retrieve supplier site details from a purchase order (PO) for a procure to pay inbound message.

  1. In the Setup and Maintenance work area, go to the following:

    • Offering: Manufacturing and Supply Chain Materials Management

    • Task: Manage Collaboration Messaging Configuration

  2. On the Manage Collaboration Messaging Configuration page, click the Business Process Setup tab.

  3. In the Configure Collaboration Documents area, select PROCESS_INVOICE_IN or PROCESS_SHIPMENT_IN and then click Configuration Additional Details.

  4. In the Process Inbound Configuration window that appears, enable the Retrieving Supplier Site from PO check box and then click OK.

  5. Click Save and Close.

Overview of Setting up an Inbound Confirmation Message

When Oracle Fusion Collaboration Messaging Framework sends any type of outbound message to a partner, the partner may respond with a synchronous or asynchronous confirmation receipt, with the processing status of the message.

A partner can send multiple confirmation messages for an outbound message. You must provide the message ID of the original outbound message in the confirmation receipt for Collaboration Messaging Framework to correlate the confirmation with the original message. If the correlation is successful, Collaboration Messaging Framework logs the confirmation receipt as a new inbound collaboration message.

If communication with the partner is via a service provider, then the service provider must configure the confirmation receipt, and set up confirmation receipt documents for the trading partner. Collaboration Messaging Framework treats the confirmation receipt like any other trading partner inbound message.

You don't have to set up the confirmation documents for the application partner because they're associated with an outbound message (for example, an outbound invoice) that's set up for the partner. So, for example, if an application partner has enabled an outbound invoice, and the trading partner associated with the customer account has the confirmation set up for the outbound invoice, then the confirmation is automatically enabled for the customer account.

You have to set up an inbound confirmation message once for a trading partner or service provider and associate it with multiple outbound messages. Note that the status of a confirmation message is always Active.

Set up an Inbound Confirmation Message

To set up an inbound confirmation message, you have to do the following:

  1. Add a message standard lookup code.

  2. Create an external message definition.

  3. Create a collaboration message definition for your trading partner.

  4. Use the message definition to associate the trading partner with an application partner.

  5. Validate inbound collaboration messaging using the collaboration message processes:

    • ColloborationMessageV2.Process

    • ColloborationMessageV2.AsyncProcess

The Manage Collaboration Messaging History page enables you to search for records of processed outbound collaboration messages.

You can access the Manage Collaboration Messaging History page from the Collaboration Messaging work area by clicking the Manage Collaboration Messaging History task in the Tasks panel.

To view the records you have to do the following:

  1. Configure the trading partner to receive or not receive the confirmation of an outbound collaboration message.

  2. Associate a collaboration documents with the supplier.

  3. Configure the customer account.

  4. Process the outbound collaboration message.

Configure a Trading Partner to Receive or not Receive Confirmation of an Outbound Collaboration Message

Here's what you do to configure a trading partner to receive or not receive confirmation of an outbound collaboration message:

  1. In the Collaboration Messaging work area, click the Manage B2B Trading Partners task.

  2. On the Manage B2B Trading Partners page, click Action > Create.

  3. In the Create Trading Partner window, enter the following details:

    • Service Provider: None

    • Trading Partner ID: TP_Confirm_COL

    • Partner ID Type = Name

  4. Click Save and Close.

  5. On the Edit Trading Partner page, in the Delivery Methods tab, click Actions > Add Row and then enter the following details:

  • Name: Email_TP_Confirm_COL

  • Delivery Method Type: Email

  • Recipient Email ID: <email>@oracle.com

    Enable the Attach Payload check box.

For the trading partner to receive confirmation of messages

Do the following:

  1. Click the Inbound Collaboration Messages tab and then click Actions > Add Row. Then enter these details:

    • Name: TP_Confirm_COL_IN

    • Collaboration Message Definition: OAGIS_10.1_CONFIRM_BOD_COLLAB_MSG_IN

    • Status: Active

  2. Click the Outbound Collaboration Messages tab and then click Actions > Add Row. Then enter these details:

    • Name: TP_Confirm_COL_OUT1

    • Collaboration Message Definition: OAGIS_10.1_PROCESS_PO_COLLAB_MSG_OUT

    • Delivery Method Name: Email_TP_Confirm_COL

    • Status: Active

    • Confirmation Message: TP_Confirm_COL_IN

  3. Click Save and Close.

For the trading partner to not receive confirmation of messages

Here's what you do:

  1. Click the Outbound Collaboration Messages tab and then click Actions > Add Row. Then enter the following details:

    • Name: TP_Confirm_COL_OUT

    • Collaboration Message Definition: OAGIS_10.1_CHANGE_PO_OUT2

    • Delivery Method Name: Email_TP_Confirm_COL

    • Status = Active

      Leave the Confirmation Message column blank.

  2. Click Save and Close.

Associate a Collaboration Document with a Supplier

Go to the site for associated collaboration documents of the supplier, and add these documents:

  • PROCESS_PO_OUT

  • PROCESS_RCV_ADV_OUT

  • CHANGE_PO_OUT

Configure the Customer Account

Here's what you do to configure a customer account:

  1. In the Collaboration Messaging work area, click the Manage Customer Account Collaboration Configuration task.

  2. On the Manage Customer Account Collaboration Configuration page, select Order To Cash as the Collaboration Business Process, enter the Customer Name, and then click Search.

  3. On the Customer Accounts search results page, select the customer and click Edit Collaboration Configuration.

  4. On the Edit Customer Account Collaboration Configuration page, in the Associated Service Providers section, click Actions > Add Row and then specify the following details:

    • Service Provider: None

    • Trading Partner ID: TP_Confirm_COL

  5. In the Collaboration Documents for Service Provider section, click Actions > Add Row and then specify the following details:

    • Document: PROCESS_INVOICE_OUT

    • Association Status: Disabled

  6. Click Save and Close.

Process the Outbound Collaboration Message for Confirmation Status Not Required and Confirmation Status Required

Here's what you do:

  1. In the Collaboration Messaging work area, click the Validate Outbound Collaboration Messaging Setup task.

  2. On the Validate Outbound Collaboration Messaging Setup page, specify the following details:

    • Collaboration Business Process: Procure To Pay

    • For Confirmation Status Not Required: Document: CHANGE_PO_OUT

    • For Confirmation Status Required: Document: PROCESS_PO_OUT

  3. Click Next.

  4. On the Validate Outbound Collaboration Messaging Setup: Select Recipient page, select the Supplier Name and click Next.

  5. On the Validate Outbound Collaboration Messaging Setup: Define Payload page, click Create Message Payload and then click Process.

    The outbound message is processed for validation.

  6. Click OK and then click Next.

  7. Note the Collaboration Message ID, view the details after the processing is complete, and then click Done.

Process the Outbound Collaboration Message for Confirmation Status Received

Here's what you do to process the outbound collaboration message for Received confirmation status:

  1. In the Collaboration Messaging work area, click the Validate Inbound Collaboration Messaging Setup task.

  2. On the Validate Inbound Collaboration Messaging Setup: Select Sender page, select these values:

    • Service Provider: None

    • From Partner ID: TP_Confirm_COL

      The application generates the Partner ID Type and External Message ID.

  3. Click Next.

  4. On the Validate Inbound Collaboration Messaging Setup: Select Message page, select these values:

    • External Message Name: OAGIS_10.1_CONFIRM_BOD

    • Collaboration Message Definitions: OAGIS_10.1_CONFIRM_BOD_COLLAB_MSG_IN

    • Processing Service: CollaborationMessageV2.ProcessAsync

  5. Click Next

  6. On the Validate Inbound Collaboration Messaging Setup: Define Payload page, click Create Message Payload.

  7. In the payload area, replace the value for DataArea/Confirm/Original ApplicationArea/BODID with the value for OUT_####.

  8. Click Process and then click OK on the information message window that appears.

  9. Click Next and then click Refresh to view the results.

FAQs for Collaboration Messaging

The following table describes the main differences among the various error statuses.

Error B2B Error Hold

Indicates that the messages haven't been delivered because of a validation, configuration, or processing error in Collaboration Messaging Framework.

Indicates that the B2B component of the SOA suite couldn't deliver the message because of a configuration or processing error.

Indicates that messages haven't been processed because an administrator has put them on hold.

The following table describes the main differences among the message error types.

Document Retrieval Error Inbound Processing Error Outbound Processing Error

Occurs when the collaboration messaging framework fails to retrieve the document associated with a collaboration event.

Occurs when the collaboration messaging framework can't process inbound messages because of setup or business rule validation issues.

Occurs when the collaboration messaging framework can't process outbound messages because of setup or business rule validation issues.

If you don't enable a document type for storage, the message processing and delivery details of such documents aren't stored in the log table.

To know the cause of a message failure, search for the failed message on the Manage Failed Collaboration Messages page.

When you click the message row, the cause of the failure appears in Processing History.

To the see the list of setup data, you must first run the scheduled process to import the data into the staging tables.

After Collaboration Messaging Framework delivers an outbound message and sets the status to Success or Sent, the processing may fail further in the business flow. In such cases, you can resubmit the message from Collaboration Messaging Framework.

You can attach a user-defined XSLT file only to user-defined messages. To create a user-defined message, duplicate a predefined message.

The actions you can perform for the selected messages depend on the message status. For example, if you select messages with Success and Error status, you can't perform any action.

Based on the message status, you can:

  • Resubmit messages with Success or Sent status

  • Reprocess messages with Failed status

  • Cancel messages with Error or B2B Error status

  • Delete messages with Success, Sent, Failed, or Canceled status

You can view the logs on the Message History page.

Go to the Manage Collaboration Message Definitions page, search for a user-defined message, and then click Export Transformation Package.