2018 STIP Working Meeting

STIP and the DOE National Laboratory Library Coalition (NLLC) are combining efforts and the STIP / NLLC meetings will be held the week of April 16 – April 20 at Jefferson Lab in Newport News, VA.

Meeting information can be found at https://www.jlab.org/conferences/stip2018/index.html

AN241.1 Web Services

OSTI’s Announcement Notice 241.1

Web Service for STI


One option available for DOE sites to submit AN 241.1 metadata for STI products is the AN 241.1 Web Service. The STI product will be a full text document, such as a technical report, thesis/dissertation, book, journal literature, conference literature, or a program document. It could also be multimedia.

OSTI’s 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.

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 post the STI products they generate on their own websites and send the URL in the metadata or they may transmit the full text product to OSTI. All Limited Access records are required to be sent to OSTI and cannot be posted on the site’s public web.

The AN 241.1 Web Service provides the ability to submit new AN 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.

For more information about the Web Service and how to make arrangements with OSTI, see the 241.1 Web Services Manual below.


OSTI’s Announcement Notice 241.1

Web Service for STI 

Version 6.1, February 2018




1.0  About

1.1  Announcement Notice 241.1

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

DOE sites can manually submit AN 241.1 metadata a single record at a time through a web interface on E-Link or submit multiple records in an XML file via E-Link’s Batch Upload system.  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, a batch 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 inappropriate for release to the general 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).  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, through global databases such as WorldWideScience.org, and through arrangements with major Internet search engines such as Google.  


1.2  OSTI’s AN 241.1 Web Service

OSTI’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. 

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 post the unclassified, unlimited STI products they generate on their own 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) records 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 actual dissemination.  The URL for TEST E-Link in the test environment 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 Service

2.1  Credentials and Authentication

All AN 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 first.  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).


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 IDThis 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.

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 OSTI

A 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: 

  1. Site submits an XML metadata record to OSTI’s E-Link system via the AN 241.1 Web Service. 
  2. 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.
  3. A “script” written by the site’s software developers adds the new OSTI ID to the site’s database (records publishing system, review and approval system, etc.).
  4. 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).
  5. Another automated command in the submitting site’s programming then transmits the file named 114073.pdf to the site’s assigned sFTP directory.
  6. 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. 
  7. 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.
  8. When E-Link recognizes that a full-text product has arrived in the site’s 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.
  9. 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), 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 Metadata

3.1  AN 241.1 Required Fields

The following is a list of the required fields for the AN 241.1 Web Service.  These fields are also designated by an asterisk (*).  Records 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 that 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.



Field Name


XML Tag Name


Additional Information




The OSTI ID is required in all requests intended to edit or update existing records.  When POSTing new records to OSTI, no <osti_id> tag is needed in the XML.  E-Link automatically assigns an OSTI ID to each new record successfully submitted.


Record Status*






These tags are required to inform the system of the status of the record being submitted.  For new records, only the <new/> is needed.  For revised metadata <revdata> or revised/replaced full text products (revprod), the OSTI ID must be included as an attribute.  See format below.


Record Status Attributes are needed for revdata tag and revprod tag.

<revdata osti_id=’1053369’/> 
<revprod  osti_id=’1053370’/>
(Note the single quote marks around the attribute value)



Site Code*



The site code value is assigned by OSTI to the submitting site and must be present in each XML record.


Product Type*



Correct alpha code must be used as the value. Note that 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:






Technical Report or Workshop Report


Conference/Event Paper, Proceedings, or





Journal Article


Thesis or Dissertation


Program Document




Accomplishment Report



If product type = CO, the following field is also needed:

Conference Information   <conference_information>   Include name of conference, location, and inclusive dates.

If product type = JA, the following field is also required:

Journal Type  <journal_type> 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 that the requirement to make the Accepted Manuscript available to OSTI and to place AM as the value in <journal_type> applies to journal articles published October 1, 2014 or later.

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

These fields are also needed for JA records:

Journal Name       <journal_name></journal_name>

Journal Volume    <journal_volume></journal_volume>

Journal Issue        <journal_issue></journal_issue>

Journal Serial ID <journal_serial_id></journal_serial_id>

Page Range         <product_size></product_size>   

