About the webMethods ebXML Module Sample...

webMethods ebXML Module 7.1 SP1 Sample Package User’s Guide

About the webMethods ebXML Module Sample Package

The webMethods ebXML Module Sample Package contains several samples that demonstrate how to use the ebXML Message Service Protocol facilities in webMethods ebXML Module 7.1 SP1. The ebXML Module Sample Package contains most of the possible ebXML messages that ebXML Module can send, process, and receive. With the help of these samples, you can quickly test commonly used ebXML messages and features.

webMethods ebXML Module 7.1 SP1 supports secure business-to-business communications of ebXML Message Service versions 1.0 and 2.0. The ebXML Module Sample Package contains folders and services that correspond to a specific message version, and their names reflect the version.

For ebMS 1.0, the samples are in the basic71.ms10.services folder. The TPAs required to run the ebMS 1.0 samples can be created using the createTPA services available in the basic71.ms10.tpa folder.

For ebMS 2.0, the samples are in the basic71.ms20.services folder. The TPAs required to run the ebMS 2.0 samples can be created using the createTPA services available in the basic71.ms20.tpa folder.

All samples run on one webMethods Trading Networks instance.

Before You Begin

Make sure you have the ebXML Module Sample Package (WmebXMLSample) installed. For instructions, see “Installing the Sample”, below.

After webMethods Integration Server loads the ebXML Module Sample Package, run the util:startup service before you run any sample. This service automatically installs the following trading partner profiles on webMethods Trading Networks:

Note: The services and processing rules in the ebXML Module Sample Package have not been customized for these samples.

Trading Partner Profile DUNS

Buyer Inc. 123456789 (as the host)

Seller Inc. 987654321

Router Inc. 1111111111

Credit Inc. 2222222222

1

webMethods ebXML Module 7.1 SP1

Run the tpa:createTPA service to create the TPA required for running the samples. Set the sync parameter to true/false as desired during the TPA creation.

If you are running the multi-hop samples in the multihop folder, you must run four services to create the TPAs needed for the sender, receiver, and intermediary nodes. See “Samples in the multihop Folder” on page 6 for details.

Each trading partner profile assumes that Integration Server is using port 5555. If your Integration Server is using a different port, change the profiles to use that port. For more information about how to change the port in the delivery method settings for a trading partner profile, see the Building B2B Integrations: webMethods Trading Networks Administrator’s Guide.

Set up the signing and encryption certificates according to the instructions in the webMethods ebXML Module Installation and User’s Guide before you run any of the XML Signature- or SMIME-related samples.

Delete the ebXML Module Sample Package before you go into production.

Installing the Sample

The ebXML Module Sample Package is available for download on the webMethods Community page in the Software AG Developer Community.To install the sample

1 Navigate to the webMethods Community page in the Software AG Developer Community at http://communities.softwareag.com/ecosystem/communities/public/Developer/webmethods/products/esb/.

2 Click Code Samples and then locate the ebXML Module sample.

3 Download the ebXML Module Sample Package and save the WmebXMLSample.zip file in the IntegrationServer_directory\replicate\inbound folder.

4 In Integration Server Administrator, in the Packages area of the navigation panel, select Management.

5 Click Install Inbound Releases.

6 From the "Release file name" list, select WmebXMLSample.zip.

7 Click Install Release.

Samples in the ack Folder

The ack folder contains a sample for sending an Acknowledgement ebXML message.

2

http://communities.softwareag.com/ecosystem/communities/public/Developer/webmethods/products/esb/

http://communities.softwareag.com/ecosystem/communities/public/Developer/webmethods/products/esb/


Prerequisites

If you haven't already created the TPA as described in “Before You Begin” on page 1, do so now.

Run any send service that sends an ebXML message, for example basic71.ms20.sendPO. After executing the service, note the Internal ID of the ebXML payload document that you have received. The Internal ID is used as input to the sendAcknowledgement sample to specify to which document the sample should send an Acknowledgement.

The sendAcknowledgement Sample

This sample sends an Acknowledgement ebXML message from Seller Inc. to Buyer Inc. This service takes as input the Internal ID of the ebXML payload message for which you want to send an Acknowledgement. It also takes the ackType input where you have to specify a signed or unsigned value to send a signed or unsigned Acknowledgement.

