Crossref XML plugin for OJS

If you use the Open Journal Systems (OJS) platform from PKP, you should use PKP’s OJS Crossref XML plugin to register your content with us. To make best use of the plugin, make sure you’re using OJS version 3 or higher.

You can set up the plugin to work in one of two ways:

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

Setting up the plugin and credentials

If you plan to set up the plugin to register content with Crossref automatically, you’ll need to add your Crossref account credentials into the username and password field in the plugin.

OJS Crossref plugin settings
  1. Depositor name - Name of the organization registering the DOIs (note: this field is not authenticated with Crossref)
  2. Depositor email - email address of the individual responsible for registering content with Crossref (note: this field is not authenticated with Crossref)
  3. Username - the Crossref username that will be passed to us to authenticate your submission(s). This might also be an email address - more on role versus user credentials below.
  4. Password - the password associated with your Crossref 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 organization-wide, shared role credentials, you can simply add in your shared username and password.
  • If you are using personal user credentials that are unique to you, 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:

Password: your Password

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. Reference linking and deposit plugin - As of OJS 3.1.2, it is possible to enable a reference linking plugin for Crossref. 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.
  2. 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.
  3. Crossmark plugin - OJS 3.2 includes support for Crossmark, which gives readers quick and easy access to the current status of an item of content, including any corrections, retractions, or updates to that record.
  4. Funding Metadata plugin - As of OJS 3.1.2, it is possible to enable a funding 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.
  5. 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 at PKP’s Crossref OJS Manual, plus there’s a very active PKP Community Forum which 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 owner: Isaac Farley   |   Last updated 2022-November-04