12 Creating and Managing Trading Partner Agreements

What is A Trading Partner Agreement?

A trading partner agreement defines the behavior that trading partners agree to follow when engaging in a business transaction. A trading partner agreement consists of two trading partners:

• Host trading partner

• Remote trading partner

A remote trading partner in an agreement includes support for a specific business protocol and its associated:

• Support for a collaboration (the RosettaNet over RNIF business protocol) or business action (for any EDI or Custom Document business protocol). Trading partners define their operational capabilities by the collaborations or business actions they support.

• Delivery channel, which defines details such as nonrepudiation, encryption, and transport security capabilities, as well as the document exchange and transport used (known in the OracleAS Integration B2B user interface tool as the communication capabilities)

• Trading partner identification type and value, such as a DUNS number

The host trading partner also includes a delivery channel and trading partner identification type and value. However, the host trading partner does not include a specific business protocol and its associated support for a collaboration or business action. The host trading partner instead is automatically assigned support for all business protocols and associated collaborations and business actions included in OracleAS Integration B2B. You assign support for a business protocol and a collaboration or business action to a remote trading partner. The host trading partner is automatically assigned support for a business protocol and a collaboration or business action that are compatible with the selections for the remote trading partner. This action simplifies your user experience.

Figure 12-1 shows the contents of a trading partner agreement.

Figure 12-1 Trading Partner Agreement

Description of "Figure 12-1 Trading Partner Agreement"

How Do You Create a Trading Partner Agreement?

The OracleAS Integration B2B user interface tool enables you to perform the following tasks to create a trading partner agreement:

• Select the remote trading partner

• Select the business protocol support for the remote trading partner

• Select support for a collaboration (for the RosettaNet over RNIF business protocol) or business action (for any EDI or Custom Document business protocol) for the business protocol of the remote trading partner. Trading partners define their operational capability by the collaborations or business actions they support.

  You do not need to select support for the business protocol and a collaboration or business action for the host trading partner. Based on your selections for the remote trading partner, the host trading partner is automatically assigned details that are compatible with those of the remote trading partner. For example, if you select support for the RosettaNet over RNIF business protocol and Buyer - 3A4 - V02.00 as the collaboration and role for the remote trading partner, the host trading partner is automatically assigned support for RosettaNet over RNIF as the business protocol and Seller - 3A4 - V02.00 as the collaboration and role. This simplifies your user experience.

• Select the trading partner identification types and delivery channels (communication capabilities) for both the remote and host trading partners

• Select the host trading partner internal delivery channel and (optionally) the callout usages

• Assign a required trading partner agreement name and identifier

• Assign optional details such as an agreement description, dates during which the agreement is active, invocation limit, and concurrent conversation limit

Figure 12-2 shows the page for creating a trading partner agreement.

Figure 12-2 Create Trading Partner Agreement Page

Description of "Figure 12-2 Create Trading Partner Agreement Page"

Prerequisites to Creating a Trading Partner Agreement

Ensure that you review and complete the prerequisites described in Table 12-1 before creating a trading partner agreement.

Creating a Trading Partner Agreement

You create a trading partner agreement between the host trading partner and a remote trading partner. Follow these instructions to create a trading partner agreement:

1. Click Partners, then Agreements, then Create or Partners, and then Create Trading Partner Agreement in the Shortcuts section.

   The Create Agreement screen appears.

2. Select a remote trading partner from the Trading Partner list. You must already have created a remote trading partner for one to display in this list. If you have not already done so, see "Creating and Assigning All Capabilities During a Single Wizard Session" for instructions.

   The host trading partner is not available for selection; it is automatically included in the trading partner agreement and does not need to be selected.

   The page refreshes to display the Supported Business Protocol list.

3. Select a business protocol. You must have already assigned support for a business protocol to this remote trading partner for one to display in this list. If you have not already done so, see "Creating and Assigning All Capabilities During a Single Wizard Session" for instructions.

   The page refreshes. The list that now displays immediately under the Supported Business Protocol list is based on the business protocol you selected.

