Adding Metadata to EDG for EPA Public Access


Adding Metadata to EDG for EPA
Public Access
Version 1, April 2019
Instructions
This document guides extramural authors through the process of uploading a dataset to
the EPA's dataset metadata repository, the Environmental Dataset Gateway (EDG).
This is intended to help extramural authors fulfill their public access requirement.
The information gathered by the EDG is the metadata (a description of the data) for the
underlying data that supports the scientific, peer reviewed publication. EDG does NOT
collect the data itself.
Table of Contents
Instructions	1
Using the EPA Open Data Metadata Editor	2
Mandatory and Optional Fields	2
Editor Instructions and Assistance	3
Saving Your Form	4
Loading a Saved Form	6
Submitting Your Form	8
Edits After Submission	9
Appendix A: Sample of a Completed Form	10

-------
Adding Metadata to EDG for EPA Public Access
Using the EPA Open Data Metadata Editor
Extramural authors use the EPA Open Data Metadata Editor to submit their metadata to
the EDG. They can access the editor at: https://edg.epa.gov/epa-open-data-metadata-
editor/.
Mandatory and Optional Fields
Each empty field in the editor is designated as either mandatory or optional.
Publisher Email
Mandatory Field
Please enter the em
Distribution
itaset
Optional Field
+ ADD A DISTRIE
Once you begin filling in a field and navigate away, the field will verify if your entry is
valid or invalid.
^ EPA Contact Email
Please enter EPA conlacl
test@gmail.com
Q Title
Valid Entry
Please enter a title for the
Metadata
Invalid Entry
Page 2

-------
Adding Metadata to EDG for EPA Public Access
Editor Instructions and Assistance
The EPA Open Data Metadata Editor provides up-to-date instructions for each field in
the form. You can assess these instructions by selecting the heading of each form field,
as shown below.
Q Title
v
Please enter a title for the datase^^^
Metadata

Select the Field's Heading
Q Title
Please enter a title for the dataset
Metadata
Instructions display below the field heading.
{Subject, Geographic Extent, Relevant Time Period, Data Owner/Provider, Office/Region/Research Lab of Data
Owner}
Any individual component of this title template may be omitted if not applicable. For example, there is no need to include a date if data are
frequently or continuously updated. Similarly, if the geographic extent is implicit in the subject, i.e. National Hydrography Dataset, it may be
omitted provided that the actual extent of the data matches the extent implied in the title (an example of a dataset whose actual extent does not
match the implicitly titled extent would be National Hydrography Dataset clipped to a given state). Geographic Extent should always refer to a
place name, not a bounding box or coordinates.
Definition: Human-readable name of the dataset. Should be in plain English and include sufficient detail to facilitate search and discovery.
Guidance:
Titles should be succinct yet descriptive including the topic, and where relevant, temporal info, geography and related programs in a way that
distinguishes it from other, similar resources. To this end, EPA recommends the following template:
If the data is associated with a specific journal article, rather than published for general use, the title may reference that journal article, with
additional details on individual datasets provided in the distribution section.
You need to provide a non-trivial value.
In addition to the form instructions, the table below contains a few other details that may
be helpful about some of the form fields.
Field Name
Details
Distribution Section
This field lets you document each URL where the metadata,
or parts of the metadata, are stored. If you have one URL
that stores two different formats of the metadata (for
example CSV and Excel), you need to create separate
entries for each format.
Keywords Fields
There are four keyword fields in the form. Each form must
have at least:
• One keyword for the Place Keywords field
• One keyword for the ISO Keywords field
Page 3

-------
Adding Metadata to EDG for EPA Public Access

• One keyword for the EPA Keywords field
• Three keywords for the General Keywords field
Place, ISO, and EPA Keyword fields must be entered by
using the drop-down menus. However, the General
Keywords must be typed in.
Temporal Extent
This refers to the time period when the data was collected or
gathered. There isn't an automatic calendar for this field.
You can type in the dates.
Update Frequency
This field has two parts to it. First, there is a text field where
you type a number. Second, there is a drop-down list where
you select the appropriate period of time. For example: 2
years.
If you find you need additional assistance, please contact the EPA EDG team.
Saving Your Form
If you cannot complete the form in one visit, you can save the work you have done and
return later.
To save your form:
1. In the top left of the window, select the EPA icon.
^ EPA Open Data Metadata Editor
for extramural researchers
Welcome to the E
Select the Icon
ural Researchers in support of EPA's initiative

This tool allows extramural researchers to author, save, and submit metadata records for non-geospati
Technical Specification. If you wish to submit metadata for geospatial data, please contact the EPA EDGlSSro f&ij
Each element has a corresponding status: A Mandatory (empty), © Optional (empty), Invalid, and Valid,
are available by clicking each element's status icon.
Use the blue button at the upper left to save, view or load existing records. The red button at the lower right will'turn green when a record has"pafsfcjJ
validation tests and is ready for submission. Please contact the EPA EDG team with any questions.
Page 4

