Open Geospatial Consortium
Date: 2012-01-09
Reference number of this OGC® project document: 06-141r6
http://www.opengis.net/doc/oseo
Version: 1.0
® Category: OpenGIS Implementation Standard
Editors: Daniele Marchionni, Stefania Pappagallo
Ordering Services Framework for Earth Observation Products Interface Standard
Copyright notice Copyright © 2012 Open Geospatial Consortium To obtain additional rights of use, visit http://www.opengeospatial.org/legal/.
Warning This document is an OGC Member approved international standard. This document is available on a royalty free, non-discriminatory basis. Recipients of this document are invited to submit, with their comments, notification of any relevant patent rights of which they are aware and to provide supporting documentation.
® Document type: OpenGIS Standard
Document subtype: Interface Standard Document stage: Approved Document language: English
Ordering Services for Earth Observation Products Interface Standard OGC 06-141r6
License Agreement Permission is hereby granted by the Open Geospatial Consortium, Inc. ("Licensor"), free of charge and subject to the terms set forth below, to any person obtaining a copy of this Intellectual Property and any associated documentation, to deal in the Intellectual Property without restriction (except as set forth below), including without limitation the rights to implement, use, copy, modify, merge, publish, distribute, and/or sublicense copies of the Intellectual Property, and to permit persons to whom the Intellectual Property is furnished to do so, provided that all copyright notices on the intellectual property are retained intact and that each person to whom the Intellectual Property is furnished agrees to the terms of this Agreement. If you modify the Intellectual Property, all copies of the modified Intellectual Property must include, in addition to the above copyright notice, a notice that the Intellectual Property includes modifications that have not been approved or adopted by LICENSOR. THIS LICENSE IS A COPYRIGHT LICENSE ONLY, AND DOES NOT CONVEY ANY RIGHTS UNDER ANY PATENTS THAT MAY BE IN FORCE ANYWHERE IN THE WORLD. THE INTELLECTUAL PROPERTY IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE DO NOT WARRANT THAT THE FUNCTIONS CONTAINED IN THE INTELLECTUAL PROPERTY WILL MEET YOUR REQUIREMENTS OR THAT THE OPERATION OF THE INTELLECTUAL PROPERTY WILL BE UNINTERRUPTED OR ERROR FREE. ANY USE OF THE INTELLECTUAL PROPERTY SHALL BE MADE ENTIRELY AT THE USER’S OWN RISK. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR ANY CONTRIBUTOR OF INTELLECTUAL PROPERTY RIGHTS TO THE INTELLECTUAL PROPERTY BE LIABLE FOR ANY CLAIM, OR ANY DIRECT, SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM ANY ALLEGED INFRINGEMENT OR ANY LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR UNDER ANY OTHER LEGAL THEORY, ARISING OUT OF OR IN CONNECTION WITH THE IMPLEMENTATION, USE, COMMERCIALIZATION OR PERFORMANCE OF THIS INTELLECTUAL PROPERTY. This license is effective until terminated. You may terminate it at any time by destroying the Intellectual Property together with all copies in any form. The license will also terminate if you fail to comply with any term or condition of this Agreement. Except as provided in the following sentence, no such termination of this license shall require the termination of any third party end-user sublicense to the Intellectual Property which is in force as of the date of notice of such termination. In addition, should the Intellectual Property, or the operation of the Intellectual Property, infringe, or in LICENSOR’s sole opinion be likely to infringe, any patent, copyright, trademark or other right of a third party, you agree that LICENSOR, in its sole discretion, may terminate this license without any compensation or liability to you, your licensees or any other party. You agree upon termination of any kind to destroy or cause to be destroyed the Intellectual Property together with all copies in any form, whether held by you or by any third party. Except as contained in this notice, the name of LICENSOR or of any other holder of a copyright in all or part of the Intellectual Property shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Intellectual Property without prior written authorization of LICENSOR or such copyright holder. LICENSOR is and shall at all times be the sole entity that may authorize you or any third party to use certification marks, trademarks or other special designations to indicate compliance with any LICENSOR standards or specifications. This Agreement is governed by the laws of the Commonwealth of Massachusetts. The application to this Agreement of the United Nations Convention on Contracts for the International Sale of Goods is hereby expressly excluded. In the event any provision of this Agreement shall be deemed unenforceable, void or invalid, such provision shall be modified so as to make it valid and enforceable, and as so modified the entire Agreement shall remain in full force and effect. No decision, action or inaction by LICENSOR shall be construed to be a waiver of any rights or remedies available to it. None of the Intellectual Property or underlying information or technology may be downloaded or otherwise exported or reexported in violation of U.S. export laws and regulations. In addition, you are responsible for complying with any local laws in your jurisdiction which may impact your right to import, export or use the Intellectual Property, and you represent that you have complied with any regulations or registration procedures required by applicable law to make this license enforceable.
2 Copyright © 2012 Open Geospatial Consortium
Ordering Services for Earth Observation Products Interface Standard OGC 06-141r6
Contents
1 SCOPE ...... 1 2 COMPLIANCE ...... 1 3 NORMATIVE REFERENCES ...... 3 3.1 OTHER REFERENCES ...... 4 4 TERMS AND DEFINITIONS ...... 5 5 CONVENTIONS ...... 9 5.1 ABBREVIATED TERMS ...... 9 5.2 UML NOTATION ...... 9 5.2.1 Introduction ...... 9 5.2.2 UML Class Diagrams ...... 10 5.2.3 UML Sequence Diagrams ...... 12 5.3 XML NOTATION ...... 13 5.4 USED PARTS OF OTHER DOCUMENTS ...... 14 5.5 PLATFORM-NEUTRAL AND PLATFORM-SPECIFIC STANDARDS ...... 14 5.6 DATA DICTIONARY TABLES ...... 15 6 ORDERING SERVICE FOR EARTH OBSERVATION PRODUCTS (OSEO) OVERVIEW ...... 16 6.1 ESSENTIAL USE-CASES ...... 17 6.1.1 Ordering from catalogue of EO Products ...... 17 6.1.2 Order of Future Products derived from tasking requests ...... 19 6.1.3 Subscribe to EO Products ...... 20 7 SHARED ASPECTS ...... 22 7.1 INTRODUCTION ...... 22 7.2 INFORMATION MODELS ...... 22 7.3 INFORMATION MODEL FOR EO PRODUCT ORDERING ...... 22 7.3.1 XML schema approach ...... 22 7.3.2 Order Options ...... 23 7.3.3 ParameterDescriptorType ...... 29 7.3.4 Pre-defined list of ordering options ...... 31 7.3.5 SceneSelectionDescriptorType ...... 47 7.3.6 Pre-defined list of Scene Selection Options ...... 48 7.3.7 Order Specification ...... 65 7.3.8 Order Item ...... 72 7.3.9 ParameterData ...... 77 7.3.10 Order Quotation ...... 79 7.3.11 Order Item Identifier ...... 84 7.3.12 Order Monitoring Specification ...... 87 7.3.13 Order Item Monitoring Specification ...... 91 7.3.14 Extensibility Model ...... 94 7.4 OPERATION ENCODING ...... 94 7.4.1 Examples Operation encoding ...... 94 7.4.2 List of Operations ...... 97 7.4.3 Asynchronous requests and replies ...... 98 7.4.4 statusNotification element ...... 100 7.4.5 User Identity Information ...... 101 7.5 PUBLISH AND SUBSCRIBE - USAGE OF WS-NOTIFICATION ...... 101 7.5.1 Topics and Events ...... 103
i Copyright © 2012 Open Geospatial Consortium
Ordering Services for Earth Observation Products Interface Standard OGC 06-141r6
7.5.2 Topic Namespace ...... 103 8 GETCAPABILITIES OPERATION ...... 106 8.1 INTRODUCTION ...... 106 8.2 REQUIREMENTS ...... 106 8.3 GETCAPABILITIES OPERATION REQUEST ...... 108 8.3.1 GetCapabilities request parameters ...... 109 8.3.2 GetCapabilities request XML encoding ...... 110 8.3.3 GetCapabilities request example ...... 111 8.4 GETCAPABILITIES OPERATION RESPONSE ...... 112 8.4.1 OperationsMetadata section standard contents ...... 113 8.4.2 Notifications section contents ...... 114 8.4.3 Contents section contents ...... 115 8.4.4 GetCapabilities response XML encoding ...... 122 8.4.5 GetCapabilities response example ...... 123 8.4.6 Exceptions ...... 126 9 GETOPTIONS OPERATION ...... 127 9.1 INTRODUCTION ...... 127 9.2 REQUIREMENTS ...... 128 9.3 GETOPTIONS OPERATION REQUEST ...... 130 9.3.1 GetOptions request parameters ...... 130 9.3.2 GetOptions request XML encoding ...... 131 9.3.3 GetOptions request example ...... 132 9.4 GETOPTIONS OPERATION RESPONSE ...... 132 9.4.1 GetOptions response parameters ...... 133 9.4.2 GetOptions response XML encoding ...... 134 9.4.3 GetOptions response example ...... 135 9.4.4 Exceptions ...... 139 10 GETQUOTATION OPERATION ...... 141 10.1 INTRODUCTION ...... 141 10.2 REQUIREMENTS ...... 142 10.3 GETQUOTATION OPERATION REQUEST ...... 144 10.3.1 GetQuotation request parameters ...... 145 10.3.2 GetQuotation request XML encoding ...... 145 10.3.3 GetQuotation request example ...... 146 10.4 GETQUOTATION OPERATION RESPONSE ...... 147 10.4.1 GetQuotation operation response parameters ...... 148 10.4.2 GetQuotation response XML encoding...... 149 10.4.3 GetQuotation response example...... 150 10.4.4 Exceptions ...... 150 11 GETQUOTATIONRESPONSE OPERATION ...... 152 11.1 INTRODUCTION ...... 152 11.2 REQUIREMENTS ...... 152 11.3 GETQUOTATIONRESPONSE OPERATION REQUEST ...... 152 11.3.1 GetQuotationResponse request parameters ...... 153 11.3.2 GetQuotationResponse request XML encoding ...... 154 11.3.3 GetQuotationResponse request XML example ...... 155 11.4 GETQUOTATIONRESPONSE OPERATION RESPONSE ...... 156 11.4.1 GetQuotationResponse response parameters ...... 156 11.4.2 GetQuotationResponse response XML encoding ...... 156 11.4.3 GetQuotationResponse response example...... 156 11.4.4 Exceptions...... 156 ii Copyright © 2012 Open Geospatial Consortium
Ordering Services for Earth Observation Products Interface Standard OGC 06-141r6
12 SUBMIT OPERATION ...... 158 12.1 INTRODUCTION ...... 158 12.2 REQUIREMENTS ...... 158 12.3 SUBMIT OPERATION REQUEST ...... 161 12.3.1 Submit request parameters ...... 162 12.3.2 Submit request XML encoding ...... 163 12.3.3 Submit request example ...... 164 12.4 SUBMIT OPERATION RESPONSE ...... 165 12.4.1 Submit operation parameters ...... 166 12.4.2 Submit response XML encoding ...... 166 12.4.3 Submit response XML example ...... 167 12.4.4 Exceptions...... 167 13 SUBMITRESPONSE OPERATION ...... 169 13.1 INTRODUCTION ...... 169 13.2 REQUIREMENTS ...... 169 13.3 SUBMITRESPONSE OPERATION REQUEST ...... 169 13.3.1 SubmitResponse request parameters ...... 170 13.3.2 SubmitResponse request XML encoding ...... 171 13.3.3 SubmitResponse request example...... 172 13.4 SUBMITRESPONSE OPERATION RESPONSE ...... 173 13.4.1 SubmitResponse response parameters ...... 173 13.4.2 SubmitResponse response XML encoding ...... 174 13.4.3 SubmitResponse response example ...... 174 13.4.4 Exceptions ...... 174 14 GETSTATUS OPERATION ...... 176 14.1 INTRODUCTION ...... 176 14.2 REQUIREMENTS ...... 176 14.3 GETSTATUS OPERATION REQUEST ...... 179 14.3.1 GetStatus request parameters ...... 180 14.3.2 GetStatus request XML encoding ...... 181 14.3.3 GetStatus request example ...... 182 14.4 GETSTATUS OPERATION RESPONSE ...... 182 14.4.1 GetStatus response parameters ...... 183 14.4.2 GetStatus response XML encoding ...... 184 14.4.3 GetStatus response example ...... 185 14.4.4 Exceptions ...... 186 15 DESCRIBERESULTACCESS OPERATION ...... 188 15.1 INTRODUCTION ...... 188 15.2 REQUIREMENTS ...... 188 15.3 DESCRIBERESULTACCESS OPERATION REQUEST ...... 190 15.3.1 DescribeResultAccess request parameters ...... 190 15.3.2 DescribeResultAccess request XML encoding ...... 191 15.3.3 DescribeResultAccess request example ...... 191 15.4 DESCRIBERESULTACCESS OPERATION RESPONSE ...... 192 15.4.1 DescribeResultAccess response parameters ...... 192 15.4.2 DescribeResultAccess response XML encoding ...... 194 15.4.3 DescribeResultAccess response example ...... 195 15.4.4 Exceptions ...... 195 16 CANCEL OPERATION ...... 197 16.1 INTRODUCTION ...... 197 iii Copyright © 2012 Open Geospatial Consortium
Ordering Services for Earth Observation Products Interface Standard OGC 06-141r6
16.2 REQUIREMENTS ...... 197 16.3 CANCEL OPERATION REQUEST ...... 199 16.3.1 Cancel request parameters ...... 199 16.3.2 Cancel request XML encoding ...... 199 16.3.3 Cancel request example ...... 200 16.4 CANCEL OPERATION RESPONSE ...... 200 16.4.1 Cancel response parameters ...... 200 16.4.2 Cancel response XML encoding ...... 201 16.4.3 Cancel response example ...... 201 16.4.4 Exceptions ...... 202 17 CANCELRESPONSE OPERATION ...... 203 17.1 INTRODUCTION ...... 203 17.2 REQUIREMENTS ...... 203 17.3 CANCELRESPONSE OPERATION REQUEST ...... 203 17.3.1 CancelResponse request parameters ...... 204 17.3.2 CancelResponse request XML encoding ...... 205 17.3.3 CancelResponse request example ...... 206 17.4 CANCELRESPONSE OPERATION RESPONSE ...... 207 17.4.1 CancelResponse response parameters ...... 207 17.4.2 CancelResponse response XML encoding ...... 208 17.4.3 CancelResponse response example ...... 208 17.4.4 Exceptions ...... 208
iv Copyright © 2012 Open Geospatial Consortium
Ordering Services for Earth Observation Products Interface Standard OGC 06-141r6
Figures Figure 2-1: OSEO Requirement Classes...... 2 Figure 5-1 - UML Class Diagram notations...... 12 Figure 5-2 - UML Sequence Diagrams Notations...... 13 Figure 5-3 – XML Diagrams Notations...... 14 Figure 6-1 - Sequence of steps generally performed for ordering products from EO Catalogue...... 18 Figure 6-2 - Sequence of steps generally performed for subscribing to EO products...... 20 Figure 7-1 - CommonOrderOptionsType diagram...... 24 Figure 7-2 - ParameterDescriptorType diagram...... 29 Figure 7-3 – swe:AbstractDataComponentDataType diagram...... 30 Figure 7-4 - SceneSelectionDescriptorType diagram...... 47 Figure 7-5 - CommonOrderSpecification diagram...... 65 Figure 7-6 - OrderSpecification diagram...... 67 Figure 7-7 - DeliveryInformationType diagram...... 68 Figure 7-8 - OnlineAddressType diagram...... 69 Figure 7-9 - DeliveryAddressType diagram...... 70 Figure 7-10 - DeliveryOptionsType diagram...... 71 Figure 7-11 - CommonOrderItemType diagram...... 73 Figure 7-12 - ParameterData element diagram...... 77 Figure 7-13 - OrderQuotation diagram...... 80 Figure 7-14 - CommonOrderMonitorSpecification diagram...... 88 Figure 7-15 - CommonOrderStatusItemType diagram...... 91 Figure 7-16 - Asynchronous requests scenario...... 99 Figure 7-17 - Sequence diagram for Publish/Subscribe functionality ...... 102 Figure 7-18 - Sequence diagram for Publish/Subscribe functionality (with Broker) ...... 103 Figure 8-1 - GetCapabilities request diagram...... 109 Figure 8-2 - Capabilities diagram...... 112 Figure 8-3 - OrderingServiceContentsType diagram...... 116 Figure 8-4 - CollectionCapability complex type diagram...... 121 Figure 9-1 - GetOptions element diagram...... 130 Figure 9-2 - GetOptionsResponse diagram ...... 133 Figure 10-1 - GetQuotation diagram...... 144 Figure 10-2 - GetQuotationAck element diagram...... 148 Figure 11-1 - GetQuotationResponse diagram...... 153 Figure 11-2 - GetQuotationResponseAck diagram ...... 156 Figure 12-1 - Submit diagram...... 162 Figure 12-2 - SubmitAck diagram ...... 165 Figure 13-1 - SubmitResponse diagram...... 170 v Copyright © 2012 Open Geospatial Consortium
Ordering Services for Earth Observation Products Interface Standard OGC 06-141r6
Figure 13-2 - SubmitResponseAck diagram...... 173 Figure 14-1 - GetStatus diagram...... 180 Figure 14-2 - GetStatusResponse element diagram...... 183 Figure 15-1 - DescribeResultAccess diagram...... 190 Figure 15-2 - DescribeResultAccessResponse diagram...... 192 Figure 16-1 - Cancel diagram...... 199 Figure 16-2 - CancelAck diagram...... 200 Figure 17-1 - CancelResponse diagram...... 204 Figure 17-2 - CancelResponseAck diagram...... 207 Figure 17-3 - Package Dependency of OSEO Specification...... 210
vi Copyright © 2012 Open Geospatial Consortium
Ordering Services for Earth Observation Products Interface Standard OGC 06-141r6
Tables Table 2-1: Requirements Classes vs. Standardization Targets...... 3 Table 5-1 - Contents of data dictionary tables ...... 15 Table 7-1 - CommonOrderOptionsType description...... 26 Table 7-2: ProtocolType definition...... 27 Table 7-3: Package Medium definition...... 28 Table 7-4 - ParameterDescriptorType description...... 29 Table 7-5 – swe:AbstractDataComponentDescriptorType description...... 31 Table 7-6 – Pre-defined list of Order Options...... 44 Table 7-7 – Pre-defined list of options for Subscription orders...... 46 Table 7-8 - SceneSelectionDescriptorType description...... 48 Table 7-9 - Scene Selection Parameter Definition...... 59 Table 7-10 - Scene Selection Restriction Definition...... 64 Table 7-11 - CommonOrderSpecification description...... 66 Table 7-12 - OrderSpecification description...... 68 Table 7-13 - DeliveryInformationType description...... 68 Table 7-14 - FTPAddressType description...... 69 Table 7-15 - DeliveryAddressType description...... 71 Table 7-16 - DeliveryOptionsType description...... 72 Table 7-17 - CommonOrderItemType description...... 76 Table 7-18 -ParameterData element description...... 77 Table 7-19 - OrderQuotation description...... 81 Table 7-20 - OrderItemGroupPrice description...... 82 Table 7-21 - OrderItemPrice description...... 84 Table 7-22 - CurrencyType description...... 84 Table 7-23 - ProductType description...... 85 Table 7-24 - TaskingRequestIdType description ...... 85 Table 7-25 - SubscriptionIdType description ...... 86 Table 7-26 - CommonOrderMonitorSpecification description...... 90 Table 7-27 - CommonOrderStatusItemType description...... 93 Table 7-28 - Operation request encoding ...... 98 Table 7-29 - statusNotification description...... 100 Table 7-30 – Events and Topics association ...... 105 Table 8-1: GetCapabilities requirements...... 108 Table 8-2 - Parameters in GetCapabilities operation request ...... 110 Table 8-3 - Section name values and contents...... 113 Table 8-4 - Required values of OperationsMetadata section attributes ...... 113 Table 8-5 - Optional values of OperationsMetadata section...... 113 vii Copyright © 2012 Open Geospatial Consortium
Ordering Services for Earth Observation Products Interface Standard OGC 06-141r6
Table 8-6 - Notifications section...... 114 Table 8-7 - NotificationProducerMetadata section...... 114 Table 8-8 – NotificationBrokerMetadata section...... 115 Table 8-9 - Description of Contents section of Capabilities document ...... 120 Table 8-10 - CollectionCapability complex type description...... 122 Table 8-11 – Exception codes for GetCapabilities operation...... 126 Table 9-1: GetOptions requirements...... 129 Table 9-2 - GetOptions element description...... 131 Table 9-3 – GetOptionsResponse description...... 134 Table 9-4 – Exception Codes for GetOptions operation...... 140 Table 10-1: GetQuotation requirements...... 144 Table 10-2 - GetQuotation description ...... 145 Table 10-3 - GetQuotationAck description ...... 149 Table 10-4 – Exception Codes for GetQuotation operation...... 152 Table 11-1 - GetQuotationResponse description ...... 154 Table 11-2 - GetQuotationResponseAck description ...... 156 Table 11-3 – Exception codes for GetQuotationResponse operation...... 157 Table 12-1: Submit requirements...... 161 Table 12-2 - Submit description ...... 163 Table 12-3 - SubmitAck description ...... 166 Table 12-4 – Exception info for Submit operation...... 168 Table 13-1 - SubmitResponse description...... 171 Table 13-2 - SubmitResponseAck description...... 174 Table 13-3 – Exception codes for SubmitResponse operation...... 175 Table 14-1 - GetStatus requirements...... 179 Table 14-2 - GetStatus description ...... 181 Table 14-3 - GetStatusResponse description ...... 184 Table 14-4 – Exception codes for GetStatus operation...... 187 Table 15-1: DescribeResultAccess requirements...... 189 Table 15-2 - DescribeResultAccess description...... 190 Table 15-3 - DescribeResultAccessResponse description...... 192 Table 15-4 - ItemURLType description...... 193 Table 15-5 - OnLineAccessAddressType description...... 194 Table 15-6 – Exception codes for DescribeResultAcces operation...... 196 Table 16-1: Cancel requirements...... 198 Table 16-2 - Cancel description...... 199 Table 16-3 - CancelAck description...... 201 Table 16-4 – Exception codes for Cancel operation...... 202 viii Copyright © 2012 Open Geospatial Consortium
Ordering Services for Earth Observation Products Interface Standard OGC 06-141r6
Table 17-1 - CancelResponse description...... 205 Table 17-2 - CancelResponseAck description...... 208 Table 17-3 – Exception codes for CancelResponse operation...... 209 Table 17-4: Requirements Classes...... 211 Table 17-5: Requirements vs. Conformance Classes...... 213 Table 17-6: Requirements vs. Conformance Tests Traceability Matrix...... 263 Table 17-7: Conformance Tests vs. Requirements Traceability Matrix...... 268
ix Copyright © 2012 Open Geospatial Consortium
Ordering Services for Earth Observation Products Interface Standard OGC 06-141r6
i. Preface This OGC® standard specifies the interfaces, bindings, requirements, conformance classes, and a framework for implementing extensions that enable complete workflows for ordering of Earth Observation (EO) data products. This standard provides the interfaces for supporting the following EO Product ordering scenarios: Ordering products from EO Catalogues