4. Make a selection based on the business protocol type you selected.

   If You Selected...	Then...
   RosettaNet over RNIF	Select support for a collaboration from the Supported Collaboration list (for example, Buyer - 3A4 - V02.00). This is the collaboration you selected when you created this remote trading partner. The host trading partner is automatically assigned a collaboration that is compatible with your remote trading partner selection (for example, Seller - 3A4 - V02.00).
   Any EDI or Custom Document business protocol	Select support for a business action from the Supported Business Actions list. This is the business action you selected when you created this remote trading partner. The host trading partner is automatically assigned a business action that is compatible with your remote trading partner selection.

   
   
   
   

   Note: You can select support for only one collaboration or business action at a time. To add additional collaborations or business actions to the agreement, you must first create the agreement, then click Add in the Trading Partner Participants section of the Agreement Details page.

   
   

5. Enter the following details to create a trading partner agreement. An asterisk (*) indicates a required field.

   Field	Value
   Host/Trading Partner	Both the host and remote trading partner appear in this section.
   Trading Partner Identification *	Select trading partner identification type values for both the host and remote trading partners. Both trading partners automatically include a default identification type called Name. You can also use one of the other predefined identification types (for example, a Data Universal Numbering System (DUNS)) or create your own identification type. See "Creating Trading Partner Identification" for instructions on creating a trading partner identification type.
   Trading Partner Delivery Channel *	Select the delivery channels for both the host and remote trading partners. You must have already created delivery channels for both trading partners for selections to display in these lists. See Chapter 9, "Creating Trading Partners" for instructions on creating a delivery channel.
   Host Delivery Channel and Callout Usage	-
   Internal Delivery Channel *	Select the internal delivery channel to use for sending messages (for example, sending an outbound purchase order request from the host application of the host trading partner to the remote trading partner). This delivery channel communicates between the host trading partner's host application and OracleAS Integration B2B. OracleAS Integration B2B includes four predefined internal delivery channels. You can also create your own. Note: The default internal delivery channel selection is sufficient for most environments. See "Managing Internal Delivery Channels" for additional details about internal delivery channels.
   Callout Usage	If required, select a callout usage to use to transform the format of one message to another. This field is associated with the Internal Delivery Channel field. For example, if the internal delivery channel is used for sending an outbound purchase order request from the host application of the host trading partner to the remote trading partner, the callout usage translates the outbound purchase order request into a format understood by the remote trading partner. See "Managing Callouts" for additional details about callouts and callout usages.
   Responding Internal Delivery Channel	If required, select the internal delivery channel to use for responding to (acknowledging) messages (for example, sending an inbound purchase order acceptance from the remote trading partner to the host application of the host trading partner). Note: This field appears if you selected Yes from the Is Acknowledgment Handled By Integration B2B? list when creating a remote trading partner on the Operational Capabilities page. Note: The default internal delivery channel selection is sufficient for most environments. See "Managing Internal Delivery Channels" for additional details about responding internal delivery channels.
   Responding Callout Usage	If required, select a responding callout usage to use to transform the format of one message to another. This field is associated with the Responding Internal Delivery Channel field. For example, if the responding internal delivery channel is used for sending an inbound purchase order acceptance from the remote trading partner to the host application of the host trading partner, the callout usage translates the inbound purchase order acceptance into a format understood by the host application of the host trading partner. See "Managing Callouts" for additional details about callouts and responding callout usages. Note: This field appears if you selected Yes from the Is Acknowledgment Handled By Integration B2B? list when creating a remote trading partner on the Operational Capabilities page.
   General	-
   Name *	Enter a unique and recognizable name for the trading partner agreement.
   Agreement Id *	Enter a unique agreement identifier.
   Description	Enter a description for the trading partner agreement.
   Effective From Date	Select the calendar icon to enter an agreement beginning date. If no date is specified, the agreement is always effective.
   Effective To Date	Select the calendar icon to enter an agreement ending date. If no date is specified, the agreement is always effective.
   Invocation Limit	Enter a value for the maximum number of times the collaboration or business action can be invoked. If you do not enter a value, there is no limit on the number of invocations.
   Concurrent Conversations	Enter a value for the maximum number of concurrent business actions or collaborations that can be in progress.

   
   

