Using ebXML

The following topics are provided about the ebXML-based business protocol that WebLogic Integration - Business Connect supports.

Concepts

• Supported Transports

• ebXML Overview

• Using Message Control Documents

• MCD Element Descriptions

• Optional ebXML MessageAgentInfo Elements

• MCD Example for ebXML

 

---

Supported Transports

WebLogic Integration - Business Connect supports ebXML trading with the following transports:

• bundled HTTP

• bundled HTTPS

• SMTP

• POP

Your organization must have a thorough understanding and working knowledge of ebXML to successfully trade documents using this business protocol. For information about ebXML see www.ebxml.org.

 

---

ebXML Overview

ebXML, sponsored by UN/CEFACT and OASIS, is a modular suite of specifications that enables a company located anywhere to conduct business over the Internet. ebXML embodies the definition and registration of processes for exchanging business messages, conducting trading relationships and communicating data in common terms.

WebLogic Integration - Business Connect supports version 1.0 of the ebXML Transport, Routing and Packaging (TRP) specification and a subset of version 1.0 of the ebXML Collaboration Protocol Agreement (CPA). WebLogic Integration - Business Connect supports packaging and transporting any document type according to the 1.0 TRP specification.

WebLogic Integration - Business Connect supports two methods for exchanging documents with the ebXML protocol. One method supports ebXML business processes and back-end system integration. The other does not, but enables partners to trade documents that are packaged as ebXML documents.

The following topics describe both of these methods:

• ebXML with MCD Interface

• ebXML with File System Interface

ebXML with MCD Interface

WebLogic Integration - Business Connect supports ebXML business processes using Message Control Documents (MCDs) as the interface between it and a back-end system. The MCDs are XML documents that contain an arbitrary payload and information that WebLogic Integration - Business Connect uses to process outbound and inbound ebXML documents. Figure  6-1 and Figure  6-2 show high-level views of ebXML processing with the MCD interface in WebLogic Integration - Business Connect.

Figure 6-1 ebXML with MCD Interface Outbound Processing

 

For outbound processing, WebLogic Integration - Business Connect does the following:

• Retrieves the MCD from the XML-out directory.

• Validates the incoming MCD against an MCD schema that resides on the Internet.

• Uses the SenderId and ReceiverId of the MCD to look up a CPA document.

• If there is a CPA, loads the file and extracts document packaging information.

• If there is no CPA, uses information from the MCD and partner profile for packaging.

• Packages the ebXML document.

• Sends the ebXML document to the partner.

  Figure 6-2 ebXML with MCD Interface Inbound Processing

  
   

For inbound processing, WebLogic Integration - Business Connect does the following:

• Receives an ebXML document or acknowledgment.

• Unpackages the document or acknowledgment and sends it to the ebXML Message Service Handler (MSH).

• Uses the CPAId of the inbound ebXML document to look up a CPA document.

• If there is a CPA, loads the file and extracts information which for reliable messaging parameters.

• For an inbound document, the MSH queries the CPA, if present, or the inbound document itself for whether an acknowledgement document is to be created and sent back to the sender.

• Wraps the inbound document, if the destination is the back-end system and not the MSH in an MCD.

• Puts the MCD in the XML-in directory.

WebLogic Integration - Business Connect supports the use of CPAs with the MCD interface. A CPA is an agreement between two or more parties that specifies the transport, messaging and security protocols to use in trading. WebLogic Integration - Business Connect supports file system-based lookups of CPA documents.

WebLogic Integration - Business Connect supports a subset of the CPA document, including security and reliable messaging settings for a specific DeliveryChannel. Parsing based on CollaborationRole is not supported. If there is more than one CollaborationRole element in a CPA, WebLogic Integration - Business Connect extracts the first one and uses it to resolve the specific DeliveryChannel to use. There is no automated support for creating or importing CPAs. You must provide pre-defined CPA documents.

You must edit the CpaRegistry.xml file for each CPA you use. This file is in the WebLogic Integration - Business Connect mcd\ebxml\config directory. The value for the CPA element must be a valid URL that references the location of the CPA document. A sample CPA document is in the WebLogic Integration - Business Connect mcd\ebxml\cpas directory. We recommend this directory as the location for your CPAs.

