Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Minor enhancements/additions to the EZID docs

...

The EZID IdentifierProvider operates synchronously, so there is much less to configure. You will need to un-comment the the org.dspace.identifier.EZIDIdentifierProvider bean in config/spring/api/identifier-service.xml to enable DOI registration through EZID.

...

namemeaning
identifier.doi.ezid.shoulderThe "shoulder" is the DOI prefix issued to you by the EZID service.  DOIs minted by this instance of DSpace will be the concatenation of the "shoulder" and a locally unique token.

identifier.doi.ezid.user

identifier.doi.ezid.password

The username and password by which you authenticate to EZID.
identifier.doi.ezid.publisherYou may specify a default value for the required datacite.publisher metadatum, for use when the Item has no publisher.

In Back in config/spring/api/identifier-service.xml you will see some other configuration of the EZIDIdentiferProvider bean.   You may not need to change any of itIn most situations, the default settings should work well.  But here 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.  The key of each entry is the name of an EZID metadata field; the value is the name of the corresponding DSpace field, from which the EZID metadata will be populated.

You can also supply transformations to be applied to field values using the crosswalkTransform property.  Each key is the name of an EZID metadata field, and its value 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, named org.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.

...

, here's an explanation of options available:

  • EZID Provider / Registrar settings: By default, the EZIDIdentifierProvider is configured to use the CDLib provider (ezid.cdlib.org) in the EZID_SCHEME, EZID_HOST and EZID_PATH settings. In most situations, the default values should work for you. However, you may need to modify these values (especially the EZID_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 in EZID_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 and ezid.lib.purdue.edu point to the same location.
  • 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.  The key of each entry is the name of an EZID metadata field; the value 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.  Each key is the name of an EZID metadata field, and its value 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, named org.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.

Adding support for other Registration Agencies

...