Skip to content

Commit

Permalink
updates before PR
Browse files Browse the repository at this point in the history
  • Loading branch information
@djbrooke
djbrooke committed May 18, 2021
1 parent 70ccc15 commit aae9e33
Showing 1 changed file with 13 additions and 25 deletions.
38 changes: 13 additions & 25 deletions doc/release-notes/5.5-release-notes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Users trying to download a zip file larger than the Dataverse installation's :zi

### Guidelines on Depositing Code

User Guide...
The Software Metadata Working Group has created guidelines on depositing research code in a Dataverse installation. Learn more in the [Dataset Management section](https://guides.dataverse.org/en/latest/dataset-management) of the Dataverse Guides.

### New Metrics API

Expand All @@ -26,37 +26,34 @@ Users can retrieve new types of metrics and per-collection metrics. The new capa

Newly-supported major use cases in this release include:

- Sort Users. (Issue #xxx, PR #xxx)
- New Metrics API
- Search Geospatial Other
- Research code guidelines
- Aux Files
- New Download Workflow
- Users can now select and download Auxiliary files through the UI. (Issue #7400, PR #7729)
- Users attempting to download zip files above the installation's size limit will receive better messaging and be directed to other download options. (Issue #7714, PR #7806)
- Superusers can now sort users on the Dashboard. (Issue #7814, PR #7815)
- Users can now access expanded and new metrics through a new API (Issue #7177, PR #7178)
- Dataverse collection administrators can now add a search facet on their collection pages for the Geospatial metadatablock's "Other" field, so that others can narrow searches in their collections using the values entered in that "Other" field (Issue #7399, PR #7813)
- Depositors can now receive guidance about depositing code into a Dataverse installation (PR #7717)

## Notes for Dataverse Installation Administrators

### Zip Limit for installations running the external zipper

If your installation is running the experimental zipper service, note that the zipper service ignores the :zipdownload limit. If you'd like users to still download large zips, this should be set to an appropriate value.

### Simple Search Fix for Solr Configuration

The introduction in v4.17 of a schema_dv_mdb_copies.xml file as part of the Solr configuration accidentally removed the contents of most metadata fields from index used for simple searches in Dataverse (i.e. when one types a word without indicating which field to search in the normal search box). This was somewhat ameliorated/hidden by the fact that many common fields such as description were still included by other means.

This release removes the schema_dv_mdb_copies.xml file and includes the updates needed in the schema.xml file. Installations with no custom metadata blocks can simply replace their current schema.xml file for solr, restart Solr, and run a ['Reindex in Place' as described in the guides](https://guides.dataverse.org/en/latest/admin/solr-search-index.html#reindex-in-place).

Installations using custom metadata blocks should manually copy the contents of their schema_dv_mdb_copies.xml file (excluding the enclosing `<schema>` element and only including the `<copyField>` elements) into their schema.xml file, replacing the section between
Installations using custom metadata blocks should manually copy the contents of their schema_dv_mdb_copies.xml file (excluding the enclosing `<schema>` element and only including the `<copyField>` elements) into their schema.xml file, replacing the section between

`<!-- Dataverse copyField from http://localhost:8080/api/admin/index/solr/schema -->`

and

`<!-- End: Dataverse-specific -->`.

In existing schema.xml files, this section currently includes only one line:
In existing schema.xml files, this section currently includes only one line:

`<xi:include href="schema_dv_mdb_copies.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />`.

In this release, that line has already been replaced with the default set of `<copyFields>`.
In this release, that line has already been replaced with the default set of `<copyFields>`.
It doesn't matter whether schema_dv_mdb_copies.xml was originally created manually or via the recommended updateSchemaMDB.sh script and this fix will work with all prior versions of Dataverse from v4.17 on. If you make further changes to metadata blocks in your installation, you can repeat this process (i.e. run updateSchemaMDB.sh, copy the entries in schema_dv_mdb_copies.xml into the same section of schema.xml, restart solr, and reindex.)

Once schema.xml is updated, solr should be restarted and a ['Reindex in Place'](https://guides.dataverse.org/en/latest/admin/solr-search-index.html#reindex-in-place) will be required. (Future Dataverse versions will avoid this manual copy step.)
Expand Down Expand Up @@ -89,15 +86,11 @@ Most of your API users have likely figured it out already, since you enabled S3

The "deactivated" field on the Authenticated User table has been updated to be a non-nullable field. When the field was added in version 5.3 it was set to 'false' in an update script. If for whatever reason that update failed in the 5.3 deploy you will need to re-run it before deploying 5.5. The update query you may need to run is: UPDATE authenticateduser SET deactivated = false WHERE deactivated IS NULL;

## New JVM Options and Database Settings

Check for new JVM and DB options.

## Notes for Tool Developers and Integrators

### S3 Download Redirects

See above note about download redirects. If your application integrates with the Dataverse using the APIs, you may need to change how redirects are handled in your tool or integration.
See above note about download redirects. If your application integrates with the the Dataverse software using the APIs, you may need to change how redirects are handled in your tool or integration.

## Complete List of Changes

Expand Down Expand Up @@ -131,16 +124,11 @@ If this is a new installation, please see our [Installation Guide](https://guide

- `$PAYARA/bin/asadmin deploy dataverse-5.5.war`

8\. Restart payara
5\. Restart payara

- `service payara stop`
- `service payara start`

9\. Reload Citation Metadata Block:

`wget https://github.com/IQSS/dataverse/releases/download/v5.4/citation.tsv`
`curl http://localhost:8080/api/admin/datasetfield/load -X POST --data-binary @citation.tsv -H "Content-type: text/tab-separated-values"`

## Additional Release Steps

1\. Update Geospatial Metadata Block (if used)
Expand Down

0 comments on commit aae9e33

Please sign in to comment.