ebXML with File System Interface

WebLogic Integration - Business Connect can retrieve any type of document from the EDI-out, XML-out or binary-out directory. Documents also can be retrieved from an API client or integration points. This method does not support ebXML business processes, but enables partners to exchange documents that are packaged as ebXML documents.

WebLogic Integration - Business Connect can use the the MCD interface after editing certain values in the MCDHandlerConfig.xml file in the WebLogic Integration - Business Connect MCD directory.

In the following two properties, change false to true. False, which is the default for both, enables the file system interface. True enables the MCD interface.

<mcdconfig:Property name="requireOutboundMcd">false</mcdconfig:Property>

<mcdconfig:Property name="generateInboundMcd">false</mcdconfig:Property>

Complete the following two properties. Type your own values for service and action. These can be any values you choose.

Note: When trading with a WebLogic Integration trading partner, the value of service must match the name of the conversation definition defined in WebLogic Integration. There are no WebLogic Integration requirements for the value of the action.

<mcdconfig:Property name="defaultService">service</mcdconfig:Property>

<mcdconfig:Property name="defaultAction">action</mcdconfig:Property>

Note: Using the ebXML file system interface, if Cyclone Activator receives an ebXML package that contains multiple attachments, one MDN acknowledgment is sent to the sender. The control ID of the acknowledgment will be the same as one of the inbound attachment's. Which control ID is used depends on the order the inbound documents are unpackaged and logged. A control ID can be the control ID of an EDI document, XML for an XML document or binary for a binary document.

Figure  6-3 and Figure  6-4 show high-level views of ebXML processing with the file system interface in WebLogic Integration - Business Connect.

Figure 6-3 ebXML with File System Interface Outbound Processing

 

For outbound processing, WebLogic Integration - Business Connect does the following:

• Retrieves the document from the EDI-out, XML-out or binary-out directory or from the API or integration points.

• Uses information from the partner profile for packaging.

• Packages the document as an ebXML document.

• Sends the ebXML document to the partner.

  Figure 6-4 ebXML with File System Interface Inbound Processing

  
   

For inbound processing, WebLogic Integration - Business Connect does the following:

• Receives an ebXML document or acknowledgment.

• Unpackages the document or acknowledgment.

• For an inbound document, an acknowledgement is created and sent back to the sender.

• Puts the document in the EDI-in, XML-in or binary-in directory or sends to the document API or integration points.

 

---

Using Message Control Documents

A Message Control Document (MCD) is an XML document that is used in the WebLogic Integration - Business Connect implementation of the ebXML business protocol. An MCD is an interface between a back-end system and WebLogic Integration - Business Connect for processing business messages.

The following topics explain more about the use of MCDs:

• MCDs for ebXML

• MCD Element Descriptions

• Optional ebXML MessageAgentInfo Elements

• MCD Example for ebXML

MCDs for ebXML

For ebXML, an MCD is an interface between a back-end business application and the WebLogic Integration - Business Connect ebXML engine. MCDs support ebXML 1.0.

MCDs are used to:

• Send outgoing business documents from the back-end system to WebLogic Integration - Business Connect

• Send incoming business documents from WebLogic Integration - Business Connect to the back-end system

For ebXML processing, MCDs are used to:

• Send outgoing ebXML business documents from the back-end system to the ebXML engine.

• Send incoming ebXML business documents from the ebXML engine to the back-end system.

MCD Element Descriptions

Table  6-2 lists the information elements used in an MCD to send business documents between a back-end system and WebLogic Integration - Business Connect. The definitions of the letters in the Usage column are summarized in Table  6-1.

Table 6-1 Key

This letter . . .	In this column . . .	Indicates that the element is . . .
R	Usage	Required in the MCD produced by the back-end system.
O	Usage	Optional in the MCD produced by the back-end system.
C	Usage	Optional only when a CPA is present.

 

Also see the following topic, Optional ebXML MessageAgentInfo Elements.

Table 6-2 MCD Information Elements  