After running the sample, you will see the following messages in the Transaction Analysis view in webMethods Trading Networks Console:

Samples in the coder Folder

The coder folder contains a sample for character encoding within an ebXML message.

Prerequisites

Set up certificates for all trading partner profiles before you run the sample.


The sendEncoded Sample

This sample sends six encoded and XML digitally signed Purchase Orders (PO) to Seller Inc. that verifies the signed POs. Each PO is encoded with one of the following character encodings: base64, quoted-printable, 7bit, 8bit, binary, and uuencode.


TN Document Type Sender Receiver User Status

ebXML Default Seller Inc. Buyer Inc. Acknowledgement

ebXML Default Seller Inc. Buyer Inc. SendMessage:sent

Note: You can disable the XML Signature facility for the payloads. For more information, see the webMethods ebXML Module Installation and User’s Guide.

3


Samples in the compression Folder

The compression folder contains a sample for sending compressed payloads using the zip and gzip compression algorithms.

Prerequisites

Set up certificates for all trading partner profiles before you run any sample.


The sendCompress Sample

This sample sends two compressed and XML digitally signed Purchase Orders (PO) to Seller Inc. that verifies the signed POs. The POs are first compressed and then XML digitally signed.


Samples in the error Folder

The error folder contains a sample for sending an Error ebXML message.

Prerequisites



ebXML Payload Buyer Inc. Seller Inc. Payload:proc

ebXML Payload Buyer Inc. Seller Inc. SendMessage:sent

Note: You can disable the XML Signature for the payloads. For more information, see the webMethods ebXML Module Installation and User’s Guide.




4


Run any send service that sends an ebXML message, for example basic71.ms20.sendPO. After executing the service, note the Internal ID of the ebXML payload document that you have received. The Internal ID is used as input to the sendAcknowledgement sample to specify to which document the sample should send an Acknowledgement.

The sendErrorMessage Sample

This sample sends an Error ebXML message from Seller Inc. to Buyer Inc. This service takes as input the Internal ID of the ebXML payload message for which you want to send an Error ebXML message. It also takes the wm.ip.ebxml.rec:ErrorMsg document as input. You supply the Error message details at run time.


Samples in the importCPA Folder

The importCPA folder contains a sample for creating a Trading Partner Agreement (TPA) and profiles using an existing Collaboration Protocol Agreement (CPA) v1.0 or v2.0.

Prerequisites

The CPA document should be well-formed and compliant with the Collaboration-Protocol Profile and Agreement Specification v1.0 and v2.0 available at http://www.ebxml.org/specs/cpp-cpa-v1_0.xsd and http://www.oasis-open.org/committees/ebxml-cppa/schema/cpp-cpa-2_0b.xsd.

The importCPA Sample

This sample takes the contents of a CPA document and creates a webMethods Trading Networks TPA and profiles corresponding to the two trading partners.


Trading Partners


ebXML Default Seller Inc. Buyer Inc. ErrorMessage


Corporation Name (Unit Name) Receiver User Status

CompanyA Active

CompanyB Active

5

http://www.ebxml.org/specs/cpp-cpa-v1_0.xsd

http://www.oasis-open.org/committees/ebxml-cppa/schema/cpp-cpa-2_0b.xsd

http://www.oasis-open.org/committees/ebxml-cppa/schema/cpp-cpa-2_0b.xsd


Agreements

Samples in the multihop Folder

The multihop folder contains samples for multi-hop messaging. Instead of Buyer Inc. sending a message directly to Seller Inc., the message is routed through the intermediaries Router Inc. and Credit Inc. The routing path is:

Buyer Inc. -> Router Inc. -> Credit Inc. -> Seller Inc.

In ebMS 1.0, the entire routing path is recorded in the TraceHeaderList element, where a new TraceHeader element is appended at every intermediate node before transmitting the message to the next node.

In ebMS 2.0, the MessageHeader/From and MessageHeader/To elements of the message are updated at each intermediate node to reflect the next routing.

Prerequisites

