ToggleInterfaces

Type InterfaceDescription
Public interfaceICmAbstractSearchResult
The abstract, base class from which you create a subclass to define the class of objects that are returned in a background search result. This CmAbstractSearchResult subclass defines the custom properties to receive SQL select statement query result values from a background search. For each of these custom properties, set the settability property to SETTABLE_ONLY_ON_CREATE and, for object-valued properties, set the DeletionAction property to NONE.

When a background search is started, IBM Content Search Services instantiates the CmAbstractSearchResult subclass that you defined and populates the properties of each resultant background search result object from the properties that are selected in the background search query. Properties are matched by name: the name of a property object in the result row properties collection matches the symbolic name of a custom property that is defined in the CmAbstractSearchResult subclass.

Public interfaceICmBackgroundSearch
The base class from which you can create a subclass to define the search expression and parameters for a background search. The CmBackgroundSearch class is derived from the CmSweep class and its instances are stored in the Sweep table. The base CmBackgroundSearch class cannot be instantiated.

After you define a background search in a CmBackgroundSearch subclass, you start the background search by instantiating the subclass, providing values to those object properties that define parameters, and saving the object.

To define the search expression of the background search, set the default value of the SearchExpression property definition of a CmBackgroundSearch subclass definition to a valid Content Platform Engine SQL expression. This SQL expression has a syntax extension for specifying parameter substitution. Parameters are defined by custom properties that you add to a CmBackgroundSearch subclass to define a particular search. The name of each parameter must match the symbolic name of a custom property.

Public interfaceICmBulkMoveContentJob
Represents a background task that moves content from one storage area to another. A ICmBulkMoveContentJob performs a one-time sweep of Document or Annotation instances, and applies the specified storage policy to all instances that meet the criteria set in the filter expression. Set the sweep target to the Document or Annotation class, or a subclass of either.

After ICmBulkMoveContentJob moves the content, the Content Platform Engine deletes the content from the original storage area.

ICmBulkMoveContentJob can be used to disable replication on federated documents and annotations after the content has been moved to a P8 storage area. Also, for a fixed content device that you want to retire, ICmBulkMoveContentJob can be used to copy content under device retention to another storage area. In this scenario, the content is not deleted from the fixed content device.

Public interfaceICmContentBackoutQueueEntry
Represents the information needed for a IContentBackoutQueueSweep to back out content abandoned during upload to an advanced storage area. An entry is created in the backout queue for each content ID batch that's generated.

See Queue sweeps

Public interfaceICmContentBackoutQueueSweep
Represents a queue sweep that processes content backout queue entries in the advanced storage areas of an object store. A entry is represented by a ICmContentBackoutQueueEntry object. A queue sweep is a background task that runs continuously, subject to time-scheduling parameters.

Content Platform Engine creates an instance of ICmContentBackoutQueueSweep for each object store. A client application cannot create another instance, but it can retrieve the system instance and modify default property values.

See Queue sweeps

Public interfaceICmContentDeletionQueueEntry
Represents the information needed for a ICmContentDeletionQueueSweep to delete content from an advanced storage area. An entry is created in the deletion queue when a document or annotation with content stored in an advanced storage area is deleted.

See Queue sweeps

Public interfaceICmContentDeletionQueueSweep
Represents a queue sweep that processes content deletion queue entries in the advanced storage areas of an object store. A entry is represented by a ICmContentDeletionQueueEntry object. A queue sweep is a background task that runs continuously, subject to time-scheduling parameters.

Content Platform Engine creates an instance of ICmContentDeletionQueueSweep for each object store. A client application cannot create another instance, but it can retrieve the system instance and modify default property values.

See Queue sweeps

Public interfaceICmContentMigrationPolicy
Public interfaceICmContentReplicationQueueEntry
Represents the information needed for a ICmContentReplicationQueueSweep to replicate content within an advanced storage area. An entry is created in the replication queue when content needs to be replicated asynchronously to a storage device, either as the result of content upload or content repair.

See Queue sweeps

Public interfaceICmContentReplicationQueueSweep
Represents a queue sweep that processes content replication queue entries within an advanced storage area of an object store. A entry is represented by a ICmContentReplicationQueueEntry object. A queue sweep is a background task that runs continuously, subject to time-scheduling parameters.

Content Platform Engine creates an instance of ICmContentReplicationQueueSweep for each object store. A client application cannot create another instance, but it can retrieve the system instance and modify default property values.

See Queue sweeps

Public interfaceICmCustomQueueSweep
Represents a background task that performs an indefinite number of sweeps over a queue table specified as a target class. The custom queue sweep passes retrieved queue objects to a user implementation of the SweepActionHandler Java interface, which performs a custom action on the objects. When the handler successfully processes a queue item, the sweep service automatically deletes the item from the queue table. Queue items that fail to process are automatically retried up to a configurable number of times.

