SUNScholar/Researcher Identification/5.X/ORCID

BACK TO RESEARCHER IDENTIFICATION

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:

1. http://pub.orcid.org (For public read access)
2. https://api.orcid.org (For member read/write access)

Consult with your campus network administrator to ensure your server has the correct access to the ORCID 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 per 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".

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

Step 4 - Rebuild DSpace

Click here to rebuild DSpace.

Step 5 - Import existing authorities

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

$HOME/bin/dspace index-authority

What is ORCID?

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

ORCID Help

• http://support.orcid.org/knowledgebase

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

References

• https://wiki.duraspace.org/display/DSDOC5x/ORCID+Integration