MCD element			Description	Usage
PackagingProtocol
	Standard		Contains a value, ebXML, indicating the protocol in which the outbound message or acknowledgement is to be packaged or the packaging protocol used by the inbound message or acknowledgement. The MCD supports CIDX and ebXML packaging standards.	R
	Version		Contains a value indicating the version, 01.10, 02.00 or 01.00, of the packaging protocol.	R
Service			Back-end system service name (ebXML BPSS Service). If a CPA is present this is an optional element, otherwise it is required.	C
	Type		If Service value is not a valid URI then use the type attribute to indicate the format of the Service value.	O
Action			Back-end system document action name.	R
TimeStamp			The creation time of the MCD.	O
CorrelationId			An identifier that matches multiple documents to the same process flow.	R
RoutingInfo
	SenderID		A unique business identifier for the sender of a message.	R
	ReceiverID		A unique business identifier for the receiver of a message.	R
TransportInfo
	SessionID		A unique identifier for a specfic transport session. This identifier is used when sending multiple message using the same transport instance. If the SessionID is present on an inbound message, it must be copied to the outbound response MCD.	O
	MaxRetrys		The maximun number of times to retry sending a message at the message level.	O
	RetryInterval		The time to wait for an acknowledgement before resending a document.	O
MessageAgentInfo			An optional element for attaching protocol-specific information. See Optional ebXML MessageAgentInfo Elements.	O
ManifestInfo
	MessageContentInfo		Contains a back-end system business payload.
		MIME Content ID	A unique identifier for this part of the message.	R
		MIME Content Type	The MIME content type of the payload.	R
		Description	A string describing the payload.	O
		URI	An optional pointer to the actual data. URI or Body, but not both, must be specified.	R
		Body	The actual data for this section of the message. URI or Body, but not both, must be specified.	R
StatusInfo			The status information container.	O
	StatusType		The type of status message, acknowledgement or exception.	O
	ExceptionInfo		Exception Info if Status Type = Exception.	O
		Error Description	A description of the error.	O
		Error Classification	The classification of the error.	O
		Offending Message Component	The section of the message that generated the error.	O
		Exception Type	The type of exception received.	O
	DigestInfo
		DigestValue	A base64 encoded digest value.	O
		DigestAlgorithm	The algorithm used in computing the digest.	O

 

Optional ebXML MessageAgentInfo Elements

The following table lists the optional MessageAgentInfo elements for ebXML. These elements are optional only when a CPA is present.

Note: The settings in the MCD for signing, encrypting and requesting acknowledgments should match the settings on the Partner Profile window Security tab or inbound documents from the partner will be rejected.

Table 6-3 Optional MessageAgentInfo Elements  

MessageAgentInfo element					Description
ebXML					An MCD extension element for ebXML-specific options.
	ebXMLBinding
		ReliableMessaging			Contains ebXML Reliable Messaging specific data.
			Retries		The maximum number of times to retry sending a message at the message level. Overrides the MCD MaxRetries element.
			RetryInterval		The time to wait for an acknowledgement before resending a document.
			PersistDuration		n/a
			Acknowledgement		The ackRequested attribute specifies if the ebXML engine should request an acknowledgement. Values are Signed, Unsigned and None.
		DeliveryReceipt			The deliveryReceiptRequested attribute specifies if the ebXML engine should request a DeliveryReceipt. Values are Signed, Unsigned and None.
		Envelope			Security related values for the ebXML header envelope.
			NonRepudiation		Non-repudiation specific values.
				Protocol	The non-repudiation protocol to use for the ebXML envelope. Only XMLDSIG is supported. Value is http://www.w3.org/2000/09/xmldsig#.
				HashFunction	The hash function to use for XMLDSIG non-repudiation protocol. Only SHA1 is supported. Value is http://www.w3.org/2000/09/xmldsig#sha1.
			DigitalEnvelope		Encryption specific values. Currently, ebXML header envelope encryption is not supported.
				Protocol	The encryption protocol to use for the ebXML envelope.
				EncryptionAlgorithm	The encryption algorithm to use.
		ManifestInfo			Security related values for the ebXML payloads.
			NonRepudiation		Non-repudiation specific values.
				Protocol	The non-repudiation protocol to use for the ebXML payloads. Only S/MIME is supported. Value is S/MIME.
				HashFuntion	The hash function to use for the S/MIME non-repudiation protocol.
			DigitalEnvelope		Encryption specific values.
				Protocol	The encryption protocol to use for the ebXML envelope. Only S/MIME is supported. Value is S/MIME.
				EncryptionAlgorithm	The encryption algorithm to use.

 

 

