Case List

Edit online
Use the Case List view to display a list of cases. When used along with the Case Search view, the Case List view lists the case results that are returned from the case searches.

Customize your Case List view

You can tailor the case list to display the information you need by applying filters, sorting columns, and selecting which data fields to show.

To customize your views Customize view icon, you can scope your search, and build and combine filters that refine your search results.

You can name and save your customized searches for reuse. These saved searches are scoped according to their appropriate solution.

 25.0.1.0 
Note: To save customized searches, you must enable the indexing of case data in the federated data repository.
Select the filters to use

A default filter narrows down the search based on the state of your case instances. You can refine the results further by adding more basic field operator value filters until you obtain the results that you want. The fields that you include in the filters can be system data, business data, or both.

Select the column to sort by
You can select the field by which to sort the information and also specify the sorting order.
Select the columns to show

Select columns from business or system data to be displayed in the Case List.

  • Visible columns

    Shows the columns that are displayed in the Case List.

  • Business data

    Lists the properties that are used for case search, as described in Defining case type views. You can select which of these properties to display in the Case List.

  • System data

    Displays system-generated fields such as status or timestamps. You can choose which ones to include in the view

The applied filters are clearly indicated.

Expandable rows

The rows of the case list can now be expanded to show the standard summary of that particular case associated with each row.

The content that is shown when the rows are expanded can also be customized. The standard summary can be disabled with the disable standard summary config option. Upon disabling the standard summary, a drop zone is provided where any views can be dropped to customize the content.

The on expandable row loaded event fires when an expandable row with custom content is loaded. For more information, see Events.

 25.0.1.0 
 Static saved searches

In addition to the saved searches created from the Search filter dialog, static saved searches can be created through a script added to the onLoad event handler of the Case List view. For more details on the onLoad event handler, see Case List JavaScript API.

The script can be extended to define custom static saved searches based on user requirements. When the Case List view loads, it initially displays the first static saved search by default. You can switch between saved searches by using the Search filter dialog.

Note: Static saved searches that are created by using the onLoad script are different from the searches that are created through the Search filter dialog:
  • They are only available in the specific Case List view where they are defined.
  • You cannot edit or delete them.
  • To make changes, you must save a new search instead of updating the existing one.

Configuration properties

Set or modify the configuration properties for the view in the Configuration properties tab.
Table 1. Configuration properties for the Case List view
Property Description Data type
Target object store name

The name of the repository to which the view needs to connect.

 String
Solution prefix

The prefix of the case solution.

 String
Is Case Client

An option that indicates whether the view is used in the context of Case Client or Workplace. When the option is selected, the context is Case Client.

 Boolean
Initial page size

Initial maximum number of case entries to be shown per page.

 Integer
Get repository name service

The service that retrieves the name of the repository that is associated to the case instance. Typically, it is used in the process activity user task to automatically fetch the repository name.

 String
Custom actions

Provides the identifier, label, and icon for each custom action that is shown when the user clicks the overflow menu in the table row. Add the JavaScript code that performs the action to the On custom action click event.

The following custom actions for cases are available by default in the case list for a default client-side human service and a solution layout that is created from the cases template:
  • viewCaseId: View the case details.
  • showLinkId: Show the case link.
  • sendLinkId: Send the case as a link in the email client.
  • caseCommentId: View and add case comments.
  • createPackageId: Create a case package.
More custom action IDs that are available to use include:
  • completeCurrentStageId: Complete the current stage of a case.
  • restartPreviousStageId: Restart the previous stage of a case.
Keep in mind the following points:
  • When you add the custom action, the Id is required.
  • Default labels are available for the default actions. You can overwrite the default labels with your own custom labels.
  • Case title link is the first action in the custom actions.
  • If no custom actions are defined, View is the default action, which you can use to view the case details.
For execution logic that can be added to the On custom action click event for the custom actions, see Events.
 Table
Hide State Column To hide the State column. Boolean
Hide Modified By Column To hide Modified By column. Boolean
Hide Modified On Column To hide Modified On column. Boolean
Hide Type Column To hide the Type column. Boolean
Hide search filter To hide the search filter icon. Boolean
Disable expandable rows Disables the rows of the case list from expanding. Boolean
Disable standard summary Disables the standard summary that is displayed when a row is expanded. Boolean
 25.0.1.0 
Disable default search loading		 Disables the automatic loading of the first saved search defined in the on-load script. Boolean
Table 2. Columns
Property Description Data type
Property Symbolic name of a case instance property. Case Business Object is not supported. String
Label Label of the column that renders as a table column header at run time.
Note: If no label is specified, the display name of the case property is rendered as a table column header at run time.
 String
Render as Denotes the format in which the cell contents are to be rendered. Possible values:
  • Simple HTML
  • Custom
 String
Visibility The visibility of the column. Possible values:
  • Visible
  • Read-Only
  • None
 String
Sortable Select the checkbox to allow the data in the column to be sorted. String
Options Options to format the data in the column, depending on the data type.

Date Picker

For example, if the required format is Monday 08 Jun, 2015, enter: "datePattern":"EEEE dd MMM, yyyy"

These options work only if the column is rendered as HTML or Custom. For custom rendering, in the On custom cell event, use the cell.getFormattedValue() function to get a value with the applied formatting.

 String
CSS The CSS styling to be applied to the column. You can use CSS style (For example - color:#00ff00) or CSS classes. If a colon is included in this field, the table control assumes the CSS style. Otherwise, it assumes that one or more CSS class names are specified. String
Width Width of column in px, em, or %. If no unit is specified, the value is assumed in px.
Note: Define widths for all required columns except one, allowing the browser to automatically allocate the remaining space to the column without a specified width.
 String

Methods

For the methods that are available in the Case List view, see Case List JavaScript API.

Additional resources
For more information about how to create a coach or page, see Building coaches.
For more information about standard properties (General, Configuration, Positioning, Visibility, and HTML Attributes), see View properties. For other UI views, see UI toolkit.

Events

Set or modify the event handlers for the view in the Events properties. You can set events to be triggered programmatically or when a user interacts with the view. For information about how to define and code events, see User-defined events.

Case List has the following event handler:
  • On custom action click

    Activated when the user clicks the overflow menu that displays the custom actions. See Custom actions.

    • When default actions are used, the me.handleStandardActions(data); method must be used for execution logic in the On custom action click event.
    • To add a custom action, such as customID, customLabel, customIcon, you can add business execution logic as follows:
      me.handleStandardActions(data);
if(data.menuId === "customId"){
    // custom action logic
};
  • On expandable row loaded

    This event fires when an expandable row with custom content loads (when the disable standard summary config is enabled).

    • The data that is associated with a particular row is available as row.data.
    • The data of the views added to the drop zone is available as row.views.
    For example, if a case toolkit view like Case Stages is added to the drop zone of the expanded row, the following script can be added to the event handler:
    var caseId = row.data.Id;
var tosName = row.data.ObjectStoreDisplayName;
var stagesView = row.views[0];
stagesView._instance.tosName = tosName;
if(stagesView.setCaseId != null) {
    stagesView.setCaseId(caseId);
}