A queue sweep can only process subclass instances of ICmAbstractQueueEntry. For a custom queue sweep to work, you must create a subclass of ICmAbstractQueueEntry, and specify that subclass in the SweepTarget property of the custom queue sweep.

To associate an implemented action handler with a custom queue sweep, set a ICmSweepAction on the custom queue sweep.

A typical use case for a queued background operation is to control the flow of work to a scarce resource that is too slow to perform its operation within the context of an on-line transaction. A shared printer servicing a client application is one such case. An application that sends requests directly to the printer could back up the printer with requests. By implementing a custom queue sweep, you could manage the delivery of requests to the printer at an even rate. Instead of sending requests directly to the printer, the application would leverage the custom queue sweep, which would pass queue objects (printer requests) to a sweep action handler. The handler (and the supporting sweep service) would control the flow of requests to the printer.

See Custom Sweeps and Action Handlers.

Public interfaceICmCustomSweepJob
Represents a background task that performs a one-time sweep over a specified target class and retrieves instances that meet the criteria set on the job's filter expression. The custom sweep job passes retrieved instances to a user implementation of the SweepActionHandler Java interface, which performs a custom action on the instances. To associate an implemented action handler with a custom sweep job, you set a ICmSweepAction on the custom sweep job.

See Custom Sweeps, Action Handlers

Public interfaceICmCustomSweepPolicy
Represents a background task that performs an indefinite number of sweeps over a specified target class and retrieves instances that meet the criteria set on the policy's filter expression. The custom sweep policy passes retrieved instances to a user implementation of the SweepActionHandler Java interface, which performs a custom action on the instances. To associate an implemented action handler with a custom sweep policy, you set a ICmSweepAction on the custom sweep policy.

See Custom Sweeps, Action Handlers.

Public interfaceICmDisposalPolicy
Defines criteria for when objects of a specified class will be disposed by sweeping. When you create a ICmDisposalPolicy object, the server automatically creates the other objects required for policy-based processing: ICmSweepPolicyRelationship and ICmPolicyControlledSweep. A ICmDisposalPolicy object can only be associated with one policy controlled sweep.

See Disposal Policy Concepts.

Public interfaceICmJobSweepResult
Defines a result record generated by a sweep job. Result records generated by sweep jobs are not automatically pruned by the server. Result records are automatically removed when the controlling job is deleted.
Public interfaceICmPolicyControlledSweep
Represents a background service that repeatedly visits all instances of a specified class residing in a single database table. A policy controlled sweep cannot be created directly with a factory class. It is created indirectly by the server, when you create or update a ICmSweepPolicy object.

The same instance of a policy controlled sweep is subscribed to by all sweep policy objects that target classes whose instances are contained in the same table. If the policy controlled sweep does not already exist for a particular table, the server creates it.

For example, consider a scenario where two sweep policies are created that target Document subclasses DC1 and DC2. Instances of Document subclasses are persisted in the DocVersion table. In this scenario, there currently is no policy controlled sweep instance for the DocVersion table. When a disposal policy is created with a sweep target of DC1, the server creates a policy controlled sweep to visit the DocVersion table for instances of class DC1. When a retention update policy is created with a sweep target of DC2, the server uses the existing policy controlled sweep, which is now configured to sweep over the DocVersion table for instances of both DC1 and DC2.

When a sweep policy object is created, the server automatically creates a ICmSweepRelationship object that links the sweep policy object with an instance of the policy controlled sweep. In the previous example, two ICmSweepRelationship objects are created, one that associates the disposal policy object to the policy controlled sweep instance for the DocVersion table, and one that associates the retention update policy object to the same policy controlled sweep object.

Public interfaceICmPolicySweepResult
Defines a result record generated by a sweep policy. Because a policy-controlled sweep iterates repeatedly over the same set of objects, redundant result records can accumulate. To avoid that situation, you can configure the server to prune old result records after each sweep, keeping the result records from only the latest iterations. Using the SweepResultIterationKeepCount property on ICmSweepPolicy, set the number of the latest iterations from which to keep the result records, and the server will automatically delete the result records from iterations prior to the specified iteration.
Public interfaceICmQueueSweep
Abstract base class for sweep instances that are optimized for ongoing processing of queue tables.
Public interfaceICmRetentionUpdateJob
Represents a background task that updates the retention date on objects that support it. A ICmRetentionUpdateJob performs a one-time sweep, updating the CmRetentionDate property on all instances that meet the criteria set in the filter expression. For this type of sweep, you must set the sweep target to a Document, Folder, Annotation, or CustomObject class or subclass.

The CREATE_INSTANCE access right is required on the class definition to create a ICmRetentionUpdateJob instance. The MODIFY_RETENTION access right is required on the object store to create, update, or delete instances of this class.

