Creating background search queries

To create a background search query, you create a template and a template-based sweep. Multiple sweeps can be created from the same template.

Before you begin

If you want the search results of your query to be downloadable as a CSV file, install the Reporting Enablement Extensions add-on for the object store. For information about installing add-ons, see Installing an add-on feature to an object store. For information about other ways that search results can be exported to a CSV file, see Search result processing.

About this task

The template primarily consists of three interrelated elements:
  • The search expression
  • Parameter properties
  • Search result properties

You specify parameter values when the sweep is created from the template. Also, when you create the sweep, you can limit the number of search results for query testing purposes.

Important: Some configuration such as creating database indexes might be necessary to prevent your background search queries from running slowly. For more information, see Tuning Content Platform Engine background searches.

Procedure

To create a background search query:

  1. Start the New Background Search Class Template wizard in the administration console:
    1. In the domain navigation pane, select the object store.
    2. In the object store navigation pane, select the Data Design > Background Search Class Templates folder.
    3. On the Background Search Class Templates tab, click New.
  2. Complete the wizard:
    1. Enter a search expression.
    2. As necessary, edit the attributes of the custom property templates that the wizard creates automatically for parameters and search results.
    3. Optional: Select the Generate a CSV file option. The wizard displays this option only if the Reporting Enablement Extensions add-on is installed.
  3. Generating search results with a background search sweep. Create a template-based sweep.