Contents

DOE Data ID Service Background........................................................................................................... 1

1. About E-Link and AN 241.6................................................................................................................ 1

1.1 Why should I get a DOI?.............................................................................................................. 4

1.2 General Requirements................................................................................................................ 5

1.3 Understanding Key Components.................................................................................................. 5

1.4 The Digital Object Identifier (DOI)................................................................................................. 6

1.5 The Landing Page....................................................................................................................... 8

2. Submitting Metadata to Obtain a DOI................................................................................................ 9

2.1 Scientific Research Datasets 241.6 Web Submission Interface Single Metadata Record.................... 9

2.2 Application Programming Interface (API) Multiple Metadata Records.......................................... 10

3. Reserving a DOI............................................................................................................................. 12

4. Editing DOI Metadata..................................................................................................................... 16

5. Searching for a DOI........................................................................................................................ 18

6. Deleting a DOI............................................................................................................................... 20

7. Using Related Identifiers................................................................................................................. 21

8. Versioning: Assigning DOIs to Data Object Versions............................................................................ 30

9. Creating a Unique DOI Infix............................................................................................................. 31

Appendix: DOE Data ID Service API Metadata....................................................................................... 33

Appendix: 241.6 Web Submission Interface Submission Example............................................................. 40

Appendix: Frequently Asked Questions (FAQs)...................................................................................... 45

Appendix: Release Notes.................................................................................................................... 52

DOE Data ID Service Background

In 2011, OSTI joined DataCite to facilitate citing, accessing, and reusing publicly available scientific research datasets produced by DOE-funded researchers. DataCite, an international non-profit organization that registers digital object identifiers (DOIs) with the International DOI Foundation, develops and maintains the metadata schema tailored for describing scientific data and software, and provides infrastructure for allocating DOI prefixes, registering DOIs and associated metadata, and managing DOIs. The U.S. Department of Energy (DOE) Office of Scientific and Technical Information (OSTI), through the DOE Data ID Service, assigns DOIs to datasets announced by DOE and its contractor and grantee researchers and registers the DOIs with DataCite to aid in citation, discovery, retrieval, and reuse. OSTI assigns and registers DOIs for datasets for DOE researchers as a free service to enhance the Department's management of this important resource. OSTI refers to individual data centers at DOE-funded organizations as data clients, and sets up data client accounts to allow for tailored customization of features, which will be detailed in later sections of this manual. 

1. About E-Link and AN 241.6 

DOE OSTI develops and maintains E-Link, an electronic submission tool for DOE-funded scientific and technical information (STI). E-Link provides Announcement Notices (ANs) or submission tools to submit various types of STI and associated metadata. The E-Link¹ AN 241.6, the Scientific Research Datasets AN, allows for the metadata needed to identify/announce datasets resulting from work funded by DOE to be provided to OSTI. The submitted metadata allows the assignment of DOIs to datasets through the DOE Data ID Service. This value-added step of assigning a DOI facilitates visibility, ensures long-term preservation, (re)usability.

1 E-Link facilitates the electronic submittal of STI between DOE and its client community including researchers, reviewers, research administrators, and others doing business with DOE. STI deliverables provided to DOE through E-Link are announced, as appropriate, on web products maintained by OSTI, which provide free and convenient public access to full text and bibliographic data of products resulting from DOE-funded research.

and supports better linkages between DOEs published research results and the underlying data.

The DOE Data ID Service offers three options to submit metadata for DOIs:

1. Scientific Research Datasets 241.6 Web Submission Interface Single metadata record
The 241.6 Web Submission Interface for manual entry of metadata is a good option for low-volume data clients. Researchers at DOE national laboratories should contact their sites STI Manager² to arrange for manual submittal.

2. Application Programming Interface (API) Multiple metadata records
OSTI offers an Application Programming Interface (API) for POST (submit) and GET (retrieval) functions to a communication channel called an endpoint.
Testing in the API is required prior to receiving a production account. Please contact OSTI: DOEDataID@osti.gov to set up a test account with credentials.

• Test E-Link Endpoint: https://www.osti.gov/elinktest/2416api
• Production E-Link Endpoint: https://www.osti.gov/elink/2416api

For more information about the API, please click here: E-Link 241.6 API Documentation

² Each DOE national Laboratory has a designated point of contact for coordinating submissions of scientific and technical information (STI) to OSTI.

3. Financial Assistance recipients (Grantees) can submit metadata for their individual datasets without log-in credentials using the Scientific Research Datasets (AN 241.6) Submission Interface found at: https://www.osti.gov/elink/2416-submission.jsp

The workflow below explains the entire submission workflow from submission to E-Link to display in OSTIs output search products.

Dataset Record Submission Workflow

The user can submit a dataset metadata record to OSTI either through the 241.6 Web Submission Interface (either by logging in for DOE sites or using the Financial Assistance Step-by-Step version for grantees) or the Application Programming Interface (API). If successful, the metadata is submitted to E-Link, OSTIs ingest system. OSTI then sends the metadata record to DataCite to register the DOI. After the record has been processed in E-Link, it will be displayed in both OSTI.GOV and DOE Data Explorer.

1.1 Why should I get a DOI?

DOIs allow people to more easily discover research and technology objects, access them, and reuse them for verification of the original experiment or to produce new results with the latest methods.

DOIs facilitate linkages among outputs published articles, patents, technical reports, data, software, and other research objects.

DOIs are easy to cite in a standardized way to give inventors, authors, or creators the proper attribution.

DOIs can be assigned to any digital entity a user wishes to persistently identify, primarily for sharing with an interested user community or managing as intellectual property.

DOI links are persistent. That is, DOIs resolve to a URL that can be updated even if domain names change and/or the domain naming system itself is replaced. This characteristic can be helpful to agencies as they often undergo reorganizations and renaming. A DOI can ensure the long-term integrity of identifiers in these situations.

DOIs are cross-disciplinary used in the humanities, social sciences, physical sciences and in a number of communities that frequently interact with the scholarly literature, such as non-governmental organizations (NGOs), intergovernmental organizations (IGOs), patent systems, and standards bodies.³

