You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

Element Description

The Related URLs element, when accompanied by the 'get data' sub-elements, is used to link directly to a data access point. This is different from a GET SERVICE URL, which relates to methods of sub-setting and/or transforming data before obtaining it. For details concerning GET SERVICE URLs, please see the Related URLs (GET SERVICE) wiki page

Best Practices

The GET DATA Related URL metadata element allows for the linkage of a metadata record to a location on the web where data may be directly accessed. As mentioned on the Related URLs wiki page, there are several sub-elements which are used to identify the purpose of the URL. For GET DATA links specifically, best practices for these elements include:

URL Content Type: The URL Content Type is a keyword which, at a high level, describes the content of a link. This is a controlled vocabulary field maintained as an enumeration list within the UMM-Common schema. For GET DATA URLs, the URL Content Type should always be "DistributionURL".

URL Type: The URL Type is a keyword which specifies the content of a link. URL Type keywords are maintained in the Keyword Management System (KMS). For GET DATA URLs, the URL Type should always be "GET DATA".

URL Subtype: The URL Subtype is a keyword which further specifies the content of a link. Together, the URL Type and Subtype keywords create a keyword hierarchy which is used to identify the URL. Providing a Subtype for GET DATA URLs is optional, but should be used when applicable. Currently (as of 7/25/2018) the following Subtype keywords are valid under GET DATA: <insert list> Should we include examples/ a brief description of each subtype?

Description: While not required, it is highly recommended that a description be provided for each URL provided in the metadata. The description should be kept brief and explain to the user that the link goes to a data access point. The descriptions should be unique to the link. While descriptions can be repeated for the same type of URL across different metadata records, it is generally advised that the same description not be repeated within the same metadata record. I.e. the description should be used to further differentiate two GET DATA URLs with the same URL Type and Subtype. 

A GET DATA URL is required for all NASA data sets. For NASA EOSDIS data, data access should be behind URS authentication. For NASA EOSDIS data, it is also recommended that data access not be provided via FTP protocol, in favor of the HTTPS protocol.

There are several sub-elements specifically designated for GET DATA URLs. The following provides definitions and best practices for each of the sub-elements:

RelatedUrls/GetData/Format: The format of the data provided via the associated URL. Providing the format is required??. Format is a controlled vocabulary field and should be chosen from the <insert GCMD data format keyword list>. If data is provided in a compressed file format, recommend listing the format of the data once it is uncompressed.   

RelatedUrls/GetData/MimeType: The mime type of the associated URL. Mime Type is a controlled vocabulary field and should be chosen from the <insert GCMD mime type keyword list>. Providing a Mime Type is optional.  

RelatedUrls/GetData/SizeReally only makes sense to provide if the link is a direct download. Is this going to remain a required field? 

RelatedUrls/GetData/UnitReally only makes sense to provide if the link is a direct download. Is this going to remain a required field?

RelatedUrls/GetData/FeesThe fee (if any) for ordering the data. The fee should be a number in U.S. dollars. This is an optional field.  

RelatedUrls/GetData/ChecksumDoes it only make sense to provide a checksum if the link directly downloads a file? Or should you provide one if the link just takes you to another web page e.g. a 'data tree' type of page? Would like to provide some guidelines for when use of this field is encouraged.


Examples:

URL: https://hydro1.gesdisc.eosdis.nasa.gov/data/FLDAS/FLDAS_VIC025_C_EA_M.001/

URL Content Type: DistributionURL

URL Type: GET DATA

URL Subtype: DATA TREE

Description: Use the link to access the data via HTTPS. Files are organized by date.

Format: NetCDF-4 

Mime Type: text/html 

Size: Is this element getting updated?

Unit: MB

Fees: 0


URL: https://daac.ornl.gov/cgi-bin/download.pl?ds_id=465&source=dsviewer

URL Content Type: DistributionURL

URL Type: GET DATA

URL Subtype: DIRECT DOWNLOAD

Description: Downloads the NPP Boreal Forest: Canal Flats, Canada, 1984, R1 data set directly to your workstation. 

Format: Text File 

Size: 91.8

Unit: KB

Fees: 0

Checksum: f2 aa 78 d6 82 5e c4 2d 78 35 81 a8 d5 ea 1f 68


Element Specification

An unlimited amount of Related URLs may be listed (Cardinality: 0..*)

ModelElementTypeUsable Valid ValuesConstraintsRequired?CardinalityNotes
UMM-CommonRelatedUrls/URLStringn/a

1 - 1024 characters

Yes1The GET DATA URL should point the user to a location where data files may be directly downloaded.
UMM-CommonRelatedUrls/DescriptionStringn/a1 - 4000 charactersNo0..1It is strongly recommended that a description be provided for each URL.
UMM-CommonRelatedUrls/URLContentTypeEnumeration

CollectionURL

