Setting sweep properties

Create and configure sweeps to set scheduling options and optimize performance settings.

About this task

The following sections provide instructions for opening different types of sweeps:
Not all sweep properties are exposed in the sweep creation wizard. In many cases, you'll want to create a sweep in disabled mode and then open it to set additional properties, like time slots and FilteredQueryTimeout. After running a sweep, you might want to adjust performance-related properties, like MaxSweepWorkers and InterBatchDelay. And you'll want to open a sweep to view its results.

Opening a sweep policy

A sweep policy is an object that specifies processing rules for a policy-controlled sweep, which runs continuously.

About this task

When you create a sweep policy, the server automatically creates the associated policy-controlled sweep. The sweep policy contains properties that define rules for the sweep, such as the sweep target, filter expression, and the sweep mode to run in. The sweep policy also contains the sweep results. The policy-controlled sweep contains run-related properties, like completed iterations and sweep delay values. For more information, see the topic Sweep Policies.

Procedure

To open the sweep policy and the policy-controlled sweep:

  1. Expand the appropriate folder in the administration console:
    1. In the domain navigation pane, click the object store.
    2. In the object store navigation pane, expand the Sweep Management > Sweep Policies folder.
    3. Expand the appropriate subfolder for the policy.
      For example, for a content migration policy, expand the Content Migration Policies folder.
  2. Click the policy. A tab for the policy opens in the details pane.
  3. On the policy tab, look at the Policy-controlled sweep property for the name of the sweep.
    For example, the name of the sweep might be "Document".
  4. In the object store navigation pane, expand the Sweep Management > Policy-Controlled Sweeps folder.
  5. Under the folder, click the sweep.
    For example, click the "Document" sweep.

Opening a job sweep

A job sweep runs one time to process objects of a target class.

About this task

The Content Platform Engine includes job sweep subclasses with built-in actions. For example, you can create job sweep instances to move content between storage areas, or to update object retention. For more information, see the topic Job Sweeps.

Procedure

To open a job sweep:

Expand the appropriate folder in the administration console:
  1. In the domain navigation pane, click the object store.
  2. In the object store navigation pane, expand the appropriate subfolder under the Sweep Management > Job Sweeps folder, such as Bulk Move Content Jobs.
  3. Under the subfolder, click the job sweep.
    A tab for the sweep opens in the details pane.

Opening a queue sweep

A queue sweep is optimized for continuous processing of queues.

About this task

Queue sweeps provide a generic queuing service and are especially useful in controlling the flow of work to a slow or resource-intensive process. For more information, see the topic Queue Sweeps.

Procedure

To open a queue sweep:

Expand the appropriate folder in the administration console:
  1. In the domain navigation pane, click the object store.
  2. In the object store navigation pane, click the Sweep Management > Queue Sweeps folder.
  3. Click the queue sweep.
    A tab for the sweep opens in the details pane.

Opening a background search sweep

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

About this task

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. For more information, see the topic Background Search Sweeps.

Procedure

To open a background search sweep:

Expand the appropriate folder in the administration console:
  1. In the domain navigation pane, click the object store.
  2. In the object store navigation pane, expand the subfolder Sweep Management > Background Search Sweeps.
  3. Under the subfolder, click the background search sweep.
    A tab for the sweep opens in the details pane.