TaskViewer

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:

Methods:

Inherited addClass(name, [replaced])

Add or replace the CSS classes for this view.

Name Type Default Description

name {string} The CSS class names to add to the view. For multiple classes, use space to separate the class names.

replaced {string} The CSS class names to be replaced by the first argument. For multiple classes, use space to separate the class names.

Example

Button.addClass("green");

closeViewer()

Closes the view.

Inherited hide(collapseFlag)

Hide the view.

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}

Indicate the bound status of the view.

Inherited isEnabled() Returns: {boolean}

Check whether the view is enabled.

Example

var enabled = MyView.isEnabled();

Inherited isLabelVisible() Returns: {boolean}

Check whether the view label is visible.

Example

var labelVisible = MyView.isLabelVisible();

Inherited isVisible() Returns: {boolean}

Check whether the view is visible.

Example

var visible = MyView.isVisible();

Inherited setEnabled(enabled, required)

Enable or disable the view.

Name Type Default Description

enabled {boolean} Enabled/read-only flag (true to enable view, false to disable/make read-only)

required {boolean} Enable or disable the required field flag for the view.

Example

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

Inherited setLabelVisible(visible)

Show or hide the view label.

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 or update the bound data associated with the view. It applies only to views with bound data.

Note: It should only be used with simple type bindings, or complex type bindings with simple type properties.
It should not be used with bindings that have properties that are lists or compext types. For complex types, set the bindings by using
the binding.set pattern, as described in the Binding data and configuration options documentation section.

Name Type Default Description

data {Object} The value of the bound data. The parameter type must match the type of the bound data.

createPseudoBinding {boolean} If the value is set to true, the parameter 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 or hide the view.

Name Type Default Description

visible {boolean} Visibility flag (true to show the view, false to hide it)

collapse {boolean} Set it to true to collapse the view space when the option 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.

Example

MyView.show();

Methods

Parent

Helpers