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 44 Current »

Element Description

The Location Keywords element contains keywords that characterize the study area/region where data was collected. 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://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/locations?format=csv

Best Practices

Location Keywords identify areas where data collection occurred, and are provided in a hierarchical structure. 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. Providing a Location Keyword is optional. If provided, the top level of the Location Keyword hierarchy must be provided (at a minimum). If a specific location keyword is not already 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/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

Providing a Location Keyword is optional. Multiple Location Keywords may be provided, if necessary (Cardinality: 0..*).

ModelElementTypeUsable Valid ValuesConstraintsRequired?CardinalityNotes
UMM-CLocationKeywords/CategoryStringLocation Category Keywords

KMS controlled

Yes, if applicable1If a Location Keyword is included in the metadata (it's optional), then a Category keyword must be provided at a minimum.
UMM-CLocationKeywords/TypeStringLocation Type KeywordsKMS controlled
No0..1
UMM-CLocationKeywords/Subregion1StringLocation Subregion1 KeywordsKMS controlledNo0..1
UMM-CLocationKeywords/Subregion2StringLocation Subregion2 KeywordsKMS controlledNo0..1
UMM-CLocationKeywords/Subregion3String

Location Subregion3 Keywords

KMS controlledNo0..1
UMM-CLocationKeywords/DetailedLocationStringn/a

1 - 80 characters

(Uncontrolled/Free-Text)

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
    • 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.
  • If this element is used, every location keyword must have at least the category sub-element populated.
  • All location keyword sub elements except for DetailedLocation must be valid according to the keyword management system.

ARC Priority Matrix

Priority CategorizationJustification

This element is categorized as highest priority when:

  • 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 to an existing keyword in the metadata (i.e. to extend a keyword hierarchy down to a more detailed keyword).

This element is categorized as low priority when:

  • A recommendation is made to add a relevant location keyword to the metadata.

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

ARC Automated Checks

  • Category
    • 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."
  • Type
    • 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."
  • Subregion
    • 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 Location
    • If no value is provided, return is "np"
    • If a value is provided, return is "OK"

Dialect Mappings

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

DIF 10

Providing a Location is optional. Multiple Locations may be provided, if necessary (Cardinality: 0..*).

UMM-C ElementDIF 10 PathTypeUsable Valid ValuesConstraintsRequired in DIF 10?CardinalityNotes
LocationKeywords/Category

Location/Location_Category

String

Location Category KeywordsKMS controlled

Yes, if applicable

1

If a Location is included in the metadata (it's optional), then a Location_Category must be provided at a minimum.

LocationKeywords/TypeLocation/Location_Type
StringLocation Type Keywords

KMS controlled

No0..1
LocationKeywords/Subregion1Location/Location_Subregion1StringLocation Subregion1 Keywords

KMS controlled

No0..1
LocationKeywords/Subregion2Location/Location_Subregion2StringLocation Subregion2 KeywordsKMS controlledNo0..1
LocationKeywords/Subregion3Location/Location_Subregion3StringLocation Subregion3 KeywordsKMS controlledNo0..1
LocationKeywords/DetailedLocationLocation/Detailed_LocationStringn/a1 - 80 characters (Uncontrolled/Free-Text)No0..1


Example Mapping

DIF 10

<Location>
  <Location_Category>CONTINENT</Location_Category>
  <Location_Type>NORTH AMERICA</Location_Type>
  <Location_Subregion1>UNITED STATES</Location_Subregion1>
  <Location_Subregion2>ALBAMA</Location_Subregion2>
  <Detailed_Location>THE UNIVERSITY OF ALABAMA IN HUNTSVILLE</Detailed_Location>
</Location>
<Location>
  <Location_Category>CONTINENT</Location_Category>
  <Location_Type>NORTH AMERICA</Location_Type>
  <Location_Subregion1>CANADA</Location_Subregion1>
  <Location_Subregion2>ONTARIO</Location_Subregion2>
</Location>

UMM

LocationKeywords: [
  {
    Category: "CONTINENT",
    Type: "NORTH AMERICA",
    Subregion1: "UNITED STATES",
    Subregion2: "ALABAMA",
    DetailedLocation: "THE UNIVERSITY OF ALABAMA IN HUNTSVILLE"
  },
  {
    Category: "CONTINENT",
    Type: "NORTH AMERICA",
    Subregion1: "CANADA",
    Subregion2: "ONTARIO"
  }
],

ECHO 10

Providing a Spatial Keyword is optional. Multiple Spatial Keywords may be provided, if necessary (Cardinality: 0..*).

UMM-C ElementECHO 10 PathTypeUsable Valid ValuesConstraintsRequired in ECHO10?CardinalityNotes

LocationKeywords/Category

LocationKeywords/Type

LocationKeywords/Subregion1

LocationKeywords/Subregion2

LocationKeywords/Subregion3

LocationKeywords/DetailedLocation

/Collection/SpatialKeywords/KeywordStringAny GCMD Location Keyword

KMS controlled

No0..*ECHO 10 only has 1 field for spatial keywords. Therefore, a keyword from any position in the GCMD location keyword hierarchy can be provided in this field. If a value is provided that is not in the keyword list, then it will map to Location Category Keyword "OTHER" followed by a Location Type Keyword of the unique value in the UMM (see mapping example below, where the spatial keyword 'THE UNIVERSITY OF ALABAMA IN HUNTSVILLE' is not included in the GCMD location keyword list.)


Example Mapping

ECHO 10

<SpatialKeywords>
  <Keyword>ONTARIO</Keyword> 
  <Keyword>THE UNIVERSITY OF ALABAMA IN HUNTSVILLE</Keyword>
</SpatialKeywords>

UMM

LocationKeywords: 
  {
    Category: "CONTINENT",
    Type: "NORTH AMERICA",
    Subregion1: "CANADA",
    Subregion2: "ONTARIO"
  }
  {
    Category: "OTHER",
    Type: "THE UNIVERSITY OF ALABAMA IN HUNTSVILLE"
  },
],



ISO 19115-2 MENDS

Providing a Location Keyword is optional. Multiple Location Keywords may be provided, if necessary (Cardinality: 0..*).

UMM-C Element

ISO 19115-2 MENDS Path

TypeNotes

LocationKeywords/Category

LocationKeywords/Type

LocationKeywords/Subregion1

LocationKeywords/Subregion2

LocationKeywords/Subregion3

LocationKeywords/DetailedLocation

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

String


KMS controlled. Valid Location Keywords can be found here: https://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/locations?format=csv

This is where the entire keyword hierarchy should be listed. Each keyword in the hierarchy must be separated by "&gt;". 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 as 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:type/MD_KeywordTypeCode


codeList="https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_KeywordTypeCode" codeListValue="place"

Codelist

codeList=https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_KeywordTypeCode

Select the value "place" from the codelist. This codelist value does not directly map to a UMM element; choosing "place" indicates to CMR that the provided value should be mapped to 'Location Keywords'.


Example Mapping

ISO 19115-2 MENDS

<gmi:MI_Metadata>
  ...
  <gmd:identificationInfo>
    <gmd:MD_DataIdentification>
      ...
      <gmd:descriptiveKeywords>
        <gmd:MD_Keywords>
          <gmd:keyword>
            <gco:CharacterString>CONTINENT&gt;NORTH AMERICA&gt;UNITED STATES&gt;ALABAMA&gt;NONE&gt;THE UNIVERSITY OF ALABAMA IN HUNTSVILLE</CharacterString>
          </gmd:keyword>
          <gmd:keyword>
            <gco:CharacterString>CONTINENT&gt;NORTH AMERICA&gt;CANADA&gt;ONTARIO</CharacterString>
          </gmd:keyword>
          <gmd:type>
            <gmd:MD_KeywordTypeCode codeList="https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_KeywordTypeCode" codeListValue="place">place</gmd:MD_KeywordTypeCode>
          </gmd:type>
        </gmd:MD_Keywords> 
      </gmd:descriptiveKeywords>
      ...
    </gmd:MD_DataIdentification>
  </gmd:identificationInfo>
  ...
</gmi:MI_Metadata>

UMM

LocationKeywords: [
  {
    Category: "CONTINENT",
    Type: "NORTH AMERICA",
    Subregion1: "UNITED STATES",
    Subregion2: "ALABAMA"
    DetailedLocation: "THE UNIVERSITY OF ALABAMA IN HUNTSVILLE"
  },
  {
    Category: "CONTINENT",
    Type: "NORTH AMERICA",
    Subregion1: "CANADA",
    Subregion2: "ONTARIO"
  }
],



ISO 19115-2 SMAP

Providing a Location Keyword is optional. Multiple Location Keywords may be provided, if necessary (Cardinality: 0..*).

UMM-C Element

ISO 19115-2 SMAP Path

TypeNotes

LocationKeywords/Category

LocationKeywords/Type

LocationKeywords/Subregion1

LocationKeywords/Subregion2

LocationKeywords/Subregion3

LocationKeywords/DetailedLocation

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

String

KMS controlled. Valid Location Keywords can be found here: https://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/locations?format=csv

This is where the entire keyword hierarchy should be listed. Each keyword in the hierarchy must be separated by "&gt;". 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 as they are only used to place each keyword in its correct space in the hierarchy.


/gmd:DS_Series/gmd:seriesMetadata/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:descriptiveKeywords/ gmd:MD_Keywords/gmd:type/MD_KeywordTypeCode

codeList="https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_KeywordTypeCode" codeListValue="place"

Codelist

codeList=https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_KeywordTypeCode

Select the value "place" from the codelist. This codelist value does not directly map to a UMM element; choosing "place" indicates to CMR that the provided value should be mapped to 'Location Keywords'.


Example Mapping

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>CONTINENT&gt;NORTH AMERICA&gt;UNITED STATES&gt;ALABAMA&gt;NONE&gt;THE UNIVERSITY OF ALABAMA IN HUNTSVILLE</CharacterString>
              </gmd:keyword>
              <gmd:keyword>
                <gco:CharacterString>CONTINENT&gt;NORTH AMERICA&gt;CANADA&gt;ONTARIO</CharacterString>
              </gmd:keyword>
              <gmd:type>
                <gmd:MD_KeywordTypeCode codeList="https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_KeywordTypeCode" codeListValue="place">place</gmd:MD_KeywordTypeCode>
              </gmd:type>
            </gmd:MD_Keywords> 
          </gmd:descriptiveKeywords>
          ...
        </gmd:MD_DataIdentification>
      </gmd:identificationInfo>
      ...
    </gmi:MI_Metadata>
  </gmd:seriesMetadata>
</gmd:DS_Series>

UMM

LocationKeywords: [
  {
    Category: "CONTINENT",
    Type: "NORTH AMERICA",
    Subregion1: "UNITED STATES",
    Subregion2: "ALABAMA"
    DetailedLocation: "THE UNIVERSITY OF ALABAMA IN HUNTSVILLE"
  },
  {
    Category: "CONTINENT",
    Type: "NORTH AMERICA",
    Subregion1: "CANADA",
    Subregion2: "ONTARIO"
  }
],



UMM Migration

None

Future Mappings

ISO 19115-1

Providing a Location Keyword is optional. Multiple Location Keywords may be provided, if necessary (Cardinality: 0..*).

UMM-C Element

ISO 19115-1 Path

TypeNotes

LocationKeywords/Category

LocationKeywords/Type

LocationKeywords/Subregion1

LocationKeywords/Subregion2

LocationKeywords/Subregion3

LocationKeywords/DetailedLocation

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

String

KMS controlled. Valid Location Keywords can be found here: https://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/locations?format=csv

This is where the entire keyword hierarchy should be listed. Each keyword in the hierarchy must be separated by "&gt;". 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 as they are only used to place each keyword in its correct space in the hierarchy.


/mdb:MD_Metadata/mdb:identificationInfo/mri:MD_DataIdentification/mri:descriptiveKeywords/mri:MD_Keywords/ mri:type/mri:MD_KeywordTypeCode

codeList="https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_KeywordTypeCode" codeListValue="place"

Codelist

codeList=https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_KeywordTypeCode

Select the value "place" from the codelist. This codelist value does not directly map to a UMM element; choosing "place" indicates to CMR that the provided value should be mapped to 'Location Keywords'.

Example Mapping

ISO 19115-1

<mdb:MD_Metadata>
  ...
  <mdb:identificationInfo>
    <mri:MD_DataIdentification>
      ...
      <mri:descriptiveKeywords>
        <mri:MD_Keywords>
          <mri:keyword>
            <gco:CharacterString>CONTINENT&gt;NORTH AMERICA&gt;UNITED STATES&gt;ALABAMA&gt;NONE&gt;THE UNIVERSITY OF ALABAMA IN HUNTSVILLE</CharacterString>
          </mri:keyword>
          <mri:keyword>
            <gco:CharacterString>CONTINENT&gt;NORTH AMERICA&gt;CANADA&gt;ONTARIO</CharacterString>
          </mri:keyword>
          <mri:type>
            <mri:MD_KeywordTypeCode codeList="https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#MD_KeywordTypeCode" codeListValue="place">place</gmd:MD_KeywordTypeCode>
          </mri:type>
        </mri:MD_Keywords>
      </mri:descriptiveKeywords>
      ...
    </mri:MD_DataIdentification>
  </mdb:identificationInfo>
  ...
</mdb:MD_Metadata>

UMM

LocationKeywords: [
  {
    Category: "CONTINENT",
    Type: "NORTH AMERICA",
    Subregion1: "UNITED STATES",
    Subregion2: "ALABAMA"
    DetailedLocation: "THE UNIVERSITY OF ALABAMA IN HUNTSVILLE"
  },
  {
    Category: "CONTINENT",
    Type: "NORTH AMERICA",
    Subregion1: "CANADA",
    Subregion2: "ONTARIO"
  }
],

History

UMM Versioning

VersionDateWhat Changed
1.15.512/3/2020No changes were made for Location Keywords during the transition from version 1.15.4 to 1.15.5
1.15.49/18/2020No changes were made for Location Keywords during the transition from version 1.15.3 to 1.15.4
1.15.37/1/2020No changes were made for Location Keywords during the transition from version 1.15.2 to 1.15.3
1.15.25/20/2020No changes were made for Location Keywords during the transition from version 1.15.1 to 1.15.2
1.15.13/25/2020No changes were made for Location Keywords during the transition from version 1.15.0 to 1.15.1
1.15.02/26/2020No changes were made for Location Keywords during the transition from version 1.14.0 to 1.15.0
1.14.010/21/2019No changes were made for Location Keywords during the transition from version 1.13.0 to 1.14.0
1.13.004/11/2019No changes were made for Location Keywords during the transition from version 1.12.0 to 1.13.0
1.12.001/22/2019No changes were made for Location Keywords during the transition from version 1.11.0 to 1.12.0
1.11.011/28/2018No changes were made for Location Keywords during the transition from version 1.10.0 to 1.11.0
1.10.005/02/2018No changes were made for Location Keywords during the transition from version 1.9.0 to 1.10.0

ARC Documentation

VersionDateWhat ChangedAuthor
1.002/01/2018Recommendations/priority matrix transferred from internal ARC documentation to wiki spaceJeanne' le Roux



  • No labels