SUNScholar/Researcher Identification/5.X/ORCID

BACK TO RESEARCHER IDENTIFICATION

What is ORCID?

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

ORCID Help

• http://support.orcid.org/knowledgebase
• https://github.com/ORCID/ORCID-Source

Create ORCID records on demand

• http://orcid.org/organizations/integrators/create-client-application
• http://members.orcid.org/web-graphics-guidelines
• http://members.orcid.org/create-records
• http://members.orcid.org/api/get-oauthauthorize
• http://members.orcid.org/api/customize-oauth-login-screen
• http://members.orcid.org/api/post-oauthtoken
• http://members.orcid.org/api/tutorial-add-activities-curl-12-and-earlier
• http://members.orcid.org/api/tutorial-update-bio-curl-12-and-earlier
• http://members.orcid.org/api/tutorial-add-activities-curl-12-and-earlier

Create ORCID records by batch submission

• https://members.orcid.org/batch-create

Requirements

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:

http://pub.orcid.org (For public read access, essential for DSpace to do identification lookups!)

https://api.orcid.org (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.

Step 1 - Enable the ORCID authority control plugin

Edit the following file:

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

Search for ORCID authority control and remove comments to enable.

See example below.

plugin.named.org.dspace.content.authority.ChoiceAuthority = \
    org.dspace.content.authority.SolrAuthority = SolrAuthorAuthority

Step 2 - Configure the plugin

Step 2.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

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

choices.plugin.dc.contributor.advisor = SolrAuthorAuthority
choices.presentation.dc.contributor.advisor = authorLookup
authority.controlled.dc.contributor.advisor = true
authority.author.indexer.field.2=dc.contributor.advisor

Step 2.2

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

nano $HOME/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">
        <map>
            <entry key="dc_contributor_author">
                <bean class="org.dspace.authority.PersonAuthorityValue"/>
            </entry>
            <entry key="dc_contributor_advisor">
                <bean class="org.dspace.authority.PersonAuthorityValue"/>
            </entry>
        </map>
    </property>
</bean>

Step 3 - Enable the authority event listener

Search for the following and ensure the "default" listener includes "authority".

See example below.

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

Step 4 - Rebuild DSpace

Click here to rebuild DSpace.

Step 5 - Import existing authorities (Optional)

WARNING:

Whether to run this script or not depends on how you want to start using ORCID. If you feel that the "eperson" records in your repository are accurate and authoritative then run this script. If you feel that the "eperson" records in your repository are NOT accurate and authoritative then DO NOT run this script. See: https://wiki.duraspace.org/display/DSDOC5x/ORCID+Integration#ORCIDIntegration-DifferentpossibleusecasesforIndex-authorityscript for official DSpace notes.

Update "eperson" records with an authority index

After the rebuild, populate the authority index by running the following script:

$HOME/bin/dspace index-authority

Step 6 - Maintain local DSpace ORCID database

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:

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

Step 6.2 - Regular update

Add the command in Step 6.2 above to your daily admin routine.

See: http://wiki.lib.sun.ac.za/index.php/SUNScholar/Daily_Admin for an example after selecting DSpace 5.X.

References

• https://wiki.duraspace.org/display/DSPACE/Authority+Control+of+Metadata+Values
• https://wiki.duraspace.org/display/DSDOC5x/ORCID+Integration
• http://orcid-create-on-demand.herokuapp.com

Screenshots