Integrations for Journals and Manuscript Platforms
We work to really automate peer review dataflow. You can transfer data from your submission and peer review system to our servers through Plugins, APIs and Comma Separated File upload (or FTP transfer).
Please access to our tutorials below or request a demo if you are interested in integrating with ReviewerCredits.
You can upload a CSV file to import peer review data in our database.
Download the form to fill in with the required information relating to the peer review activities completed by the reviewers of your Journal (it is possible to record the reviews that took place in the last 24 months).
Each reviewer will be notified with an e-mail message to confirm that he/she has carried out the activity (will be invited to register – if not already part of the ReviewerCredits network) – to be recognized, certified and repaid his activity thanks to the assignment of
credits to be used in ReviewerCredits online store.
The attestation of an intense and careful peer review activity certainly supports your reliability and consolidate the identity of reviewers as part of your network: offer a real service to your collaborators!
(please select commas as separator)
Once you fill your reviews in the format presented above, you can import them through “Import Claims” button on your Journal Profile.
The process of importing reviews data from Editorial Manager to ReviewerCredits is completely automated, but some setup is needed in order to connect the two platforms.
Here we outline the necessary steps to be followed.
Prerequisites: Enterprise Analytics Reporting must be enabled for your Editorial Manager account.
Ask us the import credentials
In order to start the process, we need to enable the integration on your Journal. Write an e-mail to [email protected] or click this link Journal Editorial Manager Activation to indicate your interest in the integration. We will enable your Journal to import review data and we will send you the information to be inserted in the next steps:
• Import username
• Import password
• SFTP address
Setup a periodical report on Editorial Manager
When you access the Enterprise Analytics Reporting main page, you will find ReviewerCredits report in the “Third Party Exports” section of the list of Standard Reports. You should click on the “SFTP” schedule icon near the report title, the Report Delivery Schedule page will show up to configure the periodical sending.
On the “Report Delivery Schedule” page, select the “SFTP” radio button in the “Delivery Method” section.
You should fill in the following values:
• Delivery Frequency: weekly
• First Delivery Date: the date you want to start the report sending, may be “today”
• Number of Deliveries: insert 500 (or the max number allowed)
• Delivery Method: SFTP
• SFTP Server Address: the “SFTP address” you received in the first step
• Username: the “Import username” you received in the first step
• Password: the “Import password” you received in the first step
• Subdirectory: leave empty
• Email Address: an e-mail address on which you will be notified of the successful send, or the errors that happened
• Include CSV file of report: please, check this box
Setup the review question
Review data will be sent only if the reviewer accept the transfer. Therefore, a question should be configured in the Review Form in order to ask reviewers if they agree to send the review data to ReviewerCredits.
To configure the review question, go to PolicyManager > Create/Edit Custom Review Questions. Click the “Add” button to add a new question.
Enter exactly the following HTML into the “Question” text area:
<b>Register this peer review on <a href=”https://www.reviewercredits.com/”>ReviewerCredits.com</a></b>
<br>I agree to tranfer my peer review data (email, first and last name, ORCID, manuscript ID, date review due, date review completed) to ReviewerCredits. <a href=”https://www.reviewercredits.com/why-join-reviewers/”>Read more</a>.
Select “Yes/No” in the “Response Type” dropdown menu.
Please note: do not insert a personalized question, otherwise reports will extract empty data. Insert exactly the HTML above.
Add the question to Review Forms
You can find the new question you setup in the list of Custom Questions when you are configuring the Review Form in PolicyManager > Create/Edit Review Forms. Add the question to any Review Forms for which you would like to give reviewers the option to deposit to ReviewerCredits. The “Add Custom Review Question” button can be used to add the new question to a form:
The question can then be selected on an overlay that displays after clicking the button:
Open Journal Systems (OJS) 3.x - Plugin
If your Journals use OJS from the Public Knowledge Project to manage manuscript submission download and install our free plugin. This plugin allows automated transfer of peer review data from your Journals to our database enabling a seamless experience to your reviewers. Installing the plugin, Journals will interact automatically with our API. The plugin is released within the OJS plug n gallery, according to the OJS license rules. The plugin is compatible with OJS 3.x versions. We recommend to register your Journal before installing the plugin.
Download the plugin.
Note: If you are using one of the Open Journal System versions listed below, you can install it from the plugin gallery (without needing to download it) and continue to step 3.
You can find it in the OJS Plugin Gallery as shown below.
On the OJS platform go to Settings > Website > Plugins page and click on the “Upload a new plugin”. Upload the plugin file and click save. The plugin will be added to your OJS plugins page.
Proceed to configure it clicking on settings as shown below.
Insert the Journal credentials you use to access ReviewerCredits platform.
The plugin connects your journal to ReviewerCredits database using the reviewer’s ORCID or email address. If a reviewer is not registered on ReviewerCredits it will not be possible to transfer peer review information.
Upon submitting their review (in review step 3), reviewers will find a tick box to agree to the transfer of data to ReviewerCredits.com as shown below.
Which data is transferred?
- Peer reviewer Email address and ORCID (for matching purposes)
- Manuscript ID
- Peer review due date
- Peer review submission date
Upon successful transfer of data, the reviewer will receive a confirmation pop up message from OJS:
If you encounter any problem with installation, you can check our ReviewerCredits OJS Plugin Installation Checklist, and if the problem persists tell us the step you have the problem with on our contact page.
Open Journal Systems (OJS) - CSV Import
CSV Import is available for all OJS versions. But we suggest journals to update their OJS Platform to 3 or higher for free and use our plugin.
2) Manual part:
Fill the first 3 columns with your journal information (Title, P-ISSN, e-ISSN without dashes).
Fill the manuscript ID column for each review.
3) Download the OJS Review Report going into OJS Admin Panel > Tools > Report Generator and then clicking on “Review Report”.
Then take the columns from OJS Review Report put into the ReviewerCredits report following the column map below
OJS Review Report column > ReviewerCredits Import Format Column
- Round > Revision Number
- Given Name > Reviewer First Name
- Family Name > Reviewer Last Name
- Orcid ID > ORCID
- Country > Country
- Email > Email Address
- Review Due Date > Date Review Due (Change date format to YYYY/MM/DD)
- Date Completed > Date Review Complete (Change date format to YYYY/MM/DD)
4) Once the CSV file is completed, go to the Journal profile page, and under “Import Peer Review Data” click “Choose File” to upload your reviews csv. And then click on “Import claims”.
5) This will save your reviews on our platform and let your reviewers know about it.
ARPHA by Pensoft
ARPHA’s API is powered by Pensoft. This API allows the data import directly to ReviewerCredits platform as soon as the Journal editor makes his/her final decision on the acceptance/rejection of a submitted manuscript (accept, reject or reject, but resubmission encouraged) in an ARPHA-hosted participating Journal. With this API, the reviewers who had previously agreed to have their review activity registered on ReviewerCredits, will have their contribution automatically submitted to ReviewerCredits.
To activate this service, reviewers need to:
Log in to the Journal’s website with the account they have used to submit their review. This is also their account on the ARPHA system.
Register in the ReviewerCredits system using the pop-up that will automatically appear once they are logged in.
We developed API (Application Programming Interface) which allows, at first, the automated transferral of peer review data from publishing platforms; specifications can be found here.
Our APIs are developed following the paradigm of simplicity and uniformity of mature RESTful webservice. More specifically the API are designed to target level 3 of the Richardson Maturity Model (read the Martin Fowler article here). Our API specifications are fully documented using Swagger, allowing easy consultation and testing with the ability to self generate clients for the most used programming languages including PHP, Java, Python, R, Ruby, Node.js and many others.