DOIs help make data FAIR (Findable, Accessible, Interoperable, Reusable). Specifically, DOIs help make data findable, and OSTI makes data accessible, interoperable, and reusable. See the FAIR Data Principles for a more detailed explanation of FAIR. 

3 This has been slightly modified from Crossrefs persistent identifiers webpage at https://www.crossref.org/blog/global-persistent-identifiers-for-grants-awards-and-facilities/

1.2 General Requirements

General requirements have been established for data registration. The submitter must:

• Provide the required metadata to enable basic, bibliographic citation
• Have the authority to make the data public, as the data owner, PI, or other designated submitter
• Guarantee the persistence of registered data
  • Ensuring that data are stored and managed for indefinite access and usability
  • Maintaining and updating all landing pages/URLs associated with the DOI

OSTI DOES NOT CURRENTLY PROVIDE A REPOSITORY TO HOST DATASETS.

1.3 Understanding Key Components

Granularity is the level of depth represented by the data. More granularity means a very focused detail, the most precision. Less granularity is a summary view of data and transactions.

• Determining the level at which DOIs are assigned to data is one of the first steps in planning data DOI registration.
• DOIs can be assigned at varying granularity. The granularity of data can be dependent upon the type of data. Subject matter expertise and knowledge of how researchers use data can help determine the appropriate level of granularity to assign the DOI, as well as intention for reuse, versioning, and how the data is used within journal articles, technical reports, or patents.
• DOIs can be assigned for a variety of different forms of data, such as instruments, sensor data, time-sensitive data (for example, monthly datasets for a location, with new DOIs each month), supercomputer runtime data, individual samples, grouped samples, supplemental data

to a journal article, computer models/simulations, photographs, graphics, interactive resources, and more.

1.4 The Digital Object Identifier (DOI)

A DataCite DOI consists of a prefix, infix, and suffix. Each OSTI data client receives a numeric prefix from DataCite, which is specific to that data client.

A DOI prefix begins with 10.XXXX, where XXXX is a series of numbers. (See Figure Below)

Directory: 10

Registrant Prefix: XXXX

Optional Intelligence: Infix

Suffix: OSTI ID

The Infix is optional and can be incorporated by the data client/submitter. The infix can add intelligence to the DOI by incorporating project, user facility, or other specific identification. The infix must contain 3-50 characters. Characters may not be spaces or forward slashes (/)

The suffix is assigned by OSTI and is the OSTI ID. Every STI record processed through OSTI receives an OSTI ID

Once a DOI is registered, it cannot change, but the URL/landing page associated with the DOI can change or be updated as it is part of the metadata associated

with the DOI. DOIs are meant to be persistent, which means submitting organizations should manage and update metadata, including landing pages/URLs as needed for the DOI to properly take the user to the correct page.

This can be accomplished by entering a DOI at: https://dx.doi.org/:

Or by clicking on the hyperlinked DOI in dataset metadata records found at OSTI.GOV and DOE Data Explorer:

The browser will take the user to a web page (URL) associated with that DOI.

1.5 The Landing Page

A DOI points/resolves to a landing page or URL, which provides information about and access to the dataset. A landing page should contain the following information:

• Full citation metadata of the data object (including the DOI)
• Access information
• Links to software needed to open, view, download or analyze the data
• Update and version information
• Contact information

Below is an example of a landing page:

The image on this page presents a possible example of a landing page. A table on the left side of the page lists the information about the dataset enumerated prevously. Another section describes the dataset and its relationship to other products. In this case, the dataset was used to generate illustrations for another article.

2. Submitting Metadata to Obtain a DOI

2.1 Scientific Research Datasets 241.6 Web Submission Interface
Single Metadata Record

The 241.6 Web Submission Interface for manual entry of metadata is a good option for low volume data clients. Researchers from DOE national laboratories should contact their sites STI Manager to arrange for manual submittal.

If a user plans to exclusively submit through the 241.6 Web Submission Interface, then the user does not need to go through Test E-Link first. Work with the Data Liaison by emailing DOEDataID@osti.gov, who will set up a meeting to go through each step of manually submitting.

OSTI prepares a new data client for the 241.6 Web Submission Interface by:

1. Creating a site code in E-Link
2. Assigning a unique DOI prefix to a users submissions
3. Creating the account at DataCite
4. Creating login credentials on Production E-Link

Financial Assistance recipients (Grantees) can submit metadata for their individual datasets without log-in credentials using the step-by-step version of the Scientific Research Datasets (AN 241.6) Submission Interface found at: https://www.osti.gov/elink/2416-submission.jsp.

For more information about manual submission, please refer to the E-Link 241.6 Web Submission Interface Instructions.

If users have any questions about the submission process, please contact DOEDataID@osti.gov and a member of the OSTI Data Team will answer as soon as possible.

2.2 Application Programming Interface (API)
Multiple Metadata Records

OSTI offers an Application Programming Interface (API) for POST (submit) and GET (retrieval) functions.

Establishing Test Credentials

To use the production API, users must first submit through Test E-Link before being able to submit in production. In Test E-Link, users can freely practice submissions without the records being shown in OSTIs search products. The Data Ingest Liaison Librarian will work with the user on checking submissions for errors and giving recommendations for improving metadata quality. Once OSTI determines the user has enough experience and a high success rate of submissions, the user will be given production credentials. Before being ready to test submissions to OSTI, the user must obtain the following by contacting DOEDataID@osti.gov:

1. Site Code - The site code associates the user with their metadata and records by associating credentials to those who wish to receive notification emails concerning the account. These automated emails are sent after each submission and inform the user of the new OSTI ID and the DOI of the submitted record.
2. DOI Prefix The DOI prefix, beginning with 10., is unique to the site code. Every DOI assigned to the users datasets by the DOE Data ID Service will begin with this prefix.
3. E-Link Account Finally, OSTI establishes a Test E-Link account. The E-Link API requires the user to include the credentials in the header of the servers transmission file.

Confirming Test Credentials New Client/Submitter

