Oracle® Application Server Integration B2B User's Guide
10g Release 2 (10.1.2) B19370-03 |
|
![]() Previous |
![]() Next |
The OracleAS Integration B2B tutorials guide you through the steps to design, deploy, and verify B2B scenarios. After using this tutorial, you should be able to create and deploy your own custom document over ebXML messaging service (ebMS) transaction.
This chapter contains the following topics:
This tutorial depicts a scenario in which Acme sends a custom XML document using the ebMS exchange protocol to GlobalChips.
Note: For this tutorial, you set up OracleAS Integration B2B on servers at both Acme and GlobalChips "sites;" that is, on:
With this setup, you can verify that the custom XML document is sent and received. On both servers, Acme is the buyer and GlobalChips is the seller. |
Before you begin the tutorial, see the following sections:
Note: The path name delimiter used in this documentation, /, is for UNIX. If you are using Windows, assume that the path name delimiter is \. |
In the following tasks, you set up the Acme server first and then the GlobalChips server. If you are working through this tutorial with a partner, one person can do the tasks on the Acme server while the other does the tasks on the GlobalChips server.
One person does the following tasks:
In parallel, the other person does the following tasks:
GlobalChips Server, Task 3: Creating the Trading Partner Agreement
GlobalChips Server, Task 4: Creating and Deploying the Configuration
After each partner finishes tasks 1 through 4 on the respective server, work together to do task 5:
Note: Fields and checkboxes that you should accept default values for, or leave blank, are omitted in the following steps, although they appear on the screen. This is done to simplify the instructions and move you through the tutorial more quickly. |
Note about ebMS: OracleAS Integration B2B mapsINREPLYTO_MSG_ID (see Table 4-1, "IP_MESSAGE_TYPE Parameters") to the ebMS conversation_id parameter.
|
In the following set of tasks, Acme is the host trading partner. You create the following business actions for this transaction.
Process_ebMSRequest—Acme uses the Process_ebMSRequest business action to send an XML document to GlobalChips.
See "Creating a Business Action" for more information.
Click Partners, then Protocols.
Click Custom Document over ebMS.
From Shortcut, click Create Business Action.
On the Create Business Action: General page, provide the following information and click Next.
Field | Value |
---|---|
Name | Process_ebMSRequest |
Revision | 1.0 |
Is Nonrepudiation of Receipt Required | No |
Is Nonrepudiation of Origin Required | No |
Acknowledgement Mode | Async |
On the Create Business Action: Document Protocol Revision page, provide the following information and click Next.
Field | Value |
---|---|
Name | ebMS Document Protocol Revision |
Revision | 1.0 |
On the Create Business Action: Document Type page, provide the following information and click Next.
General Field | Value |
---|---|
Name | ebMS doc type |
Revision | 1.0 |
Document Definition Field | Value |
---|---|
Name | ebMS doc def |
Definition | ebMSOrder.xsd |
Document Type Parameters Field | Override Value |
---|---|
Service | Acme Service |
Service Type | Acme Service Type |
From Role | Acme From Role |
To Role | Acme To Role |
Review the data and click Finish, or make changes using Back.
You should see Business Action Process_ebMSRequest : 1.0 successfully created at the top of the page.
On the Acme server, Acme is the host trading partner and GlobalChips is the remote trading partner.
This section contains these topics:
If you have not already done so, change the default host trading partner name from MyCompany to:
Acme, if you are working on the Acme server
GlobalChips, if you are working on the GlobalChips server
See the following for more information:
"Creating and Assigning All Capabilities During a Single Wizard Session"
"Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners"
As you set up GlobalChips, you associate it with the Process_A01-Responder business actions.
Click Partners.
From Shortcuts, click Create Trading Partner.
On the Create Trading Partner: General page, provide the remote trading partner name, GlobalChips
, and click Next.
On the Create Trading Partner: Identification page, for the ebMS Identifier value, enter GlobalChips
and click Next.
On the Create Trading Partner: Operational Capability page, provide the following information and click Next.
General Field | Value |
---|---|
Business Protocol | Custom Document over ebMS |
Business Action | Process_ebMSRequest |
Is Initiator | False |
Functional acknowledgement required? | No |
Is acknowledgement handled by Integration B2B? | Yes |
Continuing on the Create Trading Partner: Operational Capability page, provide the following information and click Next.
Document Information Field | Value |
---|---|
Document Type | ebMS doc type |
Use Existing Document Protocol Parameter Values | Check the box. |
Use Default Document Definition | Check the box. |
On the Create Trading Partner: Delivery Channel page, provide the following information and click Next.
Field | Value |
---|---|
Name | GlobalChips ebMS DC |
Acknowledgement Mode | Async |
On the Create Trading Partner: Document Exchange page, provide the following information and click Next.
Field | Value |
---|---|
Name | GlobalChips ebMS DocEx |
Exchange Protocol Revision | ebMS - 2.0 |
On the Create Trading Partner: Transport page, provide the following information.
General Field | Value |
---|---|
Name | GlobalChips ebMS Transport |
Transport Protocol Field | Value |
---|---|
Transport Protocol | HTTP - 1.1 |
Transport Server Field | Value |
---|---|
Name | GlobalChips Transport Server |
Host Name | GlobalChips_hostname
The transport server host exchanging messages at the GlobalChips site. |
Port | port_number
|
Click Create New, provide the following information, and click Next.
Endpoint Field | Value |
---|---|
URI | b2b/transportServlet |
Review the data and click Finish, or make changes using Back.
You should see Trading Partner GlobalChips successfully created at the top of the page.
In the following steps, you set up the host trading partner's ebMS identifier and communication capabilities. The host is automatically assigned a business protocol and operational capabilities that are compatible with the remote trading partner.
Click Partners, then Trading Partners.
Click Acme (Host).
Under Trading Partner Identifications, click Create.
For Trading Partner Identification Type, select ebMS Identifier.
For Value, enter Acme
.
Click Apply.
Click Capabilities.
Click Custom Document over ebMS.
Click Create Communication Capability.
On the Create Trading Partner: Delivery Channel page, provide the following information and click Next.
Field | Value |
---|---|
Name | Acme ebMS DC |
Acknowledgement Mode | Async |
On the Create Trading Partner: Document Exchange page, click Create New.
Provide the following information and click Next.
Field | Value |
---|---|
Name | Acme ebMS DocEx |
Exchange Protocol Revision | ebMS - 2.0 |
On the Create Trading Partner: Transport page, do the following and click Next.
Select Create New and provide the following information:
General Field | Value |
---|---|
Name | Acme ebMS Transport |
Transport Protocol Field | Value |
---|---|
Transport Protocol | HTTP - 1.1 |
Select Create New and provide the following information:
Transport Server Field | Value |
---|---|
Name | Acme Transport Server |
Host Name | Acme_hostname
The transport server host exchanging messages at the Acme site. |
Port | port_number
|
Select Use Existing and provide the following information:
Endpoint Field | Value |
---|---|
URI | b2b/transportServer |
Review the data and click Finish, or make changes using Back.
You should see Communication Capability created successfully at the top of the page.
As the host trading partner, Acme is automatically included in the trading partner agreement. So, in the following steps, select GlobalChips as the remote trading partner in the agreement. Acme is also automatically assigned a business action that is compatible with the one assigned to GlobalChips.
Note: You cannot create a trading partner agreement between more than two trading partners. |
Click Partners.
From Shortcuts, click Create Trading Partner Agreement.
From Trading Partner, select GlobalChips.
From Supported Business Protocol, select Custom Document over ebMS.
From Supported Business Action, select Process_ebMSRequest - Responder.
For Trading Partner Identification, select ebMS Identifier - hostname for both GlobalChips and Acme.
For Trading Partner Delivery Channel, select GlobalChips ebMS DC and Acme ebMS DC.
In the Name field, enter ebMS Agreement
.
In the Agreement ID field, enter agr1
.
The same value for Agreement ID must be used for both trading partners.
Click Apply.
You should see Agreement ebMS Agreement successfully created at the top of the page.
Click Validate.
You should see Agreement ebMS Agreement is valid. The agreement is approved as part of the validation.
See "Creating a Trading Partner Agreement" for more information.
After you have created the trading partner agreement, you are ready to create the configuration. A configuration consists of the data you defined in the previous tasks in this tutorial. A configuration enforces validation rules, ensuring that only valid, complete, and consistent data is available for deployment in a production environment.
Click Deployment.
Click Create.
For Configuration Name, enter ebMS Configuration
.
Select ebMS Agreement.
Click Apply.
For ebMS Configuration, click Deploy.
Review the list of configurations and click Deploy.
You should see Deployment finished successfully for configuration ebMS Configuration.
See Chapter 13, "Creating and Deploying a Configuration" for more information.
See "Both Servers, Task 5: Verifying the Transaction" for instructions.
In the following set of tasks, GlobalChips is the host trading partner. You create the following business action for this transaction.
Process_ebMSRequest—GlobalChips uses the Process_ebMSRequest business action to send an XML document to Acme.
See "Creating a Business Action" for more information.
Click Partners, then Protocols.
Click Custom Document over ebMS.
From Shortcut, click Create Business Action.
On the Create Business Action: General page, provide the following information and click Next.
Field | Value |
---|---|
Name | Process_ebMSRequest |
Revision | 1.0 |
Is Nonrepudiation of Receipt Required | No |
Is Nonrepudiation of Origin Required | No |
Acknowledgement Mode | Async |
On the Create Business Action: Document Protocol Revision page, provide the following information and click Next.
Field | Value |
---|---|
Name | ebMS Document Protocol Revision |
Revision | 1.0 |
On the Create Business Action: Document Type page, provide the following information and click Next.
General Field | Value |
---|---|
Name | ebMS doc type |
Revision | 1.0 |
Document Definition Field | Value |
---|---|
Name | ebMS doc def |
Definition | ebMSOrder.xsd |
Document Type Parameters Field | Override Value |
---|---|
Identification Value | POReq |
Identification Expression (XPath) for XML Document | /Query/DocType/text() |
Service | GlobalChips Service |
Service Type | GlobalChips Service Type |
From Role | GlobalChips From Role |
To Role | GlobalChips To Role |
Review the data and click Finish, or make changes using Back.
You should see Business Action Process_ebMSRequest : 1.0 successfully created at the top of the page.
On the GlobalChips server, GlobalChips is the host trading partner and Acme is the remote trading partner.
This section contains these topics:
If you have not already done so, change the default host trading partner name from MyCompany to:
Acme, if you are working on the Acme server
GlobalChips, if you are working on the GlobalChips server
See the following for more information:
"Creating and Assigning All Capabilities During a Single Wizard Session"
"Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners"
As you set up Acme, you associate it with the following business actions:
Process_A01-Initiator. Acme is the initiator of the Process_A01 business action when it sends the admission notification to GlobalChips.
Process_ACK-Responder. Acme receives an acknowledgment from GlobalChips.
Click Partners.
From Shortcuts, click Create Trading Partner.
On the Create Trading Partner: General page, provide the remote trading partner name, Acme
, and click Next.
On the Create Trading Partner: Identification page, for the ebMS Identifier value, enter Acme and click Next.
On the Create Trading Partner: Operational Capability page, provide the following information and click Next.
General Field | Value |
---|---|
Business Protocol | Custom Document over ebMS |
Business Action | Process_ebMSRequest |
Is Initiator | False |
Functional acknowledgement required? | No |
Is acknowledgement handled by Integration B2B? | Yes |
Document Information Field | Value |
---|---|
Document Type | ebMS doc type |
Use Existing Document Protocol Parameter Values | Check the box. |
Use Default Document Definition | Check the box. |
On the Create Trading Partner: Delivery Channel page, provide the following information and click Next.
Field | Value |
---|---|
Name | Acme ebMS DC |
Acknowledgement Mode | Async |
On the Create Trading Partner: Document Exchange page, provide the following information and click Next.
Field | Value |
---|---|
Name | Acme ebMS DocEx |
Exchange Protocol Revision | ebMS - 2.0 |
On the Create Trading Partner: Transport page, provide the following information.
General Field | Value |
---|---|
Name | Acme ebMS Transport |
Transport Protocol Field | Value |
---|---|
Transport Protocol | HTTP - 1.1 |
Transport Server Field | Value |
---|---|
Name | Acme Transport Server |
Host Name | Acme_hostname
The transport server host exchanging messages at the Acme site. |
Port | port_number
|
Click Create New, provide the following information, and click Next.
Endpoint Field | Value |
---|---|
URI | b2b/transportServlet |
Review the data and click Finish, or make changes using Back.
You should see Trading Partner Acme created successfully at the top of the page.
In the following steps, you set up the host trading partner's ebMS Identifier and communication capabilities. The host is automatically assigned a business protocol and operational capabilities that are compatible with the remote trading partner.
Click Partners, then Trading Partners.
Click GlobalChips (Host).
Under Trading Partner Identifications, click Create.
For Trading Partner Identification Type, select ebMS Identifier.
For Value, enter GlobalChips.
Click Apply.
Click Capabilities.
Click Custom Document over ebMS.
Click Create Communication Capability.
On the Create Trading Partner: Delivery Channel page, provide the following information and click Next.
Field | Value |
---|---|
Name | GlobalChips ebMS DC |
Acknowledgement Mode | Async |
On the Create Trading Partner: Document Exchange page, click Create New.
Provide the following information and click Next.
Field | Value |
---|---|
Name | GlobalChips ebMS DocEx |
Exchange Protocol Revision | ebMS - 2.0 |
On the Create Trading Partner: Transport page, do the following information and click Next.
Select Create New and provide the following information:
General Field | Value |
---|---|
Name | GlobalChips ebMS Transport |
Transport Protocol Field | Value |
---|---|
Transport Protocol | HTTP- 1.1 |
Select Create New and provide the following information:
Transport Server Field | Value |
---|---|
Name | GlobalChips Transport Server |
Host Name | GlobalChips_hostname
The transport server host exchanging messages at the GlobalChips site. |
Port | port_number
|
Select Use Existing and provide the following information:
Endpoint Field | Value |
---|---|
URI | b2b/transportServlet |
Review the data and click Finish, or make changes using Back.
You should see Communication Capability created successfully at the top of the page.
As the host trading partner, GlobalChips is automatically included in the trading partner agreement. So, in the following steps, select Acme as the remote trading partner in the agreement. GlobalChips is also automatically assigned a business action that is compatible with the one assigned to Acme.
Click Partners.
From Shortcuts, click Create Trading Partner Agreement.
From Trading Partner, select Acme.
From Supported Business Protocol, select Custom Document over ebMS.
From Supported Business Action, select Process_ebMSRequest-Responder.
For Trading Partner Identification, select ebMS - trading_partner_name for both Acme and Globalchips.
For Trading Partner Delivery Channel, select Acme ebMS DC and GlobalChips ebMS DC.
In the Name field, enter ebMS Agreement
.
In the Agreement ID field, enter agr1
.
The Agreement ID value here must match the ID used in the sender's agreement.
Click Apply.
You should see Agreement ebMS Agreement successfully created at the top of the page.
Click Validate.
You should see Agreement ebMS Agreement is valid. The agreement is approved as part of the validation.
See "Creating a Trading Partner Agreement" for more information.
After you have created the trading partner agreement, you are ready to create the configuration. A configuration consists of the data you defined in the previous tasks in this tutorial. A configuration enforces validation rules, ensuring that only valid, complete, and consistent data is available for deployment in a production environment.
Click Deployment.
Click Create.
For Configuration Name, enter ebMS Configuration
.
Select ebMS Agreement.
Click Apply.
For ebMS Configuration, click Deploy.
Review the list of configurations and click Deploy.
You should see Deployment finished successfully for configuration ebMS Configuration.
See Chapter 13, "Creating and Deploying a Configuration" for more information.
Table 7-1 lists the files that you use to verify the transaction.
Table 7-1 Files Used in the Tutorial
File Name | Description |
---|---|
ebMSOrder.xml |
The payload that the buyer sends to the seller |
ebMSOrder.xsd |
Describes the payload |
enq_ebMSOrder.properties |
Parameter file with information needed to enqueue the payload to |
enq_order.bat enq_order.sh |
Calls See Chapter 16, "Utilities for Enqueuing and Dequeuing" for more information about |
The files are found at
Oracle_Home/ip/tutorial/protocolname
On the Acme server, go the directory that contains the tutorial files and run enq_order.bat
or enq_order.sh
.
Using the OracleAS Integration B2B user interface on the Acme server, run a Business Message Status Report to see if the message was sent.
Click Reports.
Click Business Message.
Click Run Report.
If the message was sent, you see two lines in the report, one for the order and one for the acknowledgment. The state field should say complete.
You can run the same report from the GlobalChips server.