Documentation

OJS 3.4


Registering your DOI records using OJS version 3.4

You can register your DOI records with us using the OJS (Open Journal Systems) platform by enabling the Crossref Manager plugin. 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.4 (more in Public Knowledge Project’s (PKP) documentation).


Step 1: Enabling the Crossref Manager plugin

  1. As Journal Manager, under Settings, click Website > Plugins.
  2. Under Installed Plugins, scroll down to the section labelled Generic Plugins.
  3. Click the checkbox next to the plugin description to enable the plugin.
screenshot of Crossref Manager Plugin for OJS 3.4

Step 2: 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
Distribution Settings 1
  1. Check the box to allow DOIs to be assigned to your published works
  2. Check the box to determine which items DOI will be assigned
  3. Enter your Crossref assigned DOI prefix. Your prefix will start with 10. and is in the format 10.xxxx (e.g., 10.5555).
Distribution Settings 2
  1. Select your preferred stage for automatic DOI assignment to your articles (can be upon the article reaching copyediting stage or upon article publication).
  2. Select your preferred method of DOI suffix generation (can be Default, None for manual entry of suffixes, or Custom pattern)
Distribution Settings 3
  1. Next, switch to the ‘Registration’ tab menu
Distribution Settings 4
  1. 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’.
  2. Check the box under ‘Automatic Deposit’ to enable automatic DOI deposits from your OJS instance.
  3. Enter your name here as the depositor.
  4. Enter your email here as the depositor (all deposit emails will be sent to this email).
Distribution Settings 5
  1. Enter your assigned Crossref username. For example [email protected]/abcd

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 protected]/role Password: your password

  1. Enter your set personal password into the password field.
  2. IMPORTANT: Leave the test checkbox unchecked.
Distribution Settings 6

Step 3: 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.

Workflow Settings

  1. Click ‘Settings’ and then ‘Workflow’ from your dashboard
  2. Under the ‘Submission’ tab, choose ‘Metadata’!
Workflow Settings for References
  1. Scroll down to the bottom and 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’.
  2. Click save!
Enable References Metadata

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.
Website Plugins Tab
  1. Search ‘Crossref reference linking’
  2. 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.
  4. ROR plugin - the ROR Plugin for OJS enables authors to add the ROR ID for the organization they are affiliated with.

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.

Page maintainer: Isaac Farley
Last updated: 2025-September-17