Point of contact name (i.e., author name): Ruth Duerr
Determine whether or not my OpenSearch service or casts are compliant with some version of the ESIP discovery protocol.
I, someone whose organization is trying to develop an OpenSearch server or cast generator that wishes to be compliant with some version of the ESIP discovery protocols, use the ESIP testbed to test whether or not my service or cast actually is compliant.
- User - primary actor, someone with a service or cast they wish to verify
- ESIP testbed portal - the version of the Esri Geoportal Server that has been installed on the ESIP testbed and configured to be able to validate an OpenSearch service or cast
- URL - the URL of the OpenSearch service or cast to be validated
The ESIP testbed portal is up and running and has been configured to accept a range of ESIP specifications that it can validate against. There is a publicly accessible URL for the service or cast to be validated.
This use case is triggered when the user decides to activate it by going to the ESIP testbed portal and selecting one of the options for validating OpenSearch servers or cast endpoints.
- User points their browser to the ESIP testbed portal
- User selects one of the validation options. The options available include:
- To validate a cast URL
- To validate an OpenSearch server
- User selects from a list the version of the ESIP specification to validate against (at this point I expect the list will include ESIP 1.0 and 1.1 specs)
- If a cast is being validated
- The user is asked by the portal to enter the URL of the cast
- The user enters the URL of the cast and clicks the Validate button
- The ESIP testbed portal, retrieves the cast at the URL entered and validates it against the selected specification
- The ESIP testbed portal, summarizes the results of the validation, including
- whether the URL passed or failed
- which types of cast entries (collection, service, data granule, and/or events) were detected in the cast
- If the URL passed validation, the user is asked whether they would like the cast to be added to the ESIP testbed portal aggregation of known ESIP-compliant casts
- If the user says yes, then the cast URL is added to the aggregation (note this could either be to update the Esri geoPortal or a copy of the NSIDC aggregator or both - what does ESIP want to do?)
- If an OpenSearch server is being validated
- The user is requested to enter the URL of the OpenSearch Description Document (OSDD)
- The ESIP testbed portal, retrieves and attempts to validate the OSDD
- If validation is successful, the ESIP testbed portal
- formulates a ESIP-compliant query to the service endpoint indicated in the OSDD
- attempts to validate the response to the query submitted
- The ESIP testbed portal summarizes the results of the validation, including
- whether the OSDD was compliant
- whether the query returned properly
- whether the query results were compliant
- If the OpenSearch server passed all tests, the user is asked whether they would like to add the server to the ESIP testbed portal list of known OpenSearch servers
- If the user says yes, then the server is added to the list
- If a cast fails validation, the ESIP testbed portal will also indicate what parts of the specification the cast failed to meet
- If an OSDD fails validation, the ESIP testbed portal will also indicate what parts of the specification the OSDD failed to meet
- If the OpenSearch server failed to return a response to the portal query, the ESIP testbed portal will indicate that fact
- If the response of the OpenSearch server failed validation, the ESIP testbed portal will indicate exactly what parts of the specification the server response failed to meet
After validation, the user will know whether or not their cast or OpenSearch service is ESIP compliant and if not, exactly what the problem is
OK - so no diagram so far. Is one needed for this use case?
Out of the box, the Esri Geoportal Server provides a mechanism for validating XML documents against a requisite XML schema. The Geoportal can also validate against an XSD or Schematron document.
- The development here would be to 1) identify schemas by which the geoportal can validate a cast/OpenSearch document, 2) configure the geoportal to use those schemas, and 3) ensure that casts/documents that don't validate have a helpful error message indicating the issues.
- Resources that are retrievable at a cast/document endpoint can be validated separately (e.g., a cast/document can be compliant even if the resources it advertises are not).
The Esri Geoportal Server has two interfaces for checking validity.
- The first is to validate the document itself - looks like this:
- The second is used to register the endpoint in a federated search list - with some changes could look like this:
Federated search to these endpoints is described more fully in the Query aggregated data and services use case.
Back to Discovery Testbed Work Plan