User avatar
juanjogpsgate
GpsGate
Posts: 25
Joined: Wed Oct 08, 2014 12:49 pm
Location: Sweden
Contact: Website

Event Rules: variables list with description

Fri Sep 04, 2015 4:47 pm

Event Rule / Notifier variables

With this post we intend to describe the variables you can find by default in your Vehicle Tracker for your Event Rules notifications (Argument, Report Arguments, SMS, Email and Text notifications).

The format is the following:

Variable label | Variable name | Description

-- GENERIC variables (apply to all the Expressions in an Event Rule)

Rule name | [RULE_NAME] | The event rule name defined in the vehicle tracker interface
Trigger time | [EVENT_TIME] | The local time when the rule has been triggered
Event duration | [EVENT_DURATION] | The duration of the event until has reached its end state
Vehicle login id | [USER_USERNAME] | The username of the unit that generated the event defined in Details
Vehicle name | [USER_NAME] | The name assigned to the unit defined in Details
Vehicle description | [USER_DESCRIPTION] | The vehicle description assigned defined in Details
Application name | [APPLICATION_NAME] | The name of the application where the Event Rule has been executed
Position timestamp | [POS_TIME] | The time of the last valid/invalid position when the event occurred
Last valid Position time | [POS_TIME_LAST_VALID] | The time of the last valid position when the event occurred
Latitude | [POS_LATITUDE] | Latitude of the last position when the event occurred expressed in Signed degrees format
Longitude | [POS_LONGITUDE] | Longitude of the last position when the event occurred expressed in Signed degrees format
Heading | [POS_HEADIGN] | The heading in degrees of the vehicle at the moment of the event
Address | [POS_ADDRESS] | Address of the last valid position registered (geocoder dependent)
Mobile application login | http://vm-juanjo/GpsGateServer/vt/[MOBILE_ALARM_PAGE]?h|[_TMP_CREDENTIALS] | A link with the summary of the current events
Map link | http://maps.google.com?q|[POS_LATITUDE],[POS_LONGITUDE] | Google map link to the position where the event occurred.

