Location Keywords

Element Description

Note: This page is a draft/ work in progress

The Location Keywords element contains keywords that characterize the study area/region where data was collected from. This allows users to narrow their searches to areas that suit their geographic interest. The Location Keywords are chosen from a controlled keyword hierarchy maintained in the Keyword Management System (KMS). A list of valid Location Keywords can be found here: https://gcmdservices.gsfc.nasa.gov/static/kms/locations/locations.csv ?

Best Practices

Location keywords specify areas where data was collected. The keywords can be chosen to classify broad study areas/regions or very specific places. However, it is suggested that location keywords are as specific as possible to aid in data discovery. At bare minimum, a location keyword/category is required in the hierarchy, which provides a general area of data collection. If a specific location keyword is not included in the KMS, a request to have it added can be made through the GCMD Keywords Community Forum.

Examples:

LocationKeywords/Category: "CONTINENT"

LocationKeywords/Topic: "NORTH AMERICA"

LocationKeywords/Subregion1: "UNITED STATES"

LocationKeywords/Subregion2: "ALABAMA"

LocationKeywords/Subregion3: "HUNTSVILLE"

LocationKeywords/DetailedLocation: "THE UNIVERSITY OF ALABAMA IN HUNTSVILLE"

LocationKeywords/Category: "CONTINENT"

LocationKeywords/Topic: "NORTH AMERICA"

LocationKeywords/Subregion1: "CANADA"

LocationKeywords/Subregion2: "ONTARIO"

LocationKeywords/Category: "GEOGRAPHIC REGION"

LocationKeywords/Topic: "TROPICS"

Element Specification

Location Keywords are required. An unlimited amount of Location Keywords may be provided (Cardinality: 1..*)

Model	Element	Type	Usable Valid Values	Constraints	Required?	Cardinality
UMM-C	LocationKeywords/Category	String	Location Category Keywords	KMS controlled	Yes	1
UMM-C	LocationKeywords/Type	String	Location Type Keywords	KMS controlled	No	0..1
UMM-C	LocationKeywords/Subregion1	String	Location Subregion_1 Keywords	KMS controlled	No	0..1
UMM-C	LocationKeywords/Subregion2	String	Location Subregion_2 Keywords	KMS controlled	No	0..1
UMM-C	LocationKeywords/Subregion3	String	Science Subregion_3 Keywords	KMS controlled	No	0..1
UMM-C	LocationKeywords/DetailedLocation	String		1 - 80 characters (Uncontrolled/Free-Text)	No	0..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.

GCMD Metadata QA/QC

Manual Review
- Identify errors, discrepancies or omissions.
- Verify that all pertinent keywords have been applied.
- Verify that existing facets and other controlled keyword values are consistent and suitable for the data.
Automated Review
- Check that the field has been populated.
- Check that the field is populated with a valid value from KMS.
- Check that the field value is not a duplicate.
- Check that the 'Detailed_Variable' field length is not greater than 80 characters.

ARC Metadata QA/QC

ARC Priority Matrix

Priority Categorization	Justification
	This element is categorized as highest priority when: The element is not included at all. The element is included but is empty. The location keyword does not align with the KMS. The location 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 Subregion 2 keyword is placed in the Subregion 1 field). The location keyword is not appropriate for the dataset.
	This element is categorized as medium priority when: A recommendation is made to add a relevant location 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
	The element is provided and follows all applicable criteria specified in the best practices section above.

ARC Automated Checks

Category
- If no value is provided, return is: "This is a required field. Recommend providing at least one science keyword hierarchy relevant to this data set. This field should contain the Category keyword as specified in the hierarchy (EARTH SCIENCE). Science keywords are GCMD controlled and should be chosen from the following list: https://gcmdservices.gsfc.nasa.gov/static/kms/sciencekeywords/sciencekeywords.csv?ed_wiki_keywords_page"
- If the provided value is in the incorrect position of the hierarchy, return is: "<provided value> is in the incorrect position of the project keyword hierarchy."
- If the provided value does not conform to GCMD, return is: "<provided value> does not conform to GCMD."
Topic
- If no value is provided, return is: "This is a required field. Recommend providing at least one science keyword hierarchy relevant to this data set. This field should contain the Topic keyword as specified in the hierarchy. Science keywords are GCMD controlled and should be chosen from the following list: https://gcmdservices.gsfc.nasa.gov/static/kms/sciencekeywords/sciencekeywords.csv?ed_wiki_keywords_page"
- If the provided value is in the incorrect position of the hierarchy, return is: "<provided value> is in the incorrect position of the project keyword hierarchy."
- If the provided value does not conform to GCMD, return is: "<provided value> does not conform to GCMD."
Term
- If no value is provided, return is: "This is a required field. Recommend providing at least one science keyword hierarchy relevant to this data set. This field should contain the Term keyword as specified in the hierarchy. Science keywords are GCMD controlled and should be chosen from the following list: https://gcmdservices.gsfc.nasa.gov/static/kms/sciencekeywords/sciencekeywords.csv?ed_wiki_keywords_page"
- If the provided value is in the incorrect position of the hierarchy, return is: "<provided value> is in the incorrect position of the project keyword hierarchy."
- If the provided value does not conform to GCMD, return is: "<provided value> does not conform to GCMD."
Variable Level 1 - Variable Level 3
- If no value is provided, return is "np"
- If the provided value is in the incorrect position of the hierarchy, return is: "<provided value> is in the incorrect position of the project keyword hierarchy."
- If the provided value does not conform to GCMD, return is: "<provided value> does not conform to GCMD."
Detailed Variable
- If no value is provided, return is "np"
- If a value is provided, return is "OK"

