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).
FilteredQueryTimeout
can be used to enhance 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.
The following is a sweep query of the Document
class and all subclasses:
SELECT TOP 2000 bcn.Id, bcn.StorageArea, bcn.ReplicationGroup
FROM Document bcn WITH INCLUDESUBCLASSES
WHERE Id > {00000000-0000-0000-0000-000000000000} ORDER BY Id
The query retrieves instances of the Document
class from the database.
If the FilterExpression
property is set on the sweep job or policy, the sweep
uses the filter expression to evaluate the instances (the candidate objects) that were
returned from the database. For the objects that satisfy the conditions of the filter expression,
the sweep processes them as defined by the job or policy .
For example, if a document disposal policy has a filter expression of
IsReserved=TRUE AND ContentSize > 10000
, the disposal policy deletes
only instances that are in the reservation state and have content that is larger than 10,000 bytes.
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.
Expanding on the previous example, using a FilteredQueryTimeout
value of 30 seconds
and a filter expression of IsReserved=TRUE AND ContentSize > 10000
results in
the following sweep query:
SELECT TOP 2000 bcn.Id, bcn.StorageArea, bcn.ReplicationGroup, bcn.ContentSize, bcn.IsReserved
FROM Document bcn WITH INCLUDESUBCLASSES
WHERE Id > {00000000-0000-0000-0000-000000000000}
AND (IsReserved=TRUE AND ContentSize > 10000)
ORDER BY Id OPTIONS(TIMELIMIT 30)
Note that the TIMELIMIT value of the query is set to the value of the FilteredQueryTimeout
property (TIMELIMIT 30).
The value of the FilterExpression
property is used to expand the the WHERE clause and the selection list of the query.
When the time limit is greater than 0, it 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 sweep continues to use the WHERE clause without the filter expression until the iteration is completed. If the query time limit is not exceeded during the first query, then the sweep continues to use the WHERE clause with the filter expression until the sweep iteration is completed.
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.
If the FilteredQueryTimeout
property is used, each query runs longer because it includes the conditions of the
filter expression in the WHERE clause. However, the sweep job or policy runs faster because it
need not evaluate candidate objects returned by the database before processing them.
If the FilteredQueryTimeout
property is not used, then each query runs faster,
but the policy or job must first evaluate the candidate instances before processing the ones that meet
the filter expression conditions.
For more information, see usage guidelines.
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).
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.
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.