CmThreadPoolConfiguration Properties

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

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: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ClassDescription
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

DispatcherThreadIdleTimeout Property



The period in seconds that a thread in the dispatcher thread pool can be idle before being terminated.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 30
PropertyMaximumInteger32: none
PropertyMinimumInteger32: 10
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

MaxDispatcherThreads Property



The maximum number of threads that can be allocated for processing of background tasks in the dispatcher thread pool.

Metadata

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

MaxWorkerThreads Property



This property applies to CFSImportAgentConfiguration and CmThreadPoolConfiguration objects.

For a CFSImportAgentConfiguration object, the MaxWorkerThreads property is the maximum number of import workers that the import agent is allowed to create. Setting the value of this property appropriately prevents the under- or over-utilization of the Content Engine server on behalf of the CFS importer. For information on the CFS import agent, see the CFSImportAgentConfiguration interface.

For a CmThreadPoolConfiguration object, the MaxWorkerThreads property is the maximum of number of threads that can be allocated for processing of background tasks in the worker thread pool.

Metadata

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

WorkerThreadIdleTimeout Property



The period in seconds that a thread in the worker thread pool can be idle before being terminated.

Metadata

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