CFSImportAgentConfiguration Properties

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

BatchSelectionSize Property



Attention: Do not change the value of this property without guidance from a support representative. Doing so might adversely affect system performance.

The maximum number of batches that are selected by the import agent dispatcher from the database in a single database round trip.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 4
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: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ClassDescription
RequiresUniqueElements: false
Settability: READ_ONLY
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

DispatcherWaitInterval Property



Attention: Do not change the value of this property without guidance from a support representative. Doing so might adversely affect system performance.

An interval, in seconds, between processing runs for the dispatcher; during this time, the dispatcher remains idle and waits for incoming work. The value specified by this property can represent differing wait intervals depending on the class on which the property occurs, as follows:

The interaction between the minimum and maximum intervals occurs in this manner: if in the previous processing run the dispatcher had work to perform, the duration of the subsequent wait interval that the dispatcher actually remains idle is the minimum interval; otherwise, if the dispatcher had no work to perform, the duration is the shorter of these two intervals: (a) Double the previous wait interval or (b) the maximum wait interval. As an example, assuming the minimum interval to be 35 seconds and the maximum as 120, the dispatcher remains idle for 35 seconds, detects no available work, remains idle for 70 seconds (double the previous wait interval), detects no available work, remains idle for 120 seconds (the maximum interval), detects no available work, remains idle for 120 seconds, detects incoming work and processes the work, remains idle for 35 seconds, and so on. Note that, when the minimal interval equals the maximum interval (as is always the case for the AsyncProcessingConfiguration interface), this example can be simplified. If both the minimum and maximum interval is 35 seconds, the dispatcher remains idle for 35 seconds, detects no available work, remains idle for 35 seconds, detects incoming work and processes the work, remains idle for 35 seconds, and so on.

For the CFSImportAgentConfiguration interface, this property, despite the name, applies to the importer sub-component known as the import agent and not to the import dispatcher; for information on the importer sub-components, see the CFSImportAgentConfiguration interface.

Metadata

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

LeaseDuration Property



Attention: Do not change the value of this property without guidance from a support representative. Doing so might adversely affect system performance.

The maximum interval, in seconds, allowed for a worker to process a batch before the batch is assigned to another worker. Used for multi-server coordination, this interval ensures that any abnormal termination of the worker previously assigned to the batch does not prevent batch completion.

For VerityServerConfiguration, this property is deprecated.

Metadata

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

MaxInMemoryItems Property



Attention: Do not change the value of this property without guidance from a support representative. Doing so might adversely affect system performance.

This value, in combination with the MaxWorkerThreads parameter, establishes a threshold that, when exceeded, prevents additional batches of federation requests from being inserted in the in-memory pre-fetch queue. The number of items in the queue is reduced as batches of work are dispatched to worker threads. The number of batches in the queue will eventually fall below the threshold and the addition of new batches from the database queue will be resumed.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 2
PropertyMaximumInteger32: 0x7FFFFFFF
PropertyMinimumInteger32: none
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: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 10
PropertyMaximumInteger32: 0x7FFFFFFF
PropertyMinimumInteger32: none
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

MoveContentLeaseThreshold Property



The number of seconds that must be remaining on the version series row lease to allow a move content operation to proceed.

When the Import Agent assigns a queued import request to a worker thread, the worker thread acquires a lease on the request. The lease is the number of seconds allotted by the Import Dispatcher for the worker thread to complete its work. If the time expires before the work is completed, the dispatcher can assign the request to another thread. A move operation can take considerable time and can potentially exceed the allotted time. Before attempting the move operation, the worker thread determines how much time remains on the lease, and compares that value to the MoveContentLeaseThreshold property value. If the amount of time is greater than the MoveContentLeaseThreshold value, the worker thread proceeds to execute the work. If the amount of time left is less than the MoveContentLeaseThreshold value, the worker thread relinquishes the lease and allows the Import Dispatcher to reassign the request to another thread.

Attention: Do not change the value of this property without guidance from a support representative. Doing so might adversely affect system performance.

Metadata

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