Before You Begin

Use the following instructions to backup and restore HelpSystems Insite 3.0 or above on the same system. To backup or restore on Insite installations before 3.00, see Backing Up and Restoring HelpSystems Insite 2.x and 1.x.

Backing Up and Restoring HelpSystems Insite 3.00+

There are two executables used to backup and restore HelpSystems Insite (backup/.exe and restore/.exe). Both files reside in the HelpSystems Insite root directory on the server.

Environment Location
Windows C:\Program Files\Help Systems\HelpSystems Insite\
Linux (Root install) /opt/insite/{backup|restore}database.sh
Linux (User install) {USER_HOME}/insite/{backup|restore}database.sh

Note: In order to use these scripts, the database service must be running.

Backing Up HelpSystems Insite

To back up the database, run the following command:

  • Windows: backup.exe
  • Linux: ./backup

This command creates multiple backup files and puts them in the root directory of the product. The command will list the backup files created at the end of the command output.

Database Dump location: c:\Program Files\Help Systems\HelpSystems Insite\insite_db_3_00_<timestamp>.backup

Integration config backup: c:\Program Files\Help Systems\HelpSystems Insite\integration_config_<timestamp>.zip

Watch List Coordinator configuration: c:\Program Files\Help Systems\HelpSystems Insite\wl_coordinator_config_<timestamp>.zip  

Watch List Coordinator database: c:\Program Files\Help Systems\HelpSystems Insite\watchlist_db_<timestamp>.zip

Watch List Collector: c:\Program Files\Help Systems\HelpSystems Insite\wl_collector_config_<timestamp>.zip

PTAV Service: c:\Program Files\Help Systems\HelpSystems Insite\ptav_service_config_<timestamp>.zip

Note: If you are backing up Insite in preparation for an upgrade, be sure to copy the backup file to a location outside the product directories.

Restoring HelpSystems Insite

Notes:

  • We highly recommend that you stop the HelpSystems Insite Server service and the HelpSystems Insite Analytics Service before performing a restore.
  • The database service (HelpSystemsDatabaseServer) must be running.
  • You must be at the same Insite version as the backup that you are trying to restore. For example, you cannot restore a 3.00 backup over a 3.02 installation.

To restore the database, run the following command (found in the HelpSystems Insite root directory):

  • Windows: restoredatabase.bat
  • Linux: ./restoredatabase.sh

This command takes a backup file created by the backup command and restores it to the database.

The file path is passed to the script.

Command example:

(Windows) restoredatabase.bat insite_db_3_00_<timestamp>.backup

(Linux) ./restoredatabase.sh -f insite_db_3_00_<timestamp>.backup

 

To restore the Integration, Watch List, and PTAV configuration, run the following command (found in the HelpSystems Insite root directory):

  • Windows: restore.exe
  • UNIX/Linux: restore

This command takes the zip files created by the backup command and restores them.

The file path is passed to the command.

Command examples:

restore -i integration_config_<timestamp>.zip

restore -wlCoord wl_coordinator_config_<timestamp>.zip  

restore -wlDB watchlist_db_<timestamp>.zip

restore -wlCol wl_collector_config_<timestamp>.zip

restore -ptavService ptav_service_config_<timestamp>.zip


Still have questions? We can help. Submit a case to Technical Support.

Last Modified On: December 09, 2019