Changes

Jump to: navigation, search

ORCID Integration

2,995 bytes added, 15:48, 31 March 2021
no edit summary
||'''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'''
||'''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'''
||'''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 SmartSimple Platform3 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.
|-
||'''Total Funding Amount'''
||'''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'''
||'''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 SmartSimple Platform3 settings, the ID should always be available for the funding record.
|-
||'''Record Identifier URL'''
||'''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 profile, a funding record will be pushed to each of their ORCID profile. 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
|-
||Row 1, Cell 1
||Row 1, Cell 2
||Row 1, Cell 3
|-
||Row 2, Cell 1
||Row 2, Cell 2
||Row 2, Cell 3
|-
||
||
||
|}
The fields required in the ORCID Funding record are displayed in the left column and the SmartSimple Platform3 L1 fields are displayed in the right column. Mandatory fields are indicated with a red asterisk. SmartSimple Platform3 fields are selected using a drop-down.
 
We currently support Adding a new funding record to the user’s ORCID profile. 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.
===Workflow to use Task Type: Push Fund records to users’ 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.
 
We currently support Adding a new funding record to the user’s ORCID profile. 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.
==Using the ORCID Integration==
===Import ORCID records to User Profile===
# Under User Profile - (Edit mode) - Options (tab) -  Profile Data Import (Import from When the user logs into their portal, if they have not previously imported their ORCID)profile, a message appears instructing them to navigate to the correct section.# (i) Login with your When the user navigates to the '''ORCID credentials (see screenshot) and<br />(ii) Authorize SmartSimple tab''' on their profile, they have the option to access your connect their ORCID record (after logged iD. Instructions appear to the user inthis tab. These instructions should introduce users to ORCID, it will ask why you are requesting access to Authorizetheir ORCID record, and what you will only have to authorize once)do with their data.# After you authorized SmartSimple to access When they click on the '''Create or connect your ORCID profileiD''' button, your a new window appears for the user to create or login to ORCID. This process uses OAuth to authenticate ORCID id iDs.# Once their credentials are entered, the user is prompted to '''Authorize access''' for the system. Note that the organization name will be displayed on pagethe one used to apply for the ORCID API and not SmartSimple Software.# Once the '''Authorize access''' is clicked, the ORCID iD is authorized and have the option user is prompted with a button to '''Continue to Import import your ORCID data or Clear '''. 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 token and try login again (if you've previously authorized SmartSimple'' is clicked, you will only need the process ends.# When the user clicks '''Continue to loginimport your ORCID data''', the data is automatically refreshed on their profile and will be authorized automatically)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.# Enable If specific Funding records do not contain a year or amount, they are excluded from the "Profile Model" standard field chart and permission for a message to the users you'd like user is displayed.# An ORCID iD icon is displayed to be able the top of the page next to access the profile name on the '''ORCID data & funding chartstab''' of the profile. You can re-caption This has a hyperlink to the public ORCID profile of the tab via this standard fielduser’s account. The user’s iD and last imported date is displayed.# After you imported A button captioned '''Re-Import ORCID Data''' is available for the user to trigger a re-Import of their ORCID profile. Any data from that has been updated or added to ORCID, you should see will be imported and the data available under your profile - Profile Model tab on the left hand sidepage automatically refreshed. Data The Last Imported date will be read-onlyupdated.# A button captioned '''Unlink Account''' is available for the user to unlink their account. A message appears for the user to confirm. Currently we only support Import from When confirmed, the ORCID, there profile information is no pushing data to immediately removed from the '''ORCIDtab''' of their profile.
Tips===Viewing Other Users’ ORCID profiles===# For roles able to view the user’s profile, such as internal staff, if the user has not previously imported their ORCID profile, 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.# 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 can be viewed. ===Adding/Updating ORCID Records===# 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.# 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".# Trigger the workflow to send the information to ORCID. The new funding record will populate the user’s ORCID profile. Screenshot for ORCID login below is an example from a sandbox/testing account.
[[File:orcidLogin.png|500px]]
 
==See Also==
ORCID Research Database Integration - Why?
110
edits

Navigation menu