Methods

addClass
callLaunchInstanceEvent
createStatusCell
displayExpandedTaskRow
hide
hideStartBtn
initInstanceList
isBound
isEnabled
isLabelVisible
isVisible
launchInstance
onActionMenuClosed
onColumnSorting
onResizeColumn
openFilter
paginationHandler
refreshInstanceList
reload
setAdvancedSearch
setEnabled
setFilterConditions
setLabelVisible
setQuickFilterConditions
setSearchTerm
setSelectedColumns
setViewData
setVisible
show
updateSortIcons

Parent

CoachView

Helpers

bpmext.log
bpmext.number
bpmext.text
bpmext.ui
bpmext.ui.View
bpmext.ui.util
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/replace CSS class(es) for this control
NameTypeDefaultDescription
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");
callLaunchInstanceEvent(data)
Calls the 'On instance launched' event
NameTypeDefaultDescription
data{Data}The instance data
createStatusCell(theView, cell)
Creates the status cell with the appropriate highlighting based on the current instance status.
NameTypeDefaultDescription
theView{View}The current view
cell{Cell}The table cell where the status information will be displayed.
displayExpandedTaskRow()
Sets the list of conditions to filter the instance list. If a search term is provided, it overrides any previously specified search conditions.
Inherited hide(collapseFlag)
Hide this view/control
NameTypeDefaultDescription
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.
NameTypeDefaultDescription
view{View}The view to initialize
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();
launchInstance(row)
Opens the instance details for the given row.
NameTypeDefaultDescription
row{Row}The table row that contains the instance record.
onActionMenuClosed(actionsMenuView, actionsMenuTargetElement)
Called when the actions menu is closed.
NameTypeDefaultDescription
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
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.
NameTypeDefaultDescription
data{Object}An object containing the input string, interaction filter, json query, and sort of the advanced search
Inherited setEnabled(enabled, required)
Enable/disable this view/control
NameTypeDefaultDescription
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
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.
NameTypeDefaultDescription
conditions{NameValuePair[]}The list of filter conditions.
Inherited setLabelVisible(visible)
Show/hide the label of this view/control
NameTypeDefaultDescription
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.
NameTypeDefaultDescription
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.
NameTypeDefaultDescription
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.
NameTypeDefaultDescription
columns{NameValuePair[]}The list of selected columns.
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
NameTypeDefaultDescription
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
NameTypeDefaultDescription
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();
updateSortIcons()
Update sort icons displayed on table headers