Upgrade instructions

This pages gives an overview of the steps you need to take when you upgrade to a Blueriq release.

As a best practice

backup your repository
backup your database before running scripts
backup your spring.config.additional-location directory ([Blueriq installation directory]\Runtime)
backup any config files you have altered under [Blueriq installation directory]\Services

before you start the upgrade.

Property files for messages

Message properties are treated differently than other properties. When you put messages*.properties (e.g. messages_nl-NL.properties) files in the Runtime config location, this will completely overwrite all the properties in the matching messages*.properties file in the WAR. Meaning none of the properties from the WAR in that properties file will be loaded anymore. Therefore with every Runtime upgrade you should compare the properties in your own custom messages*.properties with the ones present in the messages*.properties from the WAR.

On this page:

Using the installer

Backup property files

When upgrading from 13.x to a newer version, it is advised to make a backup of your property files. The property files will be overridden by the installer with the new version. This new version will not have the previously used values. After upgrading there are two ways to adjust the properties so they fit the previous configuration:

Manually set the previously used values, like username/passwords, URL's, etc..., again.
Another possibility is to follow the upgrade instructions and manually adjust your backup-ed property files according to it and copy them back into the spring config locations.

Backup H2 database

When the external H2 database is used on your local installation and preservation of the data is required after updating to a newer Blueriq version (starting from 10.0), a backup of the H2 database should be made before upgrading and put back after the installation. If the upgrade instructions of the release contain any upgrade scripts, these should be executed manually after the backup is put back.

Upgrade for every type of release

If you as a customer are building a custom war, you should merge the files from the projectstarters of the new Blueriq release with your local equivalent files. The projectstarters are located in "\Runtime\Java\Webapp\Development\" of the Blueriq release zip. Please choose the the projectstater.zip for your application platform.

Check if the services need to be upgraded (for example but not limited to the customerdata service)

Upgrade to a release within a major release

Example: upgrade from 13.0 to the latest 13 release

Within a major release you can upgrade by running the installer. This ensures that your Blueriq installation including your repository and configuration are automatically upgraded to the new release.

Please note that there can be release specific upgrade instructions that you have to take into account, also for intermediate releases between the release you are using and the one you are upgrading to.

Upgrade to a major release

Example: upgrade from 9.5 to the latest 10 release

When you upgrade to a major release, you must upgrade to every intermediate major release as well. This does not mean that you have to install every intermediate version. You can install the latest 10 and migrate directly to that version. You are however obliged to execute the upgrade instructions of each release that you have missed in the mean time. So in the case of the example, you first upgrade to the latest 10 release and then the upgrade instructions for. 9.6, 9.7, 9.8, 9.9 and 10.0 and all other minors in between. Also check the bufix releases that you have missed for relevant information.

Before you start

Check your license: make sure you have a license for the major release you are upgrading to
Check your platform: check our platform support to see whether the platform you are using is still supported by the major release you are upgrading to
Read the release notes: read up on the new functionality that is available in the major release and intermediate releases by studying the release notes
Read release specific upgrade instructions: Some releases require specific steps when you upgrade to that release. These are documented in the upgrade instructions per release. Do not forget the upgrade instructions from intermediate releases.
When using deprecated features, it is highly recommended that you upgrade to the latest patch release available in the major release before upgrading to the next.Then you can refactor your model and code to remove the use of deprecated features before upgrading to the major where these features are removed from the software.

Performing the upgrade

A major release of Blueriq is always a new installation. This allows to install different majors next to each other. An upgrade to a major therefore consists of a fresh installation of that major and then copying the repository and configuration from the old major to that new installation.

Please note that there can be release specific upgrade instructions that you have to take into account during the upgrade.

Backup Encore (Studio) repositories

Create a backup of the Encore (Studio) repositories using the Blueriq Backup Tool, more information can be found here.

Installation of the new major

For the installation of Blueriq please read our installation guide.

Restoring studio server data storage and copying configuration

Restore the Encore (studio) backup to the new installation. Restore the backup in to the new installation using the same Blueriq Backup Tool
Copy the Encore users & roles. This can be accomplished by copying the [Blueriq installation directory]\Studio\Configuration\Security directory and sub directories to the new installation.
Copy the Runtime configuration. This can be accomplished by specifying your Spring Config Location.

Runtime Plugins

Version 10.x and higher: The runtime plugins are packaged together with the runtime as components, and no manual action is required.