Table of Contents |
---|
Element Description
The Collection Progress element describes the production status of the dataset. The Collection Progress element leverages a controlled vocabulary to ensure consistency across CMR. There are four possible choices for describing the status of the dataset:
- PLANNED refers to data sets to be collected in the future and are thus unavailable at the present time. Examples include:
- The Hydro spacecraft has not been launched, but information on planned data sets may be available.
- ACTIVE refers to data sets currently in production or data that is continuously being collected or updated. Examples include:
- Data from an instrument that continually makes observations such as the AIRS instrument on Aqua or MODIS on Terra.
- Datasets where one version of a dataset is continuously and regularly updated such as CERES EBAF-TOA Ed2.8 (doi: 10.5067/TERRA+AQUA/CERES/EBAF-SURFACE_L3B004.0)
- COMPLETE refers to data sets in which no updates or further data collection will be made. Examples include:
- Data collection from the Lightning Imaging Sensor (LIS) has been completed due to the end of the TRMM mission.
- Completion of a legacy version of a product where no further updates will be made such as with CERES EBAF-TOA Ed2.7.
- NOT APPLICABLE should only be used if this element is not applicable to the collection, such as a calibration collection.
Best Practices
Rule 1
Rule 2
Element Specification
Model | Element | Type | Usable Valid Values | Required? | Cardinality |
---|---|---|---|---|---|
UMM-C | CollectionProgress | Enumeration | PLANNED ACTIVE COMPLETE NOT APPLICABLE | Yes | 1 |
Value needed for translations:
The following value is needed by the CMR to translate older non UMM compliant records to and from the UMM and other supported specifications where non required elements are considered required but no valid is given. This is needed partly because the CMR still allows a non UMM compliant record to be ingested with warnings.
NOT PROVIDED - It is necessary for this value to exist so that the CMR can translate older non UMM compliant records into the latest UMM specification where CollectionProgress is required. This value should not be used by metadata providers.
ARC Recommendation and Priority Matrix
Priority Categorization | Justification |
---|---|
This element is categorized as highest priority when:
| |
The element is provided, a correct valid value is used, and the valid value matches the status of the dataset. |
Dialect Mappings
DIF 9
Specification | Path | Type | Required in DIF9? | Notes |
---|---|---|---|---|
DIF 9 | /DIF/Data_Set_Progress | String | No | DIF 9 Data_Set_progress is a string. |
Enumeration Mapping
DIF 9 | Translation Direction | UMM |
---|---|---|
PLANNED | ↔ | PLANNED |
IN WORK | ↔ | ACTIVE |
COMPLETE | ↔ | COMPLETE |
NOT APPLICABLE | ↔ | NOT APPLICABLE |
Blank or doesn’t exist | → | NOT PROVIDED |
Any other value | → | NOT PROVIDED |
Doesn’t translate | ← | NOT PROVIDED |
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
DIF 10
Specification | Path | Type | Required in DIF 10? | Notes |
---|---|---|---|---|
DIF 10 | /DIF/Dataset_Progress | Enumeration | No | There are three valid values for the DIF 10 enumeration list:
|
Enumeration Mapping
DIF 10 | Translation Direction | UMM |
---|---|---|
PLANNED | ↔ | PLANNED |
IN WORK | ↔ | ACTIVE |
COMPLETE | ↔ | COMPLETE |
Blank or doesn’t exist | → | NOT PROVIDED |
Don’t translate | ← | NOT PROVIDED |
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ECHO 10
Specification | Path | Type | Required in ECHO10? | Notes |
---|---|---|---|---|
ECHO 10 | /Collection/CollectionState | String | No | None |
Enumeration Mapping
ECHO 10 | Translation Direction | UMM |
---|---|---|
PLANNED | <=> | PLANNED |
IN WORK | <=> | ACTIVE |
COMPLETE | <=> | COMPLETE |
completed | => | COMPLETE |
NOT APPLICABLE | <=> | NOT APPLICABLE |
Blank or doesn’t exist | => | NOT PROVIDED |
Any other value | => | NOT PROVIDED |
Don’t translate | <= | NOT PROVIDED |
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ISO 19115-2 MENDS
Specification | Path | Type | Notes |
---|---|---|---|
ISO 19115-2 MENDS | /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:status/gmd:MD_ProgressCode codeList="https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_ProgressCode" codeListValue= | String | ProgressCode has code values of completed, historicalArchive, obsolete, onGoing, planned, required, underDevelopment. gmd:status is not required. Any string can be substituted as well. Since ISO can have multiple status, translate only the first one to UMM. |
ISO MENDS | Translation Direction | UMM |
---|---|---|
planned | <=> | PLANNED |
underDevelopment | => | PLANNED |
onGoing | <=> | ACTIVE |
completed | <=> | COMPLETE |
historicalArchive | => | COMPLETE |
obsolete | => | COMPLETE |
NOT APPLICABLE a string is used instead of the defined codes. The codeList=”” and codeListValue = “” | <=> | NOT APPLICABLE |
Blank or doesn’t exist | => | NOT PROVIDED |
Any other value | => | NOT PROVIDED |
Don’t translate | <= | NOT PROVIDED |
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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:status/gmd:MD_ProgressCode codeList="https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_ProgressCode" codeListValue= | String | ProgressCode has code values of completed, historicalArchive, obsolete, onGoing, planned, required, underDevelopment. gmd:status is not required. Any string can be substituted as well. Since ISO can have multiple status, translate only the first one to UMM. |
ISO SMAP | Translation Direction | UMM |
---|---|---|
planned | <=> | PLANNED |
underDevelopment | => | PLANNED |
onGoing | <=> | ACTIVE |
completed | <=> | COMPLETE |
historicalArchive | => | COMPLETE |
obsolete | => | COMPLETE |
NOT APPLICABLE a string is used instead of the defined codes. The codeList=”” and codeListValue = “” | <=> | NOT APPLICABLE |
Blank or doesn’t exist | => | NOT PROVIDED |
Any other value | => | NOT PROVIDED |
Don’t translate | <= | NOT PROVIDED |
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
UMM Migration
UMM Version 1.9.0 | Translation Direction | UMM Version 1.10.0 |
---|---|---|
PLANNED | <=> | PLANNED |
IN WORK | <=> | ACTIVE |
COMPLETE | <=> | COMPLETE |
NOT APPLICABLE | <=> | NOT APPLICABLE |
NOT PROVIDED | <=> | NOT PROVIDED |
Any other value | => | NOT PROVIDED |
Future Mappings
ISO 19115-1
Specification | Path | Type | Notes |
---|---|---|---|
ISO 19115-1 | /mdb:MI_Metadata/mdb:identificationInfo/mri:MD_DataIdentification/mri:status/mri:MD_ProgressCode with codeList and codeListValue attributes | String | ProgressCode has code values of completed, historicalArchive, obsolete, onGoing, planned, required, underDevelopment. gmd:status is not required. Any string can be substituted as well. Since ISO can have multiple status, use only the first one. |
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|