Review Datasets #11753

pdurbin · 2025-08-19T19:15:23Z

What this PR does / why we need it:

Makes creation of review datasets possible.

Which issue(s) this PR closes:

Special notes for your reviewer:

This is a decent entry point for the docs: https://dataverse-guide--11753.org.readthedocs.build/en/11753/user/dataset-management.html#review-datasets
I'm aware that the displayName and description of a dataset type cannot be changed via API. A workaround is to use properties files. On a related note, perhaps these two classes should be refactored into a single class for updating dataset types?
- https://github.com/IQSS/dataverse/blame/v6.9/src/main/java/edu/harvard/iq/dataverse/engine/command/impl/UpdateDatasetTypeLinksToMetadataBlocksCommand.java
- https://github.com/IQSS/dataverse/blob/v6.9/src/main/java/edu/harvard/iq/dataverse/engine/command/impl/UpdateDatasetTypeAvailableLicensesCommand.java
I'm aware that you can't unset allowedDatasetTypes from a collection. You can't set it back to null. I documented a workaround, which is to set it to "dataset". This will remove the connection between a dataset type and a collection to allow you to delete the dataset type.

Suggestions on how to test this:

Do all the setup at https://dataverse-guide--11753.org.readthedocs.build/en/11753/admin/dataverses-datasets.html#review-datasets-setup
Create a review dataset (via API)
Test DataCite changes; confirm that DataCite received <resourceType resourceTypeGeneral="Other">Review</resourceType>
Test data citation changes for the CSL format. The "type" can now be "dataset", "software", or "review".

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

Yes, the facets under "Dataset Type" are changing from human readable and translatable ("Dataset" from getDisplayName) to machine-readable ("dataset" from getName). This is to fix #11758 and IQSS/dataverse-frontend#809

Before

After

Note that I'm aware that even after this fix, when you click any of the machine readable names, such as "software", the friendly name will appear above the search results like this:

I left a note in the xhtml about this. I don't think this is worth fixing on the JSF side. In the SPA, the values will consistently be the machine readable versions, such as "software" (lower case).

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

Included

coveralls · 2025-08-19T19:21:41Z

coverage: 24.334% (-0.02%) from 24.35%
when pulling e65d76d on 11747-review-dataset-type
into 0b78ff8 on develop.

src/main/java/edu/harvard/iq/dataverse/DataCitation.java

jggautier · 2025-08-27T21:22:55Z

Next Tuesday I'll add to this PR . properties files for the two metadata blocks

jggautier · 2025-09-02T13:23:57Z

I put the two properties files for the metadata blocks into this branch's src/main/java/propertyFiles folder

doc/sphinx-guides/source/user/dataset-management.rst

poikilotherm

Here's a first review. Tried to be thorough, might not have captured everything.

src/test/java/edu/harvard/iq/dataverse/api/UtilIT.java

src/main/java/edu/harvard/iq/dataverse/api/Datasets.java

poikilotherm · 2026-02-10T13:47:40Z

src/main/java/edu/harvard/iq/dataverse/dataset/DatasetType.java

                .add("availableLicenses", availableLicenses);
    }

+    public String getDisplayName(Locale locale) {


Is it really necessary to duplicate the code for displayName and description?

Of course not. I was being lazy, thinking about this:

poikilotherm · 2026-02-10T13:48:33Z

src/main/java/edu/harvard/iq/dataverse/dataset/DatasetType.java

                .add("availableLicenses", availableLicenses);
    }

+    public String getDisplayName(Locale locale) {


All the log messages should use lambas to only execute the string concatenations when actually being logged.

Where were you when @michbarsinai opened the following issue? 😅

Logging guidelines in the coding style document should be updated #4284

Should we re-open it? 🤔

@poikilotherm as an IntelliJ user, you want me to click on one of these?

poikilotherm · 2026-02-10T13:49:05Z

src/main/java/edu/harvard/iq/dataverse/dataset/DatasetType.java

+            logger.fine("Locale is English, returning default display name: " + displayName);
+            return displayName;
+        }
+        String propertiesFile = "datasetTypes_" + locale.toLanguageTag() + ".properties";


This burns unnecessary CPU cycles every time it's looked up but is only used for a debugging log message.

I'm happy to change this. What do you suggest?

src/main/java/edu/harvard/iq/dataverse/engine/command/impl/AbstractCreateDatasetCommand.java

