CmTask Properties

The list of ActiveMarking objects currently applied to a given object. Each ActiveMarking object represents a marking that is in a MarkingSet associated with a property on the object.

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 whether permissions should be inherited from the Coordinator property.

Indicates whether the object is marked (flagged) for deletion. If true, the object is the original object explicitly marked for deletion by a user, or the object is referenced by the original object through an object-valued property (OVP), and, therefore, was marked for deletion by the server.

Objects marked for deletion are represented by a CmRecoveryItem object, through which the objects can be either recovered or purged (removed from the object store database).

See Recovery Bin Concepts

A reference to the Containable object that is acting as the coordinator for this and other related tasks. To return an enumeration of all related tasks coordinated by the object, call Containable.get_CoordinatedTasks.

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.

The date and time at which the task transitioned into the COMPLETE state.

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

The date and time at which the task transitioned into the WORKING state.

Specifies an ExternalIdentityList collection of the read-only ExternalIdentity objects that represent the identities of replicas of this object in external repositories.

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.

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

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 name for this object.

For most classes, this property is read-only and returns the value of the designated name property for the object, or its ID if there is no name property. If ClassDescription.NamePropertyIndex has a value, this property contains the value of the designated name property. If there is no designated name property value, and the object has an Id property, this property contains the string value of the Id property. If neither of these conditions is satisfied, this property contains an empty string.

For a ComponentRelationship object, this property is read/write and specifies the name of the object.

Manages the security owner assigned to the object.

Manages the discretionary permissions assigned to the object.

A condition the CmTask object must satisfy before it may be considered complete. Postcondition expressions are specified in the class definition for the task (as class constant properties). They cannot be set on a task instance.

A postcondition is evaluated when a CmTask object is in the WORKING state, and changeState(LifecycleChangeFlags.PROMOTE) is invoked on the CmTask.

A condition is expressed as an SQL predicate applied to the CmTask object itself, or to objects related to the CmTask through object-valued properties. For example, if you have a claim processing task that cannot be completed until its ClaimStatus property is set to CLOSED, then the postcondition expression would be ClaimStatus = 'CLOSED'.

A postcondition has the same syntax requirements as the FilterExpression property.

A condition the CmTask object must satisfy in order to be considered ready to be worked upon. Precondition expressions are specified in the class definition for the task (as class constant properties). They cannot be set on a task instance.

A precondition is evaluated when a CmTask object is in the WAITING_PRECONDITION state, and changeState(LifecycleChangeFlags.PROMOTE) is invoked on the CmTask.

A condition is expressed as an SQL predicate applied to the CmTask object itself, or to objects related to the CmTask through object-valued properties. For example, if you have a document approval task that cannot be worked on until its InputDocument property is set to a released document version, then the precondition expression would be InputDocument SATISFIES (VersionStatus = 1).

A precondition has the same syntax requirements as the FilterExpression property.

An enumeration of task relationships objects identifying the predecessors of this task. When you create a CmTaskRelationship object and set its SuccessorTask property to this CmTask object, the newly created CmTaskRelationship object is added to the enumeration.

Specifies a ReplicationGroup object representing the replication group to which this replicable object belongs. For ReplicationJournalEntry objects only, this property represents the replication group to which the source object of the replication operation generating this journal entry belongs.

An enumeration of task relationships objects identifying the successors of this task. When you create a CmTaskRelationship object and set its PredecessorTask property to this CmTask object, the newly created CmTaskRelationship object is added to the enumeration.

The current state of the task. Some state changes are made automatically by the Content Engine server, and others are made manually with the CmTask.changeState method. The states are defined by the Content Engine server. For a description of the possible states, see the TaskState class.

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.