Created by James Hurrell, last modified on Jul 09, 2021

Introduction

This section describes the upgrade process for the following components:

  • Front-end AIP Console package (includes embedded Dashboards)
  • Back-end AIP Node package on ALL AIP Nodes
  • CAST-RESTAPI-integrated.war for embedded Dashboards

It is not possible to use AIP Console and AIP Node packages from different releases, therefore choosing to upgrade one of them necessarily means upgrading the other (i.e. upgrading the AIP Console package AND all AIP Node packages to the same release).

If you are using the AIP Automation Tools available from https://github.com/CAST-Extend/com.castsoftware.aip.console.tools you MUST ensure that these are ALSO upgraded to the same release as the Front-end AIP Console package and the Back-end AIP Node package (in other words, AIP Console/AIP Node release must match the AIP Automation Tools release. This process is beyond the scope of this documentation.

Information and prerequisites

(tick)Upgrade path

Upgrades to the latest release are supported out of the box for AIP Console/AIP Node ≥ 1.14. If you are using an older release and need to upgrade, please contact CAST Technical Support for assistance.

  • If you want to upgrade from a release between 1.14 and 1.17 (inclusive), you must perform a two step upgrade: first upgrade to 1.18, then from 1.18 to the latest release.
  • If you want to upgrade from ≥ 1.18 to the latest release, you can perform a direct upgrade to the latest release.
(tick)Upgrade process for AIP Console / AIP Node packagesThe upgrade process is an "in place upgrade". This means that the existing installation locations (for AIP Console and for the AIP Node(s)) should be selected when the installer containing the new release of the AIP Console/AIP Node packages is run. The installer will detect that an existing install is present (in certain default locations) and will overwrite the existing installation with the new release, however, all configuration options from the previous release will be retained.
(tick)Embedded dashboardsIf you are using the CAST Dashboards embedded in AIP Console, then CAST highly recommends that the CAST-RESTAPI-integrated.war file on your Apache Tomcat server is upgraded at the same time as the AIP Console and AIP Node packages. This file is shipped with every new release of AIP Console. The upgrade process is a "side by side" 
(tick)Where to run the upgrade?

The upgrade must be run on the servers hosting the following:

  • AIP Console
  • All AIP Nodes managed by AIP Console
  • Apache Tomcat for embedded Dashboards
(tick)Obtain and unzip the installation media

Download the latest release of AIP Console from CAST Extend. This media contains:

  • a JAR file - the combined installer for both the AIP Console and the AIP Node packages.
  • a WAR file - the integrated WAR file for embedded dashboards.

You will need to make a copy of the JAR/WAR files on all servers that require an upgrade (do not run the JAR/WAR files from a network share).

(tick)Stop all services

Before starting any upgrade process, you must ensure ALL services are stopped, for example stop AIP Console and all AIP Node packages by stopping the Windows Service or closing the CMD Window and stop Apache Tomcat before upgrading the CAST-RESTAPI-integrated.war.

(tick)Perform a backup

Before starting the upgrade, you may wish to perform a backup of your AIP Console and AIP Node data folders. To do so, copy the relevant folders to an alternative location in case a roll back needs to be performed:

%PROGRAMDATA%\CAST\AipConsole\AipConsole
%PROGRAMDATA%\CAST\AipConsole\AipNode

Instructions

Click to see the relevant instructions: