Versions Compared

Old Version 6

changes.mady.by.user Tim Donohue

Saved on

compared with

New Version 7

changes.mady.by.user Kim Shepherd

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: added section about identifier pre-reg

...

If you want DSpace to support other registration agencies, you just have to write a Java class that implements the interface DOIConnector ([dspace-source]/dspace-api/src/main/java/org/dspace/identifier/doi/DOIConnector.java). You might use the DataCiteConnector ([dspace-source]/dspace-api/src/main/java/org/dspace/identifier/doi/DataCiteConnector.java) as an example. After developing your own DOIConnector, you configure DSpace as if you were using the DataCite API directly. Just use your DOIConnector when configuring the IdentifierService instead of the DataCiteConnector.

Configuring pre-registration of Identifiers

Why mint in submission?

Users often want to see what DOI they will  get so they can alter their PDF, coverpage, other metadata, and so on.

This feature should ensure that users can see their future DOI, and if necessary, a warning that if certain conditions are not met, the DOI will not be registered after approval.

Keeping a DOI in pending status does use up an integer from the total DOI namespace, but it also ensures that the submitter, reviewers, administrators etc know what the DOI will be if it is ever registered in the future.

If this is really not desired, eg. there are many item types which should never get a DOI, then there is a way to configure a filter that avoids minting a new PENDING DOI at all unless conditions are met in submission.

Enable the Identifiers step

See Submission User Interface#Configuringthe%22Identifiers%22step

Configure filters and behaviour

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

If an item does not have a DOI at all, or if an item has a MINTED or PENDING DOI, a user with ADMIN rights over the item may queue the DOI registration from the Item Status page. No filters will be applied to this action. This requires identifiers.item-status.register-doi  to be true  in identifiers configuration (see above)