Task Viewer

Adds a task viewer widget to your dashboard, which displays task details such as data that is relevant to the task.

null

inNavigator: Boolean

Behavior

Set task:	Set the task that you want to display in the task viewer.	`ANY`
Customize system data:	Set the system data that you want to display in the task viewer.	`String`
Set task actions:	Specify the list of actions that can be performed on the task.	`String[]`
Show on task closed:	Show the task viewer when the task is closed.	`Boolean`
Show the breadcrumb trail:	Show the navigation path to the current page in the task viewer.	`Boolean`

Events

On Load:

Description:	This event is fired whenever the view is loaded.
Example:	`console.log("View loaded")`

On Task Opened:

Description:

This event is fired when a task or service is opened in the viewer.

Context Variables	data {object}
Properties	task or service data

On Task Closed:

Description:

This event is fired when the viewer is closed.

Context Variables
Properties

On Task Action:

Description:

This event is fired when an action is triggered from the action menu.

Context Variables	data {object}	action {string}
Properties	task or service data	selected action

Extends:

com.ibm.bpm.coach.CoachView

Methods:

Inherited addClass(name, [replaced])

Add/replace CSS class(es) for this control

Name	Type	Default	Description
name	`{string}`		CSS class name(s) to add to the control. Separate class names by a space if more than one class.
replaced	`{string}`		CSS class name(s) to be replaced by the first argument. Separate class names by a space if more than one class.

Example

Button.addClass("green");

closeViewer()

Closes the view.

Inherited hide(collapseFlag)

Hide this view/control

Name	Type	Default	Description
collapseFlag	`{boolean}`		Set to `true` to collapse the view (equivalent to a view setting of "NONE")

Example

MyView.hide();

Inherited isBound() Returns: {boolean}

Indicates bound status of control.

Inherited isEnabled() Returns: {boolean}

Checks if the view is enabled or not

Example

var enabled = MyView.isEnabled();

Inherited isLabelVisible() Returns: {boolean}

Checks if control label is visible

Example

var labelVisible = MyView.isLabelVisible();

Inherited isVisible() Returns: {boolean}

Checks whether or not view is visible

Example

var visible = MyView.isVisible();

Inherited setEnabled(enabled, required)

Enable/disable this view/control

Name	Type	Default	Description
enabled	`{boolean}`		Enabled/read-only flag (`true` to enable view, `false` to disable/make read-only)
required	`{boolean}`		Enable/disable required field flag for control

Example

MyView.setEnabled(false); //Make MyView read-only

Inherited setLabelVisible(visible)

Show/hide the label of this view/control

Name	Type	Default	Description
visible	`{boolean}`		Label visibility flag (`true` to show view label, `false` to hide)

Example

MyView.setLabelVisible(false);

setServiceData(service)

Sets the service on the view.

Name	Type	Default	Description
service	`{ANY}`		The data to be set on the Task Viewer view.

setTaskData(task, businessData, systemData)

Sets the task, businessData, and systemData of the view.

Name	Type	Default	Description
task	`{ANY}`		The data to be set on Task Viewer.
businessData	`{ANY}`		The data to be set on Task Viewer.
systemData	`{ANY}`		The data to be set on Task Viewer.

Inherited setViewData(data, createPseudoBinding)

Set/update bound data associated this view/control. Only works for views/controls with bound data.

Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the binding.set pattern detailed in the Knowlege Center section Binding Data and Configuration Options

Name	Type	Default	Description
data	`{Object}`		Value of bound data. The type of this parameter must match the type of the bound data.
createPseudoBinding	`{boolean}`		If set to true, creates a pseudo binding if there is no current binding.

Example

MyView.setViewData("TEST"); //Updates bound data to the string 'TEST'

Inherited setVisible(visible, collapse)

Show/hide this view/control

Name	Type	Default	Description
visible	`{boolean}`		Visibility flag (`true` to show view, `false` to hide)
collapse	`{boolean}`		Set to `true` to collapse the control space when `visible` is set to `false`.

Examples

MyView.setVisible(false, false); //Equivalent to MyView.hide()

MyView.setVisible(false, true); // Sets visibility to "None"

Inherited show()

Show this view/control

Example

MyView.show();

Methods

Parent

Helpers