Often it is desired to get a quick overview of the business performance by monitoring the underlying processes. To achieve that, you can define Reports in Camunda Optimize according to KPIs (Key Performance Indicators) relevant to your business objectives. A Dashboard shows multiple Reports so you can get an up-to-date view of the productivity of your system at one glance.
To create a new Dashboard, click the “Create New” button on the Homepage or Collection page and select the “New Dashboard” option. This opens a dialog where you can set the Dashboard name and select one of multiple Dashboard templates. When not creating a blank Dashboard, you need to also select a process definition. This process definition is used to create new Reports for the Dashboard.
Creating a Dashboard from a template also creates new Reports which are saved as soon as the Dashboard itself is saved.
The edit mode allows you to configure the Dashboard and adjust it to your needs, including the following operations:
- rename your Dashboard
- add/remove a Report
- save the current state with your applied changes
- cancel changes you already applied to the Dashboard
- set filters that are available on the Dashboard
Once you have prepared all your reports, you can now start to assemble them into a Dashboard. Above the Dashboard grid there is an
Add a report button. Clicking on it opens a modal where you can select one of your defined Reports and add it to the Dashboard:
Please note that if the Dashboard is inside a Collection, only Reports that are in the same Collection can be added. If the Dashboard is not in a Collection, it can only contain Reports that are also not in a Collection.
In the Add Report modal, you can click on the “Add External Source” link to enter the URL of an external data source which should be added to the Dashboard. This allows you to create Dashboards that combine Optimize Reports with data from other services. Such external Reports are added as iframes to the Dashboard.
To move the Report to your desired place, you can simply drag it in any direction. As soon as you release the dragged Report, it snaps to the closest grid position. Dragging the handle on the lower right corner of each Report will resize it. Finally, you can delete the Report from your Dashboard by clicking on the
x button on the upper right corner of each Report.
Specifying Available Dashboard Filters
In the Dashboard edit mode, there is an “Add a Filter” button. Clicking that button shows a Filters panel that allows specifying Filters which will become available in the Dashboard view mode. Adding a Filter in the edit mode only makes it available in the view mode; the filter is not applied in the edit mode itself. The following filters are available:
- Start Date: Allows filtering by process instance start date
- End Date: Allows filtering by process instance end date
- Instance State: Allows filtering by process instance state, such as running, completed, or canceled
- Variable: Allows filtering by process instance variable value
- Assignee: Allows filtering Flow Node data by their assignee
- Candidate Group: Allows filtering Flow Node data by their candidate group
For Variable Filters, you need to specify which variable the Filter should apply to. For String and Number variables, you also need to provide a list of values which should be allowed to be filtered by. Additionally, it is possible to allow dashboard viewers to filter by their own values by checking the “Allow viewer to add filter values” box. In contrast to Report Filters, adding a value in the modal will not immediately filter by this value, it will only make this value available to filter by in the Dashboard view mode.
For Assignee and Candidate Group filters, the dashboard editor can specify which assignees and candidate groups are available for dashboard viewers to filter by. In contrast to report filters, adding an assignee or candidate group to the filter will not immediately filter by this value, it will only make this value available to filter by in the dashboard view mode. Additionally, it is possible to allow dashboard viewers to filter by their own values by checking the “Allow viewer to add filter values” box.
The list of variable names, variable values, assignees and candidate groups is compiled from all Reports that are on the Dashboard.
Once you have defined what your Dashboard should look like, the view mode provides you with all the features to monitor you process, such as:
- fullscreen: display the Dashboard in fullscreen and only see the essential information of your Dashboard - the Reports - and hide the header, control panel and footer. While in fullscreen mode, you can click on the Toggle Theme button to switch between the default light theme and a dark theme.
- auto-refresh: this feature periodically updates the Dashboard with the latest data. You can decide how often the update should be performed by setting a time span reaching from 1 to 60 minutes. An animation indicates when the next update is occurring. If you do not wish to use that feature anymore, you can disable it anytime. Note: when refreshing the Dashboard page manually or switching to another page in between, the auto-refresh must be enabled again.
In case you want to share the Dashboard with other people or want to embed it in a webpage, you can use the sharing feature of the Dashboard. Just click on the share button, which opens up a popover. After turning the “enable sharing” switch on, a link is generated which you can send to people who do not have access to Camunda Optimize and thus enable them to see the Dashboard. If you applied filters on the Dashboard, you can include them in the shared version of the Dashboard by enabling the “Share with current filters applied” checkbox.
You can also click the “Embed Link” button to copy a code to paste into your webpage. Everyone that views the webpage can then see content of the Dashboard. The shared versions of the Dashboard allow only to view the Dashboard itself. There is no possibility to alter it or interact with any other features of Optimize. You can revoke the sharing anytime by disabling the share switch.
If you want to see some more details about the Report on the Dashboard, you can interact with the Reports. The kind of interaction always depends on the Report itself.
If the interactions do not suffice to get the desired information or you want to edit the Report, you can directly access the Report by clicking on its title.
Applying Dashboard Filters
In the Dashboard view mode, there is a Filters button. Clicking that button opens a panel that shows all Filters that are available for this Dashboard. More Filters can be made available in the Dashboard edit mode. If the dashboard editor checked the “Allow viewer to add filter values” box for assignee, candidate group, or variable filters, dashboard viewers can add their own values to filter by.
Filters apply to all process reports on the dashboard. If a report already has filters set, they will be be combined with the dashboard filter. E.g. if a report has a filter to only show running instances and a dashboard filter for suspended instances is set, the Report will only show instances that are both running and suspended. Dashboard filters are not applied to decision reports or external reports.
Variable Filters are only applied to Reports whose process definition includes the variable. Otherwise the Filter is ignored for that Report. Other Dashboard filters as well as Filters defined directly on the Report are still applied.