Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

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.

S3BucketAndObjectPrefixNamesDefines the possible values for the Amazon Web Service US S3 bucket and/or object prefix names.

S3CredentialsAPIEndpointDefines the URL where the credentials are stored.

S3CredentialsAPIDocumentationURLDefines the URL where the credential documentation are 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 URL that is located inside each granule's  (data product file's) metadata.

Examples:

Format: "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 Distribution Information: 

ModelElementTypeUsable Valid ValuesConstraintsRequired?CardinalityNotes
UMM-C

ArchiveAndDistributionInformation/ FileArchiveInformation/

Format
StringGCMD Granule Data Format vocabulary list1 - 80 characters
Yes1To ensure consistency, it is highly recommended that the format be selected from the GCMD Granule Data Format vocabulary list.
UMM-CArchiveAndDistributionInformation/ FileArchiveInformation/FormatTypeString

Native

Supported

n/aNo0..1
UMM-CArchiveAndDistributionInformation/ FileArchiveInformation/FormatDescriptionString
1 - 80 charactersNo0..1
UMM-CArchiveAndDistributionInformation/ FileArchiveInformation/ AverageFileSizeDecimal



Yes, if TotalCollectionFileSizeBeginDate is used.0..1
UMM-C

ArchiveAndDistributionInformation/ FileArchiveInformation/ AverageFileSizeUnit

String

KB

MB

GB

TB

PB

NA


n/a

Yes, if AverageFileSize is used.
0..1
UMM-C

ArchiveAndDistributionInformation/ FileArchiveInformation/ TotalCollectionFileSize

Decimal

No0..1Either use TotalCollectionFileSize or TotalCollectiopnFileSizeBeginDate
UMM-C

ArchiveAndDistributionInformation/ FileArchiveInformation/ TotalCollectionFileSizeUnit

Enumeration

KB

MB

GB

TB

PB

NA

n/aYes, if TotalCollectionFileSize is used0..1
UMM-C

ArchiveAndDistributionInformation/ FileArchiveInformation/ TotalCollectionFileSizeBeginDate

Date

No0..1Either use TotalCollectionFileSize or TotalCollectiopnFileSizeBeginDate
UMM-C

ArchiveAndDistributionInformation/ FileArchiveInformation/ Description

Stringn/a

1 - 1024 characters


No0..1
UMM-C

ArchiveAndDistributionInformation/

FileDistributionInformation/Format

StringGCMD Granule Data Format vocabulary list1 - 80 charactersYes1To 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


No0..1
UMM-C

ArchiveAndDistributionInformation/

FileDistributionInformation/ FormatDescription

String


1 - 80 charactersNo0..1
UMM-C

ArchiveAndDistributionInformation/ FileDistributionInformation/

Media
Stringn/a

1 - 80 characters


No0..1
UMM-CArchiveAndDistributionInformation/ FileDistributionInformation/ AverageFileSizeDecimaln/an/aYes, 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

Decimaln/a
No0..1Either use TotalCollectionFileSize or TotalCollectiopnFileSizeBeginDate
UMM-C

ArchiveAndDistributionInformation/ FileDistributionInformation/ TotalCollectionFileSizeUnit

Enumeration

KB

MB

GB

TB

PB

NA

n/aYes, if TotalCollectionFileSize is used0..1
UMM-C

ArchiveAndDistributionInformation/ FileDistributionInformation/ TotalCollectionFileSizeBeginDate

Date

No0..1Either use TotalCollectionFileSize or TotalCollectiopnFileSizeBeginDate
UMM-C

ArchiveAndDistributionInformation/ FileDistributionInformation/ Description

Stringn/a

1 - 1024 characters


No0..1
UMM-C

Fees

Stringn/a

1 - 255 characters


No0..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.


  • Manual Review
  • Automated Review
  • TBD

ARC Priority Matrix

Priority CategorizationJustification

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'

The element is provided, and follows all applicable criteria specified in the best practices section above.

ARC Automated Checks

  • TBD

Dialect Mappings

DIF 9 (Note: DIF-9 is being phased out and will no longer be supported after 2018)

DIF 10

All of the sub-elements are optional in DIF 10. 

UMM-C ElementPathTypeUsable Valid ValuesConstraintsRequired in DIF 10?CardinalityNotes

ArchiveAndDistributionInformation/FileDistributionInformation/

Format
/DIF/Distribution/Distribution_Format
String



No0..1To 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_TypeString

Native

Supported


No0..1This 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_MediaString

