Document ID / Baynes
Status: DRAFT / October 1, 2014
Granule Metadata Model (UMM-G)

Unified Granule Metadata Model

November 2014

Status of This Document

This document provides information to the NASA Earth Science community. Distribution is unlimited.

Change Explanation

V1.0 / Initial Release / 10.1.2014

Impact

This document will impact data providers from NASA DAACs, client developers and catalog developers. This document outlines a model that is intended to be backwards compatible with existing metadata implementations.

Copyright Notice

The contents of this document are not protected by copyright in the United States.

Abstract

This document provides information documenting the Granule Metadata Model to be used by the NASA Earth Science community. This model takes into account existing granule metadata formats in use by this community. Catalogs built to search and discover granule-based Earth Science data provided by NASA should use this model as a guide for implementing search and discovery. Data providers should use this model as a guide to be used during metadata generation.

Table of Contents

Status of This Document 1

Change Explanation 1

Impact 1

Copyright Notice 1

Abstract 1

Introduction 5

Feedback 5

Metadata Concept Relationships and Related Documentation 6

Document Conventions 6

Granule Metadata Conceptual Model 7

Metadata Information 8

Granule Universal Identifier 8

Data Identification 10

Last Update 11

Insert Time 12

Universal Reference Identifier 13

Producer Identifier 14

Local Version Identifier 15

Reprocessing Plan Note 16

Browse Graphic 17

Data Format 19

Additional Attributes - Descriptive Keywords 20

Spatial Locality 21

Project/Campaign 22

Platform 25

Instrument 28

Access Constraint Value 31

Access Constraint Description 32

Parent Collection Identifier 34

Parent Collection Identifier Option 1 - Entry Id (Short Name + Version) 34

Parent Collection Identifier Option 2 - Entry Title (Dataset Id) 36

Spatial Extent 37

Vertical Spatial Domain 38

Spatial Option 1- Point 39

Spatial Option 2 – Line 41

Spatial Option 3 – Polygon 43

Spatial Option 4 - Bounding Box 45

Spatial Option 5 - Bounding Box with Center Point 47

Spatial Option 6 - Polygon with Center Point 49

Spatial Option 7 - Polygon with Holes 51

Additional Attributes - Geographic Identifier 54

Two-Dimensional Coordinate System 55

Temporal Extent 57

Temporal Option 1 - Date Time Range 58

Temporal Option 2 - Single Date Time 59

Coverage Description 60

Additional Attributes - Content Information 60

Day Night Flag 61

Cloud Cover 63

Distribution Information 64

Data Format 64

File Size 65

Related URL 66

Data Quality Information 69

Additional Attributes - Quality Information 69

Reprocessing Lineage 70

Production Date Time 72

Product Generation Executive (PGE) Information 73

Input Granules 74

Acquisition Information 76

Instrument 76

Instrument Characteristics 78

Additional Attributes - Instrument Information 79

Sensor 81

Sensor Characteristics 82

Instrument Operation Modes 84

Project/Campaign 86

Platform 87

Additional Attributes - Platform Information 88

Platform Orbit Information 90

Additional Platform Orbit Information 93

Appendix A: Deprecated Fields 97

Measured Parameters 97

Price 97

Orderable 97

Visible 97

Appendix B: Tags Glossary 98

Appendix C: Tag Index 99

Required 99

Optional 99

Controlled Vocabulary 99

Keyword Search 100

Parameter Search 100

Link 101

Normalize 101

Deprecate 101

Multiple ISO Mappings 101

Validated with Parent 102

Addition 102

Appendix D: Two D Coordinate Systems 103

Appendix E: Additional Attributes Categorization 104

Appendix F: Glossary and Acronym List 105

Glossary 105

Acronyms 105

Introduction

granule
The smallest aggregation of data independently managed (i.e., described, inventoried, retrievable.) Granules can be managed as logical granules and/or physical granules.
These are metadata elements that describe a single instance of a data product. Values of granule metadata apply to all of the data in that one granule. Typical metadata in this category describe spatial and temporal extent of the data as well as the quality and lineage of the data.
Source: http://edhs1.gsfc.nasa.gov/waisdata/docsw/pdf/tp1520303.pdf

EOSDIS generates, archives, and distributes massive amounts of Earth Science data via its DAACs. Reliable, consistent and high-quality metadata is essential to enable useful cataloging of this data.

