csw best practices - nasacsw best practices esip summer meeting 2016 july 19-22 2016 doug newman...
TRANSCRIPT
![Page 1: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/1.jpg)
SESIP-0716-DN1
CSW Best Practices
ESIP Summer Meeting 2016
July 19-22 2016
Doug Newman (NASA Earthdata – Raytheon)
Andrew Mitchell (NASA Earthdata)
The material is based upon work supported by the National Aeronautics and
Space Administration under Contract Number NNG15HZ39C
https://ntrs.nasa.gov/search.jsp?R=20160009282 2020-05-27T07:40:51+00:00Z
![Page 2: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/2.jpg)
SESIP-0716-DN1
2
Agenda
• What is CSW?
• Why CSW and Best Practices?
• GetCapabilities
• GetRecords
• GetRecordById
• DescribeRecord
• GetDomain
![Page 3: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/3.jpg)
SESIP-0716-DN1
WHAT IS CSW?
![Page 4: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/4.jpg)
SESIP-0716-DN1
4
Catalog Service for the Web
From OGC website:
‘Catalog services support the ability … search collections of descriptive information (metadata) for data, services, and related information objects. ... Catalogue services are required to support the discovery and binding to registered information resources within an information community.
OGC Catalog interface standards specify the interfaces, bindings, and a framework for defining application profiles required to publish and access digital catalogs of metadata for geospatial data, services, and related resource information...’
![Page 5: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/5.jpg)
SESIP-0716-DN1
WHY CSW & BEST
PRACTICES?
![Page 6: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/6.jpg)
SESIP-0716-DN1
6
Why?
• It is a widely-used earth data discovery
standard
• CWIC maintains a CSW framework for
interoperability
• OGC specs are verbose and, in our
opinion, difficult to interpret. Best practices
may help
![Page 7: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/7.jpg)
SESIP-0716-DN1
GETCAPABILITIES
![Page 8: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/8.jpg)
SESIP-0716-DN1
8
Take this seriously
• Many implementations do a poor job at
describing their service properly
• This method is key to getting clients to use
your API
• This is the gateway to your API. If you do
this poorly then confidence will be low with
respect to the rest of your API
![Page 9: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/9.jpg)
SESIP-0716-DN1
GETRECORDS
![Page 10: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/10.jpg)
SESIP-0716-DN1
10
Support GET
• GET is more user-friendly
• But complex queries are difficult with GET
so…
• Support a subset of your queries with GET
– Free text
– Bounding box
– Temporal range
![Page 11: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/11.jpg)
SESIP-0716-DN1
11
Is summary necessary?
• Getting a list of ids seems useful
• Getting some intermediary representation
of the metadata seems a throw back to the
days when ‘bandwidth was tight’
![Page 12: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/12.jpg)
SESIP-0716-DN1
GETRECORDBYID
![Page 13: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/13.jpg)
SESIP-0716-DN1
13
Is this necessary?
• It is mandatory but…
• GetRecords allows you to get the full
metadata associated with a result set.
• Might be useful from a ‘canonical
metadata reference’ context but that
should really be the domain of other APIs
or landing pages
![Page 14: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/14.jpg)
SESIP-0716-DN1
DESCRIBEDRECORD
![Page 15: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/15.jpg)
SESIP-0716-DN1
15
Of little use
• The ability to return schemas that are
publicly available and defined in the
GetCapabilties response seems
unnecessary
• Being able to subset that schema seems a
throw back to times when bandwidth was
tight.
![Page 16: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/16.jpg)
SESIP-0716-DN1
GETDOMAIN
![Page 17: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/17.jpg)
SESIP-0716-DN1
17
Of some use
• For controlled vocabularies this is useful
functionality.
• Elsewhere, not so much
![Page 18: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/18.jpg)
SESIP-0716-DN1
IN GENERAL
![Page 19: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/19.jpg)
SESIP-0716-DN1
19
Support GET wherever you can
• GET is much more user-friendly than
POST.
• Reserve POST support for complex
queries like GetRecords
![Page 20: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/20.jpg)
SESIP-0716-DN1
20
Support formats beyond minimum
• OGC mandates the GMD ISO profile. This
is somewhat out of date
![Page 21: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/21.jpg)
SESIP-0716-DN1
21
Showing it’s age
• A lot of the architectural considerations of
CSW have made based on the way the
world was some years ago.
• Verbose metadata results are no longer a
problem
• One would hope 3.0 improves this but…
![Page 22: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/22.jpg)
SESIP-0716-DN1
22
Comparison with OpenSearch
• It’s not nearly as much fun
• It’s not RESTful – no hypermedia
• The connection between collection and
granules is not tightly coupled
• Specification of API is not as compact
(GetCapabilies + GetDomain ~= OSDD)
![Page 23: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/23.jpg)
SESIP-0716-DN1
QUESTIONS?
![Page 24: CSW Best Practices - NASACSW Best Practices ESIP Summer Meeting 2016 July 19-22 2016 Doug Newman (NASA Earthdata –Raytheon) ... Catalogue services are required to support the discovery](https://reader034.vdocument.in/reader034/viewer/2022042303/5ece19c762d3a4337170b17f/html5/thumbnails/24.jpg)
SESIP-0716-DN1
24
This material is based upon work
supported by the National
Aeronautics and Space
Administration under Contract
Number NNG15HZ39C.