updateTask
- Description
- This transaction modifies the details of a given task instance. Details that can be updated include TaskDueDate, Priority, TaskOwnerRole, TaskAction, and TaskStatus. A TaskOwner change is always accompanied by a TaskAction. TaskStatus can only be updated by a TaskAction.
- Web Services
- Operation name: updateTask
- Example
- Change the due date and priority of an existing task.
Assign an existing task to a specific task owner.
Return an assigned task back to the unassigned list.
Delete a task that was created in error.
Submit a fully completed task.
Add or remove an entity to or from a task.
- Usage information
- The updateTask transaction can be fine-grained or coarse-grained.
As a coarse-grained transaction, users can add task comments to the
task. Almost all attributes of an active task instance can be updated
directly, with the following exceptions:
- The Creator and CreationDate of the task cannot be updated.
- The TaskStatus can only be changed by providing an appropriate TaskAction.
- The TaskOwnerRole can only be updated if the task is not assigned to any TaskOwner.
The following are optional input:- TaskDueDate
- Priority
- TaskOwnerRole
- TaskOwner (must be accompanied by TaskActionType)
- TaskAction (for updating TaskStatus)
- EndDate for the associated entity
- Preconditions
- The task instance being updated must exist.
The task instance being updated must be active.
- Mandatory input
- For each task instance included in the request:
- TaskId
- TaskLastUpdateDate
- Inquiry levels
- Not applicable
- Filter values
- Not applicable
- Transaction behavior
- The following TaskStatus values are predefined to track the lifecycle
of a task:
- New
- Pending
- In Progress
- Completed
- Terminated
- Returned
- Stopping
- Stopped
A TaskStatus can only be changed by sending a TaskAction. The follow TaskActions are predefined:
- Create
- Assign
- Reassign
- Unassign
- Save
- Submit
- Approve
- Reject
- Delete
- Choose Task
- Start Task
- Complete Task
- Terminate Task
- Stop Task
- Fail Action
These TaskActions can initiate the following transitions from one TaskStatus to another:
Table 1. TaskStatus transitions based on TaskActions 'From' status Action 'To' status None (task not created) Create New New Assign Pending New Delete Terminated Pending Unassign New Pending Reassign Pending Pending Save In Progress Pending Submit Completed Pending Approve Completed Pending Reject Completed Pending Delete Terminated Pending Terminate Task Terminated Pending Stop Task Stopping Pending Fail Action Stopped In Progress Assign In Progress In Progress Reassign In Progress In Progress Unassign In Progress In Progress Save In Progress In Progress Submit Completed In Progress Approve Completed In Progress Reject Completed In Progress Complete Task Completed In Progress Stop Task Stopping In Progress Terminate Task Terminated In Progress Start Task Pending In Progress Fail Action Stopped Stopping Save Stopped Stopping Start Task Pending Stopping Terminate Task Terminated Stopped Start Task Pending Stopped Terminate Task Terminated Completed Reject Returned Returned Assign Pending Returned Reassign Pending Returned Unassign Pending Returned Save In Progress Returned Submit Completed Returned Delete Terminated To associate or disassociate one or more entities to a task, provide the InstancePK and EntityName attributes in the WorkbasketEntityBObj.
To enable the updateTask transaction to associate one or more comments, provide the comment text in the TaskCommentBObj object’s CommentText attribute.
- Request message
- <TCRMTxType> updateTask
<TCRMTxObject> TaskBObj
<TCRMObject> TaskBObj
with optional business objects: - Response objects
- TaskBObj with optional
business objects:
- WorkbasketBObj with a list of WorkbasketEntityBObj
- TaskCommentBObj
- Special note
- Not applicable