ebXML Message Service Specification

1 Copyright (C) The Organization for the Advancement of Structured Information Standards [OASIS] April 2002. All Rights Reserved. Message Service Specification 1 Version 2 OASIS ebXML Messaging services Technical Committee 3 1 April 2002 4 OASIS ebXML Messaging services April 2002 Message Service Specification Page 2 of 70 Copyright (C) The Organization for the Advancement of Structured Information Standards [OASIS], 2002. All Rights Reserved. Status of this Document 5 This document specifies an ebXML Message Specification for the eBusiness community. Distribution of 6 this document is unlimited. 7 The document formatting is based on the Internet Society s Standard RFC format converted to Microsoft 8 Word 2000 format. 9 Note: Implementers of this Specification should consult the OASIS ebXML Messaging services Technical 10 Committee web site for current status and revisions to the Specification 11 ( ).

2 12 Specification 13 Version of this Technical Specification document was approved by the ebXML Plenary in May 2001. 14 Version of this Technical Specification document was approved by the OASIS Messaging Team, as a 15 Technical Committee(TC) Specification , March 1, 2002. 16 Version of this Technical Specification document is presented to the OASIS membership for 17 consideration as an OASIS Technical Specification , April 2002. 18 This version 19 20 Errata to this version 21 22 Previous version 23 24 ebXML Participants 25 The authors wish to acknowledge the support of the members of the Messaging services Team who 26 contributed ideas, comments and text to this Specification by the group s discussion eMail list, on 27 conference calls and during face-to-face Ralph Berwanger Individual Member Dick Brooks Individual Member Doug Bunting Sun Microsystems, Inc David Burdett Commerce One Arvola Chan TIBCO Sanjay Cherian Sterling Commerce Cliff Collins Sybase Philippe DeSmedt Individual Member Colleen Evans Sonic Software Chris Ferris Sun Microsystems.

3 Inc David Fischer Drummond Group Jim Galvin Drummond Group Brian Gibb Sterling Commerce Scott Hinkelman IBM Jim Hughes Hewlett Packard Kazunori Iwasa Fujitsu Limited Ian Jones Individual Member Brad Lund Intel Corporation Bob Miller GE Global eXchange Dale Moberg Cyclone Commerce Himagiri Mukkamala Sybase Bruce Pedretti Hewlett-Packard Yukinori Saito Individual Member Martin Sachs IBM Research Jeff Turpin Cyclone Commerce Aynur Unal E2 Open Cedrec Vessell DISA Daniel Weinreb eXcelon Pete Wenzel SeeBeyond Prasad Yendluri WebMethods Sinisa Zimek SAP 29 The UN/CEFACT-OASIS Team see Acknowledgments 29 OASIS ebXML Messaging services April 2002 Message Service Specification Page 3 of 70 Copyright (C) The Organization for the Advancement of Structured Information Standards [OASIS], 2002. All Rights Reserved.

4 Table of Contents 30 Status of this Document .. 2 31 ebXML Participants .. 2 32 Introduction .. 6 33 1 Summary of Contents of this Document .. 6 34 Document Conventions .. 7 35 7 36 Caveats and 7 37 Related 7 38 Concept of Operation .. 8 39 Scope .. 8 40 Background and Objectives .. 8 41 Operational Policies and 9 42 Modes of 10 43 Minimal Requirements for Conformance .. 11 44 Part I. Core 12 45 2 ebXML with SOAP .. 12 46 Packaging Specification ..12 47 SOAP Structural 13 48 Message Package .. 13 49 Header 13 50 Payload Container .. 14 51 Additional MIME 14 52 Reporting MIME Errors .. 15 53 XML Prolog .. 15 54 XML Declaration .. 15 55 Encoding Declaration .. 15 56 ebXML SOAP Envelope extensions .. 15 57 Namespace pseudo 15 58 xsi:schemaLocation 15 59 SOAP Header Element.

5 16 60 SOAP Body 16 61 ebXML SOAP Extensions .. 16 62 #wildcard Element Content .. 17 63 id attribute .. 17 64 version attribute .. 17 65 SOAP mustUnderstand attribute .. 18 66 ebXML "Next MSH" actor URI .. 18 67 ebXML "To Party MSH" actor URI .. 18 68 3 Core Extension 18 69 MessageHeader 18 70 From and To 19 71 CPAId Element .. 19 72 ConversationId Element .. 20 73 Service 20 74 Action 21 75 MessageData Element .. 21 76 DuplicateElimination 22 77 Description Element .. 22 78 MessageHeader 22 79 Manifest 22 80 Reference Element .. 23 81 Manifest 23 82 Manifest Sample .. 24 83 4 Core Modules ..24 84 Security 24 85 Signature Element .. 24 86 Security and Management .. 25 87 Signature Generation .. 25 88 Countermeasure Technologies.

