Setting up Orcid integration

This section is for administrators - if you are looking for help on connecting to Orcid as an end-user of RSpace, please see ORCID Integration

Aim of this document

This section explains how, as an RSpace admin, you can set up RSpace to enable users to connect their Orcid accounts to their RSpace account

You don't need to do this if your RSpace is hosted by ResearchSpace and has a web address ending in .researchspace.com, as RSpace is supplied with default clientId and clientSecret for this domain.

Even if you have an on-premises RSpace, the App registration on Orcid is entirely optional - we can send you a clientId and clientSecret to use for the 'Steps in RSpace' section. This App registration is only necessary if you prefer to create your own Orcid RSpace app for your users for an on-premises installation.

This procedure is a one-off step - it does not need to be done for every RSpace user!

Pre-requisites
  • An account on Orcid
  • Access to RSpace server in order to set in clientId and secret you will acquire from Orcid
  • The RSpace server must allow 2-way HTTPS communication with Orcid
You might consider using a service email account for Orcid rather than a personal email account, so that other staff can maintain the App if you leave your organisation, or are away on leave, for example.

Steps in Orcid

  1. Log into Orcid. Now click on 'Developer Tools' in the dropdown at the top-right of the screen:
  2. If this is the first time you have gone to the developer section, you will see an invitation to register for the public Orcid API. Click on the 'Register' button and agree to any Terms and Conditions
  3. Now, you can define the RSpace-Orcid connector, for example:
    For the redirect URI, add a URL in the form <RSPACE_URL>/orcid/redirect_uri. For example if your RSpace is hosted at https://rspace.myuniversity.ac.uk then the callback URI will behttps://rspace.myuniversity.ac.uk/orcid/redirect_uri.
  4. Save the App configuration.
  5. You will now see a screen showing your clientId and clientSecret - make a note of these:

You have now successfully registered the Orcid - RSpace connector App.

Steps in RSpace

  1. Connect to RSpace server terminal
  2. Open file /etc/rspace/deployment.properties and add the following properties, using the values you just obtained from Orcid:
    orcid.client.id=<MY ORCID CLIENT ID>
    orcid.client.secret=<MY ORCID SECRET>
  3. Save the file and restart RSpace
  4. You may need to login as sysadmin user and activate the Orcid integration in Settings-> Configuration->System Settings

Testing the setup

Follow the steps explained for an RSpace end-user: ORCID Integration


How did we do?


Powered by HelpDocs

Powered by HelpDocs