Overview of ORCID in Esploro
ORCID is a not-for-profit organization. They provide a unique, persistent identifier (ORCID iD) for individuals to use as they engage in research, scholarship, and innovation activities (see ORCID Website). ORCID is used by many researchers to distinguish themselves from each other. Researchers generally connect their ORCID iD with their professional information — affiliations, grants, publications, peer review, etc. Researchers also use their ORCID iD to share their information with other systems,
In Esploro, ORCID iDs are included in researcher records as well as in other data such as author metadata in imported assets, which often come with an ORCID iD. Esploro also supports the ability to integrate and push and pull data from ORCID.
How is ORCID used in Esploro
Display and Link to ORCID Profile
You can display and link to the ORCID iD on the profile page. For details see Register and Connect ORCID iD.
ORCID iD for Author Matching Approval in Smart Harvesting
The Esploro Smart Harvesting feature brings in assets that are potential matches for a set of researchers that you selected. When configuring Smart Harvesting, one of the options determines whether Esploro will use identifiers in order to decide whether the match is relevant or not.
When making this decision, Esploro gives additional weight to matches from ORCID iDs.
ORCID iD in Published Data
If an ORCID iD exists, it is included in data that is published to the systems we integrate with.
What is Available for ORCID Integration in Esploro
Register and Connect ORCID iD
A researcher can register with ORCID to receive a unique ORCID iD to identify them. Researchers can also "connect" their Esploro account with ORCID which grants the institution permissions to read and/or write data to the researcher's ORCID profile. Researchers can revoke permission at any time through their ORCID profile. Researchers also control what displays on their ORCID profile, so records that have been pushed can be set to display or not.
For details, including preconditions for ORCID integration, see Register or Connect the ORCID iD.
Push Assets from Esploro to ORCID
The push assets from Esploro to ORCID feature pushes record metadata for research output that is in Esploro.
Only approved assets can be pushed.
Output that has been brought in through Deposit (see Adding and Working with Research Deposits) or Smart Harvesting (see Working with Smart Harvesting) but has not yet been approved, will not be pushed. It is possible to configure the ORCID integration so that specific resource types are included or excluded from the push operation (see Integration below).
For details see Activating the Push Job.
Pull Assets from ORCID to Esploro
For details see Running the Pull Job.
For research output to be pulled, the following conditions apply:
1. The record must have a DOI or PMID.
2. The source is not Esploro.
3. The record has not been pulled previously.
After the pull operation is complete, the output file should be used as the input for Smart Expansion via Excel/CSV (see Working with Smart Expansion).
Smart Expansion imports the records from CDI and deduplicates on import.
Setting up the Integration
A researcher can register with ORCID to receive a unique ORCID iD to identify them
For a video showing how to setup ORCID integration see here.
In order for this feature to work, the researcher's institution needs to be registered with ORCID and must also activate the feature in Configuration > General > Institution Settings > Esploro_ORCID_Integration (from the row actions menu, set the parameter value to true). You need to logout and then login to Esploro in order for the ORCID configuration information to display. In addition, this only applies to assets that are approved and visible on the profile (see Working with Research Assets).
Navigate to the ORCID Integration page (Configuration Menu > Repository > Integrations > ORCID integration).
- Fill in the ORCID integration details as described below:
Client ID —The institution's ORCID Client ID - provided by ORCID.
Organization ID Type – The type of Organization ID provided - can be Ringgold or GRID.
Client Secret — The institutions ORCID Client Secret - provided by ORCID. The Client Secret together with the Client ID are the API credentials for your institution - they function like a username and password.
Organization ID — The Organization ID is how the institution is identified in a public database. This can be Ringgold or GRID.
Redirect URI — The redirect URL in Esploro to which ORCID's server returns the user once ORCID activities have been completed. This field is mandatory. The value should be the URL of your institution's Esploro portal (homepage), and must match the URL that was registered with ORCID. If the URL you enter here does not match the URL that was registered with ORCID, the integration process will fail. If access fails, it is recommended to contact ORCID support to confirm that the correct redirect URL was registered with them.
Send Institutional Affiliation – If you want to send employment data to ORCID, select Yes. In this case, researchers' ORCID profiles are updated to show that the researcher is employed by the organization. In order to send employment information, the Organization ID is mandatory. A researcher's employment information is sent once, but if it is changed later, it is not updated by the ORCID job. If a researcher's employment details need to be updated, the researcher must manually update them in the ORCID interface. This job can be accessed at Configuration Menu > General > Institution Settings > Research Jobs Configuration. The job is available after the ORCID integration details have been entered.
Send assets – Whether or not to push assets to ORCID. Out of the Box, the value is No. If set to Yes, the Update Researchers ORCID job sends to ORCID all the assets that are approved.
Target — The Esploro environment type (either Sandbox or Production) through which ORCID connects to Esploro. To send users to the real ORCID site, choose Production. For testing purposes, choose Sandbox.
Update Researchers ORCID Profile — If All is selected then the system will ignore the Update ORCID Profile flag in the Researcher Settings (see the Researcher Profile Fields table). If Selected is marked, then the system will use the flag in the Researcher Settings to determine which researchers are pushed. This can also be controlled when running the Update Set of Researchers job (see Manual Jobs and their Relevant Parameters). Only researchers with an ORCID iD, that have connected their ORCID profile, are eligible for being pushed.
When the ORCID Integration details have been entered by the institution in the Researcher Profiles, the researcher can click on a link that takes them to the ORCID login page where they can register/connect to ORCID by creating an ORCID access token (see here for details).
- The ORCID status for researchers appears in the right hand side pane of the Researcher Details page (see Viewing Researcher Details).
- You can view the last date that the Update Set of Researchers job was run for a researcher under the ORCID synchronize date area. In addition, the ORCID iD appears in the researcher Identifiers tab.
What are Tokens
In order to integrate with ORCID, Esploro must have an active access token for each researcher who will be synchronized. If an institution has a legacy or third party system that already integrates with ORCID, administrators can migrate or share the ORCID tokens with Esploro. This is done using an API.
Running the Integration
Storing the Tokens
For the tokens API to work, a researcher needs to exist in Esploro with the ORCID iD that is listed in the token (see Adding Researchers). In order for the integration to work, ORCID integration needs to be set up (see Configure ORCID Integration).
To run the tokens API see ORCID Token.
Esploro relies on the correct scope appearing in the access token.
For more information on ORCID access tokens see OAuth Scope.
Activating the Push Job
In order for assets to be pushed to ORCID, the Update Researcher ORCID scheduled job (see Scheduled Jobs) must be activated. Once activated, this job runs daily.
Esploro will only push assets to ORCID if they are approved and visible on the portal, and the researcher has a registered ORCID ID. See Configuring ORCID Integration for details of the prerequisites.
Running the Pull Job
The following preconditions must exist in order to pull assets from ORCID to Esploro:
- Run the Retrieve Researcher’s ORCID Profile – list of assets job (see Scheduled Jobs). The job creates a CSV file.
- Navigate to Repository > Smart Harvesting > Manage Profiles > CSV.
- Load the CSV file.
- Run the Smart Expansion Profile - see Smart Expansion via CSV or Excel for more information.
For a video showing how to retrieve assets from ORCID see How to Retrieve Assets from ORCID for a Set of Researchers.
Researchers can revoke tokens at any time as described in the ORCID documentation. Once a token has been revoked, Esploro will no longer have access to this researcher.
Frequently Asked Questions
Do I need membership?
Yes, you do need membership in order to integrate with ORCID through Esploro.
I received a redirect URL error - what do I do?
Contact ORCID support with the original URL that was entered during the ORCID configuration.
Is ORCID employment data updated?
Only the position and institutional level affiliation are sent to ORCID. If the information is updated in Esploro, the update is currently not sent to ORCID.
Asset Type Mapping Between Esploro and ORCID
|Esploro Asset Type||ORCID Work Type|