Using s-Dashboard


The purpose of this document is to describe how to use s-Dashboard to display s-Server or StreamLab data graphically. Topics include:

  • Using the s-Dashboard interface
  • Integrating s-Dashboard with s-Server or StreamLab
  • Using built-in dashboards
  • Creating custom dashboards


Page Topics

This page covers the following subtopics:

s-Dashboard Overview

s-Dashboard is a browser based solution to enable business users and analysts to build, edit, and deploy real-time dashboards over streams, views, or tables. These streams, views, and tables may have been created in StreamLab, or otherwise generated in s-Server. Once deployed, these dashboards will update continuously with s-Server data.

Once s-Dashboard is running in your environment, you access it by pointing your browser to a web address along the lines of localhost:5595. Other users may also send you links to dashboards that they have created.

In many cases, s-Dashboard will automatically work with s-Server. See Running s-Dashboard for details on connecting s-Dashboard to s-Server in other cases.

Dashboards Overview

Dashboards are web pages that contain multiple panels, each of which can connect to a different stream, view, or table. You can arrange panels in a variety of flexible layouts. See Working with Dashboard Layouts for more details.

Each panel contains a visualization. These are flexible modes of viewing your data, including simple tables, points on a map, line plots, bar graphs, area maps, and so on. These all use column-row combinations to plot data. Panels can be changed in terms of both layout and data input. Dashboards will be most useful for streaming data, as you will be able to see data changing in real time. See Working with Panels for more details.

The dashboard below, for example, shows a line chart which displays suspect logins to a bank over a shifting window of time.

By using adjustable panels, s-Dashboard lets you view multiple such objects at once. Each dashboard can be laid out with multiple panels, in combinations that you can change by adjusting panel layout. The figure below shows two dashboards side by side showing the same data.

Using the Dashboards Home Page

The Dashboards home page lists all dashboards created in this instance of s-Dashboard, lets you create new dashboards, lock and unlock existing dashboards, and delete existing dashboards.

s-Dashboard Menu

The s-Dashboard menu is the main way to manage dashboards. It is available by clicking the SQLstream icon in the upper right corner of s-Dashboard. It provides options for how you view s-Dashboard, options for the currently selected panel, and options for changing the layout frame.

  • Show title bar. The bar at the top of a panel is known as the Title Bar. You can choose to hide this bar with the Show Title Bar command.
  • Set title. You can assign each panel a name using the Set Title command. This command also lets you change the name of the panel. Once you assign the name, it appears in the Title Bar.
  • Select panel. This command causes the same action as clicking the Select Panel link, and lets you select a panel type, such as an HTML table, a time-based chart, or map.
  • Select input. This command causes the same action as clicking the Select Input link, and lets you select a stream, view, or table from which to view data from the associated instance of s-Server.
  • Panel preferences. Opens the
  • Input preference. This command opens the Input Preferences dialog box, which lets you choose whether to include the ROWTIME column for the table, view, or stream, choose to treat a stream as a table, and other options. See the topic - Setting Input Preferences for more details.
  • Reopen input. This command lets you restart the connection to the stream, view, or table associated with the panel.
  • Save dashboard. This command lets you save the current panel layout.
  • Invalidate cache. This command asks s-Dashboard to check the current catalog for s-Server (the catalog is cached, or stored in memory, the first time you select input for the panel. You will most likely want to use this command if s-Server's catalog has changed, that is, if your developers have added a new schema, stream, table, or view. Check with your developers for more information on the catalog for your instance of s-Server.
  • Enclose in layout frame. This command lets you add a layout frame to the current panel. See the topic Enclosing a Panel in a Layout Frame for more details.

Each dashboard has a unique URL. To share the URL with someone else, you can copy the URL and send it to them. You can also make the dashboard read-only by locking it.

Locking Dashboards

At times, you may want to share dashboards with other users without allowing them to change a dashboard's layout or input.

You can lock dashboards by clicking the lock icon on the Dashboards home page.

Dashboards opened when protected will not have SQLstream logo icons or other controls in title bars. Frames and title bars will not highlight when hovered. Menus are not available.

Integrating a Dashboard into a Web Page

You can integrate dashboards into a web page using iframes. An iframe embeds another HTML page into the current page. See for more information on iframes, particularly on customizing their attributes.

In s-Dashboard, simply copy the URL from the browser in which you are viewing s-Dashboard. To export a dashboard's URL for sharing in StreamLab, click the Export URL icon in the upper right corner of the dashboard:

<iframe> tags work similarly to <img> tags.

A very simple page would look something like the following:

    <h1>My Dashboard</h1>
    <!--add whatever content you want to add here-->
    <iframe src="http://myserver:5595/dashboard/mainNoPanel" height=500>
    <!--iframe with link to dashboard-->

s-Dashboard Technical Details

s-Dashboard communicates with s-Server's WebAgent over Websockets to get stream data, using Node, a JavaScript integration platform. WebAgent, in turn, communicates with s-Server over JDBC.