This topic alphabetically lists the properties that apply to the CFSImportAgentConfiguration class.
The maximum number of batches that are selected by the import agent dispatcher from the database in a single database round trip.
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
object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
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
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.
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
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:
CFSImportAgentConfiguration
interface, represents a
maximum wait interval. (The minimum interval is always 1 second and cannot be changed).
AsyncProcessingConfiguration
interface, represents a
fixed wait interval. (In effect, represents both the minimum and the maximum wait interval).
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
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.
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
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:
PropertyDescription.get_Id()
is equal to PropertyTemplate.get_Id()
, which is equal to PropertyDefinition.get_PrimaryId()
.PropertyDefinition.get_Id()
is not equal to PropertyDefinition.get_PrimaryId()
.PropertyDefinition.get_Id()
is not equal to PropertyDescription.get_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.
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
The maximum interval, in seconds, allowed a worker to process a batch before the assignment of the batch to another worker. This interval ensures that any abnormal termination of the worker previously assigned to the batch does not prevent batch completion.
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
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.
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
For information on the CFS import agent, see the
CFSImportAgentConfiguration
interface.
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