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 option 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 are:
DOI/CollectionDOI/DOI: The DOI (Digital Object Identifier) that identifies the collection.
DOI/CollectionDOI/Authority: The The DOI organization that is responsible for creating the DOI
or.
DOI/CollectionDOI/MissingReason: This element stores the fact that a DOI is not applicable for a record.
DOI/CollectionDOI/Explanation: This element describes the reason the DOI is not applicable.
For CollectionDOI/DOI and CollectionDOI/Authority
CollectionDOI/DOI:
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 DOIWhen providing information in the CollectionDOI/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 CollectionDOIDOI/MissingReason and CollectionDOIDOI/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: EOSDIS 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".
CollectionDOIDOI/Authority:
- For ESDIS providers specifically:
- The CollectionDOIDOI/Authority element value should be "https://doi.org/"
- For ESDIS providers specifically:
DOI/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.CollectionDOI/DOI: "10.5067/ISS/CATS/L2O_N-M7.1-V2-01_05KMPRO",
DOI/CollectionDOI/Authority: "https://doi.org/",
DOI/PreviousVersion: {
CollectionDOI/DOI: "10.5067/MEASURESISS/GWELD/GWELDYR.003"
DOI/CollectionDOI/Authority: "https://doi.org/"
For CollectionDOI/MissingReason and CollectionDOI/Explanation
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
DOICollectionDOI/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.
CollectionDOIDOI/Explanation:
- This element should be used to describe why a dataset was not assigned a DOI.
Examples:
CollectionDOIDOI/MissingReason: "Not Applicable"
CollectionDOIDOI/Explanation: "The collection is near real time and only exists for a couple of days, therefore, the collection was not assigned a DOI."
CollectionDOIDOI/MissingReason: "Not Applicable"
CollectionDOIDOI/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. The DOI and Authority should be treated the same as for the CollectionDOI mentioned above.
Element 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 |
or
UMM-C | DOI/PreviousVersion | Object | n/a | No | 0..1 |
UMM-C | DOI/ |
PreviousVersion/ |
DOI |
n/a
String | 1024 maximum characters | Yes, if applicable |
1 | |
UMM-C | DOI/ |
PreviousVersion/ |
Version | String |
80 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).
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 | Type | Usable Valid Values | Constraints | Required? | Cardinality |
---|---|---|---|---|---|---|
UMM-C | DOI/MissingReason | Enumeration | Not Applicable | n/a | Yes, if applicable | 1 |
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 | |||
---|---|---|---|
| |||
|
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 9 (Note: DIF-9 is being phased out and will no longer be supported after 2018) |
ARC Automated Checks ARC uses the pyQuARC library for automated metadata checks. Please see the pyQuARC GitHub for more information. |
Dialect Mappings
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DIF 10Only 1 Persistent Identifier may be provided (Cardinality: 1) Choice of:
or
|
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:
or
UMM-C Element | ISO 19115-2 MENDS Path Type | Notes |
Code This indicates that the DOI is "Not Applicable"
String | The value of "gov.nasa.esdis.umm.doi" should be provided here so that CMR can properly parse out the DOI information. | /gmi
String | The value must contain the string "DOI" so that CMR can properly identify and translate the DOI information. | DOI/Explanation | /
| If the dataset does not have a DOI, it is highly recommended to provide an explanation why here. The value must contain the string "Explanation:" String
Enumeration/Code List Mapping | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ISO MENDS | Translation Direction | UMM | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
inapplicable | ↔ | Not Applicable |
identify the DOI/PreviousVersion element. This codelist value does not directly map to a UMM element - choosing 'doiPreviouVersion' indicates to CMR that the DOI Previous Version element should be mapped. | |||
DOI/PreviousVersion/Description | /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:aggregationInfo/gmd:MD_AggregateInformation/ gmd:aggregateDataSetIdentifier/gmd:MD_Identifier/gmd:authority/gmd:CI_Citation/gmd:otherCitationDetails/gco:CharacterString | String | Provide the Previous Version Description |
DOI/PreviousVersion/DOI | /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:aggregationInfo/gmd:MD_AggregateInformation/ gmd:aggregateDataSetIdentifier/gmd:MD_Identifier/gmd:code/gco:CharacterString = <Previous Version DOI> | String | Provide the DOI. |
/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:aggregationInfo/gmd:MD_AggregateInformation/ | String | The value of "gov.nasa.esdis.umm.doi.previousversion" should be provided here so that CMR can properly parse out the DOI Previous Version. | |
/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:aggregationInfo/gmd:MD_AggregateInformation/ | String | The value must contain the string "DOI Previous Version" so that CMR can properly identify and translate the DOI Previous Version. | |
DOI/PreviousVersion/Published | /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:aggregationInfo/gmd:MD_AggregateInformation/ gmd:aggregateDataSetIdentifier/gmd:MD_Identifier/gmd:authority/gmd:CI_Citation/gmd:editionDate/gco:DateTime | Date | Format 4 digit year followed by - followed by 2 digit month followed by - followed by 2 digit day - followed by T - followed by 2 digit hour, 2 digit minutes, 2 digit seconds. For example: 2024-02-29T01:00:00 |
or
UMM-C Element | ISO 19115-2 MENDS Path | Type | Notes |
---|---|---|---|
DOI/MissingReason | /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/ gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:code nilReason="inapplicable" | Code | This indicates that the DOI is "Not Applicable". |
/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 information. | |
/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 information. | |
DOI/Explanation | /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/ gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:description/gco:CharacterString contains Explanation: | String | If the dataset does not have a DOI, it is highly recommended to provide an explanation why here. The value must contain the string "Explanation:" so that CMR can properly parse out the text. |
Enumeration/Code List Mapping
ISO MENDS | Translation Direction | UMM |
---|---|---|
inapplicable | ↔ | Not Applicable |
Example Mapping
Section | |||||||
---|---|---|---|---|---|---|---|
|
Example Mapping
Section | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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 | 12/3/20202020-12-03 | No changes were made for DOI during the transition from version 1.15.4 to 1.15.5 | ||
1.15.4 | 9/18/20202020-09-18 | No changes were made for DOI during the transition from version 1.15.3 to 1.15.4 | ||
1.15.37 | /1/20202020-07-01 | No changes were made for DOI during the transition from version 1.15.2 to 1.15.3 | ||
1.15.2 | 5/20/20202020-05-20 | No changes were made for DOI during the transition from version 1.15.1 to 1.15.2 | ||
1.15.1 | 3/25/20202020-03-25 | No changes were made for DOI during the transition from version 1.15.0 to 1.15.1 | ||
1.15.0 | 2/26/20202020-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/2019 | No changes were made for DOI during the transition from version 1.13.0 to 1.14.0 | ||
1.13.0 | 2019-04/-11/2019 | No changes were made for DOI during the transition from version 1.12.0 to 1.13.0 | ||
1.12.0 | 2019-01 | /-22 | /2019No changes were made for DOI during the transition from version 1.11.0 to 1.12.0. | |
1.11.0 | 2018-11 | /-28 | /2018No changes were made for DOI during the transition from version 1.10.0 to 1.11.0. | |
1.10.0 | 2018-05 | /-02 | /2018During 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. |
ARC Documentation
Version | Date | What Changed | Author |
---|---|---|---|
2.0 | 2021-06-18 | ARC Priority Matrix updated to include DOI/Missing Reason option. | |
1.0 | 2018-04/-30/18 | Recommendations/priority matrix transferred from internal ARC documentation to wiki space |