Release 1.9

Release Notes

The 1.9 release of ReDBox and Mint (1.4 Fascinator) introduces improvements in functionality and integration:

  1. Improvements to the data collection form to capture licence type, multiple descriptions in HTML format, free text input of party identifiers and multiple secondary identifiers for the collection.
  2. Support for the RIF-CS 1.6.1 schema
  3. Support for referencing parties via ORCID including the ability to search for external ORCIDs from the user interface
  4. A new RESTful Web Service API that gives the ability to create, edit and discover records.
  5. Support for running using the Java 8 virtual machine
  6. New upgrade script to assist with the upgrade configuration process


See the Downloads page.

Upgrading to 1.9

Note While upgrading ReDBox and Mint, you may wish to consider your Java runtime environment to the latest version 8. While ReDBox 1.9 will run on previous versions of the JVM, upgrading the JRE will ensure full support of the platform and future versions of ReDBox may take advantage of the latest Java features.

New to the upgrade process in 1.9 is the inclusion of an upgrade script (tf_upgrade) to check the configuration of the application and to optionally enable new features. Note that if you are currently running version 1.6.2 or lower, you must first upgrade to 1.8. Please see here for instructions.


  1. Download the application tarballs (ReDBox and Mint)
  2. Shutdown ReDBox and Mint.
  3. Remove the server/lib and server/plugin directories of ReDBox and Mint
  4. Extract the tarballs and copy them over the existing ReDBox and Mint
  5. Overlay your changes from your new format institutional build
  6. Run the (tf_upgrade.bat in Windows) script to check your config and make any changes needed. More information on upgrade script for 1.9 is available here.
  7. Restart ReDBox and Mint
  8. Run the (tf_restore.bat in Windows) scripts to migrate the data (This script only needs to be run in ReDBox as there are no schema changes to Mint)

1.9 Upgrade Script

This page is to walk through the execution of the upgrade script, explaining what it does at each step and providing information (links to other documentation) that describes it in more detail.

The server file, is an upgrade configuration script, run on the command-line, which runs through some basic Q and A for the user to answer about specific configurations for redbox or mint.

As the script steps through prompts for the user, it backs up the current configuration files affected by the script to another directory (e.g, /pre-upgrade-backup). The questions are either yes/no or short answers for the user to provide. Running the upgrade

The upgrade script is executed in a similar manner to

  1. Change into the server directory in your redbox installation. e.g.: cd /opt/redbox/server
  2. Ensure that your redbox installation is shutdown (and afterwards check that the server is no longer running): sudo -u redbox ./tf_server stop
  3. Find and execute the script,, as the redbox installation user: sudo -u redbox ./
  4. In the example, above the redbox user is redbox

If the script is executed correctly, you should now see some command line prompts for you to enter details about your installation upgrade. Redbox upgrade process

Currently, the redbox upgrade configuration script will step through the following prompts:

Verifies correct upgrade version

Checks if changes have been made to the dataset configuration templates

Curation relations which should be excluded

Record as location

Configure the new rifcs transformer

Note: At the 1.9 release, both the rifcs velocity template and the rifcs groovy script are compatible with rif-cs version 1.6.1. However, in the future (TBA), the rifcs velocity template will become deprecated, with revisions made only to the groovy script.

Create the api user configuration


Mint upgrade process

Currently, the mint upgrade configuration script will step through the following prompts:

Verify correct upgrade version

Technical Details

It is not necessary to understand the high-level technical detail by which the upgrade process runs. It is provided here merely as a quick technical reference for those who wish to modify the upgrade according to their institutional requirements.