* 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 Cloud, 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==
===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.
[[File:114889-2021-3-ORCIDRoleSetting.png|thumb|none|800px|Enable ORCID Import on Role Setting]]
==Configuration – Advanced==
===Add and Update ORCID Funding by Configuring Fields on L1===
SmartSimple Cloud 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 SmartSimple Cloud. 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.
{| class="wikitable"
|-
!|Data
!|Description
!|Recommended Configuration
|-
||'''Funding Type'''
||The type of funding awarded. This field is selected from a list containing the following values: Award, Contract, Grant, Salary-award
||Required field, Select One - Combo Box
This should be mapped to a custom field with ORCID values. Example: award=Award;grant=Grant;contract=Contract;salary-award=Salary Award
If this is mapped to a text field, the entered value has to be one of the option values in the list.
|-
||'''Funding Subtype'''
||This is stored as organization-defined-type in the ORCID funding record
||Text Box
|-
||'''Title of Funded Project'''
||The title of the funding item
||Required field, Text Box
|-
||'''Translated Title'''
||The title the funding appears under in another language
||Text Box
|-
||'''Language of this Title'''
||The language of the translated title is recorded as an attribute
||Select One - Combo Box
This should be mapped to a custom field with ORCID values.
If this is mapped to a text field, the entered value has to be one of the option values in the list.
|-
||'''Description'''
||Description of the funding
||Text Box
|-
||'''Currency'''
||Currency of the funding
||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 the SmartSimple Cloud currency list, 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.
|-
||'''Total Funding Amount'''
||The value of the award
||Required field, Text Box - Number
|-
||'''Start date'''
||The date the funding began
||Required field, Text Box - Date
|-
||'''End date'''
||The date the funding ended
||Required field, Text Box - Date
|-
||'''Funding URL'''
||This can be the URL to a public funding website
||Text Box
|-
||'''Funding Agency Identifier Link'''
||ORCID verifies this link with the [https://doi.crossref.org/funderNames?mode=list CrossRef list]
||Required field, Text box
If the link entered in record is not found in the CrossRef list, ORCID rejects the record.
|-
||'''Funding Agency Display Name'''
||The funding agency name should correspond to the organization that is specified in the Funding Agency Identifier Link.
||Required field, Text box
Example: "Centre for Global Change Science, University of Toronto" from the [http://dx.doi.org/10.13039/501100014130 CrossRef list].
A different name can be entered but ORCID uses the identifier link to identify the funding organization.
|-
||'''Funding Agency Display City'''
||The funding agency's city should correspond to the organization that is specified in the '''Funding Agency Identifier Link'''.
||Required field, Text box
|-
||'''Funding Agency Display Region'''
||The funding agency's region should correspond to the organization that is specified in the '''Funding Agency Identifier Link'''.
||Text box
|-
||'''Funding Agency Display Country'''
||ORCID checks the country code against the agency specified in Funding Agency Identifier Link, if they don't match, ORCID rejects the record.
||Required field, Select One - Combo Box
This should be mapped to a custom field with ORCID values. Example: "Centre for Global Change Science, University of Toronto" from the [http://dx.doi.org/10.13039/501100014130 CrossRef list] entered as the agency, but you put FI (Finland) as the country code, ORCID will reject the record.
|-
||'''Record Identifier Type'''
||An identifier associated with the work, such as an ISBN, DOI, or PMID
||Required field, Select One - Combo Box This should be mapped to a custom field with ORCID values. If this is mapped to a text field, the entered value has to be one of the option values in the list. If L1s are always be grants, map this to a field with value always equal to grant_number and hide the field. If this field is empty, the system will use doi as type and the external-id-value (normally the grant number) will be replaced with the value of '''Funding Agency Identifier Link''', because otherwise ORCID rejects the record. To prevent this from occurring, specific form validation should be set up for your awarding process.
Example: The funding is for a book, ISBN number 10000005, then the record identifier type should be '''isbn'''.
|-
||'''Record Identifier Number'''
||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 SmartSimpleCloud settings, the ID should always be available for the funding record.
|-
||'''Record Identifier URL'''
||The URL where the identifier resolves to
||Text box
|-
||'''Record Relationship'''
||This is to indicate the relationship of the funding item to the identifier.
||Required field, Select One - Combo Box
This should be mapped to a custom field with ORCID values.
Example: If the funding item is for one phase of a multi-part grant, and the identifier is for the multi-part grant, then the relationship would be part-of if the identifier is for the individual phase, then the relationship would be self.
|-
||'''Contributor Role'''
||Describes the relationship of the individuals who received the funding
||Required field, Select One - Combo Box (L1 association common field)
This should be mapped to a custom field with ORCID values.
Example: For each person involved in the funding, these users are added to the L1-Contacts and each identified as lead, co-lead, supported-by, etc.
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 record, a funding record will be pushed to each of their ORCID record. These users might represent different types of contributor roles in the funding.
|-
||'''Contributor Fund Code'''
||Stores the unique identifier of the funding data that was uploaded to ORCID user's profile.
||Required field, Text box
This is used when the fund data has already been added to ORCID user profile from the L1 and used when the workflow is triggered again to push updated data to ORCID.
|-
||'''Error Message'''
||Error response from process of uploading fund to ORCID user profiles will be saved to this field.
||Required field, Text box
|}
===Mapping the L1 Fields===
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 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:114889-2021-5-ORCIDMapping.png|thumb|none|800px|ORCID 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 record. 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]]
==Using the ORCID Integration==
[[File:114889-2021-18-ORCIDUserProfileViewImported.png|thumb|none|800px|Staff view of user's profile with ORCID data imported]]
===Adding/Updating ORCID Records ===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:114889-2021-22-ORCIDAddedFundingDetails.png|thumb|none|800px|Detailed view of the ORCID profile of the user with new Funding record]]
==See Also==
[[ORCID Research Database Integration - Why?]]
