Map

Map Node

The map node displays the location of devices or groups of devices. It can show geofences and alert the end-user when devices enter or exit them. It can also determine the proximity between devices.

Adding a map node to your workflow

1. First, select your solution and navigate to Rayven Workflow.
2. Select ‘Visualizations’ from the left-hand panel.
3. Find the Map node and drag it onto the canvas.
4. Connect the Map node to your input node.
5. Double click on the Map node to open its configuration window.

Configuring your Map node

1. Give your node a Name. Choose something simple that clearly explains its purpose. You must pick a name that has three or more characters.
2. Under the Input Data field, enter the field name within the incoming JSON payload that contains the data you want to display on the widget.
3. If you want, add a Widget Subtitle. This additional text helps explain the data presented by the node to the end-user. It will appear under the Widget Name in a smaller font. 
4. Ticking the Device/Device Label Name checkbox will display the device or label name on the widget.
5. Select a Map Type:
   • Singular Map: Displays a single device on the map. This option is best if you want to display device-level tabs. If you configure multiple devices to input into the map node, a separate widget will appear for each. 
   • Group Map: Displays all devices in a group or groups on the map.
   • Singular with geofencing: Displays a single device map with the added ability to set geofences and buffers and track the device location around those fences and buffers.
   • Group map with geofencing: Displays a group map with the added ability to set geofences and buffers and track the location of devices around those fences and buffers.
   • Proximity: Displays a group map with the added ability to track the proximity of devices to each other.
6. Choose how you want the map to appear:
   • Map: provides a clean cartographic display with street and suburb names.
   • Satellite: provides additional satellite imagery. Useful for mining, rural, and regional applications.
7. You have the option to set a Default Latitude and Longitude. If you enter coordinates, the map will open centered on this location.
8. You can enter a Default Zoom for your map. You must enter the magnitude as a number between 1 and twenty: usually, this will be between twelve and sixteen. 
9. Alternatively, select the Auto Zoom checkbox. This option will override any Default Zoom set, automatically adjusting the magnitude to show all devices. 
10. Select Show Cluster if you want to group nearby map icons into clusters. If you leave this option blank, all map icons will appear individually, regardless of the map zoom level. 
11. Uploading a map icon is optional and will override the default icon. Add an icon by clicking 'upload icon' and selecting a file from the browser. Any map icon set in the device, device filter, or 'Before Triggers' section of the node will override the selection you make here. See below for further information. 

Setting the location

These fields can be left blank when using device metadata but are required if you are using data from a JSON object.

1. Under Latitude Field Name, enter the field in the input payload containing the device latitude data. 
2. Under Longitude Field Name, enter the field in the input payload containing the device longitude data.
3. You can also change how much of the map the widget will display by entering the name of the input field with your chosen Zoom Factor.

Before triggers

Before triggers enable a workflow to change the presentation of a device depending on the value(s) of field(s) in the input payload. You can add multiple fields to test by clicking '⊕ Add before trigger'. Providing a Node ID for additional data will allow the workflow to take said node's geofence configurations.

To set a before trigger: 

1. Enter the name of the input field you want to evaluate. 
2. Set the evaluation comparator. For example =, <, >.
3. Enter the value you want to assess against the input data.
4. Click the upload icon button and select an image from the file browser. 
5. Set your Valid condition from the dropdown menu to determine if the cluster color will change based on a valid result of the before trigger. 
   • For example: If 'device_value' > 100, then show [alert icon].

Inside triggers

If you have selected a map type containing geofencing, two new fields will appear in the JSON: 'geo_value" and 'geo_name'. Inside triggers enable the map node to change how a device is presented based on its position relative to buffers and geofences.

You can add multiple conditional fields to test by clicking '⊕ Add inside a map trigger'. 

To set an inside trigger:

1. Select a conditionfrom the dropdown list:
   • Inside fence: the device is inside a geofence.
   • Inside buffer zone: the device is near the edge of a geofence.
   • Inside danger zone: the device is almost out of a geofence.
   • Outside fence violation: the device is outside a fence.
2. Select the corresponding icon you want the map widget to display using the file browser.

Configuring labels

The map node displays a label with the corresponding device ID when a user hovers over a map icon. You can modify this to remove the device ID if desired. You can also add fields for displaying label variables in real-time.

To configure a label: 

1. Decide if you want the device name shown in the tooltip. This box is by default checked.
   • When checked, the label will display the device ID.
   • If unchecked, the label will show the other selected label fields but not the device ID.
   • If you uncheck this box and don't enter any other label fields, there will be no label when hovering over an icon. 
2. Enter a Display Name to set a name for all devices or device filters on the tooltip. 
3. If you select Show last event date in Tooltip, the label will display the timestamp for the last received event or payload.
4. You can then configure other variables to appear on the label. Enter a name for the item you want to be displayed when the cursor is hovering. Then enter the name of the field in the input payload that contains the data for this variable. To display multiple fields, click '⊕ Add Label Item'.
   

Linking to other dashboards

You can configure your Map node so end users can view a linked dashboard by clicking on an icon. This feature is handy for drilling down into detailed information about a device.

For a dashboard to appear in the dropdown list, you must first have saved at least one in the Dashboards section of the Workspace. See Section 3.4: Dashboards for more information. 

Refreshing widget data

Select the refresh tickbox to configure a refresh rate for your map widget. This interval must be entered in seconds and as an integer. The minimum value is 30.

Grouping by device label

You will need to save at least one label in the Device Labels section of the Workspace before configuring this section. See Creating Device Labels and Configuring Nodes Using Labels for more information.

1. Enter your chosen label under Device Label Name.
2. Select a method for grouping the widgets on the dashboard from the dropdown options:
   • No Grouping (widget per device) will create a unique widget for each device.
   • Group by device label value (widget per label value) will create a unique widget for each unique label value. For example, if the device label is ‘Color’ and the label values are ‘Green’ and ‘Gold’, the dashboard will display two widgets. One will show data for devices labeled ‘Green’, and the other for devices labeled ‘Gold’.
   • Group by device label name (one widget) will display only one widget. It will contain data from all devices with the device label specified.
3. Choose whether to Show Devices or Show Device Label Values on your map node using the Show on Map field.

See Also: Creating a dashboard, Creating device labels, Configuring nodes using labels
As of Release: 10.02.2022