Purging Execution History

If you have many flows, or services that are used frequently, the execution history in Spectrum Management Console can become quite large. This procedure describes how to remove old records from the execution history. You may want to purge old records to reduce the size of the configuration database. Purging records before upgrading to a new version can help reduce the time it takes to upgrade Spectrum Technology Platform.

There are two purge methods:

  • Purge records:
    com.pb.spectrum.platform.configuration:manager=ArchiveTransactionManager
  • Purge records and provide archive status:
    com.pb.spectrum.platform.transaction:manager=archiveTransactionManager

    The steps below demonstrate the "purge records" (non-archive status) request.

Note: To purge execution history for all nodes on a cluster, perform the purge on each node individually.
  1. Open a web browser and go to http://server:port/jmx-console

    Where:

    server is the IP address or host name of your Spectrum Technology Platform server.

    port is the HTTP port used by Spectrum Technology Platform. The default is 8080.

  2. Under Domain: com.pb.spectrum.platform.configuration, click com.pb.spectrum.platform.configuration:manager=ArchiveConfigurationManager.
  3. Optional: If you want to save an archive of the history that you are going to purge, specify the path where you want to save the archive in the ArchiveDirectory field, then click set. Then, set ArchiveEnabled to true and click set.
  4. In the ArchiveRetain field, specify how many days of records you want to keep in the history then click set.
    For example, if you enter 45 then history records that are 45 days old or newer will be retained, and records 46 days old and older will be purged. To determine how many days of records you can retain, look at the job and process flow history in Spectrum Enterprise Designer and identify the point in time where the number of records exceeds 100,000.
  5. Optional: If you want to schedule a purge to occur on a regular schedule, enter the schedule in the CronExpression field using a Cron expression.

    A cron expression consists of six space-separated values, with an optional seventh value:

    • Seconds
    • Minutes
    • Hours
    • Day of the month
    • Month
    • Day of the week
    • Year (Optional)

    For example, this expression would purge the execution history at midnight every Sunday:

    0 0 0 ? * SUN

    For more information about cron expressions, see Quartz Scheduler Documentation.

    After specifying a cron expression, click the set button next to the CronExpression field, set PurgeEnabled to true, and click the set button next to the PurgeEnabled field.

    Note: You do not need to schedule purges if you want to purge the history only one time for the purposes of speeding up the upgrade process.
  6. Optional: If you want to set a maximum number of records to remain in the history after the purge, specify the maximum number of records in the MaxHistoryRecordCount field.
    This is useful if you have a large number of history records each day, and even after purging old records based on the value in the ArchiveRetain field, the size of the execution history is still larger than you want. After purging the old records based on the value in the ArchiveRetain field, additional records will be purged until the number of records that remains is equal to the number in the MaxHistoryRecordCount field. If you do not want to specify a maximum number of history records, specify -1.
    Note: The limit you specify in MaxHistoryRecordCount sets the limits for process flows and jobs separately. For example, if you specify 5000, the maximum number of process flow history records will be 5,000, and the maximum number of job history records will be 5,000, for a total maximum number of 10,000 records.
  7. In the PurgeOperation field, leave the value set to ALL.
  8. Select All MBeans to return to the main JMX Console screen.
  9. Under Domain: com.pb.spectrum.platform.configuration, select com.pb.spectrum.platform.transaction:manager=ArchiveTransactionManager.
  10. To run the purge, click Invoke.

This purges the execution history so that you now have a smaller configuration database.