Scheduling database backups and cleanups for the OnGuard plugin - OnGuard 5.1.3

Lenel OnGuard Plugin Guide 5.1.3

Applies to
OnGuard 5.1.3
Last updated
Content type
Guides > Plugin and extension guides
Plugin and extension guides

It is important to protect your data by scheduling regular database backups. Also, regularly clean your database to remove old data so that the database does not grow beyond its capacity. If the database is full, your integration might stop working.

Before you begin

Ensure you have the following privileges:
  • View role properties
  • Modify role properties
  • Administration > Plugins

What you should know

The plugin role database stores the following:
  • Events that occur in the OnGuard system (timestamp of the event being raised, entities attached to the event, etc.)
  • Active alarm triggers and those pending acknowledgment.

The Directory database stores the plugin configuration and related entity types.


  1. From the Config Tool home page, open the Plugins task.
  2. From the entity browser, select the OnGuard plugin role and click the Resources tab.
  3. Click Cleanup (), choose how long to keep events and when to delete old data, and then click OK.
    NOTE: By default, the Keep data setting is set to 30 days and the Clean each setting is set to custom and has no clean up day specified. This means that data will never be cleaned up unless you select a day on which it will occur.
  4. Click Backup/Restore (), choose the location for backup files, enable automatic backups at least once per week, and then click OK.
  5. Click Apply.