Methods

activitySelectorConditionChanged
addClass
addCommentClicked
beforeViewInstance
cancelComment
closeButtonHandler
closeInstance
createDocumentCell
delayReload
followInstance
getInstance
hide
initializeView
isBound
isEnabled
isLabelVisible
isVisible
launchTask
loadActivityCommentCard
loadActivityDetail
loadCommentCard
loadDataCard
loadDocumentCard
loadStartableActivityCard
modifyInstance
onActionMenuClosed
onActionMenuOpen
onTabChange
openInstanceActionMenu
openWorkstreamErrorDetailModal
postComment
propagateUpValueChange
reloadInstance
setEnabled
setInstance
setLabelVisible
setViewData
setVisible
show
showDefaultActivityDetail
startableAdhocActivity
taskListNotificationsHandler
triggerFormulaUpdates
unFollowInstance

Parent

CoachView

Helpers

bpmext.log
bpmext.number
bpmext.text
bpmext.ui
bpmext.ui.View
bpmext.ui.util
Instance Viewer
Adds an instance viewer widget to your dashboard, which displays workflow instance details such as data that is relevant to the instance.
Appearance
Instance: Instance Data ANY
Behavior
Optimize for processes: Optimize the view to display process information Boolean
Show the breadcrumb trail: Show the navigation path to the current page in the task viewer. Boolean
Disable task claiming: Do not show the Claim task modal. The task is automatically claimed upon opening. Boolean
Embeded View: Hides the close button for embedding in another view. Boolean
Performance
Set responsive mode: Select the screen size for viewing the task list.
{large | medium | small}		 ResponsiveMode
Events
On Load:
Description: This event is fired when the view is loaded.
Example: 
console.log("View loaded")
On instance UI launched:
Description: This event is fired when an instance is launched
On instance closed:
Description: This event is fired when an instance is closed
On instance action:
Description: This event is fired when an action is triggered from the action menu (for example, modify, terminate, suspend)
On instance tab change:
Description: This event is fired when the user changes the instance tab
Context Variables oldTabIndex {Number}
Properties previous tab index
Context Variables tabIndex {Number}
Properties current tab index
On instance comment post:
Description: This event is fired when a comment is posted in the Overview setion
Context Variables data {object}
Properties comment data
On instance activity selected:
Description: This event is fired when an activity is selected from the Activities section
Context Variables activity {object}
Properties activity data
Extends:
com.ibm.bpm.coach.CoachView
Methods:
activitySelectorConditionChanged(event)
Change the filter condition.
NameTypeDefaultDescription
event{view}The single select activity state view
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");
addCommentClicked(event)
Add comment handler.
NameTypeDefaultDescription
event{view}Instance UI view
beforeViewInstance(eventName, eventData)
Call the event before the instance is shown, and extract target instance information (piid & systemID).
NameTypeDefaultDescription
eventName{String}The event name
eventData{Object}A new workstream object binding
cancelComment(event)
Cancel comment handler.
NameTypeDefaultDescription
event{view}Instance UI view
closeButtonHandler(event)
Close the button handler.
NameTypeDefaultDescription
event{view}The close button view
closeInstance()
Close the instance UI.
createDocumentCell(theView, cell)
Format Document tab listing values custom formatting for column
NameTypeDefaultDescription
theView{View}The current view
cell{Cell}The table cell where the status information will be displayed.
delayReload()
Event called to handle back up reloading when the notification fails.
followInstance()
Follow the instance.
getInstance()
Get the instance data.
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();
initializeView(event)
Initialize the view.
NameTypeDefaultDescription
event{view}Instance UI view
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();
launchTask(task)
Launch the instance for the given row.
NameTypeDefaultDescription
task{Task}The table row that contains the instance record.
loadActivityCommentCard(target)
Loads a comment card for a specific activity.
NameTypeDefaultDescription
target{view}The comment card wrapper view
loadActivityDetail(view, target)
Loads the activity document, data, and comments into the side panel.
NameTypeDefaultDescription
view{view}All the activity card views
target{view}A single activity card view
loadCommentCard(target, isForActivity)
Load a comment card.
NameTypeDefaultDescription
target{view}The comment card wrapper view
isForActivity{boolean}Returns true if it is a Workstream activity and not an instance-level activity
loadDataCard(target)
Load a data card.
NameTypeDefaultDescription
target{view}The data card wrapper view
loadDocumentCard(target)
Loads a document card.
NameTypeDefaultDescription
target{view}The document card wrapper view
loadStartableActivityCard(target)
Load a startable activity card.
NameTypeDefaultDescription
target{view}The activity startable card wrapper view
modifyInstance(event)
Modifies the Instance UI.
NameTypeDefaultDescription
event{string}The event name
onActionMenuClosed(actionsMenuView, actionsMenuTargetElement)
Close the actions menu.
NameTypeDefaultDescription
actionsMenuView{View}The actions menu view
actionsMenuTargetElement{Element}In the instance list, the button you click to invoke the menu.
onActionMenuOpen(actionsMenuView, actionsMenuTargetElement)
Open the actions menu.
NameTypeDefaultDescription
actionsMenuView{View}The actions menu view
actionsMenuTargetElement{Element}In the instance list, the button you click to invoke the menu.
onTabChange(event, oldTabIndex, tabIndex)
On Tab Change.
NameTypeDefaultDescription
event{view}Instance UI view
oldTabIndex{Number}previous tab index
tabIndex{Number}current tab index
openInstanceActionMenu(event)
Modify the Instance UI.
NameTypeDefaultDescription
event{view}The instance action menu button view
openWorkstreamErrorDetailModal()
Open the workstream error details modal.
postComment(event)
Post the current comment to the instance.
NameTypeDefaultDescription
event{view}Instance UI view
Inherited propagateUpValueChange(event) Returns: {boolean}
Propagates value change of control up through parent views
NameTypeDefaultDescription
event{Event}Value change event (usually an onchange event)
Example
MyView.propagateUp(event);
reloadInstance(event)
Close the instance UI.
NameTypeDefaultDescription
event{view}The reload instance button view
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
setInstance(instance)
Set the instance data.
NameTypeDefaultDescription
instance{Object}The instance data
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);
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();
showDefaultActivityDetail()
Load the default document, data, and comments into the side panel.
startableAdhocActivity(target)
Start an adhoc activity.
NameTypeDefaultDescription
target{view}The activity startable icon view
taskListNotificationsHandler(eventName, eventData)
Call the event to handle the task updates.
NameTypeDefaultDescription
eventName{String}The event name
eventData{Object}A new workstream object binding
Inherited triggerFormulaUpdates([phase])
Broadcasts the expression trigger for the specified view
NameTypeDefaultDescription
phase{int}bpmext.ui.PHASE_NORMALThe phase we are currently in
Example
MyView.triggerFormulaUpdates();
unFollowInstance()
Unfollows the instance.