How-to
Configuring Automatic DOI Registration
Setting up the deposit account and the test mode so that an institution with a Crossref membership sends DOIs to Crossref automatically as records are published.
Automatic DOI registration is off by default. Turn it on once the institution has a Crossref membership and a deposit account. While it is on, every public record whose DOI starts with the institution's prefix is sent to Crossref automatically when it is published and when its metadata changes. The file that is sent is the same as the file downloaded with Download Crossref XML on the record screen.
Crossref details
- On the Administration → Site settings screen, open the Integrations tab.
- On the Crossref / DOI card, fill in the DOI prefix, Registrant, Depositor name and Depositor e-mail fields.
- Press the Save button under the ROR (organisation identifiers) card.
Crossref sends the processing result of every deposit to the depositor e-mail address.
Deposit account and test
- On the Automatic DOI registration (Crossref) card, fill in the Deposit login field. For role-based
accounts, the user name has the form
user/role. - Enter the password in the Deposit password field.
- Check that the Test mode switch is on.
- Turn on the Automatic DOI registration switch.
- Press the card's Save button.
- Publish a few records.
- On the record screen, check that the Crossref status is Sent.
- Check that a success result has arrived at the depositor e-mail address.
- Turn off the Test mode switch.
- Press the card's Save button again.
Test mode is on by default. In test mode, the files go to test.crossref.org and the DOIs are not really registered. When test mode is off, the files go to doi.crossref.org.
The password is stored encrypted and is never shown again. If you leave the field empty and save, the stored password is kept. The Remove the saved password option deletes the password. Automatic registration cannot be turned on before a DOI prefix is saved. When you save the DOI prefix in the form on the same tab, the card updates by itself. Unsaved changes on the card stay in place.
Deposit rules
- The same metadata is not sent twice.
- After test mode is turned off, a record goes to the live system at its next change or when it is sent by hand. Having been sent to the test system before does not prevent this.
- Edits made one after another within half a minute are combined into one deposit.
- Records harvested from DergiPark (Türkiye's national journal platform) are not sent, because DergiPark registers their DOIs.
- If Crossref cannot be reached or is busy, the deposit is retried at growing intervals. After the last attempt, the job stays on the System health → Background jobs tab and can be run again from there.
- If the user name or the password is refused, or if the record does not meet Crossref's rules, the deposit fails at once.
The status line at the top of the card shows the numbers of sent, waiting and failed records. The Recent errors list gives the cause of each error and the link to the record. The Crossref card on the record screen and the Send now button are explained in Automatic DOI Registration.