Warning |
---|
You are reading the documentation for DSpace-CRIS 5.x and 6.x as available in the maintenance branches. For DSpace-CRIS 7 please check the PDF technical documentation provided on GitHub as noted here a specific section is devoted to the ORCID Integration |
Table of Contents |
---|
Introduction
Info | ||
---|---|---|
| ||
Currently the last line of development DSpace-CRIS 5.10.x use ORCID API v3, see https://members.orcid.org/api/news/xsd-30-update |
Info | ||
---|---|---|
| ||
Since DSpace-CRIS 5.8.0 we use the ORCID API v2, see https://members.orcid.org/api/news/xsd-20-update |
Info | ||
---|---|---|
| ||
Note that "orcid" metadata in the Researcher Profile entity MUST be a "text" property definition (check https://github.com/4Science/DSpace/blob/dspace-5_x_x-cris/dspace/etc/orcid_from_link_to_text.sql to perform the migration) |
Table of Contents |
---|
...
Info | ||
---|---|---|
| ||
more info about ORCID here Since DSpace-CRIS 5.8.0 we use the ORCID API v2, see https://members.orcid.org/api/news/xsd-20-update |
DSpace-CRIS provides the most advanced and complete integration between a CRIS / Repository system and ORCID, achieving most of the ORCID integration use cases.
...
Code Block |
---|
##################### # ORCID ##################### #Production Registry #Step | Member API | Public API #-------------------------------------------------------------------------------------------------------- #Authorize | https://orcid.org/oauth/authorize | https://orcid.org/oauth/authorize #Exchange | https://orcid.org/oauth/token | https://orcid.org/oauth/token #Use | https://api.orcid.org/v2v3.0 | https://pub.orcid.org/v2v3.0 #-------------------------------------------------------------------------------------------------------- # #Sandbox #Step | Member API | Public API #-------------------------------------------------------------------------------------------------------- #Authorize | https://sandbox.orcid.org/oauth/authorize | https://sandbox.orcid.org/oauth/authorize #Exchange | https://sandbox.orcid.org/oauth/token | https://sandbox.orcid.org/oauth/token #Use | https://api.sandbox.orcid.org/v2v3.0o | https://pub.sandbox.orcid.org/v2v3.0 #-------------------------------------------------------------------------------------------------------- authentication-oauth.orcid-api-url = https://pub.orcid.org/v2v3.0 authentication-oauth.application-token-url = https://orcid.org/oauth/token authentication-oauth.application-authorize-url = https://orcid.org/oauth/authorize # register for free on ORCID to use an institutional Public API # IMPORTANT!! Please fill authentication-oauth.application-client-name with name of client registered into orcid registries (need by the putcode flow retrieve) authentication-oauth.application-client-name = authentication-oauth.application-client-id = authentication-oauth.application-client-secret = authentication-oauth.application-client-redirect = ${dspace.baseUrl}/oauth-login # If you have only PUBLIC API the scope need to be; /authenticate scope now includes /read-public scope authentication-oauth.application-client-scope =/authenticate # if you have MEMBER API the suggested scopes are as following; /authenticate scope now includes /read-public scope #authentication-oauth.application-client-scope =/authenticate /read-limited /person/update /activities/update |
...
When the user is logged in via ORCID and proceeds to create his local researcher profile, the system automatically captures from ORCID several information:
Submission lookup
A special authority is build-in DSpace-CRIS to use the ORCID registry togheter with the internal directory of researchers as authority list for metadata editing
...
Preference shortname | DSpace-CRIS property | ORCID property |
---|---|---|
orcid-profile-pref-affiliation | affiliation | affiliations-employment |
orcid-profile-pref-authorid | authorid | external-identifier-Researcher ID |
system-orcid-profile-pref-biography | biography | biography |
orcid-profile-pref-education | education | affiliations-education |
system-orcid-profile-pref-email | primary-email | |
system-orcid-profile-pref-fullName | fullName | name |
orcid-profile-pref-iso-3166-country | iso-country | iso-3166-country |
orcid-profile-pref-keywords | keywords | keywords |
system-orcid-profile-pref-otheremails | otheremails | other-emails |
orcid-profile-pref-personalsite | personalsite | researcher-urls |
system-orcid-profile-pref-preferredName | preferredName | credit-name |
orcid-profile-pref-scopusid | scopusid | external-identifier-Scopus Author ID |
orcid-profile-pref-variants | variants | other-names |
...