- Created by Tyler Stevens, last modified on Dec 08, 2022
Element Description
Any service resource-related URLs that include a project home page, resource information pages, how-to documentation, example code snippets, thumbnail image, or other relevant information about the service.
- RelatedURLs types are keywords that describe the distinct content type of the online resource.
- A Description should explain what the web page is at the RelatedURL.
- The Format describes the organization of the service/data content so that users and applications know how to read and use the content.
The MimeType is the multi-purpose internet mail extensions indicates the nature and format of the service/data that is accessed through the URL.
Best Practices
The Related URLs 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 information related to the service including:
- A landing page for the service
- A user's guide and/or comparable documentation which provides important information about how to use the service
- The project home page of the service
- Relevant documentation
- Read-Me files
- Service citation policies
- Visualizations generated from the service
- OpenSearch Description Document (OSDD) links
- Any other documentation directly related to the service (examples include: data recipes, micro articles, service quality assessment documentation, important announcements, etc.)
The following URLContentTypes are relevant for Service RelatedURLs:
- Collection URL: These types of URLs provide links to collections related to the service, service landing pages, and project home pages. See KMS for more information.
- Publication URL: These types of URLs provide links to relevant documentation, publications related to the service, data recipes for the service, and user guides. See KMS for more information.
- Visualization URL: These types of URLs provide links to visualizations related to the service. See KMS for more information.
Examples:
RelatedURLs/URL: https://sedac.ciesin.columbia.edu/data/set/gpw-v4-population-density-rev11?_ga=2.86809936.995738450.1668986365-100546444.1668387933
RelatedURLs/Description: Access the Gridded Population of the World, Version 4 (GPWv4): Population Density, Revision 11 2000 Map Layer
RelatedURLs/URLContentType: CollectionURL
RelatedURLs/Type: DATA SET LANDING PAGE
RelatedURLs/URL: https://nsidc.org/data/user-resources/help-center/nasa-earthdata-cloud-data-access-guide
RelatedURLs/Description: NASA Earthdata Cloud Data Access Guide
RelatedURLs/URLContentType: PublicationURL
RelatedURLs/Type: VIEW RELATED INFORMATION
Element Specification
Model | Element | Type | Constraints | Required | Cardinality | Notes |
---|---|---|---|---|---|---|
UMM-S | RelatedURLs/URL | String | 1-1024 characters | Yes | 1 | |
UMM-S | RelatedURLs/Description | String | 1-4000 characters | No | 0..1 | |
UMM-S | RelatedURLs/URLContentType | String | 1-80 characters | Yes | 1 | Valid values should come from KMS. |
UMM-S | RelatedURLs/Type | String | 1-80 characters | Yes | 1 | Valid values should come from KMS. |
UMM-S | RelatedURLs/Subtype | String | 1-80 characters | Yes | 1 | Valid values should come from KMS. |
UMM-S | RelatedURLs/Format | String | 1-80 characters | No | 0..1 | Valid values should come from KMS. |
UMM-S | RelatedURLs/MimeType | String | 1-80 characters | No | 0..1 | Valid values should come from KMS. |
Metadata Validation
All records undergo CMR schema and business rule validation before entering the system.
- The 'URL' element is required.
- Must contain at least 1 character and be no longer than 1024 characters in length.
- The 'Description' element must contain at least 1 character and be no longer than 4000 characters in length.
- The 'URLContentType' element is required.
- Must contain at least 1 character and be no longer than 80 characters in length.
- The 'URLContentType' element must be a subset of the list and only be
- Collection URL
- Publication URL
- Visualization URL
- The 'Type' element is required.
- Must contain at least 1 character and be no longer than 80 characters in length.
- The 'Subtype' element is required.
- Must contain at least 1 character and be no longer than 80 characters in length.
- The 'Format' element must contain at least 1 character and be no longer than 4000 characters in length.
- The 'MimeType' element must contain at least 1 character and be no longer than 80 characters in length.
History
UMM Versioning
Version | Date | What Changed |
---|---|---|
1.5.0 | 2022-04-22 | First version published on wiki |
- No labels