CmSweepConfiguration Properties

This topic alphabetically lists the properties that apply to the CmSweepConfiguration class.

BackgroundSearchLeaseDuration Property



The amount of time, in seconds, that a background search request is allowed to run before another thread attempts to reissue the request.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultInteger32: 420
PropertyMaximumInteger32: 0x7FFFFFFF
PropertyMinimumInteger32: none
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

ClassDescription Property



Specifies a ClassDescription object containing the fixed description (immutable metadata) of the class from which this object is instantiated.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ClassDescription
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

DefaultDispatcherDelay Property



The default length of time in seconds between the end of one sweep pass and the beginning of the next one.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultInteger32: 300
PropertyMaximumInteger32: 0x7FFFFFFF
PropertyMinimumInteger32: none
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

DispatcherEnabled Property



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 CFSImportAgentConfiguration 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 CFSSiteSettings interface. For a discussion of the importer sub-components, see the CFSImportAgentConfiguration interface.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: BOOLEAN
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: true
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

Id Property



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 User and Group 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, calls to User.get_Id() and Group.get_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:

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.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: GUID
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

InterBatchDelay Property



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 CmSweep object overrides the property setting on the CmSweepConfiguration global object. If the property is set to null on the CmSweep object, then the InterBatchDelay setting on the CmSweepConfiguration object is used.

Metadata

AllowsDefaultChange: true
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 0
PropertyMaximumInteger32: 0x7FFFFFFF
PropertyMinimumInteger32: none
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

PolicyControlledSweepBatchSize Property



The number of objects that will be passed to the policy-controlled sweep action handler in a single batch.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultInteger32: 2000
PropertyMaximumInteger32: none
PropertyMinimumInteger32: 1
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

QueueSweepLeaseDuration Property



The amount of time in seconds that a busy queue sweep request is allowed to run before another thread attempts to reissue the request.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultInteger32: 420
PropertyMaximumInteger32: 0x7FFFFFFF
PropertyMinimumInteger32: none
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

SweepJobLeaseDuration Property



The amount of time in seconds that a busy sweep job request is allowed to run before another thread attempts to reissue the request.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultInteger32: 420
PropertyMaximumInteger32: 0x7FFFFFFF
PropertyMinimumInteger32: none
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

SweepTimeslots Property



A list of CmTimeslot objects that determine the schedule for sweep processing. The property setting on the CmSweep object overrides the property setting on the CmSweepConfiguration global object. If the property is set to null on the CmSweep object, then the timeslot setting on the CmSweepConfiguration object is used.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: CmTimeslot
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

WaitForQueueActivityDelay Property



When there is no queue activity, the number of milliseconds for the sweep framework dispatcher to wait before rechecking the queue.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultInteger32: 60000
PropertyMaximumInteger32: 0x7FFFFFFF
PropertyMinimumInteger32: none
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

WaitForWorkersDelay Property



The number of milliseconds for the sweep framework dispatcher to wait for workers to complete before removing terminated workers from the active worker set.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultInteger32: 3000
PropertyMaximumInteger32: 0x7FFFFFFF
PropertyMinimumInteger32: none
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

WaitForWorkersShortDelay Property



The number of milliseconds for the sweep framework dispatcher to wait before attempting to retry a deadlock.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultInteger32: 500
PropertyMaximumInteger32: 0x7FFFFFFF
PropertyMinimumInteger32: none
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