Map Node

Displays geographical data visually using a geographical map as the base. Maps can show a wide range of data, including physical locations, geographical features, or spatial data distributions.

Inputs

The map node has optional inputs. These are:

Input

Requirement

Comments

Latitude Field Name

Optional

A field that provides the device’s current latitude in decimal degrees.

Longitude Field Name

Optional

A field that provides the device’s current longitude in decimal degrees.

Zoom Factor

Optional

A field that provides an integer zoom factor from 1 to 20.


Functionality

This node does not perform any operations on input fields.

Outputs

If the map widget has geofence setup, two new fields ('geo_value' and 'geo_name') will be added to the JSON, with a value from the following representing the status of the device:

geo_value

"Out" (the device is outside buffer or fence)

"Buffer green" (the device is in the buffer of a green area)

"Buffer red" (the device is in the buffer of a red area)

"Buffer black" (the device is in the buffer of a black area)

"In green" (the device is in a green fence)

"In red" (the device is in a red fence)

"In black" (the device is in a black fence)

"Out disabled" (the device is outside a buffer or fence and inactive)

"Buffer disabled" (the device is inside a buffer and inactive)

"In green disabled" (the device is inside a green fence and inactive)

"Unknown" (there has been a server error)

geo_name

”fence name” (when the device is inside a fence, the value that was configured in “Enter fence name” in the map node)

”Out” (when the device is outside a fence)

How to Use

Implementation

In the Rayven Workflow Builder:

  • Select Functions.
  • Drag the Map node to the canvas.
  • Connect the Map node to your input node.
  • Double click on the Map node to open the configuration window.

Configuration

Section: General

This section contains basic configuration elements required for any map 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 display or hide the widget name on the header.

Map Display Type

Mandatory

Select a map type, this can be:

  • Google Map - Provides detailed information about geographical regions and sites around the world.
  • ArcGis Map - Allows users to manage and analyze geographical information.

Device/Device Label Name

Optional

Select this checkbox to display the device or label name on the widget.

Map Visibility

Optional

Select the default visibility of the map. This can be:

  • Map - Provides a clean cartographic representation with street and suburb names.
  • Satellite - Provides additional satellite imagery. This is useful for mining, rural and regional applications.

Default Latitude

Optional

Enter a default decimal latitude, e.g. -33.857847

When set, the map will open centered on this latitude.

Default Longitude

Optional

Enter a default decimal longitude, e.g. 151.214639


When set, the map will open centered on this longitude.

Set Default Location to be a fixed center point

Optional

Ability to set the default location to be a fixed center point on the map widget when checked.

Default Zoom

Optional

Set a default zoom, e.g. 16


A number between 1 and 20 which, when set, determines the initial zoom when a map is displayed.

Show Places of Interest

Optional

Ability to display places of interest on the map widget.

Auto Zoom

Optional

Set auto zoom


When checked, overrides the default zoom and will automatically zoom the map to show all devices.

Show Cluster

Optional

Set show cluster


When checked, a group of nearby map icons will be grouped into a cluster. When not selected, all map icons will appear individually, regardless of the map zoom level.

Default Map Icon

Optional

Click the upload icon link and select from the file browser.


You can upload a default map icon to override the platform’s default map icon. This selection will be overridden by any map icon set in the device or device filter or in the ‘Before Triggers’ section of the map node.



Section: Location

This section contains location configuration elements

Field

Requirement

Comments

Latitude Field Name

Optional

Enter the name of the input field that contains the current device latitude.

Longitude Field Name

Optional

Enter the name of the input field that contains the current device longitude.

Zoom Factor

Optional

Enter the name of the input field that contains a zoom factor to use.



Section: Geofence

The geofence on the map will be configured on the Rayven’s dashboard.

Field

Requirement

Comments

Hide fence name as a Tooltip

Optional

When checked, it allows users to hide the fence name when the tooltip hovers on the geofence.

Outline Fence

Optional

When checked, the geofence will have an outline (usually a black bold line around it).



Section: Before Triggers

This section allows the flow to change the way a device is presented, based on the value(s) of field(s) in the input payload.


You may add add multiple fields to test by clicking ⊕ Add before trigger 

Field

Requirement

Comments

Input Data Field Name

Optional

Enter the name of the input field to be evaluated.

Operator

Optional

Choose an evaluation comparator from the drop down menu:

  • =
  • >
  • <

Value

Optional

Enter a value to complete the evaluation

Then show

Optional

Click the upload icon link and select from the file browser or you can select from the icon library.

When the condition occurs cluster is

Optional

Determines if the cluster color will change based on a valid result of the before trigger.



Section: Inside Triggers

If the node is configured with map type == Geofencing, two new fields ('geo_value' and 'geo_name') will be added to the JSON, and the map will also allow you to complete this section. This section allows the map node to change the way a device is presented, based on a device’s position relative to buffers and geofences.


You may add add multiple fields to test by clicking ⊕ Add inside a map trigger 

Field

Requirement

Comments

If: Choose condition

Optional

Select a condition from the dropdown list.

  • Inside fence - the device is inside a fence
  • Inside buffer zone - the device is inside a buffer
  • Outside fence violation - the device is outside a fence

Then show

Optional

Click the upload icon link and select from the file browser or you can select from the icon library.

When the condition occurs cluster is

Optional

Determines if the cluster color will change based on a valid result of the before trigger.



Section: Heatmap

Field

Requirement

Comments

Enable Heatmap

Optional

