Back up a docbase using a script

The TEXTML Server provides a script to back up your docbases as a background task.

This script, called backupdocbase.pl, is stored in the following location:
<textml_install_dir>/<instance_name>/perl

Where <textml_install_dir> is the directory where the TEXTML Server is installed and <instance_name> is the name of the TEXTML Server instance. For example:

/opt/ixiasoft/textmlserver/ts01/perl

On the server where the docbase is located:

  1. Go to the perl directory:

    For example:

    cd /opt/ixiasoft/textmlserver/ts01/perl
  2. Run the script as follows: 
    ./backupdocbase.pl -sn <servername[:port]> -dn <docbasename> -td <targetPath> [-fg <backupflag> -u <username> -p <password> -timer]

    Where:

    Option Description
    <servername[:port]> Name and port of the TEXTML Server that contains the docbase to back up; default value is localhost:2500
    <docbasename> Name of the docbase to back up
    <targetDirectory> Full path to the folder where you want to back up the docbase. The user that is running the TEXTML Server service *must* have write privileges to the target directory.

    For example: /docbase_backups/4.5/docbaseA

    <backupflag> Type of backup; enter one of the following values:
    • 0: The script runs synchronously (that is, it runs completely before returning to the command prompt). If the specified target directory exists, the script aborts with the "The destination path is not empty" error message and the docbase is not backed up.
    • 1: The script runs synchronously and, if the specified target directory exists, it deletes it before backing up the docbase.
    • 2: The script runs asynchronously (that is, it immediately returns to the command prompt). If the specified target directory exists, the script aborts with the "The destination path is not empty" error message and the docbase is not backed up.
    • 3: The script runs asynchronously and, if the specified target directory exists, it deletes it before backing up the docbase.
    Default value is 0.
    <username> <password>] TEXTML Server admin role's user name and password used for running the backup.
    -timer Returns the duration (in seconds) of the backup operation. Optional.
    Note: If you do not specify any argument when running the script, the script will prompt you for the required information.

    For example:

    ./backupdocbase.pl -sn localhost:2500 -dn SportsStories -td /docbase_backups/4.5/SportsStories -fg 1 -timer
    When the backup starts, the TEXTML Server creates a file called backuperror.tmp in the target directory. This file is replaced with the backup.info file if the backup completes successfully.
  3. To confirm that the backup was successful, look in your target directory:
    • If the backup.info file is present, then the backup was successful.
    • It the backup is completed but the backuperror.tmp is present, then an error occurred and the backup is corrupted.

    If an error occurs, or to get more information about the backup operation, look at the logs. They are available in the log directory.

    <textml_install_dir>/<instance_name>/log/

    For example:

    /opt/ixiasoft/textmlserver/ts01/log/