BTR Backup Client Software Guide
|Running The Backup Client||User Interface||Client System Tray Program|
|Command Line Options|
|Use of Anti-Virus|
Connecting to a Backup Server
· What is the Backup Server?
When the Backup Client performs a backup, the data is transmitted to a Backup Server. The Backup Server is the destination system where the backup data is processed and stored. The data, which is encrypted, remains stored on the Backup Server and is available to be restored at any time.
· Where is the Backup Server?
The Backup Server can be accessed via the Internet. The IP Address or host name of the remote system must be known.
· What is a User Account?
The Backup Client must first connect to a valid user account on the Backup Server before attempting a backup. BTR Services is responsible for configuring backup users (i.e. accounts) on the Backup Server. User accounts require a username and password, and are configured with specific options pertaining to each particular account.
Running the Backup Client
· Starting the Application
After the Backup Client has been installed, there are a number of different ways to easily start the application.
· Select the Backup Icon on the Desktop.
· From the Start Menu, click on the Backup icon in the Programs folder.
· Double-click the Backup Tray Control icon in the task bar or right-click the icon and select "Run Backup Client".
· Accessing the Configuration Options
The configuration options can be accessed in two different ways.
· From the Backup Client, select View, Options from the menu
· Right-click the Backup Tray Control in the Task Bar and select Options | General.
More information about setting the configuration options can be found in the Help Topics under the Configuration section.
· Setting the Destination and Username Fields
Although many of the default configuration options are sufficient, some fields must be specifically set before getting started.
· In the "Destination" option tab, the location of the Backup Server, the username, and the password must be set. A backup will not start unless these options are filled in.
· If a modem is being used to connect to the Backup Server, the appropriate Dial-Up Networking option must be selected from the "Connection" option tab.
NOTE: It is important to verify that the configuration options described above are set correctly before performing a backup.
· Using the Application
After the basic configuration has been completed, the Backup Client application can be used to select files, run backups to either a local or remote server, and modify configuration options. It can also be used to restore files that were backed up to the Backup Server.
· Warning: Use of Anti-Virus Applications with the Backup Client
Anti-virus applications that incorporate "real-time" scanning can cause conflicts and improper operation of the Backup Client.
In order to run the Backup Client and anti-virus applications together, you must "exclude" the Backup Client's temporary working directory from the scan list. Refer to your anti-virus application documentation for the necessary steps.
The actual path of the working directory, which defaults to <Backup Client Path>\Backup, can be located by selecting View->Options->Backup->Advanced Tab. The path is listed under "Temporary Files Folder".
The user interface consists of a single main screen. This screen has three Tabs at the top. These tabs are for each of the three main functions of the program: Backup, Restore and Logging. The desired function can be displayed by clicking on the appropriate tab.
The interface looks very similar to the Windows Explorer, which makes it familiar and easy to use. Selected files can be browsed by expanding the drives or network resources in the tree view display on the left-hand side. Next to each folder and file is a checkbox. These are used for adding and removing files from the selection list.
Right-clicking on files and folders will produce a menu specific to that item. For instance, if the "Properties" option of a backed up file is selected in the restore view, it will display its backup history.
Viewing the selection history
A button on top of the list view indicated which directory is currently being viewed in the list view. If this button is pressed, a list of selection histories will be displayed. Selecting one of these history entries will change the selection.
Selecting files and folders
There are several different ways of selecting and unselecting files in the Backup Client:
1. Clicking on a checkbox
Clicking on a checkbox will select or unselect files. By default, when a folder checkbox is clicked, all the subordinate files and folders will be added to the selection list.
Note: When selecting files for backup, any new files created under a selected folder will be automatically added to the file selection the next time the backup client is run. If you wish to only include specific files in the backup, but not new files, you must uncheck the parent folder and select only the files you desire to have backed up.
2. Using a Filter
If a folder is selected, there will be two options under the "Edit" menu labeled "Apply Filter" and "Quick Select". The "Apply Filter" menu item allows a specific filter to be applied to the selected folder. In this way, filters may be used to include and/or exclude files during every backup. Optionally, the "Quick Select" menu item may be selected to perform a one-time backup using the selected filter(s). Customized filters can also be created with the filter wizard
3. Right-clicking on an item
Right-clicking on an item will display a menu of commands. If the item is a file, the first two commands will enable a file to be selected or unselected. If the item is a folder, the first two commands will enable either one level under the folder or the entire subtree to be selected or unselected.
4. Selecting multiple items in the list view
Multiple items can be selected in the list view by using the <Ctrl> or <Shift> key when clicking on individual items. When multiple items are selected, clicking on the checkbox of one of the selected items will select or unselect all of the items.
Client System Tray Program
The Backup Client Tray Control program runs in the Windows System Tray located at the opposite end of the Start button on the Task Bar. It serves as the Backup Client "command center". This program includes several useful commands that are easily accessible. If the Tray Control icon is double-clicked without the application running, the Backup Client application will be launched. If the Tray Control icon is double-clicked with the application already running, the Backup Client window will be brought into view. The Tray Control provides the following commands by right-clicking on the Tray Control icon:
· Run Backup Client or Close Backup Client
If the Backup Client is not running, the "Run Backup" option will launch the program and wait for user interaction. If the Backup Client is running, "Close Backup Client" option will close the application.
· Backup And Close
This pop-up menu allows a backup set to be selected for backup. When the backup has completed, the application will close.
· Backup and Logoff
This pop-up menu allows a backup set to be selected for backup. When the backup has completed, the Backup Client will attempt to logoff of the computer.
· Backup and Shutdown
This popup menu allows a backup set to be selected for backup. When the backup has completed, the Backup Client will attempt to shutdown the computer.
· Backup and Restart
This popup menu allows a backup set to be selected for backup. This option will immediately start a backup and attempt to have all other running applications save their data. After all applications have responded to the save request, a backup will be performed. Once that backup has completed, a system reboot will take place.
· Perform Full Backup
This popup menu allows a backup set to be selected for backup. A full backup will be performed on the selected backup set. This option will back up all selected files, regardless of whether the files have changed.
· View Backup Sets
This command will display the current list of backup sets and allow backup sets to be added, removed or modified.
· View Backup Schedules
This command will display the current list of schedules and allow schedules to be added, removed or modified.
· View Missed Events
This command will display the current list of failed backups and overdue schedules and allow outstanding events to be performed.
· View Latest Backup Log
This command will open the most recent backup log file in Notepad. The entire log file can be viewed without running the Backup Client application.
This function permits you to start and stop the scheduler service if installed, and install the service if it’s not already installed on Windows XP, 2000 and 2003. (Note: scheduler must be run in "standalone" mode on 98SE, ME and NT)
This popup menu allows any available tools to be customized. These tools can be executed before or after a backup or restore.
This popup menu allows the three Options windows, "General", "Backup" and "Restore", to be displayed.
This option will display the Backup Client "About" box, which contains version and support information.
This option will launch the online help for the Backup Client application.
This option will close the Backup Client Tray Control program in the task bar. If scheduled backups are configured in the Backup Client, they will not execute unless either the Tray Control or the main Backup Client application is running. However, scheduled backups can also be executed using many third-party program schedulers. More information can be found in the "Command-Line Option" section.
Command Line Options
The following command line options can be used with the Backup Client application:
BACKUP - This option will immediately start a backup and close the application when the backup has completed. The backup will execute in a timed backup mode, which means that there will be no dialogs displayed indicating the result of the backup.
BACKUP INTERACTIVE - This option will immediately start a backup and close the application when the backup has completed. The backup will execute in an interactive backup mode, which means that there will be dialogs displayed indicating the result of the backup. This backup method should be used if it is possible to answer any dialogs that the Backup Client application might display.
BACKUP and LOGOFF - This option will immediately start a backup and attempt to have all other running applications save their data. After all applications have responded to the save request, a backup will be performed. Once the backup has completed, the system logoff will take place. This option is also available by right-clicking on the tray control and selecting "Backup and Logoff".
BACKUP and EXIT - This option will immediately start a backup and attempt to have all other running applications save their data. After all applications have responded to the save request, a backup will be performed. Once that backup has completed, the system shutdown will take place. This option is also available by right-clicking on the tray control and selecting "Backup and Shutdown".
BACKUP and RESTART - This option will immediately start a backup and attempt to have all other running applications save their data. After all applications have responded to the save request, a backup will be performed. Once that backup has completed, a system reboot will take place. This option is also available by right-clicking on the tray control and selecting "Backup and Restart".
· -bs or -s
This option can be used to specify backup sets that will be backed up. The full name of the backup set (including spaces) must be specified and this option can be used more than one time on the command line.
Ex: -bs My Backup Set -bs Other Backup Set
This option can be used to allow a "full backup" to be performed for the backup sets specified on the command line.
· -i or -a
This option can be used to allow an "auto-detect backup" to be performed for the backup sets specified on the command line. This is the default behavior.
This option can be used to completely hide the application during the backup.
TIP: Other scheduler programs can be used to perform automated backups. The scheduler can be setup to run the Backup Client application with the -b option, and automatic backups will occur according to the defined schedule. The backup sets that should be backed up can be specified with the -bs option.
For every backup performed a log file is generated by the backup client. The number of log files available for review can be set by the user. The default number of log files to be maintained by the backup client is 40. The user should review log files on a regular basis. Log files list every file backed up, how it was backed up, the amount of compression, how long it took to transmit and several other data points. Log file review is extremely important and should not be overlooked. Log files are the leading indicator of failed/missed backups and their cause. The backup client can be configured to send an email with the backup results and the log file attached. BTR Services highly recommends this option for this allows the user to monitor the backup procedure.
BTR services offers "active monitoring" services. Please inquire for further details.mailto:firstname.lastname@example.org
All backup systems should be monitored for performance and relibility. This includes all services provided by BTR. All users should be familiar enough with the format of the log file to be able to detect errors.
By default the BTR client is configured to keep 40 log files. This may sound excessive however if multiple schedules are defined, and run dailey, 40 log files will not be enough to log more than 2-3 weeks of activity. The BTR client can be configured to send an e-mail with the log file attached to any mail recipient. This is an very nice feature that verifies the backup function.
The fastest way to access the log file using the BTR client, is to right click on the Backup Client Tray Control program icon in the system tray, and select "view latest log..." and the latest log file will open in the "notepad" application.
If you open the BTR client backup application, clicking on the the third tab will list all log files available.