Difference between revisions of "Documenting Services"
From Earth Science Information Partners (ESIP)
(Created page with "Services provide data in standard responses and formats. ==Crosswalks== <table width="95%" border="1" cellpadding="3" cellspacing="3" style="border-collapse: collapse;"> <tr> ...") |
|||
| Line 8: | Line 8: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td style="word-break:break-all;">[http://www.unidata.ucar.edu/software/netcdf-java/formats/DataDiscoveryAttConvention.html#title_Attribute Title]</td> | + | <td style="word-break:break-all;">[http://www.unidata.ucar.edu/software/netcdf-java/formats/DataDiscoveryAttConvention.html#title_Attribute Resource Title]</td> |
| − | <td style="word-break:break-all;">A short description of the | + | <td style="word-break:break-all;">A short description of the resource. The title should be descriptive enough so that |
| − | <td style="word-break:break-all;"><b>DIF</b> /dif:DIF/dif:Entry_Title<br><b>Dryad</b> dcterms:title<br><b>ECHO</b> /echo:Collection/echo:ShortName>/echo:Collection/echo:LongName<br><b>EML</b> /eml:dataset/eml:title/eml:text<br><b>FGDC</b> /fgdc:metadata/fgdc:idinfo/fgdc:citation/fgdc:citeinfo/fgdc:title<br><b>ISO</b> /*/gmd:identificationInfo/*/gmd:citation/gmd:CI_Citation/gmd:title/gco:CharacterString<br><b>OGC-SOS</b> /sos:Capabilities/ows:ServiceIdentification/ows:Title<br><b>THREDDS</b> /thredds:catalog/thredds:dataset/@name<br><b>netCDF</b> /nc:netcdf/nc:attribute[@name=title]<br></td> | + | when a user is presented with a list of titles the general content of the data set |
| + | can be determined. | ||
| + | </td> | ||
| + | <td style="word-break:break-all;"><b>DIF</b> /dif:DIF/dif:Entry_Title<br><b>Dryad</b> dcterms:title<br><b>ECHO</b> /echo:Collection/echo:ShortName>/echo:Collection/echo:LongName<br><b>EML</b> /eml:dataset/eml:title/eml:text<br><b>FGDC</b> /fgdc:metadata/fgdc:idinfo/fgdc:citation/fgdc:citeinfo/fgdc:title<br><b>ISO</b> /*/gmd:identificationInfo/*/gmd:citation/gmd:CI_Citation/gmd:title/gco:CharacterString<br><b>ISO-1</b> /*/mdb:identificationInfo/*/rmd:citation/cit:CI_Citation/cit:title/gco:CharacterString<br><b>OGC-SOS</b> /sos:Capabilities/ows:ServiceIdentification/ows:Title<br><b>THREDDS</b> /thredds:catalog/thredds:dataset/@thredds:name<br><b>THREDDS</b> /thredds:catalog/thredds:dataset/thredds:metadata/thredds:@dc:title<br><b>netCDF</b> /nc:netcdf/nc:attribute[@name=title]<br></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td style="word-break:break-all;">[http://www.unidata.ucar.edu/software/netcdf-java/formats/DataDiscoveryAttConvention.html#summary_Attribute Abstract]</td> | <td style="word-break:break-all;">[http://www.unidata.ucar.edu/software/netcdf-java/formats/DataDiscoveryAttConvention.html#summary_Attribute Abstract]</td> | ||
<td style="word-break:break-all;">A paragraph describing the resource.</td> | <td style="word-break:break-all;">A paragraph describing the resource.</td> | ||
| − | <td style="word-break:break-all;"><b>DIF</b> /dif:DIF/dif:Summary/dif:Abstract<br><b>Dryad</b> dcterms:description<br><b>ECHO</b> /echo:Collection/Description<br><b>EML</b> /eml:dataset/eml:abstract/eml:descendant<br><b>FGDC</b> /fgdc:metadata/fgdc:idinfo/fgdc:descript/fgdc:abstract<br><b>ISO</b> /*/gmd:identificationInfo/*/gmd:abstract/gco:CharacterString<br><b>OGC-SOS</b> /sos:Capabilities/ows:ServiceIdentification/ows:Abstract<br><b>THREDDS</b> /thredds:metadata/thredds:documentation[@type=summary]<br><b>netCDF</b> /nc:netcdf/nc:attribute[@name=summary]<br></td> | + | <td style="word-break:break-all;"><b>DIF</b> /dif:DIF/dif:Summary/dif:Abstract<br><b>Dryad</b> dcterms:description<br><b>ECHO</b> /echo:Collection/Description<br><b>EML</b> /eml:dataset/eml:abstract/eml:descendant<br><b>FGDC</b> /fgdc:metadata/fgdc:idinfo/fgdc:descript/fgdc:abstract<br><b>ISO</b> /*/gmd:identificationInfo/*/gmd:abstract/gco:CharacterString<br><b>ISO-1</b> /*/mdb:identificationInfo/*/rmd:abstract/gco:CharacterString<br><b>OGC-SOS</b> /sos:Capabilities/ows:ServiceIdentification/ows:Abstract<br><b>THREDDS</b> /thredds:catalog/thredds:metadata/thredds:documentation[@thredds:type=summary]<br><b>netCDF</b> /nc:netcdf/nc:attribute[@name=summary]<br></td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td style="word-break:break-all;">[http://www.unidata.ucar.edu/software/netcdf-java/formats/DataDiscoveryAttConvention.html#keywords_Attribute Keyword]</td> | <td style="word-break:break-all;">[http://www.unidata.ucar.edu/software/netcdf-java/formats/DataDiscoveryAttConvention.html#keywords_Attribute Keyword]</td> | ||
| − | <td style="word-break:break-all;">A comma separated list of key words and phrases.</td> | + | <td style="word-break:break-all;">A comma separated list of key words and phrases. Can be one of several types.</td> |
<td style="word-break:break-all;"><b>DIF</b> /dif:DIF/dif:Parameters/dif:Category > //dif:Parameters/dif:Topic > //dif:Parameters/dif:Term | <td style="word-break:break-all;"><b>DIF</b> /dif:DIF/dif:Parameters/dif:Category > //dif:Parameters/dif:Topic > //dif:Parameters/dif:Term | ||
> //dif:Parameters/dif:Variable_Level_1 > //dif:Parameters/dif:Variable_Level_2 > | > //dif:Parameters/dif:Variable_Level_1 > //dif:Parameters/dif:Variable_Level_2 > | ||
| Line 25: | Line 28: | ||
<br><b>Dryad</b> dcterms:subject<br><b>ECHO</b> / echo:Collection/echo:ScienceKeywords/echo:ScienceKeyword/echo:CategoryKeyword>//echo:TopicKeyword>//echo:TermKeyword>//echo:VariableLevel1Keyword/echo:Value>//echo:VariableLevel2Keyword/echo:Value>//echo:VariableLevel3Keyword>//echo:DetailedVariableKeyword<br><b>ECS</b> METADATA > COLLECTIONMETADATA > DisciplineTopicParameters > DisciplineTopicParametersContainer.ECSDisciplineKeyword | <br><b>Dryad</b> dcterms:subject<br><b>ECHO</b> / echo:Collection/echo:ScienceKeywords/echo:ScienceKeyword/echo:CategoryKeyword>//echo:TopicKeyword>//echo:TermKeyword>//echo:VariableLevel1Keyword/echo:Value>//echo:VariableLevel2Keyword/echo:Value>//echo:VariableLevel3Keyword>//echo:DetailedVariableKeyword<br><b>ECS</b> METADATA > COLLECTIONMETADATA > DisciplineTopicParameters > DisciplineTopicParametersContainer.ECSDisciplineKeyword | ||
> DisciplineTopicParametersContainer.ECSParameterKeyword > DisciplineTopicParametersContainer.ECSTermKeyword | > DisciplineTopicParametersContainer.ECSParameterKeyword > DisciplineTopicParametersContainer.ECSTermKeyword | ||
| − | > DisciplineTopicParametersContainer.ECSTopicKeyword<br><b>EML</b> /eml:dataset/eml:keywordSet/eml:keyword/eml:text<br><b>FGDC</b> /fgdc:metadata/fgdc:idinfo/fgdc:keywords/fgdc:theme/fgdc:themekey |/fgdc:metadata/fgdc:idinfo/fgdc:keywords/fgdc:place/fgdc:placekey<br><b>ISO</b> /*/gmd:identificationInfo/*/gmd:descriptiveKeywords/gmd:MD_Keywords/gmd:keyword/gco:CharacterString<br><b>OGC-SOS</b> /sos:Capabilities/ows:ServiceIdentification/ows:Keywords/ows:Keyword<br><b>netCDF</b> /nc:netcdf/nc:attribute[@name=keywords]<br></td> | + | > DisciplineTopicParametersContainer.ECSTopicKeyword<br><b>EML</b> /eml:dataset/eml:keywordSet/eml:keyword/eml:text<br><b>FGDC</b> /fgdc:metadata/fgdc:idinfo/fgdc:keywords/fgdc:theme/fgdc:themekey |/fgdc:metadata/fgdc:idinfo/fgdc:keywords/fgdc:place/fgdc:placekey<br><b>ISO</b> /*/gmd:identificationInfo/*/gmd:descriptiveKeywords/gmd:MD_Keywords/gmd:keyword/gco:CharacterString<br><b>OGC-SOS</b> /sos:Capabilities/ows:ServiceIdentification/ows:Keywords/ows:Keyword<br><b>THREDDS</b> thredds:catalog/thredds:metadata/thredds:keyword<br><b>THREDDS</b> thredds:catalog/thredds:dataset/thredds:keyword<br><b>netCDF</b> /nc:netcdf/nc:attribute[@name=keywords]<br></td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Line 50: | Line 53: | ||
field. | field. | ||
</td> | </td> | ||
| − | <td style="word-break:break-all;"><b>DIF</b> /dif:DIF/dif:Access_Constraints<br><b>ECHO</b> /echo:Collection/echo:RestrictionFlag<br><b>ECHO</b> /echo:Collection/echo:RestrictionComment<br><b>ISO</b> /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:resourceConstraints/gmd:MD_LegalConstraints/gmd:legalConstraints/gmd:MD_RestrictionCode<br><b>ISO</b> /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:resourceConstraints/gmd:MD_LegalConstraints/gmd:otherConstraints/gco:CharacterString<br><b>ISO</b> /*/gmd:identificationInfo/srv:SV_ServiceIdentification/srv:restrictions/gmd:MD_LegalConstraints/gmd:legalConstraints/gco:CharacterString<br><b>ISO</b> /*/gmd:identificationInfo/srv:SV_ServiceIdentification/srv:restrictions/gmd:MD_LegalConstraints/gmd:otherConstraints/gco:CharacterString<br></td> | + | <td style="word-break:break-all;"><b>DIF</b> /dif:DIF/dif:Access_Constraints<br><b>ECHO</b> /echo:Collection/echo:RestrictionFlag<br><b>ECHO</b> /echo:Collection/echo:RestrictionComment<br><b>ISO</b> /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:resourceConstraints/gmd:MD_LegalConstraints/gmd:legalConstraints/gmd:MD_RestrictionCode<br><b>ISO</b> /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:resourceConstraints/gmd:MD_LegalConstraints/gmd:otherConstraints/gco:CharacterString<br><b>ISO</b> /*/gmd:identificationInfo/srv:SV_ServiceIdentification/srv:restrictions/gmd:MD_LegalConstraints/gmd:legalConstraints/gco:CharacterString<br><b>ISO</b> /*/gmd:identificationInfo/srv:SV_ServiceIdentification/srv:restrictions/gmd:MD_LegalConstraints/gmd:otherConstraints/gco:CharacterString<br><b>THREDDS</b> /thredds:catalog/thredds:dataset/thredds:documentation[@thredds:type="rights"]<br><b>THREDDS</b> /thredds:catalog/thredds:metadata/thredds:documentation[@thredds:type="rights"]<br><b>netCDF</b> /nc:netcdf/nc:variable/nc:attribute[@name=license]/@value<br></td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Revision as of 11:36, January 4, 2013
Services provide data in standard responses and formats.
Crosswalks
| Concept | Description | Paths |
|---|---|---|
| Resource Title | A short description of the resource. The title should be descriptive enough so that
when a user is presented with a list of titles the general content of the data set can be determined. |
DIF /dif:DIF/dif:Entry_Title Dryad dcterms:title ECHO /echo:Collection/echo:ShortName>/echo:Collection/echo:LongName EML /eml:dataset/eml:title/eml:text FGDC /fgdc:metadata/fgdc:idinfo/fgdc:citation/fgdc:citeinfo/fgdc:title ISO /*/gmd:identificationInfo/*/gmd:citation/gmd:CI_Citation/gmd:title/gco:CharacterString ISO-1 /*/mdb:identificationInfo/*/rmd:citation/cit:CI_Citation/cit:title/gco:CharacterString OGC-SOS /sos:Capabilities/ows:ServiceIdentification/ows:Title THREDDS /thredds:catalog/thredds:dataset/@thredds:name THREDDS /thredds:catalog/thredds:dataset/thredds:metadata/thredds:@dc:title netCDF /nc:netcdf/nc:attribute[@name=title] |
| Abstract | A paragraph describing the resource. | DIF /dif:DIF/dif:Summary/dif:Abstract Dryad dcterms:description ECHO /echo:Collection/Description EML /eml:dataset/eml:abstract/eml:descendant FGDC /fgdc:metadata/fgdc:idinfo/fgdc:descript/fgdc:abstract ISO /*/gmd:identificationInfo/*/gmd:abstract/gco:CharacterString ISO-1 /*/mdb:identificationInfo/*/rmd:abstract/gco:CharacterString OGC-SOS /sos:Capabilities/ows:ServiceIdentification/ows:Abstract THREDDS /thredds:catalog/thredds:metadata/thredds:documentation[@thredds:type=summary] netCDF /nc:netcdf/nc:attribute[@name=summary] |
| Keyword | A comma separated list of key words and phrases. Can be one of several types. | DIF /dif:DIF/dif:Parameters/dif:Category > //dif:Parameters/dif:Topic > //dif:Parameters/dif:Term
> //dif:Parameters/dif:Variable_Level_1 > //dif:Parameters/dif:Variable_Level_2 >
//dif:Parameters/dif:Variable_Level_3 > //dif:Parameters/dif: > //dif:Parameters/dif:Variable_Level_3
EML /eml:dataset/eml:keywordSet/eml:keyword/eml:text FGDC /fgdc:metadata/fgdc:idinfo/fgdc:keywords/fgdc:theme/fgdc:themekey |/fgdc:metadata/fgdc:idinfo/fgdc:keywords/fgdc:place/fgdc:placekey ISO /*/gmd:identificationInfo/*/gmd:descriptiveKeywords/gmd:MD_Keywords/gmd:keyword/gco:CharacterString OGC-SOS /sos:Capabilities/ows:ServiceIdentification/ows:Keywords/ows:Keyword THREDDS thredds:catalog/thredds:metadata/thredds:keyword THREDDS thredds:catalog/thredds:dataset/thredds:keyword netCDF /nc:netcdf/nc:attribute[@name=keywords] |
| Service Type | Standard name for a service type. | ISO /*/gmd:identificationInfo/srv:SV_ServiceIdentification/srv:serviceType/gco:LocalName OGC-SOS /sos:Capabilities/ows:ServiceIdentification/ows:ServiceType |
| Service Type Version | Standard name for a version of a service. | ISO /*/gmd:identificationInfo/srv:SV_ServiceIdentification/srv:serviceTypeVersion/gco:CharacterString OGC-SOS /sos:Capabilities/ows:ServiceIdentification/ows:ServiceTypeVersion |
| Fees | Costs associated with obtaining the resource | ISO /*/gmd:distributionInfo/gmd:MD_Distribution/gmd:distributor/gmd:MD_Distributor/gmd:distributionOrderProcess/gmd:MD_StandardOrderProcess/gmd:fees OGC-SOS /sos:Capabilities/ows:ServiceIdentification/ows:Fees |
| Resource Access Constraints | Information about any constraints for accessing the data set. This includes any special
restrictions, legal prerequisites, limitations and/or warnings on obtaining the data set. Some words that may be used in this field include: Public, In-house, Limited, Additional detailed instructions on how to access the data can be entered in this field. |
DIF /dif:DIF/dif:Access_Constraints ECHO /echo:Collection/echo:RestrictionFlag ECHO /echo:Collection/echo:RestrictionComment ISO /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:resourceConstraints/gmd:MD_LegalConstraints/gmd:legalConstraints/gmd:MD_RestrictionCode ISO /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:resourceConstraints/gmd:MD_LegalConstraints/gmd:otherConstraints/gco:CharacterString ISO /*/gmd:identificationInfo/srv:SV_ServiceIdentification/srv:restrictions/gmd:MD_LegalConstraints/gmd:legalConstraints/gco:CharacterString ISO /*/gmd:identificationInfo/srv:SV_ServiceIdentification/srv:restrictions/gmd:MD_LegalConstraints/gmd:otherConstraints/gco:CharacterString THREDDS /thredds:catalog/thredds:dataset/thredds:documentation[@thredds:type="rights"] THREDDS /thredds:catalog/thredds:metadata/thredds:documentation[@thredds:type="rights"] netCDF /nc:netcdf/nc:variable/nc:attribute[@name=license]/@value |
| Service Provider | Organization or person responsible for the service. | ISO /*/gmd:identificationInfo/srv:SV_ServiceIdentification/gmd:pointOfContact OGC-SOS /sos:Capabilities/ows:ServiceProvider |
| Service Operation Name | name of an operation provided by the service. | ISO /gmi:MI_Metadata/gmd:identificationInfo/srv:SV_ServiceIdentification/srv:containsOperations/srv:SV_OperationMetadata/srv:operationName/gco:CharacterString OGC-SOS /sos:Capabilities/ows:OperationsMetadata/ows:Operation/@name |
| Service Location | ISO /gmi:MI_Metadata/gmd:identificationInfo/srv:SV_ServiceIdentification/srv:containsOperations/srv:SV_OperationMetadata/srv:connectPoint/gmd:CI_OnlineResource/gmd:linkage/gmd:URL OGC-SOS /sos:Capabilities/ows:OperationsMetadata/ows:Operation/ows:DCP/ows:HTTP/ows:Get/@xlink:href OGC-SOS /sos:Capabilities/ows:OperationsMetadata/ows:Operation/ows:DCP/ows:HTTP/ows:Post/@xlink:href |
|
| Service Parameters | ISO /gmi:MI_Metadata/gmd:identificationInfo/srv:SV_ServiceIdentification/srv:containsOperations/srv:SV_OperationMetadata/srv:parameters/srv:SV_Parameter/srv:description/gco:CharacterString OGC-SOS /sos:Capabilities/ows:OperationsMetadata/ows:Operation/ows:Parameter/ows:AllowedValues/ows:Value |
xPath Note: The xPaths included in this table use several wildcards. // means any path, so //gmd:CI_ResponsibleParty indicates a gmd:CI_ResponsibleParty anywhere in an XML file. /*/ indicates a single level with several possible elements. This usually indicates one of several concrete realizations of an abstract object. For example /*/gmd:identificationInfo could be gmd:MD_Metadata/gmd:identificationInfo or gmi:MI_Metadata/gmd:identificationInfo and gmd:identificationInfo//*/gmd:descriptiveKeywords could be gmd:identificationInfo/gmd:MD_DataIdentification/gmd:descriptiveKeywords or gmd:identificationInfo/srv:SV_ServiceIdentification/gmd:descriptiveKeywords.
