ORCID can be used in repository systems to clearly link authors – and all their name variants - with their research work, improving search and retrieval. Repository systems can also exchange data with the ORCID registry -for example, retreiving ORCID record information in order to populate author profiles and updating ORCID records with publication information each time repository deposit is made.
Repository System Workflow Steps
- Get User's ORCID iD & ORCID Record Read/Write Permission
- Display the User's ORCID iD in Your System
- Populate User's Profile with ORCID Record Information
- Populate User's ORCID Record with Information from your System
The first step to incorporating ORCID into your repository system is collecting users' authenticated ORCID iDs permission to read from/write to their ORCID records. You can do this by offering ORCID as a sign-in option (see: Member flow: Sign in using ORCID credentials), or by allowing users to connect their ORCID account from within your system.
To complete this process:
- Provide a button/link your submission form that prompts the corresponding author to connect his/her ORCID record
- Configure this button/link to request permission to read from/write to the user's ORCID record via the ORCID API (see Tutorial: Retrieve data from an ORCID record)
- Upon clicking the button/link, the user is prompted to sign into his/her ORCID account, or to create a new account.
Tip: This screen is designed to be opened in a pop-up window - see our guidelines for presenting the ORCID login screen
- After clicking Authorize, the user is sent back to your site and an authorization code is sent to your system via HTTP.
- When the user authorizes the connection, an authorization code is sent to your system via HTTP.
- Exchange the authorization code for the user's ORCID iD and an access token which will allow you to read from and write to the user's record.
- Store the user's ORCID iD and the access token in your system.
In order to clearly link authors – and all their name variants - with their research work, and to improve search/retrieval, repositories can display and link ORCID iDs to repository deposits.
- Display the user's ORCID iD in their profile within your system, and with each of their publications. ORCID iDs should be formatted as URLs, per our iD Display Guidelines.
ORCID record information can be used to populate authors' profiles in your system. Doing this requires that you've collected ORCID iDs and read/write permission from the authors and reviewers whose ORCID records you'd like to edit by following the steps described above.
The steps to retrieve information from ORCID records include:
- Use the ORCID iD and access token that you've stored to read the user's ORCID record (see Tutorial: Retrieve data from an ORCID record).
- Populate the user's profile in your system with ORCID record information, such as biography, affiliations, and works.
When a work is deposited, repositories can use ORCID to document the publication by adding an entry to the Works section of authors' ORCID records. Adding information to ORCID records involves sending XML or JSON data to the ORCID registry using the ORCID API. Doing this requires that you've collected ORCID iDs and read/write permission from the authors and reviewers whose ORCID records you'd like to edit by following the steps described above.
- Use the ORCID iDs and access tokens that you've stored to post publications and other information to users' ORCID records.