---

ebXML Document Processing Settings

Processing settings such as document signing and acknowledgments can be specified a number of ways for outbound and inbound ebXML documents. You need to know how WebLogic Integration - Business Connect parses processing settings to properly configure CPAs, MCDs and WebLogic Integration - Business Connect partner profiles. The following topics provide this information:

• Outbound ebXML Document Processing Settings

• Inbound ebXML Document Processing Settings

• ebXML Processing Settings at a Glance

Outbound ebXML Document Processing Settings

The following table describes how WebLogic Integration - Business Connect determines the processing settings for outbound ebXML documents.

Table 6-4 Outbound Document Processing Settings  

Outbound documents
Setting	ebXML 1.0 with MCDs	ebXML 1.0 with File System Interface
Sign document	The system first looks for this setting in an optional CPA, if present. If not specified, it looks in the MCD. If not specified in a CPA or the MCD, the document is not signed. You and your partner must have the same setting or documents are rejected.	The WebLogic Integration - Business Connect partner profile specifies whether outbound documents are signed. You and your partner must have the same setting or documents are rejected.
Request acknowledgment	The system first looks for this setting in an optional CPA, if present. If not specified, it looks in the MCD. If not specified in a CPA or the MCD, an acknowledgment is not requested for the document. You and your partner must have the same setting or documents are rejected.	The WebLogic Integration - Business Connect partner profile specifies whether acknowledgments are requested for outbound documents. You and your partner must have the same setting or documents are rejected.
Request signed acknowledgment	The system first looks for this setting in an optional CPA, if present. If not specified, it looks in the MCD. If not specified in a CPA or the MCD, a signed acknowledgment is not requested for the document. You and your partner must have the same setting or documents are rejected.	The WebLogic Integration - Business Connect partner profile specifies whether signed acknowledgments are requested for outbound documents. On the Security tab, the sign document and request acknowledgment check boxes must both be selected. You and your partner must have the same setting or documents are rejected.
Request synchronous acknowledgment	The system first looks for this setting in an optional CPA, if present. If not specified, it looks in the MCD. If not specified in a CPA or the MCD, a synchronous acknowledgment is not requested for the document. A synchronous acknowledgment can be requested only when the transport is bundled HTTP or bundled HTTPS.	The WebLogic Integration - Business Connect partner profile specifies whether synchronous acknowledgments are requested for outbound documents. A synchronous acknowledgment can be requested only when the transport is bundled HTTP or bundled HTTPS.
Number of times to try to resend upon failure	The system first looks for this setting in an optional CPA, if present. If not specified, it looks in the MCD's ReliableMessaging element. If not specified, it looks in the MCD's TransportInfo element. If not specified in a CPA or the MCD, the WebLogic Integration - Business Connect partner profile specifies the number of times to try resending documents.	The WebLogic Integration - Business Connect partner profile specifies the number of times to try resending documents.
Resend interval	The system first looks for this setting in an optional CPA, if present. If not specified, it looks in the MCD's ReliableMessaging element. If not specified, it looks in the MCD's TransportInfo element. If not specified in a CPA or the MCD, the WebLogic Integration - Business Connect partner profile specifies the interval for trying to resend documents.	The WebLogic Integration - Business Connect partner profile specifies the interval for trying to resend documents.
Signature algorithm to use	Inclusion of an XML digital signature is controlled by the mcd-ext:Envelope element and sub elements. The supported algorithm is SHA1. The XML digital signature is calculated over the SOAP envelope and the payloads. Signing individual payloads is controlled by the mcd-ext:ManifestInfo element and sub elements. The mcd-ext:ManifestInfo element controls S/MIME signing of the payloads.	Inclusion of an XML digital signature is controlled by the WebLogic Integration - Business Connect partner profile sign document setting. If this setting is on, SHA1 is used to calculate a signature over the SOAP Envelope and Payloads. Signing individual payloads is controlled by the same setting. The payloads are signed using the algorithm selected in the WebLogic Integration - Business Connect partner profile for message digests.
Document encryption	The WebLogic Integration - Business Connect partner profile specifies whether documents are encrypted before sending to partners. You and your partner must have the same setting or documents are rejected.	The WebLogic Integration - Business Connect partner profile specifies whether documents are encrypted before sending to partners. You and your partner must have the same setting or documents are rejected.
Action	The system looks in the MCD for the action.	If you are using an API, this setting can be specified in the sendDocument call. If you are using JMS global integration, this setting can be included as a string property. You also can specify the action in the MCDHandlerConfig.xml file in the WebLogic Integration - Business Connect MCD directory.
Service	The system looks in the MCD for the service.	If you are using an API, this setting can be specified in the sendDocument call. If you are using JMS global integration, this setting can be included as a string property. You also can specify the action in the MCDHandlerConfig.xml file in the WebLogic Integration - Business Connect MCD directory.

 