Confirm that the Test credentials are working by:

1. Go to Test E-Link/TEST 241.6 web service: https://www.osti.gov/elinktest/2416api
2. A dialog box will appear asking for a username and a password.
3. Enter the username and the password that OSTI has provided to the user.
4. Upon successful sign in, a screen will appear with XML. If so, the user has successfully logged into the Test E-Link account.

Moving from Test Environment to Production

Upon successful testing, the user will now move into E-Link production, where all metadata record submissions are assigned a DOI and will be publicly available through OSTI.GOV and DOE Data Explorer. Please contact DOEDataID@osti.gov to start the transition to production.

Establishing Production Credentials

1. E-Link Account After successfully submitting test records, OSTI will establish the credentials in production E-Link.
2. Production API Documentation: Production E-Link API documentation can be found at: https://www.osti.gov/elink/241-6api.jsp.
3. Production E-LinkThe API Root Endpoint for production E-Link: https://www.osti.gov/elink/2416api.

Confirming Successful Record Submission

When a metadata record has been submitted, the client will receive an email detailing whether submission was successful or unsuccessful. If unsuccessful, details will be given on why it failed. Please contact DOEDataID@osti.gov to help

with resolution of any submission issues. An example email of a successfully submitted record will look like this:

Date: 12/30/2019

Number of Records Submitted: 1

Number of Records Successfully Loaded into ELINK: 1 Number of Records Failed: 0

Record Number: 1

OSTI ID: 1164892

Site Code: ORNL-NGEEA

Report Number: NGA183

Title: Active Layer Hydrology in an Arctic Tundra Ecosystem: Quantifying Water Sources and Cycling

Using Water Stable Isotopes: Supporting Data Contract Number: DE-AC05-00OR22725DOI Assigned:10.5440/1164892

Status: SUCCESS Record updated and put into SUBMITTED status for transmission to DataCite.

Note: A new record successfully added to ELINK is put in SUBMITTED status and will travel to DataCite for DOI minting overnight. If your DOI fails to mint at DataCite, it will remain suspended in a SUBMITTED status in ELINK until the problem is corrected. You will receive an email notification of DataCite's "failure to mint," if that occurs.

A record sent to OSTI with <set_reserved/> in the XML will be automatically put in SAVED status in ELINK. It will NOT travel to DataCite for DOI minting until the record, with the correct OSTI ID included in the XML, is re-sent to OSTI for update and release. The reserve tag must NOT be in the XML record when it is resent, or the record will remain SAVED. It will only be changed to SUBMITTED status when the OSTI ID is present in the XML and the <set_reserved/> tag is NOT present in the XML.

If this record needs to be edited, resubmit the record by supplying the OSTI ID into the data that you submit.

If you have additional questions, refer to https://www.osti.gov/stip/document/an2416-web-servicepdf

3. Reserving a DOI

The DOE Data ID Service provides the ability to reserve a DOI. Reserved DOIs are placeholders within the OSTI E-Link ingest system, but are not yet registered at DataCite. Therefore, reserved DOIs will not resolve at https://dx.doi.org, and will not be publicly available in OSTI.GOV, DOE Data Explorer, or major commercial search engines such as Google. Reserved DOIs give the researcher the ability to obtain a DOI before a dataset is final or before publication. A user may desire to reserve a DOI in order to add the DOI information to a journal article or a technical report before publication, as receiving a DOI after publication may make

it impossible for the DOI to be included within the publication. Reserving a DOI earlier within the research workflow due to a strong data management plan ensures that obtaining a DOI is not forgotten at the end.

Once a dataset is finalized/published, resubmit the original submission following the instructions found below. This will trigger the DOI to be released to DataCite for registration.

A DOI can be reserved through the 241.6 Web Submission Interface and the API.

An image illustrates Part III of the submission process, where contact information fields are presented and the "Save", "Submit to OSTI", and "Printable Version" buttons are available.

To reserve a DOI in the 241.6 Web Submission Interface: Enter information for all required metadata fields (use placeholder information for what is not yet known), and then click the Save button.

This will generate an OSTI ID.

An image at the top of this page illustrates the results page of a successfully saved dataset submission.

The OSTI ID can be used to predict what the reserved DOI will be.

For example,

For example, if my sites prefix is 10.0001, and my OSTI ID is 1476405, then my DOI can be predicted to be: 10.0001/1476405.

Once the user is ready to submit the record and obtain a DataCite registered DOI which is indexed and publicly searchable, find the Saved record in E-Link by entering the OSTI ID in the search bar under Search Announcement Notices and clicking the Edit button.

An illustration of an E-Link search result page is shown here to illustrate how to enter a DOI using the "Search Announcement Notices" search and editing the saved record.

At the top of this page, an illustration of Part III: Contact Information is show. The "Submit to OSTI" button is framed with a thick red border.

To reserve a DOI within the API: Post all required metadata fields (use placeholder information for what is not yet known) and add the metadata field <set_reserved>true</set_reserved> to the API submission.

Below is an example of reserving a DOI through the API:

<?xml version="1.0" encoding="UTF-8"?><records><record><set_reserved>true</set_reserved><dataset_type>ND</dataset_type><title>AOS (Aerosol Observing System) APS (Aerodynamic Particle Sizer), aosaps.a0</title><contract_nos>DE-AC05-00OR22725</contract_nos><originating_research_org>ARM Data Center, Oak Ridge National Laboratory (ORNL), Oak Ridge, TN (United States) </originating_research_org><language>English</language><country>US</country><sponsor_org>USDOE Office of Science (SC), Biological and Environmental Research (BER)</sponsor_org><contact_name>ARM Data Center User Services</contact_name><contact_phone>888-276-3282</contact_phone><contact_email>armarchive@ornl.gov</contact_email><site_input_code>ORNL-ARM</site_input_code><subject_categories_code>54 Environmental Sciences</subject_categories_code><keywords>aerosol; particle size; concentration</keywords><description>Data from the ARM APS (Aerodynamic Particle Sizer) instrument.</description><file_extension>nc</file_extension><availability>ORNL</availability><contributor_organizations>PNNL, BNL, ANL,

ORNL</contributor_organizations><contact_org>ORNL</contact_org><source>armobs</source><data_level_code>a0</data_level_code><instrument_code>aosaps</instrument_code><creatorsblock><creators_detail><first_name>John</first_name><last_name>Smith</last_name>creators_detail></creatorsblock></record></records>

This will create a reserved DOI but it will be placed in a Saved status within E-Link, therefore it will not resolve at https://dx.doi.org, and it will not be publicly available in OSTI.GOV, DOE Data Explorer, or major commercial search engines such as Google.

Once ready to submit the finalized record and make the DOI findable, use the OSTI ID and resubmit the API request with the correct metadata and remove the <set_reserved>true</set_reserved> field from the submission.

4. Editing DOI Metadata

The DOI string itself cannot be edited/changed after registration. A DOI is persistent, so if using an infix to add intelligence to the DOI, the user should ensure they are satisfied with it, because it is impossible to change it later.

To edit the metadata of a DOI, use either the 241.6 Web Submission Interface or the API. Through both, the changes should appear on the metadata records the day after submission, so long as there are no errors.

To edit the metadata in the 241.6 Web Submission Interface:

For financial assistance recipients (grantees), please contact the E-Link Helpdesk at elink_Helpdesk@osti.gov or 865-576-4070 to have an OSTI staff member edit the record.

For researchers at national laboratories, log into E-Link with your login credentials to edit records. After logging into E-Link, click on Advanced Search, and enter the OSTI ID:

At top of this page is an image that illustrates the Search form and the OSTI ID field.

Then click search. This will show the search results. Click on the Edit button:

An image illustrates the Search Results page, with the record with a corresponding OSTI ID. An "edit" button under the OSTI ID column is emphasized.

This will bring the user to the 241.6 Web Submission Interface. Make all desired edits and then click on Submit to OSTI:

The Part III Contact Information page is illustrated, with the "Submit to OSTI" button framed with a thick red border.

To edit the metadata via the API: Whenever editing through the API, it is not required to resubmit all metadata for the record, all that is needed is the OSTI ID or Accession Number, and the XML fields that need to be changed.

For example:

<records>
<record>
<osti_id>9999</osti_id>
<title>My new title</title>
</record>
</records>

In the example, the only metadata that has been edited is the title, and none of the other metadata was needed.

5. Searching for a DOI

After the user has submitted the metadata record to OSTI via the API or the 241.6 Web Submission Interface and the DOI has been registered by DataCite, OSTI will make the metadata record and DOI visible both in DOE Data Explorer (DDE) and OSTI.GOV, and indexed in commercial search engines like Google Dataset Search.

For OSTI.GOV and DDE, search for the OSTI ID or DOI by using the Advanced Search and inserting the identifier either in Digital Object Identifier (DOI) or Identifier Numbers:

A screenshot embedded here highlights the text entry box on OSTI.GOV's search page where the DOI may be entered.

Google Dataset Search

Much like Google and Google Scholar, Google Dataset Search allows users to search and access datasets hosted in thousands of repositories. It currently indexes repositories that use the Schema.org structured data guidelines. OSTI implemented Google's structured data guidelines (largely Schema.org) for datasets, so OSTI datasets are available on the service.

A screenshot illustrating the Google Dataset Search web page has been inserted here.

6. Deleting a DOI

A DOI cannot be deleted, as it is a persistent identifier. If the exact DOI is searched in a browser or resolved, it will still point to the landing page. However, OSTI can hide the DOI and associated metadata record in DOE Data Explorer and OSTI.GOV.

If the user wishes to hide a DOI, please contact OSTI at DOEDataID@osti.gov and specify the OSTI ID, DOI, and the reason for hiding the DOI.

When hiding a DOI, the landing page needs to be updated or replaced to indicate the data object is no longer accessible. This required webpage is called a tombstone page. The tombstone page should provide a full bibliographic citation to verify users have found the correct item (or its last resting place). The tombstone page should contain the DOI itself in both a human-readable and machine-readable format. It is best to include a statement of unavailability, a reason for the items removal, and the details that led to the current situation. It should be clear to users that the item being described is in fact associated with the DOI they tried to resolve, but that item is now no longer available.

Below is an example given by DataCite of a tombstone page:

A screenshot of a tombstone page is included.

7. Using Related Identifiers

Related identifiers are a way to link data objects with other research objects (journal articles, technical reports, datasets, instruments, experiments, awards, etc.) to give users a fuller picture of how research objects are related or connect to one another. This can help to facilitate the validation of research results and support research reproducibility.

Here a journal article is supplemented by a dataset, and the dataset is supplement to the journal article.

OSTI recommends using the Related Identifier metadata field to reference previous versions or related data objects, as well as express other relationships to a related source (including journal articles associated with the data object, data sets, figures, software, etc.).

Here a dataset has part (contains) an individual data sample, and the individual data sample is part of the dataset.

OSTI currently has the following Relation Types:

In all examples below, A is always the dataset and B is the related object.

Code Description

"Cites" indicates that A includes B in a citation

OSTI Guidance: Use this relationship to show what the dataset is citing.

Example:

<related_identifier>10.1038/sdata.2016.18</related_identifier>
<relation_type>Cites</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"IsCitedBy" indicates that B includes A in a citation

OSTI Guidance: Use this relationship to show the research objects which are citing the dataset (such as a journal article, technical report, etc.).

Example:
<related_identifier>10.2172/1271651</related_identifier>
<relation_type>IsCitedBy</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"Compiles" indicates B is the result of a compile or creation event using A (used in COLLECTIONS to indicate collection item)

OSTI Guidance: Use this relationship to indicate a collection item if it is part of a Collection, or to indicate software or text that compiles/creates B.

Example:

