Using WebLogic Integration - Business Connect
|
 |
 |
|
|
 |
 |
The following topics are provided about the ebXML-based business protocol that WebLogic Integration - Business Connect supports.
WebLogic Integration - Business Connect supports ebXML trading with the following transports:
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 http://www.ebxml.org.
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 2.0 of the ebXML Messaging specification. WebLogic Integration - Business Connect also 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 2.0 Messaging specification and 1.0 TRP specification.
WebLogic Integration - Business Connect supports two methods for exchanging documents with the ebXML protocol. One method supports ebXML business processes. The other does not, but enables partners to trade documents that are packaged as ebXML documents. The following topics describe both of these methods:
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 11-1 and Figure 11-2 show high-level views of ebXML processing with the MCD interface in WebLogic Integration - Business Connect.
Figure 11-1 ebXML with MCD Interface Outbound Processing
For outbound processing, WebLogic Integration - Business Connect does the following:
Figure 11-2 ebXML with MCD Interface Inbound Processing
For inbound processing, WebLogic Integration - Business Connect does the following:
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.
MCDs are not used with the ebXML file system interface method. This method does not support ebXML business processes, but enables partners to trade documents that are packaged as ebXML documents.
With this method 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.
WebLogic Integration - Business Connect can use the file system integration method after editing certain values in the MCDHandlerConfig.xml file in the WebLogic Integration - Business Connect MCD directory. Open the file with a text editor, edit the properties as noted in the following paragraphs and then save and close the file. The properties to edit are grouped together in the file.
In the following two properties, verify that the value is set to false. 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>
Also complete the following three properties. Type your own values for service and action. These can be any values you choose. The third property is the version of the ebXML outbound packager to use. Valid values are 1.0 and 2.0. The default is 2.0.
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>
<mcdconfig:Property name="defaultVersion">2.0</mcdconfig:Property>
Note: Do not edit the attributes set in the parent element, mcdconfig:MessagingProtocol. The value set for mcdconfig:Property name="defaultVersion" controls the version of the ebXML outbound packager.
Note: Using the ebXML file system interface, if WebLogic Integration - Business Connect receives an ebXML package that contains multiple attachments, one 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 11-3 and Figure 11-4 show high-level views of ebXML processing with the file system interface in WebLogic Integration - Business Connect.
Figure 11-3 ebXML with File System Interface Outbound Processing
For outbound processing, WebLogic Integration - Business Connect does the following:
Figure 11-4 ebXML with File System Interface Inbound Processing
For inbound processing, WebLogic Integration - Business Connect does the following:
WebLogic Integration - Business Connect by default does not validate ebXML documents that are inbound from the Internet against an external XML schema. It can do so for ebXML 2.0 documents if you edit a property in the msh_config.xml file, which is in the WebLogic Integration - Business Connect mcd directory. You can enable schema validation only for ebXML 2.0 documents. Trading fails if you enable it for ebXML 1.0 documents.
Enabling external validation ensures strict adherence of inbound documents to the XML schema. The XML parser validates the ebXML message against the schema URI specified by the schemaLocation attribute located at the root element of the message. Enabling schema validation bypasses the validation the application itself performs against the document using the msh_config.xml file.
To enable validation against the XML schema, open the msh_config.xml file with a text editor and locate the following property near the top of the file:
<msh:Property name="msh.message.validate">false</msh:Property>
Change the value false, which disables schema validation, to true. Then save and close the file.
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:
For ebXML, an MCD is an interface between a back-end business application and the WebLogic Integration - Business Connect ebXML engine.
For ebXML processing, MCDs are used to:
Table 11-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 11-1.
Also see the following topic, 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.
You can place any type of data you want in an MCD used for ebXML trading that is not otherwise defined in the MCD. You define the elements in a specific format in the MCD and then provide values for them.
Figure 11-5 shows the proper location of the user-defined meta-data elements after the end of the StatusInfo element. The meta-data are between the opening and closing cyclone-prop:Property elements. The user-defined data in this example are username and password and their values.
Figure 11-5 User-Defined Meta-Data Elements in ebXML MCD
The soap:mustUnderstand property in the first line can have a value of 0 or 1. A value of 0 means your partner's ebXML message service handler (MSH) is not required to understand the cyclone-prop:Property elements and the user-defined data. If the receiving system does not understand, it can ignore the elements and the data. A value of 1 forces your partner's trading software to understand the data or else reject the ebXML document and respond with a soap:mustUnderstand fault or an ebXML not supported error message. If you are trading with a WebLogic Integration partner, use 0.
The following is an example from Figure 11-5 of a user-defined element and its value. You can define as many elements are you want.
<cyclone-prop:Property cyclone-prop:name="password">abcdefg</cyclone-prop:Property>
The following describe the attributes that are used for user-defined data. These are required and need to be used as-is.
The following attribute defines the cyclone-prop namespace prefix:
xmlns:cyclone-prop=http://www.cyclonecommerce.com/namespaces/properties attribute
The following attribute defines the SOAP namespace prefix:
xmlns:soap=http://schemas.xmlsoap.org/soap/envelope/
The following attribute points to the WebLogic Integration - Business Connect properties schema:
xsi:schemaLocation
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:
The following table describes how WebLogic Integration - Business Connect determines the processing settings for outbound ebXML documents.
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.
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.
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
|
|
|
|
|
|
|
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
||
|
|
||
|
|
||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
|
|
||
Note: See Outbound ebXML Document Processing Settings.
|
|
||
|
|
||
|
|
||
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/
Listing 11-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>2.0</mcd:Version>
</mcd:PackagingProtocol>
<mcd:MessageId></mcd:MessageId>
<mcd:Service type="string">MCD Test</mcd:Service>
<mcd:Action>Request</mcd:Action>
<mcd:TimeStamp>2002-05-13T09:07:10.733Z</mcd:TimeStamp>
<mcd:RoutingInfo>
<mcd:SenderId type="Name" role="http://www.ebxml.org/roles/Buyer">Company1</mcd:SenderId>
<mcd:ReceiverId type="Name" role="http://www.ebxml.org/roles/Seller">Company2</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/>
<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" syncReply="true">
<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:ebXMLBinding>
</mcd-ext:ebXML>
</mcd:MessagingAgentInfo>
<mcd:StatusInfo type="">
<mcd:Description/>
<mcd:ExceptionInfo type="">
<mcd:ErrorDescription/>
<mcd:ErrorClassification/>
<mcd:OffendingMessageComponent/>
</mcd:ExceptionInfo>
<mcd:DigestInfo>
<mcd:DigestValue/>
<mcd:DigestAlgorithm/>
</mcd:DigestInfo>
</mcd:StatusInfo>
<cyclone-prop:Properties soap:mustUnderstand="1" xmlns:cyclone-prop="http://www.cyclonecommerce.com/namespaces/properties" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xsi:schemaLocation="http://www.cyclonecommerce.com/namespaces/properties http://www.cyclonecommerce.com/Schemas/2002/05/cyclone-properties.xsd">
<cyclone-prop:Property cyclone-prop:name="username">jturpin</cyclone-prop:Property>
<cyclone-prop:Property cyclone-prop:name="password">abcdefg</cyclone-prop:Property>
</cyclone-prop:Properties>
<mcd:ManifestInfo>
<mcd:MessageContentInfo id="ID25789961021306030733REMERY2">
<mcd:MIMEContentId>Large-XML</mcd:MIMEContentId>
<mcd:MIMEContentType>application/xml</mcd:MIMEContentType>
<mcd:Description/>
<mcd:Filename>Company2_TO_Company4_3.xml</mcd:Filename>
<mcd:Body bodyEncoding=""><![CDATA[<?xml version="1.0"?>
<BizTalk xmlns="urn:schemas-biztalk-org:BizTalk/biztalk-0.81.xml">
<Route>
<To locationID="Company2" locationType="DUNS" process="DocGen" route="" handle="00"/>
<From locationID="Company4" locationType="DUNS" process="DocGen" route="" handle="00"/>
</Route>
<Body>
<FILLER>
<ID>0</ID>
<Title>Reilly's Luck</Title>
<Quantity>1</Quantity>
<UnitPrice>$5.00</UnitPrice>
<Title>Rapid Development</Title>
<Quantity>1</Quantity>
<UnitPrice>$20.00</UnitPrice>
</FILLER>
</Body>
</BizTalk>
]]></mcd:Body>
</mcd:MessageContentInfo>
</mcd:ManifestInfo>
</mcd:MessageControlDocument>
|
|
|
