Backing up your ElasticSearch data - Transaction Finder

Transaction Finder Plugin Guide

Applies to
Transaction Finder
Last updated
Content type
Guides > Plugin and extension guides
Transaction Finder
Plugin and extension guides

To protect your transaction data during an upgrade, you must create local backups of your transaction data and backup folders on your server.

What you should know

  • To back up the entire system, you must back up the Directory, the plugin role's SQL database and Elasticsearch database.
  • The Elasticsearch page is used to manage the storage of transaction data, including setting the backup and restore parameters.
  • SQL data recovery: If the Elasticsearch database becomes unreachable, full, or corrupted, all incoming transaction data is automatically saved to the SQL database on the plugin server. Once a day, the plugin sends these transactions from the SQL database to the Elasticsearch database. When a transaction is successfully added to Elasticsearch, it is removed from the SQL database.


  1. From the Config Tool home page, open the Plugins task.
  2. Select the Transaction Finder plugin role in the entity browser, and click the Elasticsearch tab.
  3. In the SQL data recovery section, choose the time of day when the plugin will automatically move transactions from SQL Server to Elasticsearch. The default is midnight.
  4. In the Backup policy section, turn on Automatic backups.
    NOTE: If backups cannot be configured when the option is switched ON, the plugin role turns yellow and you receive the following warning:
    The plugin will not back up any Elasticsearch indexes.
    If this occurs, contact Elastic support.
  5. In the Backup frequency field, enter the number of days between each backup.
  6. In the Backup time field, enter the time of day that you want the database backed up.
  7. (Optional) If you want to delete old backups of the Elasticsearch database, do the following:
    1. Turn on Automatic backup cleanup.
    2. In the Number of backups to keep field, enter the number of backups you want to retain.
    3. In the Automatic backup cleanup time, enter the time of day that you want obsolete backups deleted.
  8. Click Apply.