Monitoring your workload with dashboards

Dashboards provide a centralized view to monitor the health, status, and progress of your workload.

With versatile widget options and flexible configurations, you can create comprehensive overviews or purpose-specific dashboards tailored to the data you need to analyze.

The dashboard provides a real-time window into your orchestration environment by visualizing key performance data. By default, these metrics are collected from system services every 20 seconds, enabling you to track health, throughput, and resource utilization across your folders and workstations. To help you analyze your data effectively, metrics are categorized into three primary areas:
  • Workload health and status
    Monitor the progress of your plan by tracking the number of tasks by status, highlighting those currently in a successful, waiting, or error status. You can also identify processing bottlenecks by analyzing task run delays and specific timing indicators, such as tasks that have exceeded their maximum duration or missed their deadline.
  • Workstation and resource capacity
    Gain visibility into your infrastructure by monitoring the linked status of your workstations and their defined capacity limits. This helps ensure your resources are correctly connected and that you are not exceeding the numerical thresholds defined for specific workstations.
  • Consumption and license tracking
    Manage your operational costs and compliance by tracking billable task volume. The dashboard provides granular views of daily, monthly,and total task consumption, including specific tracking for AI agent calls. These metrics help you monitor your license usage trends over time.
For a comprehensive list of metrics, filtering labels, and technical definitions, see Dashboard metrics.

Dashboard interface

To get started with dashboards, open the UI and click Dashboards from the menu on the left. The homepage is organized into three sections:
  • My dashboards: a personal workspace for creating and managing dashboards. From this page you can quickly find a workspace by using the search bar or sorting by name or modification time, and perform actions on the dashboards. Within the My dashboards page, two ready-to-use dashboards are available. For more information, see Default dashboards.
  • Shared with me: a view-only collection of dashboards created by other teammates.
  • Trash: a section dedicated to deleted dashboards that acts as a safety net, allowing for restoration or permanent deletion.
Creating and managing dashboards
To create a new dashboard, click New dashboard in the My dashboards section.
Use the buttons in the upper-right part of the dashboard canvas to perform the following actions:
  • Refresh data: Click Refresh to instantly refresh data. To set an automatic refresh interval, expand the drop-down menu within the Refresh button and select one of the available options. You can either select one of the predefined intervals or set a custom one by clicking Custom.
  • Set date and time range for data: Click Select date range to customize the time range of all the widgets on the dashboard simultaneously. The Select date range menu has two tabs:
    Quick
    The Quick tab provides a set of predefined values that enable you to immediately filter your dashboard data for the most recent activity.
    • Quick ranges: Look back at the most recent system activity, ranging from the Last 5 minutes to the Last 24 hours.
    • Calendar ranges: Review the activities across specific standard periods, for example Today or Previous month.
    Custom
    The Custom tab enables you to set a custom date and time range to filter your dashboard data.
    • Recently used: Select a recently used time range.
    • Absolute time range: Set the custom time range using the From and To calendar tools, and click Apply.
  • Add a widget: Click Add widget to define the parameters and add the widget to the dashboard:
    1. From the New widget panel, expand the Metric drop-down menu and select a metric.
    2. From the Configuration tab, expand the Type drop-down menu and select a widget type. To configure and customize widget properties, use the Configuration and Customization tabs. Options vary according to the selected widget type, and the preview of the widget updates depending on the provided parameters and time range.
    3. Optionally, use the Query box to filter data entering OQL expressions. For more information, see Filtering metrics with OQL.
    4. Click Save.
Management actions
Each dashboard within the My dashboards page is represented by a card. To select a dashboard, check the checkbox in the top-right corner of the card. After having selected one or more cards, you can perform individual or bulk actions:
  • Duplicate
  • Export
  • Share
    Note: This action is only available on a single dashboard.
  • Delete
You can perform individual actions on a dashboard also by clicking the three-dot menu within its card. In addition to the actions listed above, the three-dot menu includes the Rename option.
Data portability
Export and import dashboard configurations to replicate setups across environments or for analysis in third-party reporting tools.
Importing dashboards
From the My dashboards page, click Import at the top right to upload a dashboard in JSON format.
Exporting dashboards
  • My dashboards and Shared with Me pages: Click the three-dot menu on a dashboard card to export it in JSON format.
  • Canvas: Click the More (three-dot) menu next to Share to export the current dashboard in JSON, PDF, or PNG format.
