Crossref XML plugin for OJS

Registering your DOI records using the OJS platform (OJS 3.3)

You can register your DOI records with us using the OJS platform with two extra plugins - the DOI plugin, and the Crossref XML plugin for OJS. We highly recommend including your references in the metadata you send to us, too - you can do this by adding the OJS references plugin. The instructions below are for configuring OJS version 3.3. We also have step-by-step instructions for configuring OJS version 3.4 at the bottom of this page.

Step 1: Set up the DOI plugin

Ask your OJS administrator to install the DOI plugin, and add the DOI prefix that we gave to you. Your prefix will start with 10. and will be followed by other numbers.

You can check whether the DOI Plugin is already set up by following these steps:

1. Go to ‘Settings’ on your dashboard and click ‘Website’
2. Switch to the ‘Plugins’ tab

×

3. Search ‘Public Identifier Plugins’ and find ‘DOI’
4. Click the checkbox on the right side of the DOI plugin description to enable it

×

Step 2: Set up the Crossef XML plugin for OJS

To make best use of the plugin, make sure you’re using OJS version 3 or higher.

You can start by finding the Crossref plugin from your dashboard:

1. Click ‘Tools’
2. Choose the ‘Import/Export’ tab
3. Click ‘Crossref XML Export Plugin’

×

You can deposit content with us in one of three ways:

1. Register your content with us automatically using the OJS plugin
2. Register the content with us manually, from the plugin interface
3. Have the plugin create an XML file that you can then upload to our admin tool

We recommend automatic deposits.

Step 3: Enable automatic deposits

Simply click the checkbox at the bottom of the DOI plugin settings to enable automatic deposits.

×

You’ll then need to add information into the plugin:

×

Here’s what to enter into each of the fields shown in the screenshot above:

1. Depositor name - the name of the organisation registering the DOIs (note: this field is not authenticated with Crossref)
2. Depositor email - the email address of the individual responsible for registering content with Crossref (note: this field is not authenticated with Crossref)
3. Username - this is the username element of your Crossref depositor credentials. It will be passed to us to authenticate your submission(s). Your username might be just a collection of letters (role credentials), or it might be an email address (user credentials) - there is more information on role versus user credentials below.
4. Password - this is the password associated with your Crossref depositor credentials

Note: if the combination of username and password is incorrect, OJS will return a ‘401 unauthorized status code’ error at the time of registration. This error indicates that the username and password are incorrectly entered. That is, they do not match the username and/or password set with Crossref.

• If you are using organisation-wide, shared role credentials (i.e. your username is a collection of letters), you can simply add in your shared username and password.
• If you are using personal user credentials that are unique to you (i.e. your username is your email address), you’ll need to add your email address and your role into the username field, and your personal password into the password field. Here’s an example of what this will look like:

Username: email@address.com/role
Password: your password

Step 4: Activate the OJS references plugin

The OJS references plugin is available from OJS 3.1.2 onwards. The plugin will use the Crossref API to check against plain text references and locate possible DOIs for articles. The plugin will also allow the display of reference lists on the article landing page in OJS and deposit them as part of your metadata deposit. Linking references is a requirement of Crossref membership.

Two things need to be set up to activate the references plugin:

a) Workflow Settings

1. Click ‘Settings’ and then ‘Workflow’ from your dashboard
2. Under the ‘Submission’ tab, choose ‘Metadata’!

×

3. Scroll down to the bottom and to find the ‘References’ section
   Make sure you enable references metadata by clicking the checkbox ‘Enable references metadata’. You also need to select the option ‘Ask the author to provide references during submission’.
4. Click save!

×

b) Website Settings

Then you need to activate the references plugin on the website, too, by following the instructions here:

1. Click ‘Settings’ and then ‘Website’ from your dashboard
2. Choose the ‘Plugins’ tab.

×

3. Search ‘Crossref reference linking’
4. Click the ‘Crossref reference linking checkbox

This plugin will deposit the references that you enter into the XML deposit.

Additional OJS plugins for Crossref

In addition to the Crossref XML plugin for OJS, there are also other important plugins that can be enabled in OJS to enrich your metadata records:

1. Cited-by (OJS Scopus/Crossref plugin) - as of OJS 3.2, this third-party plugin allows journals to display citations and citation counts (using article DOIs) from Scopus and/or Crossref.
2. Funding Metadata plugin - as of OJS 3.1.2, it is possible to enable a funder registry plugin for submitting funding information to Crossref. The plugin will use the Open Funder Registry to check against existing funding agencies. The plugin will include funding information in your Crossref DOI deposits.
3. Similarity Check plugin - if you are using OJS 3.1.2 or above, you are able to use the Similarity Check plugin. This will enable you to automatically send manuscripts to your iThenticate account to check their similarity to already published content. You will need to be subscribed to Crossref’s Similarity Check service for this to work.

Getting help with OJS plugins

The team at Crossref didn’t create these plugins - they were either created by the team at PKP, or by third-party developers. Because of this, we aren’t able to give in-depth help or troubleshooting on problems with these plugins.

If you need more help, you can learn more from PKP’s Crossref OJS Manual and PKP’s Open Journals System 3.3 How to guides on DOI & Crossref Plugins plus there’s a very active PKP Community Forum that has more information on how to modify your OJS instance to submit metadata and register DOIs with Crossref.

Alternatively, you can contact the support team at PKP.

Setting up automatic DOI registrations in OJS 3.4

1. Go to the Distribution menu
2. Select the DOI tab
3. Click on the Setup option

×

4. Check the box to allow DOIs to be assigned to your published works
5. Check the box to determine which items DOI will be assigned
6. Enter your Crossref assigned prefix

×

7. Select your preferred stage for automatic DOI assignment to your articles (can be upon the article reaching copyediting stage or upon article publication).
8. Select your preferred method of DOI suffix generation (can be Default, None for manual entry of suffixes, or Custom pattern)

×

9. Next, switch to the ‘Registration’ tab menu

×

10. Select Crossref your ‘Registration Agency’ from the drop down options. If you don’t see “Crossref” in the list, navigate to Website > Plugins > Plugin Gallery to enable the ‘Crossref Manager Plugin’.
11. Check the box under ‘Automatic Deposit’ to enable automatic DOI deposits from your OJS instance.
12. Enter your name here as the depositor.
13. Enter your email here as the depositor (all deposit emails will be sent to this email).

×

14. Enter your assigned Crossref username. The username must be entered as {email-address}/{role} . For example support@crossref.org/abcd
15. Enter your set personal password into the password field.
16. IMPORTANT: Leave the test checkbox unchecked.

×