Skip to Content

Wiki source code of 01. Installation

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 = Installation Prerequisites =
6
7 **Default Ports required**: 6453/6454
8 //Please note that these can be configured to any ports required after installation//
9
10 **Prerequisite software required**: Java Development Kit 17 or above
11
12 //Please note that due to Oracle licencing changes, an Oracle licence must be purchased to continue to use Oracle JDK in a commercial environment. More information can be found on the Oracle website: [[https://www.oracle.com/java/technologies/faqs-jsp.html]]//
13
14 A recommended alternative to Oracle's JDK is to use the 'Open Java Development Kit' General-Availability Release 14 or above, which is available from https://openjdk.java.net. This is fully compatible with CXAIR.
15
16 **Operating system**: Windows Server 64-bit or Linux 64-bit
17
18 **Anti-virus software**: Exclude the live scanning of CXAIR folders for optimal performance.
19
20 == Server Specification ==
21
22
23 (% border="1" cellspacing="0" style="border-collapse:collapse; border:1pt solid #90c5f6; width:727px" class="MsoTable15Grid1LightAccent1" %)
24 |(% width="139" style="border-bottom:1.5pt solid #59a9f2; border-left-style:solid; border-left-width:1pt; border-right-style:solid; border-right-width:1pt; border-top-style:solid; width:130px" %)(((
25 (% style="margin-bottom:.0001pt; text-align:left; padding:0cm 5.4pt 0cm 5.4pt;text-align:left" %)
26 (% style="font-size:11pt; line-height:normal" %)**Component**
27 )))|(% width="223" style="border-bottom:1.5pt solid #59a9f2; border-left:none; border-right:1pt solid #90c5f6; border-top:1pt solid #90c5f6; width:281px" %)(((
28 (% style="margin-bottom:.0001pt; text-align:left; padding:0cm 5.4pt 0cm 5.4pt;text-align:left" %)
29 (% style="font-size:11pt; line-height:normal" %)**Minimum Server Specification**
30 )))|(% width="239" style="border-bottom:1.5pt solid #59a9f2; border-left:none; border-right:1pt solid #90c5f6; border-top:1pt solid #90c5f6; width:303px" %)(((
31 (% style="margin-bottom:.0001pt; text-align:left; padding:0cm 5.4pt 0cm 5.4pt;text-align:left" %)
32 (% style="font-size:11pt; line-height:normal" %)**Recommended Server Specification**
33 )))
34 |(% width="139" style="border-left-width:1pt; border-right-width:1pt; border-style:none solid solid; border-top-color:initial; border-top-width:initial; width:130px" %)(((
35 (% style="margin-bottom:.0001pt; text-align:left; padding:0cm 5.4pt 0cm 5.4pt;text-align:left" %)
36 (% style="font-size:11pt; line-height:normal" %)**Processor**
37 )))|(% width="223" style="border-bottom:1pt solid #90c5f6; border-left:none; border-right:1pt solid #90c5f6; border-top:none; width:281px" %)(((
38 (% style="margin-bottom:.0001pt; text-align:left; padding:0cm 5.4pt 0cm 5.4pt;text-align:left" %)
39 (% style="font-size:11pt; line-height:normal" %)8 Cores @ 3Ghz or above
40 )))|(% width="239" style="border-bottom:1pt solid #90c5f6; border-left:none; border-right:1pt solid #90c5f6; border-top:none; width:303px" %)(((
41 (% style="margin-bottom:.0001pt; text-align:left; padding:0cm 5.4pt 0cm 5.4pt;text-align:left" %)
42 (% style="font-size:11pt; line-height:normal" %)12 Cores @ 3Ghz or above
43 )))
44 |(% width="139" style="border-left-width:1pt; border-right-width:1pt; border-style:none solid solid; border-top-color:initial; border-top-width:initial; width:130px" %)(((
45 (% style="margin-bottom:.0001pt; text-align:left; padding:0cm 5.4pt 0cm 5.4pt;text-align:left" %)
46 (% style="font-size:11pt; line-height:normal" %)**Memory**
47 )))|(% width="223" style="border-bottom:1pt solid #90c5f6; border-left:none; border-right:1pt solid #90c5f6; border-top:none; width:281px" %)(((
48 (% style="margin-bottom:.0001pt; text-align:left; padding:0cm 5.4pt 0cm 5.4pt;text-align:left" %)
49 (% style="font-size:11pt; line-height:normal" %)16GB or above
50 )))|(% width="239" style="border-bottom:1pt solid #90c5f6; border-left:none; border-right:1pt solid #90c5f6; border-top:none; width:303px" %)(((
51 (% style="margin-bottom:.0001pt; text-align:left; padding:0cm 5.4pt 0cm 5.4pt;text-align:left" %)
52 (% style="font-size:11pt; line-height:normal" %)32GB or above
53 )))
54 |(% width="139" style="border-left-width:1pt; border-right-width:1pt; border-style:none solid solid; border-top-color:initial; border-top-width:initial; width:130px" %)(((
55 (% style="margin-bottom:.0001pt; text-align:left; padding:0cm 5.4pt 0cm 5.4pt;text-align:left" %)
56 (% style="font-size:11pt; line-height:normal" %)**Storage***
57 )))|(% width="223" style="border-bottom:1pt solid #90c5f6; border-left:none; border-right:1pt solid #90c5f6; border-top:none; width:281px" %)(((
58 (% style="margin-bottom:.0001pt; text-align:left; padding:0cm 5.4pt 0cm 5.4pt;text-align:left" %)
59 (% style="font-size:11pt; line-height:normal" %)1TB Disk in RAID 10 or SSD
60 )))|(% width="239" style="border-bottom:1pt solid #90c5f6; border-left:none; border-right:1pt solid #90c5f6; border-top:none; width:303px" %)(((
61 (% style="margin-bottom:.0001pt; text-align:left; padding:0cm 5.4pt 0cm 5.4pt;text-align:left" %)
62 (% style="font-size:11pt; line-height:normal" %)2TB SSD
63 )))
64
65 //Storage required is dependent on the volume of data that will be indexed by CXAIR. The sizing above is an example, and a more accurate sizing can be provided during implementation scoping if required.//
66
67 == Workstation Specification ==
68
69 User workstations require a compatible web browser and a minimum resolution of 1280x1024 to access the solution. Compatible web browsers are:
70
71 • Microsoft Edge 90.0, or above
72 • Mozilla Firefox 51.0, or above
73 • Google Chrome 56.0, or above
74
75 Users must clear their browser cache prior to logging in.
76
77 = Windows Installation =
78
79 Please ensure that the host is running Windows Server 64bit and that the user running the install package has administrator rights to complete the installation successfully.
80
81 == Installation Process ==
82
83 === Initialising the Installer ===
84
85 Before executing the installer, all instances of the Mozilla Firefox internet browser must be closed. This includes using the Windows Task Manager to end any processes.
86
87 Right click on the **Command Prompt** option and select **Run as administrator**. This will ensure that the relevant permissions are enabled.
88
89 Change to the directory containing the installer using the **cd** command and enter the following:
90
91 **“<install path for Java 64bit>\Java\<jdk version>\bin\java.exe” –jar CXAIR-<version number>.jar**
92
93 For example:
94
95 **“C:\Program Files\Java\jdk13.0.1\bin\java.exe” –jar CXAIR-2021.1.0.123.jar**
96
97 The installer will then be launched.
98
99 === Installer ===
100
101 After accepting the terms and conditions, the installation paths can be configured.
102
103 By default, [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]] will be installed to: **C:\Program Files\CXAIR**. To change the installation path, click **Browse** and select an alternative location. Click **Next** to continue.
104
105 The database path will then need to be specified. By default, the files will be installed to: C:\Program Files\CXAIR_Database. To change the installation path, click **Browse** and select an alternative location.
106
107 After clicking **Next**, the installation process begins and the progress screen is displayed.
108
109 Once completed, click **Next** and specify whether to create shortcut entries in the start menu and on the desktop. After clicking **Next** again, the installation will be complete. Click **Done** to close the installer.
110
111 === Starting the CXAIR Service ===
112
113 On a Windows installation, the service is configured to start automatically.
114
115 To restart the service, use the Windows Task Manager to start the service titled **CXAIR**.
116
117 When this service has the **Running** status, the process is complete.
118
119 = Linux Installation =
120
121 Please ensure the administrator password is available for the installer to run with the correct user privileges.
122
123 == Installation Process ==
124
125 === Initialising the Installer ===
126
127 In a terminal window, enter the following:
128
129 **sudo java –jar CXAIR-<version number>.jar**
130
131 For example:
132
133 **sudo java –jar CXAIR-2021.1.0.123.jar**
134
135 This will open the installer in a new window.
136
137 === Installer ===
138
139 After accepting the terms and conditions, the installation paths can be configured. To change the installation path, click **Browse** and select an alternative location. Click **Next** to continue.
140
141 The database path will then need to be specified. To change the installation path, click **Browse** and select an alternative location.
142
143 After clicking **Next**, the installation process begins and the progress screen is displayed. When complete, click **Done** to close the installer.
144
145 === Starting the Service ===
146
147 Open the Terminal and change the directory to where the CXAIR directories were installed.
148
149 Following a successful installation, the following service will need to be started. This is only required the first time the solution is accessed.
150
151 **CXAIR/controller/bin/installDaemon.sh**
152
153 Then, the following service can be started:
154
155 **CXAIR/controller/bin/startDaemon.sh**
156
157 To automate this process on restart on Linux servers that use systemd, simply move the **cxair.service** file located in /CXAIR/controller to /etc/systemd/system.
158
159 The CXAIR service can then be started and stopped using the following two commands:
160
161 **systemctl start cxair** and **systemctl stop cxair**
162
163 To start the service at boot, use the following command:
164
165 **systemctl enable cxair**
166
167 To stop the CXAIR service starting automatically, use the following command:
168
169 **systemctl disable cxair**
170
171 == Headless Servers ==
172
173 If the server is headless, there are a number of configurations that must be made prior to installation.
174
175 === Xvfb ===
176
177 To allow reports to be exported, Xvfb needs to be installed. If not added automatically, the Xvfb.sh file will need to be added to the **CXAIR/wrapper/bin/** directory.
178
179 === Slimerjs ===
180
181 When the installation process is complete, the **cxair.properties** file will need to be edited. Navigate to: **CXAIR\wrapper\com\connexica\cxair\tomcat** to locate the file and open it with a text editor. Locate the following line:
182
183 **system.properties.connexica.cxair.slimerjs=<Location>**
184
185 The location will need to be changed from **slimerjs** to **cxslimerjs**. The line should end in:
186
187 **CXAIR\slimerjs\linux\x86\cxslimerjs** (32bit installations)
188 **CXAIR\slimerjs\linux\x86_64\cxslimerjs **(64bit installations)
189
190 === Inkscape ===
191
192 If installing a [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]] version prior to 2017.2, Inkscape will need to be installed in order for charts to render in their native resolution. Please refer to the Inkscape website for more information regarding the required installation for the Linux version in use.
193
194 When the Inkscape installation process is complete, the **cxair.properties** file will need to be edited. Navigate to: **CXAIR\wrapper\com\connexica\cxair\tomcat** to locate the file and open it with a text editor. Add the following line:
195
196 **system.properties.connexica.cxair.inkscape=<inkscape.exe install path>**
197
198 = Post-Installation Configuration =
199
200 When accessing [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]] for the first time following a successful installation, a licence must be applied by the system admin account. Please refer to the [[Licencing>>doc:.Licencing.WebHome]] chapter for more information.
201
202 Please note that [[deletion privileges>>doc:Technical Documentation.CXAIR.Administration Guide.Security.2b\. User Management.WebHome||anchor="Delete"]] must also be activated by the system admin account for any administrator users. Please refer to the [[User Management>>doc:Technical Documentation.CXAIR.Administration Guide.Security.2b\. User Management.WebHome]] chapter for more information.
203
204 If using an Apache server, the following line needs to be added to the **tomcat.properties** file located at **CXAIR/wrapper/com/connexica/cxair/tomcat**:
205
206 **catalina.port.ajp13=8009**
207
208 = Custom Installation =
209
210 To create a custom installer, the system must have Apache Ant installed. Please contact support to receive the necessary **CXAIR** archive file.
211
212 == Parameters ==
213
214 Locate and unpack the custom installer archive and open the **build.properties** file with a text editor. By default, the following lines are displayed:
215
216 **product.name=CXAIR
217 context=cxair
218 skipLicence=false**
219
220 To change the name of the product, change the **product.name** value. Setting this option will change the references in the installer and the names of newly created system services.
221
222 The **context** value reflects the URL reference that is used to access the solution. The URL is constructed in the following format:
223
224 **http:~/~/<server name>:<port number>/<context>**
225
226 The **skipLicence** line allows the licence agreement to be removed from the installer if the parameter is set to **true**.
227
228 == Images ==
229
230 To customise the images used, navigate to the **images** folder of the archive. Replace the **cxair.ico** file to change the shortcut icon, and the **installer.png** file to change the image displayed during the installation.
231
232 Ensure that the replacement files have the same name and file type as the original files.
233
234 == Building the Installer ==
235
236 To build the installer, open a Command Prompt or Terminal window and change the directory to the location where the custom install archive file was unpacked. Then, enter the directory for Apache Ant and press the return key.
237
238 This will start the build process. Once completed, **BUILD SUCCESSFUL** is displayed along with the build time, indicating that the installer has been built.
239
240 == Running the Installer ==
241
242 To run the installer, follow the previously detailed installation steps.
243