PublicationURL

DataCenterURL

DistributionURL

DataContactURL

VisualizationURL

n/aYes1

"DistributionURL" is the only valid option for links used to obtain the data.

UMM-CommonRelatedUrls/TypeStringKMS controlledn/aYes1"GET DATA" should be provided as the Type.
UMM-CommonRelatedUrls/SubtypeStringKMS controlledn/aNo0..1

The Type and Subtype are part of a keyword hierarchy specified in the KMS.

Any Subtype listed get after GET DATA in the keyword list is a valid option. If none of the available Subtypes are appropriate for the URL, then it is okay to leave the Subtype field blank.

UMM-CommonRelatedUrls/GetData/FormatStringKMS controlledn/aYes1

Are we keeping this field?

The format of the data provided via the associated URL.

UMM-CommonRelatedUrls/GetData/MimeTypeStringKMS controlledn/aNo0..1The mime type of the associated URL.
UMM-CommonRelatedUrls/GetData/SizeNumbern/an/aYes1

Really only makes sense to provide if the link is a direct download. Is this going to remain a required field?

The size of the data obtained via the associated URL.

UMM-CommonRelatedUrls/GetData/UnitEnumeration

KB

MB

GB

TB

PB

n/aYes1

Really only makes sense to provide if the link is a direct download. Is this going to remain a required field?

Unit is required if information is provided in the 'Size' element.


UMM-CommonRelatedUrls/GetData/FeesStringn/a1 - 80 charactersNo0..1

The fee (if any) for ordering the data. The fee should be a number in U.S. dollars.

UMM-CommonRelatedUrls/GetData/ChecksumStringn/a1 - 50 charactersNo0..1

Does it only make sense to provide a checksum if the link directly downloads a file? Or should you provide one if the link just takes you to another web page e.g. a 'data tree' type of page? Would like to provide some guidelines for when use of this field is encouraged.


Metadata Validation and QA/QC

All metadata entering the CMR goes through the below process to ensure metadata quality requirements are met. All records undergo CMR validation before entering the system. The process of QA/QC is slightly different for NASA and non-NASA data providers. Non-NASA providers include interagency and international data providers and are referred to as the International Directory Network (IDN).

Please see the expandable sections below for flowchart details.



<>

ARC Priority Matrix

Priority CategorizationJustification

This element is categorized as highest priority when:

  • A GET DATA URL is not provided in the metadata
  • The link labeled as GET DATA is broken
  • The link is mislabeled as GET DATA (i.e. the link serves a purpose other than data access)
  • The GET DATA link is labeled incorrectly (i.e. a data access link is provided in the metadata but it is labeled as something else)
  • The GET DATA link is provided via FTP
  • The GET DATA link fails to take the user as directly as possible to the described data
  • The URL Type or Subtype provided does not align with the KMS
    • The Type or Subtype does not exist in KMS
    • The Type or Subtype is placed in the incorrect position of the hierarchy (e.g. GET DATA should not be provided in the Subtype field, because it is categorized as a Type keyword in the KMS)
    • There is an invalid Type/Subtype relationship (e.g. Type: GET DATA, Subtype: USER'S GUIDE, is not a valid combination in the KMS)
  • The URL Type or Subtype provided does not accurately describe the link
  • The mime type provided is incorrect
  • The data format provided is incorrect

This element is categorized as medium priority when:

  • The 'Description' element is left blank. It is highly recommended that a description be provided for each URL.

This element is categorized as low priority when:

  • A description is repeated for multiple GET DATA URLs

The element is provided, and follows all applicable criteria specified in the best practices section above.

ARC Automated Rules

<insert>



Dialect Mappings

DIF 9 (Note: DIF-9 is being phased out and will no longer be supported after 2018)

DIF 10

An unlimited amount of Related URLs may be listed (Cardinality: 0..*)

SpecificationPathTypeConstraintsRequired in DIF 10?CardinalityNotes
DIF 10

/DIF/Related_URL/URL

URI


No

0..*

The GET DATA URL should point the user to a location where data files may be directly downloaded.

DIF 10/DIF/Related_URL/URL_Content_Type/TypeString

KMS controlled

No0..1"GET DATA" should be provided as the Type.
DIF 10/DIF/Related_URL/URL_Content_Type/Subtype
String

KMS controlled


No0..1

The Type and Subtype are part of a keyword hierarchy specified in the KMS.

Any Subtype listed get after GET DATA in the keyword list is a valid option. If none of the available Subtypes are appropriate for the URL, then it is okay to leave the Subtype field blank.

DIF 10/DIF/Related_URL/DescriptionString
No0..1It is strongly recommended that a description be provided for each URL.
DIF 10/DIF/Related_URL/Mime_TypeStringKMS controlledNo0..1
DIF 10/DIF/Related_URL/ProtocolString
No0..1
DIF 10/DIF/Related_URL/TitleString
No0..1
DIF 10/DIF/Related_URL/Application_ProfileString
No0..1
DIF 10/DIF/Related_URL/FunctionString
No0..1


Example Mapping

DIF 10

<Related_URL>
<URL_Content_Type>
<Type>GET DATA</Type>
<Subtype>DATA TREE</Subtype>
</URL_Content_Type>
<URL>https://oco2.gesdisc.eosdis.nasa.gov/data/s4pa/OCO2_DATA/OCO2_L2_Met.8r/</URL>
  <Mime_Type>text/html</Mime_Type>
<Description>Use the link to navigate and download data files organized by date.</Description>
</Related_URL>

UMM

RelatedUrls: [
  {
    Description: "Use the link to navigate and download data files organized by date.",
    URLContentType: "DistributionURL",
    Type: "GET DATA",
    Subtype: "DATA TREE",
    URL:  "https://oco2.gesdisc.eosdis.nasa.gov/data/s4pa/OCO2_DATA/OCO2_L2_Met.8r/",
   -GetData: {
      MimeType: "text/html"
    }
  }
]

ECHO 10

SpecificationPathTypeConstraintsRequired in ECHO10?CardinalityNotes
ECHO 10/Collection/DOI/DOIString

1 - 1024 characters

No0..1n/a
ECHO 10/Collection/DOI/AuthorityString

1 - 80 characters

No0..1For ESDIS providers, recommend providing "https://doi.org/" as the DOI authority.


Enumeration Mapping

ECHO 10

Translation

Direction

UMM
Not ApplicableNot Applicable

Example Mapping

ECHO 10

 

UMM

RelatedUrls: [
  {
    Description: "Use the link to navigate and download data files organized by date.",
    URLContentType: "DistributionURL",
    Type: "GET DATA",
    Subtype: "DATA TREE",
    URL:  "https://oco2.gesdisc.eosdis.nasa.gov/data/s4pa/OCO2_DATA/OCO2_L2_Met.8r/",
   -GetData: {
      MimeType: "text/html"
    }
  }
]



ISO 19115-2 MENDS

SpecificationPathTypeNotes
ISO 19115-2 MENDS

/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString

String


Where the DOI string is provided.

/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:codeSpace/gco:CharacterString = gov.nasa.esdis.umm.doiStringThe value of "gov.nasa.esdis.umm.doi" should be provided here so that CMR can properly parse out the DOI.
/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:description/gco:CharacterString contains DOIStringThe value must contain the string "DOI" so that CMR can properly identify and translate the DOI.
ISO 19115-2 MENDS

/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:authority/gmd:CI_Citation/gmd:title - empty element

String

Leave this element empty.

/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:authority/gmd:CI_Citation/gmd:date - empty elementStringLeave this element empty.
/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:authority/gmd:CI_Citation/ gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/gmd:organisationName/gco:CharacterString StringProvide the authority here. For ESDIS providers, recommend listing "https://doi.org" as the DOI authority.
/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:authority/gmd:CI_Citation/ gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/gmd:role/gmd:CI_RoleCode codeList="https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#CI_RoleCode" codeListValue="" = authorityCodelistChoose the "authority" codelist value so that CMR can properly identify the DOI/Authority element. This codelist value does not directly map to a UMM element - choosing 'authority' indicates to CMR that the Authority element should be mapped.


Enumeration/Code List Mapping

ISO MENDS

Translation

Direction

UMM
inapplicableNot Applicable

Example Mapping

ISO 19115-2 MENDS

 

UMM

RelatedUrls: [
  {
    Description: "Use the link to navigate and download data files organized by date.",
    URLContentType: "DistributionURL",
    Type: "GET DATA",
    Subtype: "DATA TREE",
    URL:  "https://oco2.gesdisc.eosdis.nasa.gov/data/s4pa/OCO2_DATA/OCO2_L2_Met.8r/",
   -GetData: {
      MimeType: "text/html"
    }
  }
]



ISO 19115-2 SMAP

SpecificationPathTypeNotes
ISO 19115-2 SMAP

/gmd:DS_Series/gmd:seriesMetadata/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString

String


Where the DOI string is provided.

/gmd:DS_Series/gmd:seriesMetadata/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:codeSpace/gco:CharacterString = gov.nasa.esdis.umm.doiStringThe value of "gov.nasa.esdis.umm.doi" should be provided here so that CMR can properly parse out the DOI.
/gmd:DS_Series/gmd:seriesMetadata/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:description/gco:CharacterString contains DOIStringThe value must contain the string "DOI" so that CMR can properly identify and translate the DOI.
ISO 19115-2 SMAP/gmd:DS_Series/gmd:seriesMetadata/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:authority/gmd:CI_Citation/gmd:title - empty element

String

Leave this element empty.

/gmd:DS_Series/gmd:seriesMetadata/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:authority/gmd:CI_Citation/gmd:date - empty elementStringLeave this element empty.
/gmd:DS_Series/gmd:seriesMetadata/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:authority/gmd:CI_Citation/ gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/gmd:organisationName/gco:CharacterString StringProvide the authority here. For ESDIS providers, recommend listing "https://doi.org" as the DOI authority.
/gmd:DS_Series/gmd:seriesMetadata/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:authority/gmd:CI_Citation/ gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/gmd:role/gmd:CI_RoleCode codeList="https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#CI_RoleCode" codeListValue="" = authorityCodelistChoose the "authority" codelist value so that CMR can properly identify the DOI/Authority element. This codelist value does not directly map to a UMM element - choosing 'authority' indicates to CMR that the Authority element should be mapped.


Enumeration/Code List Mapping

ISO SMAP

Translation

Direction

UMM
inapplicableNot Applicable

Example Mapping

ISO 19115-2 SMAP

 

UMM

RelatedUrls: [
  {
    Description: "Use the link to navigate and download data files organized by date.",
    URLContentType: "DistributionURL",
    Type: "GET DATA",
    Subtype: "DATA TREE",
    URL:  "https://oco2.gesdisc.eosdis.nasa.gov/data/s4pa/OCO2_DATA/OCO2_L2_Met.8r/",
   -GetData: {
      MimeType: "text/html"
    }
  }
]



UMM Migration

None


Future Mappings

ISO 19115-1

SpecificationPathTypeNotes
ISO 19115-1

/mdb:MD_Metadata/mdb:identificationInfo/mri:MD_DataIdentification/mri:citation/cit:CI_Citation/

cit:identifier/mcc:MD_Identifier/mcc:code/gco:CharacterString

StringWhere the DOI string is provided.

/mdb:MD_Metadata/mdb:identificationInfo/mri:MD_DataIdentification/mri:citation/cit:CI_Citation/

cit:identifier/mcc:MD_Identifier/mcc:codeSpace = gov.nasa.esdis.umm.doi

StringThe value of "gov.nasa.esdis.umm.doi" should be provided here so that CMR can properly parse out the DOI.

/mdb:MD_Metadata/mdb:identificationInfo/mri:MD_DataIdentification/mri:citation/cit:CI_Citation/

cit:identifier/mcc:MD_Identifier/mcc:description/gco:CharacterString contains DOI

StringLeave this element empty.
ISO 19115-1

/mdb:MD_Metadata/mdb:identificationInfo/mri:MD_DataIdentification/mri:citation/cit:CI_Citation/

cit:identifier/mcc:MD_Identifier/mcc:authority/cit:CI_Citation/cit:title - empty element

StringProvide the authority here. For ESDIS providers, recommend listing "https://doi.org" as the DOI authority.

/mdb:MD_Metadata/mdb:identificationInfo/mri:MD_DataIdentification/mri:citation/cit:CI_Citation/

cit:identifier/mcc:MD_Identifier/mcc:authority/cit:CI_Citation/cit:citedResponsibleParty/

cit:CI_Responsibility/cit:party/cit:CI_Organization/cit:name/gco:CharacterString

StringProvide the authority here. For ESDIS providers, recommend listing "https://doi.org" as the DOI authority.

/mdb:MD_Metadata/mdb:identificationInfo/mri:MD_DataIdentification/mri:citation/cit:CI_Citation/

cit:identifier/mcc:MD_Identifier/mcc:authority/cit:CI_Citation/cit:citedResponsibleParty/cit:CI_Responsibility/cit:role/cit:roleCode codeList="http://standards.iso.org/iso/19115/resources/Codelist/cat/codelists.xml#CI_RoleCode" codeListValue="" value = authority

CodelistChoose the "authority" codelist value so that CMR can properly identify the DOI/Authority element. This codelist value does not directly map to a UMM element - choosing 'authority' indicates to CMR that the Authority element should be mapped.


Enumeration/Code List Mapping

ISO 19115-1

Translation

Direction

UMM
inapplicableNot Applicable

ISO 19115-1

 

UMM

RelatedUrls: [
  {
    Description: "Use the link to navigate and download data files organized by date.",
    URLContentType: "DistributionURL",
    Type: "GET DATA",
    Subtype: "DATA TREE",
    URL:  "https://oco2.gesdisc.eosdis.nasa.gov/data/s4pa/OCO2_DATA/OCO2_L2_Met.8r/",
   -GetData: {
      MimeType: "text/html"
    }
  }
]

History

UMM Versioning

VersionDateWhat Changed
1.10.05/2/2018<>
1.9.0

ARC Documentation

VersionDateWhat ChangedAuthor
1.06/13/18Recommendations/priority matrix transferred from internal ARC documentation to wiki spaceJeanne' le Roux



  • No labels