Public interfaceICmRetentionUpdatePolicy
Defines criteria for updating the retention period for objects of a specified class by a policy controlled sweep. When you create a ICmRetentionUpdatePolicy object, the server automatically creates the other objects required for policy-based processing: ICmSweepPolicyRelationship and ICmPolicyControlledSweep. A ICmRetentionUpdatePolicy object can be associated with only one policy controlled sweep.

The rules for modifying the retention date of an object selected by this sweep policy are the same rules that apply for modifying an object's retention date directly with its CmRetentionDate property. For example, this sweep policy cannot be used to update the retention date of an object if the object's CmRetentionDate property is set to PERMANENT.

The CREATE_INSTANCE access right is required on the class definition to create a ICmRetentionUpdatePolicy instance. The MODIFY_RETENTION access right is required on the object store to create, update, or delete instances of this class.

Public interfaceICmSweep
An abstract base class for objects that represent a background service that visits all instances of a specified class. There are three types of sweep implementations: sweep jobs, queue table sweeps, and policy-controlled sweeps. Sweep jobs run only once, whereas the other sweep types run continuously. All sweep implementations include time-based properties, and keep count of objects examined, processed, and failed.
Public interfaceICmSweepAction
Defines the action to be taken when a custom sweep (ICmCustomSweepJob, ICmCustomSweepPolicy, or ICmCustomQueueSweep) is invoked. The action is coded by the user as a Java or JavaScript implementation of the SweepActionHandler interface. The user-implemented action is set on ICmSweepAction with the CodeModule or ScriptText property, depending on how the action is implemented.

See Custom Sweeps, Action Handlers: Restrictions and Best Practices, Deploying Java Action Handlers.

Public interfaceICmSweepConfiguration
Represents global configuration data for the sweep framework. Sweeps run as background threads on the Content Engine.

A ICmSweepConfiguration object can be assigned to objects of the server hierarchy (Domain, Site, VirtualServer, and ServerInstance), with the first encountered by the current server being the active instance. A default instance is created at the domain level during domain creation. ICmSweepConfiguration objects are persisted in the GCD.

Public interfaceICmSweepJob
Abstract base class for a sweep that visits each instance of the specified class exactly once.
Public interfaceICmSweepPolicy
Abstract base class for objects that specify rules for a policy controlled sweep, represented by a ICmPolicyControlledSweep object.
Public interfaceICmSweepPolicyRelationship
Concrete subclass that defines an association between a ICmPolicyControlledSweep and a ICmSweepPolicy as set in the Sweep property and the SweepSubscriber property, respectively. ICmSweepPolicyRelationship objects cannot be created directly with a factory class. They are created indirectly by creating or updating a sweep policy object.
Public interfaceICmSweepRelationship
Abstract base class for objects that define an association between a policy controlled sweep and a sweep policy.
Public interfaceICmSweepResult
Represents a result record for an object selected by a sweep. The implementations of this abstract base class define result records for continuously running policy sweeps and for run-once job sweeps. Results include the controlling sweep, the source object, the time of processing, and the type of result record, either failure or preview.

A sweep can run in either normal or preview mode, which determines the type of result record. In normal mode, a sweep performs an action on the selected candidate objects. If a processing error occurs on a swept object, the sweep generates a result record of type FAILURE. This type of result record describes the failure.

In preview mode, a sweep only selects candidate objects for processing; it does not actually perform an action on the selected objects. For each candidate object, the sweep generates a result record of type PREVIEW. This type of result record identifies the object as one that would be processed if the sweep were operating in normal mode.

To determine result record type, get the SweepResultType property.

You can retrieve result records from a sweep policy or sweep job object, or from an SQL search. You can also delete result records, either manually or through a disposal policy. Permissions on result records are determined by the security defined on the controlling object, that is, the sweep policy or sweep job.

Public interfaceICmThumbnailGenerationJob
Represents a background task that initiates sweep-based document thumbnail generation. A ICmThumbnailGenerationJob performs a one-time sweep of the DocVersion table for documents that meet the thumbnail generation criteria set in the FilterExpression property. For this type of sweep, you must set the sweep target to the Document class or a Document subclass.

See Thumbnail Concepts.

Public interfaceICmThumbnailRequest
Represents a request to generate a thumbnail image for a ContentElement of a Document. A request is placed on the ThumbnailRequest queue table, which is processed by an instance of ICmThumbnailRequestSweep.

The system removes successfully completed thumbnail requests from the ThumbnailRequest queue table. The system also removes requests that result in managed exceptions; that is, situations where the system cannot process the request. Managed exceptions include non-existent content or source document, or attempts to overwrite a user-generated thumbnail.

For failed requests that are fixable by an administrator, the system retries the requests up to the value set on the MaximumFailures property of the ICmThumbnailRequestSweep instance (the default is six retries). If all of the retries fail, the requests remain in the queue table. A ICmThumbnailRequest object includes properties for retrieving status and failure information, and for restarting retries.

See Thumbnail Concepts.

Public interfaceICmThumbnailRequestSweep
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.