The ICmBulkMoveContentJob type exposes the following members.

ToggleProperties

Type NameDescription
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 propertyCopyRetainedContent
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 propertyDescriptiveText
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
(Inherited from ICmSweepJob.)
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.

(Inherited from ICmSweepJob.)
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.

(Inherited from ICmSweepJob.)
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.)
(Inherited from ICmSweepJob.)
Public propertyEndReplicationAfterMove
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.

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

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.

(Inherited from ICmSweepJob.)
Public propertyFilterExpression
The text of a filter expression that, when evaluated, determines the action to be taken on the object. This property applies to IStoragePolicy, ISubscription, IAuditDefinition, ICmSweepPolicy, and ICmSweepJob objects.

For a IStoragePolicy object, 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 a ISubscription-based object, FilterExpression is used to determine whether the event action should be launched. For IAuditDefinition, 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 ISubscription or IAuditDefinition. Note that for version series subscriptions, the filter is applied to the document version in the transaction and not to the version series.

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

  • If the value of the expression evaluates to true, the event specified by the subscription is fired or enqueued, as appropriate (depending on whether the event code 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 is silently discarded.

For a sweep job or sweep policy, FilterExpression is used to evaluate each instance of 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 IAuditDefinition objects, FilterExpression is only applicable to events of type IObjectChangeEvent. 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 ISubscription and IAuditDefinition 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.

(Inherited from ICmSweepJob.)
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 propertyIncludeSubclassesRequested
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.
(Inherited from ICmSweepJob.)
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.

(Inherited from ICmSweepJob.)
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 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 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 propertyRecordFailures
Indicates whether failures are recorded for a sweep job running in normal mode. A failure is represented by a ICmSweepResult object with its SweepResultType property set to FAILURE.

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

(Inherited from ICmSweepJob.)
Public propertyStoragePolicy
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.

Public propertySweepBatchSize
The number of candidate objects that will be passed to the sweep handler in a single batch.
(Inherited from ICmSweepJob.)
Public propertySweepEndDate
A timestamp indicating when the sweep was completed. If NULL, the sweep has not completed yet.
(Inherited from ICmSweep.)
Public propertySweepMode
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

(Inherited from ICmSweepJob.)
Public propertySweepResults
An enumeration of sweep result records related to a sweep policy or sweep job. A sweep result record is represented by a ICmSweepResult object.
(Inherited from ICmSweepJob.)
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.
(Inherited from ICmSweepJob.)
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