You are viewing the documentation for Blueriq 14. Documentation for other versions is available in our documentation directory.

This type of service is used to retrieve information concerning the active task for displaying purposes. The attribute types that are used in the parameters should match the type of information returned by the service to avoid type conversion errors.

Parameters


NameDescriptionTypeRequired
taskId

The task ID of the task of which you want to get information.

Note: leaving the taskId parameter empty is deprecated for the current DCM implementation and no longer supported in DCM 2.0

Expression

false

true for DCM 2.0

nameReturns the task’s name.Attributefalse
displaynameReturns the tasks display name, empty when there is no display name available for the active language.Attributefalse
descriptionReturns the tasks description, empty when there is no description available.Attributefalse
assigneeReturns the ID of the User, empty when the task is not assigned.Attributefalse
teamReturns the names of the teams which are assigned to the task.Attributefalse
roleReturns the names of the roles which are assigned to the task.Attributefalse
authorizedrolesReturns the authorized roles which are assigned to the task.Attributefalse
startdateReturns the date and time when the task was started, empty when task is not started.Attributefalse
targetdateReturns the tasks due date, empty when task has no due date. A Due date is set at the task specification.Attributefalse
timeoutdateReturns the tasks timeout date. Date is set using a timer exit on a task.Attributefalse
statusReturns the tasks status. Available options are: started, open, complete, expired or cancelled.Attributefalse
priorityReturns the integer value which is set by the priority algorithm.Attributefalse
ismanuallyassignedReturns true when the task is manually assigned, false in case it is not. A task can also be assigned by an routing algorithm or not assigned at all.Attributefalse
customfieldsReturns the additional custom defined fields for a task.Stringfalse

A target attribute can be selected for set the derived value in the profile of the flow. It is also possible to define custom fields. This is a tuple 'custom field', 'attribute'. It is possible to enter as much custom fields as you want.

The display name is a multilingual value, for that reason it can not be displayed using an attribute. It can be showed using a content item. When placed in an attribute the name will be displayed.