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 | ||||
---|---|---|---|---|
|
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.
Panel | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
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:
|
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
34 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 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 |
See also:
Step
45 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
56 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 | ||
---|---|---|
| ||
Upgrading an existing Version 11 or latest systemAutomated upgrading of the database schema is now supported. In the archive of the live installation, go to the |
files into the corresponding directory in the new PhixFlow webapp if they exist:
Review the Special Upgrade Instructions if there are any recommendations for additional settings. Company Logo |
- phixflow-instance.xml
If you have configured PhixFlow to show your company logo, also copy 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
Linux
|
Expand | ||
---|---|---|
| ||
Upgrading to version 11 or later from pre version 11Direct 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 |
If Active Directory was previously used the following configuration settings may need to be configured. Refer to phixflow-secret.xml for existing values.
If SAML was previously used the following configuration settings may need to be configured. Refer to phixflow-secret.xml for existing values.
Company Logo If you have configured PhixFlow to show your company logo, also copy |
|
|
from the archive to the corresponding directory in the new PhixFlow webapp. |
$TOMCAT/webapps/phixflow/datalink → [PhixFlow file system]/phixflow/datalink
. For further details go to Install the PhixFlow Webapp, but if you have followed the recommended installation, you can use one of the following commands to re-create the link ($WEBAPP is the name of the installed PhixFlow, in most cases just "phixflow")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
Linux
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Upgrading to a version 10 releaseIn the archive of the live installation, go to the
For example, on Linux: Company Logo If you have configured PhixFlow to show your company logo, also copy 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
Linux
|
Configure a KeystoreIf you have not already done so, Configure a Keystore and Aliases. Use phixflow-secret.xml to specify the keystore details. |
Upgrade the DatabaseRun all migration scripts in sequence from the starting version to this version.
Example for migrating Oracle
Example for migrating SQL Server
Example for migrating MySQL
| MariaDB
| MariaDB
|
Step 8
Complete any Special Upgrade InstructionsComplete the Special Upgrade Instructions for all the intermediate releases between your current version and the version to which you are upgrading.
Step 9 Restore Soft Links andRe-start
TomcatIf you have configured soft links (also called symlinks or datalinks) between PhixFlow andTomcat
, recreate them; see Configuring Soft Links.Restart the Tomcat service .
Step 10 Republish PhixFlow Table Data
After upgrading, PhixFlow may need to republish data to its database. If you have very large tables this can cause slow initial performance. To ensure users are not affected, we recommend that you publish table data immediately after upgrading.
Note |
---|
If you do not republish altered database tables, PhixFlow will automatically start publishing data when the first user attempts to use a table. 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.