To increase the level of quality and consistency among its metadata holdings, EOSDIS has developed a model for various metadata concepts that it archives and maintains. This model aims to document vital elements that may be represented across various metadata formats and standards and unify them through core fields useful for data discovery and service invocations. This unified model, aptly named the Unified Metadata Model (UMM), has been developed as part of the EOSDIS Metadata Architecture Studies (MAS I and II) conducted between 2012 and 2013.

The UMM will be used by the Common Metadata Repository (CMR) and will drive search and retrieval of metadata cataloged within that system.

This document is intended to serve as a reference model for geographic metadata for individual granules that are part of a larger data collection. This model breaks down granules into elements closely aligned and directly applicable to ISO 19115-2[1] Geographic information Metadata schema. As part of the larger Unified Metadata Model, this reference model is referred to as the UMM-G, where ‘G’ indicates that this is the granule model.

The ISO 191115-2 mapping paths and snippets used in this document are derived from the NASA Best Practices ISO translation from ECHO to 19115-2. This translation[2] is the results of efforts of the group assembled for the Metadata Evolution for NASA Data Systems (MENDS)[3].

Feedback

Questions, comments and recommendations on this model should be directed to

Metadata Concept Relationships and Related Documentation

Any individual instance of a granule governed by the UMM-G is related to a single parent collection governed by the UMM-C. Also, as shown in Figure 1 below, each granule has an instance of a “meta-metadata”, which has its own model, the UMM-M. Both the UMM-C and the UMM-M are documented separately.

Figure 1: UMM-G Relationships

Additionally, this model and related documentation will be governed by the UMM Lifecycle, documented separately.

Document Conventions

UML diagrams and element lists are provided for each subcomponent of the model. The [R] after a field name indicates that the field is required.

Each section of this document describes an element of the model and includes the following components:

·  Section Number and Element Name: Provides a unique key within this document for this element and identifies the element name

·  Element Hierarchy: Gives the element context within the larger model by providing lineage of the element from the root of the model.

·  Path Mapping: Gives an XPath[4] for this element in both ISO 19115-2 and ECHO metadata XML representations. This can be seen as the “crosswalk” for this element.

·  Description: Provides background information on the intention of the element and how it should be used. Any notes about the current usage of this element are documented here as well as any recommendations for usage or unresolved issues.

·  Cardinality: Indicates the expectation of counts for this element, summarized in the following table:

Value / Description
1 / Exactly one of this element is required
0..1 / Optionally, one of this element may be present
0..* / Optionally, many of this element may be present
1..* / At least one of this element is required, many may be present

·  Relationships: Establishes a relationship between this model field and any other metadata concepts.

·  Tags: Provides related keywords associated with this element. There are specific valid values for tags and an appendix to this document contains valid values and a brief description of their meanings.

·  Examples: XML snippets from both ISO 19115-2 and ECHO data formats documenting sample values for the element. Whenever possible, a URL to the specific granule used for the metadata snippet is provided. All samples were developed using version 1.27 of the file ECHOtoISO.xsl Current versions of this transformation can be found at https://cdn.earthdata.nasa.gov/iso/resources/transforms/

Some elements are marked via tags as ‘Required (with Option)’. These fields are similar to the xml scheme <choice>[5] element: one of the options is required, but there is a choice in which option is utilized. For more information about the various tags used throughout this document, refer to Appendix B: Tags Glossary of this document.

Granule Metadata Conceptual Model

Figure 2: Overall Granule Model

Metadata Information

Figure 3: Metadata Information

Granule Universal Identifier

Model Hierarchy

MI_Metadata
└── Granule Universal Identifier

Path

ISO 19115-2 / /gmi:MI_Metadata/gmd:fileIdentifier/gco:CharacterString
(prefix: ‘gov.nasa.echo:’ )
ECHO / /Granule/GranuleUR

Description

The Universal Reference ID of the granule referred by the data provider. This ID is unique per data provider. The provider (or submitter) of the metadata may not be the producer of the data.
In the MENDS translation example, note the prefixed ‘gov.nasa.echo:’ value to allow for reverse translation.

Note: There may be an issue with this identifier as it might not be universal: GranuleUR is not guaranteed unique across all of ECHO, just within a single provider. Adding the gov.nasa.echo: prefix would not make this a universal identifier.

Cardinality

1

Tags

Required, Keyword Search, Parameter Search, Multiple ISO Mappings

Examples

ECHO

<GranuleUR>AIRX3ST8.005:AIRS.2005.07.07.L3.RetStd008.v5.0.14.0.G07248163722.hdf</GranuleUR>

