Task Instance Attributes

A task is work that must be done by a user. When you create a task, you assign humans to participate in and act upon the task. Table 34-15 describes the task attributes that are commonly used and interpreted by applications.

Table 34-15 Task Attributes

Task Attribute Name	Description
`task/applicationContext`	The application with which any application roles associated with this task (assignees, owners, and so on) belong.
`task/category`	An optional category of the task.
`task/creator`	The name of the creator of this task.
`task/dueDate`	The due date for the task. This is used on to-do tasks.
`task/identificationKey`	An optional, custom, unique identifier for the task. This can be set as an additional unique identifier to the standard task ID and task number. This key can retrieve a task based on business object identifiers for which the task is created.
`task/identityContext`	The identity realm under which the users and groups are seeded. In a single realm environment, this defaults to the default realm.
`task/ownerGroup`	The group (if any) that owns this task instance. Task owners can be application roles, users, or groups. If the owner of the task is a group, this field is set.
`task/ownerRole`	The application role (if any) that owns this task instance. Task owners can be application roles, users, or groups. If the owner of the task is an application role, this field is set.
`task/ownerUser`	The user (if any) that owns this task instance. Task owners can be application roles, users, or groups. If the owner of the task is a user, this field is set.
`task/payload`	The task payload that is captured as XML.
`task/percentageComplete`	The percentage of the task completed. This is used on to-do tasks.
`task/priority`	An integer number that defines the priority of this task. A lower number indicates a higher priority. The numbers `1` to `5` are typically used.
`task/startDate`	The start date for the task. This is used on to-do tasks.
`task/subCategory`	An optional subcategory of the task.
`task/taskDefinitionId`	The task definition ID that binds the task to the task metadata. At task initiation time, this can be either the `compositeDN`/`componentName` string or the `targetNamespace` in the `.task` file. If the later is used, the active version matching the `targetNamespace` is used.
`task/taskDisplayUrl`	The URL to use to display the details for this task.
`task/title`	The title of the task.

Table 34-16 lists the attributes that capture process metadata information.

Table 34-16 Attributes Capturing Process Metadata Information

Attribute	Description
`task/sca/applicationName`	The partition to which the task component that defines this task instance is deployed.
`task/sca/componentName`	The name of the task component that defines this task instance.
`task/sca/compositeDN`	A unique name for the particular deployment of the composite that contains the task component that defines this task instance.
`task/sca/compositeInstanceId`	The composite instance ID.
`task/sca/compositeName`	The name of the composite that contains the task component that defines this task instance.
`task/sca/compositeVersion`	The version of the composite that contains the task component that defines this task instance.
`task/sca/compositeCreatedTime`	The date and time on which the composite flow to which this task instance belongs was started.
`task/sca/flowId`	A unique identifier for the composite flow to which this task instance belongs.

Table 34-17 lists the attachment-related attributes.

Table 34-17 Attachment-related attributes

Attribute	Description
`task/attachment/content`	The attachment content.
`task/attachment/mimeType`	The Multipurpose Internet Mail Extension (MIME) type of the attachment.
`task/attachment/name`	The name of the attachment.
`task/attachment/updatedBy`	The user who updated the attachment.
`task/attachment/updatedDate`	The date on which the attachment was updated.
`task/attachment/URI`	The URI if the attachment is URI-based.

Table 34-18 lists the comment-related attributes.

Table 34-18 Comment-related Attributes

Attribute	Description
`task/userComment/comment`	The user comment.
`task/userComment/updatedBy`	The user who added the comment.
`task/userComment/updatedDate`	The date on which the comment was added. This is set by services when saving comments. If set by client when saving the comment, it is ignored.
`task/userComment/displayNameLanguage`	Set by services when reading comments. This indicates the language in which the `updatedBy displayName` is populated.
`task/userComment/acl`	Not used.
`task/userComment/doesBelongToParent`	If the comment is inherited from parent (example process comment).
`task/userComment/isSystemComment`	Set by services if the comment is set by the workflow system (example, a comment is created if the task goes into alerted state).
`task/userComment/taskId`	The taskId in which the comment was created. For example, if the scope is "BPM", the comment may be visible in a task different than the one in which it was created. Also, for parallel task, the current taskId and comment taskId may be different. This is set by services.
`task/userComment/commentScope`	The values - null, empty or "TASK" implies that the comment is for that task only. The value "BPM" implies that it is for the whole process. The value has to be set to "BPM" when adding comment if you want the comment to be applicable to the whole process.
`task/userComment/updatedBy/id`	ID of the user who updated the comment.
`task/userComment/updatedBy/displayName`	Display name of the user who updated the comment.
`task/userComment/updatedBy/type`	Type of User, Group, or Role of the user who updated the comment.

