Difference between revisions of "ORCID Reviewer Attribution Integration"

From SmartWiki
Jump to: navigation, search
(→‎UTA Settings)
(→‎Overview)
 
(46 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
==Overview==
 
==Overview==
−
ORCID integration in SmartSimple Cloud streamlines the grant application process for researchers by enabling the populating of their professional review summary to ORCID profiles. This automation saves time, reduces errors, and minimizes administrative burden, allowing researchers to focus more on their research activities.
+
<div style='font-weight: 400;'>ORCID integration in SmartSimple Cloud can streamline the grant application and reporting processes for researchers by enabling the automatic population of their personal and professional data''' '''from their ORCID profile. This automation saves time, reduces errors, and minimizes administrative burden, allowing researchers to focus more on their research activities.</div>
  
−
For research funding organizations, this integration offers improved data quality and accuracy. By leveraging ORCID’s verified data, these organizations can ensure precise information for funding decisions, reducing the need for extensive data verification.
+
<div style='font-weight: 400;'>For research funding organizations, this integration offers improved data quality and accuracy. By leveraging ORCID’s verified data, these organizations can ensure current and accurate researcher information for funding evaluations, and more easily track the progress and impact of the research they fund.</div>
  
−
In the peer review process, ORCID integration links reviewers’ expertise and histories with their ORCID iDs, ensuring appropriate matching to grant applications. This improves the relevance and quality of reviews. Additionally, ORCID allows peer reviewers to include their reviewing activities in their ORCID records, providing professional recognition and encouraging more researchers to participate in the peer review process.
+
<div style='font-weight: 400;'>In the peer review process, ORCID integration links reviewers’ expertise and histories with their ORCID iDs, ensuring appropriate matching to grant applications. This improves the relevance and quality of reviews. Additionally, research funding organizations can, with reviewer’s permission, update researcher’s ORCID records to publicly acknowledge review activities.</div>
  
−
The ORCID API is essential for the integration process, enabling real-time access to researchers’ ORCID records. This facilitates authentication, data synchronization, and continuous updates within grant management systems. By automating these tasks, the API enhances user experience for researchers and administrators, ensuring accurate and up-to-date information.
+
<div style='font-weight: 400;'>The ORCID API is essential for the integration process, enabling real-time access to researchers’ ORCID records. This facilitates authentication, data synchronization, and auto updates within grant management systems. By automating these tasks, the API enhances user experience for researchers and administrators, ensuring accurate and up-to-date information.</div>
  
−
In the following sections, we will describe how to configure this integration in the SmartSimple Cloud system.
+
<div style='font-weight: 400;'>In the following sections, we will describe how to configure this integration in the SmartSimple Cloud system. </div>
  
 
==Configuration – Essentials==
 
==Configuration – Essentials==
Line 15: Line 15:
 
==Configuration - Advanced==
 
==Configuration - Advanced==
 
===UTA Settings===
 
===UTA Settings===
−
# Navigate to the UTA where you want to configure your fields mapping used for reviewer attribution.
+
====Fields Setup====
−
# Add all necessary fields to the L1 object e.g. application as per example screenshot below.
+
Navigate to the UTA where you want to configure your fields mapping used for reviewer attribution and add all necessary fields for mapping. Usually this is a L2 object e.g. review form as per example screenshot below.
 +
 
 +
 
 +
[[File:UTA L2 ORCID fields.png|thumb|center|800px|Application fields used for ORCID attribution integration.]]
 +
 
 +
In the example above, we have only set a few mandatory fields. In your setup, you can decide which information you want to pass to the ORCID. In the section below, you will see which fields should always be mandatory from the integration setup perspective.  
 +
 
 +
====Connection Setup====
 +
# Go to the UTA settings page where you have created all attribution fields. 
 +
# Go to '''Settings''' &gt; '''Connectivity''' &gt; '''ORCID Peer Review Field Mapping'''.
 +
 
 +
[[File:ORCID_Peer_Review_Field_Mapping_2.png|thumb|center|600px|ORCID Peer Review Field Mapping]]
 +
 
 +
This mapping page is part of an integration designed to allow research clients to give public recognition to researchers who have contributed to peer review activities. Research organizations can utilize this integration to post details of a researcher's participation in peer reviews to their ORCID profile. If the owner of a Level 2 peer review has their ORCID profile authorized in the system, the peer review activity will be added to their ORCID profile under the peer review section. The peer review section does not appear on an ORCID profile until an organization has added at least one peer review activity. 
 +
 
 +
To learn more about ORCID, visit [https://orcid.org/ orcid.org]. To learn more about peer reviews in ORCID, visit [https://support.orcid.org/hc/en-us/articles/360006971333-Peer-Reviews support.orcid.org].
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
||'''Funding type'''
+
| colspan="2" scope="row"|Reviewer Role
−
||Matches ORCID values
+
|-
 +
||Reviewer
 +
||Use this field to indicate the role the individual assumed during the peer review process. We recommend mapping to a Level 2 custom field with the following permitted values: "chair", "editor", "member", "organizer", "reviewer".
 
|-
 
|-
 
||'''Title of funded project'''
 
||'''Title of funded project'''
Line 27: Line 44:
 
|-
 
|-
 
||'''Language of this title'''
 
||'''Language of this title'''
−
||Matches ORCID values
+
||Matches ORCID values.<br />Field values should be limited to ORCID specified language codes.
 
|-
 
|-
 
||'''Currency code'''
 
||'''Currency code'''
−
||Matches ORCID values
+
||Matches ORCID values.<br />Field values should be limited to ORCID specified currency codes.
 
|-
 
|-
 
||'''Total Funding Amount'''
 
||'''Total Funding Amount'''
Line 36: Line 53:
 
|-
 
|-
 
||'''Funding Agency Identifier'''
 
||'''Funding Agency Identifier'''
−
||Example: ORCID verifies this link with the CrossRef list.<br />
+
||ORCID verifies this link with the CrossRef list.<br data-attributes="%20/">
 
[https://info.orcid.org/documentation/integration-guide/working-with-organization-identifiers/ Working with Organization Identifiers]
 
[https://info.orcid.org/documentation/integration-guide/working-with-organization-identifiers/ Working with Organization Identifiers]
 
|-
 
|-
Line 46: Line 63:
 
|-
 
|-
 
||'''Funding Agency Country'''
 
||'''Funding Agency Country'''
−
||Matches ORCID values. ORCID checks the country code against the agency specified in Funding Agency Identifier.
+
||Matches ORCID values.
 
|-
 
|-
 
||'''Record Identifier Type'''
 
||'''Record Identifier Type'''
−
||Matches ORCID values. For awards, choose “grant_number”.<br />
+
||<br />Matches ORCID values. For awards, choose “grant_number”.<br data-attributes="%20/">
 
[https://pub.orcid.org/v3.0/identifiers ORCID identifier types]
 
[https://pub.orcid.org/v3.0/identifiers ORCID identifier types]
 
|-
 
|-
 
||'''Record Relationship'''
 
||'''Record Relationship'''
−
||Matches ORCID values.<br />
+
||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]
 
[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
 
|}
 
|}
 +
Once the mapping is set press the '''Save''' button to update the integration settings.
  
 
===Workflow Setup===
 
===Workflow Setup===
 +
Information is published to ORCID using a workflow object (with the '''Type''' set to "Tracking Activities") and a '''Task Type''' called: '''Push Peer Review Data to User ORCID Profile'''.
 +
 +
Peer reviews may be removed from a user's profile using the workflow '''Task Type''' called: '''Delete Peer Review Data from Users ORCID Profile'''.
 +
 +
 +
'''Note:''' Each review activity combines three elements: information about the reviewer, information about the organization sponsoring (or convening) the review, and information about the review. 
 +
 +
====Publishing Review to the ORCID====
 +
# Navigate to '''Workflows''' in the system.
 +
# Create a new workflow by clicking on the '''+''' button.
 +
# Set '''System Call Identifier''' name so you can refer to the workflow later. This name must be unique across all workflows.
 +
# Add a new task type '''Push Peer Review Data to Users ORCID Profile'''.<br /><br />[[File:Push_Grant_L2_Peer_Review_to_ORCID.jpg|thumb|center|800px|Push Grant L2 Peer Review to ORCID task type.]]
 +
# '''Save''' the task.
 +
# Go back to the '''Tasks''' list and connect all tasks from start to complete.
 +
 +
====Removing Published Review from ORCID====
 +
# Navigate to '''Workflows''' in the system.
 +
# Create a new workflow by clicking on the '''+''' button.
 +
# Set '''System Call Identifier''' name so you can refer to the workflow later. This name must be unique across all workflows.
 +
# Add a new task type '''Delete Peer Review Data from User ORCID Profile'''.<br /><br />[[File:Delete_Peer_Review_Data_from_User_ORCID_Profile.jpg|thumb|center|800px|Delete Peer Review Data from User ORCID Profile task type.]]
 +
# '''Save''' the task.
 +
# Go back to the '''Tasks''' list and connect all tasks from start to complete.
 +
 
===System Call Setup===
 
===System Call Setup===
 +
Now that you have workflows setup you can create a system call button which will be available to the end user to trigger relevant ORCID action from each review activity.
 +
 +
 +
In order to add a system call you need to add a custom field to a review activity in your system.
 +
 +
# Navigate to the UTA where you want to add the system call too.
 +
# Go to the L2 tab and click on the '''Custom Fields''' link.
 +
# Add a new custom field type Special - Browser Script and permission it so it is visible where required in your business process.
 +
# See the '''Trigger Type''' to On Demand.
 +
# Add '''Custom Script''' to call your preconfigured workflow.
 +
 +
<pre><! --SysCall_workflow(@objtype@,@objid@,"system call name")-->
 +
alert("custom completion message.")</pre>
 +
* '''system call name''' - S'''ystem Call Identifier '''of the workflow you want to run.
 +
* '''custom completion message'''. - this text will displayed after the workflow has run.
  
 
==See Also==
 
==See Also==
 
[[Enable ORCID within your system]]
 
[[Enable ORCID within your system]]
 +
 +
[[System Call]]
  
 
[[Category:Integration]]
 
[[Category:Integration]]
 
[[Category:ORCID]]
 
[[Category:ORCID]]

Latest revision as of 10:29, 14 August 2024

Overview

ORCID integration in SmartSimple Cloud can streamline the grant application and reporting processes for researchers by enabling the automatic population of their personal and professional data from their ORCID profile. This automation saves time, reduces errors, and minimizes administrative burden, allowing researchers to focus more on their research activities.
For research funding organizations, this integration offers improved data quality and accuracy. By leveraging ORCID’s verified data, these organizations can ensure current and accurate researcher information for funding evaluations, and more easily track the progress and impact of the research they fund.
In the peer review process, ORCID integration links reviewers’ expertise and histories with their ORCID iDs, ensuring appropriate matching to grant applications. This improves the relevance and quality of reviews. Additionally, research funding organizations can, with reviewer’s permission, update researcher’s ORCID records to publicly acknowledge review activities.
The ORCID API is essential for the integration process, enabling real-time access to researchers’ ORCID records. This facilitates authentication, data synchronization, and auto updates within grant management systems. By automating these tasks, the API enhances user experience for researchers and administrators, ensuring accurate and up-to-date information.
In the following sections, we will describe how to configure this integration in the SmartSimple Cloud system. 

Configuration – Essentials

Start here to Enabling ORCID Within Your System.

Configuration - Advanced

UTA Settings

Fields Setup

Navigate to the UTA where you want to configure your fields mapping used for reviewer attribution and add all necessary fields for mapping. Usually this is a L2 object e.g. review form as per example screenshot below.


Application fields used for ORCID attribution integration.

In the example above, we have only set a few mandatory fields. In your setup, you can decide which information you want to pass to the ORCID. In the section below, you will see which fields should always be mandatory from the integration setup perspective.  

Connection Setup

  1. Go to the UTA settings page where you have created all attribution fields. 
  2. Go to Settings > Connectivity > ORCID Peer Review Field Mapping.
ORCID Peer Review Field Mapping

This mapping page is part of an integration designed to allow research clients to give public recognition to researchers who have contributed to peer review activities. Research organizations can utilize this integration to post details of a researcher's participation in peer reviews to their ORCID profile. If the owner of a Level 2 peer review has their ORCID profile authorized in the system, the peer review activity will be added to their ORCID profile under the peer review section. The peer review section does not appear on an ORCID profile until an organization has added at least one peer review activity. 

To learn more about ORCID, visit orcid.org. To learn more about peer reviews in ORCID, visit support.orcid.org.

Reviewer Role
Reviewer Use this field to indicate the role the individual assumed during the peer review process. We recommend mapping to a Level 2 custom field with the following permitted values: "chair", "editor", "member", "organizer", "reviewer".
Title of funded project
Language of this title Matches ORCID values.
Field values should be limited to ORCID specified language codes.
Currency code Matches ORCID values.
Field values should be limited to ORCID specified currency codes.
Total Funding Amount
Funding Agency Identifier ORCID verifies this link with the CrossRef list.

Working with Organization Identifiers

Funding Agency Name ORCID uses the identifier link to identify the funding organization.
Funding Agency City
Funding Agency Country Matches ORCID values.
Record Identifier Type
Matches ORCID values. For awards, choose “grant_number”.

ORCID identifier types

Record Relationship Matches ORCID values.
Field values should be limited to: self, part-of

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

Once the mapping is set press the Save button to update the integration settings.

Workflow Setup

Information is published to ORCID using a workflow object (with the Type set to "Tracking Activities") and a Task Type called: Push Peer Review Data to User ORCID Profile.

Peer reviews may be removed from a user's profile using the workflow Task Type called: Delete Peer Review Data from Users ORCID Profile.


Note: Each review activity combines three elements: information about the reviewer, information about the organization sponsoring (or convening) the review, and information about the review. 

Publishing Review to the ORCID

  1. Navigate to Workflows in the system.
  2. Create a new workflow by clicking on the + button.
  3. Set System Call Identifier name so you can refer to the workflow later. This name must be unique across all workflows.
  4. Add a new task type Push Peer Review Data to Users ORCID Profile.

    Push Grant L2 Peer Review to ORCID task type.
  5. Save the task.
  6. Go back to the Tasks list and connect all tasks from start to complete.

Removing Published Review from ORCID

  1. Navigate to Workflows in the system.
  2. Create a new workflow by clicking on the + button.
  3. Set System Call Identifier name so you can refer to the workflow later. This name must be unique across all workflows.
  4. Add a new task type Delete Peer Review Data from User ORCID Profile.

    Delete Peer Review Data from User ORCID Profile task type.
  5. Save the task.
  6. Go back to the Tasks list and connect all tasks from start to complete.

System Call Setup

Now that you have workflows setup you can create a system call button which will be available to the end user to trigger relevant ORCID action from each review activity.


In order to add a system call you need to add a custom field to a review activity in your system.

  1. Navigate to the UTA where you want to add the system call too.
  2. Go to the L2 tab and click on the Custom Fields link.
  3. Add a new custom field type Special - Browser Script and permission it so it is visible where required in your business process.
  4. See the Trigger Type to On Demand.
  5. Add Custom Script to call your preconfigured workflow.
<! --SysCall_workflow(@objtype@,@objid@,"system call name")-->
alert("custom completion message.")
  • system call name - System Call Identifier of the workflow you want to run.
  • custom completion message. - this text will displayed after the workflow has run.

See Also

Enable ORCID within your system

System Call

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=ORCID_Reviewer_Attribution_Integration&oldid=43047’