Changes

Updating Funding Data in ORCID

1,054 bytes removed, 13:20, 29 July 2024

→‎Mapping the L1 Fields

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]

SmartSimpleCloud SmartSimple Cloud supports functionality that can authenticate ORCID iDs and update ORCID records using the ORCID API. SmartSimpleCloud is SmartSimple Cloud is using the 3.0 version of the API for the ORCID integration. By collecting a user’s authenticated ORCID iD, this allows import of a user’s ORCID record to their profile. The ORCID integration can also be configured to add and update funding records on the user's ORCID record. This functionality will be of particular interest and advantage to researchers and research-based foundations using SmartSimpleCloudSmartSimple Cloud.

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].

==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 Start here to [[https://orcid.org/content/register-client-application-2 ORCID API application] for more information. Below is a screenshot of the Enabling ORCID Member API application on ORCID: [[File:ORCIDAPIapplication.png|thumb|none|800pxWithin Your System|enable 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 within 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. [[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''' > '''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|800px|ORCID Tab on User Profile]] ===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==

The fields required in the ORCID Funding record are displayed in the left column and the SmartSimple Cloud L1 fields are displayed in the right column. Mandatory fields are indicated with a red asterisk. SmartSimple Cloud fields are selected using a drop-down.

[[File:114889ORCID_Peer_Review_Field_Mapping.png|thumb|center|600px|ORCID Peer Review Field Mapping]] {| class="wikitable"|-||'''Funding type'''||Matches ORCID values.<br />Field values should be limited to: award, contract, grant, salary-award.|-||'''Title of funded project'''|||-||'''Language of this title'''||Matches ORCID values.<br />Field values should be limited to ORCID specified language codes.|-||'''Currency code'''||Matches ORCID values.<br />Field values should be limited to ORCID specified currency codes.|-||'''Total Funding Amount'''|||-||'''Funding Agency Identifier'''||ORCID verifies this link with the CrossRef list.<br data-2021attributes="%20/">[https://info.orcid.org/documentation/integration-guide/working-with-organization-identifiers/ Working with Organization Identifiers]|-||'''Funding Agency Name'''||ORCID uses the identifier link to identify the funding organization.|-5||'''Funding Agency City'''|||-ORCIDMapping||'''Funding Agency Country'''||Matches ORCID values.png|-|thumb|none'''Record Identifier Type'''|800px|<br />Matches ORCID values. For awards, choose “grant_number”.<br data-attributes="%20/">[https://pub.orcid.org/v3.0/identifiers ORCID Mappingidentifier types]|-||'''Record Relationship'''||Matches ORCID values.<br />Field values should be limited to: self, part-of<br data-attributes="%20/">[https://pub.orcid.org/v3.0/identifiers ORCID identifier types]|-||'''Contributor role'''||Field values should be limited to: lead, co-lead, supported-by, other-contribution|-||'''Contributor Fund Code'''||Stores uploaded ORCID fund code. If funding data is uploaded to contributor's ORCID profile successfully, a fund code is returned as the unique identifier of this fund data on user's profile.|-||'''Exclude Contributor'''||Value should be 0 or 1. A value of 0 or empty means contact will be exported to ORCID as contributor of the fund record. A value of 1 means contact will not be exported to ORCID.|-||'''Error Message'''||Stores error message returned from ORCID|}

===Workflow to use Task Type: Push Fund records to users’ ORCID Record===

==See Also==

[[Enabling ORCID Research Database Integration - Why?Within Your System]]

• ← Older edit

Chris Kulczyk

Smartstaff

327

edits