Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
stylecircle

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

ModelElementTypeConstraintsRequired?CardinalityNotes
UMM-CShortNameString

1 - 85 characters

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

Lucidchart
rich-viewerfalse
autofittrue
nameCopy of Wiki Page Metadata Evaluation Workflow-1939-23c7a101
width1102
pages-to-display
id98e5dc28-3252-4209-953f-66f1378e1cf4
alignLeft
height299

Please see the expandable sections below for flowchart details.


Expand
titleGCMD Metadata QA/QC
  • 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.
Expand
titleCMR Validation
  • 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
Expand
titleARC Metadata QA/QC

ARC Priority Matrix

Priority CategorizationJustification

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 The Short Name is incorrect for the dataset.A recommendation is made to remove a Short Name since it does not exist in the GCMD. 

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

Expand
titleDIF 9

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

Expand
titleDIF 10

DIF 10

UMM-C ElementDIF 10 PathTypeConstraintsRequired in DIF 10?CardinalityNotes
ShortNameEntry_ID/Short_NameString85 maximum charactersYes1

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

Section
Column
width50%

DIF 10

No Format
<Entry_ID>
  <Short_Name>AIRX3STD</Short_Name>
  <Version>006</Version>
</Entry_ID>
Column
width50%

UMM

No Format
"ShortName" : "AIRX3STD",
"Version" : "006",
Expand
titleECHO 10

ECHO 10

UMM-C ElementPathTypeConstraintsRequired in ECHO10?CardinalityNotes
ShortName/Collection/ShortNameString
Yes1


Enumeration Mapping

N/A

Example Mapping

Section
Column
width50%

ECHO 10

No Format
<ShortName>AIRX3STD</ShortName>
<VersionId>006</VersionId>
Column
width50%

UMM

No Format
"ShortName" : "AIRX3STD",
"Version" : "006",



Expand
titleISO 19115-2 MENDS

ISO 19115-2 MENDS

UMM-C Element

ISO 19115-2 MENDS Path

TypeNotes
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

Section
Column
width50%

ISO 19115-2 MENDS

No Format
<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>
        ...
Column
width50%

UMM

No Format
"ShortName" : "AIRX3STD",
"Version" : "006",



Expand
titleISO 19115-2 SMAP

ISO 19115-2 SMAP

UMM-C ElementISO 19115-2 SMAP PathTypeNotes
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


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

Enumeration/Code List Mapping

N/A

Example Mapping

Section
Column
width50%

ISO 19115-2 SMAP

No Format
<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>
Column
width50%

UMM

No Format
"ShortName" : "AIRX3STD",
"Version" : "006",



UMM Migration

N/A

Excerpt
hiddentrue

Future Mappings

Expand
titleISO 19115-1

ISO 19115-1

UMM-C ElementISO 19115-1 PathType
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

Section
Column
width50%
No Format
<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>
Column
width50%
No Format
"ShortName" : "AIRX3STD",
"Version" : "006",

History

UMM Versioning

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

ARC Documentation

VersionDateWhat ChangedAuthor
1.004/06/2018Recommendations/priority matrix transferred from internal ARC documentation to wiki space