Page History
...
Configuration File: | [dspace]/config/dspace.cfg | |
---|---|---|
Property: | identifier.doi.user | |
Example Value: | Code Block | identifier.doi.user = user123 |
Informational Note: | Username to login into the API of the DOI registration agency. You'll get it from your DOI registration agency. | |
Property: | identifier.doi.password | |
Example Value: | Code Block | identifier.doi.password = top-secret |
Informational Note: | Password to login into the API of the DOI registration agency. You'll get it from your DOI registration agency. | |
Property: | identifier.doi.prefix | |
Example Value:code | identifier.doi.prefix = 10.5072 | |
Informational Note: | The prefix you got from the DOI registration agency. All your DOIs start with this prefix, followed by a slash and a suffix generated from DSpace. The prefix can be compared with a namespace within the DOI system. | |
Property: | identifier.doi.namespaceseparator | |
Example Value: | Code Block | identifier.doi.namespaceseparator = dspace- |
Informational Note: | This property is optional. 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 namespace separator. All the DOIs that DSpace generates will start with the DOI prefix, followed by a slash, the namespace separator and some number generated by DSpace. For example, if 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. |
...
The command line interface in general is documented here: Command Line Operations.
The command used for DOIs is 'doi-organiser
'. You can use the following options:
...
Code Block | ||
---|---|---|
| ||
# Send information about new and changed DOIs to the DOI registration agency: 0 1,13 * * * [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 |
Limitations of DataCite DOI support
Warning |
---|
Every DSpace installation expects to be the only application that generates DOIs which start with the prefix and the namespace separator you configured. DSpace does not check whether a DOI it generates is reserved or registered already. |
That means if you want to use other applications or even more than one DSpace installation to register DOIs with the same prefix, you'll have to use a unique namespace separator for each of them. Also you should not generate DOIs manually with the same prefix and namespace separator you configured within DSpace. For example, if your prefix is 10.5072 you can configure one DSpace installation to generate DOIs starting with 10.5072/papers-, a second installation to generate DOIs starting with 10.5072/data- and another application to generate DOIs starting with 10.5072/results-.
DOIs will be used in addtion addition to Handles. This implementation does not replace Handles with DOIs in DSpace. That means that DSpace will still generate Handles for every item, every collection and every community, and will use those Handles as part of the URL of items, collections and communities.
DSpace currently generates DOIs for items only. There is no support to generate DOIs for Communities and collections yet.
When using DSpaces DSpace's support for the DataCite API probably not all infomration information would be restored when using the AIP Backup and Restore (see Jira
...
- EZID Provider / Registrar settings: By default, the EZIDIdentifierProvider is configured to use the CDLib provider (ezid.cdlib.org) in the
EZID_SCHEME
,EZID_HOST
andEZID_PATH
settings. In most situations, the default values should work for you. However, you may need to modify these values (especially theEZID_HOST
) if you are registered with a different EZID provider. In that situation, please check with your provider for valid "host" and "path" settings. If your provider provides EZID service at a particular path on its host, you may set that inEZID_PATH
.- NOTE: As of the writing of this documentation, the default CDLib provider settings should also work for institutions that use Purdue (ezid.lib.purdue.edu) as a provider. Currently, Purdue and CDLib currently share the same infrastructure, and both
ezid.cdlib.org
andezid.lib.purdue.edu
point to the same location.
- NOTE: As of the writing of this documentation, the default CDLib provider settings should also work for institutions that use Purdue (ezid.lib.purdue.edu) as a provider. Currently, Purdue and CDLib currently share the same infrastructure, and both
- Metadata mappings: You can alter the mapping between DSpace and EZID metadata, should you choose. The
crosswalk
property is a map from DSpace metadata fields to EZID fields, and can be extended or changed. Thekey
of eachentry
is the name of an EZID metadata field; thevalue
is the name of the corresponding DSpace field, from which the EZID metadata will be populated. - Crosswalking / Transforms: You can also supply transformations to be applied to field values using the
crosswalkTransform
property. Eachkey
is the name of an EZID metadata field, and itsvalue
is the name of a Java class which will convert the value of the corresponding DSpace field to its EZID form. The only transformation currently provided is one which converts a date to the year of that date, namedorg.dspace.identifier.ezid.DateToYear
. In the configuration as delivered, it is used to convert the date of issue to the year of publication. You may create new Java classes with which to supply other transformations, and map them to metadata fields here. If an EZID metadatum is not named in this map, the default mapping is applied: the string value of the DSpace field is copied verbatim.
Limitations of EZID DOI support
DOIs will be used in addition to Handles. This implementation does not replace Handles with DOIs in DSpace. That means that DSpace will continue to generate Handles for every item, every collection and every community, and will use those Handles as part of the URL of items, collections and communities.
Currently, the EZIDIdentifierProvider has a known issue where it stores its DOIs in the dc.identifier
field, instead of using the dc.identifier.uri
field (which is the one used by DataCite DOIs and Handles). See DS-2199 for more details. This will be corrected in a future version of DSpace.
DSpace currently generates DOIs for items only. There is no support to generate DOIs for Communities and Collections yet.
Adding support for other Registration Agencies
...