Element Description
The Related URLs element provides access to resources related to a granule (i.e. an individual data file within a collection/data set). 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.
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 in granule metadata, 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.)
The following sub-elements are included for RelatedUrls at the granule level:
URL: Where the link is provided.
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 Providing a URL Type is required.
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 Please see the diagram below for details on the relationship between URL Type and URL Subtype keywords. Providing a URL Subtype is optional, but highly recommended if one applies.
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.
Format: The format of the resource. Providing a format is optional, but it is recommended for URLs that link to data. The format must be selected from the GCMD Granule Data Format Keywords list.
MimeType: The mime type of the resource. Providing a mime type is optional. Mime type values are currently controlled by an enumeration list in the UMM-G schema.
Size: For URLs that prompt a download of a file to a user's local desktop, this element in combination with the 'Unit' element can be used to specify the size of the resulting download. The 'Size' field should be a numerical value only.
Unit: For URLs that prompt a download of a file to a user's local desktop, this element in combination with the 'Size' element can be used to specify the size of the resulting download. The unit must be selected from an enumeration list of file size units that include the following options: KB, MB, GB, TB, PB, NA. NA stands for "Not Applicable."
Please see the below diagram for the relationship between URL Type, and Subtype keywords:
Examples:
Type: GET DATA
Subtype: DIRECT DOWNLOAD
Description: Download the granule data file directly to your desktop. Requires Earthdata login.
Format: netCDF-3
MimeType: application/x-netcdf
Size: 304
SizeUnit: KB
URL Type: USE SERVICE API
URL Subtype: OPENDAP DATA
Description: Access the granule data file via OPeNDAP.
Element Specification
Related URLs is an optional metadata element at the granule level (Cardinality: 0..*).
Model | Element | Type | Usable Valid Values | Constraints | Required? | Cardinality | Notes |
---|---|---|---|---|---|---|---|
UMM-G | RelatedUrls/URL | String | n/a | 1 - 1024 characters | Yes | 1 | |
UMM-G | RelatedUrls/Type | String | GCMD URL Content Type 'Type' Keywords | KMS controlled | Yes | 1 | |
UMM-G | RelatedUrls/Subtype | String | GCMD URL Content Type 'Subtype' Keywords | KMS controlled | No | 0..1 | The Type and Subtype are part of a keyword hierarchy specified in the KMS. |
UMM-G | RelatedUrls/Description | String | n/a | 1 - 4000 characters | No | 0..1 | It is strongly recommended that a description be provided for each URL. |
UMM-G | RelatedUrls/Format | String | GCMD Granule Data Format Keywords | KMS controlled 1 - 80 characters | No | 0..1 | |
UMM-G | RelatedUrls/MimeType | Enumeration | application/json application/xml application/x-netcdf application/x-hdfeos application/gml+xml application/vnd.google-earth.kml+xml image/gif image/tiff image/bmp text/csv text/xml application/pdf application/x-hdf application/x-hdf5 application/octet-stream application/vnd.google-earth.kmz image/jpeg image/png image/vnd.collada+xml text/html text/plain application/zip application/gzip application/tar application/tar+gzip application/tar+zip application/vnd.opendap.dap4.dmrpp+xml Not provided | n/a | No | 0..1 | |
UMM-G | RelatedUrls/Size | number | n/a | n/a | No | 0..1 | The size of the resource. |
UMM-G | RelatedUrls/SizeUnit | Enumeration | KB MB GB TB PB NA | n/a | No | 0..1 | The unit of the resource size. |
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.
Dialect Mappings
UMM Migration
None
History
UMM Versioning
Version | Date | What Changed |
---|---|---|
1.6.4 | 2021-10-06 | Removed Format Enums in favor of using KMS. Granule (UMM-G) only. |
1.6.3 | 2021-05-03 | Added new Related URL subtypes for use with Extended Metadata. |
1.6.2 | 2021-04-21 | Added GET DATA VIA DIRECT ACCESS to the RelatedUrlTypeEnums. |
1.6.1 | 2020-06-05 | Added application/vnd.opendap.dap4.dmrpp+xml to the RelatedUrl Mime-Types and added dmrpp to the formats. |
1.6 | 2019-11-04 | No updates were made to RelatedUrls in the transition from v1.5 to v1.6. |
1.5 | 2019-01-30 | No updates were made to RelatedUrls in the transition from v1.4 to v1.5. |
1.4 | 2018-08-01 | Initial creation of UMM-G schema, prior versions only existed as deliverables on paper but were not implemented. |
ARC Documentation
Version | Date | What Changed | Author |
---|---|---|---|
1.0 | 2022-03-29 | Recommendations/priority matrix transferred from internal ARC documentation to wiki space | Jeanne' le Roux |