Views in the Workplace toolkit

Edit online

V21.0.2
The Workplace toolkit consists of a set of views that you can use to build your own custom applications and dashboards.

Each view 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 Workplace toolkit by themselves as stand-alone views, but typically you would use them in conjunction with views in the UI toolkit, such as Horizontal layout, Vertical layout, Collapsible panel, and Panel.

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 Workplace toolkit
View name	Description
Instance list	Adds an instance list widget to your dashboard, which lists all the workflow instances that you are authorized to see and participate in. You can sort, filter by app, and reload the instances in the list. For the methods and event handlers that are available for the view, see Instance list.
Instance viewer	Adds an instance viewer widget to your dashboard, which displays data that is relevant to the workflow instance. For the methods and event handlers that are available for the view, see Instance viewer.
Task list	Adds a task list widget to your dashboard, which lists all the tasks that you claimed or you've been assigned, as well as the unclaimed tasks that are assigned to your team. You can search, sort, filter by app, reload, and open the tasks in the list. For the methods and event handlers that are available for the view, see Task list.
Task viewer	Adds a task viewer widget to your dashboard, which displays data that is relevant to the task. For the methods and event handlers that are available for the view, see Task viewer.