Changes

SmartSimple Platform3 supports functionality ORCID is an independent non-profit organization that can authenticate provides a persistent identifier – an ORCID iDs iD – that distinguishes individual researchers and a mechanism for linking research outputs and update ORCID records using activities to the ORCID API. By collecting a user’s authenticated specific ORCID iD, this allows import of a user’s ORCID profile to their SmartSimple Platform3 profile. The ORCID integration can also be configured to add and update Funding records on the users’ ORCID profile. This functionality will be of particular interest and advantage to researchers is integrated into many systems used by publishers, funders, institutions, and other research-based foundations using SmartSimple Platform3related services. Learn more at [https://orcid.org/ ORCID.org]

SmartSimple's Platform3 supports functionality that can authenticate ORCID is an independent non-profit organization that provides iDs and update ORCID records using the ORCID API. By collecting a persistent identifier – an user’s authenticated ORCID iD – that distinguishes individual researchers and , this allows import of a mechanism for linking research outputs user’s ORCID record to their Platform3 profile. The ORCID integration can also be configured to add and activities to update funding records on the user’s specific user's ORCID iDrecord. ORCID is integrated into many systems used by publishers, funders, institutions, This functionality will be of particular interest and advantage to researchers and other research-related services. Learn more at [https://orcid.org/ ORCIDbased foundations using Platform3.org]

This article will show you how to setup importing a user’s ORCID profile record as well as add and update Funding records using the ORCID API. You will need global administrator '''Global Administrator''' access to setup the ORCID integration.

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

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

To use the ORCID Integration, a ORCID Basic 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 URL and also a Redirect url 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 Basic Member API application on ORCID:

[[File:ORCIDAPIapplication.png|thumb|none|800px|ORCID Basic Member API application]]

# Go to '''Global Settings''' - > '''Integrations''' - > '''Integration Key Management'''. 

# Copy the Homepage and Redirect URLs for ORCID Basic Member API application.

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

SmartSimple Platform3 supports importing a user’s ORCID profile import 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 instructions and messaging on the Profile Main tab. Sample templates for messaging within these sections are available.

Under '''Global Setting''' - > '''User Roles''', select a role and check toggle on the option '''Enable ORCID Import'''. Users with the selected role will have the option for ORCID import in their Profileprofile. [[File:114889-2021-3-ORCIDRoleSetting.png|thumb|none|800px|Enable ORCID Import on Role Setting]]

SmartSimple Platform3 currently supports adding and updating Funding funding data on the users’ 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.

ORCID crosschecks information imported from SmartSimple Platform3[[File:114889-2021-4-ORCIDFundingRecord. Certain fields must be configured using png|thumb|none|800px|Add Funding page on ORCID values.]]

ORCID crosschecks information imported from Platform3. Certain fields must be configured using ORCID values. An overview of the fields from the Funding 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.

||'''Funding typeType'''

||'''Funding subtypeSubtype'''

||'''Title of funded projectFunded Project'''

||'''Language of this titleTitle'''

||'''Funding agency display nameAgency Display Name'''

||'''Funding agency display cityAgency Display City'''

||'''Funding agency display regionAgency Display Region'''

||'''Funding agency display countryAgency Display Country'''

||'''Contributor roleRole'''

If multiple contacts are added to a funding record, for each of these contacts with an ORCID enabled role, and have authorized SmartSimple to access their ORCID profilerecord, a funding record will be pushed to each of their ORCID profilerecord. These users might represent different types of contributor roles in the funding.

===Workflow to use Task Type[[File: Push Fund records to users’ 114889-2021-5-ORCIDMapping.png|thumb|none|800px|ORCID Profile===In a L1 workflow, create a new task type: '''Push Fund Data to Users ORCID Profile'''. If desired, this task can be incorporated into an existing workflow.Mapping]]

===Workflow to use Task Type: Push Fund records to users’ ORCID Record===In a L1 workflow, create a new task type: '''Push Fund Data to Users ORCID Record'''. If desired, this task can be incorporated into an existing workflow. We currently support Adding a new funding record to the user’s ORCID profilerecord. The update fund data will only run for '''L1 - Contacts''' which have a valid fund code in the '''Contributor Fund Code''' (L1 contact association field) field where this fund code is unique to the ORCID user’s profile. [[File:114889-2021-6-ORCIDTaskType.png|thumb|none|800px|Task Type: Push Fund Data to Users ORCID Profile]]

===Import ORCID records record to User Profile===# 1. When the user logs into their portal, if they have not previously imported their ORCID profilerecord, a message appears instructing them to navigate to the correct section.# [[File:114889-2021-7-ORCIDUserProfile.png|thumb|none|800px|Prompt for user to import their ORCID profile]] 2. When the user navigates to the '''ORCID tab''' on their profile, they have the option to connect their ORCID iD. Instructions appear to the user in this tab. These instructions should introduce users to ORCID, why you are requesting access to their ORCID record, and what you will do with their data.# When they click on the '''Create or connect your ORCID iD''' button, a new window appears for the user to create or login to ORCID. This process uses OAuth to authenticate ORCID iDs.# Once their credentials are entered, the user is prompted to '''Authorize access''' for the system. Note that the organization name will be the one used to apply for the ORCID API and not SmartSimple Software.# Once the '''Authorize access''' is clicked, the ORCID iD is authorized and the user is prompted with a button to '''Continue to import your ORCID data'''. The ORCID iD is stored in the field designated in the configuration settings. Note the ORCID iD, access tokens and refresh tokens are all stored into the same record for the user in the system database. If '''Deny access''' is clicked, the process ends.# When the user clicks '''Continue to import your ORCID data''', the data is automatically refreshed on their profile and a thank you message appears. The user can close the separate window at their leisure. The user’s data is stored in JSON format in the field designated in the settings.# The user profile displays an overview of their ORCID profile. A count of different Funding Types and Works is provided at the top of the page. Details of the Funding and Works are listed.# If specific Funding records do not contain a year or amount, they are excluded from the chart and a message to the user is displayed.# An ORCID iD icon is displayed to the top of the page next to the profile name on the '''ORCID tab''' of the profile. This has a hyperlink to the public ORCID profile of the user’s account. The user’s iD and last imported date is displayed.# A button captioned '''Re-Import ORCID Data''' is available for the user to trigger a re-Import of their ORCID profile. Any data that has been updated or added to ORCID will be imported and the profile page automatically refreshed. The Last Imported date will be updated.# A button captioned '''Unlink Account''' is available for the user to unlink their account. A message appears for the user to confirm. When confirmed, the ORCID profile information is immediately removed from the '''ORCID tab''' of their profile.

[[File:114889-2021-8-ORCIDUserProfileTab.png|thumb|none|800px|Message to user on their ORCID tab]] 3. When the user clicks on the '''Create or connect your ORCID iD''' button, a new window appears for the user to create or login to ORCID. This process uses OAuth to authenticate ORCID iDs. [[File:114889-2021-9-ORCIDUserProfileConnect.png|thumb|none|800px|User connecting to ORCID]] 4. Once the user's credentials are entered, the user is prompted to '''Authorize access''' for the system. Note that the organization name will be the one used to apply for the ORCID API and not SmartSimple Software. [[File:114889-2021-10-ORCIDUserProfileAuthorize.png|thumb|none|800px|User Authorizing Access to ORCID]] 5. Once the '''Authorize access''' is clicked, the ORCID iD is authorized and the user is prompted with a button to '''Continue to import your ORCID data'''. The ORCID iD is stored in the field designated in the configuration settings. Note the ORCID iD, access tokens and refresh tokens are all stored into the same record for the user in the system database. If '''Deny access''' is clicked, the process ends. [[File:114889-2021-11-ORCIDUserProfileImport.png|thumb|none|800px|User prompted to continue to import ORCID records]] 6. When the user clicks '''Continue to import your ORCID data''', the data is automatically refreshed on their profile and a thank you message appears. The user can close the separate window at their leisure. The user’s data is stored in JSON format in the field designated in the settings. [[File:114889-2021-12-ORCIDUserProfileImportSuccess.png|thumb|none|800px|User's ORCID Profile successfully imported]] 7. The user profile displays an overview of their ORCID record. A count of different Funding Types and Works is provided at the top of the page. Details of the Funding and Works are listed. [[File:114889-2021-13-ORCIDUserProfileChart.png|thumb|none|800px|Chart on user's profile]] 8. If specific Funding records do not contain a year or amount, they are excluded from the chart and a message to the user is displayed. [[File:114889-2021-14-ORCIDUserProfileChartMessage.png|thumb|none|800px|Message if funding data is incomplete]] 9. An ORCID iD icon is displayed to the top of the page next to the profile name on the '''ORCID tab''' of the profile. This has a hyperlink to the public ORCID record of the user’s account. The user’s iD and last imported date is displayed. [[File:114889-2021-15-ORCIDUserProfileChartLink.png|thumb|none|800px|Link to user's public ORCID profile]] 10. A button captioned '''Re-Import ORCID Data''' is available for the user to trigger a re-Import of their ORCID record. Any data that has been updated or added to ORCID will be imported and the profile page automatically refreshed. The Last Imported date will be updated.11. A button captioned '''Unlink Account''' is available for the user to unlink their account. A message appears for the user to confirm. When confirmed, the ORCID record information is immediately removed from the '''ORCID tab''' of their profile. [[File:114889-2021-16-ORCIDUserProfileUnlink.png|thumb|none|800px|Prompt to unlink the user's ORCID iD]] ===Viewing Other Users’ ORCID profilesrecords===# 1. For roles able to view the user’s profile, such as internal staff, if the user has not previously imported their ORCID profilerecord, a message appears indicating that they have not connected to ORCID. Note that the user themselves has to login to the system in order to authenticate their iD to import their profile.# [[File:114889-2021-17-ORCIDUserProfileView.png|thumb|none|800px|Staff view of user's profile before authorization with ORCID]] 2. For roles able to view the user’s profile, such as internal staff, once the user has connected to ORCID and imported their profile, the ORCID profile record can be viewed. [[File:114889-2021-18-ORCIDUserProfileViewImported.png|thumb|none|800px|Staff view of user's profile with ORCID data imported]]

# 1. Complete all of the fields in the L1 funding record with the data to be transferred to ORCID. ORCID verifies this link with the CrossRef list. Not all of the fields in the example are required for the ORCID Funding record.# [[File:114889-2021-19-ORCIDL1Fields.png|thumb|none|800px|L1 Fields containing data for Funding Record]] 2. For each of the L1 - Contacts, identify their role in the funding. When adding a contributor to a funding record, ORCID supports the following roles: lead, co-lead, supported-by and other-contribution. As an example, in your L1, you have three L1 contacts, each with a different UTA role: Lead Investigator, Co-Lead and Co-Applicant, where Co-Applicants are support staff. In the L1 association common field, for Lead Investigator, select "lead", for Co-lead, select "co-lead" and Co-Applicant, select "supported-by".# [[File:114889-2021-20-ORCIDL1Contacts.png|thumb|none|800px|Select role of each contact in funding]] 3. Trigger the workflow to send the information to ORCID. The new funding record will populate the user’s ORCID record. [[File:114889-2021-21-ORCIDAddedFunding.png|thumb|none|800px|ORCID profile.of the user with new Funding record]]

[[File:orcidLogin114889-2021-22-ORCIDAddedFundingDetails.png|500pxthumb|none|800px|Detailed view of the ORCID profile of the user with new Funding record]]