6. Click Apply.

   The trading partner agreement is created and the Agreement Details page appears. The host trading partner is automatically assigned a collaboration or business action that is compatible with that assigned to the remote trading partner. For example, if remote trading partner support is for collaboration Buyer - 3A4 - V02.00, the host trading partner is automatically assigned collaboration Seller - 3A4 - V02.00.

7. Click Validate.

   If successful, the message agreement_name Agreement is valid appears at the top.

See the following for more information:

• "Managing Internal Delivery Channels"

• "Managing Callouts"

Viewing a Trading Partner Agreement

Follow these instructions to view details about a specific trading partner agreement:

1. Click Partners, then Agreements.

2. Select a specific trading partner agreement to view in the Name column.

   The Agreement Details page for the selected trading partner agreement appears.

3. View specific details, including the following:

   • The agreement ID, agreement description, dates during which the agreement is active, invocation limit, number of concurrent conversations, and agreement state (in the Details section)

   • The host and remote trading partners in this agreement (known as participants in the OracleAS Integration B2B user interface tool) and their associated support for a collaboration (for the RosettaNet over RNIF business protocol) or business action (for any EDI or Custom Document business protocols).

   See Figure 12-4 for an example of an Agreement Details page.

   This page, as with the Trading Partner Agreements page shown in Figure 12-3, enables you to delete or update a trading partner agreement.

   Depending on the current state of an agreement (which displays in the State field of the Details section), different buttons and additional sections can also display. If the state is Approved or Deployed, no button displays.

   The Export button also displays on the Agreement Details page. This button enables you to export your partner data to an XML file. You can then submit this file for review to applicable trading partners in a trading partner agreement to ensure that it is correct.

4. Click Return to List to return to the Trading Partner Agreements page.

See the following for more information:

• "Viewing the State of Partner Data on the Details Pages" for details about the states (such as Draft) that display on agreement details pages

• "Exporting Partner Data to an XML File" for details about the Export button

Updating a Trading Partner Agreement

Follow these instructions to update a trading partner agreement:

1. Click Partners, then Agreements.

2. Select a specific trading partner agreement to update in the Update column.

   The Update Agreement page appears.

3. Make appropriate updates. An asterisk (*) indicates a required field.

   Field	Value
   Name *	Update with a unique and recognizable name for the trading partner agreement.
   Agreement Id *	Update the agreement identifier.
   Description	Update the description for the trading partner agreement.
   Effective From Date	Select the calendar icon to update an agreement beginning date. If no date is specified, the agreement is always effective.
   Effective To Date	Select the calendar icon to update an agreement ending date. If no date is specified, the agreement is always effective.
   Invocation Limit	Update the value for the maximum number of times the collaboration or business action can be invoked. If you do not enter a value, there is no limit on the number of invocations.
   Concurrent Conversations	Update the value for the maximum number of concurrent business actions or collaborations that can be in progress.

   
   

4. Click Apply.

   The agreement is updated and the Agreement Details page appears.

Deleting a Trading Partner Agreement

Follow these instructions to delete a trading partner agreement:

1. Click Partners, then Agreements.

2. Select a specific trading partner agreement to delete in the Delete column.

3. Click Yes when prompted to delete a trading partner agreement.

   The trading partner agreement is deleted and the Trading Partner Agreements page appears.

Adding Additional Identifications and Operational and Communication Capabilities to Trading Partner Agreement Participants

You can add additional trading partner identifications, support for business protocols and a collaboration or business action (operational capabilities), and delivery channels (communication capabilities) to trading partners in this agreement.

Follow these instructions to add additional identifications and operational and communication capabilities to trading partners in a trading partner agreement.

1. Click Partners, then Agreements.

