Difference between revisions of "Submission System"

From Dryad wiki
Jump to: navigation, search
 
(28 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''Status: initial work completed by Nescent. Enhancements are being evaluated by @mire.'''
 
  
See also the list of [[Use Cases]] and the [[Partner Submission Integration]].
+
== Overview ==
  
 +
Dryad's submission system allows users to quickly and easily submit data packages. Key features include:
  
== Workflow for a New Article ==
+
#[[Submission_Integration:_Overview|Integration with journals]] -- allowing authors to automatically fill the Dryad forms with information from the journal's description of an article, and automatically notifying journal editors when a Dryad submission is completed.
 +
#Minimal description requirements -- Dryad minimizes the amount of typing/clicking required by submitters. Descriptions are automatically propagated from the article description to descriptions for individual data files. Reasonable defaults are set for the various choices available.
 +
#Integration with partner repositories -- allowing submitters to use Dryad information as a starting point for submitting content to another repository.
  
# Journal accepts the author's publication.
+
See also the journal-oriented [[Submission Integration]] page.
# Journal mails Dryad with metadata.
 
# Journal mails author acceptance letter, which contains a link to the Dryad submission for that publication. If the primary corresponding author of the article is not the primary manager of the data set, the article author may forward the email to the data set author.
 
## Author follows the link, which has the form: http://datadryad.org/submit?journalID=zzzz&manu=xxxx
 
## The link redirects to the DSpace aspect that handles submission: http://datadryad.org/repo/dryadsubmit/jsubmit?journalID=zzzz&manu=xxxx
 
## Author logs in to Dryad (or creates an account). ([[Media:SubmissionMockupLogin.png]])
 
## Author is presented with a publication page that allows "Edit Publication Details" and "Add Dataset". ([[Media:SubmissionMockupPubSummary.png]])
 
## Author may expand metadata for the publication. ([[Media:SubmissionMockupJournalPub.png]])
 
## Author uploads data, providing additional metadata for each data set. ([[Media:SubmissionMockupDataset.png]])
 
## Author may provide IDs of data sets in other repositories.
 
## Author may provide IDs of pre-existing data sets in Dryad.
 
## Author may choose to place data sets under embargo. (Default embargo period lasts until 1 year from the '''publication''' date.
 
## Author chooses to "Publish Datasets". ([[Media:SubmissionMockupPubSummary.png]])
 
# Dryad mails handle of '''publication''' record to journal editor. (At least one dataset must be present.)
 
# Journal editors may include the Dryad handle in the article.
 
# Journal sends the table of contents (including DOI list) for each issue to Dryad, so complete metadata can be extracted and the embargo period can officially start.
 
#* This may be the same information that is sent to Crossref and/or PubMedCentral.
 
  
== Workflow for an Article in a non-partner Journal ==
+
== Instructions ==
  
# Author logs in to Dryad (or creates an account).
+
An overview of the Dryad submission process can be seen in the [http://www.youtube.com/watch?v=RP33cl8tL28 Dryad submission video].
# Author chooses "Deposit Data for a New Publication".
 
# Author is presented with an "Add Publication" page. This page looks similar to the "Edit Publication Details" page from the partner journal process, but all fields may be edited (and are initially blank). ([[Media:SubmissionMockupCreateNewPublication.png]])
 
# Author is presented with a publication page that allows "Edit Publication Details" and "Add Dataset".
 
# Author may edit/expand metadata for the publication.
 
# Author uploads data, providing additional metadata for each data set.
 
# Author may provide IDs of data sets in other repositories.
 
# Author may provide IDs of pre-existing data sets in Dryad.
 
# Author may choose to place data sets under embargo. (Default embargo period lasts until 1 year from the '''publication''' date.
 
# Author chooses to "Publish Datasets".
 
  
== Points to remember ==
+
For a journal-oriented view of the process, see [[Submission Integration]].
  
* Dorothea has a great post about [http://cavlec.yarinareth.net/archives/2007/11/02/less-cognitive-load-faster-deposit/ making the repository submission process easier].
+
== Technical Documentation ==
* Note the comments from [[WG:Team_Meetings#Nov._17|Jane's metadata class]]
 
  
== Email Parsing System ==
+
Technical documents are available on several topics:
 +
* [[Submission System Technology]]
 +
* [[Submission System Workflow]]
 +
* [[Journal Metadata Processing]]
 +
* [[BagIt_Handshaking|Integration with TreeBASE]]
  
# Email sent to a short perl script (journalEmailGateway.pl), which forwards the contents of the message to a web service.
+
== Design history ==
# The web service (journal-submit) parses the contents of the email.
 
#* Parsing can be different for each journal, though most journals use the Manuscript Central template created by Tim Vines.
 
#* The parsed content is stored as an XML file in submission/journalMetadata.
 
# When an author follows a link (or enters an equivalent journalID and manuscript number into the submission web form), the submission system will import the relevant XML file to pre-populate metadata for the new submission.
 
  
== Notes for The American Naturalist ==
+
Mockups of submission features:
 +
* [[Submission System Mockups]]
 +
* [[Login-Register Mockup]]
 +
* [[TreeBASE Submission Mockups]]
 +
* [[Repository Handshaking Mockup]]
  
* Contacts: Michael Whitlock (Dryad Representative), Mark McPeek (editor-in-chief), Trish Morse (managing editor)
+
Back-end submission features:
* They use Editorial Manager, which can send automated email messages with particular merge fields embedded.
+
* [[Submission System Updates Phase 3]]
* They do not track keywords in Editorial Manager. They are retrievable from the meta kewords tag on the web pages, though.
 
* Once the main submission system is set up, they would like to email all authors for articles from the past 5 years, and encourage them to submit data as well.
 
  
=== Testing timeline ===
 
 
* Dryad first received metadata records on 2009-9-24.
 
* URL processing went live on 2009-5-16.
 
* Authors received Dryad links in acceptance letters starting ??.
 
 
See [[American Naturalist Integration Issues]].
 
 
=== Email procecssing ===
 
 
Email processing is currently a somewhat manual process. It will become more automatic as the steps are refined.
 
 
Email processing steps:
 
# Select all messages in Mac Mail
 
# File/Save As...
 
# Move saved file to the development server, into /Users/dryad/submission/journalEmail/temp
 
# On the development server, run /Users/dryad/bin/process-amnat.sh
 
 
A cron job copies the final files to the production server, with logs in /var/log/dryad-submission.log.
 
 
 
 
== Notes for Evolution ==
 
 
* Contacts: Mark Rausher (editor-in-chief), Jennifer Mahar (managing editor)
 
* They use ScholarOne's Manuscript Central.
 
* The publication process has several stages. We would most likely want to hook into the "online accept" stage, where the publication has been accepted, but is not yet in final form.
 
** Jennifer will see what she can send us, possibly a version of the email that goes to the publishing group, but hopefully with abstract and keywords added
 
* A DOI is available for the "online early" stage, but it is not clear whether this is the final DOI, or whether it is shared with the print version of the article.
 
* The term they use for bibliographic metadata is "core data".
 
* Links from the journal's site to Dryad: these cannot be implemented until high-level approval is given.
 
* Evolution publishes several types of papers -- which of these types should go to Dryad?
 
 
== Notes for Molecular Ecology ==
 
 
* Contacts: Tim Vines (managing editor and Dryad Representative)
 
* Tim has written a document on the [[Media:VinesManuscriptCentralSetup.pdf‎|Manuscript Central template for Dryad metadata]].
 
* Status: metadata transfer is working.
 
* Their abbreviation will be "MolEcol".
 
* Molecular Ecology Resources will use the abbreviation "MolEcolRes".
 
* They will add some random digits to the normal manuscript number for security purposes.
 
 
Timeline:
 
* URL processing went live on 2009-10-26.
 
 
== Notes for Systematic Biology ==
 
 
* Contacts: Rod Page (Dryad representative, past EIC), Debbie Ciszek (Managing Editor)
 
* They already collect some types of data in Manuscript Central. The current plan is to expand this, so that all data is collected in Manuscript Central, and submitted directly to Dryad with little author involvement.
 
 
== Notes for Ecological Society of America ==
 
 
* Contacts: David Baldwin (managing editor), Anne Marie Whelan (Publications Coordinator)
 
* Want to start working on submission system ASAP.
 
* They use a submission system called Ejournal Press, and they contract with Allen Press to run it for them.
 
* We should write to David Baldwin to discuss integration of the submission process and they will convey our questions, etc. to the appropriate people at Allen Press.
 
* They already encourage submission to the ESA archives.
 
* They want to make sure the metadata standards follow what their Publications Committee recommends.
 
 
== Fleshing out metadata with publication information ==
 
 
CrossRef has published a [http://oxford.crossref.org/labs/best_practice/rss/rss_best_practice_recommendations.html draft recommendation] for journals to make their tables of contents machine-readable using RSS. If this is accepted by the community, it will greatly ease the process of obtaining complete metadata about articles that have been published.
 
 
== For Future Development ==
 
 
* We want the submission system to be implemented as a DSpace module, but not necessarily tied in to the existing submission system (because of its complexity). Should this be an entirely new module (e.g., following the model of the sword module), or just a new aspect?
 
* It is ok for end-users to use one system, and when they are done the item is kicked over to the existing workflow system for evaluation by curators.
 
 
* We seem to have some overlap with the Vireo submission system from TDL. Should we build on top of it??
 
 
[[Category:Work Packages]]
 
 
[[Category:Journals]]
 
[[Category:Journals]]
 +
[[Category:Help]]
 +
[[Category:Features]]

Latest revision as of 11:21, 22 June 2015

Overview

Dryad's submission system allows users to quickly and easily submit data packages. Key features include:

  1. Integration with journals -- allowing authors to automatically fill the Dryad forms with information from the journal's description of an article, and automatically notifying journal editors when a Dryad submission is completed.
  2. Minimal description requirements -- Dryad minimizes the amount of typing/clicking required by submitters. Descriptions are automatically propagated from the article description to descriptions for individual data files. Reasonable defaults are set for the various choices available.
  3. Integration with partner repositories -- allowing submitters to use Dryad information as a starting point for submitting content to another repository.

See also the journal-oriented Submission Integration page.

Instructions

An overview of the Dryad submission process can be seen in the Dryad submission video.

For a journal-oriented view of the process, see Submission Integration.

Technical Documentation

Technical documents are available on several topics:

Design history

Mockups of submission features:

Back-end submission features: