The purpose of this document is to describe how to use s-Dashboard to display s-Server or StreamLab data graphically. Topics include:
This page covers the following subtopics:
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 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.
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.
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.
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.
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.
You can integrate dashboards into a web page using iframes. An iframe embeds another HTML page into the current page. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe 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:
<html>
<body>
<h1>My Dashboard</h1>
<!--add whatever content you want to add here-->
<iframe src="http://myserver:5595/dashboard/mainNoPanel" height=500>
</iframe>
<!--iframe with link to dashboard-->
</body>
</html>
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.