Dataverse topic class term uri by ffritze · Pull Request #12614 · IQSS/dataverse

ffritze · 2026-08-14T09:00:51Z

What this PR does / why we need it:
It adds a valueURI attribute for topicClassification subjects in the exporter implementation and adapts attributes in the
topicClassification context.

Which issue(s) this PR closes:

Closes Feature Request: Add new subfield topicClassTermURI to citation metadata #10736

Special notes for your reviewer:
I think I have covered all the topic Classification logic. I am not quite sure if this is demanded but I could easily remove some parts of my implementation.

Suggestions on how to test this:

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes update needed for this change?:

Additional documentation:

Merge "develop" into "master" for 6.10 release

merge develop into master for 6.10.1

Merge develop into master for 6.11

…taverse_topicClassTermURI

pdurbin · 2026-08-18T14:09:10Z

+                        <topcClas subjectScheme="LOC Subject Headings" schemeURI="http://www.loc.gov/catdir/cpso/lcco/lcco.html">Elections -- California</topcClas>
                     ]]></xhtml:samp>
                  </xhtml:div>
               </xhtml:div>


@ffritze I'm just leaving this comment at the bottom. Tests are not passing. I'm seeing errors like this:

[ERROR] Failures: [ERROR] DdiExportUtilTest.testJson2DdiNoFiles:119 Expecting: <control instance> and <test instance> to be similar Expected attribute name '/codeBook[1]/stdyDscr[1]/stdyInfo[1]/subject[1]/topcClas[1]/@vocab' - comparing <topcClas...> at /codeBook[1]/stdyDscr[1]/stdyInfo[1]/subject[1]/topcClas[1]/@vocab to <topcClas...> at /codeBook[1]/stdyDscr[1]/stdyInfo[1]/subject[1]/topcClas[1] expected:<<topcClas vocab="TC Vocabulary" vocabURI="http://www.topicclass.com/one" xmlns="ddi:codebook:2_5">TC Value 1</topcClas>> but was:<<topcClas schemeURI="http://www.topicclass.com/one" subjectScheme="TC Vocabulary" xmlns="ddi:codebook:2_5">TC Value 1</topcClas>>> [ERROR] DdiExportUtilTest.testJson2DdiNoFilesTermsOfUse:172 Expecting: <control instance> and <test instance> to be similar Expected attribute name '/codeBook[1]/stdyDscr[1]/stdyInfo[1]/subject[1]/topcClas[1]/@vocab' - comparing <topcClas...> at /codeBook[1]/stdyDscr[1]/stdyInfo[1]/subject[1]/topcClas[1]/@vocab to <topcClas...> at /codeBook[1]/stdyDscr[1]/stdyInfo[1]/subject[1]/topcClas[1] expected:<<topcClas vocab="TC Vocabulary" vocabURI="http://www.topicclass.com/one" xmlns="ddi:codebook:2_5">TC Value 1</topcClas>> but was:<<topcClas schemeURI="http://www.topicclass.com/one" subjectScheme="TC Vocabulary" xmlns="ddi:codebook:2_5">TC Value 1</topcClas>>>

Can you please take a look?

Hi @pdurbin , I have updated my feature branch. I have decided not to change the src/test/resources/xml/xsd/ddi-codebook-2.5/ddi_codebook_2_5.xsd because it is loaded via the internet here src/test/java/edu/harvard/iq/dataverse/export/ddi/dataset-finch1.xml and therefore cannot be changed directly. So I have just made minimal changes to the DDI Exporter keeping the old attribute names and updating the metadata field from topicClassVocabURI to topicClassTermURI

My main focus lay on the OAI oai_datacite export which is now working as expected.

@ffritze tests are passing now! Thanks!

…taverse_topicClassTermURI

This reverts commit 5a03c25.

…LSchema/codebook.xsd schema file

pdurbin · 2026-08-20T14:39:53Z

@@ -0,0 +1,38 @@
+Analogue to the addition of a termURI field to the keywords in the citation metadata blocks, the same idea should also be applied to the topicClassification fields:
+
+add a new subfield topicClassTermURI to the citation metadata block


I'm confused. In this pull request should scripts/api/data/metadatablocks/citation.tsv be updated to include a new field?

Assuming so, this release note snippet should also include a ## Upgrade instructions section at the bottom explaining how to load it and how to update Solr to include the new field. https://github.com/IQSS/dataverse/releases/tag/v6.8 is probably a decent example. Here's a screenshot:

@pdurbin I have updated the documentation by adapting the former keywordTermURI migration with https://github.com/IQSS/dataverse/releases/tag/v6.3

Interesting. From a quick look I'm wondering if all that SQL should be put into a migration script so it can be run automatically. If you're not familiar with how we use Flyway for this: https://guides.dataverse.org/en/6.11/developers/sql-upgrade-scripts.html

I don't think it can be automated - people may have been using the existing field correctly, in which case values shouldn't be migrated.

pdurbin · 2026-08-20T14:40:52Z

+                  "typeName": "topicClassTermURI",
                  "multiple": false,
                  "typeClass": "primitive",
                  "value": "http://www.topicClass.com/one"


Checks are failing:

We should fix this. Don't worry, we'll help. 😄

pdurbin · 2026-08-25T17:30:24Z

 datasetfieldtype.originOfSources.title=Origin of Historical Sources
 datasetfieldtype.characteristicOfSources.title=Characteristic of Sources
 datasetfieldtype.accessToSources.title=Documentation and Access to Sources
 datasetfieldtype.title.description=The main title of the Dataset


