Changes

Updating Funding Data in ORCID

3,003 bytes removed, 26 July
Configuration – Essentials
==Configuration – Essentials==
===Obtain Keys to Use the ORCID API===To use the ORCID Integration, a ORCID 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 Member API application on ORCID: [[File:ORCIDAPIapplication.png|thumb|none|800px|ORCID Basic Member API application]] ===ORCID URL Configuration==='''Example of "URL of the home page of your application"'''  https://<em>alias.smartsimple.com</em>This is the URL you use to access your instance of SmartSimple Cloud.  '''Example of "Redirect URI"'''  https://<em>alias.smartsimple.com</em>/links/orcid/callback.jspThis is a link to the callback server page for your instance of SmartSimple. Note that the URL will be different as it must match that used to access your own copy of SmartSimple Cloud. ===Integration Key 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''' (+ button).# Key Type: set to ORCID.# Copy the '''Home Page URL''' and '''Redirect URL''' for ORCID 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.# Select one or more '''Import ORCID Data''' record types. 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. Start here to [[File:114889 2021 1 IntegrationKeyManagement.png|thumb|none|800px|Integration Key Management]] ===Enable ORCID Tab on User Profile===SmartSimple Cloud supports importing a user’s ORCID 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''' > '''Users '''> '''Standard Fields''' > '''Enabling 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. [[File:114889-2021-2-ORCIDStandardField.png|thumb|none|800pxWithin Your System|enable ORCID Tab on User ProfileWithin Your System]] ===Configure Roles Using ORCID===Under '''Global Setting''' > '''Users > Roles''', select a role and toggle on 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==
Smartstaff
314
edits