CMR Validation

<>

Dialect Mappings

DIF 9

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

DIF 10

Science_Keywords are required. An unlimited amount of Science Keywords may be provided (Cardinality: 1..*)

Specification	Path	Type	Constraints	Required in DIF 10?	Cardinality
DIF 10	/DIF/Location_Keywords/Category	String	KMS controlled	Yes	1
DIF 10	/DIF/Location_Keywords/Type	String	KMS controlled	No	0..1
DIF 10	/DIF/Science_Keywords/Subregion_1	String	KMS controlled	No	0..1
DIF 10	/DIF/Science_Keywords/Subregion_2	String	KMS controlled	No	0..1
DIF 10	/DIF/Science_Keywords/Subregion_3	String	KMS controlled	No	0..1
DIF 10	/DIF/Science_Keywords/Detailed_Location	String	1 - 80 characters (Uncontrolled/Free-Text)	No	0..1

Example Mapping

DIF 10

<Location_Keywords>
  <Category>CONTINENT</Category>
  <Type>NORTH AMERICA</Type>
  <Subregion_1>UNITED STATES</Subregion_1>
  <Subregion_2>ALBAMA</Subregion_2>
  <Subregion_3>HUNTSVILLE</Subregion_3>
  <Detailed_Location>THE UNIVERSITY OF ALABAMA IN HUNTSVILLE</Detailed_Location>
</Location_Keywords>
<Location_Keywords>
  <Category>CONTINENT</Category>
  <Type>NORTH AMERICA</Type>
  <Subregion_1>CANADA</Subregion_1>
  <Subregion_2>ONTARIO</Subregion_2>
</Location_Keywords>

UMM

ScienceKeywords: [
  {
    Category: "EARTH SCIENCE",
    Topic: "BIOSPHERE",
    Term: "VEGETATION",
    VariableLevel1: "VEGETATION INDEX"
    VariableLevel2: "NORMALIZED DIFFERENCE VEGETATION INDEX (NDVI)"
    DetailedVariable: "0.9 DENSITY"
  },
  {
    Category: "EARTH SCIENCE",
    Topic: "BIOSPHERE",
    Term: "VEGETATION",
    VariableLevel1: "EVERGREEN VEGETATION"
  }
],

ECHO 10

Science Keywords are required. An unlimited amount of Science Keywords may be provided (Cardinality: 1..*)

Specification	Path	Type	Constraints	Required in ECHO10?	Cardinality	Notes
ECHO 10	/Collection/ScienceKeywords/ScienceKeyword/CategoryKeyword	String	KMS controlled	Yes	1	The category keyword will always be "EARTH SCIENCE"
ECHO 10	/Collection/ScienceKeywords/ScienceKeyword/TopicKeyword	String	KMS controlled	Yes	1
ECHO 10	/Collection/ScienceKeywords/ScienceKeyword/TermKeyword	String	KMS controlled	Yes	1
ECHO 10	/Collection/ScienceKeywords/ScienceKeyword/VariableLevel1Keyword/Value	String	KMS controlled	No	0..1
ECHO 10	/Collection/ScienceKeywords/ScienceKeyword/VariableLevel1Keyword/VariableLevel2Keyword/Value	String	KMS controlled	No	0..1
ECHO 10	/Collection/ScienceKeywords/ScienceKeyword/VariableLevel1Keyword/VariableLevel2Keyword/VariableLevel3Keyword/Value	String	KMS controlled	No	0..1
ECHO 10	/Collection/ScienceKeywords/ScienceKeyword/DetailedVariableKeyword	String	Uncontrolled (Free-Text)	No	0..1

Example Mapping

ECHO 10

