Page History
Table of Contents | ||
---|---|---|
|
Element Description
The direct distribution information main element allows data providers to provide users information on getting direct access to data products that are stored in the Amazon Web Service (AWS) S3 buckets when they are initially looking at a collection. The end users get information such as the S3 credentials end point, a credential documentation URL, as well as bucket prefix names, and an AWS region.
Best Practices
There are multiple sub-elements that comprise Direct Distribution Information:
Region: Defines the possible values for the Amazon Web Service US Regions where the data product resides. The current valid values are: us-east-1,us-east-2,us-west-1, and us-west-2.
S3BucketAndObjectPrefixNames: Defines the possible values for the Amazon Web Service US S3 bucket and/or object prefix names.
S3CredentialsAPIEndpoint: Defines the URL where the credentials are stored.
S3CredentialsAPIDocumentationURL: Defines the URL where the credential documentation are is stored.
Each of these elements describes the information that is necessary to pull out data products that are stored in the AWS cloud using a s3 S3 URL that is located inside each granule's s (data product file's) metadata.
Examples:
FormatRegion: "us-east-1"
S3BucketAndObjectPrefixNames: "Bucket 1"
S3CredentialsAPIEndpoint: "https://some-data-product-credentials-api.com/api.html"
S3CredentialsAPIDocumentationURL: "https://some-data-product-credentials-api.com/docs.html"
Element Specification
Cardinality of Archive and Direct Distribution Information:
Model | Element | Type | Usable Valid Values | Constraints | Required? | Cardinality | Notes | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
UMM-C | ArchiveAndDistributionInformationDirectDistributionInformation/ FileArchiveInformation/ FormatRegion | String | GCMD Granule Data Format vocabulary list | 1 - 80 characters | Yes | 1 | us-east-1 us-east-2 us-west-1 us-west-2 | n/a | Yes | 1To ensure consistency, it is highly recommended that the format be selected from the GCMD Granule Data Format vocabulary list. | |||||||||||||||||||||||||
UMM-C | DirectDistributionInformation/ S3BucketAndObjectPrefixNamesArchiveAndDistributionInformation/ FileArchiveInformation/FormatType | String | Native Supported | n/a | 1 - 1024 characters | No | 0..1* | ||||||||||||||||||||||||||||
UMM-C | ArchiveAndDistributionInformation/ FileArchiveInformation/FormatDescription | DirectDistributionInformation/ S3CredentialsAPIEndpoint | URI | n/aString | 1 - 80 1024 characters | NoYes | 0..1 | ||||||||||||||||||||||||||||
UMM-C | ArchiveAndDistributionInformation/ FileArchiveInformation/ AverageFileSize | Decimal | Yes, if TotalCollectionFileSizeBeginDate is used. | 0..1 | UMM-C | ArchiveAndDistributionInformation/ FileArchiveInformation/ AverageFileSizeUnit | String | KB MB GB TB PB NA | Yes, if AverageFileSize is used. | 0..1 | UMM-C | ArchiveAndDistributionInformation/ FileArchiveInformation/ TotalCollectionFileSize | Decimal | No | 0..1 | Either use TotalCollectionFileSize or TotalCollectiopnFileSizeBeginDate | UMM-C | ArchiveAndDistributionInformation/ FileArchiveInformation/ TotalCollectionFileSizeUnit | Enumeration | KB MB GB TB PB NA | n/a | Yes, if TotalCollectionFileSize is used | 0..1 | UMM-C | ArchiveAndDistributionInformation/ FileArchiveInformation/ TotalCollectionFileSizeBeginDate | Date | No | 0..1 | Either use TotalCollectionFileSize or TotalCollectiopnFileSizeBeginDate | UMM-C | ArchiveAndDistributionInformation/ FileArchiveInformation/ Description | String | n/a | No | 0..1 |
UMM-C | ArchiveAndDistributionInformation/ FileDistributionInformation/Format | String | GCMD Granule Data Format vocabulary list | 1 - 80 characters | Yes | 1 | To ensure consistency, it is highly recommended that the format be selected from the GCMD Granule Data Format vocabulary list. | UMM-C | ArchiveAndDistributionInformation/ FileDistributionInformation/ FormatType | String | Native Supported | No | 0..1 | UMM-C | ArchiveAndDistributionInformation/ FileDistributionInformation/ FormatDescription | String | 1 - 80 characters | No | 0..1 | UMM-C | ArchiveAndDistributionInformation/ FileDistributionInformation/ Media | String | n/a | No | 0..1 | 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
DirectDistributionInformation/ S3CredentialsAPIDocumentationURL | URI | n/a | 1 - 1024 characters | Yes | 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 10The definitions are the same between UMM-C and ECHO 10.
|
|
|
Fees
|
|
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:
- No data format is provided
- The data format provided is incorrect
This element is categorized as medium priority when:
- The data format provided is correct, but could be more specific
- E.g. Providing 'NetCDF' when the format should be 'NetCDF-4'
- E.g. Providing 'ASCII' when the data format should be 'CSV'
This element is categorized as low priority when:
- The data format provided is correct, however, it does not exactly match its entry in the GCMD Granule Data Format vocabulary list.
- E.g. providing 'netcdf4' versus 'NetCDF-4'
- E.g. providing 'geo-tiff' versus 'GeoTIFF'
ARC Automated Checks
- TBD
Dialect Mappings
Expand | ||
---|---|---|
| ||
DIF 9 (Note: DIF-9 is being phased out and will no longer be supported after 2018) |
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ECHO 10The definitions are the same between UMM-C and ECHO 10.
|
Expand | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||
ISO 19115-2 MENDSArchive and Distribution Information is an optional metadata element in ISO 19115-2 MENDS.
| |||||||||||||||||||||||||||||||||
Expand | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
DIF 10All of the sub-elements are optional in DIF 10. | |||||||||||||||||||||||||||||||||
UMM-C Element | Path | Type | Usable Valid Values | Constraints | Required in DIF 10? | Cardinality | Notes | ArchiveAndDistributionInformation/FileDistributionInformation/ Format | /DIF/Distribution/Distribution_Format | String | No | 0..1 | To ensure consistency, it is highly recommended that the format be selected from the GCMD Granule Data Format vocabulary list. | ArchiveAndDistributionInformation/FileDistributionInformation/FormatType | /DIF/Distribution/Distribution_Format_Type | String | Native Supported | No | 0..1 | This is a DIF 10.3 field. Currently in DIF 10.2 there is just one field called '/DIF/Distribution/Distribution_Format' | ArchiveAndDistributionInformation/FileDistributionInformation/Media | /DIF/Distribution/Distribution_Media | String | No | 0..1 | ArchiveAndDistributionInformation/FileDistributionInformation/AverageFileSize | /DIF/Distribution/Average_Granule_Size | This is a DIF 10.3 field. Currently in DIF 10.2 there is just one field called '/DIF/Distribution/Distribution_Size' | ArchiveAndDistributionInformation/FileDistributionInformation/AverageFileSizeUnit | /DIF/Distribution/Average_Granule_Size_Unit | Enumeration | KB MB GB TB PB | No | 0..1 | This is a DIF 10.3 field. Currently in DIF 10.2 there is just one field called '/DIF/Distribution/Distribution_Size' | ArchiveAndDistributionInformation/FileDistributionInformation/TotalCollectionFileSize | /DIF/Distribution/Total_Collection_Size | Decimal | No | 0..1 | This is a DIF 10.3 field. Currently in DIF 10.2 there is just one field called '/DIF/Distribution/Distribution_Size' | ArchiveAndDistributionInformation/FileDistributionInformation/TotalCollectionFileSizeUnit | /DIF/Distribution/Distribution_Collection_Size_Unit | Enumeration | KB MB GB TB PB | No | 0..1 | This is a DIF 10.3 field. Currently in DIF 10.2 there is just one field called '/DIF/Distribution/Distribution_Size' | ArchiveAndDistributionInformation/FileDistributionInformation/ Fees | /DIF/Distribution/Fees | String | n/a | No | 0..1 | Example Mapping
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
title | ECHO 10 |
---|
ECHO 10
Only 2 UMM-C Archive and Distribution Information sub-elements map to ECHO 10, Data Format and Fees, and neither element is required.
N/A
N/A
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
title | ISO 19115-2 MENDS |
---|
ISO 19115-2 MENDS
Archive and Distribution Information is an optional metadata element in ISO 19115-2 MENDS.
[=> /gmd:name/gco:CharacterString
[=> /gmd:specification/gco:CharacterString = FormatType: <FormatType>
[=> /gmd:transferOptions xlink:href="FileDistributionInformation_Media_<Block Number>"gmd:MD_DigitalTransferOptions/gmd:offLine/gmd:MD_Medium/gmd:name/gmd:MD_MediumNameCode codeList="https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_MediumNameCode" codeListValue="<value>" = <value>
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
title | ISO 19115-2 SMAP |
---|
ISO 19115-2 SMAP
Archive and Distribution Information does not currently map to ISO 19115-2 SMAP.
N/A
N/A
Section | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
UMM Migration
None
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ISO 19115-2 SMAP
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Excerpt | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Future Mappings
|
UMM Migration
None
Excerpt | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||
Future Mappings
|
History
UMM Versioning
Excerpt Include | ||||||
---|---|---|---|---|---|---|
|
Version | Date | What Changed |
---|---|---|
1.16.0 | 03/24/2021 |
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 |
1.13.0 | 04/11/2019 | This element was added to the UMM-C specification. |
ARC Documentation
Version | Date | What Changed | Author |
---|---|---|---|
1.0 | 056/1630/1821 | Recommendations/priority matrix transferred from internal ARC documentation to wiki space |