110
edits
Changes
no edit summary
ORCID is an independent non-profit organization that provides a persistent identifier – an ORCID iD – that distinguishes individual researchers and a mechanism for linking research outputs and activities to the user’s specific ORCID iD. ORCID is integrated into many systems used by publishers, funders, institutions, and other research-related services. Learn more at [https://orcid.org/ ORCID.org]
SmartSimple's Platform3 supports functionality that can authenticate ORCID iDs and update ORCID records using the ORCID API. By collecting a user’s authenticated ORCID iD, this allows import of a user’s ORCID profile record to their Platform3 profile. The ORCID integration can also be configured to add and update funding records on the user's ORCID profilerecord. This functionality will be of particular interest and advantage to researchers and research-based foundations using Platform3.
ORCID offers a [https://info.orcid.org/documentation/features/public-api/ Public API] that allows organizations to connect their systems to the ORCID registry. The Public API can be used to collect authenticated ORCID iDs. ORCID Membership allows access to the [https://info.orcid.org/documentation/features/member-api/ Member API], which facilitates registration, and information exchange with ORCID records. ORCID membership is open to any organization interested in integrating ORCID identifiers. The Member API allows your systems and applications to connect to the ORCID registry, including reading from and writing to individual ORCID records with the user’s permission. Learn more at [https://info.orcid.org/about-membership/ ORCID Membership].
This article will show you how to setup importing a user’s ORCID profile record as well as add and update Funding records using the ORCID API. You will need '''Global Administrator''' access to setup the ORCID integration.
==Use cases==
==Configuration – Essentials==
===Obtain Keys to Use the ORCID API===
To use the ORCID Integration, a ORCID Basic Member API (Production Member API) is required. Each instance URL will need its own API. During signup, you will need to provide the Homepage URL and also a Redirect URL . Please refer to the [https://orcid.org/content/register-client-application-2 ORCID API application] for more information.
Below is a screenshot of the ORCID Basic Member API application on ORCID:
[[File:ORCIDAPIapplication.png|thumb|none|800px|ORCID Basic Member API application]]
# Click on New Integration Key.
# Key Type: set to ORCID
# Copy the Homepage and Redirect URLs for ORCID Basic Member API application.
# Fill in '''Client ID''' and '''Client Secret''' from your ORCID API application
# Choose user custom fields to store the ORCID iD and JSON data
===Enable ORCID Tab on User Profile===
SmartSimple Platform3 supports importing a user’s ORCID profile import records to their profile. The ORCID iD is stored to a user profile field and the data imported from ORCID is stored in JSON format.
Under '''Global Settings''' > '''User Roles''' > '''User Standard Fields''' > '''ORCID''', update the configuration to permission specific roles and statuses. It is advisable to include instructions and messaging on the Profile Main tab. Sample templates for messaging within these sections are available.
This should be mapped to a custom field with ORCID values.
Example: For each person involved in the funding, these users are added to the L1-Contacts and each identified as lead, co-lead, supported-by, etc.
If multiple contacts are added to a funding record, for each of these contacts with an ORCID enabled role, and have authorized SmartSimple to access their ORCID profilerecord, a funding record will be pushed to each of their ORCID profilerecord. These users might represent different types of contributor roles in the funding.
|-
||'''Contributor Fund Code'''
[[File:114889-2021-5-ORCIDMapping.png|thumb|none|800px|ORCID Mapping]]
===Workflow to use Task Type: Push Fund records to users’ ORCID ProfileRecord===In a L1 workflow, create a new task type: '''Push Fund Data to Users ORCID ProfileRecord'''. If desired, this task can be incorporated into an existing workflow.
We currently support Adding a new funding record to the user’s ORCID profilerecord. 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 record to User Profile===1. When the user logs into their portal, if they have not previously imported their ORCID profilerecord, 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]]
[[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 profilerecord. 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]]
[[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 record 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 profilerecord. 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 record 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 profilesrecords===1. For roles able to view the user’s profile, such as internal staff, if the user has not previously imported their ORCID profilerecord, 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 record can be viewed.
[[File:114889-2021-18-ORCIDUserProfileViewImported.png|thumb|none|800px|Staff view of user's profile with ORCID data imported]]
[[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 profilerecord.
[[File:114889-2021-21-ORCIDAddedFunding.png|thumb|none|800px|ORCID profile of the user with new Funding record]]