View Source

Element Description

The Short Name element contains an abbreviated name for a dataset. The Short Name and Version Id combination must be unique per provider in the CMR.

Best Practices

The Short Name is an abbreviated or shortened name used to identify a dataset. The Short Name, in combination with the Version Id, uniquely describe a metadata record in the CMR per data provider. While the Short Name can be used as a unique identifier for a dataset, it should never be the same as the dataset DOI.

The Data Product Development Guide for Data Producers offers the following information about Short Names:

"EOSDIS developed the standard Earth Science Data Type (ESDT) [50] naming conventions to provide
an efficient way to archive data products by name and for convenience in working with toolkits. The
short name is an abbreviated version of the product name. A limit of 30 characters is
recommended, where alphanumeric and “_” are the only acceptable characters. The restriction on
the usage of spaces and special characters is to ensure compatibility with Earthdata Search and
other search systems. The short name is included in the metadata as the global attribute
ShortName and included in the data product’s documentation. Data producers should contact the
DAAC responsible for the data product’s archiving to check if there are additional restrictions on
short names."

Examples:

"AIRIBQAP"

"gpmrgachiphx"

"FIFE_RAIN_30M_2"

Element Specification

Model	Element	Type	Constraints	Required?	Cardinality	Notes
UMM-C	ShortName	String	1 - 85 characters	Yes	1	The ShortName and Version together have to be unique per data provider.

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.
- Proof all content for conciseness and readability.
Automated Review
- Check that the field has been populated.
- Check that the field length is not greater than 85 characters.
- Check that the field value does not match the Entry Title.

This element is required
Must contain at least 1 character and be no longer than 85 characters in length
The ShortName together with the Version must be unique per data provider

ARC Priority Matrix

Priority Categorization	Justification
Red = High Priority Finding	This element is categorized as highest priority when: No Short Name is provided. The Short Name is identical to the Entry Title. The Short Name is identical to the DOI. The Short Name is incorrect for the dataset.
Yellow = Medium Priority Finding	Not Applicable
Blue = Low Priority Finding	Not Applicable
Green = No Findings/Issues	The element is provided and follows all applicable criteria specified in the best practices section above.

ARC Automated Checks

ARC uses the pyQuARC library for automated metadata checks. Please see the pyQuARC GitHub for more information.

Dialect Mappings

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

DIF 10

UMM-C Element	DIF 10 Path	Type	Constraints	Required in DIF 10?	Cardinality	Notes
ShortName	Entry_ID/Short_Name	String	85 maximum characters	Yes	1	DIF 10 Short_Name is a string. The Short_Name and Version Id must be unique for a provider.

Enumeration Mapping

N/A

Example Mapping

DIF 10

<Entry_ID>
  <Short_Name>AIRX3STD</Short_Name>
  <Version>006</Version>
</Entry_ID>

UMM

"ShortName" : "AIRX3STD",
"Version" : "006",

ECHO 10

UMM-C Element	Path	Type	Constraints	Required in ECHO10?	Cardinality	Notes
ShortName	/Collection/ShortName	String		Yes	1

Enumeration Mapping

N/A

Example Mapping

ECHO 10

<ShortName>AIRX3STD</ShortName>
<VersionId>006</VersionId>

UMM

"ShortName" : "AIRX3STD",
"Version" : "006",

ISO 19115-2 MENDS

UMM-C Element

ISO 19115-2 MENDS Path

Type

Notes

ShortName

/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/

