ORCID 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

A scheduled job can push asset-record metadata from Esploro's database to ORCID.

Only approved assets can be pushed. Output that has been brought in as a deposit (see Adding and Working with Research Deposits) or via Smart Harvesting (see Working with Smart Harvesting), but has not yet been approved, is not 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).

The push operation can also add a link to researchers' ORCID profiles that opens their Esploro profiles. This option can be enabled in the Orcid Record Sections Settings configuration table (Configuration menu > Repository > Integrations > ORCID Record Sections Settings). To enable the option, in the table, for the RESEARCHER_URL Entity Type, under Send to Orcid, select True. The text of the link that will appear in the ORCID profile appears under Value. You can modify the link text if you wish. Select Customize to implement your changes.

For information about activating the push feature, see Activating the Push Job.

Pull Assets from ORCID to Esploro

For details see Running the Pull Job.

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

Integration Screen

A researcher can register with ORCID to receive a unique ORCID iD to identify them and to grant the institution permissions to handle the profile on the researcher’s behalf. A researcher's ORCID links all their research activity, even if they have changed their affiliated institution and even if they changed their name. It also distinguishes between researchers for the same name. For more information on working with ORCID in Esploro see ORCID in Esploro.

1. Navigate to the ORCID Integration page (Configuration Menu > Repository > Integrations > ORCID integration).

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

3. 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). 

4. The ORCID status for researchers appears in the right hand side pane of the Researcher Details page (see Viewing Researcher Details).

Researcher Details

ORCID status in Researcher Profile pane

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

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.

Running the Pull Job

1. Run the Retrieve Researcher’s ORCID Profile – list of assets job (see Scheduled Jobs). The job creates a CSV file.
2. Navigate to Repository > Smart Harvesting > Manage Profiles > CSV.
3. Load the CSV file.
4. Run the Smart Expansion Profile - see Smart Expansion via CSV or Excel for more information.

Revoking Tokens

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.