Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
stylecircle

Element Description

The Related URLs element provides access to resources related to a granule (i.e. an individual data file within a collection/ dataset). The Related URL should link to a data access point, as well as relevant tools and services. 

Note: This wiki page pertains to Related URLs in granule level metadata. For guidance on Related URLs in collection level metadata, please see the RelatedURLs (COLLECTIONS) wiki page.

***THIS PAGE IS A DRAFT***

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. While there are many links that could be provided, it is generally recommended that the granule level Related URLs be kept more light-weight. At a minimum, it is recommended that the following URLs be provided in granule metadata:

  • A link to directly access/ download the granule data (i.e. the user should not have to navigate through sub-folders or conduct additional search queries to access the data pertinent to the granule)
  • A link to any relevant services provided for the granule (if applicable) such as: Web Map Services (WMS), OPeNDAP, THREDDS, Web Map Tile Services (WMTS), Web Coverage Services (WCS), etc. 

Links to the following resources are highly recommended at the collection level but are considered less important to include in granule metadata. There is certainly no harm in providing links to these resources, but doing so is completely optional and is left to the discretion of the metadata provider:

  • A link to the landing page for the associated parent collection/ dataset
  • A link to the dataset user's guide and/or comparable documentation which provides important information about how to use the data 
  • A link to relevant software packages
  • A link to relevant online data tools
  • A link to relevant PI documentation
  • Read-Me files
  • Data citation policies
  • Algorithm Theoretical Basis Document (ATBD)
  • Any other documentation directly related to the data (examples include: data recipes, micro articles, product quality assessment documentation, important announcements, documentation on data set anomalies, etc.)  

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

Related URLs (GET DATA)

Related URLs (USE SERVICE API)

The details on this wiki page are for general Related URL guidance and do not include any of the GET DATA or USE SERVICE API 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://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/rucontenttype?format=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://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/rucontenttype?format=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:

Lucidchart
lcId5c763b14-d23e-4463-a855-cc931af7f60a
rich-viewertrue
autoUpdatefalse
autofittrue
nameRelatedURL Flowchart
width2900
documentTokene2d9afc2-91e5-44ad-9482-2eee1320ef43|106473568||968eaYEqp8/7owC14lE1oIJ9cvAVTpeAnUo14YHLPnY=
ide2d9afc2-91e5-44ad-9482-2eee1320ef43
alignLeft
height954

    

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

Related URLs is a required metadata element. At least 1 Related URL must be provided. Multiple URLs may be provided if necessary (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/TypeStringGCMD URL Content Type 'Type' KeywordsKMS controlledYes1Each Type keyword corresponds to a specific URL Content Type category.
UMM-CommonRelatedUrls/SubtypeStringGCMD URL Content Type 'Subtype' KeywordsKMS controlledNo0..1The Type and Subtype are part of a keyword hierarchy specified in the KMS.
UMM-GRelatedUrls/FormatStringGCMD Granule Data Format KeywordsKMS controlledNO0..1



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

Lucidchart
rich-viewerfalse
autofittrue
nameCopy of Wiki Page Metadata Evaluation Workflow-1939-51df84
width1102
pages-to-display
id98e5dc28-3252-4209-953f-66f1378e1cf4
alignLeft
height299

Please see the expandable sections below for flowchart details.


Expand
titleGCMD Metadata QA/QC
  • Manual Review
    • Identify errors, discrepancies or omissions.
    • Confirm that the URLs link to the appropriate web pages.
  • Automated Review
    • Check that the field has been populated.
    • Check that the URL_Content_Type field is populated with a valid value from KMS.
    • Check for potential broken links.
    • Check that the URL is formatted correctly.
    • Check that the field length of Description is not greater than 12,000 characters.
    • Check that the field length of URL is not greater than 1,024 characters.
Expand
titleCMR Validation
  • Checks to see that the URL value is a syntactically valid URL.
  • Checks to see if a description is present
  • Validates that the RelatedUrl/Type and Subtype values correspond to the correct value in the URLContentType element.
  • Validates that the object types of GET DATA and GET SERVICE are only used with Distribution URLs.
Expand
titleARC Metadata QA/QC

ARC Priority Matrix

Priority CategorizationJustification

Red = High Priority Finding

This element is categorized as highest priority when:

  • No Related URL is provided.
    • No data access URL is provided. For further details on data access URLs please see the Related URLs (GET DATA) wiki page.
    • A data access URL is provided but it doesn't link directly to the described granule. 
    • There is a link to an OPeNDAP or THREDDS server provided at the collection level, but no direct link to the service for the granule is provided. For further details on service URLs please see the Related URLs (USE SERVICE API) wiki page.
  • The URL provided is broken.
  • The URL provided is incorrect/ unrelated to the associated dataset.
  • The URL Type or Subtype provided does not accurately describe the link (i.e. the link is mislabeled).
  • 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).

