The ICmBackgroundSearch type exposes the following members.

ToggleProperties

Type NameDescription
Public propertyAllowStringTruncation
Specifies whether string-valued property values in the background search result can be truncated if their length exceeds the maximum length of the corresponding property of the search result class. If this property is set to false, the search fails if it contains string values that exceed the maximum string length. The default value is false.
Public propertyAuditedEvents
An EventSet collection of the Event objects containing the audited events that have occurred for the object.
(Inherited from ICmSweep.)
Public propertyClassDescription
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.)
Public propertyCreator
Indicates the name of the user assigned as the creator of the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

(Inherited from ICmSweep.)
Public propertyDateCreated
Indicates the date and time the object was created. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

(Inherited from ICmSweep.)
Public propertyDateLastModified
Indicates the date and time the object was last modified. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users can only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

(Inherited from ICmSweep.)
Public propertyDisplayName
The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.

For ICmAuditProcessingBookmark and IAuditDefinition objects, this property is intended to identify client applications that process the audit log. For ICmAuditProcessingBookmark objects, this property, in support of the audit disposition feature, identifies the client that created the object. For IAuditDefinition objects, this property identifies a set of audit definitions for a given client or client functionality.

For ICmAuditProcessingBookmark and IAuditDefinition objects, it is recommended that you set this property. Specify a unique value to distinguish one client application from another. Note, however, that the server does not prevent identical display names across multiple ICmAuditProcessingBookmark or IAuditDefinition objects. Therefore, the client application is responsible for enforcing uniqueness.

Public propertyEffectiveEndDate
The date and time after which this sweep rule becomes no longer eligible to run. If this property is not set on a sweep policy, the policy runs continuously.

If you set this property on a sweep job, which runs one time only, be careful to allow sufficient time for the the job to process the entire table, especially if the table is very large. If the effective end date does not allow the necessary time, then the job will end before it completely processes the table.

Similarly, If you set this property on a run-once background search, be careful to allow sufficient time for the query to complete; otherwise, the sweep will end before returning all of the search results.

Public propertyEffectiveSQL
The system-generated SQL statement that is used for this background search. The SQL statement is generated when the server performs parameter substitution on the user-defined SQL statement that is set in the SearchExpression property.
Public propertyEffectiveStartDate
The date and time this sweep rule becomes effective and eligible to run. If this property is not set, then the sweep is eligible to start immediately. (It will not start immediately if, for example, the sweep is disabled, or if timeslots are set to times in the future.)
Public propertyExaminedObjectCount (Inherited from ICmSweep.)
Public propertyFailedObjectCount
For a sweep job, which runs only once, the number of objects that failed when applying the sweep action. For an ongoing sweep, the cumulative number of objects that failed in the current iteration plus in all of the previous iterations.

For a background search, the value of this property is always zero.

(Inherited from ICmSweep.)
Public propertyFailureCount
The number of times this queued object has failed.

When this property is equal to or exceeds the MaximumFailures property on ICmQueueSweep, the QueueEntryStatus property is set to FAILED, and the sweep service no longer selects the entry for processing. To restart processing of a queue entry with a FAILED status, reset this property to zero, and the QueueEntryStatus property is changed from FAILED to RETRY_WAIT.

For a background search (ICmBackgroundSearch), when this property is equal to or exceeds the MaximumFailures property on ICmBackgroundSearch, the background search stops.

Public propertyId
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 IUser and IGroup 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, IUser.Id and IGroup.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.Id is equal to PropertyTemplate.Id, which is equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDescription.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.

(Inherited from ICmSweep.)
Public propertyInterBatchDelay
The minimum number of milliseconds a sweep will wait before running back-to-back sweep queries. A sweep iteration consists of multiple queries, each of which returns a batch of candidate items for processing.

The property setting on the ICmSweep object overrides the property setting on the ICmSweepConfiguration global object. If the property is set to null on the ICmSweep object, then the InterBatchDelay setting on the ICmSweepConfiguration object is used.

(Inherited from ICmSweep.)
Public propertyIsEnabled
Indicates whether a given object is enabled or disabled. For example, you can globally disable or enable active events by setting an IEventAction object's IsEnabled property to False (off) or True (on). Likewise, you can enable or disable a subscription, a security template, an audit definition, an audit disposition policy, a change preprocessor definition, a change preprocessor action, and a sweep The property defaults to true.

Enabling a security template indicates that it can be applied to an object. A disabled security template remains part of its security policy container, but cannot be applied to an object. Disabling a security template is useful when you are testing or developing the security templates that make up a security policy.

Disabling a subscription prevents the function associated with the event from being loaded and executed. You might want to disable a subscription that is undergoing modifications due to a change in business processes or when you do not want functions to execute against federated documents. Note that when you disable an IEventAction, all of its associated subscriptions are also disabled. However, when you disable one particular ISubscription, you only disable events that are in its subscribed event list.

Disabling a change preprocessor action has system scope, that is, it prevents code handler execution for all class definitions that reference the change preprocessor action. On the other hand, disabling a change preprocessor definition has class scope; it prevents code handler execution for only that class definition, and for any subclass definitions to which the changed property value is propagated.

Public propertyLastFailureReason
For IIndexJob and ICmIndexRequest objects, this property identifies the final failure condition for the index job.

For an IReplicationJournalEntry object, this property provides a description of the latest failure condition, if any, for the replication operation that generates this journal entry.

For an ICmThumbnailRequest object, this property states why document thumbnail generation failed.

For an ICmBackgroundSearch object, this property provides a description of the latest failure condition, if any, for the background search operation that generates this journal entry.

