Case List

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

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 menus

Provides the identifier, label, and icon for each custom menu 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 click of custom menu event.

The following custom menus actions for cases are available by default in the case list for a default client-side human service and a solution layout 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.
Additional custom menu 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 menus 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 click of custom menu event for the custom actions, see Events.
Table

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 click of custom menu: Activated when the user clicks the overflow menu that displays the custom menu actions. See Custom menus.
    • When default actions are used, the me.handleStandardActions(data); method must be used for execution logic in the On click of custom menu event.
    • To add a custom action, such as customID, customLabel, customIcon, business execution logic can be added as shown:
      if(data.menuId === "customId"){
      // custom action logic
      }
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.