Collaboration and security
You can grant other users or groups view-only access to your dashboards. Click Share from the dashboard card or the canvas to open the Share Dashboard panel. From here, you can select specific users and groups and view current access permissions.
Note: Shared dashboards are provided in a view-only format. If you need to modify a dashboard that has been shared with you, you must first Duplicate the dashboard. The duplicated version is private to your My dashboards page. Any subsequent changes you make will not be visible to others unless you choose to share your new version.
Important: Dashboard sharing distributes the layout and configuration of the widgets, not the underlying data itself. Because data visibility is governed by individual security permissions, different users might see different values within the same shared dashboard. For example, a widget will only display data for folders or workstations that the viewing user is permitted to access. If a user lacks the required permissions for a specific folder, the corresponding data points will not appear in their view.
Deleting
Deleted dashboards are moved to the Trash page. To permanently remove them you have two options:
  • Select one or more dashboards and click Erase.
  • Click Empty trash.
To restore one or more dashboards, select them and click Restore.

Dashboard widgets

Widgets serve as the building blocks of your dashboard, transforming complex data into readable charts.

Widget description
You can add two types of widgets to your dashboards:
Time series
The time series widget is a linear visualization used to track the fluctuations of a metric over a specific duration. It provides historical context, helping you identify patterns, peaks, and trends in system behavior.
Data structure
Designed for time-series data.Common metrics mapped to this widget include Submitted task rate, Total task consumption for license monitoring, and Task run delay by workstation.
Interaction
The widget features a horizontal X-axis representing time and a vertical Y-axis representing the metric value. You can zoom into specific intervals or hover over data points to view exact timestamps and labels, such as folder or workstation names.
Main options
  • Group by: The Group By feature enables you to organize and aggregate metric data based on specific labels, such as folder paths or workstation names. By selecting a label from the Group By drop-down list, you can transform large, complex datasets into focused, meaningful visualizations.
    • Single line view: If you leave the Group By field empty, the widget aggregates all retrieved data into a single, summarized record.
    • Segmented view: By selecting a specific label from the Group By drop-down menu, the widget displays a separate line or data point for each unique value within that label. For example, a line chart can display individual lines representing the task processing status of each specific folder.
  • Rate: The Rate option changes how your data is displayed. If you select the Rate check-box, the widget displays the processing throughput over time, that is the difference between the current value and the previous data point.
  • Aggregation: The Aggregation drop-down menu changes how your data is summarized. For more information, see Aggregation and visualization.
Gauge
The Gauge widget is a radial visualization that represents a single data point within a defined range. It provides an immediate status update on system performance and resource utilization by comparing current values against predefined limits.
Data structure
Requires a numerical metric, for example Task run delay or Workstation limit.
Visual modes
  • Standard gauge: When a maximum value is defined, the widget displays an arc to show the current value relative to the limit. If you configure a threshold, the arc dynamically changes color based on the range you have set for that specific value. This enables you to visualize at a glance the status of your process status.
  • KPI mode: If you check the Hide gauge option from the Customize tab within the New widget panel, the arc is omitted. The widget displays the metric as a standalone Key Performance Indicator (KPI) value, focusing purely on the numerical data point.
Main option
Aggregation: The Aggregation drop-down menu changes how your data is summarized. For more information, see Aggregation and visualization.
Filtering metrics with OQL

While configuring a widget, you can use Orchestration Query Language to filter and refine the data retrieved from the database. This ensures your dashboard displays only the most relevant information for your specific monitoring needs.

For comprehensive information about OQL syntax and keywords, see Using Orchestration Query Language.

After having selected the metric and the widget type from the New widget panel, you can enter an OQL query within the Query field to narrow down a global metric to a specific subset.

The available OQL fields for metrics are:
value
The value field filters metrics according to numeric values. The syntax associated with the value field is: 
value <comparison_operator> <integer>
The comparison operators for the value field are:
  • =
  • !=
  • <
  • <=
  • >
  • >=
labels.<metric_label>
The labels.<metric_label> field filters metrics according to the labels available for the selected metric. The labels associated to each metric are listed in Dashboard metrics. The syntax associated with the labels.<metric_label> field is: 
labels.<metric_label> <comparison_operator> '<string>'
The comparison operators for the labels.<metric_label> field are:
  • =
  • !=
  • LIKE
  • NOT LIKE
You can combine the value and labels.<metric_label> OQL fields to retrieve even more detailed information. For example, you can run the following query for the Workstation limit metric:
value > 100 AND labels.folder LIKE '@WS@'