The ICmSweepConfiguration type exposes the following members.

ToggleProperties

Type NameDescription
Public propertyBackgroundSearchLeaseDuration
The amount of time, in seconds, that a background search request is allowed to run before another thread attempts to reissue the request.
Public propertyClassDescription
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.)
Public propertyDefaultDispatcherDelay
The default length of time in seconds between the end of one sweep pass and the beginning of the next one.
Public propertyDispatcherEnabled
A boolean value that controls the run enabled status of the dispatcher. When true, the dispatcher runs. When false, the dispatcher does not run.

For the ICFSImportAgentConfiguration interface, when the value of this property is true, the dispatcher runs, but the importer as a whole might still not process import requests when the import agent sub-component has not also been enabled. For more information, see the IsImportAgentEnabled property on the ICFSSiteSettings interface. For a discussion of the importer sub-components, see the ICFSImportAgentConfiguration interface.

Public propertyId
A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.

For IUser and IGroup classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, IUser.Id and IGroup.Id always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server.

For a given property representation, the Id property has the following characteristics:

  • PropertyDescription.Id is equal to PropertyTemplate.Id, which is equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDescription.Id.

For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time.

(Inherited from ISubsystemConfiguration.)
Public propertyInterBatchDelay
The minimum number of milliseconds a sweep will wait before running back-to-back sweep queries. A sweep iteration consists of multiple queries, each of which returns a batch of candidate items for processing.

The property setting on the ICmSweep object overrides the property setting on the ICmSweepConfiguration global object. If the property is set to null on the ICmSweep object, then the InterBatchDelay setting on the ICmSweepConfiguration object is used.

Public propertyPolicyControlledSweepBatchSize
The number of objects that will be passed to the policy-controlled sweep action handler in a single batch.
Public propertyProperties
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.)
Public propertyQueueSweepLeaseDuration
Public propertySweepJobLeaseDuration
The amount of time in seconds that a busy sweep job request is allowed to run before another thread attempts to reissue the request.
Public propertySweepTimeslots
A list of ICmTimeslot objects that determine the schedule for sweep processing. The property setting on the ICmSweep object overrides the property setting on the ICmSweepConfiguration global object. If the property is set to null on the ICmSweep object, then the timeslot setting on the ICmSweepConfiguration object is used.
Public propertyWaitForQueueActivityDelay
When there is no queue activity, the number of milliseconds for the sweep framework dispatcher to wait before rechecking the queue.
Public propertyWaitForWorkersDelay
The number of milliseconds for the sweep framework dispatcher to wait for workers to complete before removing terminated workers from the active worker set.
Public propertyWaitForWorkersShortDelay
The number of milliseconds for the sweep framework dispatcher to wait before attempting to retry a deadlock.

ToggleSee Also