Page History
...
| Info |
|---|
Since DSpace 7.3 a bidirectional ORCID integration is available for DSpace |
| Info | ||
|---|---|---|
| ||
| The ORCID integration has been was originally developed by 4Science in DSpace-CRIS, it is the result of years of collaboration with several institutions and the ORCID team that has helped to correct, improve and broaden the scope of the integration. We want to thank the University of Hong Kong that was the first institution to fund development activities on this regards back in 2015 and the TUHH Hamburg University of Technology that have funded the initial porting of the ORCID integration to the new Angular/REST architecture introduced in DSpace 7. Last but not least, funds have been received by the DSpace community to port this feature from DSpace-CRIS to DSpace. |
...
DSpace provides a bidirectional integration with ORCID based on the ORCID API v3.0. Both the Public ORCID API than the Membership API are supported.
...
Once enabled an option to login via ORCID is provided to the user among the other authentication method configured in the system. The ORCID authentication doesn't allow the user to reset his password from DSpace.
Connect/Disconnect the
...
local profile to ORCID
The researcher can connect (or disconnect) his their DSpace local profile Researcher Profile with ORCID from the Person item detail page
...
Once that a profile has been connected he they can manage his their synchronization preferences deciding what need to be pushed to ORCID among the biographic data, the publications and projects associated with his profile
, including:
- biographic data
- Publication (entities) linked with their Researcher Profile. (Publication entities are synced to Works in ORCID)
- Project (entities) linked with their Researcher Profile. (Project entities are synced to Fundings in ORCID)
NOTE: The ORCID synchronization feature is disabled by default, even when ORCID Authentication is enabled. See Configuration section below for how to enable it.
The synchronization can happen automatically over the night or manually. The The synchronization can happen automatically over the night or manually, the list of information that need to be pushed or updated from DSpace to ORCID is presented in a queue and can be manually discarded or immediately pushed by the researcher.
...
In the ORCID API Credentials request form you will be asked to enter one or more redirect URLs for you application (DSpace), you will need to enter here the root URL of your REST and Angular interfaces that could eventually be different, otherwise it will be sufficient to put the URL of your angular UI. For example, for the DSpace 7 official demo these are
...
When an user logged-in via ORCID the system will attempt to reuse an existing account looking up by email, if none is found a new account is created in DSpace. It is eventually even possible to disable the creation of new accounts settings the following property
...
Please note that many fields on the ORCID side are subject to validation, i.e. only values from controlled-list can be used and some fields are mandatory. The table below summarize the validation that are defined at the time of DSpace 7.3, ORCID update such rules periodically usually modifying (enlarging) the controlled-list, change to the mandatory fields can also happen
| ORCID Entity | Corresponding DSpace Entity | Mandatory fields | Controlled fields |
|---|---|---|---|
| Person | Person | Country (iso-3166 2 code letter) | |
| Work | Publication | Title Type Publication Date (>= 1900) External Identifier (at least one) | Type (https://info.orcid.org/documentation/integration-and-api-faq/#easy-faq-2682) Identifier.Type (https://pub.orcid.org/v3.0/identifiers) |
| Funding | Project | Title External Identifier (at least one) Funding Agency (Organisation) Currency if an Amount is provided | Amount.Currency (https://www.iso.org/iso-4217-currency-codes.html) |
| Organisation | OrgUnit | External Identifier (at least one) Address City Country | See https://support.orcid.org/hc/en-us/articles/360006894674-Metadata-in-the-Funding-section Country (iso-3166 2 code letter) Identifier.Type (ROR, LEI, CrossRef Funder ID, RINGOLD, GRID) |
To provide more meaningful message to the user DSpace implements a local validation before to try to push the record to ORCID. This validation verify the rules above so that a specific message is displaied to the user. If for any reason another errors is returned by ORCID a generic message is show to the user and the exact technical message received by ORCID is logged in the dspace.log file and stored in the orcidhistory table.
...
the following bean is instead used to configure the i mport import of publication records from ORCID (Work)
...
- via an ORCID lookup authority available for DSpace repository that are not using Configurable Entities
- via a relation among the research output item (Publication, etc.) and a Person Item bind to the ORCID Person External Source defined in the previous paragraph
...
Troubleshooting & common issues
The trouble-shooting troubleshooting guide from ORCID can help as well https://info.orcid.org/documentation/integration-guide/troubleshooting/
I'm having trouble
...
testing the ORCID integration, what should I check?
Please double check the documentation and the other FAQ to be sure to have followed all the instructions to enable the integration correctly. If you still have trouble reach the DSpace tech community via email or slack trying to provide as much details as possible. If the issue is related to the synchronization of DSpace local data with ORCID it would be useful to share information about the content of your orcidhistory table and any relevant message that you could have in the dspace.log file.
...
The ORCID features must be enabled by hand changing some configuration file, please refer to the Enable the integration section paragraph above in the page
I'm unable to authenticate via ORCID
...
When you use public ORCID API credentials you can only use a subset of the integration features (check ) moreover you need to limit the scopes (permissions) requested to the user via the ORCID authentication to the /authenticate scope. Please check the Enable the integration section paragraph above in the page.
I don't find my publications looking up for my ORCID iD
Please check if the system has been properly configured "config/modules/orcid.cfg" (or your local.cfg) to see if the system has been properly configured to use the production ORCID API, there is a chance that your installation is still configured to use the ORCID Sandbox that is appropriate for the testing and developement development phase of the integration. The ORCID sandbox doesn't contain the same data than the publication environment.
...
Please double check that the orcidqueue consumer has been enabled (in dspace.cfg or local.cfg) and that the orcid settings of your profile has the "All publications" checkbox flagged. ORCID features require the use of the new Configurable Entities. Only Publication item are synchronized with ORCID, legacy simple "untyped" items Items will not be synchronized. Please consider to convert your legacy collection to "Publication" collection and set a dspace.entity.type = Publication metadata on your legacy items
...
This is usually due to validation errors. ORCID could complain about missing mandatory fields or invalid values for field that are linked to controlled-list. Please check the table in the Configure the push of information from DSpace to ORCID and the Mapping of DSpace Publication items to ORCID Works paragraph to solve this. Your dspace.log file may also provide useful error messages.
Push of projects to ORCID fails
This is usually due to validation errors. Pays attention to the information in the linked Funding Agency Organisation as well because validation failure on the Funding Agency data will prevent to push the whole fundingMake sure that all required metadata fields exist on the Project Entity and any linked OrgUnit Entities. ORCID could complain about missing mandatory fields or invalid values for field that are linked to controlled-list. Please check the table in the Configure the push of information from DSpace to ORCID and the Mapping of DSpace Project items to ORCID Funding paragraph to solve this. Your dspace.log file may also provide useful error messages.
Overview
Content Tools