Yellow = Medium Priority Finding

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.

Blue = Low Priority Finding

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 URLContentType/URLType/Subtype elements.
  • If a URL with Type "USE SERVICE API" is present, but no mime type is provided, a blue recommendation will be made to add a mime type for the service URL. 
  • A URL is provided via http when https is available.
  • If a recommendation is made to add a new "USE SERVICE API" URL to the metadata, there will be an accompanying blue recommendation to add a mime type for the service URL.
  • The URL provided in the metadata re-directs. It is recommended that the most current link always be provided.

Green = No Findings/Issues

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

ARC Automated Checks

ARC uses the pyQuARC library for automated metadata checks. Please see the pyQuARC GitHub for more information. 

Dialect Mappings

Expand
titleDIF 9

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

Expand
titleDIF 10

DIF 10

Related_URL is a required metadata element. At least 1 Related_URL must be provided. Multiple URLs may be provided if necessary (Cardinality: 0..*).

UMM-C ElementPathTypeUsable Valid ValuesConstraintsRequired in DIF 10?CardinalityNotes
RelatedUrls/URL

/DIF/Related_URL/URL

URI



No

0..*

The link is provided here.

RelatedUrls/URLContentType





The URLContentType is derived from the Types.
RelatedUrls/Type/DIF/Related_URL/URL_Content_Type/TypeStringGCMD URL Content Type 'Type' Keywords

KMS controlled

No0..1
RelatedUrls/Subtype/DIF/Related_URL/URL_Content_Type/Subtype
StringGCMD URL Content Type 'Subtype' Keywords


KMS 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.

RelatedUrls/Description

/DIF/Related_URL/DescriptionString

No0..1It is strongly recommended that a description be provided for each URL.
RelatedUrls/GetData/MimeType/DIF/Related_URL/Mime_TypeStringGCMD Mime Type KeywordsKMS controlledNo0..1This is only translated to UMM if the The
RelatedUrls/GetService/Protocol/DIF/Related_URL/ProtocolString

No0..1

/DIF/Related_URL/TitleString

No0..1

/DIF/Multimedia_Sample/FileString

No0..1
RelatedUrls/URL/DIF/Multimedia_Sample/URLString

No0..1

/DIF/Multimedia_Sample/FormatString

No0..1

/DIF/Multimedia_Sample/CaptionString

No0..1
RelatedUrls/Description

/DIF/Multimedia_Sample/Description

String

No0..1
RelatedUrls/URLContentType = VisualizationURL





For all Multimedia URLs translated to UMM the URLContentType is VisualizationURL
RelatedUrls/Type = GET RELATED VISUALIZATION





For all Multimedia URLs translated to UMM the Type is GET RELATED VISUALIZATION


Example Mapping

Section

DIF 10

Column
width50%
<Multimedia_Sample>
  <File>ACOS</File>
  <URL>https://docserver.gesdisc.eosdis.nasa.gov/public/project/OCO/ACOS.Lite.2015_v7.3.png</URL>
  <Format>PNG</Format>
  <Caption>Global amounts of column CO2, averaged for 2015, using ACOS_L2_Lite_FP v7.3.</Caption>
  <Description>Global amounts of column CO2, averaged for 2015, using ACOS_L2_Lite_FP v7.3. This average used 365 "Lite" files, gridded on a 6x6 deg grid, and smoothed for the presentation.</Description>
</Multimedia_Sample>
...
<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>
Column
width50%

UMM

No Format
"RelatedUrls": [
  {
    "Description": "Global amounts of column CO2, averaged for 2015, using ACOS_L2_Lite_FP v7.3. This average used 365 \"Lite\" files, gridded on a 6x6 deg grid, and smoothed for the presentation.",
    "URLContentType": "VisualizationURL",
    "Type": "GET RELATED VISUALIZATION",
    "URL": "https://docserver.gesdisc.eosdis.nasa.gov/public/project/OCO/ACOS.Lite.2015_v7.3.png"
  }, {
    "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"
  }
]
Expand
titleECHO 10

ECHO 10

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

UMM-C ElementPathTypeUsable Valid ValuesConstraintsRequired in ECHO10?CardinalityNotes
RelatedUrls/URL/OnlineAccessURLs/OnlineAccessURL/URLString
String length from 1 to 1024Yes1
RelatedUrls/Description/OnlineAccessURLs/OnlineAccessURL/URLDescriptionString
String length from 1 to 4000No0..1
RelatedUrls/URLContentType = DistributionURL





All OnlineAccessURLs are URLContentTypes of DistributionURL
RelatedUrls/Type = GET DATA





All OnlineAccessURLs are Types of GET DATA
RelatedUrls/GetData/MimeType/OnlineAccessURLs/OnlineAccessURL/MimeTypeString
String length from 1 to 50No0..1
RelatedUrls/URL/Collection/OnlineResources/OnlineResource/URLString

String length from 1 to 1024

Yes1
RelatedUrls/Description/Collection/OnlineResources/OnlineResource/DescriptionString
String length from 1 to 4000No0..1

RelatedUrls/URLContentType

RelatedUrls/Type

RelatedUrls/Subtype

/Collection/OnlineResources/OnlineResource/TypeStringAny GCMD URL Content Type Keyword

KMS controlled

String length from 1 to 50

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.

RelatedUrls/GetData/MimeType

/Collection/OnlineResources/OnlineResource/MimeTypeStringGCMD Mime Type Keywords

KMS controlled

String length from 1 to 50

No0..1It is recommended that a mime type always be provided for service URLs.
RelatedUrls/URL/Collection/AssociatedBrowseImageUrls/ProviderBrowseUrl/URLString

String length from 1 to 1024

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.
RelatedUrls/Description/Collection/AssociatedBrowseImageUrls/ProviderBrowseUrl/DescriptionString
String length from 1 to 4000No0..1A brief explanation/ description of the browse image.

/Collection/AssociatedBrowseImageUrls/ProviderBrowseUrl/FileSizeLong

No0..1

/Collection/AssociatedBrowseImageUrls/ProviderBrowseUrl/MimeTypeString
String length from 1 to 50No0..1
RelatedUrls/URLContentType = VisualizationURL





For all AssociatedBrowseImageUrls translated to UMM the URLContentType is VisualizationURL
RelatedUrls/Type = GET RELATED VISUALIZATION





For all AssociatedBrowseImageUrls translated to UMM the Type is GET RELATED VISUALIZATION


Example Mapping

Section
Column
width50%

ECHO 10

No Format
<OnlineAccessURLs>
  <OnlineAccessURL>
    <URL>https://daac.ornl.gov/daacdata/actamerica/ACTAMERICA-PICARRO_Ground/</URL>
    <URLDescription>This link allows direct data access via Earthdata login</URLDescription>
  </OnlineAccessURL>
