Case List widget

Edit online
Draft comment:
This topic is shared by BAW, CP4BA. Last updated on 2025-03-13 12:15
You use the Case List widget to display the cases that are returned by a search. Case workers can select a case to view from the list.
The Case List widget displays the results of a search based on the criteria that the case worker entered in the Search widget. The properties that are returned from a search are those properties that were selected for display in the Case Summary view for the case type. These properties which might include:
  • The case identifier, which provides a link that the case worker can click to open the case
  • The ID of the case worker who last modified the case
  • The date that the case was last modified
  • The case type
  • The case status
  • The case stage
You can edit the settings for the Case List widget to:
  • Specify the default view for the list and whether case workers can switch between views.
  • Show the case health for each case in the list.
  • Add a toolbar to the widget.
  • Configure the pop-up menu for the widget.

IBM Business Automation Workflow pages that include this widget by default

The Case List widget is included on the Cases page. By default, the pop-up menu for the widget on this page includes the following actions:
  • Add Comment to Case
  • Create Package
  • Open Case
  • Send Link to Case
  • Show Link to Case
Restriction: The Create Package action is included by default only for solutions that are created with version 5.2.1 Fix Pack 4 or later.

Customized Content Platform Engine SQL queries

The Case List widget search payload supports customized Content Platform Engine SQL queries.

For example, you can construct the following Content Platform Engine query to search all cases that were created by admin users (user names that include "admin"):

"SELECT [this], t.[FolderName], t.[LastModifier], t.[DateLastModified], t.[CmAcmCaseTypeFolder], t.[CmAcmCaseState], t.[CmAcmCaseIdentifier], t.[DateCreated], t.[Creator], t.[Id], t.[ClassDescription] FROM [CmAcmCaseFolder] t WHERE (((t.[creator] LIKE '%admin%' AND t.[CmAcmParentSolution] = Object({CF0CFF8C-CD8C-41D3-AC0A-1272E4F73991}) AND t.[CmAcmCaseState] > 0))) ORDER BY t.[CmAcmCaseIdentifier]";

Custom Content Engine SQL queries must meet the following requirements:

  • The SELECT statement must include the following properties: "FolderName", "LastModifier", "DateLastModified", "CmAcmCaseTypeFolder", "CmAcmCaseState", "CmAcmCaseIdentifier", "DateCreated", "Creator", "Id", "ContainerType", "LockToken", "LockTimeout", "ClassDescription",
  • The query must search against a Case class, either the CmAcmCaseFolder class or its subclass.

To create the search payload object, you can use the icm.util.SearchPayload utility class as shown in the following sample code:

//////////////////////////////////////////////////////////// 
// This is running in a script adapter widget 
var solution = this.getSolution(); 
var repositoryId = solution.getTargetOS().id; 
var solutionGUID = solution.solutionFolderId; 
console.log("solutionFolderId is:" + solutionGUID); 
var caseTypeName =""; 
var ceQuery = "SELECT t.[FolderName], t.[LastModifier], 
  t.[DateLastModified], t.[CmAcmCaseTypeFolder], 
  t.[CmAcmCaseState], t.[CmAcmCaseIdentifier], t.[DateCreated], 
  t.[Creator], t.[Id], t.[ClassDescription] FROM [CmAcmCaseFolder] 
  t WHERE (((t.[creator] LIKE '%admin%' AND t.[CmAcmParentSolution] 
  = Object(" + solutionGUID + ") AND t.[CmAcmCaseState] > 0))) ORDER 
  BY t.[CmAcmCaseIdentifier]"; 
console.log("ceQuery is:" + ceQuery); 

var params = {}; 
params.ObjectStore = repositoryId; 
params.ceQuery = ceQuery; 
params.CaseType = caseTypeName; 
params.solution = solution; 

var p = new icm.util.SearchPayload(); 
p.setModel(params); 
var payload = p.getSearchPayload(); 
console.log("Payload is: -----"); 
console.dir(payload); 

return payload; 
////////////////////////////////////////////////////////////
Restriction: Content Platform Engine queries that use the ceQuery parameter return one page of results only. The limitation is due to the default page size that is set by IBM® Content Navigator (200 rows). For example, if an SQL query matches 500 rows in the Content Platform Engine server, the ceQuery service will return only 200 rows of items.