Case List

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.

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 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 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 and synchronized with the main search view.

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`

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.	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: Consider leaving a single column width undefined so that the browser can calculate any remaining space and assign it to the column whose width is not specified.	String

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
};
```

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