gmd:identifier/gmd:MD_Identifier [=>

[=> /gmd:code/gco:CharacterString

and

[=> /gmd:codeSpace/gco:CharacterString = gov.nasa.esdis.umm.shortname

and

[=>/gmd:description/gco:CharacterString = Short Name

(CMR read only) If the gmd:code/gco:CharacterString doesn't exist look at gmd:code/gmx:Anchor.

String

Adding gco:CharacterString='Short Name' helps CMR identify the identifier.

Enumeration/Code List Mapping

N/A

Example Mapping

ISO 19115-2 MENDS

<gmi:MI_Metadata>
  ...
  <gmd:identificationInfo>
	<gmd:MD_DataIdentification>
	  <gmd:citation>
	    <gmd:CI_Citation>
        ...
          <gmd:edition>
            <gco:CharacterString>006</gco:CharacterString>
          </gmd:edition>
        ...
          <gmd:identifier>
           <gmd:MD_Identifier>
             <gmd:code>
               <gco:CharacterString>AIRX3STD</gco:CharacterString>
             </gmd:code>
             <gmd:codeSpace>
               <gco:CharacterString>gov.nasa.esdis.umm.shortname</gco:CharacterString>
             </gmd:codeSpace>
             <gmd:description>
               <gco:CharacterString>Short Name</gco:CharacterString>
             </gmd:description>
           </gmd:MD_Identifier>
          </gmd:identifier>
        ...

UMM

"ShortName" : "AIRX3STD",
"Version" : "006",

ISO 19115-2 SMAP

UMM-C Element

ISO 19115-2 SMAP Path

Type

Notes

ShortName

/gmd:DS_Series/gmd:seriesMetadata/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/

gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString
with
/gmd:DS_Series/gmd:seriesMetadata/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/

gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:description/gco:CharacterString = The ECS Short Name

String

Adding gco:CharacterString='The ECS Short Name' helps CMR identify the identifier.

Enumeration/Code List Mapping

N/A

Example Mapping

ISO 19115-2 SMAP

<gmd:DS_Series>
 <gmd:seriesMetadata>
  <gmi:MI_Metadata>
    ...
	<gmd:identificationInfo>
	  <gmd:MD_DataIdentification>
		<gmd:citation>
		  <gmd:CI_Citation>
          ...
            <gmd:identifier>
              <gmd:MD_Identifier>
                <gmd:code>
                  <gco:CharacterString>AIRX3STD</gco:CharacterString>
                </gmd:code>
                <gmd:codeSpace>
                  <gco:CharacterString>gov.nasa.esdis.umm.shortname</gco:CharacterString>
                </gmd:codeSpace>
                <gmd:description>
                  <gco:CharacterString>The ECS Short Name</gco:CharacterString>
                </gmd:description>
              </gmd:MD_Identifier>
             </gmd:identifier>
          ...
            <gmd:identifier>
              <gmd:MD_Identifier>
                <gmd:code>
                  <gco:CharacterString>006</gco:CharacterString>
                </gmd:code>
                <gmd:description>
                  <gco:CharacterString>The ECS Version ID</gco:CharacterString>
                </gmd:description>
              </gmd:MD_Identifier>
             </gmd:identifier>

        ...
		  <gmd:CI_Citation>
	    </gmd:citation>
        ...
	  </gmd:MD_DataIdentification>
	</gmd:identificationInfo>
    ...
  </gmi:MI_Metadata>
 </gmd:seriesMetadata>
</gmd:DS_Series>

UMM

"ShortName" : "AIRX3STD",
"Version" : "006",

UMM Migration

N/A

Future Mappings

ISO 19115-1

UMM-C Element

ISO 19115-1 Path

Type

ShortName

/mdb:MD_Metadata/mdb:identificationInfo/mri:MD_DataIdentification/mri:citation/

cit:CI_Citation/cit:identifier/mcc:MD_Identifier [=>

[=> /mcc:code/gco:CharacterString

[=>/mcc:codeSpace/gco:CharacterString=gov.nasa.esdis.umm.shortname

[=>/mcc:description/gco:CharacterString=Short Name

(CMR read only) If the mcc:code/gco:CharacterString doesn't exist look at mcc:code/gcx:Anchor.

String

Example Mapping

<mdb:MD_Metadata>
  ...
  <mdb:identificationInfo>
    <mri:MD_DataIdentification>
      <mri:citation>
        <cit:CI_Citation>  
          ... 
          <cit:edition>
            <gco:CharacterString>2.0</gco:CharacterString>
          </cit:edition>
          ...
         <cit:identifier>
           <mcc:MD_Identifier>
             <mcc:code>
               <gco:CharacterString>AIRX3STD</gco:CharacterString>
             </mcc:code>
             <mcc:codeSpace>
               <gco:CharacterString>gov.nasa.esdis.umm.shortname</gco:CharacterString>
             </mcc:codeSpace>
             <mcc:description>
               <gco:CharacterString>Short Name</gco:CharacterString>
             </mcc:description>
           </mcc:MD_Identifier>
          </cit:identifier>
        </cit:CI_Citation>
      </mri:citation>
      ...
    </mri:MD_DataIdentification>
  </mdb:identificationInfo>
  ...
</mdb:MD_Metadata>

"ShortName" : "AIRX3STD",
"Version" : "006",

History

UMM Versioning

Version	Date	What Changed
1.15.5	12/3/2020	No changes were made for Short Name during the transition from version 1.15.4 to 1.15.5
1.15.4	9/18/2020	No changes were made for Short Name during the transition from version 1.15.3 to 1.15.4
1.15.3	7/1/2020	No changes were made for Short Name during the transition from version 1.15.2 to 1.15.3
1.15.2	5/20/2020	No changes were made for Short Name during the transition from version 1.15.1 to 1.15.2
1.15.1	3/25/2020	No changes were made for Short Name during the transition from version 1.15.0 to 1.15.1
1.15.0	2/26/2020	No changes were made for Short Name during the transition from version 1.14.0 to 1.15.0
1.14.0	10/21/2019	No changes were made for Short Name during the transition from version 1.13.0 to 1.14.0
1.13.0	04/11/2019	No changes were made for Short Name during the transition from version 1.12.0 to 1.13.0
1.12.0	01/22/2019	No changes were made for Short Name during the transition from version 1.11.0 to 1.12.0.
1.11.0	11/28/2018	No changes were made for Short Name during the transition from version 1.10.0 to 1.11.0.
1.10.0	05/02/2018	No changes were made for Short Name during the transition from version 1.9.0 to 1.10.0.

ARC Documentation

Version	Date	What Changed	Author
1.0	04/06/2018	Recommendations/priority matrix transferred from internal ARC documentation to wiki space	Kaylin Bugbee