Use a script in Windows for a docbase backup

IXIA TEXTML Server provides a script to perform your Content Store docbase backup as a background task.

The script BackupDocbaseAuto.vbs is stored at:
<textml_install_dir>\AdminScripts\vbs

where

<textml_install_dir> is the directory where the docbase for IXIA TEXTML Server is installed, such as:

C:\Program Files\IxiaSoft\TextmlServer\AdminScripts\vbs
Note: Content Store data is stored in a IXIA TEXTML Server docbase. To back up your Content Store, you must back up the docbase.

There are two very different approaches to a system backup for your docbase. For more information, read the following article about backup and replication: https://www.computerweekly.com/feature/Storage-101-Replication-vs-backup-and-synchronous-vs-asynchronous.

  1. Synchronous backups are a linear process that runs the entire script continuously and in real-time to create a complete copy or clone of the specified files and then waits for confirmation of success before it returns to the command prompt. While it provides a high level of data protection, it involves higher latency and can slow the other applications on the system.
  2. Asynchronous backups are a multi-thread process used in a distributed environment that runs the script while it is performing other tasks and can manage the data transfer to optimize performance and availability, but with greater risk to the dataset.

To use a script in Windows for a docbase backup:

  1. Open a command prompt and navigate to the vbs directory, such as: 
    cd C:\Program Files\IxiaSoft\TextmlServer\AdminScripts\vbs
  2. Run the script as follows: 
    cscript BackupDocbaseAuto.vbs <servername[:port]> <docbase name> <targetDirectory> [<backupflag> <username> <password>]

    where:

    OptionDescription
    <servername[:port]> IXIA TEXTML Server filename and port that contains the docbase for backup, using a default value of localhost:2500
    <docbasename> Name of the docbase to back up
    <targetDirectory> Full path to the folder for the docbase backup

    For example: C:\docbase_backups\4.4\docbaseA

    <backupflag> Type of Windows backup where you enter one of the following values:
    • 0: The script runs a synchronous backup.
      Note: If the specified target directory already exists, the script aborts with an error message of "The destination path is not empty" and the docbase backup does not run.
    • 1 (or TEXTML_BACKUP_OVERWRITE): The script runs a synchronous backup and, if the specified target directory exists, it deletes the existing directory before it runs the docbase backup.
    • 2 (or TEXTML_BACKUP_ASYNC): The script runs an asynchronous backup and, if the specified target directory exists, the script aborts with the "The destination path is not empty" error message.
    • 3 (or TEXTML_BACKUP_OVERWRITE+TEXTML_BACKUP_ASYNC): The script runs an asynchronous backup and, if the specified target directory exists, it deletes the existing directory before it runs the docbase backup.
    The default value is 0.
    <username> <password> The name and password of the user with the IXIA TEXTML Server System Administrator's role used to run the backup.

    For example:

    cscript BackupDocbaseAuto.vbs localhost:2500 SportsStories c:\docbase_backups\4.4\SportsStories TEXTML_BACKUP_OVERWRITE
    When the backup starts, IXIA TEXTML Server creates a file called backuperror.tmp in the target directory. If the backup completes successfully, this file is replaced with the backup.info file.
  3. To confirm that the backup was successful, look in your target directory.
    • If the backup.info file is present, then the backup successfully completed.
    • It the backup completed but the backuperror.tmp is present, then an error occurred and the backup is corrupt.

    For example:

    The backup ran and you either confirmed its success or began to troubleshoot the problem.