Metadata Requirements

This page provides an overview of the minimum metadata required for publication on ESS-DIVE. These requirements are used by the ESS-DIVE team to review datasets before approval for publication.

ESS-DIVE’s dataset metadata requirements allow you to fully describe your dataset so that others can more easily find and use relevant data from dataset searches. Metadata for each dataset submitted should meet the guidelines in the description of each field listed below, and metadata completeness will be assessed during the dataset publication process using both automated and manual review workflows. Ensuring that your dataset has complete metadata before requesting publication will expedite the publication process.

Dataset metadata fields marked with a red asterisk (*) are required to submit your dataset. All dataset metadata fields are reviewed using the requirements outlined in the Description of each field.

Controlled and Prohibited Information

ESS-DIVE will not accept any datasets that include controlled and prohibited information categories (section D.2), such as Protected Information (i.e., Personally Identifiable Information [PII] and Protected Health Information [PHI]).

Examples of Protected Information (PII and PHI)
  • Social Security numbers

  • Driver's license numbers

  • Health information with personal identifiers

  • The individual's past, present, or future physical or mental health or condition

See Section F. Definitions/Acronyms for a detailed list of examples.

JSON-LD Fields

Datasets that are created or edited using the Dataset API must use the JSON-LD schema. The JSON-LD rows indicates what each metadata field looks like in the JSON-LD schema.

Automated Checks

A set of automated checks are performed whenever a dataset is submitted. The results of these checks are compiled into an Assessment Report and used in the review process. Failed automated checks or warnings should be addressed by the dataset submitter before requesting publication.

Please note that assessment reports can take minutes, or up to 24 hours, to generate.

Working Offline? ESS-DIVE's Offline Metadata Template can be used to prepare your dataset metadata prior to submission. We recommend using the template to collaborate with your team members in Google Docs, then copying and pasting the completed fields into the ESS-DIVE Dataset Submission form when you are ready to create your dataset.

Overview

Title*

Existing DOI & Alternate Identifier

Abstract*

Keywords*

Data Variables

Publication Date

Usage Rights*

Project *

Online Form only

API Only

Funding Organization*

DOE Contracts

People

Contact*

Creators

Contributors

Dates

Start Date

End Date

Locations

Geographic Description

Bounding Box Coordinates

Methods

Methods

Additional Automated Checks

The below checks are run on each dataset upon submission as a part of the ESS-DIVE automated check suite. Informational checks appear on the assessment reports and are not pass/fail.

Last updated