ISO 19115-2

<gmd:fileIdentifier>
<gco:CharacterString>gov.nasa.echo:AIRX3ST8.005:AIRS.2005.07.07.L3.RetStd008.v5.0.14.0.G07248163722.hdf</gco:CharacterString>
</gmd:fileIdentifier>

ECHO Granule Source:

https://api.echo.nasa.gov:443/catalog-rest/echo_catalog/granules/G183456396-GSFCS4PA

Data Identification

Figure 4: Data Identification

Last Update

Model Hierarchy

MI_Metadata
└── MD_DataIdentification
└── CI_Citation
└── CI_Date
└── CI_DateTypeCode
└── Last Update

Path

ISO 19115-2 / /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:date/gmd:CI_Date/gmd:date/gco:DateTime
with
CI_DateTypeCode[@codeListValue="revision"]
ECHO / /Granule/LastUpdate

Description

This attribute is the date/time the data provider last updated the granule information in the data provider's database

Cardinality

1

Tags

Required, Parameter Search

Examples

ECHO

<LastUpdate>2007-08-05T05:42:56.000Z</LastUpdate>

ISO 19115-2

<gmd:date>
<gmd:CI_Date>
<gmd:date>
<gco:DateTime>2007-08-05T05:42:56.000Z</gco:DateTime>
</gmd:date>
<gmd:dateType>
<gmd:CI_DateTypeCode codeList="http://www.ngdc.noaa.gov/metadata/published/xsd/schema/resources/Codelist/gmxCodelists.xml#CI_DateTypeCode"
codeListValue="revision">revision</gmd:CI_DateTypeCode>
</gmd:dateType>
</gmd:CI_Date>
</gmd:date>

ECHO Granule Source:

https://api.echo.nasa.gov:443/catalog-rest/echo_catalog/granules/G183451293-GSFCS4PA

Insert Time

Model Hierarchy

MI_Metadata
└── MD_DataIdentification
└── CI_Citation
└── CI_Date
└── CI_DateTypeCode
└── Insert Time

Path

ISO 19115-2 / /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:date/gmd:CI_Date/gmd:date/gco:DateTime
with
CI_DateTypeCode[@codeListValue="creation"]
ECHO / /Granule/InsertTime

Description

This attribute is the date/time this granule entered the data archive's database.

Cardinality

1

Tags

Required, Parameter Search

Examples

ECHO

<InsertTime>2014-04-11T03:29:29.000Z</InsertTime>

ISO 19115-2

<gmd:date>
<gmd:CI_Date>
<gmd:date>
<gco:DateTime>2014-04-11T03:29:29.000Z</gco:DateTime>
</gmd:date>
<gmd:dateType>
<gmd:CI_DateTypeCode codeList="http://www.ngdc.noaa.gov/metadata/published/xsd/schema/resources/Codelist/gmxCodelists.xml#CI_DateTypeCode"
codeListValue="creation">creation</gmd:CI_DateTypeCode>
</gmd:dateType>
</gmd:CI_Date>
</gmd:date>

ECHO Granule Source:

https://api.echo.nasa.gov:443/catalog-rest/echo_catalog/granules/G7106212-LARC_ASDC

Universal Reference Identifier

Model Hierarchy

MI_Metadata
└── MD_DataIdentification
└── CI_Citation
└── MD_Identifier
└── Universal Reference Identifier

Path

ISO 19115-2 / /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString
ECHO / /Granule/GranuleUR

Description

The Universal Reference (UR) ID of the granule referred to by the data provider. This ID is unique per data provider.

Cardinality

1

Tags

Required, Keyword Search, Parameter Search

Examples

ECHO

<GranuleUR>AIRHBRAD.005:AIRS.2002.05.25.060.L1B.HSB_Rad.v5.0.0.0.G07278181905.hdf</GranuleUR>

ISO 19115-2

<gmd:identifier>
<gmd:MD_Identifier>
<gmd:code>
<gco:CharacterString>AIRHBRAD.005:AIRS.2002.05.25.060.L1B.HSB_Rad.v5.0.0.0.G07278181905.hdf</gco:CharacterString>
</gmd:code>
</gmd:MD_Identifier>
</gmd:identifier>

ECHO Granule Source:

https://api.echo.nasa.gov:443/catalog-rest/echo_catalog/granules/G191267498-GSFCS4PA

Producer Identifier

Model Hierarchy

