Review Datasets

[pdurbin]

What this PR does / why we need it:

Makes creation of review datasets possible.

Which issue(s) this PR closes:

• Closes Add "review" scholarly research object #11747
• Closes Design "Item Reviewed" metadata fields #12015
• Closes Allow control over which dataset types are available, per collection #12115
• Closes Dataset types should have a display name and a description #11887
• Closes investigate why the Dataset Type facet works in JSF but not the SPA #11758
• Closes 500 error when deleting dataset type by name #11833

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. I opened this issue to handle this and some additional refactoring I think we should do:
  • Some fields for dataset types can't be edited (displayName, description) #12192
• 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:

Dataset Type facet values are now lowercase

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).

Review Metadata/Item Reviewed

Also, a "Review Metadata" block has been added. The primary field is "Item Reviewed" (#12015) and it looks like this (see IQSS/dataverse-frontend#876 (comment) for how it looks in the SPA):

Dataset Type dropdown (SPA only)

The "Dataset Type" dropdown does not appear in JSF but here's how it looks in the SPA (see IQSS/dataverse-frontend#876 (comment) for more context):

If allowedDatasetTypes does not include "dataset"

If you have configured a collection to only allow "review" (or only "software", or only "review" and "software" or whatever but not "dataset") for allowedDatasetTypes, you will get an error in JSF if you try to create a "dataset" dataset type (which is the only dataset type JSF knows how to create), like this:

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

Included

[coveralls]

coverage: 24.619% (-0.03%) from 24.644%
when pulling 92c95e6 on 11747-review-dataset-type
into d988622 on develop.

[jggautier]

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

[jggautier]

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

[pdurbin]

Based on testing, I made the following changes:

2b03a64 better handling of collections disallowing "dataset" datasetType #12115 #11747
38ec9a7 move "create collection" step down, just before "allow type" #11747
bebb87b add sample file dataset-create-review.json #11747

I also opened the following issue which can be observed in this pull request as well as the "develop" branch:

• linkedMetadataBlocks, dataset types, and fields set as required in tsv for metadata blocks #12196

[github-actions]

📦 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.