Automated DOI Generation & Crossref Metadata Deposit Plugin
Step-by-step implementation guide for automated DOI assignment and Crossref deposits in OJS. Covers prefix configuration, suffix patterns, automated deposits, and error resolution.
Real Problem
Many editorial teams manually download Crossref XML files and upload them to the Crossref web portal for every published issue, leading to delayed indexing, missing DOIs, and metadata errors.
Practical Solution
Configure the native Crossref Export/Deposit plugin in OJS with institutional member credentials, enable automated deposit upon publication, and establish diagnostic error logs for deposit verification.
The Essential Role of DOIs in Academic Publishing
A Digital Object Identifier (DOI) is an internationally standardized persistent identifier that provides a permanent, reliable link to scholarly content. Even if your university changes server infrastructure or domain names, the DOI remains unchanged, routing citation traffic directly to the current article URL.
Crossref is the world's leading DOI registration agency for scholarly research. Open Journal Systems features deep, native integration with the Crossref API, enabling fully automated metadata synchronization.
Step 1: Configuring the DOI Plugin
Navigate to Settings > Distribution > DOIs:
1. Enable DOI generation for Articles.
2. Enter your Crossref DOI Prefix (e.g., 10.55555).
3. Select your DOI Suffix Generation Pattern:
- Default: Automatically generates suffixes using journal initials and submission ID (e.g., %j.v%vi%i.%a).
- Custom: Allows editors to manually define suffixes during copyediting.
We recommend the Default algorithmic pattern to prevent human typographical errors.
Step 2: Configuring the Crossref XML Export Plugin
Navigate to Tools > Import/Export > Crossref XML Export Plugin > Settings:
- Depositor Name: The official registered name of your publishing organization.
- Depositor Email: An administrative email address monitored for Crossref error reports.
- Crossref Username & Password: The API credentials assigned to your organization by Crossref.
- Automatic Deposit: Check "OJS will deposit articles automatically to Crossref upon publication."
Step 3: Background Automated Task Processing
Automated deposits are executed by the OJS scheduled task runner. Ensure that real system crontab is configured (as detailed in Cluster 3) so that tools/runScheduledTasks.php executes hourly.
When an issue is published, OJS queues the metadata XML, sends a POST request over TLS to the Crossref deposit gateway (api.crossref.org), and polls for the registration receipt.
Step 4: Debugging Failed Deposits
If an article displays a "Failed" status in the Crossref plugin dashboard, click "View Log":
- "User lacks permission": Invalid Crossref username or password.
- "DOI already exists": The DOI was previously registered under a different URL. Update URL via Crossref admin interface.
- "Malformed XML / Schema validation failed": An author field contains illegal control characters or missing required attributes.
Step-by-Step Action Plan
Obtain Crossref Membership & Prefix
Acquire your official Crossref DOI prefix (e.g., 10.12345) and institutional depositor credentials.
Configure DOI Plugin in OJS
Navigate to Settings > Distribution > DOIs, enter your assigned prefix, and select a standardized suffix generation rule.
Set Up Crossref Export Plugin Credentials
In Plugins > Import/Export > Crossref XML Export Plugin, enter depositor name, email, username, and password.
Enable Automatic Deposits
Check the box "Automatic Deposits" to instruct OJS to submit metadata immediately whenever an issue is published.
Audit Deposit Status & Resolve XML Errors
Check the Crossref deposit log tab to verify that articles show "Active" or "Submitted" status without schema rejections.
Questions People Usually Ask
Why does a Crossref deposit return a 400 Bad Request error?
This occurs when mandatory metadata is missing—such as an empty author surname, missing article title, invalid publication date, or an abstract containing unclosed HTML tags.
How long does it take for a newly deposited DOI to resolve?
Crossref typically registers and activates new DOIs within 15 to 45 minutes. Once active, the handle resolves globally via https://doi.org/10.XXXX/XXXX.
Can OJS register DOIs for individual articles as well as entire issues?
Yes! In the DOI settings, you can choose to assign DOIs to articles, issues, and even individual galleys or supplementary datasets.
Tired of Manual Crossref XML Deposits?
AcademiaTech configures automated Crossref DOI pipelines that register article metadata with Crossref instantly upon publication.