(Note: Provide the page range as p. xx-xx.  If the journal uses article numbers, that value may also be used in this field)


If you know the DOI that the publisher has assigned to the journal article, please include it also.  The tag for the DOI field is <doi></doi> 

If product type = B, the following field is also needed:

Publisher Information   <publisher_information></publisher_information>   Include name of publisher and city, state, and country if other than U.S.

If product type = P, the following field is also needed:

Patent Assignee   <patent_assignee></patent_assignee>



STI Product Title*



Full title of the STI Product.  Include version number, if applicable.

Please use the 6.1 format below for author information when at all possible!




Preferred format for authors and required in some cases.


Note:  Names of collaborations do not go in the author fields.  See Contributing Orgs



<first_name></first_name>  <middle_name></middle_



 <affiliation></affiliation>    <private_email></private_





Use the <authors> block of tags if you ARE including ORCID number with any of the authors in the submitted record.

When the submitted record has the <authors> 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).


Also note that the email, affiliation, and ORCID parts of the authors “block” format may be left blank if no value is available.




Note:  Names of collaborations do not go in the author fields.  See Contributing Orgs



Format is Last Name, First Name, MI

Separate multiple authors with a semi-colon followed by a space.  Affiliations may be place in square brackets after each author’s name.


<author>DOE, John [National Tech, Inc.]; Smith, Nancy [Brookhaven National Laboratory]</author>


Report/Product Number(s)*




A value in this field is required but may be the word, None, if no valid report number or product number exists. TR and TD product types should always have valid report numbers.


DOE Contract Number(s)*




Use the format of the contract “as is,” but please leave off any preceding “DE”.  If multiple contract numbers apply, separate with a semi-colon followed by a space.


Originating Research







For DOE organizations, use the spelled-out text exactly as shown in the Originating Research Organization Authority at https://www.osti.gov/elink/authorities.jsp 


If work for this product was done at more than one research organization, multiple values may be listed; they should be separated by a semicolon and a space. The primary DOE organization should be listed first, followed by any others. 


If non-DOE orgs are included, input the spelled-out, full name of the organization.



Issue Date* 




Use one of these three Publication Date formats:

  • mm/dd/yyyy
  • yyyy
  • yyyy  Month


If product type = TR, TD, or JA (where journal_type equals AM), the mm/dd/yyyy format must always be used.







Up to75 characters; use format from OSTI’s Language Authority; e.g. English


Authority values are available at https://www.osti.gov/elink/authorities.jsp


Country of Origin/






Use two character code from OSTI’s Country Code  Authority; e.g. US


Authority values are available at https://www.osti.gov/elink/authorities.jsp


Sponsoring Organization(s)*





For DOE organizations, use the spelled-out text as shown in the Sponsoring Organization Authority at https://www.osti.gov/elink/authorities.jsp.  The DOE Order 241.1B requires that three levels of sponsoring information be provided for DOE funding:  Agency, Program Office, and the sub-program within the DOE Program Office.  If funding for this product was provided from more than one organization, multiple values may be listed; they should be separated by a semicolon and a space. The primary DOE sponsor should be listed first, followed by any others.  
Non-DOE sponsoring orgs may also be included in this field, following the DOE orgs.  Please include the spelled-out, full name of the non-DOE sponsoring organization and separate multiples with a semi-colon and a space.


Access Limitation*


Note:  There are several attribute tags and values associated with the list of limited access codes.  See 3.2 Access Limitations – Attributes and Values for additional information needed when submitting access limitation values.





The value in the Access Limitation field should be one of the following.  These values are required to have the formatting shown below, even though they will be enclosed within the <access_limitation> tag.  See more information in Section 3.2.
Use this code
Which means this:
Unlimited Announcement
Copyright Material with Restrictions
Official Use Only
Export Controlled Information
Security Sensitive Information
Protected Data – CRADA or Other
Patent Pending
Limited Rights Data (Proprietary/Trade Secret)
Program-Determined Official Use Only
Naval Nuclear Propulsion Info


Medium Code*



