...
[dspace-installDir]/config/modules/authentication-oauth.cfg (via build.properties)
Code Block |
---|
##################### # The client id value <client-id> from ORCID client application registration application-client-id=${authentication-oauth.application-client-id} # The client secret value <client-secret> from ORCID client application registration application-client-secret=${authentication-oauth.application-client-secret} # Public API: http://pub.orcid.org/ # Public API Sandbox: http://pub.sandbox.orcid.org/ # Member API: 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/ # Member API Sandbox: http://api.sandbox.v2.0 | https://pub.orcid.org/ orcid-api-url=${authentication-oauth.orcid-api-url} # Th Redirect URL should be constructed off your dspace url in the following manner: # http://dspace.my/jspui/oauth-login # or if deployed as ROOT application # http://dspace.my/oauth-login application-redirect-uri=${authentication-oauth.application-client-redirect} # Developers Sandbox http://sandbox.orcid.org/oauth/authorize # Production Registry httpv2.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/v2.0 | https://pub.sandbox.orcid.org/v2.0 #-------------------------------------------------------------------------------------------------------- authentication-oauth.orcid-api-url = https://pub.orcid.org/v2.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-authorize-url=${-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-authorize-url} 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 /orcid-profile/read-limited /orcid-bio/update /orcid-works/create /orcid-works/update /funding/create /funding/person/update /activities/update |
...
Using the code available in the dspace-5_x_x -cris branch is also possible to import publication from an ORCID profile in DSpace-CRIS. An ORCIDDataloaderProvider for BTE is included that allow to input an ORCID in the first submission screen (Search by Identifiers) and importing one or all the publications. The dataloader will use the structural information available in the ORCID Work plus the citation field if supplied in a format understandable by another BTE provider (such as BibTex, EndNote, etc.)
...
from DSpace-CRIS to ORCID
Info |
---|
Previously, v1.2 allowed members to update a researcher’s given name, family name, or biography. This had the potential to overwrite the researcher’s preferred name, or how they chose to describe themselves in the system, or even lock them out from editing that data.The v2.0 no longer has edit access to any of these fields. The logic behind this is that the user has chosen to add these fields themselves, and no party can edit data added by another party. |
If the researcher grants permission to DSpace-CRIS to update his ORCID profile, this is done during the authentication via ORCID or directly from the ORCID tab in the researcher profile, DSpace-CRIS is able to send these local information to ORCID (below the shortname of the property as in the default configuration):
affiliation
authorid
biography
education
email
fullName
country
keywords
otheremails
other-emails
personalsite
preferredName
scopusid
variants
the researcher can set his own preferences about the synchronization both about which information needs to be send than how/when this happen (automatically or manually). All the preferences are stored as property in the researcher profile.
...
- define which publications to send: all, only publications selected, only publications not hidden (see ), none
- define which projects to send: all, only projects selected, only projects not hidden (see ), none
- define which biographic information will be send
Info |
---|
The synchronization procedures use a convention to discover which preference are available, see Mapping local properties to ORCID below. |
...
The shortname of all the ORCID preference flags start with orcid-profile-pref- and end with the shortname of the property that need to be syncronized with ORCID. The label of the preference property must match the name of the target Element in the ORCID XML message in this way you can easily set a custom mapping for your extra or renamed properties. The shortname start with "system-" prefix is used to build request document to send to ORCID but due to the v2 limitation is not possible synchronized its values.
The default configuration is
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 | 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 |
...