This page is for system administrators who are upgrading an existing PhixFlow instance from one release to another. This page explains the standard steps that you should always follow.

Warning

Some releases contain special instructions.

When planning an upgrade, please check the special instructions for each intermediate release and follow the additional steps as indicated.

Planning your Upgrade
Anchor
preparation
preparation

Check Supported Versions and Special Instructions

Please read the System Requirements and Compatibility page. Check for any special upgrade instructions between your current and target versions of PhixFlow.

Ensure that your versions of:

the database
Tomcat
Java

are supported in the planned upgrade.

NoteIf any of these items need updating, please contact your IT team several weeks

in

advance of

the planned upgrade.

Panel

borderColor	#7da054
titleColor	white
titleBGColor	#7da054
borderStyle	solid
title	Sections on this page

Table of Contents

maxLevel	3
indent	12px
style	none

Note
If any of these items need updating, please contact your IT team several weeks in advance of the planned upgrade.

Check Java and Database Connectors

If Java needs upgrading, you must verify that any JDBC connectors you have installed to non-standard databases are still supported. The standard databases supported by PhixFlow are Oracle, MS SQL Server and MySQL/ MariaDBMySQL. The drivers needed to connect to these databases are shipped with PhixFlow, and connections to external databases through PhixFlow data sources are supported by these drivers; see Datasource.

However, if you have connections to external databases other than these - for example, Netezza, Teradata, DB2 - then you will have installed JDBC drivers for these in the folder [tomcat home]/lib. You must check that your current version of each installed driver is compatible with the new version of Java, and if not, obtain a new version of the JDBC driver from the supplier.

How to Upgrade

Step 1 Backup your Database

Ensure that you have a recent, full backup of your PhixFlow database. If you need to rollback (see "Rollback Upgrade" below), your PhixFlow configuration and data will revert to this point.

Tip

We also recommend that you:

Review your installation for any remaining uses of the discontinued features mentioned in the release notes. All data related to the use of these features will be removed when PhixFlow is migrated to the new version.
Backup all tables except those whose names begin with a 'zz'. This backs up the data tables that do not contain table data.

Step 2 Review Special Upgrade Instructions

Review the Special Upgrade Instructions for all the intermediate releases between your current version and the version to which you are upgrading. make a note of any that will need to be performed during the upgrade.

Step 3 Stop Tomcat and Delete the Work Directory

Stop the Tomcat service.
Note
PhixFlow will not be available to users until the upgrade is complete and you restart Tomcat.
Delete the Tomcat <tomcat base>/work directory. For example in a Linux installation, enter:
Code Block
rm -r /opt/tomcat/work

Step

3

4 Upgrade the Environment

If necessary, upgrade to supported versions of Java, Tomcat and your database: Oracle, SQL Server or MySQL / MariaDBMySQL. See Planning your Upgrade, above.

Remember, if you are upgrading are Upgrading Tomcat, to restore any JDBC drivers needed for any data sources that use database technologies or versions not supported for PhixFlow's own connections. Make sure that any additional JDBC drivers you use are placed in:

Code Block
[tomcat home]/lib

Step

4

5 Unzip the PhixFlow Release

Unzip the PhixFlow release package into a temporary directory.

We will refer to the new PhixFlow release directory as $RELEASE and its corresponding Tomcat directory as $TOMCAT.

Step

5

6 Install the New Webapp into Tomcat

Move the live PhixFlow installation directory, $TOMCAT/webapps/phixflow, to an archive location.

For example, on Linux: mv $TOMCAT/webapps/phixflow $ARCHIVE/phixflow-<current date>

Copy $RELEASE/webapp/phixflow to $TOMCAT/webapps.

For example, on Linux: cp -r $RELEASE/webapp/phixflow $TOMCAT/webapps/phixflow

Tip
From PhixFlow version 11.0.1, the database schema updates are recorded in the System Console → Audit Summary Tab, with the Action Description starting with “Executing db\upgrade”.

Step 7 Configure the Webapp

The webapp configuration step depends on which version you are upgrading from and to. Please follow the appropriate section below

Expand

title	Upgrading an existing Version 11 or latest system

Upgrading an existing Version 11 or latest system

Automated upgrading of the database schema is now supported.

In the archive of the live installation, go to the $TOMCAT/webapps/phixflow/WEB-INF/classes/ directory. Copy the following files into the corresponding directory in the new PhixFlow webapp if they exist:

phixflow.properties
local.properties
logback.phixflow.xml

Review the Special Upgrade Instructions if there are any recommendations for additional settings.

Company Logo

If you have configured PhixFlow to show your company logo, also copy $ARCHIVE/phixflow-<current date>/gui/images/customerLogo.svg from the archive to the corresponding directory in the new PhixFlow webapp.

Soft Links

If you have configured soft links (also called symlinks or datalinks) between PhixFlow and Tomcat, recreate them. Example scripts are provided below, these examples assume your application is called phixflow. For more details see Configuring Soft Links.

Windows

Code Block
mklink /D C:\app\tomcat\webapps\phixflow\datalink C:\app\phixflow\data\phixflow\datalink