Inbound ebXML Document Processing Settings

The WebLogic Integration - Business Connect partner profile specifies whether signatures are required on inbound documents by virtue of whether document signing is set for outbound documents. If you digitally sign outbound XML documents, WebLogic Integration - Business Connect expects inbound documents also to be signed. S/MIME signing of individual payloads is expected if the sign document setting is on.

The same situation applies to whether acknowledgments you send partners are signed and whether inbound documents are encrypted. If the partner profile requests signed acknowledgments from a partner, you also send signed acknowledgments. In the same manner, if the profile specifies that outbound documents are to be encrypted, WebLogic Integration - Business Connect expects inbound documents to be encrypted.

ebXML Processing Settings at a Glance

The following tables provide quick-scan views of how WebLogic Integration - Business Connect determines the processing settings for ebXML documents. The columns represent the places and the order that WebLogic Integration - Business Connect checks for these settings. Check marks indicate whether WebLogic Integration - Business Connect checks for a particular setting. WebLogic Integration - Business Connect determines the setting in the first place it is found. That is, if the system looks in the CPA for a setting and cannot find it, the system looks next in the MCD and, lastly, in the WebLogic Integration - Business Connect partner profile. Conversely, if the system finds the setting in the CPA, it stops looking.

ebXML 1.0 with MCDs

Outbound documents
Setting	1. CPA	2. MCD	3. Partner profile
Sign document
Request acknowledgment
Request signed acknowledgment
Request synchronous acknowledgment
Number of times to try to resend upon failure
Resend interval
Signature algorithm to use
Document encryption
Action
Service

 

Inbound documents
Setting	1. CPA	2. Partner profile
Require signature
Require signed acknowledgment
Require encryption

 

ebXML 1.0 with File System Interface

Outbound documents
Setting	1. CPA	2. Partner profile
Sign document
Request acknowledgment
Request signed acknowledgment
Request synchronous acknowledgment
Number of times to try to resend upon failure
Resend interval
Signature algorithm to use
Document encryption
Action	see note below
Service	see note below

 

Note: See Outbound ebXML Document Processing Settings.

Inbound documents
Setting	1. CPA	2. Partner profile
Require signature
Require signed acknowledgment
Require encryption

 

 

---

MCD Example for ebXML

The following is an example of an MCD for an ebXML document. You can additional find examples of ebXML MCDs in the following directory:

installation_directory/MCD/ebxml/

WebLogic Integration - Business Connect validates MCDs using the following schema:

installation_directory/xmlschema/MCD_v2_0.xsd

For the optional MessageAgentInfo elements, WebLogic Integration - Business Connect also validates MCDs using the following schema:

installation_directory/xmlschema/MCD_Extension_ebXML_v1_0.xsd

Listing 6-1 MCD for an ebXML Document

    <?xml version="1.0" encoding="UTF-8" ?> 
- <mcd:MessageControlDocument xmlns:mcd="http://www.cyclonecommerce.com/Schemas/2001/08/mcd" 


xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" 


