Soracom Lagoon
Using Query to Display Data on the Panel
Overview
The Query Editor in the Panel Editor controls what data is displayed. It is located below the panel display, in the Explore menu, and in the Alert editor.
Configuration Options
Resource Type
The Resource type dropdown, located on the left, filters the resource list by type.
Resource types include Air, Sigfox, Device, and Demo.
If you configure variables for the dashboard, you can set variables as the Resource type. Newly created dashboards provide a built in $resource_types variable which can be selected in the Resource type dropdown list.
Group
The Group dropdown filters the resource list by group.
When set to All Groups, all resources corresponding to the selected Resource type will be displayed.
Group here refers to the groups you have created in the Soracom User Console. Refer to Creating a Group for more information on creating groups.
If you configure variables for the dashboard, you can set variables as Groups. Newly created dashboards provide a built in $groups variable which can be selected in the Group dropdown list.
Resources
The Resources dropdown supports multi-select and is used to select the target resources to display in the panel.
Resources that have sent data to Soracom Harvest Data at least once and match the selected Resource type are displayed.
To clear selections, click the X next to a resource name or the X on the right of the dropdown bar to remove all selections.
You can select up to five resources to display on the panel.
The Demo resource type provides five resources for experimenting with various Soracom Lagoon features, labeled Device-1 through Device-5.
Multi-resource selection is not supported by some panel types.
Certain panel types require separate queries for multi-resource plotting.
- Time series
- Bar chart
- Stat
- Gauge
- Bar Gauge
- Table
- Pie Chart
- State Timeline
- Heatmap
- Status History
- Histogram
If you configure variables for the dashboard, you can set variables as Resources. Newly created dashboards provide a built in $resources variable which can be selected in the Resources dropdown list.
Data Format
The Data format dropdown is used to modify the format of the data to improve compatibility with certain panels. The three available options are Standard, Table, and Map.
- Standard
- The Standard format is broadly compatible with most panels and should be used in most cases.
- Table
- The Table format is deprecated and exists to ensure legacy compatibility with dashboards migrated from Soracom Lagoon 2.
- Map
- The Map format is used to indicate which data series corresponds to the
latitudeandlongitudeproperties required by the Soracom Map Panel.
- The Map format is used to indicate which data series corresponds to the
Properties
The Properties dropdown supports multi-select and filters the type of data displayed on the panel by name. Available properties are based on the data sent by the selected Resources.
When set to -All-, all data sent by the selected resources will be displayed.
To clear selections, click the next to a resource name or the on the right of the dropdown bar to remove all selections.
If you configure variables for the dashboard, you can set variables as Properties. Newly created dashboards provide a built in $properties variable which can be selected in the Properties dropdown list.
Searching the Configuration Options
The dropdowns in the Query Editor can be searched by typing the first few letters of the desired value. The options shown in the dropdown will be filtered based on the search term.
See examples below, of searching the Resources and Properties dropdowns.
After choosing the desired option from the returned search results, it can be selected by pressing Enter or clicking on the option. If you accidentally select the wrong option, you can clear the selection by pressing Backspace.