Dashboards
  • 27 Jun 2023
  • 4 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Dashboards

  • Dark
    Light
  • PDF

Article Summary

Dashboard is a tool in Corezoid for collecting and visualizing statistics and reports related to processes and State Diagrams. Dashboards present data in the form of charts, allowing users to gain insights from the data visually.

A chart uses data from nodes of built processes and State Diagrams. Tasks in nodes (counters) are the source of data (metrics) of the chart.

Creating a dashboard

Here's how you can create and customize a dashboard in Corezoid:

  • Click on the Create button;
  • Select Dashboard from the options;
  • Enter a name and a description (optional) for the dashboard.

create_dashboard

Once the dashboard is created, it will contain an empty chart that is ready for editing.

Save your changes by clicking the Save button.

Click Add chart to add a new chart to the dashboard.

new_dashboard

Chart settings

Chart metrics

To add data to the chart, click on the "+" (Add Metrics) in the Metrics settings:

add_metrics

This will open a window where you can select the data source for the chart:

metrics

Folders - displays a list of folders with processes;

Processes - displays processes located in the selected folder;

Process nodes - displays nodes of the selected process. Clicking the + button adds the node to the chart;

Added metrics - lists the nodes added to the dashboard.

After you've added the needed metrics, close the metrics selection window to view your customized chart:

with_metrics

Click the Save button to apply changes.

You can change the order of metrics in the list using drag and drop in Metrics settings:

order_metrics

Chart Type

You can customize the chart type based on the type of data and the purpose of the chart.

Available types:

  • Bar chart;
  • Pie chart;
  • Funnel chart;
  • Table.

chart_types

Chart Size

Adjust the size of the chart by moving the cursor to its left or right corner and setting the desired size:

chart_size

Range

You can set a range of data to be displayed on a dashboard. This range will be applied to all existing charts in the dashboard.

Pay attention that the Real-Time mode works correctly only for final nodes (End: Success, End: Error) and Waiting for callback, Delay and Set state nodes (in a State Diagram).
This is because tasks in node types Waiting for callback, Delay, Set state are delayed for the time specified in the process, while in End: Success and End: Error nodes tasks are accumulated.
Nodes of other types don’t accumulate tasks. If you select Real-Time mode, the chart data will be empty.

range

Adding a link to the linked chart

If your data has a hierarchical structure, that is, it contains nestings, then they can be appropriately detailed. Use a link to the chart from another dashboard to display metric details.

Click on “🔗” (Add chart link) in Metrics settings to do this.

link_metrics

This will open the window for selecting a linked chart. Select a dashboard and a chart in it.

linked_chart

Clicking the link opens the selected chart in a new tab.

Access management

You can share a dashboard in two ways:

  1. When editing the dashboard, click the Share button in the upper right corner of the screen:

share_dashboard

The Sharing settings window will open. In the window, you can view the list of current users and their access rights as well as add a new one.

If a user has been already added to your list, you can search for this user by first three symbols of the user name or email. Select a user, check his/her access rights and click the Send invitation button.

share_exist_user

If the user hasn’t been added to your list yet, enter the user's e-mail, check the user's access rights and click the Send invitation button.

share_new_user

The invited guest will receive an e-mail notification of being invited to a dashboard.

invite_message

Until the user confirms the invitation the user's email will be displayed with an envelope symbol in the sharing window.

  1. In the Workspace tab, when browsing a folder that contains the dashboard, click Share objects:

ShareInFolder

This will open the Sharing settings window, in which you can view the list of current users with their access rights, and you can add new users as described in pragraph 1.

Dashboard export

You can download a dashboard as well as other Corezoid objects as a json file.

Dashboard data sources export

If you want your dashboard to work correctly after you've downloaded it, the downloaded folder must contain the dashboard together with the related processes/charts

To perform the export, select a folder containing a dashboard and related processes and click Download.

download_dashboard

Click to file in the window with a successful download notification to save the file to your hard disk.

Dashboard import

You can create a dashboard from json file. To do this, json file needs to contain a folder with a dashboard and related processes/charts.
Click Create -> From file and select the needed file in json format in the explorer.

create_from_file

This will create a folder which you can find in the list of your processes - folder "My files".