When checked, the map widget will display the heatmap of the devices.

Radius of Influence

Optional


(Only available when “Enable Heatmap” is checked)

Enter a numeric value which will increase or decrease the radius of the heatmap.

Radius measurement units

Optional


(Only available when “Enable Heatmap” is checked)

Select radius measurement units from the dropdown list:

  • Pixels
  • Meters

Opacity (0-100%)

Optional


(Only available when “Enable Heatmap” is checked)

Enter a percentage value to determine the transparency of the heatmap.

Heatmap Type

Optional


(Only available when “Enable Heatmap” is checked)

Select a heatmap type from the dropdown list.

  • Location based
  • Event based

Field

Mandatory


(Only available when “Event Based” is selected)

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

Operator

Mandatory


(Only available when “Event Based” is selected)

Choose a relevant condition to determine if the row will be shown or hidden.

  • “=” If the field is equal to the value set, the condition will pass.
  • “>” If the field is greater than the value set, the condition will pass.
  • “<” If the field is less than the value set, the condition will pass.
  • “≥” If the field is greater and equal than the value set, the condition will pass.
  • “≤” If the field is less and equal than the value set, the condition will pass.
  • “≠” If the field is not equal to the value set, the condition will pass.
  • “Exclusive Between” If the field is not in between the endpoints, the condition will pass.
  • “Exclusive Not Between” If the field is in between the endpoints, the condition will pass.
  • “Inclusive Between” If the field is in between and equal to the endpoints, the condition will pass.
  • “Inclusive Not Between” If the field is not between and equal to the endpoints, the condition will pass.
  • “Exists” If the field exists, the condition will pass.

Value

Mandatory


(Only available when “Event Based” is selected)

Is the value or string the field data uses to check for the set condition against the JSON field.

Color

Mandatory


(Only available when “Event Based” is selected)

Select a desired color you wish to see when the value received falls under the min-max range or the value set.

Condition Name

Mandatory


(Only available when “Event Based” is selected)

Provide a unique name for each condition.



Section: KMZ File

Field

Requirement

Comments

KMZ File

Optional

Users are able to upload a KMZ file.



Section: Tooltip

By default the map node will display a label showing the device id, when the user hovers the cursor over the map icon.


This can be modified to remove the device id and also to add fields for real-time display of variables in the label.


You may add add multiple fields to test by clicking ⊕ Add Tooltip Item

Field

Requirement

Comments

Show Device Name in Tooltip

Optional

This is checked by default. When checked, the label will display the device ID. 

Display Name

Optional

Will set the name for all devices/device filters on the tooltip.

Show last event date in Tooltip

Optional

This is unchecked by default. When checked, the label will display the timestamp for the last received event or payload.

Item Name

Optional

Enter the display name that will appear in the label for this field.

Item Field Name

Optional

Enter the name of the input field that contains the variable to be displayed.



Section: Link to

Maps allow you to link to other dashboards by clicking on an icon. This is useful when you want to ‘drill-down’ to a different dashboard to display more detailed information about a device.

Field

Requirement

Comments

Multiple Dashboard

Optional

When checked, you are able to link to multiple dashboard from the same map widget.

Dashboard to link to

Optional

Select a dashboard to link to from the dropdown.

Time Range

Optional

Drop down list to select:

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

Time Range Value

Optional

Enter a numeric value for the time range.

Device Label Name to Link to by

Mandatory


(Only when “Multiple Dashboard” is checked)

Select a device label name from the dropdown menu.

Link

Mandatory


(Only when “Multiple Dashboard” is checked)

You can add multiple “Links” to the node by clicking “+ Add Value”

Value

Mandatory


(Only when “Multiple Dashboard” is checked)

Select a value from the dropdown menu after selecting the “Device Label Name to Link to by”.


This allows the users to link a device label value to a specific dashboard.

Dashboard to Link to

Mandatory


(Only when “Multiple Dashboard” is checked)

Select a dashboard to link to from the dropdown.



Section: Refresh

Field

Requirement

Comments

Refresh

Optional

Select this checkbox to open a textbox (Widget Refresh Interval). 


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



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 Map widgets on the dashboard from the dropdown:


No Grouping (widget per device): one map widget will appear for each device


Group by device label value (Widget per label value): One map 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 map 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 map widget will be displayed and this will contain all devices.

Show on Map

 

Drop down list provides the option to select if devices will show on the tabular data node, or if device filters will show. The options are:

  • Show Devices
  • Show Device Label Values

See Also: Creating a dashboard, Creating device labels, Configuring nodes using labels


Step by Step section for Geofence

  1. In order to create your geofences on the map, you will need to log into your Rayven’s dashboard account.
  2. Go to the selected map you wish to have the geofence on.
  3. Click on the expand icon to open the pop up window to the map.

  1. You are able to select the different geofence shapes; circle, rectangle, and polygon.
  2. Then, you can draw freely on the map to create various geofences.

  1. After drawing the geofence, right click on the geofence. You are able to enter a unique name for the geofence created by selecting “Enter Fence Name”.
  2. You can also enter the fence zone distance (which is in KM si unit) by selecting “Define fence zone”.
  3. You can also enter the buffered zone distance (which is in KM si unit) by selecting “Define Buffer Zone”.
  4. To remove the geofence, select “Remove this fence”.
  5. You can also change the color of the geofence by selecting the pre-selected colors from the drop down menu.
  6. After setting up your geofence, click on the save icon to save your geofence on the map.