<ScienceKeyword>
  <CategoryKeyword>EARTH SCIENCE</CategoryKeyword> 
  <TopicKeyword>BIOSPHERE</TopicKeyword> 
  <TermKeyword>VEGETATION</TermKeyword> 
  <VariableLevel1Keyword>
    <Value>VEGETATION INDEX</Value>
      <VariableLevel2Keyword>
        <Value>NORMALIZED DIFFERENCE VEGETATION INDEX (NDVI)</Value>
      </VariableLevel2Keyword>
  </VariableLevel1Keyword>
  <DetailedVariableKeyword>0.9 DENSITY</DetailedVariableKeyword>
</ScienceKeyword>
<ScienceKeyword>
  <CategoryKeyword>EARTH SCIENCE</CategoryKeyword> 
  <TopicKeyword>BIOSPHERE</TopicKeyword> 
  <TermKeyword>VEGETATION</TermKeyword> 
  <VariableLevel1Keyword>
    <Value>EVERGREEN VEGETATION</Value>
  </VariableLevel1Keyword>
</ScienceKeyword>

UMM

ScienceKeywords: [
  {
    Category: "EARTH SCIENCE",
    Topic: "BIOSPHERE",
    Term: "VEGETATION",
    VariableLevel1: "VEGETATION INDEX"
    VariableLevel2: "NORMALIZED DIFFERENCE VEGETATION INDEX (NDVI)"
    DetailedVariable: "0.9 DENSITY"
  },
  {
    Category: "EARTH SCIENCE",
    Topic: "BIOSPHERE",
    Term: "VEGETATION",
    VariableLevel1: "EVERGREEN VEGETATION"
  }
],

ISO 19115-2 MENDS

Science Keywords are required. An unlimited amount of Science Keywords may be provided (Cardinality: 1..*)

Specification

Path

Type

Notes

ISO 19115-2 MENDS

/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 ">". If any keyword is missing and there exists a keyword later in the hierarchy (such as DetailedLocation), use NONE to fill in the values in between. The CMR will not translate the NONE values they are only used to place each keyword in its correct space in the hierarchy.

/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 MENDS

...
<gmd:identificationInfo>
  <gmd:MD_DataIdentification>
    <gmd:descriptiveKeywords>
      <gmd:MD_Keywords>
        <gmd:keyword>
          <gco:CharacterString>EARTH SCIENCE&gt;BIOSPHERE&gt;VEGETATION&gt;VEGETATION INDEX&gt;NORMALIZED DIFFERENCE VEGETATION INDEX (NDVI)&gt;NONE&gt;0.9 DENSITY</CharacterString>
        </gmd:keyword>
        <gmd:keyword>
          <gco:CharacterString>EARTH SCIENCE&gt;BIOSPHERE&gt;VEGETATION&gt;EVERGREEN VEGETATION</CharacterString>
        </gmd:keyword>
        <gmd:type>
          <gmd:MD_KeywordTypeCode codeList="https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_KeywordTypeCode" codeListValue="theme">theme</gmd:MD_KeywordTypeCode>
        </gmd:type>
      </gmd:MD_Keywords> 
    </gmd:descriptiveKeywords>
  </gmd:MD_DataIdentification>
</gmd:identificationInfo>
...

UMM

ScienceKeywords: [
  {
    Category: "EARTH SCIENCE",
    Topic: "BIOSPHERE",
    Term: "VEGETATION",
    VariableLevel1: "VEGETATION INDEX"
    VariableLevel2: "NORMALIZED DIFFERENCE VEGETATION INDEX (NDVI)"
    DetailedVariable: "0.9 DENSITY"
  },
  {
    Category: "EARTH SCIENCE",
    Topic: "BIOSPHERE",
    Term: "VEGETATION",
    VariableLevel1: "EVERGREEN VEGETATION"
  }
],

ISO 19115-2 SMAP

Science Keywords are required. An unlimited amount of Science Keywords may be provided (Cardinality: 1..*)

Specification

Path

Type

Notes

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 > )

String

KMS controlled. This is where the entire keyword hierarchy should be listed. Each keyword in the hierarchy must be separated by ">". If any keyword is missing and there exists a keyword later in the hierarchy (such as DetailedLocation), use NONE to fill in the values in between. The CMR will not translate the NONE values they are only used to place each keyword in its correct space in the hierarchy.

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

