CmBulkMoveContentJob Properties

An EventSet collection of the Event objects containing the audited events that have occurred for the object.

Specifies a ClassDescription object containing the fixed description (immutable metadata) of the class from which this object is instantiated.

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.

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.

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).

User-readable text that describes an object.

The text is not locale-specific to the retrieving user except for the following classes:

• ClassDescription
• PropertyDescription
• ClassDefinition
• PropertyTemplate
• PropertyDefinition

The user-readable, provider-specific name of an object. This property is usually the designated 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.

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.

The date and time that 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.)

A flag that indicates that replication will be permanently disabled on documents and annotations after the content has been moved. This property supports the use case of decommissioning an external repository that is no longer needed.

Set this property to true to disable replication on federated documents and annotations after the content is moved to a P8 storage area. After moving the content, the server sets the ReplicationGroup property to null on documents and annotations.

For a sweep job, which runs only once, the number of objects that were examined in the iteration. For an ongoing sweep, the cumulative number of objects that were examined in the current iteration plus in all of the previous iterations.

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.

The text of a filter expression that, when evaluated, determines the action to be taken on the source object. This property applies to StoragePolicy, Subscription, AuditDefinition CmSweepPolicy, and CmSweepJob objects.

For StoragePolicy, FilterExpression is used as the selection criteria for determining into which storage area the content for a document or annotation should be stored. The expression is evaluated against all storage areas to determine which ones are deemed "equivalent" in terms of this storage policy. For more information, see Storage policies.

For Subscription, FilterExpression is used to determine whether the event action should be launched. For AuditDefinition, FilterExpression is used to determine whether an event should be audited. The filter is applied to either the source object, or, optionally, to the object specified in the FilteredPropertyId property of Subscription or AuditDefinition. Note that for version series subscriptions, the filter is applied to the document version in the transaction and not to the version series.

For Subscription, the Content Engine server evaluates the filter expression, as follows:

• If the value of the expression evaluates to true, the event action specified by the subscription is fired or enqueued, as appropriate (depending on whether the event action is set to execute synchronously or asynchronously).
• If the value evaluates to false or unknown (typically resulting from a property that has no value), or if there is an error in the evaluation (such as a syntax error in the expression or an incorrect reference to a property), the event action is silently discarded.

For a sweep job or sweep policy, FilterExpression is used to evaluate each instance of the sweep-target class. If the value of the expression evaluates to true, an operation is applied to the instance. The operation performed depends on the type of sweep.

For AuditDefinition objects, FilterExpression is only applicable to GetContentEvent and events of type ObjectChangeEvent. If the value of the expression evaluates to true, the event is audited; otherwise, it is not audited.

The syntax of this property must be a fragment of a SQL where-clause expression (for example, VersionStatus = 1) and use supported operators. See SQL Syntax Reference.

Note that some operators that are valid in an ad hoc SQL query are not supported in FilterExpression. The following operators are not supported.

• Binary compare operators (e.g., Equal Binary)
• Contains
• Exists
• Float64 To Integer 32 Round/Truncate
• In Folder and In Subfolder
• Integer32 To Float 32
• IsDefined
• Joins (e.g., Full Outer Join)

Note that a filter expression can include conditions expressed against non-queryable and non-persistent properties. For example, the following is a valid expression: Owner='jsmith'

For Subscription and AuditDefinition objects only, you can use the IsModified predicate, for filtering events based on modified properties of the source object.

A filter expression using the IsModified predicate must be constructed as follows: IsModified(property), where property can be in any form supported elsewhere in the query, for example, table_alias.property_alias.

Note that the IsModified predicate can only be used in a filter expression. It cannot be used in an ad hoc SQL query.

Indicates whether the queries issued during a sweep iteration include the conditions of the filter expression (as defined in the FilterExpression property). 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.

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

Indicates whether the operation should apply to the subclasses of the class. For a ClassSubscription object, this property indicates whether the subscription should also apply to the subclasses of the target class. For an AuditDefinition object, this property indicates whether auditing should also apply to the subclasses of the class configured for auditing.

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

Indicates whether a given object is enabled or disabled. For example, you can globally disable or enable active events by setting an 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.

Indicates the name of the user who last modified this 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).

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

Manages the security owner assigned to the object.

Manages the discretionary permissions assigned to the object.

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.

Indicates whether failures are recorded for a sweep job running in normal mode. A failure is represented by a CmSweepResult object with its SweepResultType property set to FAILURE.

This property is ignored if the sweep job is running in preview mode.

Specifies the document's storage policy, which identifies the set of available storage areas that are considered equivalent based on common, user-specified criteria. Assigning a storage policy to a document is the recommended method of selecting a storage area. The alternative is to directly assign the storage area (specify the StorageArea property).

When a document is created, the order of precedence for setting the storage on the Document instance is (from highest to lowest):

• instance value for the StorageArea property
• class default for the StorageArea property
• instance value for the StoragePolicy property
• class default for the StoragePolicy property

The default ClassDefinition for a document sets the StorageArea to Database Storage Area and the StoragePolicy to All Storage Areas. Therefore, if you create a new Document instance of the default Document ClassDefinition with only the StoragePolicy property set, the document will use the class default for the StorageArea property (Database Storage Area).

To avoid this situation, you must set the instance value for the document's StorageArea property to null. Because the instance value for StorageArea is set, but has no value, the StoragePolicy property will be evaluated and used.

In general, storage policies should be used to allow administrators to properly administer their storage systems. They can assign multiple storage areas to be load balanced, and also assign standby storage areas to be used if any of the current storage areas become full.

The number of candidate objects that will be passed to the sweep handler in a single batch.

A timestamp indicating when the sweep was completed. If NULL, the sweep has not completed yet.

The mode under which a sweep job or policy will execute. In normal mode, selected candidate objects are processed. In preview mode, selected candidate objects are identified but not actually processed.

The property takes a value of type SweepMode.

An enumeration of sweep result records related to a sweep policy or sweep job. A sweep result record is represented by a CmSweepResult object.

If a retryable exception occurs during the processing of a sweep batch, the minimum number of seconds to wait before reattempting the batch.

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.

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.

A list of CmTimeslot objects that determine the schedule for sweep processing. 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 timeslot setting on the CmSweepConfiguration object is used.

The current object. The primary purpose of this property is to enable the expression of relationships among objects in a Content Engine query and to select candidate objects in the query results.