Working with Trading Partners

 

The following sections provide key concepts and procedures for configuring and working with trading partners on the C-Hub Administration Console:

• What Are Trading Partners?

• Creating a Trading Partner

• Defining XOCP Filters and Routers for a Trading Partner

• Defining Server-Side Security Values for a Trading Partner

• Assigning a Trading Partner to a TP Protocol

• Adding Extended Properties for a Trading Partner

• Viewing Trading Partners on a C-Hub

• Modifying an Existing Trading Partner

• Viewing Configuration Details for Trading Partners

• How Do Trading Partners Relate to C-Spaces?

• Removing a Trading Partner

For introductory information about trading partners, see Overview in BEA WebLogic Collaborate Getting Started. For more information about developing trading partner applications, see the BEA WebLogic Collaborate Developer Guide.

 

---

What Are Trading Partners?

A trading partner represents an entity, such as a company, that is authorized to participate in collaboration activity through BEA WebLogic Collaborate. A trading partner is authorized to participate in one or more predefined collaboration spaces (c-spaces). Within a c-space, a trading partner can participate in one or more conversations by being subscribed (authorized) to a role in one or more conversation definitions. Trading partners are registered on the c-hub level, so the c-hub administrator must first define and configure them, specifying such attributes as name, address, e-mail, phone, and fax information for each trading partner.

For a complete explanation of what trading partners are and how they relate to e-markets and collaboration spaces, see BEA WebLogic Collaborate Getting Started, particularly the Overview.

 

---

Creating a Trading Partner

To create a new trading partner:

1. Click Configuration in the left navigation bar.

2. Click the Trading Partners tab to display the Trading Partners configuration screen.