2. Select a specific trading partner agreement in the Name column.

   The Agreement Details page for the selected trading partner agreement appears.

3. Click Add in the Trading Partner Participants section.

   The Add Trading Partner Participant page appears.

4. Select a business protocol from the Supported Business Protocol list.

   The page refreshes to display additional fields.

5. Make an appropriate selection from the Supported Collaboration list (if your business protocol selection is RosettaNet over RNIF) or the Supported Business Action list (if your business protocol selection is any EDI or Custom Document protocol).

6. Enter the following details:

   Field	Value
   Host/Trading Partner	Both the host and remote trading partner appear in this section.
   Trading Partner Identification	Select trading partner identification type values for both the host and remote trading partners. The host and remote trading partners automatically include a default identification type called Name. You can also create your own identification type. See "Creating a Trading Partner Identification Type" for instructions on creating a trading partner identification type.
   Trading Partner Delivery Channel	Select the delivery channels for both the host and remote trading partners. You must have already created delivery channels for both trading partners for selections to display in these lists. See Chapter 9, "Creating Trading Partners" for instructions on creating a delivery channel.

   
   

7. Click Apply.

   The trading partner agreement participant details are updated and the Trading Partner Participant Details page appears.

Viewing a Trading Partner Agreement Participant

Follow these instructions to view details about a specific trading partner agreement participant:

1. Click Partners, then Agreements.

2. Select a specific trading partner agreement in the Name column.

   The Agreement Details page for the selected trading partner agreement appears.

3. Select a specific trading partner participant to view in the Name column of the Trading Partner Participants section.

   The Trading Partner Participant Details page for the selected trading partner agreement participant appears.

4. View specific details about the identification value and support for a collaboration (for the RosettaNet over RNIF business protocol) or business action (for any EDI or Custom Document business protocol). You can also view and manage (add, remove, and update) the delivery channel associated with this trading partner agreement participant.

   See Figure 12-5 for an example of the Trading Partner Participant Details page.

5. Click Return to List to return to the Agreement Details page for the selected trading partner agreement.

Updating a Trading Partner Agreement Participant

Follow these instructions to update the trading partner identification, delivery channel, internal delivery channel, and callout usage of a trading partner agreement participant.

1. Click Partners, then Agreements.

2. Select a specific trading partner agreement in the Name column.

   The Agreement Details page for the selected trading partner agreement appears.

3. Select a specific trading partner participant to update in the Update column of the Trading Partner Participants section.

   The Update Trading Partner Participant page appears.

4. Make appropriate updates.

   Field	Value
   Host/Trading Partner	Both the host and remote trading partner appear in this section.
   Trading Partner Identification	Update the trading partner identification type values for both the host and remote trading partners. Both trading partners include a default identification type called Name that is automatically included with OracleAS Integration B2B. You can also create your own identification type. See "Creating a Trading Partner Identification Type" for instructions on creating a trading partner identification type.
   Trading Partner Delivery Channel	Update the delivery channels for both the host and remote trading partners. You must have already created delivery channels for both trading partners for selections to display in these lists. See Chapter 9, "Creating Trading Partners" for instructions on creating a delivery channel.
   Host Delivery Channel and Callout Usage
   Internal Delivery Channel	Update the internal delivery channel of the host trading partner. See Step 5 for a description of internal delivery channels.
   Callout Usage	Update the callout usage associated with the internal delivery channel of the host trading partner. See Step 5 for a description of callout usages.
   Responding Internal Delivery Channel	Update the responding internal delivery channel of the host trading partner. See Step 5 for a description of responding internal delivery channels.
   Responding Callout Usage	Update the responding callout usage associated with the responding internal delivery channel of the host trading partner. See Step 5 for a description of responding callout usages.

   
   

5. Click Apply.

   The trading partner agreement participant is updated and the Trading Partner Participant Details page appears.

Removing a Trading Partner Agreement Participant

Follow these instructions to remove a remote trading partner agreement participant. You cannot remove the host trading partner participant.

