Using the MassTransit Windows Backup Application

1 Star2 Stars3 Stars4 Stars5 Stars
  • Product:
  • Version:
  • Document Type:
  • Revised:
  • Reviewed:


This article describes how to configure and use the Windows Backup Application in order to automate the backup of MassTransit Enterprise files and databases.

MassTransit Enterprise customers with current Maintenance & Support contracts can contact us at to receive the backup application.


What the backup application does
The Windows Backup Application backs up MassTransit files and databases to a separate directory – these archives can later be used to restore the MassTransit in the event of a database failure, or to revert the state of MassTransit to any previously backed-up state. In order to gain access to files and databases that are locked by MassTransit while it is running, the backup application shuts down MassTransit, copies the files, and then re-launches MassTransit. The backup application will not shut down MassTransit if there are any active file transfers.

Backups are stored in a configurable directory – this directory can be on the same physical drive, on a different drive, or even on a (mounted) network volume. Backups are stored in a directory containing the date and time of the backup, so backups on different dates can be easily distinguished.

All Backup Application files should be extracted into a single directory. The only other installation step is to register ntsvc.ocx – to do that, execute the following command on the command line (while in the Backup Application directory):
regsvr32 ntsvc.ocx

Configuration – the backup.ini file
Configuration parameters are stored in the backup.ini file:

; Folder containing the MassTransit application
MTFolderPath = C:\Program Files\MassTransit

; Destination folder for the backup files
MTBackupPath = C:\Program Files\MassTransit\Backup

; Minutes between retries (the backup application will check every NumMinutes to see if there are no active transfers)
NumMinutes = 1

; Maximum retries before aborting
MaxRetries = 10

There are four configurable parameters:
1. MTFolderPath – This is the folder containing the MassTransit application that will be backed up. Some examples of valid values for this parameter:
C:\Program Files\MassTransit
\\Computer\Volume\MT [a remote (mounted) volume]

2. MTBackupPath – This is the destination directory – the backed-up files will be placed within this folder (inside a timestamp folder). Some examples of valid values for this parameter:
C:\Program Files\MassTransit\Backup [on the same drive as the MassTransit installation]
D:\Backup [on a different drive]
\\Computer\Volume\Backup [a remote (mounted) volume]

3. NumMinutes – The backup application will not shut down the MassTransit application if there are any active transfers. This parameter indicates the number of minutes the backup application will wait before retrying. This value should be an integer value of at least 1.

4. MaxRetries – The maximum number of retries the backup application will attempt before it aborts the backup. This value should be an integer value of at least 1.

Running the backup application
The backup application can be run in two primary ways – manually, and via the Windows Task Scheduler – and against MassTransit running both as an application and as a service. In order to backup MassTransit when running as a service, the backup application itself must also run as a service. To install the MassTransit Backup Service, launch the InstallBackupService.bat batch file.

Running the backup application manually is simple – to backup MassTransit running as an application, launch the RunBackupApp.bat batch file, and to backup MassTransit running as a service, launch the RunBackupService.bat batch file.

Running the backup application via the Windows Task Scheduler allows the backup application to be automatically executed in a scheduled manner, such as once a day or once a month. The Windows Task Scheduler can be found in the Windows Control Panel as “Scheduled Tasks”. Simply point the Scheduler to the RunBackupApp.bat or RunBackupService.bat batch files as needed.