Run the tpa:createTPA_sender_receiver, tpa:createTPA_sender_hub, tpa:createTPA_hub_credit, and tpa:createTPA_credit_receiver services to create the TPAs required for running all samples in the folder. Set the sync parameter to true/false as desired during the TPA creation.

The ping Sample

This sample sends a Ping/Pong message via intermediate nodes. Buyer Inc. generates a Ping message that is routed via Router Inc. and Credit Inc. to Seller Inc. Seller Inc. processes the Ping message and responds with a Pong message that is routed via Credit Inc. and Router Inc. to Buyer Inc.


Sync

Sender Receiver Agreement ID Agreement Status

CompanyA CompanyB ebXML_7-1_cpa_v2 Proposed


ebXML Default Router Inc. Buyer Inc. Pong

ebXML Default Router Inc. Buyer Inc. SendMessage:sent

ebXML Routing Credit Inc. Router Inc. MessageRouting:proc

ebXML Routing Credit Inc. Router Inc. SendMessage:sent

6


Async

The sendPO Sample

This sample sends a payload message via intermediate nodes. Buyer Inc. generates a payload message that is routed via Router Inc. and Credit Inc. to Seller Inc. Seller Inc. processes the payload message and responds with a DeliveryReceipt (ebMS 1.0) or an Acknowledgement (ebMS 2.0). The response is routed via Credit Inc. and Router Inc. to Buyer Inc. Each intermediate node, including Seller Inc., sends an Acknowledgement to the previous node on receipt of the payload message.


ebXML Routing Seller Inc. Credit Inc. MessageRouting:proc

ebXML Routing Seller Inc. Credit Inc. SendMessage:sync

ebXML Default Credit Inc. Seller Inc. Ping

ebXML Default Credit Inc. Seller Inc. SendMessage:sent

ebXML Routing Router Inc. Credit Inc. MessageRouting:proc

ebXML Routing Router Inc. Credit Inc. SendMessage:sent

ebXML Routing Buyer Inc. Router Inc. MessageRouting:proc

ebXML Routing Buyer Inc. Router Inc. SendMessage:Received


ebXML Default Router Inc. Buyer Inc. Pong





ebXML Routing Seller Inc. Credit Inc. SendMessage:sent

ebXML Default Credit Inc. Seller Inc. Ping





ebXML Routing Buyer Inc. Router Inc. SendMessage:received


7


v1.0 Sync

v1.0 Async


ebXML Receipt Router Inc. Buyer Inc. DeliveryReceipt

ebXML Receipt Router Inc. Buyer Inc. SendMessage:Sent


ebXML Routing Credit Inc. Router Inc. SendMessage:Sent

ebXML Default Seller Inc. Credit Inc. Acknowledgement


ebXML Default Seller Inc. Credit Inc. SendMessage:sent

ebXML Routing Seller Inc. Credit Inc. SendMessage:Sent

ebXML Payload Credit Inc. Seller Inc. Payload:proc

ebXML Default Credit Inc. Router Inc. Acknowledgement

ebXML Default Credit Inc. Seller Inc. SendMessage:ack

ebXML Payload Credit Inc. Router Inc. SendMessage:sync

ebXML Routing Router Inc. Credit Inc. RouteMessage:proc

ebXML Default Router Inc. Buyer Inc. Acknowledgement

ebXML Routing Router Inc. Credit Inc. SendMessage:ack

ebXML Default Router Inc. Buyer Inc. SendMessage:sync

ebXML Routing Buyer Inc. Router Inc. RouteMessage:proc












8


v2.0 Sync



ebXML Payload Credit Inc. Router Inc. SendMessage:sent








ebXML Default Router Inc. Buyer Inc. Acknowledgment

ebXML Default Router Inc. Buyer Inc. SendMessage:Sent









ebXML Payload Credit Inc. Seller Inc. SendMessage:ack

ebXML Default Credit Inc. Router Inc. SendMessage:sync








9


v2.0 Async

The sendSign Sample

