U.S. Department of Energy
Scientific and Technical Information Program

DOE Laboratory Researchers Financial Awardees and Grantees Headquarters DOE Laboratory Researchers Click the Product Type to preview and download Fact Sheets. Accepted Manuscripts Book/Monograph Conference Paper/Presentation or Proceedings Patents Program Documents ... Scientific Datasets Scientific/Technical Software Thesis/Dissertation Technical/Workshop Report Scientific Videos Download: Accepted Manuscripts (PDF 557.65 KB) Figure 277572: Factsheet for DOE Lab Researchers: Accepted Manuscripts - Page 1 Factsheet for DOE Lab Researchers: Accepted Manuscripts - Page 1 STI Product Fact Sheet for DOE Laboratory Researchers:Accepted Manuscripts ABOUT STIIn the course of performing research and development (R&D) and other scientific and technological work, researchers funded by the U.S. Department of Energy (DOE) produce scientific and technical information (STI) to document and disseminate their findings.STI includes products such as journal articles, technical reports, conference presentations, books, and more. Through the Scientific and Technical Information Program (STIP), the DOE Office of Scientific and Technical Information (OSTI) collaborates with people across the DOE complex, including Headquarters programs, field offices, national laboratories, and other facilities. The STIP partnership ensures that the results of DOE- funded work are identified, disseminated, and preserved. Thus, OSTI collects STI produced across the DOE laboratory and facility complex as well as from financial assistance recipients.The Department's 2014 Public Access Plan added accepted manuscripts as a form of STI to be submitted to OSTI.DEFINITIONAn accepted manuscript of a scholarly publication (i.e., journal article) is the final peer-reviewed accepted manuscript accepted for publication. This final version of the article which has been accepted by a publisher includes changes made during the peer-review process. Thus, it has the same content as the published article, but it is not the final published version or reproduction copy of what appears in the journal (i.e., it is not a "reprint" of the published article). The key criteria for submission of accepted manuscripts to DOE OSTI are (1) DOE partially or completely funded the research reflected in the article or accepted manuscript and (2) the article has been accepted for publication in a peer-reviewed journal. It is preferred that the final journal publication information (e.g., Digital Object Identifier) be included at the time of submission to OSTI to aid in the processing and display of the best available version.SUBMISSIONS Each DOE laboratory has a site program to manage scientific and technical information produced under the contract and to make it available to DOE's Office of Scientific and Technical Information. Each site's STI Manager is involved in the process; for more information, see the listing of STI Managers at http://www.osti.gov/stip/stimanagers.Using a Lab's processes for STI submission, the researcher should provide metadata/citation information for the journal article as well as an upload of the accepted manuscript in PDF format. This is comparable to the current submission process for technical reports. factsheet-acceptedmanuscripts-labs-feb-2020-1.jpg Printer-friendly version Figure 277573: Factsheet for DOE Lab Researchers: Accepted Manuscripts - Page 2 Factsheet for DOE Lab Researchers: Accepted Manuscripts - Page 2 STI AVAILABILITYOSTI.GOV (https://www.osti.gov) is the primary search tool for DOE science, technology, and engineering research and development results and the organizational hub for information about the DOE Office of Scientific and Technical Information.  OSTI.GOV makes discoverable over 70 years of research results from DOE and its predecessor agencies.  Research results include journal articles/accepted manuscripts and related metadata; technical reports; scientific research datasets and collections; scientific software; patents; conference and workshop papers; books and theses; and multimedia.  OSTI.GOV contains over 3 million records, including citations to 1.6 million journal articles, 1.1 million of which have digital object identifiers (DOIs) linking to full-text articles on publishers' websites.  OSTI.GOV provides access to this DOE STI by offering numerous easy-to-use search capabilities and customization options; and for the DOE community, additional citation information is available to help researchers evaluate article impact and find related research.DOE PAGES (Public Access Gateway for Energy and Science - http://www.osti.gov/pages) is the Department's portal and search interface that offers free access to the best available full-text version of DOE-affiliated scholarly publications. Articles will be made publicly available after an administrative period of 12 months from publication date.OSTI.GOV and DOE PAGES are included in the Federal science portal Science.gov (https://www.science.gov) and the international science portal WorldWideScience.org (https://worldwidescience.org).  Science.gov, hosted by OSTI, offers free access to research and development (R&D) results and scientific and technical information from more than 60 databases from scientific organizations across 13 federal agencies.  WorldWideScience.org searches over 100 STI resources including national libraries and information centers from more than 70 countries.OSTI also works in close collaboration with Google and others, using Sitemap Protocols and other information industry standards to facilitate the discovery of DOE STI through widely used search engines.ADDITIONAL INFORMATION/CONTACTSThe STIP website at https://www.osti.gov/stip/OSTI staff will respond to questions/suggestions sent to stip@osti.govQuestions related to E-Link may also be sent to Elink_Helpdesk@osti.gov factsheet-acceptedmanuscripts-labs-feb-2020-2.jpg Printer-friendly version Download: Book/Monograph (PDF 525.21 KB) Figure 277576: Factsheet for DOE Lab Researchers: Book/Monograph - Page 1 Factsheet for DOE Lab Researchers: Book/Monograph - Page 1 STI Product Type Fact Sheet for DOE Laboratory ResearchersBooks and MonographsABOUT STIIn the course of performing research and development (R&D) and other scientific and technological work, researchers funded by the U.S. Department of Energy (DOE) produce scientific and technical information (STI) to document and disseminate their findings.STI includes products such as journal articles, technical reports, conference presentations, books, and more. Through the Scientific and Technical Information Program (STIP), the DOE Office of Scientific and Technical Information (OSTI) collaborates with people across the DOE complex, including Headquarters programs, field offices, national laboratories, and other facilities. The STIP partnership ensures that the results of DOE- funded work are identified, disseminated, and preserved. Thus, OSTI collects STI produced across the DOE laboratory and facility complex as well as from financial assistance recipients.DEFINITIONAs an STI product, a book or monograph is a scholarly piece of writing on a specific subject. It may contain a detailed written study of a single specialized subject or an aspect of it, including a manual describing a particular process. Each volume is a self-contained work, yet monographs may be a published in a series to provide detailed information on a specialized scientific or technical topic. A book may also be composed of chapters, and the STI product may be just one part or topic in the whole book to be published. Books and monographs may be published by the originating site (e.g., as e-books or technical fact sheets) or by a commercial publisher. If the STI product is a chapter, reference should also be made to the whole book.SUBMISSIONSEach DOE laboratory has a site program to manage scientific and technical information produced under the contract and to make it available to DOE's Office of Scientific and Technical Information. Each site's STI Manager is involved in the process; for more information, see the listing of STI Managers at http://www.osti.gov/stip/stimanagers.Using a Lab's processes for STI submission, the author provides metadata for a book or monograph as well as a full-text document in searchable PDF format, if it is publicly accessible. If the STI product is copyrighted by a commercial publisher, then an announcement notice only may be submitted, providing metadata and the source of availability. factsheet-booksmonographs-labs-feb-2020-1.jpg Printer-friendly version Figure 277577: Factsheet for DOE Lab Researchers: Book/Monograph - Page 2 Factsheet for DOE Lab Researchers: Book/Monograph - Page 2 OSTI.GOV is included in the Federal science portal Science.gov (https://www.science.gov) and the international science portal WorldWideScience.org (https://worldwidescience.org). Science.gov, hosted by OSTI, offers free access to research and development (R&D) results and scientific and technical information from more than 60 databases from scientific organizations across 13 federal agencies.  WorldWideScience.org searches over 100 STI resources including national libraries and information centers from more than 70 countries.OSTI also works in close collaboration with Google and others, using Sitemap Protocols and other information industry standards to facilitate the discovery of DOE STI through widely used search engines.ADDITIONAL INFORMATION/CONTACTSThe STIP website at https://www.osti.gov/stip/OSTI staff will respond to questions/suggestions sent to stip@osti.govQuestions related to E-Link may also be sent to Elink_Helpdesk@osti.gov factsheet-booksmonographs-labs-feb-2020-2.jpg Printer-friendly version Download: Conference Paper/Presentation or Proceedings (PDF 549.74 KB) Figure 277570: Factsheet for DOE Lab Researchers: Conference Paper/Presentation or Proceedings - Page 1 Factsheet for DOE Lab Researchers: Conference Paper/Presentation or Proceedings - Page 1 STI Product Type Factsheet for DOE Laboratory ResearchersConference Paper/Presentation or ProceedingsABOUT STIIn the course of performing research and development (R&D) and other scientific and technological work, researchers funded by the U.S. Department of Energy (DOE) produce scientific and technical information (STI) to document and disseminate their findings.STI includes products such as journal articles, technical reports, conference presentations, books, and more. Through the Scientific and Technical Information Program (STIP), the DOE Office of Scientific and Technical Information (OSTI) collaborates with people across the DOE complex, including Headquarters programs, field offices, national laboratories, and other facilities. The STIP partnership ensures that the results of DOE- funded work are identified, disseminated, and preserved. Thus, OSTI collects STI produced across the DOE laboratory and facility complex as well as from financial assistance recipients.DEFINITIONA conference paper/presentation or proceedings is a type of scientific and technical information (STI) product from a conference, symposium, lecture, or similar event. Individual papers and presentations are those presented at an event by an individual whose work was sponsored by DOE, while a conference proceedings is the compilation of a group of papers from a conference, workshop, seminar, etc., typically prepared at the request of a DOE program that sponsored work in the area covered by the conference. Papers and proceedings are typically PDF documents, while presentations may be PowerPoint slides, posters, or videos. [See also the fact sheet for "Videos"].SUBMISSIONSEach DOE laboratory has a site program to manage scientific and technical information produced under the contract and to make it available to DOE's Office of Scientific and Technical Information. Each site's STI Manager is involved in the process; for more information, see the listing of STI Managers at http://www.osti.gov/stip/stimanagers.  Using the Lab's processes for STI submission, the researcher should provide metadata/citation information for conference papers/presentations or proceedings plus an upload in PDF. If the item has been commercially published (within conference proceedings, for example), then an announcement record only (metadata and availability information) may be submitted if copyright restrictions are imposed on the product. See also the "Videos" fact sheet for more specific guidance. factsheet-conferencepaperpresentationproceedings-labs-feb-2020-1.jpg Printer-friendly version Figure 277571: Factsheet for DOE Lab Researchers: Conference Paper/Presentation or Proceedings - Page 2 Factsheet for DOE Lab Researchers: Conference Paper/Presentation or Proceedings - Page 2 STI AVAILABILITYOSTI.GOV (https://www.osti.gov) is the primary search tool for DOE science, technology, and engineering research and development results and the organizational hub for information about the DOE Office of Scientific and Technical Information.  OSTI.GOV makes discoverable over 70 years of research results from DOE and its predecessor agencies.  Research results include journal articles/accepted manuscripts and related metadata; technical reports; scientific research datasets and collections; scientific software; patents; conference and workshop papers; books and theses; and multimedia.  OSTI.GOV contains over 3 million records, including citations to 1.6 million journal articles, 1.1 million of which have digital object identifiers (DOIs) linking to full-text articles on publishers' websites.  OSTI.GOV provides access to this DOE STI by offering numerous easy-to-use search capabilities and customization options; and for the DOE community, additional citation information is available to help researchers evaluate article impact and find related research.DOE ScienceCinema (http://www.osti.gov/sciencecinema) includes more than 3,700 multimedia scientific videos from DOE national laboratories, other DOE research Facilities and CERN (European Organization for Nuclear Research), and makes them searchable using Watson speech‐recognition search technology. The ability to search and "jump to" the spoken words in a video that may be an hour or longer is a unique, added value.OSTI.GOV and DOE ScienceCinema are included in the Federal science portal Science.gov (https://www.science.gov) and the international science portal WorldWideScience.org (https://worldwidescience.org).  Science.gov, hosted by OSTI, offers free access to research and development (R&D) results and scientific and technical information from more than 60 databases from scientific organizations across 13 federal agencies.  WorldWideScience.org searches over 100 STI resources including national libraries and information centers from more than 70 countries.OSTI also works in close collaboration with Google and others, using Sitemap Protocols and other information industry standards to facilitate the discovery of DOE STI through widely used search engines.ADDITIONAL INFORMATION/CONTACTSThe STIP website at https://www.osti.gov/stip/OSTI staff will respond to questions/suggestions sent to stip@osti.govQuestions related to E-Link may also be sent to Elink_Helpdesk@osti.gov factsheet-conferencepaperpresentationproceedings-labs-feb-2020-2.jpg Printer-friendly version Download: Patents (PDF 548.40 KB) Figure 277578: Factsheet for DOE Lab Researchers: Patents - Page 1 Factsheet for DOE Lab Researchers: Patents - Page 1 STIP Product Type Fact Sheet for DOE Laboratory ResearchersPatentsABOUT STIIn the course of performing research and development (R&D) and other scientific and technological work, researchers funded by the U.S. Department of Energy (DOE) produce scientific and technical information (STI) to document and disseminate their findings.STI includes products such as journal articles, technical reports, conference presentations, books, and more. Through the Scientific and Technical Information Program (STIP), the DOE Office of Scientific and Technical Information (OSTI) collaborates with people across the DOE complex, including Headquarters programs, field offices, national laboratories, and other facilities. The STIP partnership ensures that the results of DOE- funded work are identified, disseminated, and preserved. Thus, OSTI collects STI produced across the DOE laboratory and facility complex as well as from financial assistance recipients.DEFINITIONA patent for an invention is the grant of a property right to the inventor, which in the United States is issued by the U. S. Patent and Trademark Office (USPTO). The patent gives the holder exclusive rights to a process, design or new invention for a designated period of time. The assignee could be a government agency or a company that is a contractor or grant recipient. After a patent is issued, the USPTO includes the patent in its database, making the patent application, full text, and other descriptive information accessible to the public. If DOE-funded research led to the patent, then this research result is of interest to DOE as a form of STI. The DOE Office of Scientific and Technical Information (OSTI) obtains patent records of interest to DOE directly from USPTO; however, to ensure comprehensiveness, broad dissemination, and archival preservation, inventors funded by DOE may find it useful to submit information to OSTI through their particular STI submission channels.SUBMISSIONSEach DOE laboratory has a site program to manage scientific and technical information produced under the contract and to make it available to DOE's Office of Scientific and Technical Information. Each site's STI Manager is involved in the process; for more information, see the listing of STI Managers at http://www.osti.gov/stip/stimanagers.For patents, the researcher has the option to (1) use the Lab's processes for STI submission, providing metadata for a patent as well as a full-text document in searchable PDF format or (2) rely on the OSTI-USPTO process for ensuring access via a link to the document hosted by USPTO. If the latter is the Lab's preference, periodic review of the Lab's patents in the OSTI collection is desirable to ensure that all patents from the Lab are being included. factsheet-patents-labs-feb-2020-1.jpg Printer-friendly version Figure 277579: Factsheet for DOE Lab Researchers: Patents - Page 2 Factsheet for DOE Lab Researchers: Patents - Page 2 STI AVAILABILITYOSTI.GOV (https://www.osti.gov) is the primary search tool for DOE science, technology, and engineering research and development results and the organizational hub for information about the DOE Office of Scientific and Technical Information.  OSTI.GOV makes discoverable over 70 years of research results from DOE and its predecessor agencies.  Research results include journal articles/accepted manuscripts and related metadata; technical reports; scientific research datasets and collections; scientific software; patents; conference and workshop papers; books and theses; and multimedia.  OSTI.GOV contains over 3 million records, including citations to 1.6 million journal articles, 1.1 million of which have digital object identifiers (DOIs) linking to full-text articles on publishers' websites.  OSTI.GOV provides access to this DOE STI by offering numerous easy-to-use search capabilities and customization options; and for the DOE community, additional citation information is available to help researchers evaluate article impact and find related research.DOE Patents (http://www.osti.gov/doepatents)  is a search tool for discovering patent information resulting from DOE-funded research and development (R&D), consisting of bibliographic records with full text where available, either via a PDF document or a link to the record at the USPTO (http://www.uspto.gov).  DOE Patents provides comprehensive coverage of patents resulting from DOE funding.OSTI.GOV and DOE Patents are included in the Federal science portal Science.gov (https://www.science.gov) and the international science portal WorldWideScience.org (https://worldwidescience.org).  Science.gov, hosted by OSTI, offers free access to research and development (R&D) results and scientific and technical information from more than 60 databases from scientific organizations across 13 federal agencies.  WorldWideScience.org searches over 100 STI resources including national libraries and information centers from more than 70 countries.OSTI also works in close collaboration with Google and others, using Sitemap Protocols and other information industry standards to facilitate the discovery of DOE STI through widely used search engines.ADDITIONAL INFORMATION/CONTACTSThe STIP website at https://www.osti.gov/stip/OSTI staff will respond to questions/suggestions sent to stip@osti.govQuestions related to E-Link may also be sent to Elink_Helpdesk@osti.gov factsheet-patents-labs-feb-2020-2.jpg Printer-friendly version Download: Program Documents (PDF 526.27 KB) Figure 277574: Factsheet for DOE Lab Researchers: Program Documents - Page 1...

241.1 Web Service Instructions (PDF 960.27 KB) The images below are previews of the AN 241.1 Web Service Instructions PDF. Page 1 Figure 277401: Announcement Notice 241.1 Web Service for STI - Page 1 Announcement Notice 241.1 Web Service for STI - Page 1 ... OSTI's Announcement Notice 241.1Web Service for STIVersion 6.3, August 2020Contents1.0 About1.1 Announcement Notice 241.11.2 OSTI's AN 241.1 Web Service2.0 Using the AN 241.1 Web Service2.1 Credentials and Authentication2.2 POST (Create or Update) and GET (Retrieve)2.3 Response and Notifications2.4 Transmitting Full-Text Products to OSTI3.0 AN 241.1 Web Service Metadata3.1 AN 241.1 Required Fields3.2 Required Fields (Cont):  Access Limitation(s) Attributes and Values3.3 AN 241.1 Optional Fields4.0 AppendicesA.1 Related IdentifiersA.2 Examples of XML 241.1 Metadata RecordsNew in this revision:•  Editorial updates 2411 Webservice Updated Template-01.jpg Printer-friendly version Page 2 Figure 277402: Announcement Notice 241.1 Web Service for STI - Page 2 Announcement Notice 241.1 Web Service for STI - Page 2 1.0   About1.1 Announcement Notice 241.1Announcement Notice (AN) 241.1 provides the Office of Scientific and Technical Information (OSTI) with the information needed to identify, process, announce and disseminate the results of work funded by the Department of Energy (DOE) or performed in DOE facilities (see DOE Order 241.1B (link is external)).   When submitted, the AN 241.1 set of metadata creates a citation/record that is processed by E-Link and then transferred into the appropriate databases for access (see search tools Search Tools).DOE sites can manually submit AN 241.1 metadata a single record at a time through a web interface on E-Link (www.osti.gov/elink) (link is external).  The AN 241.1 Web Service provides an additional option for submitting DOE's scientific and technical (STI) products to OSTI for dissemination.  The STI product will be a full text document, such as a technical report, thesis or dissertation, book, journal literature, conference literature, or a program document.  It could also be a multimedia file.AN 241.1 metadata and products submitted to OSTI, whether through a manual process or an automated process, are subject to the same requirements.  A designated Releasing Official must ensure that each record has been reviewed for any content that would make it appropriate for release to the public.  The Releasing Official is also responsible to ensure that full text documents posted on site or transmitted to OSTI do not contain Personally Identifiable Information (PII) (see https://www.osti.gov/elink/faq.jsp#PII (link is external)).  Use of the AN 241.1 Web Service does not remove these responsibilities from the Releasing Official.STI from DOE's research and development activities is disseminated through OSTI's databases such as OSTI.GOV, through multiagency databases such as Science.gov (link is external), through global databases such as WorldWideScience.org (link is external), and through arrangements with major Internet search engines such as Google. 1.2 OSTI's AN 241.1 Web ServiceOSTI's AN 241.1 Web Service allows a submitting site to send AN 241.1 information in a completely automated manner.  Metadata is generated at the submitting site per the programming set-up by the site's IT developers and POSTed as an output file to OSTI.  The schedule for the POST operation may be multiple times daily, once daily, once weekly, etc. 2411 Web Service for STI Version 6.3 August 2020-02.jpg Printer-friendly version Page 3 Figure 277403: Announcement Notice 241.1 Web Service for STI - Page 3 Announcement Notice 241.1 Web Service for STI - Page 3 Records with unlimited access status and those with limited access can both be transmitted through the secure AN 241.1 Web Service.  DOE organizations may establish a URL link to the unclassified, unlimited STI products on their websites and send the URL in the metadata or they may transmit the full text product to OSTI.  All limited access (Controlled Unclassified Information or CUI) full text are required to be transmitted to OSTI and cannot be posted on the site's public web.The AN 241.1 Web Service provides the ability to submit new Announcement records, edit/update records, or retrieve a record for review.  A user manipulates a record by performing HTTP operations on the web service URL and providing XML metadata.  The POST command/request allows a submitter to create or edit/update AN 241.1 records.  The GET command/request allows a submitter to retrieve a record for review.  Submitters must coordinate with OSTI and submit records to a test environment before POSTing their first XML file for dissemination.  The URL for Test E-Link is https://www.osti.gov/elinktest/2411api.   OSTI's production web service for announcing STI is available at https://www.osti.gov/elink/2411api. 2.0 Using the AN 241.1 Web Service2.1 Credentials and AuthenticationAN 241.1 transactions require an active E-Link user account.  To request personal access to E-Link and obtain an active account, visit https://www.osti.gov/elink/register.jsp.  To obtain an account for your client server to connect to OSTI's web service, contact E-Link Product Manager, Kim Buckner (bucknerk@osti.gov).  Your web service account will be given a login name and password for Test E-Link.  After testing is completed, you will be provided a login and password for production E-Link, as well as a separate password for your site's SFTP.The AN 241.1 Web Service supports HTTP Basic authentication over SSL.  With this method, the client connects to the HTTPS URL for either Test E-Link or, when testing is complete, for production E-Link. The POST and GET verb commands will pass along the standard Authentication HTTP header (base64 encoding). 2411 Webservice Updated Template-03.jpg Printer-friendly version Page 4 Figure 277404: Announcement Notice 241.1 Web Service for STI - Page 4 Announcement Notice 241.1 Web Service for STI - Page 4 2.2 POST (Create or Update) and GET (Retrieve) [Client to OSTI]After successful authentication, the input body of the POST or GET request is read as an XML document, parsed, and loaded appropriately into E-Link.  HTML status codes (200=OK, 401=Unauthorized, 500=System error, etc.) and an XML response, which includes certain metadata fields, are returned by OSTI's server to the client server to notify of either success in loading the record or failure.  The POST command/request is most often used to submit metadata for a new record that is being provided to OSTI for the first time, but it can also be used to edit or update an existing record that has previously been submitted.  Submitters must "tell" the system which of the two activities they intend for a record.  The OSTI ID is key to this.  How and why is explained below:When POSTING to an existing record in order to update it, the OSTI ID must be included in the XML record.  The updated information will then overwrite the previously submitted information.   If the OSTI ID is not included when trying to POST to an existing record, the Web Service believes you are wanting to create rather than update.  It will create a duplicate record, but with a new, different OSTI ID.  This situation always requires correction by logging into E-Link manually and manually deleting the duplicate record.Metadata can be retrieved for any record previously submitted by your organization by using a GET request and supplying the OSTI ID as a parameter in the request.  Authentication is required and is handled in the same fashion as a Create/Update command.  The requested OSTI ID returns that specific XML record.  A GET operation will not update a record, however.                2.3 Response and Notifications [OSTI to Client]OSTI's server makes an immediate response when the client-side server sends a POST or a GET request.  The primary goal of the response is two-fold:  to let the client server "know" if it connected successfully and to provide a status message about the record that was POSTed or retrieved.  The status says SUCCESS if the record correctly transmitted and the metadata loaded into E-Link. The status says FAILURE if the record was unable to load for any reason.  The FAILURE response includes a message indicating the error or problem that kept the record from loading.  Errors leading to a FAILURE response occur when a required metadata field is missing, when a site URL cannot be validated by the automated validation process, when a value is too long for the field it must load into, etc.Note that the successful record returns its newly assigned OSTI ID.  The response for the failed record will not have an OSTI ID since IDs cannot be assigned to records that never actually make it into E-Link. 2411 Webservice Updated Template-04.jpg Printer-friendly version Page 5 Figure 277405: Announcement Notice 241.1 Web Service for STI - Page 5 Announcement Notice 241.1 Web Service for STI - Page 5 E-Link also generates an email containing the SUCCESS or FAILURE information about each submitted record.  The site will be asked to provide to OSTI the names of the people to whom these automated emails will be sent. It is the submitting site's responsibility to review the results of the web service transactions and to correct, then resubmit those records that initially failed.2.4 Transmitting Full-Text Products to OSTIA secure FTP directory is set-up at OSTI for each site utilizing the AN 241.1 Web Service.  A site cannot access any other site's SFTP directory...only the one assigned specifically to it.  The process for providing both a metadata record and its corresponding full text product is as follows: Site submits an XML metadata record to OSTI's E-Link system via the AN 241.1 Web Service. The AN 241.1 Web Service notifies the submitting site that the XML record loaded successfully into E-Link and includes the newly assigned OSTI ID in the notification message.  Notification goes out via server-to-server messaging and via an email to a site's designated distribution list.A "script" written by the site's (client) software developers adds the new OSTI ID to the site's (client) database (records publishing system, review and approval system, etc.).The "script" also reaches out to rename the corresponding full-text product, changing its file name from whatever it was originally to the new OSTI ID number.  Only the number is used as the name, not any part of the OSTI ID text that sometimes prefixes the number.    Example: a file named DOELAB-27834.pdf would be renamed 114073.pdf (if OSTI ID 114073 had been assigned to the corresponding metadata XML record).Another automated command in the submitting site's (client) programming then transmits the file named 114073.pdf to the site's assigned SFTP directory.The metadata record was submitted first and has been waiting in E-Link.  It will not complete processing until E-Link recognizes that a document with the same OSTI ID is now present in the site's assigned SFTP directory. If, on the first night after the XML record's submittal, E-Link does not detect a matching full-text product, the record stays in its "Submitted" state in E-Link.  It will stay that way, as many days as it takes, until the full text product arrives from the site.When E-Link recognizes that a full text product has arrived in the site's (client) directory and that the product has an OSTI ID matching a metadata record from the same site code, a siphon process takes place.  The process attaches the product to the record. 2411 Webservice Updated Template-05.jpg Printer-friendly version Page 6 Figure 277406: Announcement Notice 241.1 Web Service for STI - Page 6 Announcement Notice 241.1 Web Service for STI - Page 6 When E-Link recognizes that a full text product has arrived in the site's (client) directory and that the product has an OSTI ID matching a metadata record from the same site code, a siphon process takes place.  The process attaches the product to the record.After the "marriage," the record and its full text go through a "transfer" process that makes them available in the appropriate database.  CUI records and documents are transferred to Science Research Connection (SRC) (see www.osti.gov/src), a password-protected system available only to DOE and DOE contractors.  Unlimited records will be sent to OSTI.gov, Pages, or other databases.3.0 AN 241.1 Web Service Metadata3.1 AN 241.1 Required FieldsThe following is a list of the required fields for the AN 241.1 Web Service.  These fields are also designated by an asterisk (*).  Records submitted without required fields will fail to load into E-Link for processing.  The other fields available for your use are optional, though some, such as the Abstract/Description, are highly encouraged. NOTE:  The OSTI ID is a required field for all POST requests where the intent is to edit or update records.  The GET request must also include the OSTI ID and will allow retrieval of a record previously submitted by your site.REQUIRED Field NameXML Tag NameAdditional Information1OSTI ID+The OSTI ID is required in all requests intended to edit or update existing records. When POSTing new records to OSTI, no tag is needed in the XML.  E-Link automatically assigns an OSTI ID to each new record successfully submitted.2Record Status*      These tags are required to inform the system of the status of the record being submitted. For new records, only the is needed. For revised metadata or revised/replaced full text products (revprod/), the OSTI ID must be included as an attribute.  See format below.  2411 Webservice Updated Template-06.jpg Printer-friendly version Page 7 Figure 277407: Announcement Notice 241.1 Web Service for STI - Page 7 Announcement Notice 241.1 Web Service for STI - Page 7 Record Status Attributes are needed for revdata tag and revprod tag.(Note the single quote marks around the attribute value) 3Site Code*The site code value is assigned by OSTI to the submitting site and must be present in each XML record.4Product Type*The values are upper case letters. Only one code can be placed in this field. Depending on the code, additional information may be needed. The allowed values are:  CodeDefinitionTRTechnical Report or Workshop Report COConference/Event Paper, Proceedings, or Presentation If product type = CO, the following field is also needed:  Conference Information = Include conference name,conference location, and conference inclusive datesInclude name of conference, location, and inclusive dates. Product Sub-Type CodesCodeDefinitionAConference PaperRConference Presentation (may receive a DOI)OConference Poster (may receive a DOI)PConference Proceedings Example Conference Sub-Type       CO      2411 Webservice Updated Template-07.jpg Printer-friendly version Page 8 Figure 277408: Announcement Notice 241.1 Web Service for STI - Page 8 Announcement Notice 241.1 Web Service for STI - Page 8    FSFactsheet JAJournal Article If product type = JA, the following field is also required:Journal Type data  Allowed values are AC (for announcement citation only), FT (author's early manuscript), or AM (Accepted Manuscript, meaning the final author's version after peer review comments are incorporated).  When FT or AM are the values, the medium code used will be ED (see later in this table). NOTE the requirement to make the Accepted Manuscript available to OSTI andto place AM as the value in data applies to journal articles published October 1, 2014 or later.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .These fields are also needed for JA records:Journal Name       Journal Volume    Journal Issue        Journal Serial ID Page Range            NOTEProvide the page range as p. xx-xx.  If the journal uses article numbers, that value may also be used in this fieldIf you know the DOI that the publisher has assigned to the journal article, please include it also.  The tag for the DOI field is   TDThesis or DissertationPDProgram DocumentBBook/Monograph 2411 Webservice Updated Template-08.jpg Printer-friendly version Page 9 Figure 277409: Announcement Notice 241.1 Web Service for STI - Page 9 Announcement Notice 241.1 Web Service for STI - Page 9    If product type = B, the following field is also needed:Publisher Information Include name of publisher and city, state, and country if other than U.S.ARAccomplishment ReportPPatent If product type = P, the following field is also needed:Patent Assignee 5STI Product Title*Full title of the STI Product.  Include version number, if applicable.6USE THE 6.1 FORMAT BELOW FOR AUTHOR INFORMATION WHEN POSSIBLE6.1Author(s) Preferred format for authors and required in some cases. Note:  Names of collaborations do not go in the author fields. (See Contributing Orgs in section  3.3 AN 241.1 Optional Fields below)      Use the block of tags if you are including ORCID number with any of the authors in the submitted record.When the submitted record has the block of tags, ALL author names MUST be broken out into this block format (even if only one of the names has an accompanying ORCID).NOTE the middle name, email, affiliation, and ORCID parts of the authors "block" format may be left blank if no value is available." 6.2Author(s)* Note:  Names of collaborations do not go in the author fields. (See Contributing Orgs in section  3.3 AN 241.1 Optional Fields below)  Format is Last Name, First Name, MISeparate multiple authors with a semi-colon followed by a space.  Affiliations may be place in square brackets after each author's name.Doe, John [National Tech, Inc.]; Smith, Nancy [Brookhaven National Laboratory] 2411 Webservice Updated Template-09.jpg Printer-friendly version Page 10 Figure 277410: Announcement Notice 241.1 Web Service for STI - Page 10 Announcement Notice 241.1 Web Service for STI - Page 10 7Report/Product Number(s)*  A value in this field is required but the word, None, may be used if no valid report number or product number exists.TR and TD product types should always have valid report numbers.8DOE Contract Number(s)* Use the format of the contract "as is," but remove any preceding "DE". If multiple contract numbers apply, separate with a semi-colon followed by a space.9Originating ResearchOrganization*   For DOE...

DOE Data ID Services Manual (PDF 2.07 MB) The images below are previews of the DOE Data ID Services Manual PDF (DOE Data ID Services Manual.pdf). AN241.6 Web Service Instructions Title Page - Preview Figure 277725: DOE Data ID Services Title Page DOE Data ID Services Title ...Page DOE Data ID ServiceAnnouncing and Registering DOE's Datasets via Announcement Notice (AN) 241.6Manual Version 7.2, January 2021 DOE Data ID Service Manual v7-2 Jan2021-01.png Printer-friendly version AN241.6 Web Service Instructions Table of Contents - Preview Figure 277726: DOE Data ID Services 6 1 02 DOE Data ID Services 6 1 02 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 Manual v7-2 Jan2021-02.png Printer-friendly version AN241.6 Web Service Instructions Page 1 - Preview Figure 277727: DOE Data ID Services 6 1 03 DOE Data ID Services 6 1 03 DOE Data ID Service BackgroundIn 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-Link1 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. DOE Data ID Service Manual v7-2 Jan2021-03.png Printer-friendly version AN241.6 Web Service Instructions Page 2 - Preview Figure 277728: DOE Data ID Services 6 1 04 DOE Data ID Services 6 1 04 and supports better linkages between DOE's 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 recordThe 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 site's STI Manager2 to arrange for manual submittal.2. Application Programming Interface (API) - Multiple metadata recordsOSTI 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/2416apiProduction E-Link Endpoint: https://www.osti.gov/elink/2416apiFor more information about the API, please click here: E-Link 241.6 API Documentation2 Each DOE national Laboratory has a designated point of contact for coordinating submissions of scientific and technical information (STI) to OSTI. DOE Data ID Service Manual v7-2 Jan2021-04.png Printer-friendly version AN241.6 Web Service Instructions Page 3 - Preview Figure 277729: DOE Data ID Services 6 1 05 DOE Data ID Services 6 1 05 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.jspThe workflow below explains the entire submission workflow from submission to E-Link to display in OSTI's output search products.Dataset Record Submission WorkflowThe 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, OSTI's 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. DOE Data ID Service Manual v7-2 Jan2021-05.png Printer-friendly version AN241.6 Web Service Instructions Page 4 - Preview Figure 277730: DOE Data ID Services 6 1 06 DOE Data ID Services 6 1 06 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.3DOIs 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 Crossref's persistent identifiers webpage at https://www.crossref.org/blog/global-persistent-identifiers-for-grants-awards-and-facilities/ DOE Data ID Service Manual v7-2 Jan2021-06.png Printer-friendly version AN241.6 Web Service Instructions Page 5 - Preview Figure 277731: DOE Data ID Services 6 1 07 DOE Data ID Services 6 1 07 1.2 General RequirementsGeneral requirements have been established for data registration. The submitter must:Provide the required metadata to enable basic, bibliographic citationHave the authority to make the data public, as the data owner, PI, or other designated submitterGuarantee the persistence of registered dataEnsuring that data are stored and managed for indefinite access and usabilityMaintaining and updating all landing pages/URLs associated with the DOIOSTI DOES NOT CURRENTLY PROVIDE A REPOSITORY TO HOST DATASETS.1.3 Understanding Key ComponentsGranularity 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 DOE Data ID Service Manual v7-2 Jan2021-07.png Printer-friendly version AN241.6 Web Service Instructions Page 6 - Preview Figure 277732: DOE Data ID Services 6 1 08 DOE Data ID Services 6 1 08 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: 10Registrant Prefix: XXXXOptional Intelligence: InfixSuffix: OSTI IDThe 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 DOE Data ID Service Manual v7-2 Jan2021-08.png Printer-friendly version AN241.6 Web Service Instructions Page 7 - Preview Figure 277733: DOE Data ID Services 6 1 09 DOE Data ID Services 6 1 09 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. DOE Data ID Service Manual v7-2 Jan2021-09.png Printer-friendly version AN241.6 Web Service Instructions Page 8 - Preview Figure 277734: DOE Data ID Services 6 1 10 DOE Data ID Services 6 1 10 1.5 The Landing PageA 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 informationLinks to software needed to open, view, download or analyze the dataUpdate and version informationContact informationBelow 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. DOE Data ID Service Manual v7-2 Jan2021-10.png Printer-friendly version AN241.6 Web Service Instructions Page 9 - Preview Figure 277735: DOE Data ID Services 6 1 11 DOE Data ID Services 6 1 11 2. Submitting Metadata to Obtain a DOI2.1 Scientific Research Datasets 241.6 Web Submission Interface- Single Metadata RecordThe 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 site's 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:Creating a site code in E-LinkAssigning a unique DOI prefix to a user's submissionsCreating the account at DataCiteCreating login credentials on Production E-LinkFinancial 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. DOE Data ID Service Manual v7-2 Jan2021-11.png Printer-friendly version AN241.6 Web Service Instructions Page 10 - Preview Figure 277736: DOE Data ID Services 6 1 12 DOE Data ID Services 6 1 12 2.2 Application Programming Interface (API)- Multiple Metadata RecordsOSTI offers an Application Programming Interface (API) for POST (submit) and GET (retrieval) functions.Establishing Test CredentialsTo 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 OSTI's 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: 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.DOI Prefix -The DOI prefix, beginning with 10., is unique to the site code. Every DOI assigned to the user's datasets by the DOE Data ID Service will begin with this prefix.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 server's transmission file. DOE Data ID Service Manual v7-2 Jan2021-12.png Printer-friendly version AN241.6 Web Service Instructions Page 11 - Preview Figure 277737: DOE Data ID Services 6 1 13 DOE Data ID Services 6 1 13 Confirming Test Credentials - New Client/SubmitterConfirm that the Test credentials are working by:Go to Test E-Link/TEST 241.6 web service: https://www.osti.gov/elinktest/2416apiA...