Skip to main content
 

How can we help?

Search

Backup Your Terminology Database

  • Updated

A database backup is a complete export of your entire terminology database as an XML file. Use database backups to back up your terminology data, or to copy a terminology database to another installation.

A database backup contains all terminology entries as well your entire data model.

Tip

Images that you’ve added to terminology entries aren’t part of the data model and aren’t included in the terminology backup. Instead, they’re stored in the directory. Depending on your installation, your path might look like this <config directory>/server/www/uploadedImages. You'll need to back them up manually.

Important

Make sure that you restore a backup within the same Acrolinx Platform version and not across Acrolinx Platform versions. An Acrolinx Guidance Package update automatically migrates your data, so don't restore your backup to migrate your data.

Create a Database Backup

You can back up your entire terminology database or just the data structure without the terms. The data structure includes any custom categories or fields that you’ve created as well as your import and export configurations. You might back up the data structure without the terms if you want to create a test version of your terminology database on another instance.

To create a database backup, follow these steps:

  1. Navigate to Terminology > Import and Export >Database Backups.

  2. (Only follow this step if you want to back up the data structure without the terms) Select the option Back up the data structure only.

  3. Click Create New Backup.

  4. Click the filename link that appears, and choose where to save the file.

Restore a Database Backup

You can restore a database backup by uploading the backup file in the Dashboard. When you restore a database backup, all existing term entries, Duplicate Detection Rules, layout configurations, custom fields, and categories are overwritten.

To restore a database backup, follow these steps:

  1. Navigate to Terminology > Import and Export >Database Backups.

  2. Locate the database backup file using the Browse button. You can only upload a .xml file type.

  3. Click Restore.

    Tip

    The backup file has the format terminology-dump-YY-DD-MM-HRS-MIN.xml meaning it looks something like terminology-dump-2020-02-25-16-39.xml.

  4. In the security dialog that appears, enter the word yes and click OK.

    Tip

    This type of dialog is an extra precaution to prevent you from overwriting your terminology database unintentionally.

    The import operation starts and a confirmation prompt appears when the import has completed.

  5. Reload all language configurations.

Note

If you don't reload the configurations of all installed language servers, your terms and term help files won’t load correctly.