Changes

Jump to: navigation, search

ORCID Integration

6 bytes removed, 14:11, 22 November 2021
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 SmartSimpleCloud 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 record to their Platform3 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 Platform3SmartSimpleCloud.
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].
* 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 Platform3SmartSimpleCloud, 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 Platform3SmartSimpleCloud, 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.
==Configuration – Essentials==
===Enable ORCID Tab on User Profile===
SmartSimple Platform3 SmartSimpleCloud 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''' > '''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.
==Configuration – Advanced==
===Add and Update ORCID Funding by Configuring Fields on L1===
Platform3 SmartSimpleCloud currently supports adding and updating funding data on the user's ORCID record using the ORCID Member API. In order to update researcher records, the user must have an authenticated ORCID iD and provided permission for the specific system to make updates.
Below is a screenshot from ORCID when a user clicks the 'Add Funding' page, where the user is required to complete several fields.
[[File:114889-2021-4-ORCIDFundingRecord.png|thumb|none|800px|Add Funding page on ORCID]]
ORCID crosschecks information imported from Platform3SmartSimpleCloud. Certain fields must be configured using ORCID values.
An overview of the fields from the funding record is below, with key values and required fields indicated. Please refer to the [https://support.orcid.org/hc/en-us/articles/360006897214-Add-funding-information-to-your-ORCID-record ORCID support pages] for the most up-to-date values used for the metadata.
||Required field, Select One - Combo Box
This should be mapped to a custom field with ORCID values.
Although this list looks very much the same as SmartSimple Platform3 the SmartSimpleCloud currency list but , we would advise that the values provided by ORCID are used.
If this is mapped to a text field, the entered value has to be one of the option values in the list.
|-
||The identifier associated with the work
||Required field, Text box
This field data will be used as the external identifier if identifier type is selected, if no data is specified for this field, the system will push data to ORCID using the Funding agency as the identifier. Although ORCID allows this, in the SmartSimple Platform3 SmartSimpleCloud settings, the ID should always be available for the funding record.
|-
||'''Record Identifier URL'''
Each of these fields are mapped in the specific UTA. Go to '''UTA Settings''' – '''Connectivity''' – '''Service Settings''' - '''ORCID Funding Field Mapping'''
The fields required in the ORCID Funding record are displayed in the left column and the SmartSimple Platform3 SmartSimpleCloud L1 fields are displayed in the right column. Mandatory fields are indicated with a red asterisk. SmartSimple Platform3 SmartSimpleCloud fields are selected using a drop-down.
[[File:114889-2021-5-ORCIDMapping.png|thumb|none|800px|ORCID Mapping]]
110
edits

Navigation menu