Skip to content

Getting Started

Prerequisites

To access Dashboard Designer, the following requirements must be fulfilled:

  • Editor or admin access to Dashboard Designer
  • Asset data in your current set-up

User interface

When you open Dashboard Designer, the icons located at the top of the user interface (UI) are connected to various features. The below image shows the Dashboard Designer user interface and its available options:

ui-options

① Navigation area: navigate dashboard sections or modules.
② Search bar: search dashboards, reports or data sources.
③ Options bar with the following functions: Settings, Selection of time range, Refresh dashboard and the option to enable or disable auto refresh
④ Main toolbar with the following options: Create a new dashboard, Help and details of the logged in user

The following table describes the functions of the icons in detail:

Feature or Icon Description
What's new, Announcements and Changelog Displays news and information about Dashboard Designer developments
Starred Signifies the previously marked favorite items that you can click to navigate quickly
Dashboards Opens the folders and files where your dashboards are stored
Explore Explore the data and try out various queries and graph settings with the option of creating a dashboard from your exploration. Use the explore feature when you just want to explore data without creating a dashboard.
Settings Displays settings for the opened dashboard
Variables Displays variables for the opened dashboard
Asterisk icon Shows keyboard shortcuts
Links Displays the opened dashboard links
Versions Displays version information for the opened dashboard
Permissions Displays permission settings for the opened dashboard
Refresh icon Updates the data or to select the rate at which dashboard data needs to be refreshed
Collapse icon Closes and opens the secondary menu row
Time range Displays the time range of the opened dashboard
Landing page icon Returns to the landing page
Search Search your terms and access a feature
+ icon Creates a new dashboard or imports the existing one
Question mark icon Links to documentation, support, community, open source resources and keyboard shortcuts
Tenant icon Opens your user profile and notification history

Note

Dashboard Designer does not support the Connections feature.

Dashboards

The Dashboards provide a single glance view of your data and allow you to monitor metrics through various visualizations. For more information, refer to creating dashboards.

Panels

Panels are the main component of dashboards, positioned as blocks on a grid. Each panel consists of a query and a visualization. The query defines the data and the visualization defines how the data is presented.

Data Sources

To use a dashboard, a data source needs to be added to the dashboard. For more information, refer to Prerequisites.

Dashboard Designer includes a predefined set of data sources provided by Insights Hub, as shown in below image:
data sources

A brief description of each available data source in Dashboard Designer8 is described below:

  • IoT Time Series: Siemens IoT (Internet of Things) time series data
  • Test Data: a built-in data source that generates test data
  • Dashboard: a dashboard panel can pull results, datasets or annotations from another panel in the same dashboard
  • Mixed: allows each query in a panel to access a different data source. One query (other than ‘Mixed’) must exist on the panel first before selecting “Mixed” for a subsequent query.
  • Grafana: a built-in data source that generates random walk data, which helps test visualizations and run experiments, as it can poll Test Data data sources, list files and fetch other data from the app.

Note

Dashboard Designer does not support adding additional external data sources.

Adding and configuring data sources allows you to:

  • Use the Explore feature to view data sources
  • Create queries to read specific data for use in a dashboard panel
  • Visualize data on dashboard panels
  • Apply rules to generate alerts for a data source

Queries

A query retrieves specific data from the data source. The query editor enables you to select the specific data you want to use in your panel and add additional options such as aggregation, time overrides or transformations according to your objectives. The query editor allows you to explore data and configure queries to retrieve specific data for dashboard panels. Each data source’s query editor provides a customized user interface to assist you in writing queries. Due to the differences between query languages, each data source's query editor functions differently. Depending on your data source, the query editor might provide auto-completion features, metric names, variable suggestions or a visual interface.

An example of a query editor with an IoT data source is shown below:

query panel

After configuring your query, you can also customize your visualization. For more information on the query editor, refer to Configuring the query panel.

Visualizations

The Visualization panel provides tools for configuring and customizing the available visualization options. It offers multiple sections and settings for tailoring the appearance and behavior of visual elements to suit your analytical requirements. Visualization panel options include specifying all elements related to a dashboard virtually, from tooltips to value mapping and field overrides. You can instantly view the different visualization selections and the corresponding data representation. Additional options include linking to other Dashboard Designer data, setting thresholds and mapping values with text and colors.

The visualization options enhance data analysis capabilities and enable users to more effectively present, interpret and draw insights from their data.

An example of the visualization panel options is shown below:

2clicks

Exploring Data

From the Home menu, select "Explore". A query panel is displayed where you can select your data source, apply configuration options and run the query. As you adjust panel settings, the graph reflects your changes. You can also switch between lines, bars, points, etc. on the graph. Dashboard Designer has many built-in keyboard shortcuts for general purposes, time range and panels. You can view them by clicking the question mark icon on the primary menu bar.

Note

To explore data, you must first add the data source.


Last update: June 14, 2024