Losant Dashboards provide a flexible and powerful way to display information relevant to your specific connected solution. Dashboards are helpful to see changes and patterns in your data over time, or even detect anomalies. One can even securely publish dashboards internally or externally.
A dashboard can be created at any time from the
Dashboards tab, or from a few other places within the platform.
When creating a dashboard, you’ll be asked for three pieces of information:
- Dashboard Name: You are required to name your new dashboard. The name can be changed at any time.
- Description: Optionally, you may also provide a more detailed description of the application.
- Owner: The dashboard must be scoped to your personal Sandbox or to an organization for which you have the Editor role. The owner can be changed at a later date only if you have Administrator permissions for the parent organization (or Sandbox).
Note that, should you choose to make your dashboard public, the name and description will be visible to those users.
After filling out the form, click
Create Dashboard to start adding blocks.
Losant supports many different blocks for visualizing various pieces of information. New blocks can be added to your dashboard by clicking the
Add Block link at the top of the dashboard.
Most dashboard blocks require an application from which to fetch their data. Dashboards owned by an organization may only pull data from applications owned by that organization, whereas applications owned by a user’s Sandbox may pull data from any application owned by the user or any organization the user is a member of. This allow users to build their own customized views from various projects across multiple organizations.
Dashboard blocks can be resized and rearranged to any layout that fits your needs. To move a block, grab the block’s header bar with your mouse and move it around the dashboard. To resize a block, grab its bottom right corner with your mouse and expand or contract it vertically or horizontally.
Block configuration – the settings that handle the data displayed and the style of its presentation – can be edited any time after initial block creation. To edit a block, hover your mouse over the block’s title bar and click the “gear” icon. This will open a menu with an “Edit Settings”. Clicking that option will take you to a screen where the configuration can be changed.
Each block type is different; check out each type’s entry in the documentation for details on editing its respective configuration.
If you have multiple blocks that have similar configurations, it may be quicker to start from one of the blocks, make a few edits and then push a new block to your dashboard. In these cases, cloning an existing block can save time. You can clone blocks from one of two places: the dashboard overview, or the existing block’s configuration page.
- To clone the block from the dashboard overview, click the settings button in the top right corner of the block you want to clone. From the dropdown that appears, select “Clone Block.” A modal will open that will allow you to choose which dashboard you’d like to clone into. If the dashboard you clone into belongs to a different application, further configuration may be required.
- To clone the block from the existing block’s configuration page, click “Clone Block” in the footer. This will take you to a new page where the block’s settings can be adjusted. Note: The block will not actually be added to the dashboard until you click “Add Block” at the bottom of this page.
When hovering over a block, a “gear” button will appear on the upper right. This button toggles a menu containing various actions available for the block.
The available actions can vary based on your permissions, the block type, and the current state of the dashboard. The following is the full list of possible actions:
- Fullscreen - Expands the block to fit the screen’s dimensions. Not all devices support this feature (smartphones and most tablets specifically), and if your device does not allow fullscreen display, this option will not be visible.
- Lock/Unlock - Available on Input Control blocks, to lock or unlock the controls on the block.
- Download As CSV - Available on Device State Table blocks, and allows you to download the table as a CSV.
- Refresh - Available only when a block is embedded, and allows the viewer to manually refresh the data.
- Embed Block - Available on pubic dashboards, allows you to embed the block in another website.
- Clone Block - Allows you to clone the block to the current or a different dashboard.
- Edit Settings - Allows you to edit the configuration for the block.
- Delete Block - Allows you to remove this block from the current dashboard.
Within the dashboard settings menu, there are a couple options for changing the dashboard’s display style …
- Dark Theme flips the color scheme to a much darker style. This is stored as a user-level preference, so switching to the dark theme on one dashboard will cause other dashboards you visit to also be displayed in the dark theme until you disable the setting.
- Fullscreen hides the Losant header and footer and expands the dashboard to fit the screen’s dimensions. Not all devices support this feature (smartphones and most tablets specifically), and if your device does not allow fullscreen display, this option will not be visible.
Dashboards by default will automatically refresh the data every 60 seconds. You can pause the refreshing at any time by clicking the pause button at the top of the dashboard. You can also force the dashboard to refresh by clicking the refresh button. You can also control the refresh interval under the settings for the dashboard.
By default, dashboards show values as of the last time data was fetched from Losant (“Now”). To view the state of your dashboard blocks at a given point in time, open the Time Jumper dropdown and select the “Jump to a specific date/time” option. After choosing a past time, the dashboard will refresh and display each dashboard block as it appeared at that moment.
It is also possible to jump backward and forward in time simply by clicking the arrows on either side of the time jumper dropdown. This allows for quick perusing of dashboard states as they progressed over a period of time. By default, the arrows jump 60 minutes forward and backward, but this value can be changed in the Time Jumper dropdown. The arrow jump amount is stored locally on your browser and will be maintained across different dashboards.
A few things to note when viewing past dashboard states:
- The following dashboard blocks do not update when viewing a past dashboard state (meaning, they continue to reflect the “as of now” state of the block): Input Controls, Event List, Device List, Workflow List, Application List, Dashboard List, External Website
- When viewing a past state, the dashboard will cease to refresh data on a regular basis.
- Each individual block will honor its specific duration settings regardless of the selected date. For example, when viewing 10:00am on June 1, 2016, a Time Series Graph configured to show the last hour of data will display data from 9:00am to 10:00am of that same date. Meanwhile, a Gauge Block set to display a mean aggregation of data collected over the past four hours will show the aggregated value of its attribute as collected from 6:00am to 10:00am that morning.
- If you attempt to go forward in time past the current date/time, the dashboard will automatically revert to displaying “Now” data and the ability to go forward from that point will be disabled.
Live Stream dashboard blocks automatically update in real time when new data is available, instead of waiting to update when the dashboard’s refresh timer resets.
Live streams only present the live, incoming raw data for the device(s) they are configured for. You are unable to perform aggregations on that data (i.e. mean, max, min, etc.). Access to past states is also unavailable.
Live stream blocks present a “Connected… Waiting for Data” message until the device(s) report state data for the first time after the block loads. This messages means that the dashboard has successfully connected to the Losant live stream of data for the block; it does not correlate to device connectivity for any device represented in the block.
Dashboards have three levels of access:
- Private dashboards are only accessible to you, or members of your organization if it is an organization-owned dashboard.
- Public dashboards can be seen by anyone who has the dashboard URL, regardless of whether that person is logged in to a Losant account. This is great for sharing public data, but remember that any data exposed in a public dashboard is public and is accessible by anyone. Do not make your dashboard public if it contains any private or sensitive data.
- Password-protected dashboards allow anyone with the URL and a global password set by you to view the dashboard. This adds some protection to your dashboard, while still making it easy to share with people who do not have Losant accounts.
You can manage the access control for a dashboard on the settings page for the dashboard:
You can clone a dashboard into the same application, a different application, or into an organization (multi-application dashboard).
Important: Unless you are cloning in the same organization or application, many of your dashboard blocks and context variables will require updates before they are functional again.
Clone a dashboard by navigating to the Clone tab within the dashboard settings page.
NOTE: The following blocks will not display any data on public dashboards or to non-authorized users when embedded:
From your dashboard’s settings page, click “Embed Dashboard” in the left column. This will bring you to a page where you can configure your embed options, such as:
- Width in CSS units (default: 100%)
- Height in CSS units (default: the height of dashboard currently)
- Theme (default: Light)
- Fetch Data Every … (default: current dashboard setting)
This will generate a code snippet, which you can drop into any HTML document at the place where you want the embedded dashboard to appear.
An embedded dashboard only includes the dashboard’s blocks, not its title, configuration buttons or Losant header and footer. The image below is a screenshot of a dashboard. This is the only content that appears when a dashboard is embedded.
You may only embed a single block if your dashboard’s access control has been set to
public. To get an embed code, hover over your dashboard block and click the “gear” icon in the block header, and then the “Embed Block” option in that menu.
This will display a modal where you can set the block’s
theme properties. For your width and height, make sure to enter a valid CSS length attribute (
You also have the option to email reports based on a dashboard at recurring intervals. You can do this under the “Reports” tab in the dashboard settings:
You can configure up to 10 recurring reports, each containing a set of email addresses to receive a PDF report of the dashboard at a regular interval. Each report allows you to individually choose a time of day and the days of the week to send the reports, and also the subject and message of the emails.
In the above example, a report will be emailed every Thursday at 10:10am Central Time to the addressed recipient. The resulting email will include a link to a PDF report of the dashboard at that time, similar to the example below:
A non-recurring report is a one-time report of the current dashboard view - this includes the currently selected theme and time of the dashboard. You can request a report by clicking “Generate Report” in the dashboard popup settings:
This report method can send a historical view of the dashboard and allows you to configure email addresses, timezone, subject, and message just like recurring reports, but sends only once. Since non-recurring reports don’t send on a schedule, the timezone field is used only for the time displayed on the report. Shortly after submitting, your recipients will receive an email with a link to the dashboard report.