6 27 89 OASIS ebXML Messaging services April 2002 Message Service Specification Page 4 of 70 Copyright (C) The Organization for the Advancement of Structured Information Standards [OASIS], 2002. All Rights Reserved. Security Considerations .. 28 90 Error Handling Module ..29 91 Types of Errors .. 29 92 ErrorList Element .. 30 93 Implementing Error Reporting and 32 94 SyncReply Module ..33 95 SyncReply 33 96 5 Combining ebXML SOAP Extension Elements .. 33 97 MessageHeader Element Interaction ..33 98 Manifest Element 34 99 Signature Element Interaction .. 34 100 ErrorList Element 34 101 SyncReply Element Interaction .. 34 102 Part II. Additional 35 103 6 Reliable Messaging Module .. 35 104 Persistent Storage and System Failure .. 35 105 Methods of Implementing Reliable Messaging.

7 35 106 Reliable Messaging SOAP Header Extensions .. 36 107 AckRequested 36 108 Acknowledgment 37 109 Reliable Messaging 38 110 38 111 39 112 Retries .. 39 113 RetryInterval .. 39 114 TimeToLive .. 39 115 PersistDuration .. 39 116 syncReplyMode .. 39 117 ebXML Reliable Messaging 40 118 Sending Message Behavior .. 40 119 Receiving Message Behavior .. 40 120 Generating an Acknowledgment Message .. 41 121 Resending Lost Application Messages ..41 122 Resending Acknowledgments .. 42 123 Duplicate Message 43 124 Failed Message Delivery .. 43 125 Reliable Messaging Combinations .. 44 126 7 Message Status Service .. 44 127 Message Status Messages .. 45 128 Message Status Request Message ..45 129 Message Status Response Message .. 45 130 Security Considerations.

8 45 131 StatusRequest 45 132 RefToMessageId 46 133 StatusRequest Sample .. 46 134 StatusRequest Element Interaction .. 46 135 StatusResponse 46 136 RefToMessageId 46 137 Timestamp Element .. 46 138 messageStatus 46 139 StatusResponse 47 140 StatusResponse Element Interaction .. 47 141 8 Message Service Handler Ping 47 142 Message Service Handler Ping 47 143 Message Service Handler Pong Message .. 48 144 Security Considerations ..49 145 9 MessageOrder 49 146 MessageOrder Element .. 49 147 SequenceNumber Element .. 49 148 MessageOrder Sample .. 50 149 MessageOrder Element 50 150 10 Multi-Hop Module .. 50 151 Multi-hop Reliable Messaging .. 51 152 AckRequested 51 153 OASIS ebXML Messaging services April 2002 Message Service Specification Page 5 of 70 Copyright (C) The Organization for the Advancement of Structured Information Standards [OASIS], 2002.

9 All Rights Reserved. Acknowledgment 51 154 Multi-Hop Acknowledgments .. 51 155 Signing Multi-Hop Acknowledgments ..52 156 Multi-Hop Security Considerations .. 52 157 Message Ordering and 52 158 Part III. Normative 53 159 Appendix A The ebXML SOAP Extension Elements Schema .. 53 160 Appendix B Communications Protocol Bindings .. 58 161 Introduction .. 58 162 HTTP .. 58 163 Minimum level of HTTP protocol .. 58 164 Sending ebXML Service messages over 58 165 HTTP Response Codes .. 59 166 SOAP Error conditions and Synchronous Exchanges .. 60 167 Synchronous vs. Asynchronous .. 60 168 Access 60 169 Confidentiality and Transport Protocol Level 60 170 SMTP .. 61 171 Minimum Level of Supported Protocols ..61 172 Sending ebXML Messages over SMTP .. 61 173 Response 63 174 Access 63 175 Confidentiality and Transport Protocol Level 63 176 SMTP Model.

10 63 177 Communication Errors during Reliable 64 178 Appendix C Supported Security services .. 65 179 References .. 67 180 Normative References .. 67 181 Non-Normative 68 182 Contact Information .. 69 183 69 184 Disclaimer .. 70 185 Copyright Statement .. 70 186 Intellectual Property Rights Statement .. 70 187 188 OASIS ebXML Messaging services April 2002 Message Service Specification Page 6 of 70 Copyright (C) The Organization for the Advancement of Structured Information Standards [OASIS], 2002. All Rights Reserved. Introduction 188 This Specification is one of a series of specifications realizing the vision of creating a single global 189 electronic marketplace where enterprises of any size and in any geographical location can meet and 190 conduct business with each other through the exchange of XML based messages.