...
<gmd:identificationInfo>
  <gmd:MD_DataIdentification>
    <gmd:descriptiveKeywords>
      <gmd:MD_Keywords>
        <gmd:keyword>
          <gco:CharacterString>EARTH SCIENCE&gt;BIOSPHERE&gt;VEGETATION&gt;VEGETATION INDEX&gt;NORMALIZED DIFFERENCE VEGETATION INDEX (NDVI)&gt;NONE&gt;0.9 DENSITY</CharacterString>
        </gmd:keyword>
        <gmd:keyword>
          <gco:CharacterString>EARTH SCIENCE&gt;BIOSPHERE&gt;VEGETATION&gt;EVERGREEN VEGETATION</CharacterString>
        </gmd:keyword>
        <gmd:type>
          <gmd:MD_KeywordTypeCode codeList="https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_KeywordTypeCode" codeListValue="theme">theme</gmd:MD_KeywordTypeCode>
        </gmd:type>
      </gmd:MD_Keywords> 
    </gmd:descriptiveKeywords>
  </gmd:MD_DataIdentification>
</gmd:identificationInfo>
...

UMM

ScienceKeywords: [
  {
    Category: "EARTH SCIENCE",
    Topic: "BIOSPHERE",
    Term: "VEGETATION",
    VariableLevel1: "VEGETATION INDEX"
    VariableLevel2: "NORMALIZED DIFFERENCE VEGETATION INDEX (NDVI)"
    DetailedVariable: "0.9 DENSITY"
  },
  {
    Category: "EARTH SCIENCE",
    Topic: "BIOSPHERE",
    Term: "VEGETATION",
    VariableLevel1: "EVERGREEN VEGETATION"
  }
],

UMM Migration

None

Future Mappings

ISO 19115-1

Science Keywords are required. An unlimited amount of Science Keywords may be provided (Cardinality: 1..*)

Specification

Path

Type

Notes

ISO 19115-1

/mdb:MD_Metadata/mdb:identificationInfo/mri:MD_DataIdentification/mri:descriptiveKeywords/

mri:MD_Keywords/mri: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 ">". If any keyword is missing and there exists a keyword later in the hierarchy (such as DetailedLocation), use NONE to fill in the values in between. The CMR will not translate the NONE values they are only used to place each keyword in its correct space in the hierarchy.

ISO 19115-1

/mdb:MD_Metadata/mdb:identificationInfo/mri:MD_DataIdentification/mri:descriptiveKeywords/

mri:MD_Keywords/mri:keyword/mri:type/mri:MD_KeywordTypeCode[@codeListValue="theme"]

Codelist

codeList=http://standards.iso.org/iso/19115/resources/Codelist/cat/codelists.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.

ISO 19115-1

...    
    <mdb:identificationInfo>
        <mri:MD_DataIdentification>

            <mri:descriptiveKeywords>
                <mri:MD_Keywords>
                    <mri:keyword>
                        <gco:CharacterString>EARTH SCIENCE&gt;BIOSPHERE&gt;VEGETATION&gt;VEGETATION INDEX&gt;NORMALIZED DIFFERENCE VEGETATION INDEX (NDVI)&gt;NONE&gt;0.9 DENSITY</gco:CharacterString>
                    </mri:keyword>
                    <mri:keyword>
                        <gco:CharacterString>EARTH SCIENCE&gt;BIOSPHERE&gt;VEGETATION&gt;EVERGREEN VEGETATION</gco:CharacterString>
                    </mri:keyword>
                    <mri:type>
                        <mri:MD_KeywordTypeCode
                            codeList="http://standards.iso.org/iso/19115/resources/Codelist/cat/codelists.xml#MD_KeywordTypeCode"
                            codeListValue="MD_KeywordTypeCode_theme">theme</mri:MD_KeywordTypeCode>
                    </mri:type>
                </mri:MD_Keywords>
            </mri:descriptiveKeywords>
         </mri:MD_DataIdentification>
    </mdb:identificationInfo>       
...

UMM

ScienceKeywords: [
  {
    Category: "EARTH SCIENCE",
    Topic: "BIOSPHERE",
    Term: "VEGETATION",
    VariableLevel1: "VEGETATION INDEX"
    VariableLevel2: "NORMALIZED DIFFERENCE VEGETATION INDEX (NDVI)"
    DetailedVariable: "0.9 DENSITY"
  },
  {
    Category: "EARTH SCIENCE",
    Topic: "BIOSPHERE",
    Term: "VEGETATION",
    VariableLevel1: "EVERGREEN VEGETATION"
  }
],

History

UMM Versioning

Version	Date	What Changed
1.10.0	5/2/2018	No changes were made to Science Keywords in the transition from UMM Version 1.9.0 to 1.10.0
1.9.0

ARC Documentation

Version	Date	What Changed	Author
1.0	5/4/18	Recommendations/priority matrix transferred from internal ARC documentation to wiki space	Jeanne' le Roux

Page tree

Location Keywords

Element Description

Best Practices

Element Specification

Metadata Validation and QA/QC

DIF 10

ECHO 10

ISO 19115-2 MENDS

ISO 19115-2 SMAP

UMM Migration

ISO 19115-1

History

UMM Versioning

ARC Documentation