Page History
Table of Contents | ||
---|---|---|
|
Element Description
This element stores the DOI (Digital Object Identifier) that identifies the data collection. A DOI is a persistent identifier that is used to uniquely identify objects including datasets and documents.
This element also includes the options to provide information on the authority that registers the DOI, as well as the DOI of the previous version of the record.
Best Practices
For the DOI concept, there are two options for providing information. These options areChoice of:
DOI/DOI: The DOI element stores the DOI (Digital Object Identifier) that identifies the collection.
DOI/Authority: The The DOI organization that is responsible for creating the DOI is described in the Authority element.or
DOI/MissingReason: This element stores the fact that a DOI is not applicable for a record.
DOI/Explanation: This element describes the reason the DOI is not applicable.
Best Practices
Just the DOI string should be provided in the DOI/DOI field. The DOI URL should not be stored here; it should be stored as a RelatedURL. The DOI value should start with the directory indicator.
For ESDIS providers:
- The directory indicator for ESDIS is "10"
- If the DOI was registered through ESDIS, the beginning of the DOI string should be "10.5067"
- The DOI/Authority element value should be "https://doi.org/"
- DOI is a required metadata element for ESDIS providers. While the majority of ESDIS datasets will have a DOI, there are certain cases where having a DOI is not appropriate. These cases include near real time datasets and datasets that will soon be replaced by a new version. In the case that a DOI is not applicable for a dataset, the DOI/MissingReason element should be used to indicate this; and the DOI/Explanation element should be used to describe why the dataset was not assigned a DOI.
- A list of DOIs registered through ESDIS can be found here: EOSDIS DOIs Status and Listing
Examples:
DOI/DOI: "10.5067/ISS/CATS/L2O_N-M7.1-V2-01_05KMPRO"
DOI/Authority: "https://doi.org/"
DOI/DOI: "10.5067/MEASURES/GWELD/GWELDYR.003"
PreviousVersion: The previous version of this record's DOI, if applicable. Its sub elements are:
- DOI/PreviousVersion/DOI: The previous version of this record's DOI. - If the PreviousVersion element is used, then the DOI must be provided.
- DOI/PreviousVersion/Version: The version number if one exists.
- DOI/PreviousVersion/Description: A short description of what the DOI represents
- DOI/PreviousVersion/Published: The date or date and time the previous version was published.
or
DOI/MissingReason: This element stores the fact that a DOI is not applicable for a record.
DOI/Explanation: This element describes the reason the DOI is not applicable.
For DOI/DOI and DOI/Authority
DOI/DOI:
- When providing information in the DOI/DOI field, only the DOI string should be provided. The string value should begin with the directory indicator.
- The DOI URL should not be stored in the DOI element but should instead be provided as a RelatedURL.
- For ESDIS providers specifically:
- DOI is a required metadata element for ESDIS providers. While the majority of ESDIS datasets will have a DOI, there are certain cases where having a DOI is not appropriate. These cases include near real time datasets and datasets that will soon be replaced by a new version. Please see the DOI/MissingReason and DOI/Explanation section for more information.
- More details on the ESDIS DOI process can be found here: ESDIS DOI Process
- A list of DOIs registered through ESDIS can be found here: ESDIS DOIs Status and Listing
- The directory indicator for ESDIS is "10." Therefore, if the DOI was registered through ESDIS, the beginning of the DOI string should be "10.5067".
DOI/Authority:
- For ESDIS providers specifically:
- The DOI/Authority element value should be
- For ESDIS providers specifically:
- "https://doi.org/"
or
DOI/
MissingReason: "Not Applicable"DOI/Explanation: "The collection is near real time and only exists for a couple of days, therefore, the collection was not assigned a DOI."
DOI/MissingReason: "Not Applicable"
DOI/Explanation: "A new version of this dataset will be released in a month (May 2018). This version will be removed from CMR and the new version will be assigned a DOI."
Element Specification
Choice of:
? maximum number of characters
or
N/A
ARC Priority Matrix
This element is categorized as highest priority when:
- The element is not included at all.
- The element is included but is empty.
- The dataset has a DOI but the metadata indicates that it does not.
- The incorrect DOI is listed for the dataset.
- The DOI listed leads to a broken link.
- The DOI is provided in the incorrect format (e.g. as a URL rather than just the DOI string).
- The DOI/Explanation includes spelling or grammatical errors.
This element is categorized as medium priority when:
- The DOI/MissingReason option is used but no DOI/Explanation is provided.
This element is categorized as low priority when:
- A DOI is provided but the DOI/Authority element is not provided.
Dialect Mappings
Expand | ||
---|---|---|
| ||
DIF 9 (Note: DIF-9 is being phased out and will no longer be supported after 2018) |
PreviousVersion/DOI:
- When providing information in the DOI/DOI field, only the DOI string should be provided. The string value should begin with the directory indicator.
- The DOI URL should not be stored in the DOI element but should instead be provided as a RelatedURL.
Examples:
DOI/DOI: "10.5067/ISS/CATS/L2O_N-M7.1-V2-01_05KMPRO",
DOI/Authority: "https://doi.org/",
DOI/PreviousVersion: {
DOI: 10.5067/ISS/CATS/L2O_N-M7.1-V1-01_05KMPRO,
Version: "1-01",
Description: "Cloud-Aerosol Transport System (CATS) International Space Station (ISS) Level 2 Operational Day Mode 7.1 Version 1-01 5 km Profile data product.",
Published: 2015-01-01T08:00:00}
DOI/DOI: "10.5067/MEASURES/GWELD/GWELDYR.003"
DOI/Authority: "https://doi.org/"
For DOI/MissingReason and DOI/Explanation
DOI/MissingReason:
- This element should only be used for specific cases where assigning a DOI to a dataset is not appropriate. These cases include near real time datasets, provisional datasets, and datasets that will soon be replaced by a new version.
- This element is controlled by the enumeration value "Not Applicable." For translation purposes, a value of "Unknown" is provided for data sets that do not have a DOI or a MissingReason set.
DOI/Explanation:
- This element should be used to describe why a dataset was not assigned a DOI.
Examples:
DOI/MissingReason: "Not Applicable"
DOI/Explanation: "The collection is near real time and only exists for a couple of days, therefore, the collection was not assigned a DOI."
DOI/MissingReason: "Not Applicable"
DOI/Explanation: "A new version of this dataset will be released in a month (May 2018). This version will be removed from CMR, and the new version will be assigned a DOI."
AssociatedDOIs also exist so that data providers can add DOIs from either parent or other associated collections. This allows users to cite a group of data products.
Element Specification
Choice of:
Model | Element | Type | Constraints | Required? | Cardinality |
---|---|---|---|---|---|
UMM-C | DOI/DOI | String | 1024 maximum characters | Yes, if applicable | 1 |
UMM-C | DOI/Authority | String | 80 maximum characters | No | 0..1 |
UMM-C | DOI/PreviousVersion | Object | n/a | No | 0..1 |
UMM-C | DOI/PreviousVersion/DOI | String | 1024 maximum characters | Yes, if applicable | 1 |
UMM-C | DOI/PreviousVersion/Version | String | 80 maximum characters | No | 0..1 |
UMM-C | DOI/PreviousVersion/Description | String | 2048 maximum characters | No | 0..1 |
UMM-C | DOI/PreviousVersion/Published | Date Time | n/a | No | 0..1 |
or
Model | Element |
---|
title | DIF 10 |
---|
DIF 10
/DIF/Dataset_Citation/Persistent_Identifier/Type
Enumeration
DOI
ARK
Yes
Only DOI will map to CMR. ARK will not map. This element does not directly map to a UMM element - choosing 'DOI' indicates to CMR that the Identifier and Authority elements should be mapped.
1 minimum number of characters
80 maximum number of characters
1 minimum number of characters
80 maximum number of characters
or
Type | Usable Valid Values | Constraints | Required |
---|
? | Cardinality |
---|
/DIF/Dataset_Citation/Persistent_Identifier/MissingReason
Enumeration
UMM-C | DOI/MissingReason | Enumeration | Not Applicable | n/a | Yes, if applicable | 1 |
Use this option if a dataset does not have a persistent identifier.
UMM-C | DOI/ |
Explanation | String | n/a |
1024 maximum characters | No | 0..1 |
Note: only 1 DOI or DOI/MissingReason may be provided (Cardinality: 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-viewer false autofit true name Copy of Wiki Page Metadata Evaluation Workflow-1939-51df84 width 1102 pages-to-display id 98e5dc28-3252-4209-953f-66f1378e1cf4 align Left height 299
Please see the expandable sections below for flowchart details.
Expand | ||
---|---|---|
| ||
|
Expand | ||
---|---|---|
| ||
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
ARC Automated Checks ARC uses the pyQuARC library for automated metadata checks. Please see the pyQuARC GitHub for more information. |
Dialect Mappings
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DIF 10Only 1 Persistent Identifier may be provided (Cardinality: 1) Choice of:
or
| While not required, it is highly recommended to provide an explanation for why a persistent identifier is not applicable for a dataset. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DIF 10 | Translation Direction | UMM | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Not Applicable | ↔ | Not Applicable |
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
title | ECHO 10 |
---|
ECHO 10
1 minimum number of characters
1024 maximum number of characters
1 minimum number of characters
80 maximum number of characters
or
n/a
?
Enumeration Mapping
Translation
Direction
Example Mapping
Section | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ECHO 10Only 1 DOI may be provided (Cardinality: 1) Choice of:
or
|
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
ISO 19115-2 MENDSOnly 1 DOI will be translated to CMR (Cardinality: 1) Choice of:
| ||||||
Expand | ||||||
| ||||||
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 /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 /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:description/gco:CharacterString contains DOI | Where the DOI string is provided. The value of "gov.nasa.esdis.umm.doi" should be provided here so that CMR can properly parse out the DOI. 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 /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 /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 /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 | String String String Codelist | Leave this element empty. Leave this element empty. Provide the authority here. For ESDIS providers, recommend listing "https://doi.org" as the DOI authority. 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. | |||
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 |
Code
String
String
This indicates that the DOI is "Not Applicable".
The value of "gov.nasa.esdis.umm.doi" should be provided here so that CMR can properly parse out the DOI information.
The valueString | The value must contain the string "DOI" so that CMR can properly identify and translate the DOI |
. |
DOI/Authority | /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/ gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd: |
authority/ |
String
If the dataset does not have a DOI, provide an explanation here. While not required, it is highly recommended to provide an explanation for why a persistent identifier is not applicable for a dataset. The value must contain the string "Explanation:" so that CMR can properly parse out the text.
Enumeration/Code List Mapping
Translation
Direction
Example Mapping
width | 50% |
---|
ISO 19115-2 MENDS
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="" |
Column | ||
---|---|---|
| ||
UMM
|
title | ISO 19115-2 SMAP |
---|
ISO 19115-2 SMAP
Enumeration/Code List Mapping
N/A
Example Mapping
width | 50% |
---|
ISO 19115-2 SMAP
Column | ||
---|---|---|
| ||
UMM
|
UMM Migration
None
or
Enumeration/Code List Mapping
Example Mapping
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ISO 19115-2 SMAPOnly 1 DOI will be translated to CMR (Cardinality: 1) Choice of:
or
|
UMM Migration
None
Future Mappings
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ISO 19115-1Only 1 DOI will be translated to CMR (Cardinality: 1) Choice of:
or
Example Mapping
|
History
UMM Versioning
Version | Date | What Changed |
---|---|---|
1.18.0 | 2024 | PreviousVersion was added for Web Unification |
1.15.5 | 2020-12-03 | No changes were made for DOI during the transition from version 1.15.4 to 1.15.5 |
1.15.4 | 2020-09-18 | No changes were made for DOI during the transition from version 1.15.3 to 1.15.4 |
1.15.3 | 2020-07-01 | No changes were made for DOI during the transition from version 1.15.2 to 1.15.3 |
1.15.2 | 2020-05-20 | No changes were made for DOI during the transition from version 1.15.1 to 1.15.2 |
1.15.1 | 2020-03-25 | No changes were made for DOI during the transition from version 1.15.0 to 1.15.1 |
1.15.0 | 2020-02-26 | No changes were made for DOI during the transition from version 1.14.0 to 1.15.0 |
1.14.0 | 2019-10-21 | No changes were made for DOI during the transition from version 1.13.0 to 1.14.0 |
1.13.0 | 2019-04-11 | No changes were made for DOI during the transition from version 1.12.0 to 1.13.0 |
1.12.0 | 2019-01-22 | No changes were made for DOI during the transition from version 1.11.0 to 1.12.0. |
1.11.0 | 2018-11-28 | No changes were made for DOI during the transition from version 1.10.0 to 1.11.0. |
1.10.0 | 2018-05-02 | During the transition from version 1.9.0 to 1.10.0, the sub elements 'MissingReason' and 'Explanation' were added to inform users why a collection is exempt from having a DOI assigned to it. |
Future Mappings
title | ISO 19115-1 |
---|
/mdb:MD_Metadata/mdb:identificationInfo/mri:MD_DataIdentification/mri:citation/cit:CI_Citation/cit:edition/gco:CharacterString
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
History
UMM Versioning
Version | Date | What Changed |
---|---|---|
1.0.0 | Initial Release
ARC Documentation
Version | Date | What Changed | Author |
---|---|---|---|
12.04 | 2021-06-18 | ARC Priority Matrix updated to include DOI/Missing Reason option. | |
1.0 | 2018-04-30/18/18 | Recommendations/priority matrix transferred from internal ARC documentation to wiki space |