This sample sends an XML digitally signed message via intermediate nodes. Buyer Inc. generates a signed payload message that is routed via Router Inc. and Credit Inc. to Seller Inc. Seller Inc. processes the payload message and responds with a signed DeliveryReceipt (ebMS 1.0) or a signed Acknowledgement (ebMS 2.0). The response is routed via Credit Inc. and Router Inc. to Buyer Inc. Each intermediate node, including Seller Inc., sends an unsigned Acknowledgement to the previous node on receipt of the payload message.














ebXML Default Credit Inc. Router Inc. SendMessage:sent







10


v1.0 Sync

v1.0 Async





ebXML Routing Credit Inc. Router Inc SendMessage:Sent

























11


v2.0 Sync









ebXML Routing Buyer Inc. Roter Inc. SendMessage:received





















12


v2.0 Async

The sendSignAndEncrypt Sample

This sample sends an XML digitally signed message with S/MIME signed and encrypted payload via intermediate nodes. Buyer Inc. generates a signed payload message that is routed via Router Inc. and Credit Inc. to Seller Inc. Seller Inc. processes the payload message and responds with a signed DeliveryReceipt (ebMS 1.0) or a signed Acknowledgement (ebMS 2.0). The response is routed via Credit Inc. and Router Inc. to Buyer Inc. Each intermediate node, including Seller Inc., sends an unsigned acknowledgement to the previous node on receipt of the payload message.





















13


v1.0 Sync

v1.0 Async






























14


v2.0 Sync


















ebXML Default Credit Inc. Router Inc Acknowledgement












15


V2.0 Async

The status Sample

This sample sends a StatusRequest/StatusResponse message via intermediate nodes. Buyer Inc. generates a StatusRequest message that is routed via Router Inc. and Credit Inc. to Seller Inc. Seller Inc. processes the StatusRequest message and responds with a StatusResponse message that is routed via Credit Inc. and Router Inc. to Buyer Inc.


Sync





















ebXML Default Router Inc. Buyer Inc. StatusResponse


16


Async

Samples in the order Folder

The order folder contains a sample for sending ordered ebXML messages.




ebXML Routing Seller Inc. Credit Inc. SendMessage:sync

ebXML Default Credit Inc. Seller Inc. StatusRequest





ebXML Routing Buyer Inc. Router Inc. SendMessage:Received


ebXML Default Router Inc. Buyer Inc. StatusResponse





ebXML Routing Seller Inc. Credit Inc. SendMessage:sent

ebXML Default Credit Inc. Seller Inc. StatusRequest







17


Prerequisites


The sendPO Sample

This sample sends an XML purchase order (PO) to Seller Inc. that sends back a transport level unsigned Acknowledgment. The TPA created for this sample incorporates all required settings for message ordering. See the ebXML 2.0 Message Service Specification document for more information on message ordering.

In webMethods Trading Networks Console, you will see the following messages in the Transaction Analysis view:

Samples in the ping Folder

The ping folder contains a sample for sending an ebXML Ping message.

Prerequisites


The ping Sample

This sample sends a Ping message from Buyer Inc. to Seller Inc.. The Ping message can be synchronous or asynchronous depending on the TPA configuration. Seller Inc. responds with a Pong message.



ebXML Default Seller Inc. Buyer Inc. Acknowledgment



ebXML Payload Buyer Inc. Seller Inc. SendMessage:received

18


Sync

Async

Samples in the receipt Folder

The receipt folder contains a sample for sending a DeliveryReceipt for a previously sent ebXML message.

Prerequisites


Run the sendPO:sendPO service to have an ebXML BizDoc in place before running the sample.

The sendDeliveryReceipt Sample

This sample is specific to ebMS 1.0. It takes as input the bizDocID (Internal ID) of a previously sent ebXML message and sends a DeliveryReceipt corresponding to it.



ebXML Default Seller Inc. Buyer Inc. Pong

ebXML Default Seller Inc. Buyer Inc. SendMessage:sync

ebXML Payload Buyer Inc. Seller Inc. Ping



ebXML Default Seller Inc. Buyer Inc. Pong

ebXML Default Seller Inc. Buyer Inc. SendMessage:send

ebXML Payload Buyer Inc. Seller Inc. Ping


19


v1.0 Sync/Async

Samples in the reliable Folder

