This topic alphabetically lists the properties that apply to the CmPolicyControlledSweep class.
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).
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.
FilteredQueryTimeout
can be used to optimize job and policy sweep performance.
When FilteredQueryTimeout
is set to the default value of 0, a sweep first issues queries
to retrieve candidate objects from the database, and next applies the filter expression conditions on the
candidate objects to determine which objects to process.
When the FilteredQueryTimeout
value is greater than 0, then the queries
issued to the database include the conditions of the filter expression in the WHERE
clause.
The value of the FilteredQueryTimeout property is used to set a time limit on the query.
The time limit is applied only to the first query of the sweep iteration. If the query time limit is exceeded,
then the query terminates and the sweep falls back to using a query that does not contain the
filter expression in the WHERE
clause.
The use of the FilteredQueryTimeout
property is a trade-off between
the sweep issuing longer-running database queries or evaluating candidate objects before processing them.
For more information, see
Optimizing sweeps with FilteredQueryTimeout.
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.
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.
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.
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.