</OnlineAccessURLs>
<OnlineResources>
  <OnlineResource>
    <URL>https://doi.org/10.3334/ORNLDAAC/1568</URL>
    <Description>Access the data set landing page for the collection.</Description>
    <Type>DATA SET LANDING PAGE</Type>
  </OnlineResource>
  <OnlineResource>
    <URL>https://daac.ornl.gov/ACTAMERICA/guides/ACTAMERICA-PICARRO_Ground.html</URL>
    <Description>The guide document contains detailed information about the data set.</Description>
    <Type>USER'S GUIDE</Type>
  </OnlineResource>
  <OnlineResource>
    <URL>https://daac.ornl.gov/graphics/browse/project/act-america_logo.png</URL>
    <Description>Browse Image</Description>
    <Type>GET RELATED VISUALIZATION</Type>
    <MimeType>image/png</MimeType>
  </OnlineResource>
</OnlineResources>
...
<AssociatedBrowseImageUrls>
  <ProviderBrowseUrl>
    <URL>https://s3.amazonaws.com/grfn-static/SENTINEL-1_INSAR_UNWRAPPED_INTERFEROGRAM_AND_COHERENCE_MAP_browse.png</URL>
  </ProviderBrowseUrl>
</AssociatedBrowseImageUrls>

Column
width50%

UMM

No Format
"RelatedUrls": [
  {
    "Description": "This link allows direct data access via Earthdata login",
    "URLContentType": "DistributionURL",
    "Type": "GET DATA",
    "URL": "https://daac.ornl.gov/daacdata/actamerica/ACTAMERICA-PICARRO_Ground"
  }, {
    "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"
  }, {
    "Description": "Browse Image",
    "URLContentType": "VisualizationURL",
    "Type": "GET RELATED VISUALIZATION",
    "URL":  "https://daac.ornl.gov/graphics/browse/project/act-america_logo.png"
  }, {
    "URLContentType" : "VisualizationURL",
    "Type" : "GET RELATED VISUALIZATION",
    "URL" : "https://s3.amazonaws.com/grfn-static/SENTINEL-1_INSAR_UNWRAPPED_INTERFEROGRAM_AND_COHERENCE_MAP_browse.png"
  } 
]



Expand
titleISO 19115-2 MENDS

ISO 19115-2 MENDS

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

Note: These ISO paths only apply to CollectionURLs and PublicationURLs. Please see the RelatedURLs (GET DATA) wiki page for ISO guidance specific to data access URLs. Please see the RelatedURLs (USE SERVICE API) wiki page for ISO guidance specific to services. Please see the Data Center wiki page for ISO guidance specific to DataCenterURLs. Please see the Data Contact wiki page for ISO guidance specific to DataCenterURLs.

UMM-C ElementPathTypeNotes
RelatedUrls/URL

/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:aggregationInfo/gmd:MD_AggregateInformation/gmd:aggregateDataSetName/ gmd:CI_Citation/gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/gmd:contactInfo/gmd:onlineResource/gmd:CI_OnlineResource/gmd:linkage/gmd:URL

String


Where the URL is provided.

Maps to the UMM element "RelatedUrls/URL"

Note: This path only applies to CollectionURLs and PublicationURLs.

RelatedUrls/Description/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/ gmd:aggregationInfo/gmd:MD_AggregateInformation/gmd:aggregateDataSetName/ gmd:CI_Citation/gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/ gmd:contactInfo/gmd:onlineResource/gmd:CI_OnlineResource/gmd:description/gco:CharacterString="Description: "String

Maps to the UMM element "RelatedUrls/Description"

A brief, unique description of the URL should be provided in this field. It is highly recommended that a description be provided for each URL.

* The character string should always start with the prefix "Description: " in order for CMR to properly parse out the URL description.

RelatedUrls/URLContentType

/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/ gmd:aggregationInfo/gmd:MD_AggregateInformation/gmd:aggregateDataSetName/ gmd:CI_Citation/gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/ gmd:contactInfo/gmd:onlineResource/gmd:CI_OnlineResource/gmd:description/gco:CharacterString="URLContentType: "String

