Versions Compared

Old Version 54

changes.mady.by.user Kaylin Bugbee

Saved on

compared with

New Version 55

changes.mady.by.user Kaylin Bugbee

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
stylecircle

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 datasets 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 datasets may be available.
  • ACTIVE refers to datasets 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 datasets 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

For continuous datasets:

If data collection is ongoing and the Collection Progress element is set to “ACTIVE”, the following actions are recommended:

  • The ‘Ends at Present Flag’ element should be set to “true.”
  • If the temporal extent of the collection is expressed as a range date time, then it is not necessary to populate the “Ending Date Time” element in the metadata.

Setting the ‘Ends at Present Flag’ element to “true” tells the CMR that the ending time for the collection is present day, and thus eliminates the need to specify the ending date time of the collection. This also eliminates the need to update the ending date time in the metadata each time new data gets added to the collection.

For completed datasets:

If data collection is complete and the collection progress is set to “COMPLETE”, the following actions are recommended:

  • The ‘Ends at Present Flag' element should be set to “false”. Alternatively, the ‘Ends at Present Flag’ element may be completely removed from the metadata since it is an optional element.
  • If the temporal extent of the collection is expressed as a range date time, then the “Ending Date Time” element must be provided in the metadata.

Setting the ‘Ends at Present Flag’ element to “false” tells the CMR that the ending time for the collection is in the past. If the temporal extent of the collection is expressed as a range date time, then the “Ending Date Time” element should specify the ending date and time of the last available granule in the collection.

For disparate datasets:

For some datasets, there may be gaps in data collection. For example, there may be a flight campaign dataset where data is only collected in May and September of each year. If there are future plans to add data to the collection, then it is okay to set the Collection Progress to “ACTIVE”. In this scenario, opposite to the best practices specified for continuous datasets above, it is recommended that the ‘Ends At Present Flag’ be set to “false” and that and Ending Date time be provided. This would require that the Ending Date Time be updated each time new data gets added to the collection (e.g. in May and September). This practice most accurately conveys the temporal coverage of a dataset to a user.    


Element Specification

ModelElementTypeUsable Valid ValuesRequired?Cardinality
UMM-CCollectionProgressEnumeration

PLANNED

ACTIVE

COMPLETE

NOT APPLICABLE

Yes1

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 Priority Matrix

Priority CategorizationJustification

This element is categorized as highest priority when:

  • The element is not included at all
  • The element is included but is empty
  • The valid value in the element appears to be out of sync with data collection. Examples include:
    • Data has stopped being collected in the distant past but the element lists the progress as 'ACTIVE.' As a rule of thumb, this applies when the last available granule has an ending date time of 1+ years in the past. 
    • The element lists the collection progress as 'PLANNED' but data is actually now being collected.
    • Data is still being collected but the element lists the progress as 'COMPLETE.'

The valid value in the element appears to be out of sync with data collection.

The ending date time of the latest granule in the collection is in the past, however the element lists the collection progress as 'ACTIVE' - The latest granule in the collection is less than 1 year from the present day, and the collection is part of a field or flight campaign which may still be ongoing (this could result in gaps in the data). The DAAC should confirm whether data collection is still ongoing for the field/ flight campaign or whether the collection is complete.


Not applicable

The element is provided, a correct valid value is used, and the valid value matches the status of the dataset.


Dialect Mappings

Expand
titleDIF 9

DIF 9

SpecificationPathTypeRequired in DIF9?Notes
DIF 9

/DIF/Data_Set_Progress

String


NoDIF 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

Example Mapping

Section
Column
width50%

DIF 9

No Format
<Data_Set_Progress>COMPLETE</Data_Set_Progress>
Column
width50%

UMM

No Format
"CollectionProgress" : "COMPLETE",
Expand
titleDIF 10

DIF 10

SpecificationPathTypeRequired in DIF 10?Notes
DIF 10/DIF/Dataset_ProgressEnumerationNo

There are three valid values for the DIF10 enumeration list:

    • PLANNED
    • IN WORK
    • COMPLETE

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

Example Mapping

Section
Column
width50%

DIF 10

No Format
<Dataset_Progress>IN WORK</Dataset_Progress>
Column
width50%
No Format
"CollectionProgress" : "COMPLETE",
Expand
titleECHO 10

ECHO 10

SpecificationPathTypeRequired in ECHO10?Notes
ECHO 10/Collection/CollectionStateStringNoNone


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

Example Mapping

Section
Column
width50%

ECHO 10

No Format
<CollectionState>COMPLETED</CollectionState>
Column
width50%

UMM

No Format
"CollectionProgress" : "COMPLETE",



Expand
titleISO 19115-2 MENDS

ISO 19115-2 MENDS

SpecificationPathTypeNotes
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=StringProgressCode 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 supports multiple statuses for a collection/series, the CMR translates only the first one to UMM.

Enumeration/Code List Mapping

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

Example Mapping

Section
Column
width50%

ISO 19115-2 MENDS

No Format
<gmd:status>
    <gmd:MD_ProgressCode codeList=
        "https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_ProgressCode"
        codeListValue="completed">completed</gmd:MD_ProgressCode>
</gmd:status>
Column
width50%

UMM

No Format
"CollectionProgress" : "COMPLETE",



Expand
titleISO 19115-2 SMAP

ISO 19115-2 SMAP

SpecificationPathTypeNotes
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=StringProgressCode 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 supports multiple statuses for a collection/series, the CMR translates only the first one to UMM.

Enumeration/Code List Mapping

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

Example Mapping

Section
Column
width50%

ISO 19115-2 SMAP

No Format
<gmd:status>
    <gmd:MD_ProgressCode codeList=
         "https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_ProgressCode"
         codeListValue="completed">completed</gmd:MD_ProgressCode>
</gmd:status>
Column
width50%

UMM

No Format
"CollectionProgress" : "COMPLETE",



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

SpecificationPathTypeNotes
ISO 19115-1

/mdb:MI_Metadata/mdb:identificationInfo/mri:MD_DataIdentification/mri:status/mri:MD_ProgressCode

with codeList and codeListValue attributes

StringProgressCode 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 supports multiple statuses for a collection/series, the CMR translates only the first one to UMM.
Section
Column
width50%
No Format
<mri:MD_DataIdentification>
  <mri:citation>
    ...
    <mri:status>
      <mri:MD_ProgressCode codeList="{codeListLocation}#MD_ProgressCode"
        codeListValue="onGoing">onGoing</mri:MD_ProgressCode>
    </mri:status>
    ...
  </mri:citation>
</mri:MD_DataIdentification>
Column
width50%
No Format
"CollectionProgress" : "ACTIVE",

History

UMM Versioning

VersionDateWhat Changed
1.10.0
Changes would be tracked here
1.9.0

ARC Documentation

VersionDateWhat ChangedAuthor
1.02/19/18Recommendations/priority matrix transferred from internal ARC documentation to wiki space
Kaylin Bugbee