You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Dataverse now supports review datasets, a type of dataset that can be used to review resources such as other datasets in the Dataverse installation itself or various resources in external data repositories. APIs and a new "review" metadata block (with an "Item Reviewed" field) are in place but the UI for this feature will only available in a future version of the new React-based [Dataverse Frontend](https://github.com/IQSS/dataverse-frontend). See also the [guides](https://dataverse-guide--11753.org.readthedocs.build/en/11753/api/native-api.html#add-dataset-type), #11747, #12015, #11887, #12115, and #11753.
6
+
7
+
## Other Features Added
8
+
9
+
- Citation Style Language (CSL) output now includes "type:software" or "type:review" when those dataset types are used. See the [guides](https://dataverse-guide--11753.org.readthedocs.build/en/11753/api/native-api.html#get-citation-in-other-formats) and #11753.
10
+
11
+
## Updated APIs
12
+
13
+
- The Change Collection Attributes API now supports `allowedDatasetTypes`. See the [guides](https://dataverse-guide--11753.org.readthedocs.build/en/11753/api/native-api.html#change-collection-attributes), #12115, and #11753.
14
+
15
+
## Bugs Fixed
16
+
17
+
- 500 error when deleting dataset type by name. See #11833 and #11753.
18
+
- Dataset Type facet works in JSF but not the SPA. See #11758 and #11753.
19
+
20
+
## Backward Incompatible Changes
21
+
22
+
### Dataset Types Must Be Allowed, Per-Collection, Before Use
23
+
24
+
In previous releases of Dataverse, as soon as additional dataset types were added (such as "software", "workflow", etc.), they could be used by all users when creating datasets (via API only). As of this release, on a per-collection basis, superusers must allow these dataset types to be used. See #12115 and #11753.
"value": "\"Statistical Variable Explorer - Data Commons.\" Datacommons.org, 2026, datacommons.org/tools/statvar#sv=Percent_Person_Children_WithAsthma. Accessed 9 Mar. 2026.",
Copy file name to clipboardExpand all lines: doc/sphinx-guides/source/admin/dataverses-datasets.rst
+58Lines changed: 58 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -109,6 +109,64 @@ If the :AllowedCurationLabels setting has a value, one of the available choices
109
109
110
110
Individual datasets can be configured to use specific curationLabelSets as well. See the "Datasets" section below.
111
111
112
+
.. _review-datasets-setup:
113
+
114
+
Configure a Collection for Review Datasets
115
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
116
+
117
+
:ref:`review-datasets-user` are a specialized type of dataset that can be used to review resources (such as datasets) in the Dataverse installation itself or resources in external data repositories.
118
+
119
+
Review datasets require some setup, as described below.
120
+
121
+
Load the Review Metadata Block
122
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
123
+
124
+
First, download the Review metadata block tsv file from :ref:`experimental-metadata`.
125
+
126
+
Then, load the block and update Solr. See the following sections of :doc:`metadatacustomization` for details:
127
+
128
+
- :ref:`load-tsv`
129
+
- :ref:`update-solr-schema`
130
+
131
+
Create and Enable Custom "Rubric" Metadata Blocks
132
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133
+
134
+
The Review metadata block gives you a few basic fields common to all reviews such as the URL of the item being reviewed.
135
+
136
+
You probably will want to create your own metadata blocks specific to the resources you are reviewing, your own "rubric". See :doc:`metadatacustomization` for details on creating and enabling custom metadata blocks.
137
+
138
+
Instead of creating a new custom metadata block from scratch (if you simply want to evaluate the feature, for example), you can use the metadata blocks at https://github.com/IQSS/dataverse.harvard.edu
139
+
140
+
After loading the block, don't forget to update the Solr schema!
141
+
142
+
Create a Review Dataset Type
143
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
144
+
145
+
Review datasets are built on the :ref:`dataset-types` feature. Dataset types can only be created via API so follow the steps under :ref:`api-add-dataset-type`. Copy and paste from below or download :download:`review.json <../../../../scripts/api/data/datasetTypes/review.json>` and pass it to the API.
Non-dataset types, such as the "review" type, are only available when a collection admin has enabled them, via API.
162
+
163
+
Using the API :ref:`collection-attributes-api`, change the ``allowedDatasetTypes`` attribute so that it includes "review". If you only want to allow reviews, you can pass just ``review``. If you want to allow multiple dataset types, you can pass a comma-separated list, such as ``review,dataset``.
164
+
165
+
Invite Users to Create Review Datasets
166
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
167
+
168
+
At this point, users should be able to create review datasets via API, if you gave them permission on the collection. You can point them to :ref:`creating-a-review-dataset` for details.
Copy file name to clipboardExpand all lines: doc/sphinx-guides/source/api/changelog.rst
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,7 @@ This API changelog is experimental and we would love feedback on its usefulness.
10
10
v6.9
11
11
----
12
12
13
+
- When creating datasets that contain a datasetType, that datasetType must be allowed at the collection level. This can be accomplished by passing ``allowedDatasetTypes`` to the :ref:`collection-attributes-api` API.
13
14
- The POST /api/admin/makeDataCount/{id}/updateCitationsForDataset processing is now asynchronous and the response no longer includes the number of citations. The response can be OK if the request is queued or 503 if the queue is full (default queue size is 1000).
14
15
- The way to set per-format size limits for tabular ingest has changed. JSON input is now used. See :ref:`:TabularIngestSizeLimit`.
15
16
- In the past, the settings API would accept any key and value. This is no longer the case because validation has been added. See :ref:`settings_put_single`, for example.
0 commit comments