Linux

Code Block
sudo ln -sf /opt/phixflow/data/phixflow/datalink /opt/tomcat/webapps/phixflow/datalink

Expand

title	Upgrading to version 11 or later from pre version 11

Upgrading to version 11 or later from pre version 11

Direct upgrading from version 8.3.18 onwards to version 11.0.1 or later is supported with automatic database schema upgrade. (8.3.24 for 11.0.0).

This process requires migrating the configuration settings from the modified xml settings into the local.properties file. It is assumed a keystore was previously configured.

Review the files in the archive at the following location $ARCHIVE/phixflow-<current date>/WEB-INF/classes/

Property	Previous File	Previous location	Notes
db.url	phixflow-datasource.xml	`<property` `name="url">` `<value>CONNECTION-STRING</value>` `</property>`
db.usernameKey	phixflow

-login.xml

phixflow-datasource.xml

phixflow-secret.xml

phixflow-instance.xml

logback.xml

phixflow-logging.xml

For example on Linux:cp $CV_ARCHIVE

-datasource.xml	`<property` `name="usernameKey">` `<value>ALIAS-USERNAME</value>` `</property>`
db.passwordKey	phixflow-datasource.xml	`<property` `name="passwordKey">` `<value>ALIAS-PASSWORD</value>` `</property>`
logging.file.phixflow.base	logback.xml	`<appender` `name="FILE"` `class="ch.qos.logback.core.rolling.RollingFileAppender">` `<file>logs/${logging.file.phixflow.base}.log</file>`	Just the base filename (phixflow_webappName) should be populated
keystore.type	phixflow-secret.xml	`<property name="keystoreType">` `<value>${keystore.type}</value></property>`
keystore.file	phixflow-secret.xml	`<property name="keystoreFile">` `<value>${keystore.file}</value></property>`
keystore.passwordKey	phixflow-secret.xml	`<property name="keystorePassEnvironmentVariable">` `<value>${keystore.passwordKey}</value></property>`	If an environment variable was used to store the keystore password
phixflow-keystore-password	phixflow-secret.xml	`<property name="keystorePass">` `<value>${phixflow-keystore-password}</value></property>`	If the password was stored in the config file.

If Active Directory was previously used the following configuration settings may need to be configured. Refer to phixflow-secret.xml for existing values.

Insert excerpt

	Server Configuration Properties
	Server Configuration Properties
name	LoginActiveDirectory
nopanel	true

If SAML was previously used the following configuration settings may need to be configured. Refer to phixflow-secret.xml for existing values.

Insert excerpt

	Server Configuration Properties
	Server Configuration Properties
name	LoginSaml
nopanel	true

Company Logo

If you have configured PhixFlow to show your company logo, also copy $ARCHIVE/phixflow-<current date>/gui/images/customerLogo.svg from the archive to the corresponding directory in the new PhixFlow webapp.

Soft Links

If you have configured soft links (also called symlinks or datalinks) between PhixFlow and Tomcat, recreate them. Example scripts are provided below, these examples assume your application is called phixflow. For more details see Configuring Soft Links.

Windows

Code Block
mklink /D C:\app\tomcat\webapps\phixflow\datalink C:\app\phixflow\data\phixflow\datalink

Linux

Code Block
sudo ln -sf /opt/phixflow/data/phixflow/datalink /opt/tomcat/webapps/phixflow/datalink

Expand

title	Upgrading to a version 10 release

Upgrading to a version 10 release

In the archive of the live installation, go to the $TOMCAT/webapps/phixflow/WEB-INF/classes/ directory. Copy the following files into the corresponding directory in the new PhixFlow webapp:

logback.xml
phixflow-datasource.xml
phixflow-logging.xml
phixflow-login.xml
phixflow-secret.xml

For example, on Linux: cp $ARCHIVE/phixflow-<current date>/WEB-INF/classes

, to $TOMCAT

/phixflow-datasource.xml $TOMCAT/webapps/phixflow/WEB-INF/classes

Company Logo

If you have configured PhixFlow to show your company logo, also copy

$TOMCAT/webapps

$ARCHIVE/phixflow-<current date>/gui/images/customerLogo.svg

. from

from the archive to the corresponding directory in the new PhixFlow webapp.

Soft Links

If you have configured soft links (also called symlinks or datalinks) between PhixFlow and Tomcat, recreate them. Example scripts are provided below, these examples assume your application is called phixflow. For more details see Configuring Soft Links.

Step 6

Windows

Code Block
mklink /D C:\app\tomcat\webapps\phixflow\datalink C:\app\phixflow\data\phixflow\datalink

Linux

Code Block
sudo ln -sf /opt/phixflow/data/phixflow/datalink /opt/tomcat/webapps/phixflow/datalink

Configure a Keystore

If you have not already done so, Configure a Keystore

for Database Credentials

and Aliases. Use phixflow-secret.xml to specify the keystore details.

Step 7 Upgrade

Upgrade the Database

Run all migration scripts in sequence from the starting version to this version.

Note

title	About Migration Warnings

