1 ECHO ECHO 9.0 for Data Partners Rob Baker January 23, 2007

2 ECHO 9.0 for Data Partners Web Services API Ingest and Reconciliation –Get Dataset Information –Partial Metadata Update Orders –Order Fulfillment –Order Options –Order Summary SSL Provider Policies

3 Web Services API

4 ECHO Services are the core services that clients use to communicate with ECHO ECHO 9.0 Web Services retires the ECHO Legacy API Data Partners will need to update code to work with Web Services for ECHO 9.0

5 Ingest and Reconciliation

6 Ingest and Reconciliation Get Dataset Information Inspect Dataset is now known as Get Dataset Information Get Dataset Information is used to get information about one or more datasets –Get Dataset Information operation can only be called by a user who has a provider role and has set their provider context –Get Dataset Information is mostly used by Data Partners for reconciliation –Get Dataset Information can be used to ensure that all the data was ingested correctly Get Dataset Information uses a highly optimized DB query –This allows the data to be found quickly –Data Partners should use this rather than the Catalog Service to query for their holdings

7 Ingest and Reconciliation Get Dataset Information In ECHO 8.0 catalog item ids are returned to the provider –The data is delivered immediately, or asynchronously via or FTP The solution in ECHO 9.0 is to limit the delivery mechanism to FTP Push –ECHO will stream the compressed XML to the FTP server as it is extracted from the database –ECHO will compress the data on the fly using GZip compression to reduce the amount of transmitted data –The connection to the FTP server would remain open while the entire message is written GetDatasetInformation operation –Will require an FTP server address –Will return the name of the file that will be created on the FTP server

8 Ingest and Reconciliation Get Dataset Information Get Dataset Information provides more query parameters and more result metadata than was provided with Inspect Dataset ECHO 9.0 supports the following in a Get Dataset Information query: –Provider insert datetime –Provider acquisition datetime –Provider production datetime –Online Only flag –Last Update date-time ECHO 9.0 supports the following in a Get Dataset Information response: –Provider insert datetime –Provider acquisition datetime –Provider production datetime –Browse URL –Granule URL –Last update date-time

9 Ingest and Reconciliation Get Dataset Information Dataset Information schema defines the format of the dataset information delivered as a result of the GetDatasetInformation operation. This data is normally used by data providers to perform data reconciliation.

10 DatasetInfoSchema The DatasetInfoSchema can be found in its

11 Ingest and Reconciliation Partial Metadata Update Data Partners will be able to update all granule and collection metadata fields individually. All science fields in the data model will be supported. In ECHO 9.0, partial metadata updates are accomplished using the same format and process as current metadata update and with no DTD changes.

12 Orders

13 Orders Order Fulfillment API In 9.0 the order adapters are going to be removed and all data partners will have to meet the Order Fulfillment API SSL connections are only supported with providers implementing the new Order Fulfillment API

14 Orders Order Fulfillment API The Order Fulfillment API is offered to data providers who wish to support ordering. A provider does not have to support all the operations and can configure which operations are supported using the provider policies on the ECHO API. There are three major order operations: –Submit –Cancel –Quote

15 Orders Order Fulfillment API The new API will impact your ordering code differently depending on how you interacted with previous ECHO systems. SOAP Providers (ASF, GES, PO, LAADS, ORNL, SEDAC) –Providers accepting orders via a SOAP call from ECHO will be impacted by the new Order Fulfillment API. Existing SOAP providers must update your order implementation or you will not be able to receive orders when ECHO 9 goes operational in April 2007.

16 Orders Order Fulfillment API ECS Providers (GES, LARC, LPDAAC, NSIDC) –ECHO 9 will support the existing ECHO ODL Order Adapter and will pass ODL order information (including product subsetting and ASTER-On-Demand information) to the V0 Gateway like previous versions of ECHO. –Beginning with ECS v7.2x, the ordering mechanism will migrate to the ECHO Order Fulfillment API but this should be transparent to ECS Providers (other than the requisite ECS update). –For providers wishing to remain with ECS 7.11, ECHO 9 will continue to support the ODL Order Adapter. –Once you are no longer an ECS Provider, you will have to migrate to the order fulfillment API (ASDC, GES).

17 Orders Order Options ECHO 9.0 uses ECHO Forms to define order options. Two levels of order options: –System Level order options shared by providers –Provider Level order options In ECHO 9.0 Data Partners are responsible for setting their own order option.

18 Orders Order Summary Currently ECHO’s order summary only displays OrderId and OrderState. In ECHO 9.0, the following information shall be listed in the Order Summary and can be displayed using PUMP: –Order ID –Order State –Creation Date –Provider Acceptance Date –Last Order Update Date –Order Close Date –Submitting User ID –Billing User Information –Shipping User Information –Contact User Information –Client ID of client that placed the order

19 Secure Socket Layer

20 Secure Socket Layer Providers can now specify a public SSL certificate that ECHO will use to create a secure connection to the provider when interacting with ECHO. The certificate must be approved by ECHO Operations after being set in the provider policies. Clients can now set an optional SSL certificate in the provider policies SSL connections are only supported with providers implementing the new Order Fulfillment API A self-signed SSL certificate must be generated and a secure end point must be created to test SSL ordering The SSL policy is set under Provider Policies in PUMP.

21 Resources The ECHO Web site has the latest information on Get Dataset Information for ECHO ECHO 9.0 Features & ECHO 9.0 API documentation is available online at the ECHO 9.0 Testbed