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

Compare with Current View Page History

« Previous Version 19 Next »

Element Description

The platform elements enable the specification of platforms used to collect the data available in the dataset. Platforms provided in CMR metadata 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://gcmdservices.gsfc.nasa.gov/static/kms/platforms/platforms.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

Platform keywords are important for the discovery of data. 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 GCMD Keywords Community Forum.

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.

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 (Short Name > Long Name):

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

An unlimited amount of platform keywords may be listed (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.

ModelElementTypeUsable Valid ValuesConstraintsRequired?Cardinality
UMM-CommonPlatforms/TypeStringPlatform Category Keywords

KMS controlled

No0..1
UMM-CommonPlatforms/ShortNameStringPlatform Short_Name KeywordsKMS controlled
Yes1
UMM-CommonPlatforms/LongNameStringPlatform Long_Name KeywordsKMS controlledNo0..1
UMM-CommonPlatforms/Characteristics/NameStringn/a

1 - 80 characters


Yes1
UMM-CommonPlatforms/Characteristics/DescriptionStringn/a1 - 80 charactersYes1
UMM-CommonPlatforms/Characteristics/DataTypeEnumeration

STRING

FLOAT

INT

BOOLEAN

DATE

TIME

DATETIME

DATE_STRING

TIME_STRING

DATETIME_STRING

n/aYes1
UMM-CommonPlatforms/Characteristics/UnitStringn/a

1 - 20 characters


Yes1
UMM-CommonPlatforms/Characteristics/ValueStringn/a

1 - 80 characters


Yes1

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



ARC Priority Matrix

Priority CategorizationJustification

This element is categorized as highest priority when:

  • The element is not included at all.
  • The platform short name tags are provided in the metadata but are left empty.
  • The platform keyword does not align with the KMS.
    • The platform keyword does not exist in KMS.
    • A keyword(s) is placed in the incorrect position of the hierarchy (e.g. the platform short name is placed in the long name field).
    • Keywords from two different KMS hierarchies are listed in the same hierarchy in the metadata (i.e. hierarchies cannot be mixed and matched)
  • Not all relevant platforms are listed.
  • An incorrect platform is listed.
  • A recommendation is made to replace a valid platform with a more specific/appropriate platform keyword.
  • Please see the Characteristics wiki page for high priority issues related to the Characteristics sub-elements.

This element is categorized as medium priority when:

  • A recommendation is made to add a platform long name when a long name exists in the KMS.
  • A recommendation is made to add the platform type to the metadata (this aligns with the platform category keywords in KMS).
  • Platforms are provided in an inconsistent manner across related datasets.
  • Please see the Characteristics wiki page for medium priority issues related to the Characteristics sub-elements.

This element is categorized as low priority when:


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


Dialect Mappings

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

DIF 10

An unlimited amount of platform keywords may be listed (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.

SpecificationPathTypeConstraintsRequired in DIF 10?CardinalityNotes
DIF 10

/DIF/Platform/Type

String

KMS controlled

Yes

1

Corresponds to the Platform 'Category' keywords in KMS.

DIF 10/DIF/Platform/Short_Name
String

KMS controlled

Yes1For each platform provided, a short name is required.
DIF 10/DIF/Platform/Long_NameString

KMS controlled

No0..1It is highly recommended that a long name be provided if one is available in KMS.
DIF 10/DIF/Platform/Characteristics/NameString
No0..1
DIF 10/DIF/Platform/Characteristics/DescriptionString
No0..1
DIF 10/DIF/Platform/Characteristics/DataTypeString
No0..1
DIF 10/DIF/Platform/Characteristics/UnitString
No0..1
DIF 10/DIF/Platform/Characteristics/ValueString
No0..1



Example Mapping

DIF 10

<Platform>
  <Type>Earth Observation Satellites</Type>
  <Short_Name>ICESat</Short_Name>
  <Long_Name>Ice, Cloud and Land Elevation Satellite</LongName>
  <Characteristics>
    <Name>OrbitInclination</Name>
    <Description>The angle between the orbit plane and the Earth's equatorial plane.</Description>
    <DataType>FLOAT</DataType>
    <Unit>Degrees</Unit>
    <Value>94.0</Value>
  </Characteristics>
............
</Platform>

UMM

Platforms: [
  {
    Type: "Earth Observation Satellites",
    ShortName: "ICESat",
    LongName: "Ice, Cloud and Land Elevation Satellite",
    Characteristics: [
      {
        Name: "OrbitInclination",
        Description: "The angle between the orbit plane and the Earth's equatorial plane.",
        DataType: "FLOAT",
        Unit: "Degrees",
        Value: "94.0"
      }
    ]
    .............
  }
]

ECHO 10

An unlimited amount of platform keywords may be listed (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.

SpecificationPathTypeConstraintsRequired in ECHO10?CardinalityNotes
ECHO 10/Collection/Platforms/Platform/TypeString

KMS controlled

Yes1Corresponds to the Platform 'Category' keywords in KMS.
ECHO 10/Collection/Platforms/Platform/ShortNameString

KMS controlled

Yes1For each platform provided, a short name is required.
ECHO 10/Collection/Platforms/Platform/LongNameStringKMS controlledNo0..1It is highly recommended that a long name be provided if one is available in KMS.
ECHO 10/Collection/Platforms/Platform/Characteristics/Characteristic/NameString
Yes1
ECHO 10/Collection/Platforms/Platform/Characteristics/Characteristic/DescriptionString
Yes1
ECHO 10/Collection/Platforms/Platform/Characteristics/Characteristic/DataType String
Yes1
ECHO 10/Collection/Platforms/Platform/Characteristics/Characteristic/UnitString
Yes1
ECHO 10/Collection/Platforms/Platform/Characteristics/Characteristic/ValueString
Yes1


Example Mapping

ECHO 10

<Platforms>
  <Platform>
    <Type>Earth Observation Satellites</Type>
    <ShortName>ICESat</ShortName>
    <LongName>Ice, Cloud and Land Elevation Satellite</LongName>
    <Characteristics>
      <Characteristic>
        <Name>OrbitInclination</Name>
        <Description>The angle between the orbit plane and the Earth's equatorial plane.</Description>
        <DataType>FLOAT</DataType>
        <Unit>Degrees</Unit>
        <Value>94.0</Value>
      </Characteristic>
    </Characteristics>
............
  </Platform>
</Platforms>

UMM

Platforms: [
  {
    Type: "Earth Observation Satellites",
    ShortName: "ICESat",
    LongName: "Ice, Cloud and Land Elevation Satellite",
    Characteristics: [
      {
        Name: "OrbitInclination",
        Description: "The angle between the orbit plane and the Earth's equatorial plane.",
        DataType: "FLOAT",
        Unit: "Degrees",
        Value: "94.0"
      }
    ]
    .............
  }
]



ISO 19115-2 MENDS

An unlimited amount of platform keywords may be listed (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.

SpecificationPathTypeNotes
ISO 19115-2 MENDS

/gmi:MI_Metadata/gmi:acquisitionInformation/gmi:MI_AcquisitionInformation/gmi:platform/eos:EOS_Platform/ gmd:description/gco:CharacterString

String


Corresponds to the UMM field Platform/Type. Values should be selected from the platform 'Category' keywords in KMS.

/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

Corresponds to the UMM field Platform/ShortName. A list of valid platform short names can be found in the KMS. 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.

/gmi:MI_Metadata/gmi:acquisitionInformation/gmi:MI_AcquisitionInformation/gmi:platform/eos:EOS_Platform/ gmi:identifier/gmd:MD_Identifier/gmd:description/gco:CharacterStringStringCorresponds to the UMM field Platform/LongName. A list of valid platform long names can be found in the KMS.
/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"=platformInformationCodelistThe "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.
/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:CharacterStringStringCorresponds to the UMM field Platform/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:description/gco:CharacterStringStringCorresponds to the UMM field Platform/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:dataType/eos:EOS_AdditionalAttributeDataTypeCode codeList="https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_DatatypeCode" codeListValue=<date type> value=<data type>Codelist

Corresponds to the UMM field Platform/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)

/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:CharacterStringStringCorresponds to the UMM field Platform/Characteristics/Unit.
/gmi:MI_Metadata/gmi:acquisitionInformation/gmi:MI_AcquisitionInformation/gmi:platform/eos:EOS_Platform/ /eos:otherProperty/gco:Record/eos:AdditionalAttributes/eos:AdditionalAttribute/eos:value/gco:CharacterStringStringCorresponds to the UMM field Platform/Characteristics/Value.


Example Mapping

ISO 19115-2 MENDS


UMM

Platforms: [
  {
    Type: "Earth Observation Satellites",
    ShortName: "ICESat",
    LongName: "Ice, Cloud and Land Elevation Satellite",
    Characteristics: [
      {
        Name: "OrbitInclination",
        Description: "The angle between the orbit plane and the Earth's equatorial plane.",
        DataType: "FLOAT",
        Unit: "Degrees",
        Value: "94.0"
      }
    ]
    .............
  }
]



ISO 19115-2 SMAP

An unlimited amount of platform keywords may be listed (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.

SpecificationPathTypeNotes
ISO 19115-2 SMAP

/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 &gt; )

StringKMS controlled. This is where the entire keyword hierarchy should be listed. Each keyword in the hierarchy must be separated by "&gt;"
ISO 19115-2 SMAP/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:descriptiveKeywords/gmd:MD_Keywords/gmd:keyword/ gmd:type/MD_KeywordTypeCode[@codeListValue="theme"]Codelist

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

ISO 19115-2 SMAP

 

UMM

Platforms: [
  {
    Type: "Earth Observation Satellites",
    ShortName: "ICESat",
    LongName: "Ice, Cloud and Land Elevation Satellite",
    Characteristics: [
      {
        Name: "OrbitInclination",
        Description: "The angle between the orbit plane and the Earth's equatorial plane.",
        DataType: "FLOAT",
        Unit: "Degrees",
        Value: "94.0"
      }
    ]
    .............
  }
]



UMM Migration

None


Future Mappings

ISO 19115-1

An unlimited amount of platform keywords may be listed (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.

SpecificationPathTypeNotes
ISO 19115-1


String

ISO 19115-1

 

UMM

Platforms: [
  {
    Type: "Earth Observation Satellites",
    ShortName: "ICESat",
    LongName: "Ice, Cloud and Land Elevation Satellite",
    Characteristics: [
      {
        Name: "OrbitInclination",
        Description: "The angle between the orbit plane and the Earth's equatorial plane.",
        DataType: "FLOAT",
        Unit: "Degrees",
        Value: "94.0"
      }
    ]
    .............
  }
]

History

UMM Versioning

VersionDateWhat Changed
1.0.0
Initial Release

ARC Documentation

VersionDateWhat ChangedAuthor
1.05/14/18Recommendations/priority matrix transferred from internal ARC documentation to wiki spaceJeanne' le Roux



  • No labels