Show TOC

Task CollectionLocate this document in the navigation structure

This collection represents the user's tasks exposed by the respective providers (for example, SAP Business Workflow (BWF) and SAP Business Process Management (BPM)). When navigating to the Task collection, users receive their inbox tasks and their completed tasks.

Table 1: Properties Table

Property Name

Description

SAP__Origin

Key field.

Contains the system alias of the task's source.

InstanceID

Key field.

Contains the task instance ID. (For example, work item ID from BWF.)

TaskDefinitionID

The task ID. (It can also be retrieved using the TaskDefinitionData association.)

TaskDefinitionName

The name of the Task ID. (It can also retrieved using the TaskDefinitionData association.)

TaskTitle

The item's subject.

Priority

The technical name of the item's priority. For the possible values of this property and the display name, use the FilterOptionCollection. Mapping of values is done from provider to Task Gateway. For an overview of the values, see Filter Option Collection.

Status

The technical name of the item's status. For the possible values of this property and the display name, use the FilterOptionCollection. Mapping of values is done from provider to Task Gateway. For an overview of the values, see Filter Option Collection.

StatusText

Optional — Contains the custom text description for the provider’s status.

CreatedOn

The time and date when the item was created.

CreatedBy

Full name of the user who created the item (source system user).

Processor

The current processor of the item (source system user).

StartDeadLine

The time and date of the started item's deadline.

CompletionDeadLine

The time and date when the item deadline ends.

ExpiryDate

For BPM: The time and date when the item expires.

For Task Gateway: The time and date of the closest deadline.

IsEscalated

This flag indicates the item was escalated.

HasComments

This flag indicates the existence of comments.

HasAttachments

This flag indicates the existence of attachments.

HasPotentialOwners

This flag indicates the existence of potential owners.

SupportsComments

This flag indicates that comments are supported.

SupportsAttachments

This flag indicates that attachments are supported.

SupportsClaim

This flag indicates that tasks can be claimed by users.

SupportsRelease

This flag indicates that the task can be released.

SupportsForward

This flag indicates that the task can be forwarded.

PriorityNumber

This flag indicates the priority number of task.

ScenarioID

Enables to filter by scenario ID.

ForwardingUser

Full name of user who forwarded the item (source system user)

TaskSupports:

  • AddAttachments

  • AddComments

  • Attachments

  • Comments

  • CreatedByDetails

  • CustomAttributeData

  • Description

  • PossibleAgents

  • PotentialOwners

  • ProcessingLogs

  • ProcessorDetails

  • TaskDefinitionData

  • TaskObject

  • UIExecutionLink

  • CancelResubmission

  • Confirm

  • Claim

  • Forward

  • Release

  • Resubmit

  • SetPriority

Complex type indicating what the task supports

CompletedOn

Date on which the task was completed.

ResumeOn

Date on which tasks processing is to be resumed.

ForwardedOn

Date on which task was forwarded for processing.

ForwardedUser

Full name of user to whom task has been forwarded for processing.

UID

Unique identifier that indicates unique InstanceID in a system landscape.

In cases where a provider can guarantee the uniqueness of the InstanceID, the provider can assign the InstanceID to this attribute.

In cases where a provider cannot guarantee the uniqueness of the InstanceID, the provider adds a suffix to the InstanceID to make it unique and assigns this value to this attribute.

GUI_Link

If this property is set, no lazy loading of the task execution URL is required since this is contained in the GUI_Link property. For all tasks for which GUI_Link is not set, navigation to the UIExecutionLink is used.