15Define Collaboration Messaging

This chapter contains the following:

Using Collaboration Messaging: Overview

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

Reprocessing Undelivered Messages: Procedure

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 under 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.

Process Inbound Collaboration Messages

Validating Inbound Collaboration Messaging: Procedure

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. Enter the external message ID.

  4. Select the details pertaining to the External Message Type. The related details, such as document type and messaging standard, appear.

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

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

  7. Examine the elements of the message payload. The following table contains an example of the mapping between the elements and actual data.

    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.

  8. Click Process. The Processing Confirmation message appears.

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

  10. 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.

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

Process Outbound Collaboration Messages

Validating Outbound Collaboration Messaging: Procedure

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.

Manage Collaboration Messages

Creating a Trading Partner with a Service Provider: Procedure

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. 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. Under Associated Collaboration Documents, click Manage Trading Partners.

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

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

  7. 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.
  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.

Creating a Trading Partner without a Service Provider: Procedure

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. Under 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.

Managing Associated Collaboration Documents: Procedure

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. Under 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.

Configuring Collaboration Messaging for a Customer: Procedure

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. Under 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.

Configuring Collaboration Messaging for a Customer Account: Procedure

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. Under Associated Service Providers, click Actions - Add Row and fill the details of the service provider and the trading partner.

  4. Under 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.

FAQs for Define Collaboration Messages

What are the different undelivered collaboration message error statuses?

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.

What are the different undelivered collaboration message error types?

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.

What happens if I don't enable a document type for storage?

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.

Why did my message fail?

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 under Processing History.

Why can't I see the import batch list to select from?

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

When would you resubmit a collaboration message?

After CMK 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 CMK.

How can I use a custom XSLT file?

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