Raw Data Node

Raw data visualizations present unprocessed data as it comes in, without any aggregation or summarization. This can be useful for debugging, detailed analysis, or when the exact data points are crucial.

What is a Raw Data Table?

The raw data table serves as a fundamental tool for displaying and organizing comprehensive data sets associated with a specific device or device label. Its primary purpose is to provide users with a detailed view of all available data points in a structured format. Each row represents new data received for the designated device or label, enabling users to track the chronological progression of information. By presenting data in its unprocessed form, the raw data table offers transparency and granularity, allowing users to perform in-depth analysis, identify trends, and derive insights. Whether used for troubleshooting, monitoring device performance, or conducting research, this table provides a foundational resource for accessing and understanding the underlying data associated with a device or device label.

Inputs

The Raw Data node has both mandatory and optional inputs. These are:

Input

Requirement

Comments

Column - Input Field Name

Mandatory

This is the field name within the incoming JSON payload that contains the data to be displayed on the widget.

File Name Field

Optional

This is mandatory if a field type is selected as File where users must provide the field name within the JSON payload that holds the file name value.

Functionality

The Raw data node is used to show available data on all devices or device labels.

Outputs

When the user selects an option from the multi-choice field on the LIVE dashboard, the table will resend the updated JSON packet associated with the payload timestamp in the workflow.

How to Use

Implementation

In the Rayven Workflow Builder:

  • Select Visualizations.
  • Drag the Raw Data node to the canvas.
  • Connect the Raw Data node to your input node.
  • Double click on the Raw Data node to open the configuration window.

Configuration

Section: General

This section contains basic configuration elements required for any Raw 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.

Raw Data Type

Mandatory

Select one of the options in the drop down menu:

  • Regular (Default)
  • Dynamic

These options will require different set up, please refer to their respective column sections.

Hide Device Name

Optional

Ability to hide the device name from the raw data table.

Widget Refresh Interval (sec)

Mandatory

Configure how often the chart widget will refresh. The default is every 60 seconds.



Section: Columns (If Regular Raw Data Type is selected)

This section is where columns are added and defined if Regular Raw Data Type is chosen. Raw 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 Column” 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 Column” button below the rows will add a new column.


The columns can be reordered by clicking and holding on the column numbers.

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:

  • Workflow Field - grab data from workflow.
  • Custom Table Field - grab data from table using the following syntax:
    TableCodeName.ColumnName
  • Event Date - shows timestamp for the record.
  • Device - shows device name associated to the record
  • Multi Choice - comma separated list to provide dropdown options for users to choose from. If a value is changed for tables showing devices, the table will resend the new JSON packet associated with the payload timestamp in the workflow.
  • File - Requires user to provide JSON field name to match to the name of files in the FTP folder. A comma will separate the list that allows the users to categorize the files shown. Users are also required to set up the “File Display” section of the node.
  • From To Field - This enable users to configure the date range for historical drill down dashboards.

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:

  • Commas - there will be comma separators at the thousand mark.
  • No Commas - there will not be any comma separators at the thousand mark.

Time Range

Optional

(Only available when Event Date is selected from Field Type)

Drop down list to select:

  • Second
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

This section only works if the dashboard link to is configured to drilldown to historical dashboard type. It also controls the custom date range on the drilldown dashboard where it creates new start and end time by padding the time range to the data timestamp.

Time Range Value

Optional

(Only available when Event Date is selected from Field Type)

Key in any numeric value for the time range.

File Name Field

Mandatory 

(Only available when File is selected from Field Type)

Field name in the JSON field that contains file names should be entered here.This field only appears if the “File” option is selected from the options drop down.



Note: The file name must match the FTP file name.

Category

Optional

(Only available when File is selected from Field Type)

Provides a comma-separated list of categories available to assign to the files. 


Note: This field only appears if the “File” option is selected from the options drop-down.



Section: Columns (If Dynamic Raw Data Type is selected)

This section is where columns are added and defined if Dynamic Raw Data Type is chosen. With this option, table column headers are automatically generated and the order is determined by the order of the JSON fields in the payload.

Field

Requirement

Comments

Data Field Name

Mandatory

This is the field name within the incoming JSON payload that contains the data to be displayed on the widget.


Sample of JSON payload expected:

{
"data_field_name": [
{
"Column 1": "A",
"Timestamp": "03/11/2023 00:00:00"
},
{
"Column 1": "B",
"Timestamp": "03/11/2023 15:00:00"
}
]
}

Device Column

Mandatory

Users can opt to show or hide this column on the table widget using the dropdown menu.

Date Column

Mandatory

Users can opt to show or hide this column on the table widget using the dropdown menu.



Section: File Display

This section is mandatory if “File” is selected as a field type for a column. The settings in this section contain the FTP details to obtain the files. Examples of supported file types are MP3, MP4, WAV, CSV, PDF, TXT, JPG, PNG, GIF.

Field

Requirement

Comments

FTP Address

Mandatory if field type is selected as Field

The FTP address for the folder within the FTP server in which the files are located.

FTP User Name

Mandatory if field type is selected as Field

The username to access the FTP server.

FTP Password

Mandatory if field type is selected as Field

The password to access the FTP server.



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:

  • Value Background Only - Colors only the value’s background
  • Entire Cell - Colors the entire cell

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:

  • Alphanumeric
  • Numeric

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.
Workflow values can be used with the following format: [[range1]]. This allows custom ranges to be set for specific use cases.

Max Range 

(Only available when Numeric is selected as the Type)

Optional

Enter a maximum value for the conditional formatting.
Workflow values can be used with the following format: [[range1]]. This allows custom ranges to be set for specific use cases.

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 minimum and maximum range or the value configured.



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

  • Alphanumeric
  • Numeric
  • Date

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: 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 Raw data node, or if device label values for the selected device labels will show.

  • Show Devices
  • Show Device Label Values

Calculation Interval

Optional

Set the interval for calculations performed on the Raw data node.

Units of Measurement

Optional

Drop down list of units of measurements for the selected calculation interval.