Open Researcher and Contributor ID (ORCID) funding fields map to SmartSimple Level 1 fields, controlling the funding data submitted to a researcher's ORCID record. Field definitions, recommended configuration, and the mapping between ORCID funding fields and Level 1 fields are covered below.
ORCID Funding Field Definitions
SmartSimple supports adding and updating funding data on a user's ORCID record using the ORCID Member API. ORCID crosschecks information imported from SmartSimple, and certain fields must be configured using ORCID values. Refer to the ORCID support pages for the most up-to-date values used for the metadata.
| Field | 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. Map to a custom field with ORCID values. Example: award=Award; grant=Grant; contract=Contract; salary-award=Salary Award. If mapped to a text field, the entered value must be one of the option values in the list. |
| Funding Subtype | 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, recorded as an attribute. |
Select One - Combo Box. Map to a custom field with ORCID values. If mapped to a text field, the entered value must 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. Map to a custom field with ORCID values. Although this list looks similar to the SmartSimple currency list, it is recommended to use the values provided by ORCID. If mapped to a text field, the entered value must 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 CrossRef list. |
Required field, Text Box. If the link entered in the 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 specified in the Funding Agency Identifier Link. |
Required field, Text Box. Example: "Centre for Global Change Science, University of Toronto" from the 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 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 specified in the Funding Agency Identifier Link. | Text Box |
| Funding Agency Display Country | ORCID checks the country code against the agency specified in the Funding Agency Identifier Link. If they do not match, ORCID rejects the record. |
Required field, Select One - Combo Box. Map to a custom field with ORCID values. Example: if "Centre for Global Change Science, University of Toronto" from the CrossRef list is entered as the agency, but the country code entered is FI (Finland), ORCID rejects the record. |
| Record Identifier Type | An identifier associated with the work, such as an ISBN, DOI, or PMID. |
Required field, Select One - Combo Box. Map to a custom field with ORCID values. If mapped to a text field, the entered value must be one of the option values in the list. If Level 1 records will always be grants, map this field to a value that is always equal to grant_number and hide the field. If this field is empty, the system uses doi as the type, and the external-id-value (normally the grant number) is replaced with the value of Funding Agency Identifier Link, because otherwise ORCID rejects the record. Set up specific form validation for the awarding process to prevent this. Example: if the funding is for a book with ISBN number 10000005, the record identifier type should be isbn. |
| Record Identifier Number | The identifier associated with the work. |
Required field, Text Box. Used as the external identifier when an identifier type is selected. If no data is specified for this field, the system pushes data to ORCID using the funding agency as the identifier. Although ORCID allows this, the ID should always be available for the funding record. |
| Record Identifier URL | The URL where the identifier resolves to. | Text Box |
| Record Relationship | Indicates the relationship of the funding item to the identifier. |
Required field, Select One - Combo Box. Map 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, the relationship is part-of. If the identifier is for the individual phase, the relationship is self. |
| Contributor Role | Describes the relationship of the individuals who received the funding. |
Required field, Select One - Combo Box (Level 1 association common field). Map to a custom field with ORCID values. Example: for each person involved in the funding, add the contact to the Level 1 Contacts, and identify each as lead, co-lead, supported-by, or another applicable role. If multiple contacts are added to a funding record, a funding record is pushed to the ORCID record of each contact who has an ORCID-enabled role and has authorized SmartSimple to access their ORCID record. These contacts might represent different contributor roles in the funding. |
| Contributor Fund Code | Stores the unique identifier of the funding data that was uploaded to the ORCID user's profile. |
Required field, Text Box. Used when fund data has already been added to the ORCID user's profile from the Level 1 record, and used again when the workflow is triggered to push updated data to ORCID. |
| Error Message | Stores the error response from the process of uploading fund data to ORCID user profiles. | Required field, Text Box. |
ORCID Funding Field to Level 1 Mapping
Each field required in the ORCID funding record is mapped to a SmartSimple Level 1 field. Mandatory fields are indicated with a red asterisk, and Level 1 fields are selected using a drop-down menu.
| ORCID Funding Field | Mapping Notes |
|---|---|
| Funding Type | Matches ORCID values. Field values should be limited to: award, contract, grant, salary-award. |
| 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. Refer to ORCID's documentation on working with organization identifiers for details. |
| 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. Refer to ORCID's documentation on identifier types for details. |
| Record Relationship | Matches ORCID values. Field values should be limited to: self, part-of. Refer to ORCID's documentation on identifier types for details. |
| Contributor Role | Field values should be limited to: lead, co-lead, supported-by, other-contribution. |
| Contributor Fund Code | Stores the uploaded ORCID fund code. If funding data is uploaded to the contributor's ORCID profile successfully, a fund code is returned as the unique identifier of this fund data on the user's profile. |
| Exclude Contributor | Value should be 0 or 1. A value of 0 or empty means the contact is exported to ORCID as a contributor of the fund record. A value of 1 means the contact is not exported to ORCID. |
| Error Message | Stores the error message returned from ORCID. |