2.5 Maintenance Tab

Path: Retain Server Manager > Configuration > Server Configuration > Maintenance Tab

The Maintenance tab contains the following panels:

Maintaining a Retain system involves many tasks:

Backup Configuration (Embedded) Database
Compress Configuration Database
Zookeeper Purging and Backup

These items are all controlled here.

This configuration database – the “Embedded” database:

Should be backed up regularly
Contains your system address book
Also contains key information used by Retain
Configure how often it gets backed up here.

2.5.1 Maintenance/Caching Panel

Path: Retain Server Manager > Configuration > Server Configuration > Maintenance Tab > Maintenance/Caching Panel

Table 2-17 Using the Maintenance/Caching Panel

Option, Field, or Sub-panel	Information and/or Action
Enable Index Backup	Select this to enable scheduled index backups at the interval specified.
Enable Index Optimization	Select this to enable scheduled index optimization at the interval specified.
Mail Job Report	Specify whether a Mail Job Report is generated.
Purge exported files when older than	Specify how old exported files can be before they are purged.
Run maintenance procedure at	Specify when to run the maintenance procedure.
Delete Zookeeper backup older than	Specify the number of days for which zookeeper backup folder to be retained. Default is 30 days.

Datastore Maintenance

Retain also lists a history of backups and maintenance here.

NOTE:This maintenance section does not involve backup or maintenance of the data store. You must back that up yourself with your normal backup tools.

You must backup:

SQL Database
File System where your data is stored

Zookeeper Purging and Backup

Beginning 23.4 zookeeper data will be purged and backed up when the maintenance job runs. First, the zookeeper data will be purged to maintain the last three files (snapshot<datetime> and log), then the backup of the zookeeper data will happen. The zookeeper backup will maintain the same folder structure as in the zookeeper path.

The following are the zookeeper paths

Default zookeeper path: <basepath>/zookeeper
Default zookeeper backup path: <basepath>/backup/zookeeper/snapshot<datetime>

When the maintenance runs again, it creates a new snapshot folder with DateTime (snapshot<datetime>) and backs up the current zookeeper data, then deletes the old zookeeper data backed up based on the number of days specified in the field: "Delete zookeeper backup older than"

NOTE:Do not delete or modify the zookeeper folder data and the zookeeper backup folder data manually.

Upgrade from a Retain version lower than 23.4 to 23.4 or higher. By default, index backup is disabled.

When upgrading Retain from version 23.4 or later, the index backup specification is maintained

2.5.2 Ignore Domains Panel

Path: Retain Server Manager > Configuration > Server Configuration > Maintenance Tab > Ignore Domains Panel

Table 2-18 Using the Ignore Domains Panel

Option, Field, or Sub-panel	Information and/or Action
Ignored Domains list	A list of Domains that Retain ignores.
Remove Selected Domains	Select an entry in the Ignored Domains list and use this button to remove it.
Domain	Type a domain to be added to the Ignored Domains list in this field.
Add button	Click this to add the typed domain to the Ignored Domains list.

Some mail systems allow for the addition of non-system, or external domains. Sometimes, you might do this to add external domains to the mail system address book. However, the mail system cannot pull up e-mail from these domains and you may want to tell Retain to ignore references to these external domains to avoid wasting time during data collection.

Specify these domains in this window.