ORCID Integration

From SmartWiki
Revision as of 12:29, 19 August 2020 by Wivina Lo (talk | contribs) (ORCID Integration Setting)

Jump to: navigation, search

ORCID Profile Import Integration

SmartSimple currently supports ORCID profile import to user profile model. To use ORCID integration, you will need to set up the following:

  1. Apply for ORCID Basic Member API
  2. Set up credentials for ORCID Integration Key Settings.
  3. Enable ORCID Import for selected roles.
  4. Login and Authorize ORCID Import from your personal profile.

ORCID Basic Member API

To use ORCID Integration, a ORCID Basic Member API (Production Member API) is required. ORCID API application: https://orcid.org/content/register-client-application-2

  • each instance URL will need its own API
  • during signup, you will need to provide Homepage url and also a Redirect url (see screenshot)

For the Homepage and Redirect URLs:

  1. Go to Global Settings - Integrations - Integration Key Management. 
  2. Click on New Integration Key:
    • Key Type: set to ORCID
    • Copy the Homepage and Redirect URLs for ORCID Basic Member API application.

Tips: Below is a screenshot of ORCID Basic Member API application on ORCID:


ORCID Integration Setting

After successful ORCID Member API application, set up your Client ID and Client Secret in Integration Key Management.

  1. Go to Global Settings - Integrations - Integration Key Management. 
  2. Click on New Integration Key.
  3. Fill in Client ID and Client Secret from your ORCID API application.
  4. Pick a user custom field to store the ORCID Profile ID.
  5. Select one or more "Import ORCID Data" record types, these determine the set of information that will be pulled from ORCID.

Enable ORCID Import

Under Global Setting - User Roles, select a role and check the option "Enable ORCID Import".

Users with the selected role above will have the option for ORCID import under Profile - Edit Mode - Options - Profile Data Import (Import from ORCID)


Authorize ORCID Profile Import

  1. Under User Profile - (Edit mode) - Options (tab) -  Profile Data Import (Import from ORCID)
  2. (i) Login with your ORCID credentials (see screenshot) and
    (ii) Authorize SmartSimple to access your ORCID record (after logged in, it will ask you to Authorize, you will only have to authorize once)
  3. After you authorized SmartSimple to access your ORCID profile, your ORCID id will be displayed on page, and have the option to Import ORCID data or Clear the stored access token and try login again (if you've previously authorized SmartSimple, you will only need to login, and will be authorized automatically).
  4. Enable the "Profile Model" standard field and permission for the users you'd like to be able to access the ORCID data & funding charts. You can re-caption the tab via this standard field.
  5. After you imported data from ORCID, you should see the data available under your profile - Profile Model tab on the left hand side. Data will be read-only. Currently we only support Import from ORCID, there is no pushing data to ORCID.

Tips: Screenshot for ORCID login below is an example from a sandbox/testing account.