MI_Metadata
└── MD_DataIdentification
└── CI_Citation
└── MD_Identifier
└── Producer Identifier

Path

ISO 19115-2 / /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString
ECHO / /Granule/DataGranule/ProducerGranuleId

Description

Unique identifier assigned to a granule by the data creator

Cardinality

0..1

Tags

Optional, Keyword Search, Parameter Search

Examples

ECHO

<ProducerGranuleId>AIRS.2002.08.31.100.L1B.AIRS_QaSub.v5.0.0.0.G07071151057.hdf</ProducerGranuleId>

ISO 19115-2

<gmd:identifier>
<gmd:MD_Identifier>
<gmd:code>
<gco:CharacterString>AIRS.2002.08.31.100.L1B.AIRS_QaSub.v5.0.0.0.G07071151057.hdf</gco:CharacterString>
</gmd:code>
<gmd:description>
<gco:CharacterString>ProducerGranuleId</gco:CharacterString>
</gmd:description>
</gmd:MD_Identifier>
</gmd:identifier>

ECHO Granule Source:

https://api.echo.nasa.gov:443/catalog-rest/echo_catalog/granules/G185415387-GSFCS4PA

Local Version Identifier

Model Hierarchy

MI_Metadata
└── MD_DataIdentification
└── CI_Citation
└── MD_Identifier
└── Local Version Identifier

Path

ISO 19115-2 / /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString
ECHO / /Granule/DataGranule/LocalVersionId

Description

PGE-defined granule version as assigned by the data creator. See note for more information

Note: This field is used inconsistently within ECHO. Some providers use this for more granule-specific lineage information. Usage needs to be normalized.

Cardinality

0..1

Tags

Optional, Deprecate, Normalize

Examples

ECHO

<LocalVersionId>1</LocalVersionId>

ISO 19115-2

<gmd:identifier>
<gmd:MD_Identifier>
<gmd:code>
<gco:CharacterString>1</gco:CharacterString>
</gmd:code>
<gmd:description>
<gco:CharacterString>LocalVersionId</gco:CharacterString>
</gmd:description>
</gmd:MD_Identifier>
</gmd:identifier>

ECHO Granule Source:

https://api.echo.nasa.gov:443/catalog-rest/echo_catalog/granules/G202006-PODAAC

Reprocessing Plan Note

Model Hierarchy

MI_Metadata
└── MD_DataIdentification
└── MD_MaintenanceInformation
└── Reprocessing Plan Note

Path

ISO 19115-2 / /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:resourceMaintenance/gmd:MD_MaintenanceInformation/gmd:maintenanceNote/gco:CharacterString
ECHO / /Granule/DataGranule/ReprocessingPlanned

Description

Note stating what reprocessing may be performed on this granule.

Cardinality

0..1

Tags

Optional, Deprecate

Examples

ECHO

<ReprocessingPlanned>further update is anticipated</ReprocessingPlanned>

ISO 19115-2

<gmd:resourceMaintenance>
<gmd:MD_MaintenanceInformation>
<gmd:maintenanceAndUpdateFrequency gco:nilReason="missing"/>
<gmd:maintenanceNote>
<gco:CharacterString>further update is anticipated</gco:CharacterString>
</gmd:maintenanceNote>
</gmd:MD_MaintenanceInformation>
</gmd:resourceMaintenance>

ECHO Granule Source:

https://api.echo.nasa.gov:443/catalog-rest/echo_catalog/granules/G29633887-LPDAAC_ECS

Browse Graphic

Model Hierarchy

MI_Metadata
└── MD_DataIdentification
└── MD_BrowseGraphic
└── Browse Graphic

Path

