Purge Match Previews

The Purge Match Previews service task is responsible for deleting the preview data from the Console. The preview data is what is shown in the Location Preview section of the Results Details window. As endpoints send their preview data to the Console, that data is stored in the Console database. Storing large amounts of preview data can over time can consume a large quantity of database storage space which can in turn slow the performance of the Console. When preview information is no longer necessary, you can run the Purge Match Previews service task to free up space and improve performance. You can also set a filter to purge specific preview data as described below.

The Purge Match Preview Service Task has the following options:

Field Description
Information This text field is used to provide a description of the purpose of the Purge Match Previews task being created and is only present to help users manage their tasks.
Filter

A filter can be applied to help identify the correct data points. To apply a filter simply click on the filter option from the drop-down, select the filter to use, then configure the sub-options for each filter type and click Apply. To apply multiple filters click on the gray split button. The following filter options are available:

  • Action - A filter which restricts based upon a selected action that has been performed on one or more items in a results set.
  • Applied Action Result - A filter that restricts based upon the value in the Result field in the Matches and Action History section of the Result Details. If there is an icon in the Result field, hovering the mouse over the icon will display a tooltip which is the value for this field. A tooltip of "The action completed successfully" is the same as no message (Is Empty).
  • Assignee - A filter that allows selection of specific existing assignees from the assignee list.
  • Classification Name - A filter that allows selection based on text matching classification names.
  • Classification Rules - A filter that allows selection of specific existing classification rules from the classification rules list.
  • Classifications - A filter that allows selection of specific existing classifications from the classification list.
  • Data Types - A filter that allows selection of specific existing data types from the data types list.
  • Date/Time - A filter which restricts based on selected date/time criteria. If the (All day) option is selected, the time portion of the filter does not display. If the (All day) option is not selected, the time portion of the filter displays and is applied.
  • Endpoint Name - A filter that allows selection based on text matching endpoint names.
  • Endpoints - A filter that allows selection of specific existing endpoints from the endpoints list.
  • Location - A filter that restricts based on text matching the location information.
  • Location Access Date/Time - A filter which restricts based on the date and time that the file was last accessed. If the (All day) option is selected, the time portion of the filter does not display. If the (All day) option is not selected, the time portion of the filter displays and is applied.
  • Location Create Date/Time - A filter which restricts based on the date and time that the file was created. If the (All day) option is selected, the time portion of the filter does not display. If the (All day) option is not selected, the time portion of the filter displays and is applied.
  • Location Modify Date/Time - A filter which restricts based on the date and time that the file was last modified. If the (All day) option is selected, the time portion of the filter does not display. If the (All day) option is not selected, the time portion of the filter displays and is applied.
  • Location Type - A filter that allows selection of specific existing location types from the location types list.
  • Location Type General - Uniquely identifies a specific general location type stored in the database. For example, database table instead of the specific type of database.
  • Match - A filter that restricts based on text matching the data match.
  • Match Quantity - A filter that restricts based on the match quantity information.
  • Owner - A filter that restricts based on text matching the object owner name.
  • Search User Name - A filter that restricts based on text matching the search user name.
  • Search Users - A filter that allows selection of specific existing search users from the search users list.
  • Sensitive Data Type Name - A filter which restricts based on specific sensitive data type names. These are the names assigned to a Keyword, Regular Expression, Dictionary, Logic Statement and Search API in the Sensitive Data Types page of the Admin tab.
  • Source Endpoint Name - A filter that restricts based on text matching the source endpoint name.
  • Source Endpoints - A filter that allows selection of specific existing source endpoints from the source endpoints list.
  • Tags - A filter that allows selection of endpoints based on their tag.
  • Workflow Status - A filter that allows selection of specific existing workflow statuses from the workflow status list.
Disable/Rebuild Indexes This option allows the purge task to disable indexes on the MatchPreviews table, which helps the process complete faster by only having to update the underlying table and not the related indexes. However, having the indexes disabled could impact reporting and queries in other areas of the Console. Once the purge process is complete, it rebuilds the indexes to ensure they are active and defragmented.
Attempt rebuild using ONLINE option This process attempts to include the ONLINE option when rebuilding the indexes. Including this option allows user activity against the MatchPreviews table to run concurrently instead of blocking those processes. However, the ONLINE option is only available in some versions and editions of SQL Server. So if the version and edition running does not support ONLINE index rebuilds, the underlying table and indexes are blocked/unusable until the rebuild is complete. ONLINE index rebuild should be used when there is no maintenance window available for schedule as it usually requires much more resources and takes noticeably longer than OFFLINE rebuild.
Location This option only displays if you have chosen to replicate your database prior to installation of the Console, but is disabled for this service task.
Maximum task run time:

Specify the amount of time that the service task has to complete. For example, if you set the Maximum task run time to 5 minutes, after 5 minutes has elapsed from the time the service task first executes, the service job stops and its status shows as Aborted. The default setting is indefinitely. The following options are available:

  • Indefinitely - The task runs until completion.
  • Minutes - Set the number of minutes the service task has to complete. If the service task does not complete within the allotted time it aborts.
  • Hours - Set the number of hours the service task has to complete. If the service task does not complete within the allotted time it aborts.
  • Days - Select the number of days the service task has to complete. If the service task does not complete within the allotted time it aborts.