Changes

Jump to: navigation, search

ORCID Integration

18 bytes added, 13:37, 1 April 2021
no edit summary
==Using the ORCID Integration==
===Import ORCID records to User Profile===
# 1. 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 their ORCID profile]]
# 2. 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 their ORCID tab]]
# 3. When the user clicks 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]]
# 4. Once the user's 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]]
# 5. 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.
[[File:114889-2021-11-ORCIDUserProfileImport.png|thumb|none|800px|User prompted to continue to import ORCID records]]
# 6. 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.
[[File:114889-2021-12-ORCIDUserProfileImportSuccess.png|thumb|none|800px|User's ORCID Profile successfully imported]]
# 7. The user profile displays an overview of their ORCID profile. A count of different Funding Types and Works is provided at the top of the page. Details of the Funding and Works are listed.
[[File:114889-2021-13-ORCIDUserProfileChart.png|thumb|none|800px|Chart on user's profile]]
# 8. If specific Funding records do not contain a year or amount, they are excluded from the chart and a message to the user is displayed.
[[File:114889-2021-14-ORCIDUserProfileChartMessage.png|thumb|none|800px|Message if funding data is incomplete]]
# 9. An ORCID iD icon is displayed to the top of the page next to the profile name on the '''ORCID tab''' of the profile. This has a hyperlink to the public ORCID profile of the user’s account. The user’s iD and last imported date is displayed.
[[File:114889-2021-15-ORCIDUserProfileChartLink.png|thumb|none|800px|Link to user's public ORCID profile]]
# 10. A button captioned '''Re-Import ORCID Data''' is available for the user to trigger a re-Import of their ORCID profile. Any data that has been updated or added to ORCID will be imported and the profile page automatically refreshed. The Last Imported date will be updated.# 11. A button captioned '''Unlink Account''' is available for the user to unlink their account. A message appears for the user to confirm. When confirmed, the ORCID profile information is immediately removed from the '''ORCID tab''' of their profile.
[[File:114889-2021-16-ORCIDUserProfileUnlink.png|thumb|none|800px|Prompt to unlink the user's ORCID iD]]
===Viewing Other Users’ ORCID profiles===
# 1. For roles able to view the user’s profile, such as internal staff, if the user has not previously imported their ORCID profile, a message appears indicating that they have not connected to ORCID. Note that the user themselves has to login to the system in order to authenticate their iD to import their profile.
[[File:114889-2021-17-ORCIDUserProfileView.png|thumb|none|800px|Staff view of user's profile before authorization with ORCID]]
# 2. For roles able to view the user’s profile, such as internal staff, once the user has connected to ORCID and imported their profile, the ORCID profile can be viewed.
[[File:114889-2021-18-ORCIDUserProfileViewImported.png|thumb|none|800px|Staff view of user's profile with ORCID data imported]]
===Adding/Updating ORCID Records===
# 1. Complete all of the fields in the L1 funding record with the data to be transferred to ORCID. ORCID verifies this link with the CrossRef list. Not all of the fields in the example are required for the ORCID Funding record.
[[File:114889-2021-19-ORCIDL1Fields.png|thumb|none|800px|L1 Fields containing data for Funding Record]]
# 2. For each of the L1 - Contacts, identify their role in the funding. When adding a contributor to a funding record, ORCID supports the following roles: lead, co-lead, supported-by and other-contribution. As an example, in your L1, you have three L1 contacts, each with a different UTA role: Lead Investigator, Co-Lead and Co-Applicant, where Co-Applicants are support staff. In the L1 association common field, for Lead Investigator, select "lead", for Co-lead, select "co-lead" and Co-Applicant, select "supported-by".
[[File:114889-2021-20-ORCIDL1Contacts.png|thumb|none|800px|Select role of each contact in funding]]
# 3. Trigger the workflow to send the information to ORCID. The new funding record will populate the user’s ORCID profile.
[[File:114889-2021-21-ORCIDAddedFunding.png|thumb|none|800px|ORCID profile of the user with new Funding record]]
110
edits

Navigation menu