Maps to the UMM element "RelatedUrls/URLContentType"

The URL Content Type is required in UMM and is used to specify how the link will display in the Earthdata Search Client. The URL Content Type must be selected from the following controlled vocabulary options: CollectionURL, PublicationURL, DataCenterURL, DistributionURL, DataContactURL, VisualizationURL. Please see the best practices section (above) on guidance on choosing the correct URL Content Type.

* The character string should always start with the prefix "URLContentType: " in order for CMR to properly parse out the URL Content Type.

RelatedUrls/Type

/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/ gmd:aggregationInfo/gmd:MD_AggregateInformation/gmd:aggregateDataSetName/ gmd:CI_Citation/gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/ gmd:contactInfo/gmd:onlineResource/gmd:CI_OnlineResource/gmd:description/gco:CharacterString="Type: "

String

Maps to the UMM element "RelatedUrls/Type"

Providing a URL Type is required in UMM. Failing to specify a Type in ISO metadata will result in the field being auto-populated by the CMR, which could result in the URL being mislabeled. URL Type is a GCMD controlled vocabulary field and must be selected from keywords in the KMS. Please see the best practices section (above) on guidance on choosing the correct URL Type.

* The character string should always start with the prefix "Type: " in order for CMR to properly parse out the URL Type.

RelatedUrls/Subtype

/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:aggregationInfo/ gmd:MD_AggregateInformation/gmd:aggregateDataSetName/ gmd:CI_Citation/gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/ gmd:contactInfo/gmd:onlineResource/gmd:CI_OnlineResource/gmd:description/gco:CharacterString="Subtype: " String

Maps to the UMM element "RelatedUrls/Subtype"

Providing a URL Subtype is optional, but is encouraged if an appropriate URL Subtype exists. URL Subtype is a GCMD controlled vocabulary field and must be selected from keywords in the KMS. Please see the best practices section (above) on guidance on choosing the correct URL Subtype.

* The character string should always start with with the prefix "Subtype: " in order for CMR to properly parse out the URL Subtype.


Example Mapping

Section
Column
width50%

ISO 19115-2 MENDS

No Format
<gmi:MI_Metadata>
...
  <gmd:identificationInfo>
  <gmd:MD_DataIdentification>
   <gmd:citation gco:nilReason="missing"/>
   <gmd:abstract gco:nilReason="missing"/>
    <gmd:aggregationInfo>
    <gmd:MD_AggregateInformation>
      <gmd:aggregateDataSetName>
        <gmd:CI_Citation>
        <gmd:title gco:nilReason="missing"/>
        <gmd:date gco:nilReason="missing"/>
          <gmd:citedResponsibleParty>
          <gmd:CI_ResponsibleParty>
            <gmd:contactInfo>
            <gmd:CI_Contact>
              <gmd:onlineResource>
              <gmd:CI_OnlineResource>
                <gmd:linkage>
                  <gmd:URL>https://doi.org/10.3334/ORNLDAAC/1568</gmd:URL>
                </gmd:linkage>
                <gmd:description>
                  <gco:CharacterString>Description: Access the data set landing page for the collection. URLContentType: CollectionURL URLType: DATA SET LANDING PAGE</gco:CharacterString>
                </gmd:description>
              </gmd:CI_OnlineResource>
              </gmd:onlineResource>
            </gmd:CI_Contact>
            </gmd:contactInfo>
           <gmd:role gco:nilReason="missing"/>
          </gmd:CI_ResponsibleParty>
          </gmd:citedResponsibleParty>
          <gmd:citedResponsibleParty>
          <gmd:CI_ResponsibleParty>
            <gmd:contactInfo>
             <gmd:CI_Contact>
              <gmd:onlineResource>
              <gmd:CI_OnlineResource>
                <gmd:linkage>
                  <gmd:URL>https://daac.ornl.gov/ACTAMERICA/guides/ACTAMERICA-PICARRO_Ground.html</gmd:URL>
                </gmd:linkage>
                <gmd:description>
                  <gco:CharacterString>Description: The guide document contains detailed information about the data set. URLContentType: PublicationURL URLType: VIEW RELATED INFORMATION URLSubtype: USER'S GUIDE</gco:CharacterString>
                </gmd:description>
              </gmd:CI_OnlineResource>
              </gmd:onlineResource>
             </gmd:CI_Contact>
            </gmd:contactInfo>
           <gmd:role gco:nilReason="missing"/>
          </gmd:CI_ResponsibleParty>
          </gmd:citedResponsibleParty>
        </gmd:CI_Citation>
      </gmd:aggregateDataSetName>
     <gmd:associationType gco:nilReason="missing"/>
    </gmd:MD_AggregateInformation>
    </gmd:aggregationInfo>
  </gmd:MD_DataIdentification>
  </gmd:identificationInfo>