3. Fill in the fields as described in the following table.

   Table 14-1 Trading Partners Fields

   Field	Description
   Trading Partner Name	Enter the name of a new trading partner you want to create or modify. (Limit is 256 characters.) Note that the trading partner name you enter in this field must be the same as the <trading-partner name> defined in the XML file for the c-enabler.
   Description	Enter a brief description of the trading partner. (Limit is 256 characters.) (optional)
   Address	Enter the physical address of the trading partner. (Limit is 256 characters.) (optional)
   Certificate Field Value	This is the certificate field value for the certificate-field name specified in the Hub tab. The value is used when fingerprint is chosen in the Hub tab. When email or none are chosen, then the email address is used. The value is used while mapping the trading partner certificate to a WebLogic Server (WLS) user. (This is a client-side security setting related to connections flowing from the trading partners' c-enablers to the c-hub. For information on how to set server-side security for connections flowing out from the c-hub, see Defining Server-Side Security Values for a Trading Partner.)
   WLS User Name	WLS user field lists the WebLogic Server user the trading partner certificate should be mapped to while executing messages sent by that trading partner. (This is a client-side security setting related to connections flowing from the trading partners' c-enablers to the c-hub. For information on how to set server-side security for connections flowing out from the c-hub, see Defining Server-Side Security Values for a Trading Partner.)
   Email	Enter the e-mail address for the trading partner. (Limit is 256 characters.)
   Phone	Enter the phone number for the trading partner. (Limit is 256 characters.) (optional)
   Fax	Enter the fax number for the trading partner. (Limit is 256 characters.) (optional)
   State	Select Enabled or Disabled.

   Figure 14-1 Trading Partners Configuration

   

4. Click Add/Update to create the new trading partner. Your new trading partner should show up in the Trading Partners list.

   (You can also click Reset to discard your current changes and start again.)

When you create a new trading partner, initially it will not be part of a collaboration space (c-space) until you assign it to one. This is indicated by the label [NONE] showing next to the newly added trading partner under the C-Spaces list. You can add trading partners to c-spaces that you set up on the C-Spaces tab. From the Trading Partners tab, you can click on the c-space for a trading partner (or [NONE] if none are defined) and go directly to the C-Spaces tab. (Information on how to create c-spaces and add trading partners to them is described in the topic Working with C-Spaces.) You can skip to this task now, or continue working through the Trading Partner tasks in sequential order, depending on which entities you would like to set up first. When you later define c-spaces and add trading partners to them, those relationships will be reflected on the Trading Partners screen shown in Figure 14-1.

Similarly, when first created, the trading partner will not be assigned to a trading partner (TP) protocol, and the TP Protocol for the new trading partner will be [NONE]. (For more information on this, see Assigning a Trading Partner to a TP Protocol.)

 

---

Defining XOCP Filters and Routers for a Trading Partner

You can use XOCP filters and XOCP routers to control the flow of XOCP business messages exchanged among trading partners in a c-space. (Note that XOCP filters and XOCP routers can be used only for XOCP business protocol definitions.)

For more information about XOCP filters and XOCP routers, see Routing and Filtering XOCP Business Messages.

To define filters and routers for a trading partner:

1. From the main Trading Partner tab, click the trading partner to which you want to assign filters and routers.

   This brings up a screen showing the configuration details for the selected trading partner.

   Figure 14-2 Details on a Trading Partner

   

2. From this screen you can configure XOCP filters and routers for a trading partner by defining XPath expressions as described in the following table.

   Note: If you define an XPath expression in the XOCP Filter Configuration group, this XPath expression will be added to the XOCP filter logic plug-in. Similarly, if you define an XPath expression in the XOCP Router Configuration group, this XPath expression will be added to the XOCP router logic plug-in.

   Table 14-2 XPath Fields for XOCP Filter and XOCP Router Configurations

   Field	Description
   XPath Expression	Enter an XPath expression in this text field. (XPath is the XML path language. An XPath expression is a string that specifies intended recipients of a business message using XPath syntax.) These XPath expressions are evaluated in sequence at run time against the message-context XML document, which has the content of the message along with meta information about the message, such as the sending and receiving trading partners, conversation information, and versioning. In the XOCP router logic plug-in, each XPath router expression can examine different parts of the message-context document and select a different set of recipient trading partners. The trading partners produced by each expression can either replace the previously generated set of recipient trading partners or add to the current set. In the XOCP filter logic plug-in, each XPath filter expression can examine different parts of the message-context document to determine whether or not to forward the message to the recipient trading partner. Each XPath filter expression can return true or false using different selection criteria. After an XPath filter expression returns false, the message is blocked from further evaluation and is not sent to the intended recipient. For example, you might want to filter messages for trading partners that are shippers so that they receive only shipping requests, while all other types of trading partners receive all messages: (/c-hub/message/@message-def-name='Shipping Request' AND /c-hub/trading-partner/extended-property-set/business='shipper') OR (/c-hub/trading-partner/extended-property-set/business!='shipper')
   Type	Select either Append or Replace. If you choose Append, the results of evaluating the new XPath expression are added to the results of the evaluations of any preceding XPath expressions. If you choose Replace, the results of evaluating the new XPath expression replace the results of the evaluations of all preceding XPath expressions.
   Use Payload	Select whether to use payload. (A checkmark indicates payload will be used.) If you select Use Payload, the generated message-context document will include message parts from the payload.

   When you have defined the XPath expression you want to use and set the type and payload filtering options, click on the right arrow button to move the XPath expression into the Assigned list. (You can use the left arrow button to remove an expression from the Assigned list.)

   These fields and options work the same way for both XOCP Filter Configuration and XOCP Router Configuration.

   Note: When you use the detail screen for a trading partner to create an XPath expression, you are defining a trading partner XPath expression. Trading partner XPath expressions are applied only to XOCP business messages that the selected trading partner sends or receives. (In contrast, you can also define XPath expressions for your business protocol definition which are applied to all XOCP business messages flowing through the c-hub.)

3. When you have the XOCP filters and routers you want to use listed in the appropriate Chain lists, click Add/Update to update the trading partner to use the assigned XPath expressions.

   (You can also click Reset to discard your current changes and start again.)

 

---

Defining Server-Side Security Values for a Trading Partner

You can define client-side security values (certificate field value and WLS user name) from the main Trading Partners tab when you add a new trading partner (as described in Creating a Trading Partner.) Client-side security values relate to connections flowing from the c-enablers (trading partners) to c-hub.

In addition to these client-side settings, you can also assign server-side security values to a trading partner. Server-side security values relate to connections flowing from the c-hub to the c-enablers (trading partners). This option is located on the screen that shows configuration details for a selected trading partner (along with the XPath expressions details).

To define Server-Side Security Values:

1. From the main Trading Partners tab, click the trading partner to which you want to assign filters and routers.

   This brings up a screen showing the configuration details for the selected trading partner. This screen includes the settings for server-side security.

   Figure 14-3 Server-Side Security Option on Detailed Configuration Screen for a Trading Partner

   

2. Fill in the server certificate value as described in the following table.

   Table 14-3 Trading Partners Security Fields

   Field	Description
   Server Certificate Value	Enter a server certificate value. The server certificate field value is used to authenticate message recipients to the SSL certificate holder obtained from the remote SSL host. The server certificate value is used while the c-hub is sending a message to a trading partner's c-enabler.
   Assigned	When you have filled in the server certificate value, use the right arrow button to move it into the Assigned list. (You can use the left arrow to remove a value from the Assigned list.)

3. When you have the appropriate server certificate value in the Assigned list, click Add/Update to update the trading partner with the new value.

   (You can also click Reset to discard your current changes and start again.)

 

---

Assigning a Trading Partner to a TP Protocol

Trading Partner Protocol defines additional trading partner information needed for non-XOCP business protocol support.

To assign a trading partner to a trading partner (TP) protocol or modify an existing assignment:

1. From the main Trading Partners tab, click the TP protocol for the trading partner you want to modify. If this trading partner is not yet assigned to a TP protocol, click the [NONE] in the TP protocol list for the trading partner you want to assign.

   This brings up the TP protocol assignment screen for the selected trading partner. (In our example, we have brought up the TP assignment screen for a trading partner called "TestPartner-1" as shown on the top of the screen.)

   Figure 14-4 TP Protocol Assignment

   

   (You can also use the Add/Update TP Protocol button on the configuration details screen for a trading partner to get to this "TP Protocol" screen.)

2. Fill in the fields as described in the following table.

   Table 14-4 TP Protocol Assignment Fields

   Field	Description
   Business Protocol Definitions	Use the drop down menu to select the name of a business protocol definition with which to associate this partner.
   URL	An external URL to where business messages should be routed. Each c-space/business protocol combination has a unique URL. A trading partner uses this URL to access a particular c-space using a particular business protocol. Warning: A URL for a c-space/business protocol combination can be used only by the c-hub and c-enablers. If customer-supplied software uses one of these URLs, messages will not be processed correctly.
   Business ID	A business identifier to be used by an external trading partner, which is distinct from the internal WLC trading partner name.
   Business ID Type	The type of the business identifier. For example, for RosettaNet, a "DUNS" number is used. The type names are under the control of the c-hub administrator and need to be synchronized with the related business protocol plug-in.

3. Click Add/Update to assign the trading partner to the TP protocol with the specified data.

   (You can also click Reset to discard your current changes and start again.)

 

---

Adding Extended Properties for a Trading Partner

The "Extended Properties for a Trading Partner" screen lets you add additional information that you want to associate with a trading partner. This additional data associated with a trading partner is expressed in the repository as XML sub-trees. The sub-tree root element is extended-property-set.

In the following example XML document generated from the repository, everything contained within the extended-property-set element is user-defined extended property information for a trading partner named "B2Binc."

<c-hub context="message-router">

<trading-partner name="B2Binc" 
     email="[e-mail]" 
     phone="408-111-222">
     <address>123 Main St., San Jose, CA 95131</address>
     <extended-property-set name="B2Binc">
          <business-contact>Joe Jackson</business-contact>
          <phone type="work">408-999-1212</phone>
          <phone type="cell">408-999-1234</phone>
          <city>San Jose</city>
          <state>California</state>
     </extended-property-set>
</trading-partner>

</c-hub>

To add extended properties to a trading partner:

1. From the main Trading Partners tab, click the trading partner to which you want to add extended attributes.

   This brings up a screen showing the configuration details for the selected trading partner.

2. Click on the Add/Update Extended Properties button.

   This brings up the Extended Properties screen for the selected trading partners.

   Figure 14-5 Extended Properties for a Trading Partner

   

3. Fill in the fields as described in the following table.

   Table 14-5 TP Protocol Assignment Fields

   Field	Description
   Element Name	Indicate the name of the element for the extended property.
   Element Value	Define a text string that you want contained in the element.
   Attributes	Define the list of available attributes by first defining a name/value attribute pair for the extended property in the fields Attributes Name and Attributes Value. Then use the right arrow button to move the name/value pair into the Available Attributes list, which is used to construct the extended properties. Repeat this process to build a list of available attributes. (Use the right facing arrow to move attributes into this list; use the left facing arrow to remove attributes from the list.)
   Extended Properties for Trading Partner	Use the second set of left/right arrow buttons (on the right) to move attribute name/value pairs from the Attributes to assign list into the Extended Properties for a Trading Partner list. (Use the right facing arrow to move attributes into the extended properties list; use the left facing arrow to remove attributes from the extended properties list.)

4. Click Add/Update to update the trading partner to use the extended properties you added or modified.

 

---

Viewing Trading Partners on a C-Hub

To view trading partners configuration information:

1. Click Configuration in the left navigation bar.

2. Click the Trading Partners tab to display the Trading Partners configuration screen.

   Figure 14-6 Trading Partners Configuration

   

   The Trading Partners configuration screen shows a table of trading partners currently defined in the c-hub, the Trading Partner (TP) protocols to which they are assigned (if any), and the c-spaces to which the trading partners belong.

Using the Query Feature to Find Trading Partners

Notice the * in the Trading Partner Name field. This is a special wildcard character used for queries. In the above screen, the table shows all the trading partners on the c-hub. You can type text strings in the Trading Partner Name field and do queries on them to refine the table display. For instance, to display just trading partners that start with "Pa", you can input Pa* in the System-ID field and click Query. (The query is case-sensitive.) To display information just for Partner1, you can enter Partner1 in the Trading Partner Name field and click Query, or just click on the Partner1 name in the Trading Partners list.

 

---

Modifying an Existing Trading Partner

To modify an existing trading partner:

1. Click Configuration in the left navigation bar.

2. Click the Trading Partners tab to display the Trading Partners configuration screen.

3. In the Trading Partners list, click on the trading partner you want to modify. The configuration information for that trading partner is displayed.

4. Update the fields you want to modify as described in Table 14-1.

5. Click Add/Update to update the trading partner.

   (You can also click Reset to discard your current changes and start again.)

 

---

Viewing Configuration Details for Trading Partners

To display details for a specific trading partner from the Trading Partners configuration tab, click on its name in the Trading Partners list.

 

---

How Do Trading Partners Relate to C-Spaces?

For information on how to add a trading partner to a c-space, see Working with C-Spaces.

Viewing Details about the C-Space to which a Trading Partner Belongs

For trading partners that have already been added to c-spaces, you can view the configuration details of the related c-space. To display details of the c-space a trading partner belongs to from the Trading Partners configuration tab, click on the c-space name in the C-Spaces column.

 

---

Removing a Trading Partner

To remove a trading partner:

1. Click Configuration in the left navigation bar.

2. Click the Trading Partners tab to display the Trading Partners configuration screen.

3. In the Trading Partner Name field, enter the full name of the trading partner that you want to remove, and click Remove.

   or

   Click on the trading partner you want to remove to display the configuration details for that trading partner. On this screen, click Remove.

   A confirmation dialog is displayed. If you click OK, the specified trading partner is removed and you are returned to the main Trading Partners configuration screen.

Note: If the object you remove references or is referenced by other objects, those references will be removed. If the object you remove contains other objects, those objects will be removed. Removing a trading partner should not affect other c-hub entities. See Table 8-2 for details on relationships and dependencies that can exist among configured c-hub objects.

 

---

Monitoring Trading Partners

For information on how to view and monitor detailed information on existing trading partners, see Monitoring Trading Partners on the C-Hub in Monitoring the C-Hub.