Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

When a DOI should be reserved, registered, delete deleted or the its metadata need needs to be updated, DSpace just write writes this information into its local database. A command line interface is supplied to send the necessary information to the registration agency. This behaviour makes it easier to react on outages or errors while using the API from the registration agency. As these information should be send regularly it is a good idea to let this done by a cron job instead of doing it manually.

There are for four commands that should be run regularly:

  • Update the mata data metadata of all items that have changed since their DOI was reserved.
  • Reserve all DOIs marked for reservation
  • Register all DOIs marked for registration
  • Delete all DOIs marked for deletion

In DSpace, a DOI can has have the state "registered", "reserved", "to be reserved", "to be registered", "needs update", "to be deleted", or "deleted". After an updating an update of the metadata of an item items metadata the state of an its assigned DOI is set back to the last state it had before. So f.e. if a DOI has the state "to be registered" and the metadata of its item changeschanged, it will be set to the state "needs update". After the update is performed its state is set "to be registered" again. In cause of this behaviour the order of the commands above matters, the : The update command should must be performed executed before every other of the commands above.

The cron job should perform the following command commands with the rights of the user your DSpace installation runs as:

Code Block
languagebash
[dspace]/bin/dspace doi-organiser -u -q
[dspace]/bin/dspace doi-organiser -s -q
[dspace]/bin/dspace doi-organiser -r -q
[dspace]/bin/dspace doi-organiser -d -q

The doi-organiser command sends error messages as email and logs some messagesadditional information. The option -q tells DSpace to be quiet. That means it does not give information about the command line. If you don't use this option the doi-organiser will print messages to stdout about every DOI it successfully reserved, registered, updated, deleted. Using a cron job these messages will would be send as E-Mail email to you.

In case of an error take a look in consult the log messages what happened. If there is an outage of the API of your registration agency, DSpace will not change the state of the DOIs so that it will do everything necessary when the cron job starts the next time and the API is reachable again.

...