Setting Input Preferences

<< Click to Display Table of Contents >>

Navigation:  Using s-Dashboard > Working with Panels > s-Dashboard Input Overview >

Setting Input Preferences

Previous pageReturn to chapter overviewNext page

Each frame gets its input from one stream, view, or table and displays it using the selected panel. There are separate preferences for how the frame reads its input and for whatever panel is selected.

To set input preferences:

Click the Configure Input Preferences Icon

sd_configure_input_prefs_icon

The Input Preferences dialog box opens.

sd_input_preferences

You can configure input preferences in four main categories:

Configuring Data Windows

Using Key Columns

Treating Views as Tables

Using a Custom Select Template

Once you configure preferences, click Update. You can change preferences at any time.

Configuring Data Windows

The nature of streaming data means that it continually updates. This means that dashboards always display a subset of the data emitted from your source, such as "all failed logins from the last minute" or "all buses speeding over the past hour."  

We use the term data window to refer to how s-Dashboard displays data in terms of time. (Some dashboards can only display one row at a time.) The data window can be a fixed number ("20 rows"), a fixed number per category ("20 rows for each department") a fixed time period ("every hour on the hour"), a sliding time period ("all data from the last sixty minutes").

The first thing you want to determine, then, is how you want to configure your data window. (You can always change this by returning to Input Preferences.)

Choose one of the following four options:

Data Window

Description

N Rows

A specified number of rows. When you choose N Rows, a dialog box appears that lets you enter a number. Very high numbers may affect performance.

N Rows Per Key

s-Dashboard lets you use a column to divide your data into categories. This column is called the key column, and can be a list of cities, departments, countries, regions, products, and so on--any category into which your data can be grouped. N Rows Per Key works the same as N Rows, but lets you enter a number per category. When you choose N Rows Per Key, a dialog box appears that lets you enter a number. Very high numbers may affect performance.

Sliding Time Period

All streaming rows have a timestamp called ROWTIME. This means that you can tell s-Dashboard "give me all the rows in the past hour" or "give me all the rows in the past minute" and so on. Again, high numbers may affect performance, so experiment accordingly.

This is the most common way to view time series data.

Tumbling Time Period

This data window also uses ROWTIME, and lets you tell s-Dashboard "give me data for an hour, then clear data, then give me data for the next hour," at, for example, 2:00 PM, 3:00 PM, 4:00 PM, and so on.

Working with Key Columns

Some panels let you group data into categories, using a special column called the key column. A key column has a limited set of values that categorize the values in other columns, such as cities, departments, product lines, and so on. You can enter the name of this key column in Input Preferences. You need to generate this column as part of your data before using it in s-Dashboard. You could, for example, use the Categorize Analytic in StreamLab to set up a stream with multiple categories.

The panels in the View Rows Over a Key Column display one row for each category in the key column. For example, you can use the Bars Over Key panel  to group a bar chart. The stream below has a key column called "key" that contains a list of cities.

sd_key_column_example

and producing this chart:

sd_key_column_rendered_as_dashboard        

Using the Treat View as Table Option

By default, s-Server assumes views are of streaming data, but they can refer to tables. If you know that your view refers to a table, you can use the Treat View as a Table command to ask s-Dashboard to treat the view as a table (and therefore check the server less frequently.

Using the SELECT Template Option

By default, the dashboard uses either SELECT * FROM <input> SELECT (if Include ROWTIME is not selected) or SELECT STREAM ROWTIME,* FROM <input> (if Include ROWTIME is selected). You can use the SELECT template field to create a custom SELECT statement. This is an advanced feature that requires knowledge of both SQL and JavaScript to use. See Using the SELECT template in this guide for more details.