...
</gmi:MI_Metadata>       
Column
width50%

UMM

No Format
"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"
  }
]



Expand
titleISO 19115-2 SMAP

ISO 19115-2 SMAP

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

Note: These ISO paths only apply to CollectionURLs and PublicationURLs. Please see the RelatedURLs (GET DATA) wiki page for ISO guidance specific to data access URLs. Please see the RelatedURLs (USE SERVICE API) wiki page for ISO guidance specific to services. Please see the Data Center wiki page for ISO guidance specific to DataCenterURLs. Please see the Data Contact wiki page for ISO guidance specific to DataCenterURLs.

UMM-C ElementPathTypeNotes
RelatedUrls/URL

gmd:DS_Series/gmd:seriesMetadata/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/ gmd:aggregationInfo/gmd:MD_AggregateInformation/gmd:aggregateDataSetName/ gmd:CI_Citation/gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/ gmd:contactInfo/gmd:onlineResource/gmd:CI_OnlineResource/gmd:linkage/gmd:URL

String


Where the URL is provided.

Maps to the UMM element "RelatedUrls/URL"

Note: This path only applies to CollectionURLs and PublicationURLs.

RelatedUrls/Descriptiongmd:DS_Series/gmd:seriesMetadata/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/ gmd:aggregationInfo/gmd:MD_AggregateInformation/gmd:aggregateDataSetName/ gmd:CI_Citation/gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/ gmd:contactInfo/gmd:onlineResource/gmd:CI_OnlineResource/gmd:description/gco:CharacterString="Description:"
String

Maps to the UMM element "RelatedUrls/Description"

It is highly recommended that a description be provided for each URL.

Provide a brief, unique description of the URL in this field. The value must start with the string "Description: " in order for CMR to properly identify the URL description.

RelatedUrls/URLContentType

gmd:DS_Series/gmd:seriesMetadata/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/ gmd:aggregationInfo/gmd:MD_AggregateInformation/gmd:aggregateDataSetName/ gmd:CI_Citation/gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/ gmd:contactInfo/gmd:onlineResource/gmd:CI_OnlineResource/gmd:description/gco:CharacterString="URLContentType:"String

Maps to the UMM element "RelatedUrls/URLContentType"

The value must start with the string "URLContentType: " in order for CMR to properly identify the URL Content Type.

The URL Content Type is required in UMM and is used to specify how the link will display in the Earthdata Search Client. The URL Content Type must be selected from the following controlled vocabulary options: CollectionURL, PublicationURL, DataCenterURL, DistributionURL, DataContactURL, VisualizationURL. Please see the best practices section (above) on guidance on choosing the correct URL Content Type.

RelatedUrls/Type

gmd:DS_Series/gmd:seriesMetadata/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/ gmd:aggregationInfo/gmd:MD_AggregateInformation/gmd:aggregateDataSetName/ gmd:CI_Citation/gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/ gmd:contactInfo/gmd:onlineResource/gmd:CI_OnlineResource/gmd:description/gco:CharacterString="Type:"

