InstanceUI

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:

Methods:

activitySelectorConditionChanged(event)

Change the filter condition.

Name Type Default Description

event {view} The single select activity state view

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

addCommentClicked(event)

Add comment handler.

Name Type Default Description

event {view} Instance UI view

beforeViewInstance(eventName, eventData)

Call the event before the instance is shown, and extract target instance information (piid & systemID).

Name Type Default Description

eventName {String} The event name

eventData {Object} A new workstream object binding

cancelComment(event)

Cancel comment handler.

Name Type Default Description

event {view} Instance UI view

closeButtonHandler(event)

Close the button handler.

Name Type Default Description

event {view} The close button view

closeInstance()

Close the instance UI.

createDocumentCell(theView, cell)

Format Document tab listing values custom formatting for column

Name Type Default Description

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

initializeView(event)

Initialize the view.

Name Type Default Description

event {view} Instance UI view

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

launchTask(task)

Launch the instance for the given row.

Name Type Default Description

task {Task} The table row that contains the instance record.

loadActivityCommentCard(target)

Loads a comment card for a specific activity.

Name Type Default Description

target {view} The comment card wrapper view

loadActivityDetail(view, target)

Loads the activity document, data, and comments into the side panel.

Name Type Default Description

view {view} All the activity card views

target {view} A single activity card view

loadCommentCard(target, isForActivity)

Load a comment card.

Name Type Default Description

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.

Name Type Default Description

target {view} The data card wrapper view

loadDocumentCard(target)

Loads a document card.

Name Type Default Description

target {view} The document card wrapper view

loadStartableActivityCard(target)

Load a startable activity card.

Name Type Default Description

target {view} The activity startable card wrapper view

modifyInstance(event)

Modifies the Instance UI.

Name Type Default Description

event {string} The event name

onActionMenuClosed(actionsMenuView, actionsMenuTargetElement)

Close the actions menu.

Name Type Default Description

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.

Name Type Default Description

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.

Name Type Default Description

event {view} Instance UI view

oldTabIndex {Number} previous tab index

tabIndex {Number} current tab index

openInstanceActionMenu(event)

Modify the Instance UI.

Name Type Default Description

event {view} The instance action menu button view

openWorkstreamErrorDetailModal()

Open the workstream error details modal.

postComment(event)

Post the current comment to the instance.

Name Type Default Description

event {view} Instance UI view

Inherited propagateUpValueChange(event) Returns: {boolean}

Propagate the value change of the view up through the parent views.

Name Type Default Description

event {Event} Value change event (usually an onchange event)

Example

MyView.propagateUp(event);

reloadInstance(event)

Close the instance UI.

Name Type Default Description

event {view} The reload instance button view

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

setInstance(instance)

Set the instance data.

Name Type Default Description

instance {Object} The instance data

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

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

showDefaultActivityDetail()

Load the default document, data, and comments into the side panel.

startableAdhocActivity(target)

Start an adhoc activity.

Name Type Default Description

target {view} The activity startable icon view

taskListNotificationsHandler(eventName, eventData)

Call the event to handle the task updates.

Name Type Default Description

eventName {String} The event name

eventData {Object} A new workstream object binding

Inherited triggerFormulaUpdates([phase])

Broadcast the expression trigger for the specified view.

Name Type Default Description

phase {int} bpmext.ui.PHASE_NORMAL The phase we are currently in

Example

MyView.triggerFormulaUpdates();

unFollowInstance()

Unfollows the instance.

Methods

Parent

Helpers