Channergy Backup and Restore Utility

Introduction                                Buy Now

LGD has released a new, more complete backup utility for our Channergy customers.  It offers more flexibility where the files are backed up and includes not only the database tables but any reports that are associated with them.  Here is a list of the features that are included

  • It stops the MCM and any other services that may be running at the time to get a complete data backup and restarts them when the processes are complete.
  • It has the option to backup the reports and scripts stored in the client server folder.
  • It allows users to restore the database and client server data to new folders.
  • It includes a module that allows automatic backups to be run using the Windows task scheduler.

Note:  This utility is designed to only work with Channergy 2019 build 1907 or later.

Installation and Setup

Backup File Location

The backup utility will be installed in your Channergy program files  folder.  When the application is first installed, it assumes that your backup folder will be the default backup folder that Channergy uses.  However, if you want the data backed up or synchronized to a cloud based drive such as Google Drive or Drop Box, you can change the default backup folder location by clicking on the Select backup folder button and selecting a different folder

 

Client Server Files

If you have a Channergy Client Server setup you will need to set up the location for the client server folder in the Channergy Backup Settings window by Clicking on the Select Client Server Folder button.  This will open an Open File dialog box and allow you to select the folder that contains the clientserver.ini file.

Once you have selected the clientserver.ini  file click on the Open button in the dialog, this will update the folder in the Channergy Backup Settings window.

Creating a Backup Set Manually

To create a manual backup of your Channergy data scripts and reports, click on the Backup Database button.  The application will stop the installed services (MCM,Client Server and FTP utilities) and copy the files into a temporary folder.

Once the data have been copied to the temporary folder a folder is created in your backup  folder path that is in the form of YYYYMMDDHHmmSS inside that folder there will be either one or two files added depending on if you have a client server installation or not.

The database tables (and related reports and scripts) will be in a file that begins with CHData followed by a time stamp with a .chb extension.  If you have a client server setup there will be a file that starts will begin with CHCS followed by a time stamp with a .chb extension.

When the backup process is complete the installed services will be restarted.

Restoring Database Files

The Channegy backup utility enables you to restore the files to the default location(s), as defined in the settings window or to another location.  To start the restore process click on the restore database button.  That will load the Restore Data window.

Since the database tables and the client server files are stored in different locations, you will need to select which type of data you are going to restore.  You can do that by selecting the type of data you will be restoring from the Select Data Type combo box.  Depending on which data type you select the Restore To Folder will load the default path from the settings in the Channergy Backup Settings window, in the image below the Database Tables option was selected and the default database location was added to the Restore To Folder field.

 

Likewise if the Client Server Files option is picked, the default client server folder location was added to the Restore To Folder field.

Changing the Restore To Folder location

There may be times where you want to restore the data to a different location.  You can do that by select the Change folder button.  This will load a Browse for folder window. 

Once you select a new folder, the new location will be loaded into the Restore To Folder field

Selecting the Data to Restore

When you click on the Select Backup File button, the application will load a list of folders in the Backup Folder location.

After selecting the backup set you want to restore, the application will list the files that match the selection that was made in the Select Data Type combo box.  In the example below, the Database Tables option was selected.

If the Client Server Files option was selected, the application will only allow you to select files that contain client server file data.

Once you have selected the file you want to restore, the Restore Data window will look similar to this.

When you click on the Restore Data button, the application will stop the installed services and restore the data to the location selected.

When the process is complete, the services will be restarted.

Setting Up Daily Backups

The Channergy backup utility includes an application that is designed to be run from the Windows Task Scheduler and allows backups to be run on a regular basis.  In order for this utility to work correctly, the paths in the Channergy Backup Settings window need to be set up first.  This information is designed to be used by individuals familiar with using the Windows Task Scheduler.

The Channergy Backup and Restore utility includes a file called ChannergyBackup.exe.  This file needs to be stored in the Channergy program files folder and will be the application that is launched from the task scheduler.

Creating the Scheduled Task

To set up a scheduled task in Windows, type Task Scheduler in the search box.

Click on the Create Task… link in the right navigation panel. 

Set up the scheduled task as follows

General Tab

  • Give the task a meaningful name.
  • Select the Run whether user is logged in or not option.

Triggers

In the Triggers tab click on the New… button.  In the New Trigger window set the options as follows:

  • Begin the task: On a schedule
  • Settings: Click on the Daily option
  • Set the Recur every option to 1 days.
  • Start: Select the date and time you want the task to start.
    • It is highly recommended that you select a time that is not during business hours.
  • Click on the Stop task if it runs longer than: check box.
  • Select the 2 hours option

The trigger window will look similar to this:

 

Actions

In the Actions tab click on the New… button.  In the New Action window set the options as follows:

  • Action: Keep the Start a program option.
  • Click on the Browse… button and load the file location of the ChannergyBackup.exe into the program/script text box.

The New Action window will look similar to this

The remaining tabs in the Create Task window do not need to be changed from their default.  When you click on OK to close the Create Task window you will be prompted to add a user name and password of a user that has administrative privileges on the server.   This will allow the task to run without being logged into the system.