Difference between revisions of "SUNScholar/Researcher Identification/5.X/ORCID"

Latest revision as of 11:52, 28 May 2016

BACK TO RESEARCHER IDENTIFICATION

What is ORCID?

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

ORCID Help

Create local researcher ORCID records

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.

Scope of Implementation

Before implementing ORCID with DSpace, please refer to:

https://jira.duraspace.org/browse/DS-2785

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.

dc.contributor.author

dc.contributor.advisor

dc.contributor.editor

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.

plugin.named.org.dspace.content.authority.ChoiceAuthority = \
    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

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

choices.plugin.dc.contributor.editor = SolrAuthorAuthority
choices.presentation.dc.contributor.editor = authorLookup
authority.controlled.dc.contributor.editor = true
authority.author.indexer.field.3 = 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">
        <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>
            <entry key="dc_contributor_editor">
                <bean class="org.dspace.authority.PersonAuthorityValue"/>
            </entry>
        </map>
    </property>
</bean>

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

WARNING:

Please consult the following before creating an index cache:

https://wiki.duraspace.org/display/DSDOC5x/ORCID+Integration#ORCIDIntegration-DifferentpossibleusecasesforIndex-authorityscript for official DSpace notes.
https://wiki.duraspace.org/display/DSPACE/Authority+Control+of+Metadata+Values for a discussion of the metadata authority control framework.

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: http://wiki.lib.sun.ac.za/index.php/SUNScholar/Daily_Admin 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

References

Screenshots

Submit item

Step 1

Step 2

Step 3

Update item metadata

Step 1

Step 2

Step 3

@@ Line 3: / Line 3: @@
 </center>
-===Step 1===
+==What is ORCID?==
-Enable the ORCID authority control plugin, by typing the following:
+[[Media:Jisc-ARMA-ORCID_final_report.pdf|'''Click here''']] to view the JISC national ORCID implementation project report - 2015.
-  nano $HOME/dspace/source/config/dspace.cfg
-Find the ''plugin.named.org.dspace.content.authority.ChoiceAuthority'' plugin and add as follows:
+<html5media width="560" height="315">File:What-is-ORCID.mp4</html5media>
+===ORCID Help===
+*http://support.orcid.org/knowledgebase
+*https://github.com/ORCID/ORCID-Source
+===Create local researcher ORCID records===
+*http://members.orcid.org/create-records
+*http://orcid-create-on-demand.herokuapp.com
+*https://github.com/lizkrznarich/orcid-demo-app
+==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)
+<font color="red">'''Consult with your campus network administrator to ensure that your server has the correct access to the ORCID API web sites.'''</font>
+==<font color="red">Scope of Implementation</font>==
+''Before implementing ORCID with DSpace, please refer to:''
+ https://jira.duraspace.org/browse/DS-2785
+The current implementation of ORCID with DSpace 5.X is related to item metadata only.
+'''<u>There is no relation between user accounts in DSpace and item metadata updated by the ORCID feature.</u>'''
+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.
+ dc.contributor.author
+ dc.contributor.advisor
+ dc.contributor.editor
+See details below for implementation.
+==Step 1 - Enable the ORCID authority control plugin==
+''Please note: The ORCID authority control plugin is called the <tt>'''SolrAuthorAuthority'''</tt> plugin, perhaps it should have been called <tt>'''ORCIDContributorAuthority'''</tt>.''
+Edit the following file:
+  nano $HOME/{{Source}}/dspace/config/dspace.cfg
+Search for <tt>'''ORCID authority control'''</tt> and remove comments to enable.
+See example below.
 <pre>
 plugin.named.org.dspace.content.authority.ChoiceAuthority = \
      org.dspace.content.authority.SolrAuthority = SolrAuthorAuthority
 </pre>
-===Step 2===
+==Step 2 - Enable the DSpace authority control event listener==
-Configure the plugin. Search for the following and uncomment the hashes.
+Edit the following file:
+ nano $HOME/{{Source}}/dspace/config/dspace.cfg
+Search for <tt>'''event.dispatcher.default.consumers'''</tt> 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 <tt>'''SolrAuthorAuthority'''</tt> plugin, perhaps it should have been called <tt>'''ORCIDContributorAuthority'''</tt>.''
+===Step 3.1===
+Edit the following file:
+ nano $HOME/{{Source}}/dspace/config/dspace.cfg
+Search for <tt>'''ORCID based authority control'''</tt> then uncomment the hashes and modify as needed.
+See example below.
 <pre>
-solr.authority.server=${solr.server}/authority
+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
+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
+choices.plugin.dc.contributor.editor = SolrAuthorAuthority
+choices.presentation.dc.contributor.editor = authorLookup
+authority.controlled.dc.contributor.editor = true
+authority.author.indexer.field.3 = dc.contributor.editor
 </pre>
-===References===
+===Step 3.2===
+Update the <tt>'''orcid-authority-services.xml'''</tt> 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 <tt>'''fieldDefaults'''</tt> section and add the advisor entry key.
+See example below.
+<pre>
+    <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>
+            <entry key="dc_contributor_editor">
+                <bean class="org.dspace.authority.PersonAuthorityValue"/>
+            </entry>
+        </map>
+    </property>
+</bean>
+</pre>
+==Step 4 - Rebuild DSpace==
+[[SUNScholar/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 [[SUNScholar/Prepare_Ubuntu/S05|'''Tomcat security is enabled''']] in <tt>'''/etc/default/tomcat7'''</tt>.
+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 <tt>'''/home/dspace/solr'''</tt> folder.
+To ensure file permissions are adequate, type the following:
+ sudo chmod 0777 -R /home/dspace/solr
+===<font color="red">'''WARNING:'''</font>===
+Please consult the following before creating an index cache:
+*https://wiki.duraspace.org/display/DSDOC5x/ORCID+Integration#ORCIDIntegration-DifferentpossibleusecasesforIndex-authorityscript for official DSpace notes.
+*https://wiki.duraspace.org/display/DSPACE/Authority+Control+of+Metadata+Values for a discussion of the metadata authority control framework.
+==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: http://wiki.lib.sun.ac.za/index.php/SUNScholar/Daily_Admin 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==
+<html5media width="560" height="315">https://www.youtube.com/watch?v=ZVVAzxsBmYQ</html5media>
+==References==
 *https://wiki.duraspace.org/display/DSDOC5x/ORCID+Integration
+*https://wiki.duraspace.org/display/DSPACE/Authority+Control+of+Metadata+Values
+*http://odin-project.eu
+==Screenshots==
+===Submit item===
+====Step 1====
+[[File:Orcid-submit-1.png|800px|border]]
+====Step 2====
+[[File:Orcid-form-2.png|800px|border]]
+====Step 3====
+[[File:Orcid-form-3.png|800px|border]]
+===Update item metadata===
+====Step 1====
+[[File:Orcid-item-1.png|800px|border]]
+====Step 2====
+[[File:Orcid-item-2.png|800px|border]]
+====Step 3====
+[[File:Orcid-item-3.png|800px|border]]
+[[Category:System Administration]]

Difference between revisions of "SUNScholar/Researcher Identification/5.X/ORCID"

Latest revision as of 11:52, 28 May 2016

Contents

What is ORCID?

ORCID Help

Create local researcher ORCID records

Requirements

Scope of Implementation

Step 1 - Enable the ORCID authority control plugin

Step 2 - Enable the DSpace authority control event listener

Step 3 - Configure the ORCID authority control plugin

Step 3.1

Step 3.2

Step 4 - Rebuild DSpace

Step 5 - Create an ORCID authority index cache

Tomcat Security

Folder and file permissions/ownership

WARNING:

Step 6 - Maintain ORCID authority index cache

Step 6.1 - Ad-hoc update

Step 6.2 - Regular update

Step 6.3 - Export authority records

YouTube Video

References

Screenshots

Submit item

Step 1

Step 2

Step 3

Update item metadata

Step 1

Step 2

Step 3

Navigation menu

Search