Case toolkit

Edit online

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.

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.

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.

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. Depending on the specific event, you can use JavaScript logic to modify the effects of the view. For event handler information that is specific to each view, see the corresponding JavaScript API documentation. For more information, see User-defined events.

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

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.