-------
Adding Metadata to EDG for EPA Public Access
2. In the drop-down menu, select Save.
10 EPA Open Data Metadata Editor
for extramural researchers
£% LOAD
<3>VIEW
SAVE.
en Data Metadata Editor for Extramural Researchers in support
ral researr'^^^^^^^^^^^^y^^j|^yrietadata records f
I data, please cori
espondinc^^K5fH[jM#5rjWj^^MOptional (empty),
elerr
e upper left to save, view or load existing records. The red butt
ady for submission. Please contact the EPA EDG team with an;
3. In the popup window, enter a file name.
3c7d11 ca-107a-413c-bb1 d-22d70e358bfd.json

identifier": "3c7dllca-107a-413c-bbld-22d70e358bfd"
accessLevel": "public",
bureauCode": [
"020:00"
programCode": [
"020:000"
epa_contact": "test@gmail.com"
Enter Filename
Filename (leave empty to use document identifier):
3c7d11 ca-107a-413c-bb1 d-22d70e358bfd.json
Page 5

-------
Adding Metadata to EDG for EPA Public Access
4. Then, select the Download icon.
"identifier":
"accessLevel"
"bureauCode":
3c7dllca-107a-413c-bbld-22d70e3
"public",
'programCode":
'epa_contact": "test@gmail.com"
Filename (leave empty to use document identifier):
3c7d11 ca-107a-413c-bb1 d-22d70e358bfd.json
Select Download
3c7d11 ca-107a-413c-bb1 d-22d70e358bfd.json
5. The file will be downloaded to your device.
Loading a Saved Form
If you are returning to the EPA Open Data Metadata Editor and have a saved copy of
your partially completed form, you have the option of loading the saved copy.
To load a saved copy of your form:
1. In the top left of the window, select the EPA icon.
^ EPA Open Data Metadata Editor
for extramural researchers
Select the Icon
ural Researchers in suppo
This tool allows extramural researchers to author, save, and submit metadata records for non-geospati
-------
Adding Metadata to EDG for EPA Public Access
2. In the drop-down menu, select Load.
EPA Open Data Metadata Editor
for extramural researchers
£% LOAD ^ ^

<5>VIEW
en Data support
Ck SAVE
jral researchers to author, save, and submit metadata records f
If you wish to submit metadata for geospatial data, please con
-esponding status: A Mandatory (empty), < Optional (empty),
each element's status icon.
ie upper left to save, view or load existing records. The red butt
jadv for submission. Please contact the EPA EDG team with an'
3. In the popup window, select Browse.
Browse.
Load Metadata File
Select Browse
4. In the new window, navigate to where your saved form is stored and select it.
5. Then, select Open
6. Review the file if desired.
7. To load the file into the EPA Open Data Metadata Editor, select the Edit icon.
"^context": "https://project-open-data.cio.gov/vl.1/schema/catalog.jsonld"
"@id": "https
"@type": "d>
"conformsTo
"describedBy1
"dataset": [
ittps: //project-open-da
'https: /
io.gov/vl.l/3che
cio.gov/vl.1/sch
catalog.j3on
"title": "Metadata",
"identifier": "3c7dllca-107a-413c-bbld-22d70e358bfd",
"accessLevel": "public",
"bureauCode": [
'programCode": [
epa_contact": "test@gmail.cor
C:\Users\35125\Desktop\3c Browse...
Select Edit
Load Metadata File
Page 7
-------
Adding Metadata to EDG for EPA Public Access
The content from your saved file will be used to prepopulated the EPA Open Data
Metadata Editor, and you can continue filling in the remaining fields.
Submitting Your Form
You can submit your form by selecting the Submit icon in the bottom right of the
screen.
£ EPA Open Data Metadata Editor
for extramural researchers
This tool allows extramural researchers to author, save, and submit metadata records for non-geospati1
Technical Specification. If you wish to submit metadata for geospatial data, please contact the
Each element has a corresponding status: A Mandatory (empty), O Optional (empty), Invalid, and Valid
are available by clicking each element's status icon
Use the blue button at the upper left to save, view or load existing records. The red button at the lower rigf
validation tests and is ready for submission. Please contact the EPA EDG team with any questions
BrfEMfaifffl SBEjj ID
Select Submit
aSsfli .*
4
Please select EPA agreement type
Please enter EPA agreement number or description
Welcome to the EPA Open Data Metadata Editor for Extramural Researchers in support of EPA's initiativ
If the form is not ready to be submitted, the Submit icon will be red instead of green. If
you hover over the icon, a popup displays, saying "Document not valid yet. Please click
for more info." If you select the red Submit icon, you will receive a popup notification
telling you why the form is invalid.
If all the required fields are valid and you select the green Submit icon, you will receive
the following Confirmation message:
^ Submit to EPA
Clicking Submit will send your metadata record to EPA's metadata
team for review. You will receive confirmation via email if it is
accepted into EPAs metadata inventory.
Please contact edg@epa.gov if you wish to make changes to your
record at any point in the future.
protected by reCAPTCHA
A
Privacy- Terms

SUBMIT ¦ CANCEL
Page 8
-------
Adding Metadata to EDG for EPA Public Access
If you select the Submit button, you will receive the following success message once
your form is submitted:
^ Metadata submitted to EPA successfully, dismiss
After you submit your form, a copy of the metadata record is sent to the EPA contact
entered in the form. The contact must reply with a confirmation that they have reviewed
the record and are the appropriate EPA point of contact.
If the EDG team does not receive the email confirmation, they will attempt one follow-up
email with the contact. If no confirmation is received within 2 weeks, the EDG team will
ask for an alternate contact. A new contact must be provided, or the record will not be
accepted.
Once the metadata record is accepted, it is stored in the database.
Edits After Submission
If you realize you need to make an edit to your submitted metadata, reach out to the
EPA EDG team with details on what file needs to be edited and what the edits should
be.
Page 9
-------
Adding Metadata to EDG for EPA Public Access
Appendix A: Sample of a Completed Form
Below is a sample of a completed form in the EPA Open Data Metadata Editor.
Page 10
-------
^ EPA Open Data Metadata Editor
for extramural researchers
Welcome to the EPA Open Data Metadata Editor for Extramural Researchers in support of EPA's initiative to make data open, discov§
This tool allows extramural researchers to author, save, and submit metadata records for non-geospatial data that are compliant witKWA
metadata for geospatial data, please contact the EPA EDG team for further assistance.
Each element has a corresponding status: A Mandatory (empty), 0 Optional (empty). Invalid, and Valid. Additional guidance'lffikb
status icon.
Use the blue button at the upper left to save, view or load existing records. The red button at the lower right will turn green when a record has
Please contact the EPA EDG team with any questions.

?JLU* .
^ EPA Agreement
Grant
Please enter EPA agreement number or description
1234-5678-90000
^ EPA Contact Email
Please enter EPA contacts email
lastname.firstname@epa.gov
^ Title
Please enter a title for the dataset
Dissolved oxygen, dissolved nitrous oxide, and water temperature in reservoirs in the Ohio River Basin
^ Description
Please enter a description for the dataset
This data documents "Controls on nitrous oxide production and consumption in reservoirs of the Ohio River Basin" and includes dissolved oxygen, dissolved nitrous oxide, and water temperature in
reservoirs. This dataset is associated with the following publication: Brody, J., C. Nutch, and J. Wise. Source or sink: Insight on controls of nitrous oxide biogeochemistry from a 20 reservoir survey.
Journal of Biophysical Research - Biogeosciences. American Geophysical Union, Washington, DC, USA, 120(10): 1995-2010, (2015).
^ Place Keywords

Kentucky
^ ISO Keywords
Inland waters
^ EPA Keywords
*
Surface Water ¦ Monitoring Ecology
^ General Keywords
epilimnion l hypolimnion | nitrous oxide saturation 1 greenhouse gas emissions Q
^ Publishing Organization
-------
Please enter the name of the publishing organization for the dataset
University of the Ohio Basin
^ Publishing Individual
Please enter the name of the individual responsible for publishing the dataset
Jacob Montclair
^ Publisher Email
Please enter the email address of the publisher for the dataset
montclair.jacob@uob.edu
Distribution
+ ADD A DISTRIBUTION ENTRY
^ Identifier
Please enter a DOI for the dataset or leave empty to use. e03fed09-b11 e-420f-a4e5-2ef02af20eaf
https://doi.org/10.1002/2015JG002941
^ Access Level
public
Q Rights
Restrictions on the dataset
^ Data License
URL of the license for the dataset
https://creativecommons.Org/publicdomain/zero/1.0/
^ Temporal Extent
Start: 201 5-01 -30 End: 2016-02-25
^ Last Update
2017-05-04
^ Update Frequency
number
^ Release Date
-------
2016
^ Language
^2223*
^ Data Quality
Does the dataset meet your organization's Information Quality Guidelines? SKIP
NO
YES
© Conforms To
Please provide a URL
Described By
Please provide a URL
Please select the type of file pointed by the above URL
e Landing Page
Please provide a URL
© References
Please provide a URL
©
-------