You can use the Term Transfer Tool to create and restore database backups of your entire terminology database.
To create a database backup, run the Term Transfer Tool with the following command:
$ bash ./transfer.sh --createDump -u <userName> -p <password> -s <server> -o <filename>
Example
transfer.bat --createDump -u admin -p fR9YUrA8 -s acrolinx.test.com -o c:/dumps/25MAR2012.xml
To restore a database backup, run the Term Transfer Tool with the following command:
$ bash ./transfer.sh --restoreDump -u <userName> -p <password> -s <server> -i <filename>
Example
transfer.bat --restoreDump -u admin -p fR9YUrA8 -s acrolinx.test.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 it creates 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"):
Option |
Description |
---|---|
-? (--usage or --help) |
(Optional) Displays help for the arguments. |
--createDump |
Create a database backup file. |
--restoreDump |
Restore a database backup file to the Terminology Manager. |
-s (--server) <serverAddress> |
Set the address of your Acrolinx Platform. Example: |
-u (--user) <userName> |
Set the username that you use to sign in to the Acrolinx Platform. |
-p (--password) <password> |
Set the password that you use to sign in to the Acrolinx 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. NoteNote 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: |
-i (--input) <filePath> |
The file location of the database backup that you’re restoring. Example |
-n (--noCheckCertificate) |
(Optional) Prevent the Term Transfer Tool from checking the server certificate when using HTTPS. |
-v |
(Optional) Prints the version information to the command line. NoteIf this option is present, the tool will ignore all other options and only print version information. |