ContentConfiguration Properties

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

AbandonedContentCleanupInterval Property

The number of seconds between cleanups of the inbound directory. The inbound directory is one of the temporary locations where content is stored during the first stage of content upload. A cleanup deletes those files considered abandoned; specifically, those files that have not been committed and are not participating in an existing transaction.

This property works in conjunction with the TempFileLifetime property to determine which files get deleted as part of a periodic cleanup.

Metadata

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

AbandonedDBContentCleanupInterval Property

The frequency (in seconds) with which database tables containing temporary content will be scrubbed to eliminate abandoned content. Abandoned content is content not participating in an existing transaction and not committed as part of a previous transaction.

This property works in conjunction with the TempDBContentLifetime property to determine which temporary content gets deleted as part of a periodic cleanup.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
PropertyDefaultInteger32:  3600
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

ContentQueueMaxWorkerThreads Property

The maximum number of worker threads that can exist simultaneously per Object Store. Content Queue Worker Threads are threads that are dedicated to the purpose of processing items from the content queue. Their primary function is to carry out the second stage of the content upload process. Worker threads process work from the ContentQueue in batches of one or more queue items.

Metadata

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

ContentTempDirectoryRoot Property

The root of the directory structure that holds temporary content. Specify a fully qualified location for the root directory local to the server, such as a mount point (/mount/root) or drive (c:\data\root), and give the server exclusive permissions to access the root directory. The server must have sufficient permissions to create subdirectories; it creates the inbound directory off of this root directory.

When the value for this property is null, the server uses the FileNet working directory as the directory root for temporary content.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  2083
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

DatabaseContentUploadBufferSize Property

Reserved for future use.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
PropertyDefaultInteger32:  64
PropertyMaximumInteger32:  1024
PropertyMinimumInteger32:  0
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:  5
PropertyMaximumInteger32:  10 * 60
PropertyMinimumInteger32:  5
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

ExpiredBatchSelectionSize Property

Batch selection size used when updating expired requests. An item in the Content Queue is said to expire when its LeaseDuration has been exceeded. Expired items must be updated so they can be retried. Expired queue items are updated in batches, the size of which is dependent on the value of this property.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
PropertyDefaultInteger32:  512
PropertyMaximumInteger32:  0x7FFFFFFF
PropertyMinimumInteger32:  none
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

InboundFileNameCacheMaxEntries Property

Maximum number of inbound file names to keep in an LRU cache (default 2K).

Metadata

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

InlineContentRetrievalLimit Property

The limit of the size for inline content retrieval.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
PropertyDefaultInteger32:  1024
PropertyMaximumInteger32:  1024 * 10
PropertyMinimumInteger32:  0
RequiresUniqueElements:  false
Settability:  READ_WRITE
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 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.

Metadata

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

MaxInMemoryQueueItems Property

Maximum [un-dispatched] requests allowed in the in-memory queue (to avoid throwing away batches that expire while held in-memory, this number is kept very low by default, but can be increased under certain circumstances, like content migration to a slow device). Note that this limit is not evaluated until there are at least three in-memory pending batches.

Metadata

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

MaxResolutionBatchSize Property

Maximum number of items to resolve within a batch.

Metadata

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

PartialResolutionChunkSize Property

The number of content queue items to be resolved using a single delete statement, when a batch is resolved in chunks.

Metadata

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

RenameFileRetryAttempts Property

The number of times a worker thread is to attempt renaming and moving a content file from the inbound directory to its permanent location in the storage area. Also, the number of milliseconds that the thread is to wait after each failed attempt before making another renaming attempt. If all attempts fail, the thread returns the item associated with the content file to the content queue for future processing.

Metadata

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

RetrievalRetryAttempts Property

Content retrieval retry attempts (used when attempting to locate content before roll-forward is applied).

Metadata

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

RollFwdBatchRetryAttempts Property

Roll-forward batch retry attempts (before discarding the batch).

Metadata

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

TempDBContentLifetime Property

The number of seconds temporary content can exist in the database before being considered abandoned.

Metadata

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

TempFileLifetime Property

The number of seconds that temporary files must exist in the inbound directory before they will be considered abandoned. Abandoned files get deleted as part of a periodic cleanup; for more information, see the AbandonedContentCleanupInterval property.

Metadata

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