Summary: This section describes the upgrade process for the integrated CAST RESTAPI when using the Dashboards embedded in AIP Console 1.xCAST highly recommends upgrading this file when upgrading to a new release of the AIP Console/AIP Node packages.


If you are using AIP Console 2.x or you are not using the Dashboards embedded in AIP Console, this step is not required. For 1.x users, instead, please see Standalone Dashboard upgrade.

Upgrading from CAST-RestAPI-integrated.war to cast-integrated-health-engineering-dashboard.zip

In AIP Console ≥ 1.25, the existing CAST-RestAPI-integrated.war has been replaced with the cast-integrated-health-engineering-dashboard.zip file. Fundamentally, this means that:

Step 1 - Ensure Apache Tomcat is stopped

Before starting, ensure that Apache Tomcat is not running.

Step 2 - Deploy the cast-integrated-health-engineering-dashboard.zip

The cast-integrated-health-engineering-dashboard-<version>.zip is provided in the installation media .ZIP file (alongside the .JAR installer for the AIP Console) and is partly pre-configured for use with the CAST AIP Console. Locate the file and move it to a suitable location - it can be run from anywhere.

See Embedded CAST Dashboard deployment process for more details about how to proceed.

CAST does not recommend re-using existing files from the existing .war file deployment: their contents and location have changed in the new .zip file.

Step 3 - Check configuration details in AIP Console admin center

Ensure you check that the configuration details in Administration Center - Settings - Dashboard Integration are correct. In particular the URL to the newly deployed .zip file will have changed.

Step 4 - Check access to CAST Dashboards from AIP Console

Browse to your AIP Console URL http://<server>:8081/ui/index.html, login to AIP Console and check that you can access the Engineering and Health Dashboards via the options:

Step 5 - Undeploy the existing WAR file

Undeploy the existing CAST-RESTAPI-integrated.war file from Apache Tomcat - you can use Apache Tomcat manager to do this, or simply delete the relevant folder and file in CATALINA_HOME\webapps. Apache Tomcat is no longer required if you are only using it for the embedded Dashboards.

Upgrading between CAST-RestAPI-integrated.war file - AIP Console ≤ 1.24

Step 1 - Ensure Apache Tomcat is stopped

Before starting, ensure that Apache Tomcat is not running.

Step 2 - Deploy the new CAST-RESTAPI-integrated.war

Obtain the new CAST-RESTAPI-integrated.war file from the AIP Console media and rename it so that you can deploy it alongside the existing CAST-RESTAPI-integrated.war file, for example to CAST-RESTAPI-integrated_new.war. Now unzip the CAST-RESTAPI-integrated_new.war to the following location:

CATALINA_HOME\webapps

This should give you the following file hierarchy:

Step 3 - Copy and paste files from existing WAR file into the new WAR file

Copy the following files from the existing WAR file:

CATALINA_HOME\webapps\CAST-RESTAPI-integrated\META-INF\context.xml
CATALINA_HOME\webapps\CAST-RESTAPI-integrated\WEB-INF\license.key
CATALINA_HOME\webapps\CAST-RESTAPI-integrated\WEB-INF\domains.properties

And paste them in to the relevant location in the new WAR file, overwriting the existing files if they exist:

CATALINA_HOME\webapps\CAST-RESTAPI-integrated_new\META-INF\context.xml
CATALINA_HOME\webapps\CAST-RESTAPI-integrated_new\WEB-INF\license.key
CATALINA_HOME\webapps\CAST-RESTAPI-integrated_new\WEB-INF\domains.properties

Step 4 - Undeploy the existing WAR file

Undeploy the existing CAST-RESTAPI-integrated.war file from Apache Tomcat - you can use Apache Tomcat manager to do this, or simply delete the relevant folder and file in CATALINA_HOME\webapps.

Step 5 - Rename the new WAR file and corresponding folder

Rename the new WAR file and its corresponding folder to match the name used by the previous WAR file:

Step 6 - Restart Apache Tomcat

Restart Apache Tomcat and ensure that the CAST-RESTAPI-integrated webapp has started correctly using Apache Tomcat manager:

Step 7 - Check access to CAST Dashboards from AIP Console

Browse to your AIP Console URL http://<server>:8081/ui/index.html, login to AIP Console and check that you can access the Engineering and Health Dashboards via the options:

Troubleshooting

Cannot access the Dashboards post upgrade

Check that: