Creating custom sweeps

Unlike a system sweep that performs an action that is built into the server, a custom sweep performs a user-implemented action. You can use the administration console to create custom job sweeps and custom policy sweeps, but custom queue sweeps must be created programmatically.

About this task

Custom sweeps provide the flexibility to process objects in ways that are not built into the server. For example, you can use a custom sweep to change the class of multiple document instances. For more information, see the topic Custom Sweeps.

The following sections provide instructions for creating and managing a custom sweep:

Creating a custom sweep action

A sweep action specifies the action handler implementation to be used by a custom sweep.

Before you begin

You must first create an action handler, which will be referenced by the sweep action. For more information, see Implementing a Sweep Action Handler.

Procedure

To create a custom sweep action:

  1. Start the New Sweep Action wizard:
    1. In the domain navigation pane, click the object store.
    2. In the object store navigation pane, right-click the Sweep Management > Sweep Actions folder and click New Sweep Action.
  2. Complete the wizard.

Creating a custom job sweep

A custom job sweep performs a custom action that runs only one time.

Before you begin

Verify that the custom sweep action and the user-implemented action handler are in place.

Procedure

To create a custom job sweep:

  1. Start the New Custom Job wizard in the administration console:
    1. In the domain navigation pane, select the object store.
    2. In the object store navigation pane, select the Sweep Management > Job Sweeps > Custom Jobs folder.
    3. Click New.
  2. Optional: Select the Enabled property to enable the sweep to run.
    Note: Some sweep properties cannot be set in the wizard; they can only be set in the sweep object after it is created. Time slots and FilteredQueryTimeout are two such properties. If you need to change default values of properties that are not available in the wizard, disable the sweep in the wizard. You can enable the sweep later, after you change default property values in the sweep object. For more information, see the topic Setting sweep properties.
  3. Complete the wizard.

Creating a custom sweep policy

A custom sweep policy performs a custom action that runs continuously.

Before you begin

Verify that the custom sweep action and the user-implemented action handler are in place.

Procedure

To create a custom sweep policy:

  1. Start the New Custom Policy wizard in the administration console:
    1. In the domain navigation pane, select the object store.
    2. In the object store navigation pane, select the Sweep Management > Sweep Policies > Custom Policies folder.
    3. Click New.
  2. Optional: Select the Enabled property to enable the sweep to run.
    Note: Some sweep properties cannot be set in the wizard; they can only be set in the sweep object after it is created. Time slots and FilteredQueryTimeout are two such properties. If you need to change default values of properties that are not available in the wizard, disable the sweep in the wizard. You can enable the sweep later, after you change default property values in the sweep object. For more information, see the topic Setting sweep properties.
  3. Complete the wizard.