This topic alphabetically lists the properties that apply to the CmTask class.
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.
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.
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).
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
.
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.
COMPLETE
state.
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).
WORKING
state.
ExternalIdentityList
collection of the read-only ExternalIdentity
objects
that represent the identities of replicas of this object in external repositories.
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.
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)
.
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 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.
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.
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.
CmTaskRelationship
object and set its SuccessorTask
property to this CmTask
object,
the newly created CmTaskRelationship
object is added to the enumeration.
ReplicationGroup
object representing the replication group to
which this replicable object belongs.
ReplicationJournalEntry
objects only, this property represents the replication group
to which the source object of the replication operation generating this journal entry belongs.
CmTaskRelationship
object and set its PredecessorTask
property to this CmTask
object,
the newly created CmTaskRelationship
object is added to the enumeration.
CmTask.changeState
method.
The states are defined by the Content Engine server.
For a description of the possible states, see the TaskState
class.