CaseActivities

Case Activities

Displays the activities of the case.

General options

Case Identifier: The identifier of the case instance that is required by the view. String

Target Object Store Name: The name of the repository that the view connects to. String

Edit title: Customize the title of the view. Do not set the Hide title configuration option to view the custom title. String

Hide title: Hide the title that is set either by default or in Edit title. Boolean

Get Repository Name Service: The service to retrieve the repository name that is associated with the case instance. Typically used in the process activity user task, which may contain case toolkit views, to automatically fetch the repository name without requiring the user to set it manually. String

Initial Page Size: The default number of items that can be configured to display items of type List. Default: 10. Integer

Show Footer: Show or hide the table footer pagination bar. Boolean

Hide Add Activity Button: Hide the Add Activity button. Boolean

Events

Filter Add Activities:

Description:

Triggered to filter and customize discretionary activities for the current case.

Context Variables	addActivitiesList {array}
Properties	activityID - Activity ID
	activityDisplayName - Default display name of the activity
	state - Activity state (YES, NO, LOCK)*

*state values:

YES (default) - Include in the add activity list.
NO - Do not include in the add activity list.
LOCK - Include in the add activity list, but the activity display name is not customizable.

Returns:

The addActivitiesList with customizable objects for discretionary activities.

Filter Activities List:

Description:

Triggered to filter and customize activities for the current case.

Context Variables	activitiesList {array}
Properties	activityID - ID of the activity
Properties	state - state of the activity (YES, NO)*

*state values:

YES - Include in the activity list (default).
NO - Do not include in the activity list.

Returns:

The activitiesList with customizable objects for activities. Each object is defined by activityID and state (YES, NO).

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

closeDiscModal()

Closes the discretionary activity dialog.

closeErrorModal()

Closes the error dialog on icon click.

closeModal()

Closes the modal dialog.

getCaseActivitesInfo()

Gets case activities information for the current instance.

Inherited getData() Returns: {Object}

Retrieve the bound data associated with the view. It applies only to views with bound data.

Example

var dec1 = MyDecimal.getData();

getDiscretionaryActivityInfo()

Gets launchable discretionary activities for the current case.

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 isValid() Returns: {boolean}

Return the valid status as last set by the setValid() method.

Example

var valid = MyView.isValid();

Inherited isVisible() Returns: {boolean}

Check whether the view is visible.

Example

var visible = MyView.isVisible();

onDiscActivitySelectChange()

Updates the activity text when the selection of the discretionary activity changes.

openDiscretionaryActivitiesModal()

Opens the discretionary activities dialog list.

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

Inherited recalculate()

Applicable only to formula-enabled views!
Triggers the re-evaluation of the formula
for the view, if a formula was specified. If the view is not formula-enabled, recalculate() does nothing.

Example

Text1.recalculate();
//If the formula for Text1 is: new Date().toString(), Text1 is updated to the current date/time

refresh()

Refreshes the activities list.

reload()

Reloads the instance activities.

reloadDiscertionaryActivitiesList()

Reloads the instance activities

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 conditions that the list of tasks is filtered on. If a search term is provided, it overrides any previously specified search conditions.

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

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 task list.

Inherited setValid(valid, errorText)

Flag the view as valid or invalid.

Name Type Default Description

valid {boolean} Valid/invalid flag (true to set view valid, false to make it invalid - which typically shows the view with "invalid" styling and indicator)

errorText {string} Validation error text to show on the invalid-styled view

Example

MyView.setValid(false, "Fix your data entry"); //Make MyView invalid

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

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

Methods

Parent

Helpers