110
edits
Changes
no edit summary
==ORCID Profile Import IntegrationOverview==SmartSimple currently 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 import to user their SmartSimple Platform3 profile model. To use The ORCID integration, you can also be configured to add and update Funding records on the users’ ORCID profile. This functionality will need be of particular interest and advantage to set up the following:researchers and research-based foundations using SmartSimple Platform3.
==Use cases==
* Once logged into the system, users sign into their ORCID accounts using their registered email address and password or they can create a new account and then authorize your system to obtain their ORCID iD. Storing authenticated ORCID iDs in your system ensures you get the correct ORCID iD for the user and that the information on that record reflects their research activities.
* Once the user has granted permission, information that the user has set as visible to trusted parties in addition to the information set as visible to everyone is imported to their profile. The display of the ORCID records on the user’s profile is permissioned by role to allow staff or reviewers an overview of the user’s research activities.
* The user’s process is streamlined by retrieving data from their ORCID records on their profile to populate application or progress report forms. In SmartSimple Platform3, data from ORCID is stored in JSON format to allow specific formatting and allow your team to use the data in different ways within the system.
* By enabling the functionality for staff to add and update data in ORCID funding records, it can help make life easier for your users by connecting validated information to their ORCID records. Since this action is triggered by a workflow, it can be configured for specific roles to trigger at a particular status. Mapping of the data fields sent to ORCID is determined by your system administrator.
* The display of the user’s ORCID data on their profile is complementary to any configuration capturing researcher profile data and outputs currently configured in your system. In SmartSimple Platform3, the data from ORCID is stored in JSON format to allow your system administrator to create specific views of information from different sources for your team or processes specific to your organization.
[[File:ORCIDAPIapplication.png|800px]]
==ORCID =Integration SettingKey Management===After a successful ORCID Member API application, set up your '''Client ID ''' and '''Client Secret ''' in your system in Integration Key Management.
# Go to '''Global Settings ''' - '''Integrations ''' - '''Integration Key Management'''.
# 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.# Pick a Choose user custom field fields to store the ORCID Profile ID.iD and JSON data# Select one or more "Import ORCID Data" record types, these . These determine the set of information that will be pulled from ORCID. Note: ORCID offers a [https://info.orcid.org/documentation/integration-guide/sandbox-testing-server/ sandbox testing server] to try the ORCID API. You can create user accounts and test out API calls on the sandbox without needing to worry about affecting production data or accidentally spamming researchers.
===Enable ORCID ImportTab on User Profile===Under Global Setting - User Roles, select SmartSimple Platform3 supports importing a user’s ORCID profile import to their profile. The ORCID iD is stored to a role user profile field and check the option "Enable data imported from ORCID Import"is stored in JSON format.
===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.