Page History

Introduction

DSpace-CRIS provides the most advanced and complete integration between a CRIS / Repository system and ORCID achieving most of the ORCID integration use cases.

The available functionalities depend on the kind of API Key that you have, Public or Member. You must configure your client-id, client secret and specify the endpoint appropriate for your API level in the 

[dspace-installDir]/config/modules/authentication-oauth.cfg (via build.properties)

Introduction

DSpace-CRIS provides the most advanced and complete integration between a CRIS / Repository system and ORCID, achieving most of the ORCID integration use cases.

The available functionalities depend on the kind of API Key that you have: Public or Member. You must configure your client-id, client secret and specify the endpoint appropriate for your API level in the 

[dspace-installDir]/config/modules/authentication-oauth.cfg (via build.properties, that contains configuration like below)

#####################
# ORCID
#####################
#Production Registry
#Step        |     Member API                                |    Public API
#--------------------------------------------------------------------------------------------------------
#Authorize   |    https://orcid.org/oauth/authorize          |    https://orcid.org/oauth/authorize
#Exchange    |    https://orcid.org/oauth/token              |    https://orcid.org/oauth/token
#Use         |    https://api.orcid.org/v3.0                 |    https://pub.orcid.org/v3.0
#--------------------------------------------------------------------------------------------------------
#
#Sandbox
#Step        |     Member API                                |    Public API
#--------------------------------------------------------------------------------------------------------
#Authorize   |     https://sandbox.orcid.org/oauth/authorize |    https://sandbox.orcid.org/oauth/authorize
#Exchange    |     https://sandbox.orcid.org/oauth/token     |    https://sandbox.orcid.org/oauth/token
#Use         |     https://api.sandbox.orcid.org/v3.o        |    https://pub.sandbox.orcid.org/v3.0
#--------------------------------------------------------------------------------------------------------
authentication-oauth.orcid-api-url = https:

# The client id value <client-id> from ORCID client application registration
application-client-id=${authentication-oauth.application-client-id}
# The client secret value <client-secret> from ORCID client application registration
application-client-secret=${authentication-oauth.application-client-secret}
 
# Public API:   	  http://pub.orcid.org/
# Public API Sandbox: httpv3.0
authentication-oauth.application-token-url = https://pub.sandbox.orcid.org/
# Member API:   	  oauth/token
authentication-oauth.application-authorize-url = https://api.orcid.org/oauth/authorize

