You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 6
Next »
Links to information related to the data.
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, the Related URLs section of the metadata should point to:
- A data access location
- A landing page for the associated data set
- Any relevant services provided for the data (if applicable)
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 willl be displayed in the EarthData Search Client.
URL Type: The URL Type is a keyword which specifies the content of a link. The 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 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?
Please see the below diagram for the full relationship between URL Content Type, Type, and Subtype keywords:
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 where the link will take them. Descriptions should be unique to the link. While descriptions can be repeated for the same type of link 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.
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. <link>
Examples:
<>
An unlimited amount of Related URLs may be listed (Cardinality: 1..*)
Only provide element specification tables on specific URL pages? E.g. Get data URLs wiki page?
Model | Element | Type | Usable Valid Values | Constraints | Required? | Cardinality | Notes |
---|
UMM-Common | RelatedUrls/URL | String | n/a | | Yes | 1 |
|
UMM-Common | RelatedUrls/Description | String | n/a | 1 - 4000 characters | No | 0..1 | It is strongly recommended that a description be provided for each URL. |
UMM-Common | RelatedUrls/URLContentType | Enumeration | CollectionURL PublicationURL DataCenterURL DistributionURL DataContactURL VisualizationURL | n/a | Yes | 1 | 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-Common | RelatedUrls/Type | String | KMS controlled | n/a | Yes | 1 | Each Type keyword corresponds to a specific URL Content Type category. |
UMM-Common | RelatedUrls/Subtype | String | KMS controlled | n/a | No | 0..1 | The Type and Subtype are part of a keyword hierarchy specified in the KMS. |
UMM-Common | RelatedUrls/GetData/Format | String | KMS controlled | n/a | Yes, if applicable | 1 | Only applies to DistributionURLs with the URL Type of "GET DATA". Please see the "???" wiki page for full details and examples. |
UMM-Common | RelatedUrls/GetData/MimeType | String | KMS controlled | n/a | No | 0..1 | Only applies to DistributionURLs with the URL Type of "GET DATA". Please see the "???" wiki page for full details and examples. |
UMM-Common | RelatedUrls/GetData/Size | Number | n/a | n/a | Yes, if applicable | 1 | Only applies to DistributionURLs with the URL Type of "GET DATA". Please see the "???" wiki page for full details and examples. |
UMM-Common | RelatedUrls/GetData/Unit | Enumeration | KB MB GB TB PB | n/a | Yes, if applicable | 1 | Unit is required if information is provided in the 'Size' element. Only applies to DistributionURLs with the URL Type of "GET DATA". Please see the "???" wiki page for full details and examples. |
UMM-Common | RelatedUrls/GetData/Fees | String | n/a | 1 - 80 characters | No | 0..1 | The fee (if any) for ordering the data. The fee should be a number in U.S. dollars. Only applies to DistributionURLs with the URL Type of "GET DATA". Please see the "???" wiki page for full details and examples. |
UMM-Common | RelatedUrls/GetData/Checksum | String | n/a | 1 - 50 characters | No | 0..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. Only applies to DistributionURLs with the URL Type of "GET DATA". Please see the "???" wiki page for full details and examples. |
UMM-Common | RelatedUrls/GetService/Format | String | KMS controlled | n/a | No | 0..1 | Only applies to DistributionURLs with the URL Type of "USE SERVICE API". Please see the "???" wiki page for full details and examples. |
UMM-Common | RelatedUrls/GetService/MimeType | String | KMS controlled | n/a | Yes, if applicable | 1 | Only applies to DistributionURLs with the URL Type of "USE SERVICE API". Please see the "???" wiki page for full details and examples. |
UMM-Common | RelatedUrls/GetService/Protocol | Enumeration | HTTP HTTPS FTP FTPS Not Provided | n/a | Yes, if applicable | 1 | It is recommended that use of FTP and FTPS be phased out if possible. Only applies to DistributionURLs with the URL Type of "USE SERVICE API". Please see the "???" wiki page for full details and examples. |
UMM-Common | RelatedUrls/GetService/FullName | String | n/a | 1 - 80 characters | Yes, if applicable | 1 | Are we keeping the full name field? Only applies to DistributionURLs with the URL Type of "USE SERVICE API". Please see the "???" wiki page for full details and examples. |
UMM-Common | RelatedUrls/GetService/DataID | String | n/a | 1 - 80 characters | Yes, if applicable | 1 | Are we keeping the data ID field? "The data identifier of the data provided by the service." Typically, this is a file name. ← Providing a file name would only make sense for direct download Only applies to DistributionURLs with the URL Type of "USE SERVICE API". Please see the "???" wiki page for full details and examples. |
UMM-Common | RelatedUrls/GetService/DataType | String | n/a | 1 - 80 characters | Yes, if applicable | 1 | Only applies to DistributionURLs with the URL Type of "USE SERVICE API". Please see the "???" wiki page for full details and examples. |
UMM-Common | RelatedUrls/GetService/URI | Array Composed of at least 1 String | n/a | 1 - 1024 characters (per string) | No | 0..* | Only applies to DistributionURLs with the URL Type of "USE SERVICE API". Please see the "???" wiki page for full details and examples. |
Will create separate wiki page for get data and get service links. DataCenterURLs and DataContactURLs details will be worked into the data center and data contact wiki pages.
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 Metadata QA/QC
ARC Priority Matrix
Priority Categorization | Justification |
---|
| This element is categorized as highest priority when: - The element is not included at all.
|
| This element is categorized as medium priority when: |
| This element is categorized as low priority when: |
| The element is provided, and follows all applicable criteria specified in the best practices section above. |
ARC Automated Rules
<insert>
DIF 9
DIF 9 (Note: DIF-9 is being phased out and will no longer be supported after 2018)
DIF 10
DIF 10
Specification | Path | Type | Constraints | Required in DIF 10? | Cardinality | Notes |
---|
DIF 10 | /DIF/Related_URL/URL | URI |
| No | 0..* | The link is provided here. |
DIF 10 | /DIF/Related_URL/URL_Content_Type/Type | String | KMS controlled | No | 0..1 |
|
DIF 10 | /DIF/Related_URL/URL_Content_Type/Subtype
| String | KMS controlled
| No | 0..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/Description | String |
| No | 0..1 | It is strongly recommended that a description be provided for each URL. |
DIF 10 | /DIF/Related_URL/Mime_Type | String | KMS controlled | No | 0..1 |
|
DIF 10 | /DIF/Related_URL/Protocol | String |
| No | 0..1 |
|
DIF 10 | /DIF/Related_URL/Title | String |
| No | 0..1 |
|
DIF 10 | /DIF/Related_URL/Application_Profile | String |
| No | 0..1 |
|
DIF 10 | /DIF/Related_URL/Function | String |
| No | 0..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>
ECHO 10
ECHO 10
Specification | Path | Type | Constraints | Required in ECHO10? | Cardinality | Notes |
---|
ECHO 10 | /Collection/DOI/DOI | String | 1 - 1024 characters | No | 0..1 | n/a |
ECHO 10 | /Collection/DOI/Authority | String | 1 - 80 characters | No | 0..1 | For ESDIS providers, recommend providing "https://doi.org/" as the DOI authority. |
Enumeration Mapping
ECHO 10 | Translation Direction | UMM |
---|
Not Applicable | ↔ | Not Applicable |
Example Mapping
ISO 19115-2 MENDS
ISO 19115-2 MENDS
Specification | Path | Type | Notes |
---|
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.doi | String | The 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 DOI | String | The 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 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:citedResponsibleParty/gmd:CI_ResponsibleParty/gmd:organisationName/gco:CharacterString | String | Provide 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="" = authority | Codelist | Choose 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 SMAP
ISO 19115-2 SMAP
Specification | Path | Type | Notes |
---|
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.doi | String | The 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 DOI | String | The 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 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:citedResponsibleParty/gmd:CI_ResponsibleParty/gmd:organisationName/gco:CharacterString | String | Provide 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="" = authority | Codelist | Choose 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-1
ISO 19115-1
Specification | Path | Type | Notes |
---|
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 | String | Where 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 | String | The 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 | String | Leave 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 | String | Provide 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 | String | Provide 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 | Codelist | Choose 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 |
History
Version | Date | What Changed |
---|
1.10.0 | 5/2/2018 | <> |
1 |
|
|
Version | Date | What Changed | Author |
---|
1.0 | 6/13/18 | Recommendations/priority matrix transferred from internal ARC documentation to wiki space | Jeanne' le Roux |