Purging Audit Data

The audit entries for a process instance are not required once the process instance completes, is cancelled, or has failed.

The AuditService API provides functions to manage purges of audit data from the Event Collector database tables—that is, to delete the audit entries and statistical data for completed, cancelled, and failed process instances.

The AuditService provides the following functions for purging:

  • doPurge - This function purges data from the Event Collector database tables. Its options enable you to define the scope of the purge.
  • stopPurge - This function stops an ongoing purge.
  • checkPurge - This function checks the status of an ongoing purge.
    Note:
    • The functionality provided by this service is equivalent to that of the administrator-initiated stored procedures described in the section "Clearing Audit Entries and Statistical Data" in the TIBCO ActiveMatrix BPM - Administration guide.

      The performance of the data purges described in this section will be greatly improved if you create the same database indexes that you are recommended to use with these stored procedures. See the section "Clearing Audit Entries and Statistical Data" in the TIBCO ActiveMatrix BPM - BPM Administration guide for the syntax to use for each of the supported database types.

    • TIBCO recommends that you back up your database, according to whatever backup strategy your organization has implemented, before running doPurge or initiating the equivalent stored procedure. Refer to the documentation supplied with your database server for information on how to do this.