Page History
Table of Contents | ||
---|---|---|
|
Element Description
The archive Archive and distribution information main element allows data providers to provide users information of what is available for downloading when they are initially looking at a collection. The end users get elements provide information about a format other than its original for data immediately available for download. This includes information such as the average downloadable file size, data format, mime type, checksum, and an estimate of the collection's entire downloadable file size, etc.
Best Practices
There are multiple sub-elements that comprise Archive and Distribution Information for Collections:
Format: Defines a single format for an archival artifact (e.g., binary, jpeg, HDF5, HDF-EOS5, geotiff)GeoTIFF). The format must be selected from the GCMD Granule Data Format vocabulary list in order to adhere to the UMM-C schema. This ensures consistent use of data formats across the CMR.
Format Type: Allows the provider to define if the archival artifact's format is in its native format or another supported format.
Format Description: Allows the data provider to provide added information about the provided Format.
Average File Size: An approximate average of the size of the the archivable item, which gives users an idea of the magnitude of each archivable file.
Average File Size Unit: Unit of measure for the average file size (e.g., KB, MB, TB).
Total Collection File Size: An approximate total size of the archivable items, which gives users an idea of the magnitude of all the archivable files combined.
Total Collection File Size Unit: Unit Unit of measure for the total collection file size (e.g., KB, MB, TB).
Total Collection File Size Begin Date: The date that data collection began for the collection, which should be in the following format: yyyy-MM-ddTHH:mm:ssZ
Description: Enables the provider to provide more information about the archivable item item.
Media: Defines how the distributable material can be obtained by an end user (e.g., Online Archive, CD-ROM, hard drives, online, etc.).
Fees: Provide the price an end user will need to pay in order to obtain the distributable material
Examples:
.
Each of these elements are available under 'FileArchiveInformation' and 'FileDistributionInformation'. FileArchiveInformation describes the data in its archived format. FileDistributionInformation describes the data as distributed by a data provider. It can be the original format in which the data are archived, or it can be used to specify when the data is distributed in a format other than its original format. FileDistributionInformation is the preferred location for providing the data format since this should specify the format data are being distributed in to the end user.
Examples:
Format: "HDF-EOS5"
Format Type: "Native"
Format Description: "This is an EOSDIS specific format, and it is also available in ASCII."
Average File Size: "250"
Average File Size Unit: "KB"
Total Collection File Size: "25"
Total Collect File Size Unit: "GB"
Total Collection File Size Begin Date: "2018-04-01T00:00:00Z"
Element Specification
Cardinality of Archive and Distribution Information:
Model | Element | Type | Usable Valid Values | Constraints | Required? | Cardinality | Notes |
---|---|---|---|---|---|---|---|
UMM-C | ArchiveAndDistributionInformation/ FileArchiveInformation/ Format | String | GCMD Granule Data Format vocabulary list | 1 - 80 characters | Yes | 1 | The format must be selected from the GCMD Granule Data Format vocabulary list. |
UMM-C | ArchiveAndDistributionInformation/ FileArchiveInformation/FormatType | String | Native Supported | n/a | No |
Element Specification
Cardinality of Archive and Distribution Information:
Model | Element | Type | Usable Valid Values | Constraints | Required? | Cardinality | Notes | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
UMM-Common | ArchiveAndDistributionInformation/ FileArchiveInformation/ Format | String | 1 - 80 characters | Yes | 1 | UMM-Common | ArchiveAndDistributionInformation/ FileArchiveInformation/FormatType | String | Native Supported | n/a | No | 0..1 | UMM-Common | ArchiveAndDistributionInformation/ FileArchiveInformation/ AverageFileSize | Decimal | Yes, if TotalCollectionFileSizeBeginDate is used. | 0..1 | UMM-Common | ArchiveAndDistributionInformation/ FileArchiveInformation/ AverageFileSizeUnit | String | KB MB GB TB PB NA | n/a Yes, if AverageFileSize is used. | 0..1 | |
UMM-CommonC | ArchiveAndDistributionInformation/ FileArchiveInformation/TotalCollectionFileSizeFormatDescription | String | 1 - 80 charactersDecimal | No | 0..1 | Either use TotalCollectionFileSize or TotalCollectiopnFileSizeBeginDate | ||||||||||||||||||
UMM-CommonC | ArchiveAndDistributionInformation/ FileArchiveInformation/ TotalCollectionFileSizeUnit | Enumeration | KB MB GB TB PB NA | n/a | AverageFileSize | Decimal | Yes, if TotalCollectionFileSize TotalCollectionFileSizeBeginDate is used. | 0..1 | ||||||||||||||||
UMM-CommonC | ArchiveAndDistributionInformation/ FileArchiveInformation/ TotalCollectionFileSizeBeginDateAverageFileSizeUnit | DateString | No | 0..1 | Either use TotalCollectionFileSize or TotalCollectiopnFileSizeBeginDate | KB MB GB TB PB NA | UMM-Common | ArchiveAndDistributionInformation/ FileArchiveInformation/ Description | String | n/a 1 - 1024 characters | Yes, if AverageFileSize is used.No | 0..1 | ArchiveAndDistributionInformation/ FileDistributionInformation/Format | String | 1 - 80 characters | Yes | ||||||||
UMM-C | ArchiveAndDistributionInformation/ FileDistributionInformationFileArchiveInformation/ FormatTypeTotalCollectionFileSize | StringDecimal | Native Supported | No | 0..1 | Either use TotalCollectionFileSize or TotalCollectiopnFileSizeBeginDate | ||||||||||||||||||
UMM- | CommonC | ArchiveAndDistributionInformation/ | FileDistributionInformationFileArchiveInformation/ TotalCollectionFileSizeUnit | MediaEnumeration | StringKB | n/a | MB GB TB PB NA | No | 0..1 | UMM-Common | ArchiveAndDistributionInformation/ FileDistributionInformation/ AverageFileSize | Decimal | n/a | n/a | Yes, if | TotalCollectionFileSizeBeginDateTotalCollectionFileSize is used | .0..1 | |||||||
UMM- | CommonC | ArchiveAndDistributionInformation/ | FileDistributionInformationFileArchiveInformation/ | AverageFileSizeUnitTotalCollectionFileSizeBeginDate | Enumeration | KB MB GB TB PB NA | Yes, if AverageFileSize is used.Date | No | 0..1 | Either use TotalCollectionFileSize or TotalCollectiopnFileSizeBeginDate | ||||||||||||||
UMM- | CommonC | ArchiveAndDistributionInformation/ | FileDistributionInformationFileArchiveInformation/ | TotalCollectionFileSizeDescription | DecimalString | n/a | 1 - 1024 characters | No | 0..1 | Either use TotalCollectionFileSize or TotalCollectiopnFileSizeBeginDate | ||||||||||||||
UMM-CommonC | ArchiveAndDistributionInformation/ FileDistributionInformation/TotalCollectionFileSizeUnitFormat | Enumeration | KB MB GB TB PB NA | n/a | Yes, if TotalCollectionFileSize is used | 0..1 | UMM-Common | ArchiveAndDistributionInformation/ FileDistributionInformation/ TotalCollectionFileSizeBeginDate | String | GCMD Granule Data Format vocabulary list | 1 - 80 characters | Yes | 1 | The format must be selected from the GCMD Granule Data Format vocabulary list. Recommend providing the data format in this element since this should specify the format data are being distributed in to the end user. | ||||||||||
UMM-C | ArchiveAndDistributionInformation/ FileDistributionInformation/ FormatType | String | Native Supported | DateNo | 0..1 | Either use TotalCollectionFileSize or TotalCollectiopnFileSizeBeginDate | ||||||||||||||||||
UMM-CommonC | ArchiveAndDistributionInformation/ FileDistributionInformation/ DescriptionFormatDescription | Stringn/a | 1 - 1024 80 characters | No | 0..1 | |||||||||||||||||||
UMM-CommonFeesC | ArchiveAndDistributionInformation/ FileDistributionInformation/ Media | String | n/a | 1 - 255 80 characters | No | 0..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).
Please see the expandable sections below for flowchart details.
Expand | ||
---|---|---|
| ||
|
Expand | ||
---|---|---|
| ||
|
title | ARC Metadata QA/QC |
---|
This element is categorized as highest priority when:
This element is categorized as medium priority when:
This element is categorized as low priority when:
ARC Automated Checks
- TBD
Dialect Mappings
Expand | ||
---|---|---|
| ||
DIF 9 (Note: DIF-9 is being phased out and will no longer be supported after 2018) |
UMM-C | ArchiveAndDistributionInformation/ FileDistributionInformation/ AverageFileSize | Decimal | n/a | n/a | Yes, if TotalCollectionFileSizeBeginDate is used. | 0..1 | |
UMM-C | ArchiveAndDistributionInformation/ FileDistributionInformation/ AverageFileSizeUnit | Enumeration | KB MB GB TB PB NA | Yes, if AverageFileSize is used. | 0..1 | ||
UMM-C | ArchiveAndDistributionInformation/ FileDistributionInformation/ TotalCollectionFileSize | Decimal | n/a | No | 0..1 | Either use TotalCollectionFileSize or TotalCollectiopnFileSizeBeginDate | |
UMM-C | ArchiveAndDistributionInformation/ FileDistributionInformation/ TotalCollectionFileSizeUnit | Enumeration | KB MB GB TB PB NA | n/a | Yes, if TotalCollectionFileSize is used | 0..1 | |
UMM-C | ArchiveAndDistributionInformation/ FileDistributionInformation/ TotalCollectionFileSizeBeginDate | Date | No | 0..1 | Either use TotalCollectionFileSize or TotalCollectiopnFileSizeBeginDate | ||
UMM-C | ArchiveAndDistributionInformation/ FileDistributionInformation/ Description | String | n/a | 1 - 1024 characters | No | 0..1 | |
UMM-C | Fees | String | n/a | 1 - 255 characters | No | 0..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 | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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) |
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DIF 10All of the sub-elements are optional in DIF 10.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UMM-C Element | Path | Type | Usable Valid Values | Constraints | Required in DIF 10? | Cardinality | Notes | ArchiveAndDistributionInformation/ FileArchiveInformation/ Format | /DIF/Distribution/Distribution_Format | String | Yes | 1 | ArchiveAndDistributionInformation/FileDistributionInformation/FormatType | /DIF/Native | String | Native Supported | No | 0..1 | ArchiveAndDistributionInformation/FileDistributionInformation/Media | /DIF/Distribution/Distribution_Media | String | No | 0..1 | ArchiveAndDistributionInformation/FileDistributionInformation/AverageFileSize | /DIF/Distribution/Distribution_Size | String | No | ArchiveAndDistributionInformation/FileDistributionInformation/AverageFileSizeUnit | /DIF/MB | String | KB MB GB TB PB | No | Example Mapping||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section |
Column | ||
---|---|---|
| ||
DIF 10
|
width | 50% |
---|
UMM
title | ECHO 10 |
---|
ECHO 10
Only 2 UMM-C Archive and Distribution Information sub-elements map to ECHO 10, Data Format and Fees, and providing either sub-element is not required.
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||
ECHO 10Only 2 UMM-C Archive and Distribution Information sub-elements map to ECHO 10, Data Format and Fees, and neither element is required.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ISO 19115-2 MENDSArchive and Distribution Information is an optional metadata element in ISO 19115-2 MENDS.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ISO 19115-2 MENDSInstrument is an optional metadata element, however, it is strongly recommended that it be provided when possible. Multiple Instruments may be listed if necessary (Cardinality: 0..*). Providing instrument characteristics is optional. An unlimited amount of instrument characteristics may be specified for a particular instrument (Cardinality: 0..*). If instrument characteristics are provided, all 5 sub-fields (Name, Description, DataType, Unit, Value) are required.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UMM-C Element | Path | Type | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
n/a | n/a | n/a | n/a | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section |
Column | ||
---|---|---|
| ||
n/a |
width | 50% |
---|
UMM
UMM Migration
None
|
Expand | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
ISO 19115-2 SMAPArchive and Distribution Information does not currently map to ISO 19115-2 SMAP.
|
UMM Migration
None
Excerpt | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Future Mappings
|
History
UMM Versioning
Version | Date | What Changed |
---|---|---|
1.15.5 | 12/3/2020 | The description of the format elements now includes text about the controlled vocabulary for this field coming from KMS. |
1.15.4 | 9/18/2020 | No changes were made for Archive and Distribution Information during the transition from version 1.15.3 to 1.15.4 |
1.15.3 | 7/1/2020 | FormatDescription was added to FileArchive and FileDistribution Information types to version 1.15.3 |
1.15.2 | 5/20/2020 | No changes were made for Archive and Distribution Information during the transition from version 1.15.1 to 1.15.2 |
1.15.1 | 3/25/2020 | No changes were made for Archive and Distribution Information during the transition from version 1.15.0 to 1.15.1 |
1.15.0 | 2/26/2020 | No changes were made for Archive and Distribution Information during the transition from version 1.14.0 to 1.15.0 |
1.14.0 | 10/21/2019 | No changes were made for Archive and Distribution Information during the transition from version 1.13.0 to 1.14.0 |
Future Mappings
title | ISO 19115-1 |
---|
ISO 19115-1
Instrument is an optional metadata element, however, it is strongly recommended that it be provided when possible. Multiple Instruments may be listed if necessary (Cardinality: 0..*).
Providing instrument characteristics is optional. An unlimited amount of instrument characteristics may be specified for a particular instrument (Cardinality: 0..*). If instrument characteristics are provided, all 5 sub-fields (Name, Description, DataType, Unit, Value) are required.
/mdb:MD_Metadata/mdb:acquisitionInformation/mac:MI_AcquisitionInformation/mac:instrument/mac:MI_Instrument id="<insert unique instrument ID here>"/mac:identifier/mcc:MD_Identifier/mcc:code/gco:CharacterString
with
/mdb:MD_Metadata/mdb:acquisitionInformation/mac:MI_AcquisitionInformation/mac:instrument/mac:MI_Instrument id="<insert unique instrument ID here>"/mac:identifier/mcc:MD_Identifier/mcc:codeSpace/gco:CharacterString = gov.nasa.esdis.umm.instrumentshortname
Corresponds to the UMM field Platforms/Instruments/ShortName. A list of valid instrument short names can be found in the KMS under the 'Short_Name' column. For each instrument listed the short name is required by CMR. The short name value goes in the gmd:code field.
The value of " gov.nasa.esdis.umm.instrumentshortname" should be provided in gmd:CodeSpace field so that CMR can properly parse out the instrument short name.
An ID should be provided directly after "eos:EOS_Instrument" in the ISO x-path. This ID corresponds to the instrument and is used to link the instrument information to the associated platform. The ID should be unique within the metadata record.
/mdb:MD_Metadata/mdb:acquisitionInformation/mac:MI_AcquisitionInformation/mac:instrument/mac:MI_Instrument id="<insert unique instrument ID here>"/mac:identifier/mcc:MD_Identifier/mcc:description/gco:CharacterString
Corresponds to the UMM field Platforms/Instruments/Characteristics/DataType.
ISO codelist values (class, codelist, enumeration, codelistElement, abstractClass, aggregateClass, specifiedClass, datatypeClass, interfaceClass, unionClass, metaClass, typeClass, characterString, integer, association)
UMM enum (STRING, FLOAT, INT BOOLEAN, DATE, TIME, DATETIME, DATE_STRING, TIME_STRING, DATETIME_STRING)
/mdb:MD_Metadata/mdb:acquisitionInformation/mac:MI_AcquisitionInformation/mac:instrument/mac:MI_Instrument id="<insert unique instrument ID here> "/mac:otherProperty/gco:Record/eos:AdditionalAttributes/eos:AdditionalAttribute/eos:reference/eos:EOS_AdditionalAttributeDescription/ eos:name/gco:CharacterString="OperationalMode"
and
/mdb:MD_Metadata/mdb:acquisitionInformation/mac:MI_AcquisitionInformation/mac:instrument/mac:MI_Instrument id="<insert unique instrument ID here> "/mac:otherProperty/gco:Record/eos:AdditionalAttributes/eos:AdditionalAttribute/eos:value/gco:CharacterString
Example Mapping
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
History
UMM Versioning
Version | Date | What Changed |
---|---|---|
1.13.0 | 04/11/2019 | This element was added to the UMM-C specification. |
ARC Documentation
Version | Date | What Changed | Author |
---|---|---|---|
1.0 | 05/16/18 | Recommendations/priority matrix transferred from internal ARC documentation to wiki space | |
1.1 | 04/12/21 | Moved "The data format provided is correct, however, it does not exactly match its entry in the GCMD Granule Data Format vocabulary list." from blue to red. GCMD keywords are now the authoritative controlled vocabulary source for data formats. | Jeanne' le Roux |