InstanceList

Instance List

Adds an instance list widget to your dashboard, which lists all the workflow instances that you are authorized to see and participate in.

Appearance

Show Refresh button: Show the Refresh button, which you can use to manually refresh the instance list when the notification server is unavailable. Boolean

Show Start workflow: Show the Start workflow button. Boolean

Hide status column: Hide the status column from the list. Boolean

Disable actions menu: Disable the menu that gives access to more actions for the task. Boolean

Show search filter: Show the search filter button. Boolean

Behavior

Filter by project: Enter the project name to filter the instance list to only the instances for that project. String

Customize instance columns: Specify the columns to display in the instance list. NameValuePair[]

Set persistent instance filters: Select the binding to persist the filters in the instance list. SearchFilter[]

Set instances per page: Enter the number of instances to show per page. Integer

Enable instance launch: Enable the ability to open a workflow instance. Boolean

Set persistent searches: Select the binding to persist the recent searches in the search bar. String[]

Case scope: Choose what case instances are included in your list, either all the instances that you're authorized to see or just the instances that are directly assigned to you.
{Allowed | Assigned} CaseScope

Set persistent column widths: Select the binding to persist the column widths in the instance list. NameValuePair[]

Set persistent instance sorting: Select the binding to persist the sorting of the instance list. NameValuePair

Open instance in new window: Open an instance in a new window. Boolean

Show copy link: Show the copy link action in the overflow menu. Boolean

Set persistent instance advanced search text: Select the binding to persist the advanced search text of the instance list. String

Set persistent instance advanced search: Select the binding to persist the advanced search of the instance list. String

Events

On Load:

Description: This event is fired whenever the view is loaded.

Example:

console.log("View loaded")

On Instance Launched:

Description:

This event is fired when an instance is launched from the instance list.

Context Variables	instance {object}
Properties	instance data

Extends:

com.ibm.bpm.coach.CoachView

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");

callLaunchInstanceEvent(data)

Calls the 'On instance launched' event

Name Type Default Description

data {Data} The instance data

createStatusCell(theView, cell)

Creates the status cell with the appropriate highlighting based on the current instance status.

Name Type Default Description

theView {View} The current view

cell {Cell} The table cell where the status information will be displayed.

deSelectAllRows()

Deselcts all selected rows

displayExpandedTaskRow()

Sets the list of conditions to filter the instance list. If a search term is provided, it overrides any previously specified search conditions.

getSelectedRecords()

Gets selected tasks

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();

hideStartBtn()

hide the start workflow button

initInstanceList(view)

Initializes the instance list.

Name Type Default Description

view {View} The view to initialize

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();

launchInstance(row)

Opens the instance details for the given row.

Name Type Default Description

row {Row} The table row that contains the instance record.

onActionMenuClosed(actionsMenuView, actionsMenuTargetElement)

Called when the actions menu is closed.

Name Type Default Description

actionsMenuView {View} The actions menu view

actionsMenuTargetElement {Element} The action menu button that was clicked to invoke the menu.

onColumnSorting()

Triggered on column sorting

onResizeColumn()

Sets the column widths to the columnWidths binding

onTableRowSelected()

Triggered when table row get (all) selected

openFilter()

The event handler for the slideout toggle.

paginationHandler()

Handler for when the pagination view's value changes

refreshInstanceList()

Refresh instancelist when the refresh button is clicked

reload()

Reloads the instance list.

setAdvancedSearch(data)

Sets the json query for filtering the task list.

Name Type Default Description

data {Object} An object containing the input string, interaction filter, json query, and sort of the advanced search

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

setFilterConditions(conditions)

Sets the list of conditions for filtering the instance list. If a search term is provided, it overrides the previously specified search conditions. The valid operators include "Equals", "NotEquals", "LessThan", "GreaterThan", and "In". For the "In" operator, use semi-colons ";" to separate a list of values.

Name Type Default Description

conditions {NameValuePair[]} The list of filter conditions.

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);

setQuickFilterConditions(conditions)

Sets the list of conditions for filtering the instance list. If a search term is provided, it overrides the previously specified search conditions.

Name Type Default Description

conditions {NameValuePair[]} The list of filter conditions.

setSearchTerm(searchTerm)

Sets the search term. If a search term is provided, it overrides any previously specified search conditions.

Name Type Default Description

searchTerm {string} The search term to filter the instance list.

setSelectedColumns(columns)

Sets the selected columns that the instance list displays, and reloads the list.

Name Type Default Description

columns {NameValuePair[]} The list of selected columns.

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();

updateSortIcons()

Update sort icons displayed on table headers

Methods

Parent

Helpers