Changes

Jump to: navigation, search

ORCID Integration

778 bytes added, 19:22, 31 March 2021
no edit summary
Below is a screenshot of the ORCID Basic Member API application on ORCID:
[[File:ORCIDAPIapplication.png|thumb|none|800px|ORCID Basic Member API application]]
===Integration Key Management===
===Configure Roles Using ORCID===
Under '''Global Setting''' - '''User Roles''', select a role and check the option '''Enable ORCID Import'''. Users with the selected role will have the option for ORCID import in their Profile.
 
[[File:114889-2021-3-ORCIDRoleSetting.png|thumb|none|800px|Enable ORCID Import on Role Setting]]
==Configuration – Advanced==
Below is a screenshot from ORCID when a user clicks the Add Funding page, where the user is required to complete several fields.
 
[[File:114889-2021-4-ORCIDFundingRecord.png|thumb|none|800px|Add Funding page on ORCID]]
ORCID crosschecks information imported from SmartSimple Platform3. Certain fields must be configured using ORCID values.
The fields required in the ORCID Funding record are displayed in the left column and the SmartSimple Platform3 L1 fields are displayed in the right column. Mandatory fields are indicated with a red asterisk. SmartSimple Platform3 fields are selected using a drop-down.
 
[[File:114889-2021-5-ORCIDMapping.png|thumb|none|800px|ORCID Mapping]]
===Workflow to use Task Type: Push Fund records to users’ ORCID Profile===
We currently support Adding a new funding record to the user’s ORCID profile. The update fund data will only run for '''L1 - Contacts''' which have a valid fund code in the '''Contributor Fund Code''' (L1 contact association field) field where this fund code is unique to the ORCID user’s profile.
 
[[File:114889-2021-6-ORCIDTaskType.png|thumb|none|800px|Task Type: Push Fund Data to Users ORCID Profile]]
==Using the ORCID Integration==
===Import ORCID records to User Profile===
# When the user logs into their portal, if they have not previously imported their ORCID profile, a message appears instructing them to navigate to the correct section.
 
[[File:114889-2021-7-ORCIDUserProfile.png|thumb|none|800px|Prompt for user to import ORCID profile]]
 
# When the user navigates to the '''ORCID tab''' on their profile, they have the option to connect their ORCID iD. Instructions appear to the user in this tab. These instructions should introduce users to ORCID, why you are requesting access to their ORCID record, and what you will do with their data.
 
[[File:114889-2021-8-ORCIDUserProfileTab.png|thumb|none|800px|Message to user on ORCID tab]]
 
# When they click on the '''Create or connect your ORCID iD''' button, a new window appears for the user to create or login to ORCID. This process uses OAuth to authenticate ORCID iDs.
 
[[File:114889-2021-9-ORCIDUserProfileConnect.png|thumb|none|800px|User connecting to ORCID]]
 
# Once their credentials are entered, the user is prompted to '''Authorize access''' for the system. Note that the organization name will be the one used to apply for the ORCID API and not SmartSimple Software.
 
[[File:114889-2021-10-ORCIDUserProfileAuthorize.png|thumb|none|800px|User Authorizing Access to ORCID]]
 
# Once the '''Authorize access''' is clicked, the ORCID iD is authorized and the user is prompted with a button to '''Continue to import your ORCID data'''. The ORCID iD is stored in the field designated in the configuration settings. Note the ORCID iD, access tokens and refresh tokens are all stored into the same record for the user in the system database. If '''Deny access''' is clicked, the process ends.
# When the user clicks '''Continue to import your ORCID data''', the data is automatically refreshed on their profile and a thank you message appears. The user can close the separate window at their leisure. The user’s data is stored in JSON format in the field designated in the settings.
110
edits

Navigation menu