Some of the scripts can generate warning messages, such as Caution: Changing any part of an object name could break scripts and stored procedures. Generally, warning messages do not indicate a problem. However, if you see any error messages, please contact your PhixFlow support team.

Example for migrating Oracle

Code Block
cd $RELEASE/install/schema/oracle/migration/X.Y sqlplus myUsername/myPassword @migrate_schema_from_x_y_z_to_X_Y_Z.sql

Example for migrating SQL Server

Code Block
cd $RELEASE/install/schema/sqlserver/migration/X.Y sqlcmd -S myServer\myInstance -U myUsername -P myPassword -d myDatabase -i migrate_schema_from_x_y_z_to_X_Y_Z.sql

Example for migrating

MariaDB (

MySQL

) MariaDB MariaDB

Code Block
title E.g. for

MySQL users

cd $RELEASE/install/schema/

sqlserver

my_sql/migration/X.Y
mysql -h myServer -u myUsername -p -D myDatabase
source migrate_schema_from_x_y_z_to_X_Y_Z.sql

Warning

title

MySQL Privileges

Some

MariaDB

MySQL PhixFlow migration scripts create or use privileged functions and/or procedures

, and must have privileges not required by the regular PhixFlow user.

You can permanently allow functions like this to run by updating a setting in your my.cnf file. See Running non-deterministic functions in MariaDB for details. If you do not make this change, then you must make sure that either:

Your session has the log_bin_trust_function_creators setting switched on. You can do this

. If you have followed PhixFlow's recommended installation, running non-deterministic functions will be permanently allowed by a setting (global log_bin_trust_function_creators) in my.cnf (see Install MySQL).

If you have not permanently set this in my.cnf, you will need to turn this on in the session you are using to perform the upgrade with the command:

Code Block
set global log_bin_trust_function_creators = 1;

Or

Alternatively, ensure that that the

migration

database user performing the upgrade has SUPER privilege.

Step 8

Complete any Special Upgrade Instructions

Complete the Special Upgrade Instructions for all the intermediate releases between your current version and the version to which you are upgrading.

Step 9

Re-start Tomcat

Restart the Tomcat service .

Step 10 Republish PhixFlow Stream Data

After upgrading, PhixFlow may need to republish data to its database. If you have very large streams this can cause slow initial performance. To ensure users are not affected, we recommend that you publish stream data immediately after upgrading.

Log on to PhixFlow.

Select Insert excerpt_administration_administrationnopaneltrue → Other Options → Publish Streams.

Wait for the pop-up notification that publishing is complete.

Note
If you do not republish altered stream tables, PhixFlow will automatically start publishing data when the first user attempts to use a stream. This may cause slow performance until publishing is complete.

Your PhixFlow upgrade is now complete and users can access the new version of PhixFlow.

For details about configuring PhixFlow once it is installed, see Administrationand verify you can login successfully.

Step 9 Special Upgrade Instructions

Review all special upgrade instructions have been implemented.

Versions Compared

Old Version 44

New Version Current

Key

Planning your Upgrade
Anchor
preparation
preparation

Check Supported Versions and Special Instructions

Check Java and Database Connectors

How to Upgrade

Step 1 Backup your Database

Step 2 Review Special Upgrade Instructions

Step 3 Stop Tomcat and Delete the Work Directory

Step

4 Upgrade the Environment

Step

5 Unzip the PhixFlow Release

Step

6 Install the New Webapp into Tomcat

Step 7 Configure the Webapp

Upgrading an existing Version 11 or latest system

Upgrading to version 11 or later from pre version 11

Upgrading to a version 10 release

Configure a Keystore

Upgrade the Database

Example for migrating Oracle

Example for migrating SQL Server

Example for migrating

MySQL

Code Block
title E.g. for

Step 8

Re-start Tomcat

Step 10 Republish PhixFlow Stream Data

Your PhixFlow upgrade is now complete and users can access the new version of PhixFlow.

Step 9 Special Upgrade Instructions

Page Comparison

Versions Compared

Old Version 44

New Version Current

Key

Planning your Upgrade Anchorpreparationpreparation

Check Supported Versions and Special Instructions

Check Java and Database Connectors

How to Upgrade

Step 1 Backup your Database

Step 2 Review Special Upgrade Instructions

Step 3 Stop Tomcat and Delete the Work Directory

Step

4 Upgrade the Environment

Step

5 Unzip the PhixFlow Release

Step

6 Install the New Webapp into Tomcat

Step 7 Configure the Webapp

Upgrading an existing Version 11 or latest system

Upgrading to version 11 or later from pre version 11

Upgrading to a version 10 release

Configure a Keystore

Upgrade the Database

Example for migrating Oracle

Example for migrating SQL Server

Example for migrating

MySQL

Code BlocktitleE.g. for

Step 8

Re-start Tomcat

Step 10 Republish PhixFlow Stream Data

Your PhixFlow upgrade is now complete and users can access the new version of PhixFlow.

Step 9 Special Upgrade Instructions

Planning your Upgrade
Anchor
preparation
preparation

Code Block
title E.g. for