Skip to Content
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 This chapter details the options available to backup and restore [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]] instances.
6
7 = Complete Backup Options =
8
9 When a complete backup is required, there are two options available: backing up with the populated indexes or backing up with only the Index structures.
10
11 If only backing up the Index structures, the restore procedure will result in all Index displaying 0 documents with a ‘WAITING’ status until they have been rebuilt manually or an automatic refresh schedule is carried out.
12
13 Backups that include all Index data may result in large file sizes. To backup using as little storage as possible, backup with only the Index structures.
14
15 == Complete Backup ==
16
17 The following folders, including all files and all sub-folders, are required:
18
19 **<Path to CXAIR install>\CXAIR**
20 **<Path to CXAIR install>\CXAIR Database**
21
22 Items Included:
23
24 • Settings, property files and configuration items
25 • User and User Group configurations
26 • Saved reports
27 • Report schedule configurations
28 • Search Engine structures
29 • Index structures and data
30 • Index schedules configuration
31
32 Using this method, it is possible to restore any data, configuration or report within [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]]. There is no need to rebuild any indexes once the backup is restored, and [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]] will be instantly operational.
33
34 == Backup Without Indexed Data ==
35
36 To backup with the Index structures instead of all Index data, follow the above steps excluding the following folder:
37
38 **<Path to CXAIR install>\CXAIR\sys\Index\**
39
40 This will result in the same items being included in the backup, but indexes will need to be re-built to include the relevant data.
41
42 = Partial Backup Options =
43
44 It is also possible to backup specific data items or configurations.
45
46 The following folders, including all files and all sub-folders, can be backed up individually:
47
48 == Saved Reports ==
49
50 **<Path to CXAIR install>\CXAIR\sys\saved**
51
52 == User and User Group Configuration ==
53
54 **<Path to CXAIR install>\CXAIR Database\databases\cxair**
55
56 == CXAIR Licence ==
57
58 **<Path to CXAIR install>\CXAIR Database\databases\licence**
59
60 = Restoring a Backup =
61
62 To restore backed up files and folders, first stop the [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]] service. Then, copy the files and folders onto the server in place of the existing files and folders. Then, use the Windows Task Manager to restart the [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]] service.
63
64 Clear the internet browser cache and, if restoring a backup that only contains the Index structures, rebuild the indexes manually or with a schedule.
65
66
67
68