<relidentifiersblock>
<relidentifier_detail relatedIdentifierType="osti_id" relationType="Compiles">
<related_identifier>12345</related_identifier>
</relidentifier_detail>
<relidentifier_detail relatedIdentifierType="doi" relationType="Compiles">
<related_identifier>10.5072/dataset/283</related_identifier>
</relidentifier_detail>
<relidentifier_detail relatedIdentifierType="accession_num" relationType="Compiles">
<related_identifier>my-data-set-001</related_identifier>
</relidentifier_detail>

"IsCompiledBy" indicates B is used to compile or create A

OSTI Guidance: Use this relationship to indicate that A is being compiled/created by a specific software or text.

Example:

<related_identifier>http://d-nb.info/gnd/4513749-3</related_identifier>
<relation_type>IsCompiledBy</relation_type>
<related_identifier_type>URL</related_identifier_type>

"Continues" indicates A is a continuation of the work B

OSTI Guidance: Use this relationship to show that a work is the direct continuation of another work, and thus they need to be viewed together to fully comprehend.

Example:

<related_identifier>10.34664/1575430</related_identifier>
<relation_type>Continues</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"IsContinuedBy" indicates A is continued by the work B
OSTI Guidance: Use this relationship to show that a work is continued by another work, and thus they need to be viewed together to fully comprehend.

Example (for IsContinuedBy):

<related_identifier>10.34664/1575430</related_identifier>
<relation_type>IsContinuedBy</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"Documents" indicates A is documentation about B

OSTI Guidance: Use this relationship to show that a work documents (such as software documentation) another work to show how it operates or how to use it.

Example:

<related_identifier>10.34664/1575430</related_identifier>
<relation_type>Documents</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"IsDocumentedBy" indicates B is documentation about/explaining A
OSTI Guidance: Use this relationship to show that a work is documented (such as software documentation) by another work to show how it operates or how to use it.

Example:

<related_identifier>10.2172/1572938</related_identifier>
<relation_type>IsDocumentedBy</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"HasMetadata" indicates resource A has additional metadata B

OSTI Guidance: Use this relationship to show that another work contains additional metadata about A.

Example:

<related_identifier>10.1234/567890</related_identifier>
<relation_type>HasMetadata</relation_type>
<related_identifier_type></related_identifier_type>

"IsMetadataFor" indicates additional metadata A for a resource B

OSTI Guidance: Use this relationship to show that a work contains additional metadata about another work.

Example:

<related_identifier>10.1234/567890</related_identifier>
<relation_type>IsMetadataFor</relation_type>
<related_identifier_type></related_identifier_type>

"HasPart" indicates A includes the part B

OSTI Guidance: Use this relationship to show container-contained type relationships and for elements of a series, such as for collections of datasets outside of OSTI.

Example:

<related_identifier>https://zenodo.org/record/16564/files/dune-stuff-LSSC_15.zip</related_identifier>
<relation_type>HasPart</relation_type>
<related_identifier_type>URL</related_identifier_type>

"IsPartOf" indicates A is a portion of B; may be used for elements of a series

OSTI Guidance: Use this relationship to show container-contained type relationships and for elements of a series, such as for collections of datasets outside of OSTI.

Example:

<related_identifier>10.5281/zenodo.754312</related_identifier>
<relation_type>IsPartOf</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"IsDerivedFrom"

indicates B is a source upon which A is based

OSTI Guidance: Use this relationship to show a resource that is a derivative of an original resource. In the example below, the dataset is derived from a larger dataset and data values have been manipulated from their original state.

Example:

<related_identifier>10.6078/M7DZ067C</related_identifier>
<relation_type>IsDerivedFrom</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"IsIdenticalTo" indicates that A is identical to B, for use when there is a need to register two separate instances of the same resource

OSTI Guidance: Use this relationship to show a resource that is the same as the registered resource but is saved on another location, maybe another institution.

Example:

<related_identifier>10.34664/1575678</related_identifier>
<relation_type>IsIdenticalTo</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"IsNewVersionOf" indicates A is a new edition of B, where the new edition has been modified or updated

OSTI Guidance: Use this relationship to show that the work is a newer/updated version of another work.

Example:

<related_identifier>10.5281/zenodo.800648</related_identifier>
<relation_type>IsNewVersionOf</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"IsPreviousVersionOf"

indicates A is a previous edition of B

OSTI Guidance: Use this relationship to show that the work is an older/previous version of another work.

Example:

<related_identifier>10.5281/zenodo.60943</related_identifier>
<relation_type>IsPreviousVersionOf</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"IsOriginalFormOf" indicates A is the original form of B

OSTI Guidance: Use this relationship to show that a work is the original form of another, such as for different software operating systems or compiler formats.

Example:

<related_identifier>10.6078/M7DZ067C</related_identifier>
<relation_type>IsOriginalFormOf</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"IsSourceOf" indicates A is a source upon which B is based

OSTI Guidance: Use this relationship to show a work is the original resource from which a derivative resource was created. In the example below, this is the original dataset without value manipulation, and the source of the derived dataset.

Example:

<related_identifier>http://opencontext.org/projects/81204AF8-127C-4686-E9B0-1202C3A47959</related_identifier>
<relation_type>IsSourceOf</relation_type>
<related_identifier_type>URL</related_identifier_type>

"IsSupplementedBy" indicates that B is a supplement to A

OSTI Guidance: Use this relationship to show that another work is supplementing this work. For example, for a journal article, the supplemental figures and tables located in a separate file would be supplementing the journal article.

Example:

<related_identifier>https://static-content.springer.com/esm/art%3A10.1038%2Fnature08275/MediaObjects/41586_2009_BFnature08275_MOESM269_ESM.pdf</related_identifier>
<relation_type>IsSupplementedBy</relation_type>
<related_identifier_type>URL</related_identifier_type>

"IsSupplementTo' indicates that A is a supplement to B

OSTI Guidance: Use this relationship to show that this work is supplementing another work. For example, for a journal article, the supplemental figures and tables located in a separate file would be supplementing the journal article.

Example:

<related_identifier>10.1038/nature08275</related_identifier>
<relation_type>IsSupplementTo</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"IsVariantFormOf" indicates A is a variant or different form of B

OSTI Guidance: Use this relationship to show that this work is a variant form of another work, such as a variant calculated or calibrated form or different packaging, different software operating systems or compiler formats.

