All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
Old Release
This documentation relates to an old version of DSpace, version 4.x. Looking for another version? See all documentation.
This DSpace release is end-of-life and is no longer supported.
Work in progress
This page has just been created and is still work in progress
Persistent Identifier
It is good practice to user Persistent Identifier to address items in a digital repository. There are many different systems for persistent Identifiers: Handle, DOI, urn:nbn, purl and many more. It is far out of the scope of this document to discuss the differences of all these systems. For several reasons the handle system is deeply integrated in DSpace and DSpace makes intensive use of handles. With DSpace 3.0 the Identifier Service was introduced that makes it possible to use external identifier services within DSpace.
DOIs are Persistent Identifier like handles are. But as many big publishing companies uses DOIs they are quite well-known by scientists. Some journals asks for DOIs to link supplemented material whenever an article is submitted. Beginning with DSpace 4.0 it is possible to use DOIs in parallel to the handle system within DSpace. By using DOIs we mean automatic generation, reservation and registration of DOIs for every item that gets published.
DOI Registration Agencies
To register a DOI one has to enter into a contract with a DOI registration agency that is member of the International DOI Foundation. Several such agencies exist. Different DOI registration agencies have different policies. Some of them offer DOI registration specially or only for academic institutions, others only for publishing companies. Most of the registration agencies charge fees for registering DOIs, all of them have different rules describing for what kind of item a DOI can be registered. To make it quite clear: to register DOIs with DSpace you have to enter into a contract with a DOI registration agency.
DataCite is an international initiative to promote science and research and a member of the International DOI Foundation. The members of DataCite act as registration agencies for DOIs. Some DataCite members provide own APIs to reserve and register DOIs, others let their clients use the API from DataCite directly. Starting with version 4.0 DSpace support registering, reserving, ... DOIs using the DataCite API directly or using the API from EZID which is a service of the University of California Digital Library. So starting with DSpace 4.0 it is possible to use DOIs with all DataCite members that let you use the DataCite API directly and with EZID.
DSpace DOI Configuration
To use DOIs within DSpace you have to configure several parts of DSpace. You'll have to enter your DOI prefix and the credentials to use the API from the DOI registration agency in dspace.cfg. If you use the DataCite API directly you'll have to configure the script which generates some metadata. Then you'll have to activate the DOI mechanism within DSpace. And last you have to configure a cronjob which transmits the information about new and changed DOIs to the registration agency.
dspace.cfg
After you entered into a contract with an DOI registration agency, they provide you with credentials and a DOI prefix. You have to enter these in the dspace cfg. Here is a list of DOI configuration options in dspace.cfg:
| Configuration File: | [dspace]/config/dspace.cfg |
|---|---|
| Property: | identifier.doi.user |
| Example Value: | identifier.doi.user = user123 |
| Informational Note: | Username to login into the API of the DOI registration agency. You can get it from you DOI registration agency. |
| Property: | identifier.doi.password |
| Example Value: | identifier.doi.password = top-secret |
| Informational Note: | Password to login into the API of the DOI registration agency. You can get it from you DOI registration agency. |
| Property: | identifier.doi.prefix |
| Example Value: | identifier.doi.prefix = 10.5072 |
| Informational Note: | The prefix that you got from the DOI registration agency. All your DOIs start with the prefix, followed by a slash and a suffix generated from DSpace. The prefix can be compared with a name space within the DOI system. |
| Property: | identifier.doi.namespaceseparator |
| Example Value: | identifier.doi.namespaceseparator = dspace- |
| Informational Note: | The value can remain empty. If you want to use the same DOI prefix in several DSpace installations or with other tools that generate and register DOIs it is necessary to use a name space separator. All the DOIs that DSpace generates will start with the DOI prefix, followed by a slash, the name space separator and some number generated by DSpace. If for example your prefix is 10.5072 and you want all DOIs generated by DSpace to look like 10.5072/dspace-1023 you have to set this as in the example value above. |
Identifier Service
'cron' Job for asynchronous reservation/registration
DataCite metadata
Command Line Interface / Cron job
Limitations of DSpace DOI support
Adding support for other Registration Agencies
Overview
Content Tools
All content on the LYRASIS Wiki is licensed under the CC BY (Attribution) license
, unless otherwise noted.