For an ICmTask object, this property indicates why the object has been set to the exception state. This property is settable only during the SET_EXCEPTION changeState transaction, for example:

ICmTask.changeState(SET_EXCEPTION);
ICmTask.set_LastFailureReason ( "Required document was not attached to workflow.");
ICmTask.save();

To reset LastFailureReason to a null value, clear the exception: ICmTask.changeState(CLEAR_EXCEPTION).

Public propertyLastModifier
Indicates the name of the user who last modified the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users could only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

(Inherited from ICmSweep.)
Public propertyMaximumExaminedRowCount
The maximum number of query result rows that this background search will examine, regardless of the total number of rows in the query result. If this property is set to the default value of 0, all rows are examined.
Public propertyMaximumFailures
For ICmQueueSweep, the maximum number of times a dequeue operation for a queue sweep will be retried following a failure. If this property is set to zero, there is no limit on the maximum number of failures.

When QueueEntryStatus on a queue entry (represented by a ICmAbstractQueueEntry subclass) is set to FAILED, then the sweep service no longer selects the entry for processing. When the queue sweep handler reports a failure of processing, the sweep service increments the FailureCount property on the queue entry. If the new value equals or exceeds the current MaximumFailures property value on the ICmQueueSweep object controlling the sweep, then the QueueEntryStatus property is set to FAILED.

The QueueEntryStatus property is also set to FAILED when a queue sweep handler sets the processing outcome of the entry to SweepItemOutcome.FAILED_NO_RETRY.

To restart processing of a queue entry with a status of FAILED, reset the FailureCount property on the queue entry to zero.

For ICmBackgroundSearch, the maximum number of failures tolerated by the sweep service before the CmBackgroundSearch instance is terminated. If this property is set to zero, there is no limit to the maximum number of failures.

Public propertyMaxSweepWorkers
The maximum number of worker threads to be allocated for processing a sweep.

For an ICmBackgroundSearch object, this property is ignored.

(Inherited from ICmSweep.)
Public propertyOrderByGroupedProperties
Specifies whether the properties specified in the background search GROUP BY clause are included in the underlying ORDER BY clause of the search expression (true) or not (false). This property provides a way to tune a background search for best performance. Ordering by properties in the GROUP BY clause can improve search performance by reducing the number of database operations. Conversely, depending on the details of the search and the number of indexes that are added to the searched table, it can also degrade performance. The default value is true.
Public propertyOwner
Manages the security owner assigned to the object.
(Inherited from ICmSweep.)
Public propertyPermissions
Manages the discretionary permissions assigned to the object.
(Inherited from ICmSweep.)
Public propertyProcessedObjectCount
For a sweep job, which runs only once, the number of objects processed during the sweep. For an ongoing sweep, the cumulative number of objects processed in the current iteration plus in all of the previous iterations.

For a background search, the number of ICmAbstractSearchResult objects that are produced as a result of the search. The value is the same as in the ExaminedObjectCount property unless you use SQL aggregate functions and the GROUP BY clause in the search. In that case, a ICmAbstractSearchResult object reflects the aggregation of query result rows.

(Inherited from ICmSweep.)
Public propertyProperties
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.)
Public propertySearchExpression
The SQL expression that is used in this background search. This property can be set to any legal Content Platform Engine SQL expression and can have parameters. The server forms the effective SQL expression for the background search by substituting values for any added parameters and stores it in the EffectiveSQL property.

Parameters are defined by custom properties that you add to an ICmBackgroundSearch subclass to define a particular search. The name of each parameter name matches the symbolic name of a custom property.

Public propertySearchObjectStore
An IObjectStore object that represents the object store against which this background search will execute. This property needs to be set only if you want to search an object store that is different from the object store to which the ICmBackgroundSearch instance belongs. If this property is null, the search is conducted in the same object store to which the ICmBackgroundSearch instance belongs.

If the search is against a different object store than the object store to which the ICmBackgroundSearch instance belongs and the SELECT list of the search expression includes any object valued-properties, then the corresponding properties of the ICmBackgroundSearch instance must allow foreign objects (their AllowsForeignObject property must be set to true); otherwise, the search will fail.

Public propertySearchResults
An ICmAbstractSearchResultSet object that holds the current enumeration of ICmAbstractSearchResult objects that are selected by this background search. Each ICmAbstractSearchResult object represents a search result that is generated by this background search.
Public propertySweepBatchSize
The number of candidate objects that will be passed to the sweep handler in a single batch.
Public propertySweepEndDate
A timestamp indicating when the sweep was completed. If NULL, the sweep has not completed yet.
(Inherited from ICmSweep.)
Public propertySweepRetryWaitInterval
If a retryable exception occurs during the processing of a sweep batch, the minimum number of seconds to wait before reattempting the batch.
Public propertySweepStartDate
A timestamp indicating when the currently running sweep started. For a sweep policy or queue sweep that is not currently in progress, the property is set to null. For a sweep job, the property remains set to a timestamp value even after the job has completed.
(Inherited from ICmSweep.)
Public propertySweepTarget
Specifies the class for which instances will be swept. Set this property to a class that is valid for the type of sweep to be run.

For a background search sweep, this property is set automatically to the background search result class.

(Inherited from ICmSweep.)
Public propertySweepTimeslots
A list of ICmTimeslot objects that determine the schedule for sweep processing. The property setting on the ICmSweep object overrides the property setting on the ICmSweepConfiguration global object. If the property is set to null on the ICmSweep object, then the timeslot setting on the ICmSweepConfiguration object is used.
(Inherited from ICmSweep.)

ToggleSee Also