Comment on page

Configuration

This section explains each of the properties in the configuration blade.
General
Property
Description
Collection
This associates the Agent to a specific Collection (default to that of the current Data Stream).
Refer to Collections and Stream Hosts to understand more about Collections.
Settings
Property
Description
Source
The source of the geofence definition can be either Dynamic (read from the geofence input payload) or Static (read from an uploaded CSV file).
Geofence Latitude Column
The column or attribute of the geofence input payload that represents the geofence's Latitude value (applies to Dynamic source only). 
Geofence Longitude Column
The column or attribute of the geofence input payload that represents the geofence's Longitude value (applies to Dynamic source only). 
Geofence File
A CSV file of Latitude and Longitude pairs, an example can be found here (applies to Static source only). 
Latitude Column
The column or attribute of the input payload that represents the Latitude value of the position to be evaluated.
Longitude Column
The column or attribute of the input payload that represents the Longitude value of the position to be evaluated.
Both Latitude and Longitude values are required to be a double or decimal point number.
Before configuring the Function, please ensure that its input endpoint is connected to a parent Agent which will be sending data to it.
Endpoints
Name
Description
Geofence_Input
This (optional) endpoint is used to receive dynamic batched geofence data (applies to Dynamic source only).
Input
This endpoint is used to receive position data from the parent (input) Agent on which the geofence is evaluated.
Output
Events received from the parent (input) Agent are made available to this endpoint, with an attribute InsideGeoFence <boolean> appended to the original event. This boolean is true if a given position is inside the geofence.

Property	Description
Collection	This associates the Agent to a specific Collection (default to that of the current Data Stream).

Property	Description
Source	The source of the geofence definition can be either Dynamic (read from the geofence input payload) or Static (read from an uploaded CSV file).
Geofence Latitude Column	The column or attribute of the geofence input payload that represents the geofence's Latitude value (applies to Dynamic source only).
Geofence Longitude Column	The column or attribute of the geofence input payload that represents the geofence's Longitude value (applies to Dynamic source only).
Geofence File	A CSV file of Latitude and Longitude pairs, an example can be found here (applies to Static source only).
Latitude Column	The column or attribute of the input payload that represents the Latitude value of the position to be evaluated.
Longitude Column	The column or attribute of the input payload that represents the Longitude value of the position to be evaluated.

Name	Description
Geofence_Input	This (optional) endpoint is used to receive dynamic batched geofence data (applies to Dynamic source only).
Input	This endpoint is used to receive position data from the parent (input) Agent on which the geofence is evaluated.
Output	Events received from the parent (input) Agent are made available to this endpoint, with an attribute InsideGeoFence <boolean> appended to the original event. This boolean is true if a given position is inside the geofence.

How to use? - Previous

Examples

Next - How to use?

Release Notes

Last modified 1yr ago