Example:

<related_identifier>10.6078/M7DZ067C</related_identifier>
<relation_type>IsVariantFormOf</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"Obsoletes" indicates that A obsoletes B

OSTI Guidance: Use this relationship to show that this work renders another work obsolete, perhaps due to the other work having inaccurate or old data.

Example:

<related_identifier>10.5438/bmjt-bx77</related_identifier>
<relation_type>Obsoletes</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"IsObsoletedBy" indicates that A is obsoleted by B

OSTI Guidance: Use this relationship to show that this work is rendered obsolete by another work, perhaps due to the work having inaccurate or old data.

Example:

<related_identifier>10.14454/7xq3-zf69</related_identifier>
<relation_type>IsObsoletedBy</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"References" indicates B is used as a source of information for A

OSTI Guidance: Use this relationship to show that this work references another work as a source of information. This is broader than citing, because references can appear anywhere throughout a work, not just in a citation or bibliography section.

Example:

<related_identifier>10.18141/1427300</related_identifier>
<relation_type>References</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"IsReferencedBy" indicates A is used as a source of information by B

OSTI Guidance: Use this relationship to show that this work is referenced by another work as a source of information. This is broader than citing, because references can appear anywhere throughout a work, not just in a citation or bibliography section.

Example:

<related_identifier>10.5440/1362279</related_identifier>
<relation_type>IsReferencedBy</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"Reviews" indicates that A is a review of B

OSTI Guidance: Use this relationship to show that this work reviews another work, such as a book review, journal comment, or peer review.

Example:

<related_identifier>10.12688/f1000research.4001.1</related_identifier>
<relation_type>Reviews</relation_type>
<related_identifier_type>DOI</related_identifier_type>

"IsReviewedBy" indicates that A is reviewed by B

OSTI Guidance: Use this relationship to show that this work is reviewed by another work, such as a book review or journal comment.

Example:

<related_identifier>10.5256/F1000RESEARCH.4288.R4745</related_identifier>
<relation_type>IsReviewedBy</relation_type>
<related_identifier_type>DOI</related_identifier_type>

For more technical API information on related identifiers, please refer to the E-Link 241.6 API Documentation.

Example of Related Identifier Entry in the 241.6 Web Submission Interface:

8. Collections

OSTI provides the ability to create relationships between data objects, including data Collections and Datasets. A data Collection is a grouping of related Datasets with a DOI for the entire Collection. Users might consider creating a Collection to draw attention to a certain subset of a data centers datasets which are deemed important to be viewed together. Or, for grouping datasets used to in a journal article to allow for simplified citation of a single DOI by the author, enabling reproducibility by others. For example, if a data center for Wind Energy has 20 datasets about one specific location, this could be a great use case for a Collection. It is ultimately up to the user to decide what they want their Collections to be. Collections have their own section on DOE Data Explorer, which can generate more interest/bring more value to specific subsets of the users

datasets based on the unique title, abstract, and subject information that are given to the Collection. Since Collections are given DOIs, the Collection DOIs can be used in performance reports, journal articles, laboratory division websites, technical reports, and more to demonstrate the value that is coming out of specific research being done.

Currently, Collections can only be created or edited using the API.

• In order for a user or data creator to create a data Collection, they would need to have the DOI, OSTI ID, or accession number from the existing datasets that they would like to include in the Collection.
• In addition to specifying a <product_type>DC</product_type> tag, a collection may specify collection items via related identifiers of relation type "Compiles". Note that when updating Collections records via API submission, any related identifiers of type "Compiles" specified will REPLACE the collection's items, causing collection authors to be recalculated as well.
• It is also possible to add or remove individual collection items by specifying related identifiers using the <add> and <remove> sets within the associated <relidentifiersdetail> tags. Additionally, any other relation types besides "Compiles" are not considered collection items, but will be retained on the collection itself.
• Component datasets making up the collection may contribute author values to the collection itself unless otherwise specified. Any collection item's PRIMARY authors will be gathered first, then supplemental authors; each will be accumulated to provide attribution to the collection as a whole. If the collection provides author values through initial entry or update, those values will be taken in place of the accumulated list.
• Note that for a Collection, a landing page URL is not required, as the OSTI metadata record can become the landing page if needed. Also,

an empty collection can be created with the minimum required metadata fields except Site URL. At a later date, the user can fill the collection with new or existing DOIs.
For more technical information on collections, please refer to the E-Link 241.6 API Documentation.

Collection Submission Example:

Here is what a Collection metadata record looks like in DOE Data Explorer:

A screenshot of a Collection metadata record is included here.

Here are the associated datasets for the Collection:

A screenshot showing a list of datasets associated with a Collection is included here.

9. Versioning: Assigning DOIs to Data Object Versions

OSTI recommends that a new DOI be registered when a major version change occurs in a data object. There are two ways to ways to ensure that users know which version of a dataset is being retrieved.

1. Include the version number as a part of the dataset title.
2. Provide a version number/identifier in the infix of the DOI. Please remember an infix cannot be edited.
   Example: 10.11111/ver1.5/1111111

We recommend using the Related Identifier metadata field to reference previous versions, as well as express other relationships to a related source (including journal articles associated with the data object, data sets, figures, software, etc.):

<relidentifier_detail>
<related_identifier>10.11111/1111111</related_identifier>
<relation_type> IsNewVersionOf</relation_type>
<related_identifier_type>DOI</related_identifier_type>

10. Creating a Unique DOI Infix

To add intelligence to a DOI, such as identifying a specific project/instrument/research group/etc., use the infix API tag:

</doi_infix> with the specific identifier the user wants to express.

Example:

<doi_infix>MyProjectName</doi_infix>

Or, within the 241.6 Web Submission Interface:

Added to the required metadata fields will result in a DOI like this:

10.1234/MyProjectName/123456

If no </doi_infix> is submitted, the same metadata submission will result in a DOI like this:

10.1234/123456

Appendix: DOE Data ID Service API Metadata

The following table lists the required and optional metadata fields, XML tags and the additional information. Records submitted without required fields will result in a FAILURE notification.
*OSTI IDan OSTI ID is given to a new record (POST) in the API and also through the Web Submission Interface, and the OSTI ID can be used to search for the record in E-Link or the API. The OSTI ID is in the suffix of the DOI. Use </osti_id> only when using GET function and when editing/updating the existing record. OSTI provides API documentation for searching DOE Data Explorer.

Metadata Schema

Required fields Shaded

Field Name and XML Tag Additional Information
1*

OSTI ID

</osti_id>

New records are assigned an OSTI ID in the suffix. To edit/update records, the user must include the </osti_id> tag.

2

Dataset Type(Required)

</dataset_type>

Main content of the dataset; ASAnimations/Simulations GDGenome/Genetic Data IMInteractive Data Map NDNumeric Data IPStill Images/Photos FPFigures/Plots SMSpecialized Mix MMMultimedia AAward IInstrument

Ex: <dataset_type>ND</dataset_type>

3

Title (Required)

</title>

Full title of the dataset

4

Creator(s)/Principal Investigator(s)/Authors (Required)

<creatorsblock>
<creators_detail>
<first_name></first_name>
<middle_name></middle_name>
<last_name></last_name>
<affiliation_name></affiliation_name>
<private_email></private_email>
<orcid_id></orcid_id>
</creators_detail>
</creatorsblock>

<creatorsblock>
<creators_detail>
<first_name>J.</first_name>
<middle_name>Robert</middle_name>
<last_name>Oppenheimer</last_name>
<affiliation_name>UCBerkeley</affiliation_name>
<private_email>jopp@ucberkeley.edu</private_email>
<orcid_id>0000000000000000</orcid_id>
</creators_detail>
</creatorsblock>

*For orcid_id, use 16-digit number only

5

Dataset Product Number(s) (Required)

</product_nos>

Identifying number; none is acceptable.

6

DOE Contract Number(s) (Required)

</contract_nos>

Omit DE from contract number.

7

Originating Research Organization (Required)

</originating_research_org>

See: https://www.osti.gov/elink/authorities.jsp

For a list of Originating Research Organizations. Multiple organizations can be listed, separated by a semicolon and a space.

8

Publication/Issue Date (Required)

</publication_date>

Accepted formats:

• mm/dd/yyyy
• yyyy Month

9

Language

</language>

Default to English. See: https://www.osti.gov/elink/authorities.jsp for other language values.

10

Country of Origin/Publication

</country>

Default to U.S.; See: https://www.osti.gov/elink/authorities.jsp for other values.

11

Sponsoring Organization(s)

</sponsor_org>

See: https://www.osti.gov/elink/authorities.jsp for values

Multiple organizations can be listed, separated by a semicolon and a space.

12

Site URL

</site_url>

URL that links to the landing page.

13

Contact Name and Position

</contact_name>

Internal tag for OSTI records only; will not be publicly displayed.

14

Contact e-mail

</contact_email>

Internal tag for OSTI records only; will not be publicly displayed.

15

Contact phone

</contact_phone>

Internal tag for OSTI records only; will not be publicly displayed.

16

Site Code

</site_input_code>

The Site Code that owns this particular dataset; it will default to logged-in user's primary Site if not set. User must have appropriate privileges to submit records to this Site.

<site_input_code>DRHUB</site_input_code>

17

Site Accession Number

</accession_num>

Site specific unique identifier for this dataset.

18

Contributor(s)

</contributors>
</contributor>
</first_name>
</last_name>
</affiliation_name>
</contributorType>
</private_email>
</orcid_id>

Example:

<contributors>
<contributor>
<first_name>J.</first_name>
<last_name>Oppenheimer</last_name>
<affiliation_name>UCBerkeley</affiliation_name>
<contributorType>Researcher</contributorType>
<private_email>jopp@ucberkeley.edu</private_email>
<orcid_id>0000-0000-0000-0000</orcid_id>
</contributor>
</contributors>

*For orcid_id, use 16-digit number only

19

Other Identifying Number(s)

</other_identifying_numbers>

Any numbers that identify the data. Separate multiple values by a semicolon and a space.

20

Subject Categories

</subject_categories_code>

See : https://www.osti.gov/elink/authorities.jsp for values. Separate multiple values by a semicolon and a space.

21

Keywords

</keywords>

Words or phrases to describe the dataset. Separate multiple values by a semicolon and a space.

22

Description

</description>

Define the content of the dataset.

23

DOI

</doi>

Use only if dataset already has a DOI.

24

Dataset File Extension

</file_extension>

Examples: .txt; .csv; .ps

25

Software needed to utilize the dataset

</software_needed>

Software tools required to utilize the dataset.

26

Dataset Size

</dataset_size>

Indicate file size and/or number of files.

27

DOI Infix

</doi_infix>

Character string decided on by submitter. <50 characters; no spaces or /

Ex: <doi_infix>Project1.3</doi_infix> Results in:
10.1234/Project1.3/123456

28

Set Reserve

</set_reserved>

This puts E-Link record in SAVED status to reserve the DOI.29

Other non-DOE Number(s)

</ othnondoe_contract_nos >

Any award numbers relevant but not associated with DOE. Separate multiple values by a semicolon and a space.

30

Related Identifier(s)

<relidentifersblock>
<relidentifier_detail>
<related_identifier_type>
<relation_type>
</ relidentifier_detail>
</ relidentifersblock>

DOI is used as the related identifier of the dataset.

A controlled vocabulary list expresses the relationship. Please see Appendix for controlled vocabulary.

Ex:
<relidentifersblock>
<relidentifier_detail>
<related_identifier_type>DOI</related_identifier_type>

<related_identifer>10.1234/Project1.3/123456</related_identifier>
<relation_type>IsPreviousVersionOF</ relation_type>
</ relidentifier_detail>
</ relidentifersblock>

In this example, the dataset being submitted is a previous version of another dataset that has received a DOI.

31

Geolocation Place Name

<geolocations>
<geolocation>
<place></place>
</geolocation>
</geolocations>

