Difference between revisions of "Submission Integration: Implementation"

From Dryad wiki
Jump to: navigation, search
m (Rollout to authors & ongoing integration)
Line 5: Line 5:
 
Journals initiating submission integration are welcome to [mailto:help@datadryad.org contact Dryad staff] at any time to discuss the details of the process, and to fill out the [http://spreadsheets.google.com/viewform?hl=en&authkey=CKGswo8M&formkey=dC0yNlE4TDNPZU01R1FQM0FrS1BoM1E6MQ#gid=0 Pre-Integration Questionnaire]. Some of the issues to discuss include:
 
Journals initiating submission integration are welcome to [mailto:help@datadryad.org contact Dryad staff] at any time to discuss the details of the process, and to fill out the [http://spreadsheets.google.com/viewform?hl=en&authkey=CKGswo8M&formkey=dC0yNlE4TDNPZU01R1FQM0FrS1BoM1E6MQ#gid=0 Pre-Integration Questionnaire]. Some of the issues to discuss include:
  
*Review workflow, confirm journal parameters and choices about options (embargoes, data available during the review process, etc.)
+
*Review workflow, confirm journal parameters and options (embargoes, data available during the review process, etc.)
*How the journal provides automated email notification to Dryad of new articles. Most journals opt to do this at the time of article acceptance.
+
*How and when the journal will provide automated email notifications to Dryad of new manuscripts. Most journals opt to do this at the time of acceptance.
*How the journal informs authors of the Dryad submission system URL so they can deposit their data efficiently.
+
*How the journal will invite authors to deposit data, and provide the Dryad submission system URL.
*Where the journal will include the Dryad DOIs in the published articles.
+
*Where the journal will include the Dryad DOI in the published articles.
 
*Whether/how the journal will monitor or enforce timeliness of deposition.
 
*Whether/how the journal will monitor or enforce timeliness of deposition.
 
*List of journal representatives that will receive reports from Dryad, including immediate notifications of Dryad submissions and weekly summary reports.<br>
 
*List of journal representatives that will receive reports from Dryad, including immediate notifications of Dryad submissions and weekly summary reports.<br>
 
*How Dryad will monitor the final publication of articles (so Dryad curators can complete the bibliographic details in the Dryad record).
 
*How Dryad will monitor the final publication of articles (so Dryad curators can complete the bibliographic details in the Dryad record).
*The timeline for the steps described below.
+
*The timeline for testing the process and for rollout to authors.
  
=== Journal sends article notices to Dryad ===
+
===Testing format of journal notices ===
  
* The journal's manuscript processing system sends notification emails to Dryad containing the basic information about each article, generally at the time of article acceptance
+
The journal sends one or more test notices to Dryad, to ensure that both systems are communicating without problems.
**These notices create a provisional entry in Dryad for the article's data, ready for the author to upload the relevant data files
 
** These notices are received by a machine, not read by a human, and must follow a specific format
 
** '''The formatting specifications of these email notices are given here: [[Journal Metadata| detailed email format]]'''.
 
** Journals usually automate this step, sending notification to Dryad of all accepted manuscripts, even those that do not have associated data.  Notifications for articles with no associated data will not "clog the system" or cause problems for Dryad.
 
* If journals use ScholarOne Manuscripts (Manuscript Central) for processing manuscripts, they can implement the [[Media:DryadSetupForMC-TimVines.pdf|Manuscript Central template for Dryad]] created by Tim Vines.
 
* If journals have another manuscript tracking system, an equivalent email template will need to be created. Dryad staff can assist with this.
 
 
 
'''Key resource: [[Journal Metadata|Detailed email format]]'''
 
 
 
===Testing format of journal notices for new articles===
 
 
 
Before releasing the system to users, the journal sends one or more test notices to Dryad, to ensure that both systems are communicating without problems.  
 
  
 
# The journal sends several test article notifications, and Dryad creates new records in a testing environment. NOTE: Depending on the journal's intended workflow, notices may be sent only at the time of article acceptance, or at multiple points in the article submission process.
 
# The journal sends several test article notifications, and Dryad creates new records in a testing environment. NOTE: Depending on the journal's intended workflow, notices may be sent only at the time of article acceptance, or at multiple points in the article submission process.
Line 38: Line 26:
 
===Rollout to authors & ongoing integration===
 
===Rollout to authors & ongoing integration===
  
When the testing phase is complete the journal may begin inviting authors to deposit data in Dryad.
+
When the testing phase is complete and all the desired customizations have been implemented, the journal may announce the completed integration and begin inviting authors to deposit data in Dryad.
  
 
# Journal provides Dryad submission system link in manuscript acceptance letters, inviting authors to submit data. This link takes the author to their provisional entry in Dryad, which incorporates the information supplied by the journal notice, and expedites the author's data deposit process.
 
# Journal provides Dryad submission system link in manuscript acceptance letters, inviting authors to submit data. This link takes the author to their provisional entry in Dryad, which incorporates the information supplied by the journal notice, and expedites the author's data deposit process.

Revision as of 09:13, 15 November 2011

The steps required to set up, test and roll out submission integration for a new journal are as follows:

Initial planning

Journals initiating submission integration are welcome to contact Dryad staff at any time to discuss the details of the process, and to fill out the Pre-Integration Questionnaire. Some of the issues to discuss include:

  • Review workflow, confirm journal parameters and options (embargoes, data available during the review process, etc.)
  • How and when the journal will provide automated email notifications to Dryad of new manuscripts. Most journals opt to do this at the time of acceptance.
  • How the journal will invite authors to deposit data, and provide the Dryad submission system URL.
  • Where the journal will include the Dryad DOI in the published articles.
  • Whether/how the journal will monitor or enforce timeliness of deposition.
  • List of journal representatives that will receive reports from Dryad, including immediate notifications of Dryad submissions and weekly summary reports.
  • How Dryad will monitor the final publication of articles (so Dryad curators can complete the bibliographic details in the Dryad record).
  • The timeline for testing the process and for rollout to authors.

Testing format of journal notices

The journal sends one or more test notices to Dryad, to ensure that both systems are communicating without problems.

  1. The journal sends several test article notifications, and Dryad creates new records in a testing environment. NOTE: Depending on the journal's intended workflow, notices may be sent only at the time of article acceptance, or at multiple points in the article submission process.
  2. Dryad staff and journal representatives test the submission system, specifically the integrity of the information transfer.
  3. Any problems that are discovered are resolved, and testing is repeated until no more issues are found.
  4. Dryad and/or journal representatives ask a few authors to test the system in the production environment.
  5. Any problems that are discovered are resolved, and testing is repeated until no more issues are found.

Rollout to authors & ongoing integration

When the testing phase is complete and all the desired customizations have been implemented, the journal may announce the completed integration and begin inviting authors to deposit data in Dryad.

  1. Journal provides Dryad submission system link in manuscript acceptance letters, inviting authors to submit data. This link takes the author to their provisional entry in Dryad, which incorporates the information supplied by the journal notice, and expedites the author's data deposit process.
  2. Sample text for use with authors is available, describing the benefits of data deposit in Dryad, here.
  3. Dryad provides journal with list of all pre-existing identifiers for the journal's articles in Dryad.
  4. Dryad informs journal weekly of all new data deposits associated with articles in the journal.
  5. Journal includes identifiers within print and online versions of published articles. Example placements of Dryad DOIs can be seen:
    • in The American Naturalist online, the Dryad DOI is presented under the Supplements tab, example and in the header information of the PDF of this article
    • in Molecular Ecology the Dryad DOI appears in a Data Accessiblity section, online example and PDF
    • in PLoS ONE, within the Data and Protocol Availability section of this article
    • in the references of this article in Science
  6. Dryad will provide any information the journal may need to verify deposits, but enforcement of deposition policy is the responsibility of the journal.
  7. The journal may wish to update their Instructions to Authors and announce the new data archiving process to its authors. Several journals' instructions to authors about data archiving are collected here.

Key resource: Sample email to authors

See also