DSpace/ORCID Integration Details
- DSpace is an open-source repository software.
- There is no authentication of ORCID iDs within the native DSpace functionality and the ORCID member API is not supported.
- Therefore, ORCID requests that members build an interface between their system and DSpace.
- This practice is demonstrated by the University of Cambridge which uses Symplectic Elements to integrate with ORCID and authenticate ORCID iDs, then sends the authenticated data to DSpace: https://ukorcidsupport.jisc.ac.uk/wp-content/uploads/sites/23/2019/11/ORCID-Case-Study-Cambridge.pdf
- For organisations without access to an ORCID-enabled system, one solution has been shared by King Abdullah University of Science and Technology (KAUST) in Saudi Arabia. KAUST developed the functionality to enable DSpace 5.9+ or 6.3+ to work with the ORCID member API and provide authentication, read, write and synchronization capabilities and have made that code open for community use.
- The KAUST developments have two components: (1) The Institutional ORCID Integration (IOI) tool which provides an interface for users from an institution to set up and manage the connection between their ORCID iD and the institution and (2) the DSpace patch which allows their ORCID iD to be added to records in the DSpace repository, and for information about new publications to be sent back through the IOI connection into their ORCID record.
First (outside of DSpace): the ‘Institutional ORCID Integration (IOI)’ tool: https://github.com/kaust-library/ioi
→ collects authenticated ORCID iDs
→ harvests new and modified repository records from DSpace to the metadata table, keeping track of new works added to the institutional repository
→ synchronizes works from IOI to ORCID, updating the user records in ORCID with new works harvested to IOI from the repository
→ sends updated ORCID metadata into DSpace, checking that ORCID iDs are added to the DSpace record for each work that the user has selected as their own
→ synchronizes affiliations from IOI to ORCID (optional task), to update affiliations in user records in ORCID. It only needs to be run if institutions are uploading new job titles, end dates, etc. for researchers to IOI.
Watch a detailed video demonstrating the step-by-step process of setting up IOI here: http://hdl.handle.net/10754/659221
Second (within DSpace): the patch ‘Expanded ORCID Support for DSpace’: https://atmire.github.io/expanded-ORCID-support/#/README
→ exposes DSpace authority keys, as well as ORCID iDs, for author metadata through the DSpace REST API
→ makes it possible to add authorities and ORCID iDs to both new and existing items through the REST API
→ enables the updating of an item with an additional author and their ORCID iD
→ unlocks limited editing of those authorities
→ triggers display of the ORCID iD Icon on the item page
→ enables advanced Search on ORCID iD
Note: while the default DSpace ORCID functionality does enable the adding and storing of ORCID iDs within repositories using the public API, this is not done through an authenticated process and therefore is not compliant with ORCID’s minimum requirements for integrations or ORCID’s recommendations for supporting ORCID in repositories.
Future plans: Duraspace (the not-for-profit organisation supporting DSpace) are actively engaging with ORCID. Duraspace merged with LYRASIS in July 2019 and LYRASIS also manages one of the US ORCID Consortia. Michele Mennielli, International Membership and Partnership Manager of Duraspace, chaired the ORCID in Repositories Task Force in 2018-2019 and concluded the process stating “DuraSpace will support and promote the Task Force recommendations throughout its community. The recommendations will be brought to the Governance of its community projects to be considered for the next roadmaps, and DuraSpace will collaborate with ORCID on outreach efforts aimed at spreading the word about the details of the recommendations.” We understand that ORCID member API integration and authentication is on the road-map and is expected in DSpace 7 or 8. If you are involved in the DSpace community, please consider advocating to enable the community to collect authenticated ORCID iDs, read data from ORCID records, and write data to ORCID records from within native DSpace functionality.
DSpace/ORCID Credentials Process
To obtain production member API credentials for your integration, first build and test your integration within the sandbox. Register to use the Sandbox here: https://orcid.org/content/register-client-application-sandbox
Integrations are recommended to meet all ORCID’s best practices but there are minimum requirements to receive production credentials. Please consult the Member API Credentials Checklist here: https://members.orcid.org/api/member-api-credentials-check-list
When your integration is ready to go live, please contact the Irish ORCID Consortium Lead to schedule a review: email@example.com
Once the integration has been approved, production credentials can be requested using this form: