Upgrading Flux allows you take advantage of the latest improvements, bug fixes, and new features that Flux has to offer. We recommend always running Flux on the newest version possible, both to take advantage of the increase stability offered as new bug fixes are added, and to provide easier to new features in the future (the more up-to-date your Flux installation is, the easier it will be to upgrade to newer versions of Flux down the line).
This guide documents the steps required to upgrade your Flux installation.
To install your Flux upgrade, you will first need a little information about your existing Flux environment and the version you plan to upgrade to.
To different between version numbers, each Flux release has three identifiers: the major version, the minor version, and the maintenance version. These are arranged like so:
Flux <major version>.<minor version>.<maintenance version>
For example, your Flux version may be "Flux 7.9.13", "Flux 7.8.4", or similar.
There are two types of Flux upgrades:
- Major or minor upgrades. These upgrades contain considerable changes from previous Flux versions (UI updates or major functionality changes) and may require database schema changes, API changes, or engine configuration changes.
- Maintenance upgrades. These upgrades only contain bug fixes and minor improvements. Maintenance upgrades do not require database schema changes, API changes, or engine configuration changes.
If your existing Flux installation and the version you are upgrading to share both a major and minor version, but the maintenance version is different, then this is a maintenance upgrade. Follow the maintenance upgrade instructions below to upgrade your Flux installation.
If your existing Flux installation and the version you are upgrading to have a different major or minor version, this is a major or minor upgrade. Follow the major or minor upgrade instructions below to upgrade your Flux installation.
To install a maintenance upgrade:
- Shut down any engine or Operations Console instances that are running.
- Download and extract the new Flux version to your system.
- Remove all the files and directories in the <Flux Installation Directory>/webapp/flux folder.
- Copy the flux.jar and flux.war files from the new release over your existing ones.
- [If this is not an evaluation version of Flux] Place your Flux license key file in the Flux directory and run the configure script located there to install the key.
- Copy all of the files from the <flux directory>/lib folder of the new release into the <flux home>/lib folder of the existing installation. Select "Yes" if prompted to replace any existing files.
- Restart your engine(s) and web application(s).
That's it! Your new Flux version is now installed and ready to run.
Major or Minor Upgrades
To install a major or minor update:
- Shut down the old version of Flux (including any engines, agents, or web applications that may be running).
- Follow the instructions in Installing Flux. Be sure to install Flux in a new location to avoid overwriting any existing files from your old Flux version.
- Run the Java code detailed in Exporting and Importing Flow Charts using XML to migrate the data from your old Flux version. This will download all flow charts from the previous Flux version and import them into the new version.
- Recompile any existing code against the new flux.jar (and new dependency files). Complete API change reports are available in the /doc/jdiff directory of the new release. You can also find API change reports for a particular version of Flux by visiting that version's documentation page from the Flux Portal Dashboard.
- If your application uses the Flux Java APIs and contains flux.jar or flux.war on the class path, be sure to replace any existing copies of those files with the new versions to avoid conflicts. If there is more than one version of flux.jar or flux.war on an application's class path, Flux may encounter errors. In addition, remove any dependency JAR files used by the previous Flux version (typically these are located in the /lib directory under the Flux installation directory) and replace them with the new JAR files from the /lib directory from your newer Flux version.
- Start the new Flux version.
That's it! Your Flux upgrade is now successfully installed and ready to run.