1. Click Partners, then Agreements.

2. Select a specific trading partner agreement in the Name column.

   The Agreement Details page for the selected trading partner agreement appears.

3. Select a specific trading partner participant to remove in the Remove column of the Trading Partner Participants section.

4. Click Yes when prompted to remove a trading partner agreement participant.

   The trading partner agreement participant is removed and the Agreement Details page appears. A trading partner agreement requires two trading partners (the host trading partner and a remote trading partner) as participants. If your agreement includes less than two participants, you must add the necessary number of trading partners.

Adding a Delivery Channel to a Trading Partner Agreement Participant

If you previously removed a delivery channel from a trading partner participant in an agreement, you can add a new delivery channel. You can also use this page to change the delivery channel used by a trading partner participating in an agreement. Follow these instructions to perform either of these tasks.

1. Click Partners, then Agreements.

2. Select a specific trading partner agreement in the Name column.

   The Agreement Details page for the selected trading partner agreement appears.

3. Select a specific trading partner participant in the Name column of the Trading Partner Participants section.

   The Trading Partner Participant Details page for the selected trading partner agreement participant appears.

4. Click Add in the Delivery Channels Used section.

   The Add Participant Delivery Channel page appears.

5. Select a delivery channel from the Delivery Channel list.

6. Click Apply.

   The delivery channel is added and the Participant Delivery Channel Details page appears.

Viewing a Delivery Channel of a Trading Partner Agreement Participant

Follow these instructions to view details about a delivery channel of a trading partner agreement participant:

1. Click Partners, then Agreements.

2. Select a specific trading partner agreement in the Name column.

   The Agreement Details page for the selected trading partner agreement appears.

3. Select a specific trading partner participant in the Name column of the Trading Partner Participants section.

   The Trading Partner Participant Details page appears.

4. Select a specific delivery channel to view in the Name column of the Delivery Channels Used section.

   The Participant Delivery Channel Details page for the selected delivery channel appears.

5. View specific details about the document exchange and transport associated with this delivery channel, and the status of acknowledgment mode, global usage code, nonrepudiation of receipt, nonrepudiation of origin, encryption, transport security, time to acknowledgment value, and retry count value.

   This page, as with the Trading Partner Participant Details page shown in Figure 12-5, enables you to remove or update the delivery channel of the selected trading partner agreement participant.

6. Click Return to List to return to the Trading Partner Participant Details page.

7. Click Return to List to return to the Agreement Details page.

Updating a Delivery Channel of a Trading Partner Agreement Participant

Follow these instructions to update a delivery channel of a trading partner agreement participant:

1. Click Partners, then Agreements.

2. Select a specific trading partner agreement in the Name column.

   The Agreement Details page for the selected trading partner agreement appears.

3. Select a specific trading partner participant in the Name column of the Trading Partner Participants section.

   The Trading Partner Participant Details page for the selected trading partner agreement participant appears.

4. Select a specific delivery channel to update in the Update column of the Delivery Channels Used section.

   The Update Participant Delivery Channel page appears.

5. Select a delivery channel from the Delivery Channel list.

6. Click Apply.

   The trading partner agreement participant is updated and the Trading Partner Participant Details page appears.

7. Click Return to List to return to the Agreement Details page.

Removing a Delivery Channel from a Trading Partner Agreement Participant

Follow these instructions to remove a delivery channel from a trading partner agreement participant:

1. Click Partners, then Agreements.

2. Select a specific trading partner agreement in the Name column.

   The Agreement Details page for the selected trading partner agreement appears.

3. Select a specific trading partner participant in the Name column of the Trading Partner Participants section.

   The Trading Partner Participant Details page for the selected trading partner agreement participant appears.

4. Select a specific delivery channel to remove in the Remove column of the Delivery Channels Used section.

5. Click Yes when prompted to remove a trading partner delivery channel.

   The delivery channel is removed and you are returned to the Trading Partner Participant Details page. You can add this delivery channel again at a later time.