Scheduling Otis Compass database backups and cleanups - Otis Compass 3.2.1

Otis Compass Destination Dispatch Plugin Guide 3.2.1
Product
Otis Compass
Content type
Guides > Plugin and extension guides
Version
3.2
Release
3.2.1
Language
English
Last updated
2023-10-12

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.

What you should know

  • The Directory database contains all of the Otis Compass entities and custom events definitions.
  • The plugin database contains all Otis Compass event notifications.
  • It is a best practice to schedule the database maintenance during non-peak hours.

Procedure

  1. From the Config Tool home page, open the Plugins task.
  2. From the entity browser, select the Otis Compass 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.
    Database cleanup window showing data retention policy set for 90 days and cleaning scheduled for Sundays at 2:00 am.
    NOTE: By default, the For (keep data) setting is set to 90 days and the Clean each setting is set to Custom and no cleanup day is specified. Select the days on which the cleanup should take place. Otherwise, the cleanup will not run.
    Database cleanup window showing data retention policy set for 30 days and cleaning scheduled for every day at 11:00 pm.
  4. Click Backup/Restore (), choose the location for backup files, enable automatic backups at least once per week, and then click OK.

    For more information, see Backing up databases.

  5. Click Apply.