Configuring Live Purge
Before running a Live Purge operation, Live Purge parameters must be configured via the My webMethods user interface.
To configure the Live Purge parameters
1. In My webMethods Server: Navigate > Administration > Analytics > Data Management > Live Purge
My webMethods displays the Live Purge page.
2. On the Live Purge page, in the General Settings panel, select one of the two available radio buttons.
Depending on your choice, additional fields appear allowing you to define the number of days to retain or the retention period start date for the purge operation.
Select the
Number of Days to Retain (Ending with Today) radio button to specify the number of days for which to retain data in the selected
Optimize database components. Outside the specified number of days, the data is eligible to be purged by the Live Purge operation.
If you select this radio button, an additional field appears. Use this field to define the number of days for which data will be retained during the Live Purge operation. The value must be an integer between 0 and 730 inclusive.
If you specify 0 (zero) in this field, the Live Purge operation will purge all data up to the current time of the day.
If you specify 1 (one), the Live Purge operation will purge all data, except the data for the current day.
If you specify 2 (two), the Live Purge operation will purge all data, except the data for today and the data for the previous calendar day.
The default value for this field is 90.
Select the
Retention Period Start Date (Ending with Today) radio button to specify the period start date for which to retain data in the selected
Optimize database components. All data prior to the specified date will be eligible to be purged by the Live Purge operation.
If you select this radio button, two additional fields are enabled, allowing you to define the start date and time of the retention period. You can use the Calendar icon or directly type the desired date. The value you provide for this setting is validated and an appropriate error message displays if you select a future date.
Note:
If you use DB2, the fields for start time for the Retention Period Start Date (Ending with Today) radio button are not enabled. In this case the data from the whole day will be purged.
3. On the Live Purge page, in the General Settings panel, click the Advanced Settings button. A pop-up dialog displays the advanced settings that you can configure for the Live Purge operation for the Live Purge operation.
The settings that you define here are validated and an appropriate error message warns when the values are not valid.
The following table describes the Advanced settings.
Setting | Description |
Transaction Size (records) | Specifies the maximum number of database records to be purged in a single transaction. The value you provide here must be an integer between 100 and 20000 inclusive. The default value is 3000 records. Note:
It is recommended that you execute the purge operation by smaller sizes. If the value entered in this field is too big, this may impact significantly the performance of the Analytic Engine during the Live Purge operation. |
Sleep Period (milliseconds) | Specifies the wait time between the transactions. The default value is 0. The value you provide here must be an integer between 0 and 30000 inclusive. The default value is 0 milliseconds. Note:
Use this parameter only if the Analytic Engine is under heavy load while the Live Purge operation is running. The larger the value of this field is, the longer it will take for the Live Purge operation to complete, but the performance of the Analytic Engine during this time will be better. |
Time Box (days) | Specifies the length of a timeboxed period in days. Live Purge will delete the data by the timeboxed periods in chronological order, starting from the oldest and moving toward the most recent records. For example, if you define this setting to 5, the data will be deleted by five-day time frames. The value you provide here must be an integer between 0 and 180 inclusive. The default value is 7 days. This parameter allows you to make sure that if the Live Purge operation is stopped by an administrator or terminated abnormally, all data not included in the defined timeboxed period will remain in a consistent state and will be visible to the Analytic Engine. |
Process Instances to Delete | Specifies the status of the process instances to be purged. Two values are possible: COMPLETED - the Live Purge operation will be executed only over completed process instances. ALL (the default) - the Live Purge operation will be executed over all process instances, regardless of their status. |
a. Click Save to save your settings and apply them when you start the Live Purge operation.
You must provide values within the allowed range to be able to save them.
b. Click Cancel to revert to the latest saved settings in the Advanced Settings dialog.
4. In the Selection Criteria panel, check the database components to be purged.
By default the two database components are selected. If none of the components are selected, the Live Purge operation will not be carried out.
The following table describes the Live Purge operation on the database components.
Database Component | Description |
Process Data | Purge process instances |
Analysis Data | Purge KPI readings, problems, etc. |
Note:
The statistics data will not be affected by the purge operation, due to its specific nature and the fact that it is updated incrementally, that is, every time period depends on the previous ones.
5. In the Specific Items to Purge panel, clear the names of specific process models uploaded for analysis only whose data you wish to retain. By default, all process model names are selected.
The table below contains all process models currently uploaded for analysis only on your system. By default, 10 items are displayed. You can use the scroll bar to see the complete list of process models uploaded for analysis only.
When the table contains process names, you can purge data as follows:
Leave all process names selected (by default) to purge all data, including intrinsic metrics and system data as specified with the other criteria.
Select specific process names to purge only the data related to them.
Clear all process names so no data is purged.
When there are no process names in the table, the purge operation will delete only intrinsic and system data.
Note:
When you purge all data related to a specific process model uploaded for analysis only, you can later delete the process model(s) in question by going to Navigate > Administration > Business > Business Processes. Currently, process models uploaded for execution cannot be deleted once they have been used.