Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: removed XMLUI-only warning as PR#2710 ported to JSPUI


Info
titleORCID API version compatibility

Please note that ORCID API 1.2 was turned off on August 1, 2018. To use the current ORCID API 2.x, you will need DSpace 5.9 or DSpace 6.3 or newer. Details: DS-3447.

Table of Contents
minLevel2
outlinetrue
stylenone

...

Enabling the ORCID authority control


Warning
titleJSPUI XMLUI Theme Support

In DSpace 5.0 , the functionality only includes user interface functionality for the DSpace XML User Interface. 

Warning
titleXMLUI Theme Support

In DSpace 5.0 the functionality only adds adds support for the XMLUI Mirage and Mirage 2 themes. Older XMLUI themes including Kubrick, Reference and Classic are currently unsupported.

...

Code Block
event.dispatcher.default.consumers = authority, versioning, discovery, eperson, harvester

Importing existing authors & keeping the index up to date

...

Running this script again will update the index and keep the index clean. For example if an author occurs in a single item and that item is deleted the script will need to be run again to remove it from the index. When run again it will remove all records that no longer have a link to existing authors in the database. 


Submission of new DSpace items - Author lookup

...

For each of the ORCID authors a lookup will be done and their names will be added to the metadata. All the non-ORCID authors will be added as well. The authority keys and solr records are added when the reported changes are applied.

 


Storage of related metadata

...

The information in the authority cache can be updated by running the following command line operation:

Command used:
[dspace]/bin/dspace dsrun org.dspace.authority.UpdateAuthorities
Argumentsdescription
-iupdate specific solr records with the given internal ids (comma-separated)
-hprints this help message

This will iterate over every solr record currently in use (unless the -i argument is provided), query the ORCID web service for the latest data and update the information in the cache. If configured, the script will also update the metadata of the items in the repository where applicable.

...

When set to true and this is script is run, if an authority record's information is updated the whole repository will be scanned for this authority. Every metadata field with this authority key will be updated with the value of the updated authority record.

Configuration

...

will be updated with the value of the updated authority record.

Configuration

In the Enabling the ORCID authority control section, you have been told to add this block of configuration.

Info
titleNOTE: for DSpace 6x you can use local.cfg for these

For all of the configuration options described below, you can use either dspace.cfg or local.cfg. Either will work. It is possible that, when you compile your code with Maven, and you have tests enabled, your build will fail. DSpace unit tests utilize parts of dspace.cfg, and the configuration options you will utilize below are known to cause unit test errors. The easiest way to avoid this situation is to use the local.cfg file.


Code Block
solr.authority.server=${solr.server}/authority
choices.plugin.dc.contributor.author = SolrAuthorAuthority
choices.presentation.dc.contributor.author = authorLookup
authority.controlled.dc.contributor.author = true
authority.author.indexer.field.1=dc.contributor.author

...

Code Block
event.dispatcher.default.consumers = authority, versioning, discovery, eperson, harvester

Without the consumer there is no automatic indexing of the authority cache and the metadata will not even have authority keys.

...