Start of changeIBM FileNet P8, Version 5.2.1            

Job sweeps

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

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. In the administration console, job sweeps are listed in the navigation pane under Sweep Management > Job Sweeps.

A job sweep runs at the start time for which it is configured. If a start time is not set, then the sweep is eligible to start immediately. It will not start immediately if, for example, the sweep is disabled, or if time slots are set to times in the future.

A job sweep includes counter properties that reflect the results of the job. ExaminedObjectCount indicates the number of objects that the job sweep evaluated but did not necessarily process. ProcessedObjectCount indicates the number of objects that met the criteria for processing. FailedObjectCount indicates the number of objects that met the criteria for processing but failed to process.

You can run a job sweep in normal or preview mode. In normal mode, a sweep performs an action on objects that meet the criteria for processing. If a processing error occurs on a swept object, the sweep generates a result record that includes a description of the failure.

In preview mode, a sweep evaluates objects only; it does not perform an action on objects that meet the criteria for processing. There are two available preview modes. In "Preview only counters" mode, the job sweep only increments the examined-object and processed-object counters. In "Preview" mode, the job sweep also increments the counters, plus generates a preview result record for each object that the sweep would attempt to process if it were operating in normal mode.

Result records that are generated by job sweeps are not automatically pruned by the server. Using the administrator console, you can delete individual result records. You can access result records in the Sweep Results tab of the job sweep.

To remove a large number of result records at one time, you can you delete the job sweep itself. However, an attempt to delete a job sweep can fail if there are two many result records to be deleted within the global transaction timeout limit. In the event of such a failure, you can create a disposal policy that targets the sweep result class.

A job sweep instance that has previously run cannot be re-executed. However, you can create a new instance of the same job sweep and run that instance. To quickly create a new instance with an identical configuration as the original instance, clone the original instance.



Last updated: March 2016
p8pcc430.htm

© Copyright IBM Corporation 2017.
End of change