Allowed values are
·         ED (if the full text document is being uploaded or FTP’d to OSTI or if a site ULR is being provided for a full text document posted at the submitting site)
·         X (if the full text document cannot be posted at the site or uploaded to OSTI.)  If X , no URL is provided in the metadata; the submission is considered “Announcement Notice Only”. 
·         AV (if the product is audiovisual material)  Any product type may exist in an audiovisual format. The most common product type that gets an AV medium code is CO for conference/event presentations. .


 Note that the alpha codes should be upper case.  Also note that, depending on the value put in this field, additional information will be needed (see below).
If medium code = ED and the full-text product is posted at the site, the Site URL is required:   Site URL*   <site_url></site_url>    The site url should link directly to the first page of the PDF document.
File Format is also requested:  <file_format></file_format>  Allowed values are:  PDF/A, PDFN, HTML, PPT
If the full-text product will be transmitted to the sFTP, allowed values for file format are:  PDF/A, PDFN, PDFI, HTML, PPT.   Note that Site URL should not be in the submitted data in this case.  
If medium code = AV and the video is posted at your site or websites such as YouTube or Scivee,  the Site URL is required:    Site URL*   <site_url></site_url>    


File Format is requested:  <file_format></file_format>   Preferred format is MP4.

(See http://www.osti.gov/stip/audiovisualsti for more on formats.)


In Format Other, <format_other></format_other>, please provide the length of the video as run time.

Example:  Run time:  00:50:25


Released by Name*





The name of the designated releasing official responsible for approval of distribution/access limitation and for ensuring no PPI is contained in the metadata or the full text. OSTI admin field; does not display in output databases.


Released Date*





Date that the record was released to OSTI by the releasing official.


Released by Email*


Released by Phone*








Both of these fields must be included in the metadata.  This is contact information only and will not display in the output databases.

3.2 Required Fields (Cont):  Access Limitation(s) Attributes and Values

Unclassified, unlimited information is available to the U.S and non-U.S. public, but certain types of information have restricted access whose publication or distribution is restricted by various laws, federal codes, executive orders, international agreements, etc.  Records describing STI products with access limitations are not released to OSTI’s publicly available databases.  They are available to DOE and DOE contractors in Science Research Connection (SRC) with different levels of access based on the product and the requestor.


Records with access limitation codes other than Unlimited (<unl/> may require additional, different information formatted as “attributes” rather than “elements.”  The following table provides this formatting guidance.  For more guidance on the actual restrictions, markings, and handling of STI with access limitations, see the STIP home page at http://www.osti.gov/stip/ or contact OSTI staff.


Access Limitation Codes

What the Code Means

Tags, examples, other information



Unlimited Announcement.  Select this option if the STI Product should have unlimited and unrestricted distribution to the U.S. and non-U.S. public.







OpenNet.  OpenNet is a website supported by DOE’s Office of Classification to provide access to declassified documents and other related information, in support of the National Openness Initiative.





See OpenNet policy and guidance at https://www.osti.gov/opennet/


STI Products marked as OpenNet will be announced by OSTI on the OpenNet database as well as on the STI announcement systems. To enable OSTI to transfer data to the OpenNet database, the following OpenNet data must be provided.


 Non-STI OpenNet products should be submitted using the DOE F 475.1.

Required/Needed Attributes of <access_limitation></access_limitation> if value is <opn/>

OpenNet Accession Number*



OpenNet Document Location



Applicable field Office Acronym


Use the appropriate acronym provided in OpenNet DeClassified Information Database Data Input

Specifications,' revised April 3, 1998.


OpenNet Declassification Status*



Allowed values:

D (Declassified)

S  (Sanitized)

N (Never Classified)

U (Unknown).

OpenNet Declassification Date*


Required if opn_declass_status = ‘D’ or ‘S’.  Format is mm/dd/yyyy

OpenNet Document Categories*





<opn opennet_accession_no='111' opennet_document_location='doc loc' opennet_fieldoffice_acronym='test OFC' opennet_document_keywords='OPN KEYS' opennet_declass_date='01/01/2001' opennet_declass_status='U'/>





Copyright Material with Restrictions.

Copyrighted material may be subject to restrictions on reproduction, distribution, the preparation of derivative works, including translations; public display of the material; and public performance of the material. 


Enter the nature of the restriction into the <access_limitation_other> field.






<access_limitation_other>Copyright Restrictions; Originating lab handles all distributions<access_limitation_other>


Official Use Only.


(Provide exemption number if OUO and no other OUO category applies.)


Export Controlled Information

Information containing technical data as defined in and controlled by U.S. export control statutes. (e.g., under ITAR/EAR) (FOIA Exemption 3)








Security Sensitive Information.




<access_limitation_other>other access lim<access_limitation_other>



Protected Data – CRADA or Other. 

Information produced in the performance of a CRADA that is marked as being Protected CRADA Information by a party to the agreement and that would have been proprietary information had it been obtained from a non-Federal entity. It may be protected for a period up to 5 years from the date it was produced, except as expressly provided for in the CRADA.




<ouoprot protected_data_crada=’Y’ access_limitation_rel_date=”01/21/2011”/>


Required Attributes of <access_limitation></access limitation> if Access Limitation is <ouoprot/>

Protected Data CRADA


Allowed values: "Y" or "N"


Protected Data Other


Required if Access Limitation equals

<ouoprot/>  and

protected_data_crada = ‘N’

Access Limitation Release Date (mm/dd/yyy)











Patent Pending.

Federal agencies are authorized to withhold from public disclosure any invention in which the Government owns or may own a right, title, or interest, for a reasonable length of time so that a patent application can be filed.







Limited Rights Data (Proprietary/Trade Secret)

Information that embodies trade secrets or is commercial or financial and confidential or privileged, to the extent that such data pertain to items, components, or processes developed at private (not government) expense, including minor modifications.






Program-Determined Official Use Only

This type of OUO is based on approved guidance as reflected in DOE Order 471.3, Identifying and Protecting Official Use Only Information. 



<access_limitation><ouopdouo exemption_number=’2’/>



<ouopdouo exemption_number=’7’/>


<access_limitation_other>other access lim</access_limitation_other>


Required/Needed Attributes of <access_limitation></access_limitation> if Access Limitation is <ouopdouo/>

Access Limitation Release Date (mm/dd/yyy) --  access_limitation_rel_date

PDOUO Exemption Number


Exemption_number --  ouopdouo exemption_number



Naval Nuclear Propulsion Information.

Unclassified information related to any aspect of propulsion plants of naval nuclear-powered ships and prototypes, including the associated shipboard and shore-based nuclear support facilities.  See Chief of Naval Operations Instruction N9210.3, Safeguarding of Naval Nuclear Propulsion Information.






3.3 AN 241.1 Optional Fields

The following is a list of optional fields for the AN 241.1 STI Announcement Web Service.  Inclusion of some of these fields, such as the Abstract/Description, is highly encouraged, however.








Author(s) Email




Admin info only; it will not be displayed in public databases.  Note: Use this field only when NOT using the <authors> block of fields.


Related Document Information



Provide additional useful information related to the STI Product that should be included in the published announcement notice, but does not fit elsewhere.  This is a good place to note supplementary material, a DOI for a dataset, etc. if the STI product is a journal article.


Related Identifier(s)



<related_identifier> </related_identifier>








(Note that the top level tags have been shortened by leaving off part of the word “related.”  Be sure to correctly spell those tags and the interior tags where the words are completely spelled out)


Identifiers of related resources.  These identifiers must be DOIs.  Each DOI included as a related identifier must be part of the overall <relatedidentifiersblock> in the XML record. Multiple related identifiers may be provided and each one appears in a nested <relatedidentifers_detail> set of tags.


The DOI itself is then placed in the <related_identifier> tag, and the value for the required <related_identifier_type> is simply the word DOI. 


If a related_identifier is used, the <relation_type> tag is also placed in the overall block.  The <relation_type> tag indicates, with controlled vocabulary, the relationship of the resource being registered (A) and the related resource (B).  The related resource may be another dataset, a journal article or other publication, an image or video file, etc.


The controlled vocabulary terms are listed below.  See Appendix A.1 for definitions and usage notes.


IsCitedBy             Cites

IsSupplementTo   IsSupplementedBy

IsContinuedBy     Continues

HasMetadata         IsMetadataFor

IsNewVersionOf   IsPreviousVersionOf

IsPartOf                 HasPart

IsReferencedBy     References

IsDocumentedBy   Documents

IsCompiledBy        Compiles

IsVariantFormOf    IsOriginalFormOf

IsIdenticalTo          IsReviewedBy

Reviews                 IsDerivedFrom






Normally used to provide the name of an organization, a division within a lab, a specific employee’s title, etc. to which a request for further information may be made. 


R&D Project ID(s)




Enter the unique and permanent Project ID assigned to the project itself by the DOE Field Office, Program Office, lab, or other installation to identify a particular research project. Separate multiples with a semicolon and a space.  Sample formats: P/ORNL--2533; TTP/RL439005


Work Proposal Number



Enter the unique seven-character identifier specific to the document that was used for proposing work to the program office. Multiple numbers are separated with a

semicolon and a space.


Work Proposal Revision Number



If the initial proposal is changed, enter the assigned sequential number of the work

proposal revision.


Work Authorization Number



Enter the unique, standardized seven-character identifier assigned by the issuing organization, specific to the work authorization. The standard format is two characters identifying the issuing DOE organization code, a four-digit sequential number assigned by the issuing organization, and one digit signifying the last digit of fiscal year. Multiple numbers are separated with a semicolon and a space.


Work Authorization Revision Number




If the initial authorization is changed, enter the assigned sequential number of the work authorization revision.


Other Identifying Numbers(s)





Any other numbers that users might wish to retrieve on or need to recognize.  If there are multiple values in this field, separate them with a semicolon followed by a space.


Subject Categories



Use the complete value (numerical code and spelled-out category title) as shown in the Subject Category Authority at https://www.osti.gov/elink/authorities.jsp. As many multiples as needed are allowed in this tag set; separate them with a semicolon and a space. List the primary subject category first.













5000 character limit

Though not required, this field is highly encouraged.  Including it will greatly enhance the retrieval of the STI Product.


Product Size


For a technical report, provide the number of pages.  For a journal article, provide the page range where the article is found in the print version (p. 33 – 37). 


Publisher Name and Location



Provide the publisher name and location when the originating research organization is not the organization that issued the document for dissemination.


Contributor Collaborations/Organizations



Provide the official name of a collaboration in this field rather than in the regular Author field.

Names for similar organizations, such as a consortium, should also go here.





(Can be either people or organizations.  Note that collaboration names, should be put in the field described in item 16 above)


contributorType=”controlled vocabulary value”>



<affiliation_name></affiliation_name>    <private_email></private_email>






People or institutions contributing in some way to the existence and accessibility of the data. Because a contributor usually plays a specific, limited role, the contributors field requires you to select the type of contributor this person/institution made.  Use the controlled vocabulary for contributor type as shown in Appendix xxxxx.



Site Accession Number



Most sites have databases from which they transmit STI to OSTI.  These databases often generate automatic sequence numbers for each record.  The numbers are commonly referred to as “site accession numbers”.  If you wish to submit those numbers with your 241.6 metadata, put them in this tag and they will be reflected in the notification email that comes back to you after each submission.  The site accession number can help you identify records that failed to load and can help identify duplication of records.


4.0 Appendices

A.1 Related Identifiers (definitions and usage notes)

Note:  Much of this table is copied directly from the DataCite 4.0 schema, Appendix, Table 9:  Description of relationType.  Some of the example values in the XML were then created from fictitious sources by OSTI staff.  Do not expect those particular URLs or DOIs to work as active links.






Indicates that B includes A in a citation




Indicates that A includes B in a citation

<relatedIdentifier relatedIdentifierType="DOI”



Indicates that A is a supplement to B

<relatedIdentifier relatedIdentifierType="DOI"




Indicates that B is a supplement to A

<relatedIdentifier relatedIdentifierType="URL"



indicates  A is  continued by the work B

<relatedIdentifier relatedIdentifierType="URL"



Indicates A is a continuation of work B

<relatedIdentifier relatedIdentifierType="URL"



Indicates resource A has

additional metadata B

<relatedIdentifier relatedIdentifierType="URL"





Indicates additional

metadata A for a resource B

<relatedIdentifier relatedIdentifierType="URL"




indicates A is a new edition

of B, where the new edition has been modified or updated

<relatedIdentifier relatedIdentifierType="DOI"




Indicates A is a previous edition of B

<relatedIdentifier relatedIdentifierType="DOI"




indicates A is a portion of

B; may be used for elements of a series

<relatedIdentifier relatedIdentifierType="DOI"




Indicates A includes the part B

<relatedIdentifier relatedIdentifierType="DOI"




Indicates A is used as a

source of information

by B

<relatedIdentifier relatedIdentifierType="URL"





Indicates B is used as a

source of information

for A

<relatedIdentifier relatedIdentifierType="DOI"




Indicates B is documentation

about/explaining A

<relatedIdentifier relatedIdentifierType="URL"



Indicates A is documentation about B

<relatedIdentifier relatedIdentifierType="DOI"



Indicates B is used to compile or create A

<relatedIdentifier relatedIdentifierType="URL"





Indicates B is the result of a compile or creation event using A

<relatedIdentifier relatedIdentifierType="DOI"




Indicates A is a variant or

different form of B, e.g.

calculated or calibrated

form or different packaging

<relatedIdentifier relatedIdentifierType="DOI"




Use for a different form of one thing.


Indicates A is the original form of B

<relatedIdentifier relatedIdentifierType="DOI"




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

<relatedIdentifier relatedIdentifierType="URL"




IsIdenticalTo should be used for a resource that is the same as the registered resource but is saved on another location, maybe another institution.


Indicates that A is reviewed by B

<relatedIdentifier relatedIdentifierType="DOI"



Indicates that A is a review of B

<relatedIdentifier relatedIdentifierType="DOI"



Indicates B is a source upon which A is based




IsDerivedFrom should be used for a resource that is a derivative of an original resource.


Indicates A is a source upon which B is based

<relatedIdentifier relatedIdentifierType="URL"





IsSourceOf is the original resource from which a derivative resource was created.


A.2 Examples of XML 241.1 Metadata Records

Here is an example of an XML file with two AN 241.1 records in it.  The first is an announcement of a technical report as it would come to OSTI’s 241.1 web service.  Following it is an example of a 241.1 announcement of a journal article with full text noted as an accepted manuscript (AM) as required by the DOE Public Access Plan.  Both records use the preferred “block” format for author names and related information.


241.1 announcement of a technical report as it would come to OSTI’s AN 241.1 web service


<?xml version="1.0" encoding="UTF-8"?>






<title>This is a test record</title>






 <affiliation>PNNL EMSL</affiliation>








<originating_research_org>Pacific Northwest National Laboratory (PNNL), Richland, WA (United States)</originating_research_org>




<sponsor_org>USDOE Office of Environmental Management (EM), Office of Soil/Ground Water Remediation (EM-12)</sponsor_org>

<keywords>Emergent Sandbar Habitat; Missouri River; Least Tern; Piping Plover; adaptive management; EIS</keywords>

<description>The goal of the Emergent Sandbar Habitat (ESH) program is to provide sufficient habitat throughout the Missouri River system to allow self-sustaining populations of Interior Least Tern (Sternula antillarum) and Piping Plover (Charadrius melodus). The adaptive management (AM) strategy described herein establishes the process, understanding and tools necessary to adaptively manage the ESH element of the response to the 2003 Biological Opinion for the next 10-15 years. The AM strategy is intended to assist the Corps of Engineers, U.S. Fish and Wildlife Service and their stakeholders in making decisions regarding how to best improve populations of tern and plover through habitat creation.  This AM strategy is guided by the framework and principles described in Adaptive Management, the U.S. Department of the Interior Technical Guide.</description>






<released_by>Test Official</released_by>






241.1 announcement of a journal article with full text noted as an accepted manuscript (AM) as required by the DOE Public Access Plan)


<new /> 
<title>Finding the Higgs Boson</title> 





 <affiliation>MajorLab National Laboratory</affiliation>








 <affiliation>MajorLab National Laboratory</affiliation>




<journal_name>Physics Review</journal_name> 
MajorLab National Laboratory, Test Town, CA (US) 
<sponsor_org>USDOE Office of Science (SC), Office of Nuclear Physics (NP) (SC-26)</sponsor_org> 
<subject_category_code>72 Physics of Elementary Particles and Fields 
<unl /> 
<released_by>A. C. Tester</released_by> 



Evelyn Gibson's picture

Last updated on Monday 12 February 2018