poikilotherm · 2026-02-10T15:02:51Z

src/main/java/edu/harvard/iq/dataverse/api/Datasets.java

@@ -5853,7 +5867,7 @@ public Response deleteDatasetType(@Context ContainerRequestContext crc, @PathPar
        try {
            idToDelete = Long.parseLong(doomed);


This method should also allow using a name or an ID, as the other methods. This is especially important now that we return a list of names for allowed types for a collection.

Sure, I can add delete by name. When I do, I'll also resolve #11753 (comment)

poikilotherm · 2026-02-10T15:12:19Z

src/main/java/edu/harvard/iq/dataverse/engine/command/impl/UpdateDataverseAttributeCommand.java

+
+        List<String> invalidDatasetTypes = new ArrayList<>();
+
+        String[] allowedDatasetTypeNames = stringValue.split(",");


Technically, all of this class does things typically located in a service layer. But fine... At least, we should not use a simple comma separated list - a JSON list is much cleaner, as we are using a JSON API and other places like settings etc also support using of JSON Arrays. At some point we really should refactor the API, service and command layer to deal with all of this in a less chaotic way.

As I said on the call yesterday (thanks!), I'm a bit weirded out by the idea of passing JSON in a query parameter, but sure, let's keep talking about it.

poikilotherm · 2026-02-10T15:29:52Z

src/main/java/edu/harvard/iq/dataverse/engine/command/impl/UpdateDataverseAttributeCommand.java

+            }
+        }
+
+        if (!invalidDatasetTypes.isEmpty()) {


It is debatable if the validation of the names should be done in this class or in a separate service layer. As we currently don't have a service layer for DatasetTypes, maybe this one will do. (This is a design flaw of our REST API, which mixes being entry and service layer a lot. As stated above, this whole class mimics a service layer...)

Maybe we're due for another rewrite! 😅

src/main/java/edu/harvard/iq/dataverse/engine/command/impl/UpdateDataverseAttributeCommand.java

Also, add note about how "Data Type" (kindOfData) metadata field is used in resourceType for DataCite exports. See also datacite/datacite-suggestions#214

…12115

src/main/java/propertyFiles/datasetTypes.properties

Co-authored-by: Julian Gautier <[email protected]>

src/main/resources/db/migration/V6.9.0.1.sql

Co-authored-by: Julian Gautier <[email protected]>

github-actions · 2026-02-12T22:20:19Z

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:11747-review-dataset-type

ghcr.io/gdcc/configbaker:11747-review-dataset-type

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.

pdurbin added this to IQSS Dataverse Project Aug 19, 2025

pdurbin moved this to In Progress 💻 in IQSS Dataverse Project Aug 19, 2025

pdurbin self-assigned this Aug 19, 2025

pdurbin mentioned this pull request Aug 19, 2025

Add "review" scholarly research object #11747

Open

This comment has been minimized.

Sign in to view

pdurbin commented Aug 21, 2025

View reviewed changes

src/main/java/edu/harvard/iq/dataverse/DataCitation.java Outdated Show resolved Hide resolved

pdurbin force-pushed the 11747-review-dataset-type branch from dc893bc to 7c629a2 Compare August 26, 2025 14:26

This comment has been minimized.

Sign in to view

cmbz added the Size: 10 A percentage of a sprint. 7 hours. label Aug 27, 2025

pdurbin moved this from In Progress 💻 to Ready for Review ⏩ in IQSS Dataverse Project Aug 27, 2025

pdurbin removed their assignment Aug 27, 2025

pdurbin marked this pull request as ready for review August 27, 2025 19:08

cmbz added the Project: Trusted Data label Aug 27, 2025

jggautier changed the title ~~add "review" dataset type~~ add "review" dataset type and related metadata blocks Aug 27, 2025

cmbz added the FY26 Sprint 5 FY26 Sprint 5 (2025-08-27 - 2025-09-10) label Aug 28, 2025

This comment has been minimized.

Sign in to view

stevenwinship reviewed Sep 3, 2025

View reviewed changes

doc/sphinx-guides/source/user/dataset-management.rst Outdated Show resolved Hide resolved

cmbz added the FY26 Sprint 6 FY26 Sprint 6 (2025-09-10 - 2025-09-24) label Sep 14, 2025

pdurbin force-pushed the 11747-review-dataset-type branch from ef2f080 to db4c453 Compare September 17, 2025 18:08

This comment has been minimized.

Sign in to view

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

scolapasta assigned pdurbin Sep 18, 2025

cmbz added the FY26 Sprint 7 FY26 Sprint 7 (2025-09-24 - 2025-10-08) label Sep 24, 2025

pdurbin force-pushed the 11747-review-dataset-type branch from db4c453 to 44e2c17 Compare September 26, 2025 13:53

This comment has been minimized.

Sign in to view

pdurbin force-pushed the 11747-review-dataset-type branch from 44e2c17 to e41d0e3 Compare September 30, 2025 20:07

This comment has been minimized.

Sign in to view

pdurbin removed their assignment Feb 9, 2026

This comment has been minimized.

Sign in to view

pdurbin changed the title ~~add "review" dataset type and related metadata blocks~~ Review Datasets Feb 10, 2026

poikilotherm requested changes Feb 10, 2026

View reviewed changes

pdurbin added 2 commits February 10, 2026 11:58

Merge branch 'develop' into 11747-review-dataset-type

b8b4a07

assert resourceTypeGeneral=Other for review datasets #11747

8091c45

This comment has been minimized.

Sign in to view

pdurbin force-pushed the 11747-review-dataset-type branch from c075909 to 8091c45 Compare February 10, 2026 17:28

send <resourceType resourceTypeGeneral="Other">Review to DataCite #11747

e65d76d

Also, add note about how "Data Type" (kindOfData) metadata field is used in resourceType for DataCite exports. See also datacite/datacite-suggestions#214

This comment has been minimized.

Sign in to view

ekraffmiller mentioned this pull request Feb 11, 2026

Update Get Collection use case to include available dataset types IQSS/dataverse-client-javascript#425

Open

Merge branch 'develop' into 11747-review-dataset-type

e2ec594

cmbz added the FY26 Sprint 17 FY26 Sprint 17 (2026-02-11 - 2026-02-25) label Feb 11, 2026

pdurbin self-assigned this Feb 12, 2026

switch allowedDatasetTypes in entity from String to a ManyToMany List #…

d2f12df

…12115

This comment has been minimized.

Sign in to view

jggautier reviewed Feb 12, 2026

View reviewed changes

src/main/java/propertyFiles/datasetTypes.properties Outdated Show resolved Hide resolved

improve description of a dataset

060215f

Co-authored-by: Julian Gautier <[email protected]>

jggautier reviewed Feb 12, 2026

View reviewed changes

src/main/resources/db/migration/V6.9.0.1.sql Outdated Show resolved Hide resolved

shorten description of dataset and match properties file

ca8a7c6

Co-authored-by: Julian Gautier <[email protected]>

This comment has been minimized.

Sign in to view

pdurbin added 2 commits February 12, 2026 15:41

cleanup: logging, javadoc, and comments #11747

8280947

rename class: first character upper case

f48b48e

This comment has been minimized.

Sign in to view

a description for "review" dataset type

403a32d

		@@ -5853,7 +5867,7 @@ public Response deleteDatasetType(@Context ContainerRequestContext crc, @PathPar
		try {
		idToDelete = Long.parseLong(doomed);


		List<String> invalidDatasetTypes = new ArrayList<>();

		String[] allowedDatasetTypeNames = stringValue.split(",");

Review Datasets #11753

Are you sure you want to change the base?

Review Datasets #11753

Conversation

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

Uh oh!

Before

After

Uh oh!

coveralls commented Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment has been minimized.

Uh oh!

This comment has been minimized.

jggautier commented Aug 27, 2025

Uh oh!

jggautier commented Sep 2, 2025

Uh oh!

This comment has been minimized.

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

poikilotherm left a comment

Choose a reason for hiding this comment

Uh oh!

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!

pdurbin Feb 12, 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!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pdurbin Feb 11, 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!

poikilotherm Feb 10, 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!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

github-actions bot commented Feb 12, 2026

Uh oh!

Reviewers

Assignees

Labels

pdurbin commented Aug 19, 2025 •

edited

Loading

coveralls commented Aug 19, 2025 •

edited

Loading

pdurbin Feb 12, 2026 •

edited

Loading

pdurbin Feb 11, 2026 •

edited

Loading

poikilotherm Feb 10, 2026 •

edited

Loading