Page History
Table of Contents | ||
---|---|---|
|
Element Description
The platform elements enable the specification of platforms used to collect the data available in the dataset. Platforms provided in CMR metadata are controlled by a vocabulary and must be chosen from a controlled keyword hierarchy maintained in the Keyword Management System (KMS). A list of valid platform keywords can be found here: https://gcmdservicesgcmd.gsfcearthdata.nasa.gov/statickms/kmsconcepts/platforms/platforms.csv?concept_scheme/platforms?format=csv
Optionally, attributes specific to the platform (such as equator crossing time, inclination angle, orbital period, etc.) may be specified in the characteristics elements. Please see the Characteristics wiki page for a detailed description of the characteristics sub-elements.
Best Practices
Science Platform keywords are important for the precise search and retrieval discovery of data, and should accurately represent the data set being described. As a rule of thumb, science keywords should represent the scientific parameters being provided in the data as well as any broader conceptual terms that may aid in describing the data. At a minimum, one science keyword hierarchy must be provided, and this hierarchy must go down to the 'Term' level of detail. The 'Detailed Variable' element is the only science keyword element that is not controlled by the KMS. The 'Detailed Variable' keyword should only be used if there is a very specific parameter provided in the data which is not adequately described by keywords in the KMS. If a particular science keyword is . All relevant platforms should be listed for each dataset. It is preferred that more specific platform keyword terms be chosen from the KMS when available. For example, if data were collected from the NASA DC-8 aircraft, it is preferred that "NASA DC-8" be listed as the platform as opposed to the more generic "AIRCRAFT" keyword. If a particular platform keyword is missing from the KMS, it is possible to put in a request to have it added. The KMS is managed by the Global Change Master Directory (GCMD), and new keyword requests may be made through the the GCMD Keywords Community Forum.
All positions in the science keyword hierarchy must be populated until the desired level of detail is reached. Skipping or leaving blank a position in the keyword hierarchy will render the keyword invalid. The only exception to this is the 'Detailed Variable' element; a Detailed Variable keyword may be provided as long as it is preceded by the required Category, Topic and Term keywords. Science In the KMS, there is a hierarchy for platform keywords. Platform keywords should be provided in the metadata field corresponding to the appropriate position of the keyword hierarchy, otherwise the keyword will be rendered invalid. For example, the platform short name specified in the KMS should not be provided in the platform 'long name' field in the metadata. When listing platforms, a platform short name will always be required. While platform long names are not required, it is highly encouraged that long names be provided if one is listed in the KMS. Many platform short names are comprised of acronyms, so inclusion of the long name provides additional context to a user who may not be familiar with the acronym. Platform keywords are not case sensitive.
Examples:
It is recommended that platform keywords be assigned in a consistent manner. For example, if data for several collections were collected by the "LANDSAT-8" satellite, it is recommended that the metadata for all of those collections list "LANDSAT-8" as the platform short name. Providing "LANDSAT-8" as the platform in some records, but the more generic "LANDSAT" as the platform in other records, results in an inconsistent experience for a user discovering data. This is especially true for users narrowing down their search results in the Earthdata Search client by using the faceted search options.
In the case that it does not make sense to provide a platform for a dataset, "Not Applicable" is an accepted value.
Examples (ShortName > LongName):
Terra > Earth Observing System, Terra (AM-1)
METOP-A > Meteorological Operational Satellite - A
VIC-LSM > Variable Infiltration Capacity (VIC) Land Surface Model
MESONET > Mesoscale Meteorological Network
BE-200 > Beechcraft King Air BE-200
Element Specification
Platform is a required element. A minimum of 1 Platform must be provided. Multiple Platforms may also be provided if necessary (Cardinality: 1..*).
Providing platform characteristics is optional. An unlimited amount of platform characteristics may be specified for a particular platform (Cardinality: 0..*). If platform characteristics are provided, all 5 sub-fields (Name, Description, DataType, Unit, Value) are required.
Model | Element | Type | Usable Valid Values | Constraints | Required? | Cardinality | Notes |
---|---|---|---|---|---|---|---|
UMM-Common | Platforms/Type | String | Platform Category Keywords | KMS controlled |
Element Specification
An unlimited amount of science keywords may be listed (Cardinality: 1..*)
KMS controlled
No | 0..1 |
ARC Priority Matrix
This element is categorized as highest priority when:
- The element is not included at all.
- The element is included but is empty.
- The science keyword does not align with the KMS.
- The science keyword does not exist in KMS.
- A keyword(s) is missing from the hierarchy.
- A keyword(s) is placed in the incorrect position of the hierarchy (e.g. a Variable Level 2 keyword is placed in the Variable Level 1 field).
- The science keyword is not appropriate for the dataset.
This element is categorized as medium priority when:
- A recommendation is made to add a relevant science keyword to the metadata.
- A recommendation is made to add to an existing keyword in the metadata (i.e. i.e. to extend a keyword hierarchy down to a more detailed keyword).
Not Applicable
Dialect Mappings
Expand | ||
---|---|---|
| ||
DIF 9 (Note: DIF-9 is being phased out and will no longer be supported after 2018) |
UMM-Common | Platforms/ShortName | String | Platform Short_Name Keywords | KMS controlled | Yes | 1 | |
UMM-Common | Platforms/LongName | String | Platform Long_Name Keywords | KMS controlled | No | 0..1 | |
UMM-Common | Platforms/Characteristics/Name | String | n/a | 1 - 80 characters | Yes, if applicable | 1 | Only required if a characteristic is listed. Providing characteristics is optional. |
UMM-Common | Platforms/Characteristics/Description | String | n/a | 1 - 80 characters | Yes, if applicable | 1 | Only required if a characteristic is listed. Providing characteristics is optional. |
UMM-Common | Platforms/Characteristics/DataType | Enumeration | STRING FLOAT INT BOOLEAN DATE TIME DATETIME DATE_STRING TIME_STRING DATETIME_STRING | n/a | Yes, if applicable | 1 | Only required if a characteristic is listed. Providing characteristics is optional. |
UMM-Common | Platforms/Characteristics/Unit | String | n/a | 1 - 20 characters | Yes, if applicable | 1 | Only required if a characteristic is listed. Providing characteristics is optional. |
UMM-Common | Platforms/Characteristics/Value | String | n/a | 1 - 80 characters | Yes, if applicable | 1 | Only required if a characteristic is listed. Providing characteristics is optional. |
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 value is given. This is needed partly because the CMR still allows a non UMM compliant record to be ingested with warnings.
NOT PROVIDED - DIF 10 records found to be missing platforms by software will be automatically assigned a value of "Not Provided". It should then be confirmed whether a platform can be assigned or whether "Not Applicable" should be provided. The value "Not Provided" should not be used by metadata providers.
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 rich-viewer false autofit true name Copy of Wiki Page Metadata Evaluation Workflow-1939-b106300c width 1102 pages-to-display id 98e5dc28-3252-4209-953f-66f1378e1cf4 align Left height 299
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 10Platform is a required element. A minimum of 1 Platform must be provided. Multiple Platforms may also be provided if necessary (Cardinality: 1..*). Providing platform characteristics is optional. An unlimited amount of platform characteristics may be specified for a particular platform (Cardinality: 0..*). If platform characteristics are provided, all 5 sub-fields (Name, Description, DataType, Unit, Value) are required.
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ECHO 10Platform is an optional element in ECHO10, however, it is required in the UMM. Therefore it is strongly recommended that a Platform be provided if possible. Multiple Platforms may also be provided if necessary (Cardinality: 0..*). Providing platform characteristics is optional. An unlimited amount of platform characteristics may be specified for a particular platform (Cardinality: 0..*). If platform characteristics are provided, all 5 sub-fields (Name, Description, DataType, Unit, Value) are required.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Specification | Path | Type | Constraints | Required in DIF 10? | Cardinality | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DIF 10 | /DIF/Science_Keywords/Category | String | KMS controlled | Yes | 1 | The category keyword will always be "EARTH SCIENCE" | DIF 10 | /DIF/Science_Keywords/Topic | String | KMS controlled | Yes | 1 | DIF 10 | /DIF/Science_Keywords/Term | String | KMS controlled | Yes | 1 | DIF 10 | /DIF/Science_Keywords/Variable_Level_1 | String | KMS controlled | No | 0..1 | DIF 10 | /DIF/Science_Keywords/Variable_Level_2 | String | KMS controlled | No | 0..1 | DIF 10 | /DIF/Science_Keywords/Variable_Level_3 | String | KMS controlled | No | 0..1 | DIF 10 | /DIF/Science_Keywords/Detailed_Variable | String | Uncontrolled (Free-Text) | No | 0..1 |
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
title | ECHO 10 |
---|
ECHO 10
An unlimited amount of science keywords may be listed (Cardinality: 1..*)
KMS controlled
KMS controlled
Example Mapping
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
title | ISO 19115-2 MENDS |
---|
ISO 19115-2 MENDS
An unlimited amount of science keywords may be listed (Cardinality: 1..*)
/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:descriptiveKeywords/gmd:MD_Keywords/ gmd:keyword/gco:CharacterString (list each value of the keyword hierarchy delimited by > )
String
KMS controlled. This is where the entire keyword hierarchy should be listed. Each keyword in the hierarchy must be separated by ">"
codeList=https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_KeywordTypeCode
Select the value "theme" from the codelist. This codelist value does not directly map to a UMM element - choosing 'theme' indicates to CMR that the Science Keywords should be mapped.
Example Mapping
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
title | ISO 19115-2 SMAP |
---|
ISO 19115-2 SMAP
An unlimited amount of science keywords may be listed (Cardinality: 1..*)
/gmd:DS_Series/gmd:seriesMetadata/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:descriptiveKeywords/ gmd:MD_Keywords/gmd:keyword/gco:CharacterString (list each value of the keyword hierarchy delimited by > )
codeList=https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_KeywordTypeCode
Select the value "theme" from the codelist. This codelist value does not directly map to a UMM element - choosing 'theme' indicates to CMR that the Science Keywords should be mapped.
Example Mapping
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
UMM Migration
None
|
Expand | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
ISO 19115-1 | ||||||||||||||
Specification | Path | Type | Notes | ISO 19115-1 | String | |||||||||
Section | ||||||||||||||
Column | ||||||||||||||
| ||||||||||||||
No Format |
Column | ||
---|---|---|
| ||
UMM
|
2 MENDS
Platform is a required element. A minimum of 1 Platform must be provided. Multiple Platforms may also be provided if necessary (Cardinality: 1..*).
Providing platform characteristics is optional. An unlimited amount of platform characteristics may be specified for a particular platform (Cardinality: 0..*). If platform characteristics are provided, all 5 sub-fields should be provided (Name, Description, DataType, Unit, Value) to meet CMR requirements.
UMM-C Element | ISO 19115-2 MENDS Path | Type | Notes |
---|---|---|---|
Platforms/Type | /gmi:MI_Metadata/gmi:acquisitionInformation/gmi:MI_AcquisitionInformation/gmi:platform/eos:EOS_Platform id="<insert unique instrument ID here>"/ gmd:description/gco:CharacterString | String | Values should be selected from the platform 'Category' keywords in KMS. An ID should be provided directly after "eos:EOS_Platform" in the ISO x-path. This ID corresponds to the platform and is used to link the platform information to the associated instrument. The ID should be unique within the metadata record. |
Platforms/ShortName | /gmi:MI_Metadata/gmi:acquisitionInformation/gmi:MI_AcquisitionInformation/gmi:platform/eos:EOS_Platform/ gmi:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString with /gmi:MI_Metadata/gmi:acquisitionInformation/gmi:MI_AcquisitionInformation/gmi:platform/eos:EOS_Platform/ gmi:identifier/gmd:MD_Identifier/gmd:codeSpace/gco:CharacterString = gov.nasa.esdis.umm.platformshortname | String | A list of valid platform short names can be found in the KMS under the 'Short_Name' column. For each platform 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.platformshortname" should be provided in gmd:CodeSpace field so that CMR can properly parse out the platform short name. |
Platforms/LongName | /gmi:MI_Metadata/gmi:acquisitionInformation/gmi:MI_AcquisitionInformation/gmi:platform/eos:EOS_Platform/ gmi:identifier/gmd:MD_Identifier/gmd:description/gco:CharacterString | String | A list of valid platform long names can be found in the KMS under the 'Long_Name' column. |
/gmi:MI_Metadata/gmi:acquisitionInformation/gmi:MI_AcquisitionInformation/gmi:platform/eos:EOS_Platform/ eos:otherProperty/gco:Record/eos:AdditionalAttributes/eos:AdditionalAttribute/eos:reference/eos:EOS_AdditionalAttributeDescription/ eos:type/eos:EOS_AdditionalAttributeTypeCode codeList="https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#EOS_AdditionalAttributeTypeCode" codeListValue="platformInformation"=platformInformation | Codelist | The "platformInformation" codelist value must be provided so that CMR can properly identify the associated information as platform characteristics. This codelist value does not directly map to a UMM element - choosing 'platformInformation' indicates to CMR that the platform characteristic elements should be mapped. | |
Platforms/Characteristics/Name | /gmi:MI_Metadata/gmi:acquisitionInformation/gmi:MI_AcquisitionInformation/gmi:platform/eos:EOS_Platform/ eos:otherProperty/gco:Record/eos:AdditionalAttributes/eos:AdditionalAttribute/eos:reference/eos:EOS_AdditionalAttributeDescription/ eos:name/gco:CharacterString | String | |
Platforms/Characteristics/Description | /gmi:MI_Metadata/gmi:acquisitionInformation/gmi:MI_AcquisitionInformation/gmi:platform/eos:EOS_Platform/ /eos:otherProperty/gco:Record/eos:AdditionalAttributes/eos:AdditionalAttribute/eos:reference/eos:EOS_AdditionalAttributeDescription/ eos:description/gco:CharacterString | String | |
Platforms/Characteristics/DataType | /gmi:MI_Metadata/gmi:acquisitionInformation/gmi:MI_AcquisitionInformation/gmi:platform/eos:EOS_Platform/ eos:otherProperty/gco:Record/eos:AdditionalAttributes/eos:AdditionalAttribute/eos:reference/eos:EOS_AdditionalAttributeDescription/ eos:dataType/eos:EOS_AdditionalAttributeDataTypeCode codeList="https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_DatatypeCode" codeListValue=<date type> value=<data type> | Codelist | 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) |
Platforms/Characteristics/Unit | /gmi:MI_Metadata/gmi:acquisitionInformation/gmi:MI_AcquisitionInformation/gmi:platform/eos:EOS_Platform/ /eos:otherProperty/gco:Record/eos:AdditionalAttributes/eos:AdditionalAttribute/eos:reference/eos:EOS_AdditionalAttributeDescription/ eos:parameterUnitsOfMeasure/gco:CharacterString | String | |
Platforms/Characteristics/Value | /gmi:MI_Metadata/gmi:acquisitionInformation/gmi:MI_AcquisitionInformation/gmi:platform/eos:EOS_Platform/ /eos:otherProperty/gco:Record/eos:AdditionalAttributes/eos:AdditionalAttribute/eos:value/gco:CharacterString | String | |
/gmi:MI_Metadata/gmi:acquisitionInformation/gmi:MI_AcquisitionInformation/gmi:platform/eos:EOS_Platform/gmi:instrument xlink:href=<insert unique instrument ID here>' | String | An ID should be provided here and should match the ID provided for the associated instrument. This ID should be unique within a metadata record. This will link all of the information provided on the platform to its associated instrument. |
Example Mapping
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ISO 19115-2 SMAPPlatform is a required element. A minimum of 1 Platform must be provided. Multiple Platforms may also be provided if necessary (Cardinality: 1..*). Providing platform characteristics is optional. An unlimited amount of platform characteristics may be specified for a particular platform (Cardinality: 0..*). If platform characteristics are provided, all 5 sub-fields should be provided (Name, Description, DataType, Unit, Value) to meet CMR requirements.
|
UMM Migration
None
Excerpt | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Future Mappings
|
History
UMM Versioning
Version | Date | What Changed |
---|---|---|
1.15.5 | 12/3/2020 | No changes were made for Platform during the transition from version 1.15.4 to 1.15.5 |
1.15.4 | 9/18/2020 | No changes were made for Platform during the transition from version 1.15.3 to 1.15.4 |
1.15.3 | 7/1/2020 | No changes were made for Platform during the transition from version 1.15.2 to 1.15.3 |
1.15.2 | 5/20/2020 | No changes were made for Platform during the transition from version 1.15.1 to 1.15.2 |
1.15.1 | 3/25/2020 | No changes were made for Platform during the transition from version 1.15.0 to 1.15.1 |
1.15.0 | 2/26/2020 | No changes were made for Platform during the transition from version 1.14.0 to 1.15.0 |
1.14.0 | 10/21/2019 | No changes were made for Platform during the transition from version 1.13.0 to 1.14.0 |
1.13.0 | 04/11/2019 | No changes were made for Platform during the transition from version 1.12.0 to 1.13.0 |
1.12.0 | 01/22/2019 | No changes were made for Platform during the transition from version 1.11.0 to 1.12.0. |
1.11.0 | 11/28/2018 | No changes were made for Platform during the transition from version 1.10.0 to 1.11.0. |
1.10.0 | 05/02/2018 | No changes were made for Platform during the transition from version 1.9.0 to 1.10.0. |
History
UMM Versioning
Version | Date | What Changed |
---|---|---|
1.0.0 | Initial Release |
ARC Documentation
Version | Date | What Changed | Author |
---|---|---|---|
1.0 | 505/414/182018 | Recommendations/priority matrix transferred from internal ARC documentation to wiki space |