No0..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_UnitEnumeration

KB

MB

GB

TB

PB


No0..1This 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_SizeDecimal

No0..1This 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_UnitEnumeration

KB

MB

GB

TB

PB


No0..1This 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/FeesStringn/a
No0..1


Example Mapping

DIF 10

<Distribution>
  <Distribution_Media>Online Archive></Distribution_Media>
  <Average_Granule_Size>231</Average_Granule_Size> **Note: In DIF 10.2 this would appear as: <Distribution_Size>231 MB per file</Distribution_Size>
  <Average_Granule_Size_Unit>MB</Average_Granule_Size_Unit>
  <Distribution_Format>HDF-EOS5</Distribution_Format>
  <Distribution_Format_Type>Native</Distribution_Format_Type>  **Note: The Distribution_Format_Type field is not available in DIF 10.2
  <Fees>Free</Fees>
</Distribution>

UMM

"ArchiveAndDistributionInformation": {
    "FileDistributionInformation": [
      {
        "FormatType": "Native",
        "AverageFileSize": 231,
        "Fees": "Free",
        "Format": "HDF-EOS",
        "AverageFileSizeUnit": "MB",
        "Media": [
          "Online Archive"
        ]
      }
    ]
  },

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. 

UMM-C ElementPathTypeUsable Valid ValuesConstraintsRequired in ECHO10?CardinalityNotes
ArchiveAndDistributionInformation/FileDistributionInformation/Format/DataFormatString

N/A

No0..1To ensure consistency, it is highly recommended that the format be selected from the GCMD Granule Data Format vocabulary list.
ArchiveAndDistributionInformation/FileDistributionInformation/Fees/PriceString

N/A

No0..1


Example Mapping

ECHO 10

<DataFormat>HDF-EOS5</DataFormat>
<Price>0.0</Price>

UMM

"ArchiveAndDistributionInformation": {
  "FileDistributionInformation": [
    {
      "FormatType": "Native",
      "Fees": "0.0",
      "Format": "HDF-EOS5"
    }
  ]
},

ISO 19115-2 MENDS

Archive and Distribution Information is an optional metadata element in ISO 19115-2 MENDS.


UMM-C ElementPathTypeNotes
ArchiveAndDistributionInformation/FileArchiveInformation/Format