Table 34-19 lists the attributes manipulated by the workflow services system.

Table 34-19 Attributes Manipulated by the Workflow Services System

Attribute	Description
`task/systemAttributes/acquiredBy`	If a task is assigned to a group, application role, or to multiple users, and then claimed by a user, this field is set to the name of the user who claimed the task.
`task/systemAttributes/approvers`	The IDs of users who performed custom actions on the task.
`task/systemAttributes/assignedDate`	The date that this task was assigned.
`task/systemAttributes/assignees`	The current task assignees (can be users, groups, or application roles).
`task/systemAttributes/createdDate`	The date the task instance was created.
`task/systemAttributes/customActions`	The custom actions that can be performed on the task.
`task/systemAttributes/endDate`	The end date for the task. This is used on to-do tasks.
`task/systemAttributes/expirationDate`	The date on which the task instance expires.
`task/systemAttributes/fromUser`	The user who previously acted on the task.
`task/systemAttributes/hasSubTasks`	If `true`, there are subtasks.
`task/systemAttributes/isGroup`	If `true`, the task is assigned to a group.
`task/systemAttributes/originalAssigneeUser`	If a user delegates a task to another user, this field is populated with the name of the user who delegated the task.
`task/systemAttributes/outcome`	The outcome of the task (for example, approved or rejected). This is only set on completed task instances.
`task/systemAttributes/parentTaskId`	This is only set on reinitiated tasks (the task ID of the previous task that is being reinitiated).
`task/systemAttributes/parentTaskVersion`	This only set on a subtask. This refers to the version of the parent task.
`task/systemAttributes/participantName`	The logical name of the participant as modeled from Oracle JDeveloper.
`task/systemAttributes/reviewers`	The reviewers of the task. This can be a user, group, or application role.
`task/systemAttributes/rootTaskId`	The ID of the root task. This is the same as the task ID for the root task.
`task/systemAttributes/stage`	The stage name that is being executed.
`task/systemAttributes/state`	The current state of the task instance.
`task/systemAttributes/substate`	The current substate of the task.
`task/systemAttributes/subTaskGroupInstanceId`	A unique ID that is set on a subtask. This same ID is set on the parent task's `taskGroupInstanceId`. This is required to identify which subtasks were created at which time.
`task/systemAttributes/systemActions`	The system actions (such as reassign, escalate, and so on) that can be performed on a task.
`task/systemAttributes/taskDefinitionName`	The name of the task component that defines this task instance.
`task/systemAttributes/taskGroupId`	The ID of the immediate parent task. This only sets a subtask.
`task/systemAttributes/taskGroupInstanceId`	A unique ID that is set on the parent task. This same ID is set on the subtask's `subTaskGroupInstanceId`. This is required to identify which subtasks were created at which time.
`task/systemAttributes/taskId`	The unique ID of the task.
`task/systemAttributes/taskNamespace`	A namespace that uniquely defines all versions of the task component that defines this task instance. Different versions of the same task component can have the same namespace, but no two task components can have the same namespace.
`task/systemAttributes/taskNumber`	An integer number that uniquely identifies this task instance.
`task/systemAttributes/updatedBy`	The user who last updated the task.
`task/systemAttributes/updatedDate`	The date this instance was last updated.
`task/systemAttributes/version`	The version of the task.
`task/systemAttributes/versionReason`	The reason the version was created.
`task/systemAttributes/workflowPattern`	The pattern that is being executed (for example, parallel, serial, FYI, or single).

Table 34-20 lists the mapped attributes.

Table 34-20 Mapped Attributes

Attribute	Description
`task/systemMessageAttributes/*`	The mapped attributes.