-- DRIVER VARIABLES: the following variables will be displayed only when a vehicle generates an event, the proper Event Rule has been setup for Driver Identification and the Driver identified correctly in the platform (http://gpsgate.com/blogComment/how_to_add_a_driver_to_gpsgate)

Driver user ID | [DRIVER_USER_ID] | The driver unique identifier in the database
Driver ID | [DRIVER_ID] | The driver ID defined in the Driver Info property.
Driver name | [DRIVER_NAME] | The driver name defined in the Details of the driver.
Driver login id | [DRIVER_USERNAME] | The driver username defined in the Details of the driver.
Driver description | [DRIVER_DESCRIPTION] | The driver description defined in the Details of the driver.

-- VEHICLE variables: the following variables will be displayed only when the Driver is the one who triggers the event --

Assigned Vehicle Name | [ASSIGNED_VEHICLE_NAME] | The vehicle name assigned to the driver
Assigned Vehicle Username | [ASSIGNED_VEHICLE_USERNAME] | The vehicle username assigned to the driver
Assigned Vehicle ID | [ASSIGNED_VEHICLE_ID] | The ID of the vehicle in the database
Assigned Vehicle description | [ASSIGNED_VEHICLE_DESC] | The vehicle description

-- GEOFENCE variables: the following variables will be available when you select "4. Expression" a Geofence.

Geofence | [GEOFENCE_NAME] | The name of the geofence given
Geofence ID | [GEOFENCE_ID] | The ID of the geofence in the database

-- INTERVAL EVENTS variables: the following variables will be available when you select "4. Expression" Interval Event.

Interval kind | [Interval kind] | CustomPeriodic (unique value)
Current interval start value | [Current interval start value] | The value that will start the next interval event
Next interval start value: | [Next interval start value] | The value of the next start increment in your interval
Initial start value | [Initial start value] | The initial value set on the Event Rule
Interval size | [Interval size] | The interval size number set in the Event Rule

-- TIME INTERVALS variables: the following variables will be available when you select "4. Expression" Time Interval.

Time interval kind | [Time interval kind] | The time interval set in the Event Rule
Initial start time | [Initial start time] | The initial time interval set in the Event Rule
Current interval start time | [Current interval start time] | The current interval start time
Custom time interval length | [Custom time interval length] | The length of the custom time interval set in the rule
Next interval start time | [Next interval start time] | The next time interval
DateTimeServer | [_DateTimeServer] | The date & time of the server localized

-- POINTS OF INTEREST variables: the following variables will be available when you activate in Privileges and Features -> Point of Interests in your application and select "4. Expression" Points of Interest.

POI ID | [POI_ID] | The ID of the POI in the database
POI NAME | [POI_NAME] | The name set when creating the POI
POI DESCRIPTION | [POI_DESCRIPTION] | The description set when creating the POI
POI Category name | [POI_CATEGORY_NAME] | The name of the category where the POI was created into
POI Category description | [POI_CATEGORY_DESCRIPTION] | The description of the POI category

-- SPEEDING EXPRESSION variables: the following variables will be available when you activate the plugin Speeding Expression in your application and select "4. Expression" Speeding Expression.

How to steup the Speeding Expression plugin follow this guide: http://gpsgate.com/blogComment/speeding_expression

Speed Limit | [SPEEDING_SPEED_LIMIT] | The speed limit used during the evaluation of the Event Rule
Road Cateogory | [SPEEDING_ROAD_CATEGORY] | The road category such as Motorway or Primary road
Is Speed Limit Fallback | [SPEEDING_IS_SPEED_FALLBACK] | True if the speed limit used was a fallback value, otherwise false (data taken from OSM)

There are functions that you can include in order to get more information: $MAX, $MIN, $START, $FINAL and $END. By default the value that the variable gets is the one that triggers the event which would be the $START function. In order to use them just add them on the Report Argument when selecting the variable according to the convention: $FUNCTION([VARIABLE]).

$FINAL() is empty on an ongoing event, and the end value when the event finish. $END is the last value of on ongoing event, and the end value when the event finish.

Example: $MIN([SIGNAL_SPEED])

Reglo
Posts: 66
Joined: Wed May 27, 2015 9:09 am
Location: USA

RE: Event Rules: variables list with description

Wed Sep 09, 2015 6:18 am

Thanks for this list.

Geofence | [GEOFENCE_NAME] | The name of the Tag assigned to the geofence

I have found that [GEOFENCE_NAME] references the actual name given to the geofence, not its tag.

Incidentally - this variable often does not resolve correctly in notifications. In one email notification it will be missing, and in the next notification the geofence name will display as expected.

Reglo

User avatar
juanjogpsgate
GpsGate
Posts: 25
Joined: Wed Oct 08, 2014 12:49 pm
Location: Sweden
Contact: Website

RE: Event Rules: variables list with description

Thu Sep 10, 2015 7:00 pm

Thanks for your reply. I corrected the mistake. If you keep experiencing problems as you mention, send an email to support@gpsgate.com.

Originally posted by Reglo

Thanks for this list.

Geofence | [GEOFENCE_NAME] | The name of the Tag assigned to the geofence

I have found that [GEOFENCE_NAME] references the actual name given to the geofence, not its tag.

Incidentally - this variable often does not resolve correctly in notifications. In one email notification it will be missing, and in the next notification the geofence name will display as expected.

Reglo


piter197
Posts: 820
Joined: Sun Jan 09, 2011 3:32 am

RE: Event Rules: variables list with description

Fri Sep 11, 2015 7:39 am

Hi,

Map link | http://maps.google.com?q|[POS_LATITUDE],[POS_LONGITUDE] | Google map link to the position where the event occurred.

I think google maps now no longer use http but now use https.

The Google map new link format https://www.google.com/maps/@[POS_LATIT ... TUDE],zoom level

like https://www.google.com/maps/@-7.777924,110.336294,16z

where zoom level from 3z (world view) to 21z (detail zoom).

Best Regards,
piter197

User avatar
juanjogpsgate
GpsGate
Posts: 25
Joined: Wed Oct 08, 2014 12:49 pm
Location: Sweden
Contact: Website

RE: Event Rules: variables list with description

Mon Sep 21, 2015 6:44 pm

Added the new Speeding Expression variables.

http://gpsgate.com/blogComment/speeding_expression

Regards.

joeroot
Posts: 1
Joined: Wed Jul 19, 2017 9:28 pm

Re: Event Rules: variables list with description

Wed Jul 19, 2017 9:33 pm

The format is the following:

Variable label | Variable name | Description

Return to “GpsGate for Developers”