CaseList

Case List

Displays a list of cases. When used with the Case Search view, lists the case results that are returned from the case searches.

General options

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

Solution Prefix: The prefix of the case solution. String

Role id: The role identifier. String

Is Case Client: Indicate whether the view is used in the context of Case Client or Workplace. When you set this option, the context is Case Client. Boolean

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

Hide State Column: Hide the State column. Boolean

Hide Modified By Column: Hide the Modified By column. Boolean

Hide Modified On Column: Hide the Modified On column. Boolean

Hide Type Column: Hide the Type column. Boolean

Hide search filter: Hides the search filter. Boolean

Disable default search loading: Disable the preloading of the first saved search defined in the On Load script. 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

Show 'My Cases' as saved view: Display My Cases as a saved view option. Boolean

Custom actions: Provide the identifier, label, and icon for showing custom actions when the overflow menu on the table row is clicked. The JavaScript code to perform the action should be added to the On custom action click event. CustomMenus[]

Columns: Specifications of the columns (Property, Render As, Sortable, Options, CSS, Width, Label) CaseListTableColumn[]

Expandable rows

Disable expandable rows: Disable the expanding of rows. Boolean

Disable standard summary: Disables the standard summary displayed when a row is expanded. Boolean

Events

On Load:

Description: This event is triggered when the view is loaded. Define static saved searches here. These static saved searches are not stored in the federated data repository. You can define as many static saved searches as needed. The first saved search in the list as seen in the filter UI is executed and the results from that search are automatically loaded when the view opens. You can disable this behavior by enabling the Disable default search loading configuration option.

Example:

The following sample script defines a saved search as a JSON object within the savedSearches array. You can add more saved search objects to the same array using a similar structure.

//Pass the data to view.addStaticSavedSearches(savedSearches) to add static saved searches
 //savedSearches - Array of static saved search definitions. which are loaded only for this view instance.
 var savedSearches = [
 {
 	"display": "Active cases",
 	"conditions": [
 		{
             	"field": "CmAcmCaseState",
             	"operator" : "EQUAL",
             	"value": "2"
       	}
 	],
 	"fields": [
       	"CmAcmCaseIdentifier",
         	"CmAcmCaseState",
         	"LastModifier",
         	"DateLastModified",
         	"CaseTypeDisplayName"
     	],
 	"sort" : 
 	{
 		"field": "CmAcmCaseIdentifier",
 		"order": "ASC"
 	}	
 }
 ];
 this.addStaticSavedSearches(savedSearches);

On custom action click:

Description:

Enables the ability to add custom logic for executing the action that represents the action click. The passed-in data contains the menuId defined in the custom actions configuration option and the selected case instance metadata information. Additional parameter passed: data.

On custom cell:

Description:

Fires when a cell with custom rendering options (set in columns) loads.\r\nEvent param\: \r\ncell \: {controlType, varName, colIndex, parentNode, row\: {data, index}}

On expandable row loaded:

Description:

Fires when expandable row loads.

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

addStaticSavedSearches(savedSearches)

Adds static saved searches to be displayed.

Name Type Default Description

savedSearches {Object} Array of static saved search definitions.

handleStandardActions(data)

Handles default actions with menu IDs: viewCaseId, showLinkId, sendLinkId, caseCommentId, createPackageId, completeCurrentStageId, restartPreviousStageId.

Name Type Default Description

data {Object} Data containing menuId and row 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();

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

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

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

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