xsi:schemaLocation="http://www.cyclonecommerce.com/Schemas/2001/08/mcd 


http://www.cyclonecommerce.com/Schemas/2001/08/MCD_v2_0.xsd">
- <mcd:PackagingProtocol>
    <mcd:Standard>ebXML</mcd:Standard> 
    <mcd:Version>1.0</mcd:Version> 
    </mcd:PackagingProtocol>
    <mcd:MessageId /> 
    <mcd:Service>FileTransfer</mcd:Service> 
    <mcd:Action>Request</mcd:Action> 
    <mcd:TimeStamp>2001-10-04T15:48:01.813Z</mcd:TimeStamp> 
- <mcd:RoutingInfo>
    <mcd:SenderId type="Name">Worldwide</mcd:SenderId> 
    <mcd:ReceiverId type="Name">ACME</mcd:ReceiverId> 

    <mcd:MarketPlace /> 
    </mcd:RoutingInfo>
- <mcd:TransportInfo sessionId="">
    <mcd:MaxRetry>0</mcd:MaxRetry> 
    <mcd:RetryInterval>0</mcd:RetryInterval> 
    </mcd:TransportInfo>
- <mcd:TrackingInfo>
    <mcd:RefToMessageId>906d1c3f5590f139:723d7c:e959e6dbc5:-8111</mcd:RefToMessageId> 
    <mcd:CorrelationId>906d1c3f5590f139:723d7c:e959e6dbc5:-8000</mcd:CorrelationId> 
    </mcd:TrackingInfo>
- <mcd:MessagingAgentInfo>
- <mcd-ext:ebXML xmlns:mcd-ext="http://www.cyclonecommerce.com/Schemas/2001/10/mcd-ext-ebXML" 


xmlns:ds="http://www.w3.org/2000/09/xmldsig#" 


xsi:schemaLocation="http://www.cyclonecommerce.com/Schemas/2001/10/mcd-ext-ebXML 


http://www.cyclonecommerce.com/Schemas/2001/10/MCD_Extension_ebXML_v1_0.xsd">
- <mcd-ext:ebXMLBinding version="1.0">
- <mcd-ext:ReliableMessaging deliverySemantics="OnceAndOnlyOnce" 


messageOrderSemantics="NotGuaranteed">
    <mcd-ext:Retries>0</mcd-ext:Retries> 
    <mcd-ext:RetryInterval>0</mcd-ext:RetryInterval> 
    <mcd-ext:PersistDuration>0</mcd-ext:PersistDuration> 
    <mcd-ext:Acknowledgement ackRequested="Signed" /> 
    </mcd-ext:ReliableMessaging>
    <mcd-ext:DeliveryReceipt deliveryReceiptRequested="None" /> 
- <mcd-ext:Envelope>
- <mcd-ext:NonRepudiation>
    <mcd-ext:Protocol version="">http://www.w3.org/2000/09/xmldsig#</mcd-ext:Protocol> 
    <mcd-ext:HashFunction>http://www.w3.org/2000/09/xmldsig#sha1</mcd-ext:HashFunction> 
    </mcd-ext:NonRepudiation>
- <mcd-ext:DigitalEnvelope>
    <mcd-ext:Protocol version="" /> 
    <mcd-ext:EncryptionAlgorithm /> 
    </mcd-ext:DigitalEnvelope>
    </mcd-ext:Envelope>
- <mcd-ext:ManifestInfo>
- <mcd-ext:NonRepudiation>
    <mcd-ext:Protocol version="2.0">S/MIME</mcd-ext:Protocol> 
    <mcd-ext:HashFunction>SHA1</mcd-ext:HashFunction> 
    </mcd-ext:NonRepudiation>
- <mcd-ext:DigitalEnvelope>
    <mcd-ext:Protocol version="2.0">S/MIME</mcd-ext:Protocol> 
    <mcd-ext:EncryptionAlgorithm>DES-CBC</mcd-ext:EncryptionAlgorithm> 
    </mcd-ext:DigitalEnvelope>
    </mcd-ext:ManifestInfo>
    </mcd-ext:ebXMLBinding>
    </mcd-ext:ebXML>
   &