Tabular data visualizations organize data in tables, making it easier to read and compare values across different categories or time periods.
Inputs
The Tabular Data node has both mandatory and optional inputs. These are:
Input |
Requirement |
Comments |
Column - Input Data Field |
Mandatory |
This is the field name within the incoming JSON payload that contains the data to be displayed on the widget. |
If Input - Input Field Name |
Optional |
This is the field name within the incoming JSON payload that contains the data to be used for the in input condition (See below). |
Functionality
The tabular data node is used to show the latest or calculated values for devices or device labels.
Outputs
If the node is configured with Multi Choice field type and to show devices, the table will send the JSON payload tied to the device and timestamp when the dashboard user selects an option from the dropdown list.
How to Use
Implementation
In the Rayven Workflow Builder:
- Select Visualizations.
- Drag the Tabular Data node to the canvas.
- Connect the Tabular Data node to your input node.
- Double click on the Tabular Data node to open the configuration window.
Configuration
Section: General |
||
This section contains basic configuration elements required for any Tabular Data implementation |
||
Field |
Requirement |
Comments |
Widget Name |
Mandatory |
Enter a name for this node. This provides a handle to which you and others can refer, so it should be simple but meaningful and explain the node’s purpose. |
Tabular Data Type |
Mandatory |
Select one of the options in the drop down menu:
|
Section: General (Tabular Data Type: Regular) |
||
This section contains basic configuration elements required for any Tabular Data implementation |
||
Field |
Requirement |
Comments |
If input |
Optional |
This section allows you to set a condition for when data will be shown or hidden. Input Data Field: Enter here the field name that you would like the row to check. Operator:
Value: Enter the value or string to compare the Input Data Field value against. |
Input Data Field |
Optional |
This is the field name within the incoming JSON payload that contains the data to be displayed on the widget. |
Operator |
Optional |
Choose a relevant condition to determine if the row will be shown or hidden.
|
Value |
Optional |
Is the value or string the field data uses to check for the set condition against the JSON field. |
Visibility |
Optional |
In the drop down menu choose either:
|
Widget Refresh Interval (sec) |
Mandatory |
Configure how often the chart widget will refresh. The default is every 60 seconds. |
Section: Columns (Tabular Data Type: Regular) |
||
This section is where columns are added and defined. Tabular data tables can have multiple columns, but must have a minimum of one. The “X” at the end of the row will remove a column, the “+ Add Value” button below the columns will add a new column. The columns can be reordered by dragging them into position. |
||
Field |
Requirement |
Comments |
Column |
Mandatory |
The “X” at the end of the row will remove a column, the “+ Add Value” button below the rows will add a new column. |
Input Data Field |
Mandatory |
This is the field name within the incoming JSON payload that contains the data to be displayed on the widget. |
Display Name |
Mandatory |
This is the name for the column that will be displayed on the widget. |
Field Type |
Mandatory |
A drop down menu that can be used to select from the following options:
|
Function |
Mandatory |
Drop down list to select data function.
|
Dashboard to link to |
Optional |
Drop down list to select a configured dashboard to link to from this column. |
Aggregate |
Optional |
Average and sum options for the entire column. |
Pre Symbol |
Optional |
Provide symbol to be added in front of every value within the column |
Post Symbol |
Optional |
Provide symbol to be added at the end of every value within the column |
Decimal Precision |
Optional |
Specifies the decimal precision for values in the column. |
Thousands Comma |
Mandatory |
Drop down list to select:
|
Section: Conditional Formatting |
||
This section allows the user to set up a conditional formatting on the tabular data table. |
||
Field |
Requirement |
Comments |
Color Fill |
Optional |
Options to select from:
|
Condition |
Optional |
Users are able to create various conditions by clicking the “+ Add Condition”. |
Display Name |
Optional |
The name must be the exact same as the “Display Name” typed in the Columns. |
Type |
Optional |
Drop down list to select:
|
Range |
Optional |
At the end of the “Condition” row, select the “+” symbol to add a range for the conditional formatting. |
Min Range (Only available when Numeric is selected as the Type) |
Optional |
Enter a minimum value for the conditional formatting. |
Max Range (Only available when Numeric is selected as the Type) |
Optional |
Enter a maximum value for the conditional formatting. |
Value (Only Available when Alphanumeric is selected as the Type) |
Optional |
Enter a value for the conditional formatting. |
Color |
Optional |
Select a desired color you wish to see when the value received falls under the min-max range or the value set. |
Section: Tooltip Info |
||
Field |
Requirement |
Comments |
Show Tooltip |
Optional |
When checked, it allows users to display their tooltip text on the widget. |
Tooltip Text |
Optional |
This section only exists when “Show Tooltip” is checked. Users are able to write any tooltip message they desire which will be display on the widget. |
Section: Conditional Link To |
||
Allows users to link different columns and also different values to different dashboards. |
||
Field |
Requirement |
Comments |
Condition |
Optional |
Users are able to create various conditions by clicking the “+ Add Condition”. |
Display Name |
Optional |
The name must be the exact same as the “Display Name” typed in the Columns. |
Type |
Optional |
Drop down list to select:
|
Default Dashboard to Link to |
Optional |
When none of the values meets the range’s conditions, the column will default the user to the dashboard selected in this section. |
Range |
Optional |
Users input the range they desire, it can be in numeric, alphanumeric or date. |
Dashboard to Link To |
Optional |
When the value meets the requirement of the range input by the user, it will link to the selected dashboard. |
Section: General (Tabular Data Type: Dynamic) |
||
This section is where the dynamic tabular data would automatically populate the table on the dashboard. |
||
Field |
Requirement |
Comments |
If input |
Optional |
This section allows you to set a condition for when data will be shown or hidden. Input Data Field: Enter here the field name that you would like the row to check. Operator:
Value: Enter the value or string to compare the Input Data Field value against. |
Input Data Field |
Optional |
This is the field name within the incoming JSON payload that contains the data to be displayed on the widget. |
Operator |
Optional |
Choose a relevant condition to determine if the row will be shown or hidden.
|
Value |
Optional |
Is the value or string the field data uses to check for the set condition against the JSON field. |
Visibility |
Optional |
In the drop down menu choose either:
|
Device - Display Name |
Mandatory |
This is the name for the column that will be displayed on the widget. |
Visibility |
Optional |
In the drop down menu choose either:
|
Date - Display Name |
Mandatory |
This is the name for the column that will be displayed on the widget. |
Visibility |
Optional |
In the drop down menu choose either:
|
Widget Refresh Interval (sec) |
Mandatory |
Configure how often the chart widget will refresh. The default is every 60 seconds. |
Section: Group by Device Label |
||
Field |
Requirement |
Comments |
Device label name |
Mandatory |
There are no labels available in this box until you have saved at least one in the Device Labels section of the Workspace. Select a Label to use to filter devices. |
Grouped |
Mandatory |
Select a method for grouping the widget on the dashboard from the dropdown: No Grouping (widget per device): one widget will appear for each device Group by device label value (Widget per label value): One widget will appear for each value of a label. For example, if the Label is ‘Color’ and there are the values ‘Green’ and ‘Gold’, then two widgets will be displayed, one with devices with Color Label equal to “Green” and one with devices with Color Label equal to “Gold” Group by device label name (One widget): Only one widget will be displayed and this will contain data from all devices. |
Show on Table |
Optional |
Drop down list providing the option to select if devices will show on the tabular data node, or if device label values for the selected device labels will show.
|
Calculation Interval |
Optional |
Set the interval for calculations performed on the tabular data node. |
Units of Measurement |
Optional |
Drop down list of units of measurements for the selected calculation interval. |