Defines the format, size, and color parameters that are used by the thumbnail generation service to render document thumbnails. A ICmThumbnailRequestSweep instance operates on the ThumbnailRequest queue table, initiating thumbnail generation for each request. A request is represented by a ICmThumbnailRequest object.

A ICmThumbnailRequestSweep instance is created by the Thumbnail Extensions AddOn. It is disabled by default. You cannot create additional instances of this class; there can be only one queue sweep instance for any given ThumbnailRequest queue table.

The default ICmThumbnailRequestSweep instance is configured to be efficiently continuous. It runs in a wait state until it is notified that a new request is posted in the ThumbnailRequest queue table.

Important: For ICmThumbnalRequestSweep, the default value of the MaximumFailures property is three, meaning that an instance of ICmThumbnalRequestSweep attempts to reprocess failed thumbnail request queue entries up to three times. Entries that fail to process after three attempts are set to QueueEntryStatus.FAILED, and, as a result, ICmThumbnalRequestSweep no longer attempts to process the queue entries.

To restart the processing of failed queue entries, you must reset the FailureCount property to zero on each queue entry, which automatically changes the QueueEntryStatus property from FAILED to RETRY_WAIT. To restart a large volume of failed queue entries, it is recommended that you use a custom sweep job. For more information, see Resetting failed queue sweep entries.

See Thumbnail Concepts.

Namespace:  FileNet.Api.Sweep
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Public Interface ICmThumbnailRequestSweep _
	Implements ICmQueueSweep, ICmSweep, IRepositoryObject, ISubscribable,  _
	IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable
C#
public interface ICmThumbnailRequestSweep : ICmQueueSweep, 
	ICmSweep, IRepositoryObject, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, 
	IEngineObject, ICloneable
Visual C++
public interface class ICmThumbnailRequestSweep : ICmQueueSweep, 
	ICmSweep, IRepositoryObject, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, 
	IEngineObject, ICloneable
JavaScript
FileNet.Api.Sweep.ICmThumbnailRequestSweep = function();
FileNet.Api.Sweep.ICmThumbnailRequestSweep.createInterface('FileNet.Api.Sweep.ICmThumbnailRequestSweep');

ToggleRemarks

Metadata

Auditable: true
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: SubscribableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: CmQueueSweep

ToggleSee Also