ISO 19115-2 / /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:graphicOverview/gmd:MD_BrowseGraphic
(format: {Description} File Size: {FileSize}
with MimeType
/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:graphicOverview/gmd:MD_BrowseGraphic/gmd:fileType/gco:CharacterString
ECHO / /Granule/AssociatedBrowseImageUrls/ProviderBrowseUrl/Description
/Granule/AssociatedBrowseImageUrls/ProviderBrowseUrl/FileSize
/Granule/AssociatedBrowseImageUrls/ProviderBrowseUrl/MimeType

Description

The list of browse image urls and descriptions associated with this granule. In the future this may be deprecated in favor of visualization metadata linkage.
In ISO 19115-2 the URL is included as an attribute and the description and file size are descriptive elements. The mime type for the browse graphic is included under a file type element.

Note: No Examples Found in Sample Data, snippets taken from constructed data

Cardinality

0..*

Tags

Optional, Link

Examples

ECHO

<AssociatedBrowseImageUrls>
<ProviderBrowseUrl>
<URL>/*/AssociatedBrowseImageUrls[1]/ProviderBrowseUrl[1]/URL[1]</URL>
<FileSize>/*/AssociatedBrowseImageUrls[1]/ProviderBrowseUrl[1]/FileSize[1]</FileSize>
<Description>/*/AssociatedBrowseImageUrls[1]/ProviderBrowseUrl[1]/Description</Description>
<MimeType>/*/AssociatedBrowseImageUrls[1]/ProviderBrowseUrl[1]/MimeType[1]</MimeType>
</ProviderBrowseUrl>
</AssociatedBrowseImageUrls>

ISO 19115-2

<gmd:graphicOverview>
<gmd:MD_BrowseGraphic>
<gmd:fileName>
<gmx:FileName src="/*/AssociatedBrowseImageUrls[1]/ProviderBrowseUrl[1]/URL[1]"/>
</gmd:fileName>
<gmd:fileDescription>
<gco:CharacterString>/*/AssociatedBrowseImageUrls[1]/ProviderBrowseUrl[1]/Description File Size: /*/AssociatedBrowseImageUrls[1]/ProviderBrowseUrl[1]/FileSize[1]</gco:CharacterString>
</gmd:fileDescription>
<gmd:fileType>
<gco:CharacterString>/*/AssociatedBrowseImageUrls[1]/ProviderBrowseUrl[1]/MimeType[1]</gco:CharacterString>
</gmd:fileType>
</gmd:MD_BrowseGraphic>
</gmd:graphicOverview>

Data Format

Model Hierarchy

MI_Metadata
└── MD_DataIdentification
└── MD_Format
└── Data Format

Path

ISO 19115-2 / /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:resourceFormat/gmd:MD_Format/gmd:name/gco:CharacterString
ECHO / /Granule/DataFormat

Description

This attribute contains the file format of the raw data (such as HDF) for this granule

Cardinality

0..*

Tags

Optional, Controlled Vocabulary, Normalize, Multiple ISO Mappings

Examples

ECHO

<DataFormat>HDF-EOS</DataFormat>

ISO 19115-2

<gmd:resourceFormat>
<gmd:MD_Format>
<gmd:name>
<gco:CharacterString>HDF-EOS</gco:CharacterString>
</gmd:name>
<gmd:version gco:nilReason="unknown"/>
</gmd:MD_Format>
</gmd:resourceFormat>

ECHO Granule Source:

https://api.echo.nasa.gov:443/catalog-rest/echo_catalog/granules/G187566584-GSFCS4PA

Additional Attributes - Descriptive Keywords

Model Hierarchy

MI_Metadata
└── MD_DataIdentification
└── MD_Keywords
└── Additional Attributes - Descriptive Keywords

Path

ISO 19115-2 / /gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:descriptiveKeywords/gmd:MD_Keywords/gmd:keyword/gco:CharacterString
ECHO / /Granule/AdditionalAttributes/AdditionalAttribute/Name: /Granule/AdditionalAttributes/AdditionalAttribute/Values/Value

Description

This entity stores the product specific attributes that are descriptive in nature. For more information on how attributes are mapped, please refer to the additional attributes appendix to this document.

Cardinality

0..*

Relationships

This field is validated against the parent collection field ProductSpecificAttribute of the UMM-C to ensure that it contains an attribute of the same name.

Tags

Optional, Keyword Search, Parameter Search, Validated

Examples

ECHO

<AdditionalAttribute>
<Name>ASCENDING_DESCENDING</Name>
<Values>
<Value>ASCENDING</Value>
</Values>
</AdditionalAttribute>

ISO 19115-2

<gmd:descriptiveKeywords>
<gmd:MD_Keywords>
<gmd:keyword>
<gco:CharacterString>ASCENDING_DESCENDING: ASCENDING</gco:CharacterString>
</gmd:keyword>
<gmd:thesaurusName>
<gmd:CI_Citation>
<gmd:title>
<gco:CharacterString>NASA ECHO Additional Attributes as descriptiveKeywords</gco:CharacterString>
</gmd:title>
<gmd:date gco:nilReason="inapplicable"/>
</gmd:CI_Citation>
</gmd:thesaurusName>
</gmd:MD_Keywords>
</gmd:descriptiveKeywords>

ECHO Granule Source: