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

Compare with Current View Page History

« Previous Version 15 Next »

Element Description

The Related URLs element is used to link to resources containing information related to a data set. The Related URL may also link to data access points, as well as relevant tools and services. 


Best Practices

The Related URLs metadata element allows for the linkage of a metadata record to external resources or locations on the web. When used properly, this element allows users to quickly and easily access data, as well as access relevant services and information about the data. At a minimum, Related URLs should point to:

  • A data access location
  • A landing page for the associated data set
  • Any relevant services provided for the data (if applicable)
  • A user's guide or comparable documentation which provides important information about the data set 

There are two special sub-sections within Related URLs. These include the GET DATA and the GET SERVICE sub-elements. A separate wiki page with full details has been developed for each of these sub-sections:

Related URLs (GET DATA)

Related URLs (GET SERVICE)

The details on this wiki page are for general Related URL guidance and do not include any of the GET DATA or GET SERVICE sub-elements. 

Several of the elements within the Related URLs section of the metadata serve to properly identify the purpose of the link. These identifying 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 with the following options: "CollectionURL", "PublicationURL", "DataCenterURL", "DistributionURL", "DataContactURL", "VisualizationURL". The URL Content Type helps specify how the URL will be displayed in the Earthdata Search Client.   

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). A list of valid URL Type keywords can be found here: https://gcmdservices.gsfc.nasa.gov/static/kms/rucontenttype/rucontenttype.csv? Note that the keyword list does not include the upper level URL Content Type keywords (specified above & maintained in the UMM schema). Please see the diagram below for details on the relationship between URL Content Type keywords and URL Type keywords.  

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 is optional, but should be used when applicable. The URL Subtype keywords are maintained in the Keyword Management System (KMS). A list of valid URL Subtype keywords can be found here: https://gcmdservices.gsfc.nasa.gov/static/kms/rucontenttype/rucontenttype.csv?

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 where the link navigates and the type of information it contains. 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 URLs with the same URL Type and Subtype. 

Please see the below diagram for the full relationship between URL Content Type, Type, and Subtype keywords:

    

Examples:

URL: https://daac.ornl.gov/ACTAMERICA/guides/ACTAMERICA-PICARRO_Ground.html

URL Content Type: PublicationURL

URL Type: VIEW RELATED INFORMATION

URL Subtype: USER'S GUIDE

Description: The guide document contains detailed information about the data set.


URL: https://ghrc.nsstc.nasa.gov/home/micro-articles/lake-effect-snow

URL Content Type: PublicationURL

URL Type: VIEW RELATED INFORMATION

URL Subtype: MICRO ARTICLE

Description: Learn about how AMSR-2 data can be used to study lake effect snow in this micro article. 


Element Specification

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

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

1 - 1024 characters

Yes1
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

The DataCenterURL option is only valid in the Data Centers section of the metadata. The DataContactURL option is only valid in the Data Contacts section of the metadata.

UMM-CommonRelatedUrls/TypeStringKMS controlledn/aYes1Each Type keyword corresponds to a specific URL Content Type category.
UMM-CommonRelatedUrls/SubtypeStringKMS controlledn/aNo0..1The Type and Subtype are part of a keyword hierarchy specified in the KMS.




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:

  • No Related URLs are provided
  • The URL provided is broken
  • The URL provided is incorrect/ unrelated to the associated data set
  • The URL Type or Subtype provided does not accurately describe the link
  • The URL Type or Subtype provided does not align with the KMS
    • The Type or Subtype does not exist in the 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 links to an FTP server (this only applies to NASA EOSDIS metadata)

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.
  • A recommendation is made to change a valid URL Type or Subtype keyword for purposes of consistency with other similar metadata records

This element is categorized as low priority when:

  • The 'Description' element is identical for multiple URLs
  • If a recommendation is made to add a URL to the metadata, there will be accompanying blue recommendations to add the appropriate URL Content Type/ URL Type/ Subtype elements.
  • A URL is provided via http when https is available
  • The URL provided in the metadata redirects - it is recommended that the most current link always be provided

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..*)

SpecificationPathTypeUsable Valid ValuesConstraintsRequired in DIF 10?CardinalityNotes
DIF 10

/DIF/Related_URL/URL

URI



No

0..*

The link is provided here.

DIF 10/DIF/Related_URL/URL_Content_Type/TypeStringKMS controlled


No0..1
DIF 10/DIF/Related_URL/URL_Content_Type/Subtype
StringKMS controlled



No0..1

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

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 controlled
No0..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>DATA SET LANDING PAGE</Type>
  </URL_Content_Type>
  <URL>https://doi.org/10.3334/ORNLDAAC/1568</URL>
  <Description>Access the data set landing page for the collection.</Description>
</Related_URL>
<Related_URL>
  <URL_Content_Type>
    <Type>VIEW RELATED INFORMATION</Type>
    <Subtype>USER'S GUIDE</Subtype>
  </URL_Content_Type>
  <URL>https://daac.ornl.gov/ACTAMERICA/guides/ACTAMERICA-PICARRO_Ground.html</URL>
  <Description>The guide document contains detailed information about the data set.</Description>
</Related_URL>

UMM

RelatedUrls: [
  {
    Description: "Access the data set landing page for the collection.",
    URLContentType: "CollectionURL",
    Type: "DATA SET LANDING PAGE",
    URL:  "https://doi.org/10.3334/ORNLDAAC/1568",
  },
  {
    Description: "The guide document contains detailed information about the data set.",
    URLContentType: "PublicationURL",
    Type: "VIEW RELATED INFORMATION",
    Subtype: "USER'S GUIDE",
    URL:  "https://daac.ornl.gov/ACTAMERICA/guides/ACTAMERICA-PICARRO_Ground.html"
  }
]

ECHO 10

An unlimited amount of OnlineResources or AssociatedBrowseImageUrls may be listed (Cardinality: 0..*)

SpecificationPathTypeUsable Valid ValuesConstraintsRequired in ECHO10?CardinalityNotes
ECHO 10/Collection/OnlineResources/OnlineResource/URLString


Yes1
ECHO 10/Collection/OnlineResources/OnlineResource/DescriptionString

No0..1
ECHO 10/Collection/OnlineResources/OnlineResource/TypeStringKMS controlled
Yes1ECHO 10 only has a single URL Type field (not a Type and Subtype field). Thus, a URL Type may be selected from either the URL Type or Subtype keywords.
ECHO 10/Collection/OnlineResources/OnlineResource/MimeTypeStringKMS controlled
No0..1It is recommended that a mime type always be provided for service URLs.
ECHO 10/Collection/AssociatedBrowseImageUrls/ProviderBrowseUrl/URLString


No0..1This element can be used to link to a browse image. Browse images may also be provided as an Online Resource URL. Use of the Associated Browse URL element is discouraged in favor of the Online Resource URL.
ECHO 10/Collection/AssociatedBrowseImageUrls/ProviderBrowseUrl/DescriptionString

No0..1A brief explanation/ description of the browse image.


Enumeration Mapping

ECHO 10

Translation

Direction

UMM
Not Applicable↔Not Applicable

Example Mapping

ECHO 10

UMM

RelatedUrls: [
  {
    Description: "Access the data set landing page for the collection.",
    URLContentType: "CollectionURL",
    Type: "DATA SET LANDING PAGE",
    URL:  "https://doi.org/10.3334/ORNLDAAC/1568",
  },
  {
    Description: "The guide document contains detailed information about the data set.",
    URLContentType: "PublicationURL",
    Type: "VIEW RELATED INFORMATION",
    Subtype: "USER'S GUIDE",
    URL:  "https://daac.ornl.gov/ACTAMERICA/guides/ACTAMERICA-PICARRO_Ground.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
inapplicable↔Not Applicable

Example Mapping

ISO 19115-2 MENDS

UMM



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
inapplicable↔Not Applicable

Example Mapping

ISO 19115-2 SMAP

UMM




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
inapplicable↔Not Applicable

ISO 19115-1

UMM

History

UMM Versioning

VersionDateWhat Changed
1.10.05/2/2018<>
1.9.0

ARC Documentation

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



  • No labels