Tutorial: Crossref Funders Registry Setup
Role: Journal Manager
Time: 20–30 minutes
OJS Version: 3.5+
The Funding Plugin for OJS integrates with the Crossref Funders Registry (FundRef) to collect structured funder acknowledgements from authors at submission and include them in CrossRef metadata deposits.
Before You Start
- You have Journal Manager access in OJS.
- Your journal has CrossRef DOIs configured. See Enable DOIs with CrossRef.
- The CrossRef XML Export Plugin is enabled and credentials are saved.
Step 1 — Install the Funding Plugin
- Log in as Site Administrator.
- Go to Administration → Plugin Gallery.
- Search for Funding.
- Click Install.
If already installed, skip to Step 2.
Step 2 — Enable the Plugin
- Go to Settings → Website → Plugins → Installed Plugins.
- Find Funding in the list.
- Toggle to Enabled.
Step 3 — Configure the Plugin
- Click the Settings (gear) icon next to the Funding plugin.
- Enable the following options as required:
| Setting | Recommendation |
|---|---|
| Show funder during submission | Enable — authors add funders in the submission form |
| Require funder for submission | Optional — make funder entry mandatory |
| Show on article page | Enable — display funder info on published article pages |
- Click Save.
Step 4 — Author Experience During Submission
When the plugin is enabled, authors see a Funding section in the submission form:
- Author types the funder name in the search box.
- The plugin queries the Crossref Funders Registry and returns matching funders.
- Author selects the correct funder.
- Author optionally enters the Award/Grant Number.
- Multiple funders can be added.
Step 5 — Include Funder Data in CrossRef Deposits
Funder data is automatically included in CrossRef XML deposits when:
- The Funding Plugin is enabled and configured.
- The CrossRef XML Export Plugin is enabled.
- The article has a registered DOI.
To verify funder data in a CrossRef deposit:
- Go to Tools → Import/Export → CrossRef XML Export Plugin.
- Select an article that has funder data.
- Click Export and inspect the XML — you should see a
<fr:program>block containing funder names and award numbers.
Step 6 — Verify on Article Pages
- Navigate to a published article that has funder data.
- The Funding Sources section should appear in the article metadata.
Troubleshooting
| Problem | Solution |
|---|---|
| Funder search returns no results | Check internet connectivity from the OJS server; the plugin queries Crossref's API |
| Funder data missing from CrossRef XML | Ensure the plugin is enabled and that the article was saved after the plugin was configured |
| Plugin not found in Plugin Gallery | Download from github.com/pkp/funding and install manually |
Next Steps
- Enable DOIs with CrossRef — required for funder data deposits
- ORCID Profile Setup — collect author ORCID iDs alongside funder data
- Research Org. Registry Setup — add institutional affiliation data