String

Maps to the UMM element "RelatedUrls/Type."

The value must start with the string "Type: " in order for CMR to properly identify the URL Type.

Providing a URL Type is required in UMM. Failing to specify a Type in ISO metadata will result in the field being auto-populated by the CMR, which could result in the URL being mislabeled. URL Type is a GCMD controlled vocabulary field and must be selected from keywords in the KMS. Please see the best practices section (above) on guidance on choosing the correct URL Type.

RelatedUrls/Subtype

gmd:DS_Series/gmd:seriesMetadata/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/ gmd:aggregationInfo/gmd:MD_AggregateInformation/gmd:aggregateDataSetName/ gmd:CI_Citation/gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/ gmd:contactInfo/gmd:onlineResource/gmd:CI_OnlineResource/gmd:description/gco:CharacterString="Subtype:
String

Maps to the UMM element "RelatedUrls/Subtype"

The value must start with the string "Subtype: " in order for CMR to properly identify the URL Subtype.

Providing a URL Subtype is optional, but is encouraged if an appropriate URL Subtype exists. URL Subtype is a GCMD controlled vocabulary field and must be selected from keywords in the KMS. Please see the best practices section (above) on guidance on choosing the correct URL Subtype.


Example Mapping

Section
Column
width50%

ISO 19115-2 SMAP

No Format
<gmd:DS_Series>
<gmd:seriesMetadata>
<gmi:MI_Metadata>
...
  <gmd:identificationInfo>
  <gmd:MD_DataIdentification>
   <gmd:citation gco:nilReason="missing"/>
   <gmd:abstract gco:nilReason="missing"/>
    <gmd:aggregationInfo>
    <gmd:MD_AggregateInformation>
      <gmd:aggregateDataSetName>
        <gmd:CI_Citation>
        <gmd:title gco:nilReason="missing"/>
        <gmd:date gco:nilReason="missing"/>
          <gmd:citedResponsibleParty>
          <gmd:CI_ResponsibleParty>
            <gmd:contactInfo>
            <gmd:CI_Contact>
              <gmd:onlineResource>
              <gmd:CI_OnlineResource>
                <gmd:linkage>
                  <gmd:URL>https://doi.org/10.3334/ORNLDAAC/1568</gmd:URL>
                </gmd:linkage>
                <gmd:description>
                  <gco:CharacterString>Description: Access the data set landing page for the collection. URLContentType: CollectionURL URLType: DATA SET LANDING PAGE</gco:CharacterString>
                </gmd:description>
              </gmd:CI_OnlineResource>
              </gmd:onlineResource>
            </gmd:CI_Contact>
            </gmd:contactInfo>
           <gmd:role gco:nilReason="missing"/>
          </gmd:CI_ResponsibleParty>
          </gmd:citedResponsibleParty>
          <gmd:citedResponsibleParty>
          <gmd:CI_ResponsibleParty>
            <gmd:contactInfo>
             <gmd:CI_Contact>
              <gmd:onlineResource>
              <gmd:CI_OnlineResource>
                <gmd:linkage>
                  <gmd:URL>https://daac.ornl.gov/ACTAMERICA/guides/ACTAMERICA-PICARRO_Ground.html</gmd:URL>
                </gmd:linkage>
                <gmd:description>
                  <gco:CharacterString>Description: The guide document contains detailed information about the data set. URLContentType: PublicationURL URLType: VIEW RELATED INFORMATION URLSubtype: USER'S GUIDE</gco:CharacterString>
                </gmd:description>
              </gmd:CI_OnlineResource>
              </gmd:onlineResource>
             </gmd:CI_Contact>
            </gmd:contactInfo>
           <gmd:role gco:nilReason="missing"/>
          </gmd:CI_ResponsibleParty>
          </gmd:citedResponsibleParty>
        </gmd:CI_Citation>
      </gmd:aggregateDataSetName>
     <gmd:associationType gco:nilReason="missing"/>
    </gmd:MD_AggregateInformation>
    </gmd:aggregationInfo>
  </gmd:MD_DataIdentification>
  </gmd:identificationInfo>
