Start of changeIBM FileNet P8, Version 5.2.1            

Background search sweeps

A background search sweep runs one time to execute a query that generates search results.

Running a query as a background search allows you to proceed with other activities while the search is running. In addition, background searches are an essential part of the reporting framework that enables processing of search results. The reporting framework can be enhanced by installing the Reporting Enablement Extensions add-on.

View a demo: To view a short video that shows how to configure background searches and then create reports and charts to show the results, see https://www.youtube.com/watch?v=OBS7YIBodVo.

Background search class template

A background search class template is the means for defining and creating background search sweeps. You start by first creating a template, which contains the search expression. Optionally, you can include query parameters in the search expression. When you later create the sweep, it prompts you to enter values for the query parameters.

When you save the background search class template, a corresponding background search result class is automatically created. This class defines the properties to be returned in the background search results. At sweep creation, this class will automatically be set as the target class of the sweep.

After creating the search class template, you create a background search sweep that will execute the query that is defined in the template. The same template can be used to create multiple background search sweeps.

In the object store navigation pane of the administrator console, background search class templates are listed under Data Design > Background Search Class Templates. Background search result classes are listed under Data Design > Background Search Result Classes.

Creating a background search sweep

You configure and create the background search sweep by invoking a start operation on the background search class template. The sweep runs at the start time for which it is configured. If a start time is not set, then the sweep starts immediately. (It will not start immediately if, for example, the sweep is disabled, or if time slots are set to times in the future.) An end time when the sweep stops running can also be configured. Background search sweeps are listed under Sweep Management > Background Search Sweeps.

If a search fails, the sweep retries it for as many times as specified in the MaximumFailures property. On each failure, the LastFailureReason property is updated with the failure's message. If all attempts of the search fail, the sweep is terminated. After addressing the reason for the search failure, you can restart the sweep.

Search results are listed in the Sweep Results tab. Search results are not automatically pruned by the server. You can remove all of the search results at one time by deleting the sweep itself. You can also use a disposal policy.



Last updated: October 2015
p8pcc457.htm

© Copyright IBM Corporation 2015.
End of change