Name of the place where the data were collected.

Ex:
<geolocations>
<geolocation>
<place>Oak Ridge</place>
</geolocation>
</geolocations>

32

Geolocation Point

<geolocations>
<geolocation>
<point latitude=numberlongitude= number>
</geolocation>
</geolocations>

Ex:
<geolocations>
<geolocation>
<point latitude= 36.0104longitude=84.2696>
</geolocation>
</geolocations>

33

Geolocation Bounding Box

<geolocations>
<geolocation>
<boundingBox>
<northLatitude>
<southLatitude>
<eastLongitude>

Expressing 4 points in a square (box).

Ex:
<geolocations>
<geolocation>
<boundingBox>

<westLongitude
</geolocation>
</geolocations>
<northLatitude>+36.067428</northLatitude>
<southLatitude>-35.849496</ southLatitude>
<eastLongitude>+83.688549</ eastLongitude>
<westLongitude>-84.161622</ westLongitude>
</boundingBox>
</geolocation>
</geolocations>

34

Geolocation Polygon

</polygon>

Irregular geolocation. 3 or more points.

Ex:
<geolocations>
<geolocation>
<polygon>
<point latitude= 36.597longitude=-81.606>
<point latitude= 36.650longitude=-88.044>
<point latitude= 36.491longitude=-88.066>
<point latitude= 36.456longitude=-89.450>
<point latitude= 34.994longitude=-90.353>
</polygon>
</geolocation>
</geolocations>

Appendix: 241.6 Web Submission Interface Submission Example

Site Code: A site code will be created for you based on what collection the data belongs to.

Dataset Type: This is a dropdown with the following options: Animations/Simulations, Award, Figures/Plots, Genome/Genetics Data, Instrument, Interactive Data Map(s), Multimedia, Numeric Data, Specialized Mix, Still Images or Photos. Above, Specialized Mix was chosen (often this is chosen if there is a mix of different dataset types).

Dataset Title: This is the title of your dataset based on the title found on the landing page.

Author(s) and Contributor(s): A listing of the authors/contributors to the dataset.

Related Resource: Citation information about the related journal publication can be entered here. (Optional)

Add/Remove Related Identifiers/DOIs: Here you can add related URLs and DOIs to the dataset (such as related datasets, publications, etc). (Optional)

DOI Alphanumeric String: If you want to personalize the infix of your DOI, you can add that information here. (Optional)

Dataset Product Numbers: Here you would add important product numbers related to the dataset, such as project ID, instrument ID, etc.

DOE Contract/Award Number(s): A contract/award number is required.

Other non-DOE Contract/Award Number(s): If there are other award numbers associated with this dataset that are not DOE, you can add them here. (Optional)

Other Identifying Number(s): If there are other identifying numbers you would like to add, these can be entered here. (Optional)

Originating Research Organization: This would be the name of the laboratory/facility associated with the dataset.

Availability: Availability information can be added here (such as copyright information). (Optional)

Collaboration Name(s): If there are any collaborations associated with the dataset, those can be mentioned here. (Optional)

Publication/Issue Date: Enter here the date of the dataset submission on your landing page.

Language: Select the language of the dataset (automatically set to English). (Optional)

Country of Publication: Automatically set to the United States, but this can be changed if needed.

Sponsoring Organization(s): There is a dropdown box here with a list of DOE Sponsoring Organizations, such as USDOE Office of Science (SC).

Subject Categories: You can assign subjects based on a dropdown box. You can add multiple. (Optional)

Keywords: Keywords can be added to supplement the subject categories. (Optional)

Geolocation Data: Geolocation data can be added here. (Optional)

URL: The link to the landing page of the dataset must be entered here.

Digital Object Identifier (if already assigned): If you already have the DOI, enter it here. Otherwise, this will be automatically generated upon submission by OSTI.

Datasets File Extension: Enter file extension here. (Optional)

Software needed to utilize dataset (if applicable): If specific software is needed, it can be mentioned here. (Optional)

Dataset Size: The number of files and the approximate size combined. (Optional)

Contact Information: The name, organization, and email of the submitter must be added. A phone number is optional.

Appendix: Frequently Asked Questions (FAQs)

1. How can I get a DOI for my data from OSTI?
   OSTI provides two options for obtaining a DOI for data funded by the Department of Energy.
   OSTI provides a Web Submission Interface through E-Link (a tool developed and maintained by OSTI for the submission of scientific and technical information products and metadata) for obtaining a DOI for a single data object. As OSTI does not maintain a data repository, only the metadata describing your data will be submitted through the Web Submission Interface.
   OSTI also provides the E-Link 241.6 Application Programming Interface (API) for obtaining multiple DOIs for multiple data objects. The API is HTTP-based and can be accessed using a wide variety of clients (Postman; HTTP Requestor; Restlet API, </>RESTED, etc); most examples are illustrated using the cURL command to demonstrate basic use cases.
2. How is OSTI able to provide DOIs for DOE-funded data objects?
   OSTI is a member of DataCite, which gives us the ability to assign DOIs to data objects. DataCite employs a metadata schema that allows for the description of data objects. DOE OSTI collects relevant metadata required to obtain a DOI and passes that metadata on to DataCite allowing for a DOI to be minted by DataCite and registered globally through the International DOI Foundation.
   DataCite is an international organization that supports data visibility, ease of data citation in scholarly publications, data preservation and future re-use, and data access and retrievability. DataCite members help achieve these goals by assigning persistent identifiers such as DOIs to data objects.

Preview image for Page 51.

Preview image for Page 52.

Preview image for Page 53.

Preview image for Page 54.

related_identifier_type: The type of identifier, usually DOI.

Example:

<relidentifiersblock>

<relidentifier_detail>

<related_identifier>10.5072/238923</related_identifier>

<relation_type>Cites</relation_type>

<related_identifier_type>DOI</related_identifier_type>

</relidentifier_detail>

<relidentifier_detail relationType="References"

relatedIdentifierType="DOI">

Preview image for Page 56.

Preview image for Page 57.