Feature/orcid push by ivanmrsulja · Pull Request #4125 · vivo-project/VIVO

ivanmrsulja · 2025-11-28T16:54:27Z

linked Vitro PR: 504

What does this pull request do?

Integrates ORCID push workflow using Member API credentials.

What's new?

edu.cornell.mannlib.vivo.orcid.controller.OrcidDisallowPushHandler
edu.cornell.mannlib.vivo.orcid.controller.OrcidAllowPushHandler
edu.cornell.mannlib.vivo.orcid.controller.OrcidMemberCallbackHandler
edu.cornell.mannlib.vivo.orcid.export
edu.cornell.mannlib.vivo.orcid.service
edu.cornell.mannlib.vivo.orcid.util

How should this be tested?

Configure VIVO ORCID credentials in runtime.properties file (Ask @chenejac for sandbox credentials). Navigate to researcher profile when logged in as researcher (you can bind researcher account to any person entity). Click on Allow ORCID push and complete the OAuth2 workflow (keep in mind that you will have to create ORCID Sandbox account beforehand, your regular ORCID account won't work). After this, periodic dissemination of research information should be performed to your ORCID profile.

Interested parties

@chenejac

Reviewers' expertise

Please add any new expertise in the list which might be needed for reviewing your PR or remove any of the listed if it is not needed.

Candidates for reviewing this PR should have some of the following expertises:

Java
HTML, CSS, JavaScript
FreeMarker
SPARQL

chenejac · 2026-05-03T15:44:49Z

+            occ.getSetting(OrcidClientContext.Setting.WEBAPP_BASE_URL) +
+                occ.getSetting(OrcidClientContext.Setting.CALLBACK_PATH);
+
+        String authUrl = "https://sandbox.orcid.org/oauth/authorize" +


Why sandbox?

Left by mistake, fixed it now 😄

chenejac · 2026-05-03T16:19:42Z

+
+        if (converterClass == null) {
+            return null; // should never happen
+        }


Do we need this level of generalization here? Can we just introduce OrcidObjectConverter interface which will be implemented by EducationConverter, WorkConverter, etc with toOrcidModel method instead? Is this approach applied at some other parts of VIVO/Vitro which you just adopted?

chenejac · 2026-05-03T17:14:29Z

+    public static String FIND_ALL_EDUCATION =
+        "PREFIX rdf:        <http://www.w3.org/1999/02/22-rdf-syntax-ns#>\n" +
+            "PREFIX rdfs:       <http://www.w3.org/2000/01/rdf-schema#>\n" +
+            "PREFIX xsd:        <http://www.w3.org/2001/XMLSchema#>\n" +
+            "PREFIX owl:        <http://www.w3.org/2002/07/owl#>\n" +
+            "PREFIX vitro:      <http://vitro.mannlib.cornell.edu/ns/vitro/0.7#>\n" +
+            "PREFIX foaf:       <http://xmlns.com/foaf/0.1/>\n" +
+            "PREFIX obo:        <http://purl.obolibrary.org/obo/>\n" +
+            "PREFIX vivo:       <http://vivoweb.org/ontology/core#>\n" +
+            "PREFIX vcard:      <http://www.w3.org/2006/vcard/ns#>\n" +
+            "PREFIX bibo:       <http://purl.org/ontology/bibo/>\n" +


Should we consider moving those SPARQL queries to n3 files, to make it configurable without changing java code, building, deploying, etc? Might be that some institutions would like to add some filters, additional criteria.

chenejac · 2026-05-03T17:17:06Z


 :vitrodocumentModifier_organizations_filter
-    a   <java:edu.cornell.mannlib.vitro.webapp.searchindex.documentBuilding.SelectQueryDocumentModifier> ,
+    a   <java:edu.cornell.mannlib.vitro.webapp.searchindex.documentBuilding.SelectQueryI18nDocumentModifier> ,


This file changes are part of this task (pushing data into ORCID)?

It wasn't, my mistake, I removed it from PR. Thanks for noticing!

chenejac · 2026-05-03T17:17:13Z

        vitro-search:facetResults  true ;
        vitro-search:filterField   :field_organizations ;
        vitro-search:id            "organizations" ;
-        vitro-search:isUriValues   true ;


This file changes are part of this task (pushing data into ORCID)?

Same as above, removed from PR.

chenejac · 2026-05-20T20:45:56Z

@@ -0,0 +1,26 @@
+{
+  "Book": "book",


@ivanmrsulja can you use here the full URI as a key? This short key might introduce some issues in some cases.

chenejac · 2026-05-20T20:47:06Z

+        WHERE {
+            <%s> vivo:relatedBy ?authorship .
+            ?authorship vivo:relates ?resource .
+            ?resource <http://vitro.mannlib.cornell.edu/ns/vitro/0.7#mostSpecificType> ?workType .


@ivanmrsulja instead of mostSpecificType to use rdf:type?

@ivanmrsulja without using rdf:type subclasses wouldn't have proper orcid types. So rdf:type should be used.

…ersion.

…gic.

…n fetching data for export.

…ployments to bind intermediate representation. Added DTO classes.

…lvements.

…according to feedback.

… Updated work-type mapping.

litvinovg · 2026-06-18T20:08:13Z

+
+    OPTIONAL {
+        ?resource vivo:dateTimeValue ?dtValue .
+        ?dtValue vivo:dateTime ?publicationDate .


Date time precision should be taken into account

litvinovg · 2026-06-18T20:09:49Z

+        }
+    }
+
+    FILTER (STR(?resource) > "%s")


I suggest to get the instances to be pushed in the first run and collect information for data export in another run. In current state SPARQL queries look complicated and not efficient.

litvinovg · 2026-06-18T20:10:38Z

+
+    private static Map<String, String> loadWorkTypeMappings() {
+        try (InputStream is = WorkConverter.class
+            .getClassLoader()


I suggest to move type mapping inside sparql query.

litvinovg · 2026-06-18T20:13:41Z

+    }
+
+    @Nullable
+    private Class<?> getConverterClass(ExportSet exportSet) {


I would suggest to avoid using reflection api. It creates more safety issues and complicates the code, so it should be avoided, especially for new code.

litvinovg · 2026-06-18T20:18:54Z

@ivanmrsulja I tried to test export for person positions, but it didn't work for me for some reason. Could you extend test instructions on what data should be entered for testing pushing different types of data?

chenejac · 2026-06-20T14:36:46Z

@ivanmrsulja I tried to test export for person positions, but it didn't work for me for some reason. Could you extend test instructions on what data should be entered for testing pushing different types of data?

I believe required fields are specified here - https://info.orcid.org/documentation/integration-guide/admin-guide-to-affiliations/#Required

It means affiliation should be linked with Organisation which is described with name, city, country and rorId.

chenejac marked this pull request as draft December 1, 2025 13:23

ivanmrsulja mentioned this pull request Dec 17, 2025

Feature/integration model vivo-project/Vitro#504

Open

chenejac marked this pull request as ready for review December 29, 2025 10:00

chenejac linked an issue Jan 25, 2026 that may be closed by this pull request

Mapping of VIVO work information into the ORCID API work record #4072

Open

chenejac removed a link to an issue Jan 25, 2026

Mapping of VIVO work information into the ORCID API work record #4072

Open

This was linked to issues Jan 25, 2026

Push VIVO works information into the ORCID registry #4074

Open

Push VIVO employment / education information into the ORCID affiliation record #4075

Open

chenejac requested review from chenejac and litvinovg April 30, 2026 14:54

chenejac requested changes May 3, 2026

View reviewed changes

chenejac requested changes May 14, 2026

View reviewed changes

Comment thread api/src/main/java/edu/cornell/mannlib/vivo/orcid/export/converter/WorkConverter.java Outdated

chenejac reviewed May 20, 2026

View reviewed changes

ivanmrsulja added 17 commits June 15, 2026 08:53

Started adding OAuth2 handshake infrastructure. Implemented initial v…

c8d4190

…ersion.

Added task scheduler infrastructure. Continued work on integration lo…

e8aa235

…gic.

Finished infrastructure for access token lifecycle. STarted working o…

f259483

…n fetching data for export.

Added keyset pagination infrastructure for fetching educations and em…

9992a5d

…ployments to bind intermediate representation. Added DTO classes.

Added generic conversion infrastructure. Created PoC with person invo…

47a9d29

…lvements.

Added complete initial ORCID push PoC.

65f11d8

Completed first version of ORCID push workflow.

434ffd4

Added missing labels.

5840aa6

Fixed some bugs and added configuration examples.

e033329

Fixed some layout issues.

1fbbc93

Moved .css configuration from Vitro to wilma.css

fea4cfa

Improve error logging.

7a85e80

Revert serchFieldsConfigurationVivo.n3 change.

c191799

Revert search_individuals_vivo.n3 changes.

dbdd4fb

Fixed hardcoded sandbox host URL.

11ddf82

Added null guards.

8550b96

Fixed ORCID ID not showing on profile after binding. Refactored code …

1d49bfa

…according to feedback.

ivanmrsulja added 4 commits June 15, 2026 08:53

Fixed orcid binding bug.

e688968

Added support for more identifiers: issn, isbn, pmid, source-work-id.…

97be036

… Updated work-type mapping.

Various fixes and improvements.

d46fc1f

Improved ROR and address interpolation logic for involvements.

9f263af

ivanmrsulja force-pushed the feature/orcid-push branch from 3781c5d to 9f263af Compare June 15, 2026 06:55

ROR bugfix.

0c94963

litvinovg reviewed Jun 18, 2026

View reviewed changes

chenejac mentioned this pull request Jun 21, 2026

ORCiD authentication #4145

Merged

ivanmrsulja added 2 commits July 7, 2026 17:46

Improved type mapping.

b4acb2f

Added sync now operation. Other smaller improvements.

3d10e4b

Uh oh!

Conversation

ivanmrsulja commented Nov 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this pull request do?

What's new?

How should this be tested?

Interested parties

Reviewers' expertise

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

litvinovg commented Jun 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chenejac commented Jun 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ivanmrsulja commented Nov 28, 2025 •

edited

Loading

litvinovg commented Jun 18, 2026 •

edited

Loading