Monitor Node

Monitor visualizations provide a continuous overview of system performance or the status of various metrics over time. They can include graphs, charts, or numbers that update in real time, allowing users to watch for trends, spikes, or drops as data.

What is a monitor?

A monitor serves the purpose of displaying a specific value derived from a mathematical function or alphanumeric input. Its primary function is to provide a visual representation of data, making it easier for users to comprehend and analyze. One of its key features is the ability to automatically adjust its color based on the value it's displaying, allowing for quick visual assessment of the data's significance. This widget is particularly useful in various applications where real-time monitoring or visualization of data is essential, ranging from system performance monitoring to industrial process control.

Inputs

The monitor node has a mandatory input:

Input	Requirement	Comments
Input Data Field	Mandatory	This is the field name within the incoming JSON payload that contains the data to be displayed on the widget.

Outputs

The monitor node does not output any data into the workflow. It is used to display data using a widget on a dashboard.

How to Use

Implementation

In the Rayven Workflow Builder:

Select Visualizations.
Drag the Monitor node to the canvas.
Provide an input to the Monitor node by connecting it to another node.
Double click on the Monitor node to open the configuration window.

Configuration

Section: General
This section contains basic configuration elements required for any monitor 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.
Widget Subtitle	Optional	Additional text that can be used to explain the data presented by the node. This will appear directly under the Widget Name, in a smaller text size.
Widget Header	Mandatory	Ability to hide or show the widget’s header.
Input Data Field	Mandatory	This is the field name within the incoming JSON payload that contains the data to be displayed on the widget.
Device/Device Label Name	Optional	Select this checkbox to display the device or label name on the widget.
Background Color	Optional	Ability to select desired colors as the monitor’s background color.
Icon	Optional	Select the "CHOOSE ICON" button which will open a library of icons to choose to display on the widget.
Trend	Optional	If there has been a change in value for the widget, it will show either an up arrow or a down arrow on the widget, depending on the direction of the change.
Text for Portrait Display	Optional	Ability to add in a text description that will be displayed on the portrait mode of the monitor widget.
Symbol	Optional	Enter a symbol that will be displayed at the end of the value (e.g. °C or °F)
Decimal Precision	Optional	Enter the number of decimal places to display on the dashboard.
Comma Separators at Thousand Mark	Optional	When checked, there will be comma separators at the thousand mark.
Condition Type	Mandatory	Select from a dropdown menu Numeric Range Alphanumeric
Dashboard to link to	Optional	Select a dashboard that will open when a user clicks on the value widget. Select the dashboard from a dropdown menu.
Show Last Value	Mandatory	Select from a dropdown menu Chronologically - Takes the value from the payload with the latest timestamp Received - Takes the value from the last payload received, irrespective of the timestamp
Range	Mandatory	When the alphanumeric condition type is set, there is a single value that can be added for each row to determine colors / icons. When the numerical condition type is set, there are ‘Min’ and ‘Max’ options to determine the color ranges. Workflow values can be used with the numerical condition ranges in the following format: [[range1]]. This allows custom ranges to be set for specific use cases.

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: 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.