Somewhere in here we need a description. See Properties Check / Metadata Blocks Properties (pull_request) and "missing key" below:

Thanks for the info. It should have been fixed.

Yes! Thanks!

pdurbin · 2026-08-27T13:58:42Z

                  "value": "http://www.topicClass.com/one"
                }
              }
            ]


I'm just putting this here at the bottom.

JSF tests are failing: Dataverse JSF Frontend Tests Workflow / main-jsf-tests-workflow (pull_request)

@srmanda-cs do you think this is because a new subfield was added? 🤔

See gdcc/dataverse-jsf-tests#1

@srmanda-cs says he's working on a fix! 🎉 ❤️ See #dev > JSF tests, automated with Playwright @ 💬

@srmanda-cs made a fix here:

Fix flaky select-all checkbox in dataset actions test gdcc/dataverse-jsf-tests#2

I'm rerunning the job: https://github.com/IQSS/dataverse/actions/runs/32970901324?pr=12614

Passing now! Thanks, @srmanda-cs! ❤️ 🎉 🚀

I am currently investigating how to upgrade the DB schema with the new metadata property. I will document the whole migration process when I can approve it is working. So this pull request is still not ready...

No worries, please take your time and please let us know if we can help at all. I moved it to "in progress" and assigned it to you.

OK. I think it is working. Could you please tell me if you agree with the labels of topicClassification? I have used the same as for the keyword section. Please see here this screenshot attached.

Sorry, upload doesn't work at the moment. I will retry later.

Term
Term URI
Controlled Vocabulary Name
Controlled Vocabulary URL

These are the 4 labels in the right order.
They are the same as for keywords:

Term
Term URI
Controlled Vocabulary Name
Controlled Vocabulary URL

Do you agree?

coveralls · 2026-09-01T13:20:55Z

coverage: 25.24% (+0.2%) from 25.019% — TIK-NFL:dataverse_topicClassTermURI into IQSS:develop

pdurbin and others added 6 commits March 19, 2026 14:24

Merge pull request IQSS#12233 from IQSS/develop

270032e

Merge "develop" into "master" for 6.10 release

Merge pull request IQSS#12259 from IQSS/develop

300d5b5

merge develop into master for 6.10.1

Merge pull request IQSS#12502 from IQSS/develop

dd1859d

Merge develop into master for 6.11

dataverse_topicClassTermURI feature

54f9e4e

Merge remote-tracking branch 'refs/remotes/dataverse/develop' into da…

7fb183e

…taverse_topicClassTermURI

fixed schema file and test is now passing

5a03c25

ffritze mentioned this pull request Aug 14, 2026

Feature Request: Add new subfield topicClassTermURI to citation metadata #10736

Open

3 tasks

pdurbin added this to IQSS Dataverse Project Aug 18, 2026

pdurbin moved this to Ready for Triage in IQSS Dataverse Project Aug 18, 2026

pdurbin moved this from Ready for Triage to Ready for Review ⏩ in IQSS Dataverse Project Aug 18, 2026

pdurbin added the Size: 10 A percentage of a sprint. 7 hours. label Aug 18, 2026

pdurbin reviewed Aug 18, 2026

View reviewed changes

ffritze added 3 commits August 19, 2026 09:40

Merge remote-tracking branch 'refs/remotes/dataverse/develop' into da…

b82ae20

…taverse_topicClassTermURI

Revert "fixed schema file and test is now passing"

a43704e

This reverts commit 5a03c25.

sticking to https://ddialliance.org/Specification/DDI-Codebook/2.5/XM…

f36737f

…LSchema/codebook.xsd schema file

pdurbin reviewed Aug 19, 2026

View reviewed changes

Comment thread src/main/java/edu/harvard/iq/dataverse/export/ddi/DdiExportUtil.java

added release note

739a7d3

pdurbin reviewed Aug 20, 2026

View reviewed changes

ffritze added 6 commits August 24, 2026 08:32

updated citation.tsv

4286b08

updated citation.properties

92303b8

right order

3825c89

corrected

93b8edd

right order correction

acf463e

migration documentation

6b0cd85

pdurbin reviewed Aug 25, 2026

View reviewed changes

fixed citation properties

20a55bd

cmbz added FY27 Sprint 4 FY27 Sprint 4 (2026-08-12 - 2026-08-26) FY27 Sprint 5 FY27 Sprint 5 (2026-08-26 - 2026-09-09) labels Aug 26, 2026

pdurbin reviewed Aug 27, 2026

View reviewed changes

cmbz modified the milestones: 6.14, 6.13 Aug 27, 2026

updated label

7723018

pdurbin moved this from Ready for Review ⏩ to In Progress 💻 in IQSS Dataverse Project Sep 2, 2026

pdurbin assigned ffritze Sep 2, 2026

		@@ -0,0 +1,38 @@
		Analogue to the addition of a termURI field to the keywords in the citation metadata blocks, the same idea should also be applied to the topicClassification fields:

		add a new subfield topicClassTermURI to the citation metadata block

Uh oh!

Conversation

ffritze commented Aug 14, 2026 • edited by jggautier Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

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!

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!

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!

coveralls commented Sep 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ffritze commented Aug 14, 2026 •

edited by jggautier

Loading

pdurbin Aug 18, 2026 •

edited

Loading