Case toolkit

Edit online

V20.0.0.2
The Case toolkit includes a set of views and services for integrating cases and processes. The toolkit also provides a default Add Case, Split Case and Case Details layouts, which present a set of views in a predefined format. The Case toolkit is automatically added as a dependency into a new case solution. For existing case solutions, it is added as a dependency when the default client-side human service views are created.

Each view in the toolkit points to a specific set of files:

A JavaScript file that provides the behavior of the view.
Image files to represent the view on the palette and on the canvas.
A preview JavaScript file that shows a preliminary image of the view.

The view can also have other files such as CSS and LESS files for styling, localization files and other view-specific resource files, but these additional files are optional.

Tip: You can use the views in the Case toolkit by themselves as stand-alone views, but typically you would use them with other views in the UI toolkit, such as Horizontal layout, Vertical layout, Collapsible panel, and Panel.

V21.0.2 Adding case views to case orchestrated process task pages

The case views such as Case Summary, Case Stages, Case Comments, Case Folder, Case Activities, Case History or Case Folder Tree View from the Case Toolkit can be added to case orchestrated process user task pages.

When these case views are used in the context of the process user task page, the views configure themselves automatically based on the parent case, without the need to specify the Case identifier and Target Object Store name in the view’s configuration. Also, on these pages, the Case Content objects under caseProperties variable can be used without need of Case Properties view. This is due to the process instance itself acting as the controller and passing in the case instance content object as referential input variable. The case data is managed along with the other process variables and synchronized with the case instance automatically.

If these case views are added to other client-side human service pages that are not directly associated with a parent case, you can directly specify a Case identifier and Target Object Store name in the optional configuration.

Configuring Case views in custom case client-side human service

If any Case views are added to any custom case client-side human service, which are created through Case Type > Views > Case Layouts, the view's Case identifier and Target Object Store name configuration must be mapped to the input variables (caseId and tosName). In case of the Case Properties view, the binding to the view must be set to the caseProperties private variable. These settings are configured for the case views on any case client-side human service pages that are created from the default case pages by using Case Type > Views > Case Layouts > Add Layout > Case Page Layout.

Case Properties view configuration

The Case Properties view performs several functions. When running on the default case client-side human service pages, the view displays a list of the case properties in the order that is specified in Case Builder and acts as a controller to load and save the property values from the case being displayed.

When you create a custom case client-side human service page such as Add Case, Case Details or Split Case, which is created through Case Type > Views > Case Layouts, the Case Properties view is required to act as the controller to load and save the property values.

When a new custom case client-side human service is created, the Case Properties view no longer generates the default list of case properties. You must add the case properties that you want by dragging them anywhere on the page by selecting the properties by using the following steps: from the Component palette > Variable > select the caseProperties content object or any of its members. The Case Properties view provides a drop zone to help position the dragged properties in a layout similar to the auto-generated one.

At run time, any changes that are done to the case properties enable the Save button within the Case Properties view. If you drag the case properties to anywhere on the page (not in Case Properties view), any changes that are done to the properties must be saved by clicking the Save button, which gets enabled on the Case Properties view.

V21.0.2 Customizing View titles: All the views have their titles that are hidden by default. You can enter title by deselecting the Hide title check-box and enter your choice of a new title in Edit title entry box.

Configuration properties

Under Configuration, set or modify configuration properties for the view, such as appearance, behavior, and performance properties.

Screen size: A configuration property that has the Screen Sizes icon beside the property name can have different values for each screen size. If you do not set a value, the screen size inherits the value of the next larger screen size as its default value. If you are using the Process Designer desktop editor (deprecated), you are setting the value for the large screen size. The other screen sizes inherit this value.

Theme definitions: Theme definitions specify the colors and styles for a view and determine its appearance. You can preview the look and feel of views in the theme editor. See Themes.

For specific configuration properties for each view, see the corresponding JavaScript API documentation.

Events: Set or modify the event handlers of a view in the Events properties. You can set events to be triggered programmatically or when a user interface interacts with the view. For information about how to define and code events, see User-defined events.; For event handler information that is specific to each view, see the corresponding JavaScript API documentation. Depending on the specific event, you can use JavaScript logic to modify the effects of the view. More information on using events with views is found in the topic User-defined events.

Methods: For the methods that are available for each view, see the corresponding JavaScript API documentation.

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

Table 1. Views in the Case toolkit
View name	Description
Case History view	Displays case events as a history view. See Case History view .
Case Activities view	Displays case activities. The following conditions apply: You can start, enable, and disable case activities. However, you cannot edit or copy custom activities. You can add new discretionary activities in Workplace for IBM® Business Automation Workflow process activities. You can view an associated process instance for an activity by clicking the view instance from the menu. The View Instance action only applies to IBM Business Automation Workflow process activities. See Case Activities view.
Case Properties view	Displays case properties and provides the capability to persist changes to properties. See Case Properties view.
Case Comments view	Displays case comments. See Case Comments view.
Case Stages view	Displays case stage information. See Case Stages view.
Case Header Layout	Displays the Case ID, Date Created, and Case Type properties a toolbar (Case Client) or banner (Workplace).
Default Case Layout Templates	Provides default layouts for the Case Details and Add Case pages. These templates are the base for the corresponding client-side human services.
Case Folder view	Displays documents and folders pertaining to the case instance in the Target object store. See Case Folder view.
V21.0.2 Case Folder Tree view	Displays the case folders, subfolders, and case documents in a tree view. It is a part of the default view for selection of documents in Split case client-side human service. See Case Folder Tree view.
V21.0.3 Case Calendar view	Case calendar keeps track of events of particular case. See Case Calendar view.