[=> /gmd:name/gco:CharacterString

String


ArchiveAndDistributionInformation/FileArchiveInformation/FormatType

[=> /gmd:specification/gco:CharacterString = FormatType: <FormatType>

String
ArchiveAndDistributionInformation/FileArchiveInformation/AverageFileSize[=> /gmd:specification/gco:CharacterString = AverageFileSize: <AverageFileSize>Decimal
ArchiveAndDistributionInformation/FileArchiveInformation/AverageFileSizeUnit[=> /gmd:specification/gco:CharacterString = AverageFileSizeUnit: <AverageFileSizeUnit>String
ArchiveAndDistributionInformation/FileArchiveInformation/TotalCollectionFileSize[=> /gmd:specification/gco:CharacterString = TotalCollectionFileSize: <TotalCollectionFileSize>Decimal
ArchiveAndDistributionInformation/FileArchiveInformation/TotalCollectionFileSizeUnit[=> /gmd:specification/gco:CharacterString = TotalCollectionFileSizeUnit: <TotalCollectionFileSizeUnit>Enumeration
ArchiveAndDistributionInformation/FileArchiveInformation/TotalCollectionFileSizeBeginDate[=> /gmd:specification/gco:CharacterString = TotalCollectionFileSizeBeginDate: <TotalCollectionFileSizeBeginDate>Date
ArchiveAndDistributionInformation/FileArchiveInformation/Description[=> /gmd:specification/gco:CharacterString = Description: <Description>String


ArchiveAndDistributionInformation/FileDistributionInformation/Format[=> /gmd:distributionFormat xlink:href="FileDistributionInformation_<Block Number>"/gmd:MD_Format/gmd:name/gco:CharacterStringString
ArchiveAndDistributionInformation/FileDistributionInformation/FormatType[=> /gmd:distributionFormat xlink:href="FileDistributionInformation_<Block Number>"/gmd:MD_Format/gmd:specification/gmd:CharacterString = FormatType: <Native or Supported>String
ArchiveAndDistributionInformation/FileDistributionInformation/Media

[=> /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>

String
ArchiveAndDistributionInformation/FileDistributionInformation/AverageFileSize[=> /gmd:transferOptions xlink:href="FileDistributionInformation_AverageFileSize_<Block Number>"/gmd:MD_DigitalTransferOptions/gmd:unitsOfDistribution/gco:CharacterStringDecimal
ArchiveAndDistributionInformation/FileDistributionInformation/AverageFileSizeUnit[=> /gmd:transferOptions xlink:href="FileDistributionInformation_AverageFileSize_<Block Number>"/gmd:MD_DigitalTransferOptions/gmd:unitsOfDistribution/gco:CharacterStringEnumeration
ArchiveAndDistributionInformation/FileDistributionInformation/TotalCollectionFileSize[=> /gmd:transferOptions xlink:href="FileDistributionInformation_TotalCollectionFileSize_<Block Number>"/gmd:MD_DigitalTransferOptions/gmd:transferSize/gco:RealDecimal
ArchiveAndDistributionInformation/FileDistributionInformation/TotalCollectionFileSizeUnit[=> /gmd:transferOptions xlink:href="FileDistributionInformation_TotalCollectionFileSize_<Block Number>"/gmd:MD_DigitalTransferOptions/gmd:unitsOfDistribution/gco:CharacterStringEnumeration
ArchiveAndDistributionInformation/FileDistributionInformation/TotalCollectionFileSizeBeginDate[=> /gmd:distributionFormat xlink:href="FileDistributionInformation_<Block Number>"/gmd:MD_Format/gmd:specification/gmd:CharacterString = TotalCollectionFileSizeBeginDate: <Date use MMDDYYYYTHH:MM:SSZ format>Date
ArchiveAndDistributionInformation/FileDistributionInformation/Description[=> /gmd:distributor xlink:href="FileDistributionInformation_<Block Number>"/gmd:MD_Distributor/gmd:distributionOrderProcess/gmd:MD_StandardOrderProcess/gmd:orderingInstructions/gmd:CharacterStringString
ArchiveAndDistributionInformation/FileDistributionInformation/Fees[=> /gmd:distributor xlink:href="FileDistributionInformation_<Block Number>"/gmd:MD_Distributor/gmd:distributionOrderProcess/gmd:MD_StandardOrderProcess/gmd:fees/gmd:CharacterStringString


Example Mapping

ISO 19115-2 MENDS

<gmi:MI_Metadata>
  ...
    <gmd:distributionFormat xlink:href="FileDistributionInformation_<Block Number>"/>
        <gmd:MD_Format>
            <gmd:specification>
                <gco:CharacterString>TotalCollectionFileSizeBeginDate</gco:CharacterString>
              </gmd:code>
              <gmd:codeSpace>
                <gco:CharacterString>2018-04-01T00:00:00Z</gco:CharacterString>
              </gmd:codeSpace>
            <gmd:specification>
          <gmd:MD_Format>
      <gmd:distributionFormat xlink:href="FileDistributionInformation_<Block Number>"/>  
                

UMM

ArchiveandDistributionInformation: [ 
  { 
     AverageFileSize: "250", 
  },
  { 
     AverageFileSizeUnit: "KB", 
  },
  { 
     TotalCollectionFileSizeBeginDate: "2018-04-01T00:00:00Z", 
  } 
],
                

ISO 19115-2 SMAP

Archive and Distribution Information does not currently map to ISO 19115-2 SMAP.

UMM-C ElementPathTypeNotes
N/A

N/A

N/A

N/A


Example Mapping

N/A

N/A

UMM Migration

None

History

UMM Versioning

VersionDateWhat Changed
1.15.512/3/2020The description of the format elements now includes text about the controlled vocabulary for this field coming from KMS.
1.15.49/18/2020No changes were made for Archive and Distribution Information during the transition from version 1.15.3 to 1.15.4
1.15.37/1/2020FormatDescription was added to FileArchive and FileDistribution Information types to version 1.15.3
1.15.25/20/2020No changes were made for Archive and Distribution Information during the transition from version 1.15.1 to 1.15.2
1.15.13/25/2020No changes were made for Archive and Distribution Information during the transition from version 1.15.0 to 1.15.1
1.15.02/26/2020No changes were made for Archive and Distribution Information during the transition from version 1.14.0 to 1.15.0
1.14.010/21/2019No changes were made for Archive and Distribution Information during the transition from version 1.13.0 to 1.14.0
1.13.004/11/2019This element was added to the UMM-C specification.

ARC Documentation

VersionDateWhat ChangedAuthor
1.005/16/18Recommendations/priority matrix transferred from internal ARC documentation to wiki space
  • No labels