...
</gmi:MI_Metadata> 
</gmd:seriesMetadata>  
</gmd:DS_Series>    
Column
width50%

UMM

No Format
"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"
  }
]



UMM Migration

None

Excerpt
hiddentrue

Future Mappings

Expand
titleISO 19115-1

ISO 19115-1

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

Note: These ISO paths only apply to CollectionURLs and PublicationURLs. Please see the RelatedURLs (GET DATA) wiki page for ISO guidance specific to data access URLs. Please see the RelatedURLs (USE SERVICE API) wiki page for ISO guidance specific to services. Please see the Data Center wiki page for ISO guidance specific to DataCenterURLs. Please see the Data Contact wiki page for ISO guidance specific to DataCenterURLs.

UMM-C ElementPathTypeNotes
RelatedUrls/URL


String

Where the URL is provided.

Maps to the UMM element "RelatedUrls/URL"

Note: This path only applies to CollectionURLs and PublicationURLs.

RelatedUrls/Description


String

Maps to the UMM element "RelatedUrls/Description"

It is highly recommended that a description be provided for each URL.

Provide a brief, unique description of the URL in this field. The value must start with the string "Description: " in order for CMR to properly identify the URL description.

RelatedUrls/URLContentType


String

Maps to the UMM element "RelatedUrls/URLContentType"

The value must start with the string "URLContentType: " in order for CMR to properly identify the URL Content Type.

The URL Content Type is required in UMM and is used to specify how the link will display in the Earthdata Search Client. The URL Content Type must be selected from the following controlled vocabulary options: CollectionURL, PublicationURL, DataCenterURL, DistributionURL, DataContactURL, VisualizationURL. Please see the best practices section (above) on guidance on choosing the correct URL Content Type.

RelatedUrls/Type


String

Maps to the UMM element "RelatedUrls/Type"

The value must start with the string "Type: " in order for CMR to properly identify the URL Type.

Providing a URL Type is required in UMM. Failing to specify a Type in ISO metadata will result in the field being auto-populated by the CMR, which could result in the URL being mislabeled. URL Type is a GCMD controlled vocabulary field and must be selected from keywords in the KMS. Please see the best practices section (above) on guidance on choosing the correct URL Type.

RelatedUrls/Subtype


String

Maps to the UMM element "RelatedUrls/Subtype"

The value must start with the string "Subtype: " in order for CMR to properly identify the URL Subtype.

Providing a URL Subtype is optional, but is encouraged if an appropriate URL Subtype exists. URL Subtype is a GCMD controlled vocabulary field and must be selected from keywords in the KMS. Please see the best practices section (above) on guidance on choosing the correct URL Subtype.


Example Mapping

Section
Column
width50%

ISO 19115-1

No Format
Column
width50%

UMM

No Format
"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"
  }
]

History

UMM Versioning

VersionDateWhat Changed
1.6.4 (g)2021-09-17Removed Format Enums in favor of using KMS. Granule (UMM-G) only.
1.13.02020-07-29No changes were made for RelatedURL during the transition from version 1.12.0 to 1.13.0.
1.12.02019-01/-22/2019During the transition from version 1.11.0 to 1.12.0, 4 new Related URL keywords were added.
1.11.02018-11/-28/2018During the transition from version 1.10.0 to 1.11.0, the enumerations for sub elements 'Type' and 'Subtype' were changed to match the GCMD version of the keywords that was released on March 15, 2018.
1.10.02018-05/-02/2018During the transition from version 1.9.0 to 1.10.0, the following sub elements were added: 'Mime Type' (Get Data) and 'Format' (Get Service).

ARC Documentation

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