This topic alphabetically lists the properties that apply to the CmBackgroundSearch class.
false
, the search fails if it contains string values that
exceed the maximum string length. The default value is false
.
EventSet
collection of the Event
objects containing the audited events that have occurred for the
object.
ClassDescription
object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
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.
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.
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).
Name
property of the object's class.
For CmAuditProcessingBookmark
and AuditDefinition
objects, this property is intended to identify client applications
that process the audit log.
For CmAuditProcessingBookmark
objects, this property, in support of the audit disposition feature, identifies the client that created the object.
For AuditDefinition
objects, this property identifies a set of audit definitions for a given client or client functionality.
For CmAuditProcessingBookmark
and AuditDefinition
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
CmAuditProcessingBookmark
or AuditDefinition
objects. Therefore, the client application is responsible for enforcing uniqueness.
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.
For a background search, the number of query result rows that have been returned at this point in the search. This number reflects the setting in the MaximumExaminedRowCount property.
For a background search, the value of this property is always zero.
For a queue entry, when this property is equal to or exceeds the MaximumFailures property on CmQueueSweep
,
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 (CmBackgroundSearch
), when this property is equal to or exceeds the MaximumFailures
property on CmBackgroundSearch
, the background search stops.
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.
The property setting on the CmSweep
object overrides the property setting on the
CmSweepConfiguration
global object. If the property is set to null on the CmSweep
object,
then the InterBatchDelay setting on the CmSweepConfiguration
object is used.
EventAction
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 code handler 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 code procedures to execute against federated documents.
Note that when you disable an EventAction
, all of its associated subscriptions are also
disabled. However, when you disable one particular Subscription
, 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.
IndexJob
and CmIndexRequest
objects, this property identifies the final failure
condition for the index job.
For a ReplicationJournalEntry
object, this property provides a description of the latest failure condition,
if any, for the replication operation that generates this journal entry.
For a CmThumbnailRequest
object, this property states why document thumbnail generation failed.
For a CmBackgroundSearch
object, this property provides a description of the latest failure condition,
if any, for the background search operation that generates this journal entry.
For a CmTask
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:
CmTask.changeState(SET_EXCEPTION);
CmTask.set_LastFailureReason ( "Required document was not attached to workflow.");
CmTask.save();
To reset LastFailureReason to a null value, clear the exception:
CmTask.changeState(CLEAR_EXCEPTION)
.
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).
For a CmBackgroundSearch
object, this property is ignored.
CmQueueSweep
, 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 CmAbstractQueueEntry
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 CmQueueSweep 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 CmBackgroundSearch
, 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.
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
.
For a background search, the number of CmAbstractSearchResult
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 CmAbstractSearchResult
object reflects the aggregation of query result rows.
Parameters are defined by custom properties that you add to a CmBackgroundSearch
subclass to
define a particular search. The name of each parameter name matches the symbolic name of a custom property.
ObjectStore
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
CmBackgroundSearch
instance belongs. If this property is null, the search is conducted in the same
object store to which the CmBackgroundSearch
instance belongs.
If the search is against a different object store than the object store to which the CmBackgroundSearch
instance belongs
and the SELECT list of the search expression includes any object valued-properties, then the corresponding
properties of the CmBackgroundSearch
instance must allow foreign objects (their AllowsForeignObject
property must be set to true
); otherwise, the search will fail.
CmAbstractSearchResultSet
object that holds the current enumeration of
CmAbstractSearchResult
objects that are selected by this background search.
Each CmAbstractSearchResult
object represents a search result that is generated by this background search.
NULL
, the sweep has not completed yet.
null
.
For a sweep job, the property remains set to a timestamp value
even after the job has completed.
For a background search sweep, this property is set automatically to the background search result class.
CmSweep
object overrides the property setting
on the CmSweepConfiguration
global object.
If the property is set to null on the CmSweep
object,
then the timeslot setting on the CmSweepConfiguration
object
is used.