05h. Backup and Restore Procedure

Last modified by Tom Jardine on 06/11/2025, 14:23

This chapter details the options available to backup and restore CXAIR instances.

Complete Backup Options

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.

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.

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.

Complete Backup

The following folders, including all files and all sub-folders, are required:

<Path to CXAIR install>\CXAIR
<Path to CXAIR install>\CXAIR Database

Items Included:

• Settings, property files and configuration items
• User and User Group configurations
• Saved reports
• Report schedule configurations
• Search Engine structures
• Index structures and data
• Index schedules configuration

Using this method, it is possible to restore any data, configuration or report within CXAIR. There is no need to rebuild any indexes once the backup is restored, and CXAIR will be instantly operational.

Backup Without Indexed Data

To backup with the Index structures instead of all Index data, follow the above steps excluding the following folder:

<Path to CXAIR install>\CXAIR\sys\Index\

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.

Partial Backup Options

It is also possible to backup specific data items or configurations.

The following folders, including all files and all sub-folders, can be backed up individually: 

Saved Reports

<Path to CXAIR install>\CXAIR\sys\saved

User and User Group Configuration

<Path to CXAIR install>\CXAIR Database\databases\cxair

CXAIR Licence

<Path to CXAIR install>\CXAIR Database\databases\licence

Restoring a Backup

To restore backed up files and folders, first stop the CXAIR 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 service.

Clear the internet browser cache and, if restoring a backup that only contains the Index structures, rebuild the indexes manually or with a schedule.