Sankey Diagram Node

Visualizes flow and quantity in between different nodes. Useful for showing relationships and transfer volumes within a network, such as energy, materials, or costs between processes.

Purpose

The Sankey diagram node is a tool for visualizing how values flow from one input to a number of outputs within a system. It may be used to help understand the distribution, relationship or transformation of these values within the system.

Inputs

The Sankey Chart node has one mandatory input:

Input

Requirement

Comments

Data Field Name

Mandatory

The JSON key that contains the array of JSON objects used to build the Sankey. The sequence that each child object is in the array will determine the structure of the Sankey chart.

Data format:

{

“<Data FIeld Name>”: [

{

“<From Field Name>”: “<From Node Name>”,

“<To Field Name”: “<To Node Name>”,

“<Value Field Name>”: <Numerical Value>

…

]

}

How to Use

Implementation

In the Rayven Workflow Builder:

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

Configuration

Section: General
This section contains basic configuration elements required for any Sankey Chart 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.
Device/Device Label Name	Optional	Select this checkbox to display the device or label name on the widget.
Data Field Name	Mandatory	The JSON key that contains the array of JSON objects used to build the Sankey.
From Field Name	Mandatory	The JSON key within each JSON object of the Data Field Name array that specifies the Sankey node the value is from.
To Field Name	Mandatory	The JSON key within each JSON object of the Data Field Name array that specifies the Sankey node the value is going to.
Value Field Name	Mandatory	The JSON key within each JSON object of the Data Field Name array then specifies the numerical weight value of the from and to connection.
Function	Mandatory	Select from a dropdown menu. This is the calculation performed by the node that will determine the chart displayed. Last value received Average Minimum Maximum Sum Note: This applies to each JSON object in the Data Field Name array provided.
Calculation Interval	Mandatory only if Function ‘Average’, ‘Minimum’, ‘Maximum’ or ‘Sum’ is selected	Provide an integer to determine the period of input data. This option is not visible if the Function ‘Last Value Received’ is selected.
Units Of Measurement	Mandatory	Select interval from a dropdown menu. This option is not visible if the Function ‘Last Value Received’ is selected. Seconds Minutes Hours Days Weeks (Start on Monday) Weeks (Start on Sunday) Months Years
Widget Refresh Interval (seconds)	Optional	Configure how often the chart widget will refresh. The default is every 60 seconds.

Section: Color Picker
This section allows you to customize the colors of the Sankey Node and the output connection from it.
Field	Requirement	Comments
Value	Optional	The name of the node as given from the JSON value of the From Field Name within the configured input.
Hex Colour/Colour	Optional	Either provide the Hex Colour of the Sankey Chart node, or click the Colour option to select the color from a popup color picker. If no selection is made, a range of default colors will automatically be used.

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 displayed 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 ‘Colour’ and there are the values ‘Green’ and ‘Gold’, then two widgets will be displayed, one with devices with Colour Label equal to “Green” and one with devices with Colour 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.