The reliable folder contains samples for sending the business document within an ebXML message in reliable mode.

Prerequisites


The sendPO Sample

This sample sends an XML Purchase Order (PO) from Buyer Inc. to Seller Inc. in a reliable mode. The TPA is configured with reliable delivery parameters such as Retries and RetryInterval. After sending the PO, Buyer Inc. waits for the amount of time specified in the RetryInterval for an Acknowledgement from Seller Inc. If it does not receive an Acknowledgement, Buyer Inc. resends the same PO. This process continues until either the Acknowledgement comes in or the retry interval is reached.

After running the sample, you will see the following messages in the Transaction Analysis view in webMethods Trading Networks Console. Note that the following results are shown for a synchronous protocol.

Case 1: This case shows that an Acknowledgement has been received in the first attempt.

Case 2: This case shows that Buyer Inc. has made four attempts to resend the PO to Seller Inc. but for some reason Seller Inc. is unable to send an Acknowledgement back.


ebXML Receipt Seller Inc. Buyer Inc. DeliveryReceipt

ebXML Receipt Seller Inc. Buyer Inc. SendMessage:sent






20


Samples in the route Folder

The route folder contains samples that show the usage of the wm.ip.ebxml.MSH:routeUsingTPA service.

The routePO Sample

This sample resends an ebXML message previously exchanged between Buyer Inc. and Seller Inc. via an intermediary Router Inc. Before sending the message via Router Inc., the sample also modifies the original TPA between Buyer Inc. and Seller Inc. to include routing information.

After running the sample, you will see the following messages in the Transaction Analysis view in webMethods Trading Networks Console. The last four documents correspond to the direct exchange of ebXML messages between Buyer Inc. and Seller Inc.

v2.0 Sync

TN Document Type Sender Receiver ProcessingStatus User Status

ebXML Default Seller Inc. Buyer Inc. DONE SendMessage:err




ebXML Payload Buyer Inc. Seller Inc. DONE Payload:proc

ebXML Payload Buyer Inc. Seller Inc. WAITINGFOR ACK

SendMessage:4




ebXML Routing Seller Inc. Router Inc. Payload:proc

ebXML Routing Seller Inc. Router Inc. Acknowledgement

ebXML Payload Router Inc. Seller Inc. SendMessage:ack

ebXML Payload Router Inc. Seller Inc. SendMessage:sync


ebXML Routing Buyer Inc. Router Inc. Acknowledgement



21


v2.0 Async

Samples in the security.Mixed Folder

The security.Mixed folder contains samples for the combined usage of XML Security and SMIME Security facilities to provide security for your business document(s) within an ebXML message. It also contains a sample for combining an SMIME Security facility with a payload compression.

Prerequisites

Install the webMethods ebXML Module 7.1 SP1 Security Package before you run any sample. For more information about this package, see the webMethods ebXML Module Installation and User’s Guide.


Set up certificates for all trading partner profiles.






ebXML Routing Seller Inc. Router Inc. Payload:proc

ebXML Routing Seller Inc. Router Inc. Acknowledgement

ebXML Payload Router Inc. Seller Inc. SendMessage:ack

ebXML Payload Router Inc. Seller Inc. SendMessage:sync


ebXML Routing Buyer Inc. Router Inc. Acknowledgement






22


The sendXMLAndSMIME Sample

This sample sends three XML digitally signed Purchase Orders (POs) to Seller Inc. that verifies the signed POs. One of the POs is SMIME signed, one is SMIME encrypted, and one is SMIME signed and encrypted. The POs are XML digitally signed before they are processed by one of the SMIME operations (sign/encrypt/sign and encrypt).

The sendZipAndSMIME Sample

This sample sends three XML digitally signed Purchase Orders (PO) to Seller Inc. that verifies the signed POs. The POs are initially compressed through a zip compression algorithm, then XML digitally signed and finally processed by one of the SMIME operations (sign/encrypt/sign and encrypt).

After running any of the samples above, you will see the following messages in the Transaction Analysis view in webMethods Trading Networks Console:

Samples in the security.MSHSignals Folder

The security.MSHSignals folder contains a sample for sending a signed XML payload and requesting a signed Acknowledgement in response.

