SUNScholar/Researcher Identification/5.X/ORCID

From Libopedia
Jump to navigation Jump to search

What is ORCID?

Click here to view the JISC national ORCID implementation project report - 2015.


Create local researcher ORCID records


The ORCID feature in DSpace needs to consult an external database when doing identity lookups.

Therefore you MUST ensure that your repository server has unrestricted access via ports 80 and 443 to the following web sites: (For public read access, essential for DSpace to do identification lookups!) (For member read/write access, not needed yet for DSpace, but good to have)

Consult with your campus network administrator to ensure that your server has the correct access to the ORCID API web sites.

Scope of Implementation

Before implementing ORCID with DSpace, please refer to:

The current implementation of ORCID with DSpace 5.X is related to item metadata only.

There is no relation between user accounts in DSpace and item metadata updated by the ORCID feature.

The ORCID lookup feature only updates the contributor metadata information per item or submission.

At Stellenbosch University library we update the following metadata fields per item with the ORCID lookup per submission or per item metadata customisation/update.

See details below for implementation.

Step 1 - Enable the ORCID authority control plugin

Please note: The ORCID authority control plugin is called the SolrAuthorAuthority plugin, perhaps it should have been called ORCIDContributorAuthority.

Edit the following file:

nano $HOME/source/dspace/config/dspace.cfg

Search for ORCID authority control and remove comments to enable.

See example below. = \
    org.dspace.content.authority.SolrAuthority = SolrAuthorAuthority

Step 2 - Enable the DSpace authority control event listener

Edit the following file:

nano $HOME/source/dspace/config/dspace.cfg

Search for event.dispatcher.default.consumers and ensure the "default" listener also includes "authority".

See example below.

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

Step 3 - Configure the ORCID authority control plugin

Please note: The ORCID authority control plugin is called the SolrAuthorAuthority plugin, perhaps it should have been called ORCIDContributorAuthority.

Step 3.1

Edit the following file:

nano $HOME/source/dspace/config/dspace.cfg

Search for ORCID based authority control then uncomment the hashes and modify as needed.

See example below.

solr.authority.server = ${solr.server}/authority = SolrAuthorAuthority = authorLookup = true =

choices.plugin.dc.contributor.advisor = SolrAuthorAuthority
choices.presentation.dc.contributor.advisor = authorLookup
authority.controlled.dc.contributor.advisor = true = dc.contributor.advisor

choices.plugin.dc.contributor.editor = SolrAuthorAuthority
choices.presentation.dc.contributor.editor = authorLookup
authority.controlled.dc.contributor.editor = true = dc.contributor.editor

Step 3.2

Update the orcid-authority-services.xml file to add an "advisor" "fieldDefaults" lookup by typing the following:

nano $HOME/source/dspace/config/spring/api/orcid-authority-services.xml

Search for the fieldDefaults section and add the advisor entry key.

See example below.

    <property name="fieldDefaults">
            <entry key="dc_contributor_author">
                <bean class="org.dspace.authority.PersonAuthorityValue"/>
            <entry key="dc_contributor_advisor">
                <bean class="org.dspace.authority.PersonAuthorityValue"/>
            <entry key="dc_contributor_editor">
                <bean class="org.dspace.authority.PersonAuthorityValue"/>

Step 4 - Rebuild DSpace

Click here to rebuild DSpace.

Step 5 - Create an ORCID authority index cache

After the rebuild, create an authority index cache by running the following script:

$HOME/bin/dspace index-authority

Note: This may take a long time if there are many authors in the DSpace metadata!

Tomcat Security

If you have problems running this script, please check if Tomcat security is enabled in /etc/default/tomcat7.

We disabled security to be able to run the script and then re-enabled security after the script ran.

The next step is to see if new items with new authors get an author authority record with Tomcat security enabled.

Folder and file permissions/ownership

In addition the script requires full permission to the /home/dspace/solr folder.

To ensure file permissions are adequate, type the following:

sudo chmod 0777 -R /home/dspace/solr


Please consult the following before creating an index cache:

Step 6 - Maintain ORCID authority index cache

The data in a researchers ORCID profile on the ORCID web site may change, for example, if someone marries and changes their surname in their ORCID profile, this information needs to be updated in the local DSpace database.

Follow the procedures below to do this on an ad-hoc or regular basis.

Step 6.1 - Ad-hoc update

Type the following to do an ad-hoc update:

sudo $HOME/bin/dspace dsrun org.dspace.authority.UpdateAuthorities

Step 6.2 - Regular update

Add the command in the step above to your daily admin routine.

See: for an example after selecting DSpace 5.X.

Step 6.3 - Export authority records

Type the following to export the authority records as a backup.

sudo $HOME/bin/dspace dsrun org.dspace.util.SolrImportExport -a export --index-name authority

The exported files are in $HOME/solr-export.

YouTube Video



Submit item

Step 1


Step 2


Step 3


Update item metadata

Step 1


Step 2


Step 3