Database Backups with the Term Transfer Tool

As well as importing and exporting terms, you can also use the Term Transfer Tool to create and restore database backups of your entire terminology database. By running the Term Transfer Tool as part of a scheduled task, you can create regular backups of your terminology database or synchronize two installations of the Core Platform.

To create and restore database backups with the Term Transfer Tool, version 2.9 or later of Core Platform is required.

To create terminology database backups in the Term Transfer Tool, follow these steps:

Run the Term Transfer Tool from the command line or in your shell environment.

To create a database backup, run the Term Transfer Tool with the following command syntax:

On Windows: 

transfer.bat --createDump -u <userName> -p <password> -s <server> -o <filename>

On Unix-based operating systems: 

$ bash ./transfer.sh --createDump -u <userName> -p <password> -s <server> -o <filename>

Example:

transfer.bat --createDump -u admin -p fR9YUrA8 -s acrolinx.topspin.com -o c:\dumps\25MAR2012.xm

To restore a database backup, run the Term Transfer Tool with the following command syntax:

On Windows: 

transfer.bat --restoreDump -u <userName> -p <password> -s <server> -i <filename>

On Unix-based operating systems: 

$ bash ./transfer.sh --restoreDump -u <userName> -p <password> -s <server> -i <filename>

Example: 

transfer.bat --restoreDump -u admin -p fR9YUrA8 -s acrolinx.topspin.com -i c:\dumps\25MAR2012.xml


A temporary copy of each database backup file is stored in the server output directory. Each backup file expires after 24 hours to preserve disk space on your server computer. The next time you create a database backup, the server deletes all expired files before creating the database backup.

You can use the following options and arguments to create or restore database backups with the Term Transfer Tool script. For each argument, you can use either the abbreviated ("-d") or the full name ("-deploy"):


OptionDescription
-? (--usage or --help)(Optional) Displays help for the arguments.
--createDumpCreate a database backup file.
--restoreDumpRestore a database backup file to the Terminology Manager.
-s (--server) <serverAddress>Set the address of your Core Platform.

If you’re connecting to a secure server, include the port in the Acrolinx URL.

Example: https://acrolinx.example.com:8031

-u (--user) <userName>Set the username that you use to sign in to the Core Platform.
-p (--password) <password>Set the password that you use to sign in to the Core Platform.
-k <API token>

(Optional) Send an API token to the server for authentication and authorization purposes. You can't use this along with the {{-p}} option, which specifies a password.

Note that the user for whom the API token was generated needs to have the "Access API-based terminology applications" privilege.

-o (--output) <filePath>(Optional) Set a relative or absolute path and file name where the file will be saved.

Example -output c:\dumps\25MAR2012.xml

All backup files are first created on the server in the directory:

<INSTALL_DIR>\server\www\output\dashboardExport

If you define a location on your computer, the backup file is then copied to that location.

-i (--input) <filePath>The file location of the database backup that you’re restoring.

Example -input c:\dumps\25MAR2012.xml

-n (--noCheckCertificate)(Optional) Prevent the Term Transfer Tool from checking the server certificate when using HTTPS.

The term transfer can fail when you use the Term Transfer Tool behind a secure reverse proxy on a Unix-based operating system. You can use this option to ensure that the term transfer works behind a secure reverse proxy.

-v

(Optional) Prints the version information to the command line.

If this option is present, the tool will ignore all other options and only print version information.