Prerequisites



The sendSignedAckRequest Sample

This sample sends an XML digitally signed purchase order (PO) to Seller Inc. that sends back a transport level XML digitally signed acknowledgment. The payload can be anything you want to send, for example EDI or RosettaNet PIPs.





23


Sync

Async

Samples in the security.SMIME Folder

The security.SMIME folder contains a sample for using the SMIME facilities to provide security for your business document(s) within an ebXML message.

Prerequisites



The sendSMIME Sample

This sample sends three XML Purchase Orders (PO) to Seller Inc. One of the POs is signed, one is encrypted, and one is both signed and encrypted using S/MIME.















24


Samples in the security.XML Folder

The security.XML folder contains samples for using the XML Security facilities to provide security for your business document(s) within an ebXML message.

Prerequisites

Install the webMethods ebXML Module 7.1 SP1 Security Package before you run any sample.

Set up certificates for all trading partner profiles.


The sendEncrypt Sample

This sample is the same as the sendSign sample except that the POs are XML encrypted instead of XML signed.

The sendSign Sample

This sample sends three XML digitally signed Purchase Orders (PO) to Seller Inc. that verifies the signed POs.

The sendSignAndEncrypt Sample

This sample is the same as the sendSign sample except that the POs are both XML signed and encrypted.


Samples in the sendBizDoc Folder

The sendBizDoc folder contains a sample for sending any Trading Networks document (having content part as a payload) as an ebXML payload message.




25


Prerequisites

Run the tpa:createTPA_BizDoc service to create the TPA required for running the sendBizDoc sample. Set the sync parameter to true/false as desired during the TPA creation.

The sendBizDoc Sample

This sample sends existing payloads from Buyer Inc. to Seller Inc. The payloads are retrieved from any existing Trading Networks document and passed on to the sendBizDoc service. The sendBizDoc sample first sends the payloads through the sendUsingTPA service and then passes the persisted ebXML payload document (BizDocEnvelope) to the sendBizDoc service. It also expects the packaging information.


Samples in the sendPO Folder

The sendPO folder contains a sample for sending the business document within an ebXML message.

Prerequisites


The sendPO Sample

This sample sends an XML Purchase Order (PO) from Buyer Inc. to Seller Inc. This PO will be sent with Content-Transfer-Encoding as binary. Seller Inc. processes the payload by extracting a service name and type from the ebXML message and invokes the service if it exists. After processing the payload, Seller Inc., acknowledges the Buyer Inc. by replying with an Acknowledgement message.






26


Sync

Async

Samples in the status Folder

The status folder contains a sample for sending a StatusRequest ebXML message.

Prerequisites


Run any send service that sends an ebXML message, for example basic71.ms20.sendPO. After executing the service, note the messageID that is returned.

The sendStatusRequest Sample

This sample sends a StatusRequest ebXML message from Buyer Inc. to Seller Inc. Seller Inc. looks for the received StatusRequest messageID in the persistence storage, and if it exits, sends the StatusResponse ebXML message back as a response.

After running the sample, you will see the following messages in the Transaction Analysis view in webMethods Trading Networks Console.











27


Sync

Async

Samples in the tn Folder

The tn folder contains a sample for extracting payloads from an ebXML Payload business document.

The testPayloads Sample

This sample extracts payloads from an existing ebXML Payload document in Trading Networks. The sample expects a bizDocID as input, the value of which should map to the InternalID of an existing ebXML Payload document in Trading Networks. The format of the extracted payload is defined by the IS document type wm.ip.ebxml.rec:Payload.


ebXML Default Seller Inc. Buyer Inc. StatusResponse


ebXML Default Buyer Inc. Seller Inc. StatusRequest

ebXML Default Buyer Inc. Seller Inc. SendMessage:received


ebXML Default Seller Inc. Buyer Inc. StatusResponse


ebXML Default Buyer Inc. Seller Inc. StatusRequest

ebXML Default Buyer Inc. Seller Inc. SendMessage:received

28

About the webMethods ebXML Module Sample...

Documents

Transcript of About the webMethods ebXML Module Sample...