Perform an on-demand backup of the docbase

If you need to manually trigger a backup of the docbase, you can launch the backup from the TEXTML Server interface.

To trigger a backup:

  1. On the computer where the TEXTML Server is installed, create a directory for the backups.
  2. Open the TEXTML Server Console Java and connect to the server.
  3. Right-click the docbase and select Backup.
    The Start backup window opens:

    Figure: Backing up a docbase



    Important note:

    BEWARE: If the destination folder is not empty, TEXTML Server deletes the contents of the folder before starting the backup.

  4. In the Directory Path box, type the full path to the folder you created for the docbase backups.
    For example (replace [version] by the release version) :
    /docbase_backups/[version]/docbaseA
    Note: The TEXTML Server service or daemon *must* have write privileges to the top-level folder storing the backups; for example, the docbase_backups directory.
  5. Click OK.
    The backup is initiated. To verify, look in the Properties view under General > Status. When the backup is initiated, the value for Status changes from Ready to Ready Backing-up.

    Figure: Example of Properties view:

    Docbase backup status in Properties view
  6. Wait while the backup occurs. Depending on the size of the docbase and your server activity, this could take considerable time.
    Note: While the backup is occurring, a temporary file is created (backuperror.tmp) under the backup folder. If no errors occur during backup, this file is deleted and a new file called backup.info is created when the backup is complete.
  7. To check if the backup is complete, refresh the Properties view by clicking a different docbase and then click back again.
    When complete, the Status changes to Ready.
  8. 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.

    On Linux:
    <textml_install_dir>/<instance_name>/log/
    For example:
    /opt/ixiasoft/textmlserver/ts01/log/