Skip to Content

Wiki source code of 01a. Upgrade Procedure

Last modified by Tom Jardine on 06/11/2025, 14:23
Hide last authors
Tom Jardine 1.1 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 Before upgrading to a newer version, it is important to check the current version to receive the correct upgrade file.
6
7 To check the current version from the front-end of the solution, click **Help** then **About**. From the Administration screens, click **Info** then **About**. This will display the current **Username**, **Language**, **CXAIR Version** and **Browser Details**.
8
9 When upgrading to a new version, there are two methods available. Depending on the version being upgraded from, it can be installed using a **.jar** or **.war** file. When performing a major upgrade, a **.jar** file will be required.
10
11 Before starting either upgrade procedure, the **CXAIR** service/Daemon must be stopped, the cache must be cleared from the internet browser and all instances of the Mozilla Firefox internet browser must be closed. This includes using the Windows Task Manager to end any processes.
12
13 = Java Paths =
14
15 If the version of Java has changed, the relevant CXAIR configuration files must be changed to point to the new Java version. These files are found in the following locations:
16
17 <install path>\CXAIR\controller\conf\wrapper.conf
18
19 <install path>\CXAIR\wrapper\conf\wrapper.conf
20
21 <install path>\CXAIR\wrapperindexer\conf\wrapper.conf
22
23 <install path>\CXAIR_Database\conf\wrapper.conf
24
25 Open each file in a text editor and amend the Java path. For example:
26
27 **wrapper.java.command=C:/Program Files/Java/jdk-13.0.1/bin/java.exe**
28
29 On Windows installations, the CXAIR service will need to be reinstalled once this change has been made.
30
31 Run the uninstaller using the following file:
32
33 <install path>\CXAIR\wrapper\bat\uninstallService.bat
34
35 Then reinstall using the following file:
36
37 <install path>\CXAIR\wrapper\bat\installService.bat
38
39 = Using a .jar File =
40
41 Running an upgrade using a **.jar file** requires the same process as the initial installation. When the installer is executed, the Command Prompt or Terminal window will indicate:
42
43 **IS_UPGRADE=true**
44
45 Following the upgrade, the service will need to be restarted.
46
47 = Using a .war File =
48
49 Running an upgrade using a **.war** file does not require an installer, only the relevant upgrade file. A **.war** file can be installed automatically or manually.
50
51 == Automated Installation ==
52
53 Navigate to the Upgrade CXAIR screen by clicking **Setup**, **System** then **Upgrade CXAIR**.
54
55 Either click **Choose File** and select the relevant **.war** file, or drag and drop it to the box below to begin the installation.
56
57 Once the file has been uploaded and verified, a pop-up will appear. Click **OK** to commence the upgrade process, or **Cancel** to return to the previous screen. If cancelled, the file will remain available to start the upgrade process at a later time.
58
59 After confirming the upgrade in the subsequent pop-up, the installation will be started and the CXAIR service will be restarted. This will log out all users.
60
61 After logging back in, the upgrade needs to be verified. This enables users to make the relevant tests and roll-back to a previous version if any issues arise. To verify a successful upgrade, navigate back to the Upgrade CXAIR screen by clicking **Setup**, **System** then **Upgrade CXAIR**. Click **Verify** to confirm the successful upgrade to complete the process. If not verified before logging out, the system will revert to the previous version automatically.
62
63 All uploaded **.war** files will remain available to allow the system to be reverted to a previous version manually. Click the **Install** button next to the relevant version to change to a specific build, or click the **X** icon to delete it from the server. The options for the currently installed version will not be available.
64
65 Please note that when a **.jar** upgrade is completed, all previously uploaded **.war** files will be deleted.
66
67 == Manual Installation ==
68
69 Navigate to the CXAIR folder and locate the **CXAIR.war** file. Rename this to **CXAIROLD.war** to maintain the original file.
70
71 Next, rename the upgrade file to **CXAIR.war** and move it into the CXAIR folder.
72
73 Following the upgrade, the service needs to be restarted.
74
75 = Accessing CXAIR =
76
77 Following a successful install and with all services running, enter the following URL into the address bar a supported internet browser:
78
79 **http:~/~/<server name or IP address>:<port number>/cxair**
80
81 The **<server name>** is the name of the server where [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]] is installed and **<port number>** us the port number Tomcat is configured to use. By default, this will be set to 6453, but can be configured changing the **tomcat.properties** file located in:
82
83 **CXAIR\wrapper\com\connexica\cxair\tomcat**
84
85 Please refer to the [[Accessing CXAIR>>doc:Technical Documentation.CXAIR.User Guide.01\. Logging In.WebHome]] chapter for more information.
86
87 = System Optimisation =
88
89 Following a successful installation, it is recommended that the performance tuning settings are optimised to match the server specification. Please refer to the [[System Settings>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome]] chapter for more information regarding the necessary parameters.