# Member API Sandbox: http://api.sandbox.orcid.org/
orcid-api-url=${ register for free on ORCID to use an institutional Public API
# IMPORTANT!! Please fill authentication-oauth.orcidapplication-api-url}
 
# Th Redirect URL should be constructed off your dspace url in the following manner:
# http://dspace.my/jspui/oauth-login
# or if deployed as ROOT application
# http://dspace.my/oauth-login
application-redirect-uri=${client-name with name of client registered into orcid registries (need by the putcode flow retrieve) 
authentication-oauth.application-client-name =
authentication-oauth.application-client-id =
authentication-oauth.application-client-redirect}
 
# Developers Sandbox 	http://sandbox.orcid.org/oauth/authorize
# Production Registry 	http://orcid.org/oauth/authorize
application-authorize-url=${authentication-oauth.application-authorize-url}


# PUBLIC APIsecret =
authentication-oauth.application-client-redirect = ${dspace.baseUrl}/oauth-login

# If you have only PUBLIC API the scope need to be; /authenticate scope now includes /read-public scope
authentication-oauth.application-client-scope =/authenticate
# if you have MEMBER API
#authentication-oauth.application-client-scope =/authenticate /orcid-profile/read-limited /orcid-bio/update /orcid-works/create /orcid-works/update /funding/create /funding the suggested scopes are as following; /authenticate scope now includes /read-public scope
#authentication-oauth.application-client-scope =/authenticate /read-limited /person/update /activities/update

...

...

The following properties are specific of the authentication integration:

autoregister=true
choice-page=false
orcid-embedded-login=true

the The autoregister flag is auto-explaining,self explanitory. choice-page, if true list , lists the ORCID authentication explicitly as an authentication methods method, so that, if you have multiple authentication methods configured, such as LDAP, Shibboleth, etc., ORCID is also listed in the that choice page. The orcid-embedded-login is the preferred mode, a Login with ORCID button is displayed side-by-side the with password or ldap authentication.

...

When the ORCID Authentication is enabled and the autoregister flag is true. it is possible for a researcher to claim an existent researcher profile that have has an ORICD in DSpace-CRIS just logging in. Indeed, when the user login logs in, the system will create an a user account using the information from ORCID and, if his ORCID match one already assigned to an orphan researcher profile, this new account become the owner of the profile. In such way, external collaborators can login in the system and gains gain limited privileges to improve their profile without any explicit activity by the repository staff.

...

When the user is logged in via ORCID and proceed proceeds to create his local researcher profile, the system automatically captures from ORCID several information: 

Submission lookup

A special authority is build-in DSpace-CRIS to use the ORCID registry togheter with the internal directory of researchers as authority list for metadata editing

...

plugin.named.org.dspace.content.authority.ChoiceAuthority = \
 org.dspace.app.cris.integration.ORCIDAuthority = RPAuthority,\
 ...
 
choices.plugin.dc.contributor.author = RPAuthority
choices.presentation.dc.contributor.author = lookup
authority.controlled.dc.contributor.author = true
...

The org.dspace.app.cris.integration.ORCIDAuthority combines the result retrieved from the internal researchers database with the ones found in ORCID giving precedence to the internal matches. When an author name is selected from the ORCID registry returned list a temporary authority key tracking the ORCID is assigned to the metadata. This information is used when the publication is approved to generate a local researcher profile retrieving further information about the researcher from the ORCID registry such as his biography, email address, name variants, etc more information on this process are available here

Synchronization

DSpace-CRIS is able to capture (Public or Member API) and send information (Member API only) from and to ORCID.

from ORCID to DSpace-CRIS

The dataflow from ORCID to DSpace-CRIS happen in two scenarios:

1. when an user that has been authenticated via ORCID create his researcher profile
2. when an author of a publication is looked up in the ORCID registry during the submission

The scenario #1 has been discussed in the Authentication > Creating a local researcher profile section

The scenario #2 has been discussed in the Submission lookup section.

Using the code available in the 5_x_x branch is also possible to import publication from an ORCID profile in DSpace-CRIS. An ORCIDDataloaderProvider for BTE is included that allow to input an ORCID in the first submission screen (Search by Identifiers) and importing one or all the publications. The dataloader will use the structural information available in the ORCID Work plus the citation field if supplied in a format understandable by another BTE provider (such as BibTex, EndNote, etc.)

The ORCID Online dataloader provider need to be enabled in the bte.xml file

from DSpace-CRIS to ORCID

.cris.integration.ORCIDAuthority = RPAuthority,\
 ...
 
choices.plugin.dc.contributor.author = RPAuthority
choices.presentation.dc.contributor.author = lookup
authority.controlled.dc.contributor.author = true
...

The org.dspace.app.cris.integration.ORCIDAuthority combines the result retrieved from the internal researchers database with the ones found in ORCID giving precedence to the internal matches. When an author name is selected from the ORCID registry returned list a temporary authority key tracking the ORCID is assigned to the metadata. This information is used when the publication is approved to generate a local researcher profile retrieving further information about the researcher from the ORCID registry such as his biography, email address, name variants, etc more information on this process are available here

Synchronization

DSpace-CRIS is able to capture (Public or Member API) and send information (Member API only) from and to ORCID.

from ORCID to DSpace-CRIS

The dataflow from ORCID to DSpace-CRIS happen in two scenarios:

1. when an user that has been authenticated via ORCID create his researcher profile
2. when an author of a publication is looked up in the ORCID registry during the submission

The scenario #1 has been discussed in the Authentication > Creating a local researcher profile section

The scenario #2 has been discussed in the Submission lookup section.

Using the code available in the dspace-5_x_x -cris branch is also possible to import publication from an ORCID profile in DSpace-CRIS. An ORCIDDataloaderProvider for BTE is included that allow to input an ORCID in the first submission screen (Search by Identifiers) and importing one or all the publications. The dataloader will use the structural information available in the ORCID Work plus the citation field if supplied in a format understandable by another BTE provider (such as BibTex, EndNote, etc.)

The ORCID Online dataloader provider need to be enabled in the bte.xml file

from DSpace-CRIS to ORCID

If the researcher grants permission to DSpace-CRIS to update his ORCID profile, this is done during the authentication via ORCID or directly from the ORCID tab in the researcher profile, DSpace-CRIS is able to send these local information to ORCID  (below the shortname of the property as in the default configuration):

• affiliation

• authorid

• biography

• educationemail

• fullName

• country

• keywordsotheremails

• other-emails

• personalsite

• preferredName

• scopusid

• variants

the researcher can set his own preferences about the synchronization both about which information needs to be send than how/when this happen (automatically or manually). All the preferences are stored as property in the researcher profile.

...

• define which publications to send: all, only publications selected, only publications not hidden (see ), none
• define which projects to send: all, only projects selected, only projects not hidden (see ), none
• define which biographic information will be send
  
  

...

<bean id="ORCIDListener" class="org.dspace.app.cris.model.listener.OrcidQueueListener">
	<property name="orcidPreferencesUtils" ref="orcidPreferencesUtils" />	
</bean>

The synchronization can happen automatically via a batch script that need to be configured as a CRON Job without parameters

./dspace dsrun <bean id="ORCIDListener" class="org.dspace.app.cris.model.listener.OrcidQueueListener">
	<property name="orcidPreferencesUtils" ref="orcidPreferencesUtils" />	
</bean>.cris.batch.ScriptPushOrcid

or triggered manually by the researcher. A custom box ORCID Registry Queue ("orcidsyncqueue") is included in the default configuration to show the queue of object to synchronize and allow manual processing.

The script can be also used from the command line to force a first push of information to ORCID indipendently by the content of the ORCID queue tableThe synchronization can happen automatically via a batch script that need to be configured as a CRON Job without parameters

./dspace dsrun org.dspace.app.cris.batch.ScriptPushOrcid

or triggered manually by the researcher. A custom box ORCID Registry Queue ("orcidsyncqueue") is included in the default configuration to show the queue of object to synchronize and allow manual processing.

The script can be also used from the command line to force a first push of information to ORCID indipendently by the content of the ORCID queue table

./dspace dsrun org.dspace.app.cris.batch.ScriptPushOrcid [-a | -s <crisID>] [-p]

-a process all the researcher

-s process a single researcher, whom with the specified crisID

.cris.batch.ScriptPushOrcid [-a | -s <crisID>] [-p]

-a process all the researcher

-s process a single researcher, whom with the specified crisID

-p force the script to use POST call to ORCID instead of PUT (put is more efficient but replace all the existent publications, projects, organisations in the ORCID profile created from DSpace-CRIS with the new value. POST will just append the new values). Please note that information input manually by the researcher in his ORCID profile or created in his profile by other system (like crossref, scopus, etc.) cannot be never overridden by DSpace-CRIS

Note that DSpace-CRIS will perform an operation on the Orcid Queue when

1.      add/remove/change metadata at first level
2.      add/remove/save metadata at nested level (like affiliation and education)

Point 1. and 2. will perform a request of push for the Researcher Profile on Orcid Queue. In particular the second point means that modification on value at metadata "nested" object (like modification on "Role" of the "affiliation" nested object) not perform any operation on Orcid Queue but the "Save" event will do it. So the operation of open a nested object without change it perform an ADD operation on the Orcid Queue. By the way on the metadata first level (like authorid, country, keywords, personalsite, scopusid, variants) any ADD/REMOVE/CHANGE events occuring the system will perform a push of the Researcher Profile that need to perform a synchronization.-p force the script to use POST call to ORCID instead of PUT (put is more efficient but replace all the existent publications, projects, organisations in the ORCID profile created from DSpace-CRIS with the new value. POST will just append the new values). Please note that information input manually by the researcher in his ORCID profile or created in his profile by other system (like crossref, scopus, etc.) cannot be never overridden by DSpace-CRIS

Mapping local properties to ORCID

The shortname of all the ORCID preference flags start with orcid-profile-pref- and end with the shortname of the property that need to be syncronized with ORCID. The label of the preference property must match the name of the target Element in the ORCID XML message in this way you can easily set a custom mapping for your extra or renamed properties. The shortname start with "system-" prefix is used to build request document to send to ORCID but due to the v2 limitation is not possible synchronized its values.

The default configuration is

...