Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Information on how to change and test the xslt that is used when sending metadata to DataCite as part of the DOI registration

...

If you want to know more about the DataCite Schema, have a look at the documentation. If you change this file in a way that is not compatible with the DataCite schema, you won't be able to reserve and register DOIs anymore. Do not change anything if you're not sure what you're doing. To get the XML on which the XSLT processor will start, use the following command:

Code Block
languagebash
[dspace]/bin/dspace dsrun org.dspace.content.crosswalk.XSLTDisseminationCrosswalk dim 123456789/3

To get the XML that will be send to DataCite replace 'dim' with 'DataCite'. If the DOI is not stored in the metadata, DSpace will add it automatically as identifier. So don't worry if the XML produced by this command does not contain the DOI. Once the DOI is stored in the metadata, it should also be contained in the XML.

Identifier Service

The Identifier Service manages the generation, reservation and registration of identifiers within DSpace. You can configure it using the config file located in [dspace]/config/spring/api/identifier-service.xml. In the file you should already find the code to configure DSpace to register DOIs. Just read the comments and remove the comment signs around the two appropriate beans.

...

Code Block
title\[dspace\]/config/spring/api/identifier-service.xml
<!--
    Copyright (c) 2002-2010, DuraSpace.  All rights reserved
    Licensed under the DuraSpace License.

    A copy of the DuraSpace License has been included in this
    distribution and is available at: http://www.dspace.org/license
-->

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
           http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">

    <bean id="org.dspace.identifier.service.IdentifierService"
          class="org.dspace.identifier.IdentifierServiceImpl"
          autowire="byType"
          scope="singleton"/>

    <bean id="org.dspace.identifier.DOIIdentifierProvider"
        class="org.dspace.identifier.DOIIdentifierProvider"
        scope="singleton">
        <property name="configurationService"
            ref="org.dspace.services.ConfigurationService" />
        <property name="DOIConnector"
            ref="org.dspace.identifier.doi.DOIConnector" />
    </bean>

    <bean id="org.dspace.identifier.doi.DOIConnector"
        class="org.dspace.identifier.doi.DataCiteConnector"
        scope="singleton">
        <property name='DATACITE_SCHEME' value='https'/>
        <property name='DATACITE_HOST' value='mds.test.datacite.org'/>
        <property name='DATACITE_DOI_PATH' value='/doi/' />
        <property name='DATACITE_METADATA_PATH' value='/metadata/' />
        <property name='disseminationCrosswalkName' value="DataCite" />
    </bean>
</beans>

...

Please pay attention to configure the property DATACITE_HOST. Per default it is set to the DataCite test server. To reserve real DOIs you will have to change it to mds.datacite.org. Ask your registration agency if you're not sure about the correct address.

Sending metadata updates to DataCite

DSpace should send updates to DataCite whenever the metadata of an item changes. To do so, you have to change the must enable the DOIConsumer in your dspace.cfg again(or local.cfg. You should remove the comments in front of the two following properties or add them to the dspacelocal.cfg:

Code Block
title\[dspace\]/config/dspace.cfg
event.consumer.doi.class = org.dspace.identifier.doi.DOIConsumer
event.consumer.doi.filters = Item+Modify_Metadata

...

To enable this feature and configure the exact way it works, edit the ${dspace.dir}/dspace/modules/identifiers.cfg  configuration file

Property:

identifiers.submission.register

Example Value:

true

Informational Note:

Enable this feature. Default: false.

Handles will be registered at time of submission.

DOIs (if item filters evaluate to true) will be minted in a "pending" state for items, to be registered or queued for registration at archival.

Property:

identifiers.submission.filter.install

Example Value:

doi-filter

Informational Note:

Bean ID of a logical item filter (see config/modules/spring/api/item-filters.xml ) that will be used to evaluate whether a DOI should be queued  for registration when this item is installed (archived) in DSpace. This filter will be applied whether or not a "pending" DOI is already minted for the item.

(If a filter is absent or null, an item will always be evaluated as 'true')

Property:

identifiers.submission.filter.workspace

Example Value:

always_true_filter

Informational note

Bean ID of a logical item filter (see config/modules/spring/api/item-filters.xml ) that will be used to evaluate whether a DOI should be minted as "pending" for registration when this item is first submitted as a workspace item in DSpace.

Depending on the value of identifiers.submission.strip_pending_during_submission this filter will be checked whenever the workspace item changes, to see if it now qualifies for a DOI.

Default: always_true_filter

(If a filter is absent or null, an item will always be evaluated as 'true')

Property:

identifiers.submission.strip_pending_during_submission

Example Value:

true

Informational Note:

If, during workspace item changes, the workspace filter no longer evaluates to true, should any DOIs be stripped? (moved to MINTED or DELETED status)

This is useful in situations where the submitter needs real-time feedback as to whether their item qualifies for a DOI.

Property:

identifiers.item-status.register-doi

Example Value:

false

Informational Note:

Allow administrators to queue DOIs for registration in the Item Status page.

Default: false.

Important: This configuration property must  be set, even if it matches the default, as it is exposed as a REST configuration property to the frontend.

Administrator registration

...