Documente Academic
Documente Profesional
Documente Cultură
VehicleTracker
Application Manual
Version: 2.3
Rev: 1.0
DRAFT
GpsGate VehicleTracker Application Manual
Version: 2.3 - Rev: 1.0
Table of Contents
1 Introduction.............................................................................................................................................4
1.1 Recommended Web Browsers...............................................................................................................................4
2 Panels & User Interface..........................................................................................................................5
2.1 Main Menu..............................................................................................................................................................5
2.2 Map Display Options..............................................................................................................................................6
2.2.1 Google Map Features..............................................................................................................................................................6
2.3 Vehicle Management Panel....................................................................................................................................7
2.3.1 Vehicle Info Tab.......................................................................................................................................................................7
2.3.2 Status Tab................................................................................................................................................................................7
2.3.3 Commands Tab.......................................................................................................................................................................7
2.4 Alarm & Geofence Panel .......................................................................................................................................7
2.4.1 Alarms Tab...............................................................................................................................................................................7
2.4.2 Geofence Tab..........................................................................................................................................................................8
2.5 Vehicle and Track Panels.......................................................................................................................................8
2.5.1 Vehicle Panel Settings.............................................................................................................................................................8
3 Managing Operators and Vehicles......................................................................................................10
3.1 User types............................................................................................................................................................10
3.1.1 Vehicles.................................................................................................................................................................................10
3.1.2 Operators...............................................................................................................................................................................10
3.1.3 Application Administrators.....................................................................................................................................................10
3.2 Adding Operators.................................................................................................................................................10
3.3 Adding Vehicles....................................................................................................................................................12
3.4 Account Settings...................................................................................................................................................13
3.4.1 Devices..................................................................................................................................................................................13
3.4.2 Track Recorder......................................................................................................................................................................14
3.4.3 Tags.......................................................................................................................................................................................16
3.4.4 Marker Color..........................................................................................................................................................................16
4 Drawing Tracks and Displaying Status Signals.................................................................................17
4.1 Selecting Tracks...................................................................................................................................................17
4.2 Drawing Tracks.....................................................................................................................................................17
4.2.1 Track settings.........................................................................................................................................................................18
4.2.2 Advanced Filters....................................................................................................................................................................19
4.3 Showing Status Signals........................................................................................................................................19
5 Working with Geofences......................................................................................................................20
5.1 Geofence Creation...............................................................................................................................................20
5.2 Geofence Editing..................................................................................................................................................21
6 Tags and Views.....................................................................................................................................22
6.1 Manage Tags........................................................................................................................................................22
6.2 Manage Views......................................................................................................................................................23
7 Sending Commands to Devices..........................................................................................................25
7.1 Template Commands............................................................................................................................................25
8 Workspaces...........................................................................................................................................26
8.1 Adding a Workspace............................................................................................................................................26
8.2 Deleting a Workspace..........................................................................................................................................26
8.3 Public Workspaces...............................................................................................................................................27
9 Device Mappers....................................................................................................................................28
9.1 Device Mapper.....................................................................................................................................................28
10 Event Rules...........................................................................................................................................30
10.1 Event Rule Configuration.....................................................................................................................................30
10.2 Editing Event Rules..............................................................................................................................................33
11 Reports..................................................................................................................................................34
11.1 Distance Report Templates..................................................................................................................................35
11.1.1 Sample Distance Report........................................................................................................................................................36
11.2 Event Rule Report Templates...............................................................................................................................37
11.2.1 Sample Event Rule Report....................................................................................................................................................38
12 Exporting track data.............................................................................................................................39
12.1 Using the Export Window.....................................................................................................................................39
12.2 Exporting from the Map View...............................................................................................................................40
1 Introduction
Welcome to the GpsGate VehicleTracker Application Manual!
VehicleTracker is a web based application for real time vehicle tracking and fleet status
management. You can view your fleet, manage and create reports with a standard web browser. You
can also get notifications over email and SMS for all events in the application. You can view your
vehicles and follow up on alerts in any mobile phone with a web browser. You can relax now.
As an Operator you can manage vehicles and work with different workspaces for different tasks.
Each operator has a personal account and access rights are defined for each operator for a set of
vehicles. A an Application Administrator you can also access administrative functions to configure
application behavior and adjust the look-and-feel of the interface.
This guide mainly covers user functionality in GpsGate VehicleTracker. If you need any additional
information, please ask your GpsGate Server Site Administrator for help.
Thank you for using GpsGate VehicleTracker!
Note: Multiple Workspaces can be created where panels are moved and re-sized. Therefore your
actual user interface might differ from the pictures in is manual.
Reports View reports and create new ones. Export vehicle data as KML or CSV files
Admin Manage users and vehicles. (only available for Application Administrators)
Settings Select languages, measurement settings, track filtering options, application layout
and change your own password
Maps Choose between your maps if you have installed more than one map
You can close an open alarm by clicking on the “Close alarm”-button on the right side of the
desired alarm. Click on the arrow on the left side of your alarm to get more information.
The focal point for vehicle management operations is the Vehicle Panel containing the list of
vehicles, there you see the Users and Vehicles in the current view. By default it shows the Vehicle
Name, the time it was last seen, one check-box for Tracks and one for Show/Not show.
You select a User/Vehicle either by clicking on it on the map, or in the Vehicle list in the Vehicles
panel. A selected User/Vehicle will be marked in green on the map and highlighted in bold in the
Vehicle list.
• Last seen – time stamp for the last valid position update
• Track – the check-box for selecting tracks for a vehicle
• Show – the check-box for showing a vehicle
• Status – the vehicle connection status icons
• Last connection – time stamp for the last server connection
• Protocol – the protocol used by the device (HTTP, TCP, SMS,...)
• Speed – vehicle speed at last update
• Description – vehicle description
Above the Vehicle panel there is a Search-function where you can make free-text searches for your
Operators/Vehicles by Login ID or Vehicle name.
User type Send tracking data Viewing rights Administration Act on alarms Geofence
rights
Administrator Yes Yes Yes Yes Create/Edit
Operator Yes Yes - Yes View
Vehicle Yes - - - -
3.1.1 Vehicles
Vehicles are users that can send tracking information to GpsGate Server. These users can not login
to the VehicleTracker user interface. Normally this user type is selected for vehicle mounted
tracking devices.
3.1.2 Operators
In addition to the Vehicle functionality Operators are able to login to the VehicleTracker user
interface to view vehicles, draw tracks, export track data in KML and CSV formats, generate
different reports and act on alarms.
Click “Next” to continue and select whether you want this Operator to have Admin rights or not.
Click “Next” to continue and select the tags you want to associate with the user. You can also create
new tags at this point.
Click “Next” to continue. Select “Finish” to save the Operator or “Configure device” to move
directly to the device configuration step.
Please move on to chapter 3.4 “Account Settings” for information on Device configuration, Track
Recorder, Tags and Markers for the user.
Although a Vehicle can not login to the VehicleTracker user interface, you still have to give it a
Login ID and Password as that can be used for authentication for example if you have GpsGate
Client installed in your vehicles.
Click “Next” to continue and select the tags you want to associate with the user. You can also create
new tags at this point.
Click “Next” to continue. Select “Finish” to save the vehicle or “Configure device” to move directly
to the device configuration step..
Please move on to chapter 3.4 “Account Settings” to configure Devices, Track Recorder, Tags and
Markers for the Vehicle.
3.4.1 Devices
You can configure GPS tracking devices to both Vehicles and Operators.
You can enter the following information for a device:
Device name A description of your device
Update Interval The time required between two position updates to create a new Track
(new track)
Update distance The distance required between two position updates to create a new Track
(new track)
Restart Interval The maximum length of a Track (useful for devices that are rarely turned off)
UTC Offset Offset for the Restart interval (e.g. +2 initiates the Restart Interval at Midnight
in the UTC+2 time zone)
Update Interval The time between two position updates. Used both for position recording and
(new position) device configuration for supported devices.
SMS Update The time between two position updated when using tracking over SMS.
Interval
(new position)
Update Distance The minimum distance between two position updates to make recording. Used
(new position) for position recording.
Speed change Speed change required to trigger position recording.
(new position)
Direction change Minimum direction change to trigger position recording.
and movement Minimum movement, used together with ”Direction change”
3.4.3 Tags
Tags are used to associate users to different groups in VehicleTracker. You can add a Tag to a user
by selecting it in the list below. You can also create a new Tag by writing a Tag name and clicking
“Add new Tag”.
Read more about how Tags work in Chapter 6 “Tags and Views”.
You can select an individual track point in a track either by clicking on it on the map, or by clicking
on it in the Track point list. You remove the tracks drawn on the map by clicking the icon next
to the Draw Tracks-button.
● Show polyline
Select this option to connect all the track points in a track with a solid line.
● Show points
Select this option to show markers with direction arrows on the track points.
To show a bread crumb trail you should enable this option without the
polyline option above.
● Show Fatpoints
Select this option to show “Fatpoints” where the vehicle has been idle. A
Fatpoint also includes information on the length of the stop.
● Zoom to fit
Select this option to zoom in on the selected tracks when drawing and re-drawing them. You
should un-check this option if you have zoomed in on a part of the selected tracks and you
wish to re-draw them without changing the zoom level and position of the map.
The red circle that appears on the map is the Geofence boundary. Click on the circle center and drag
it to the right place on the map. You can click and drag on the circle border to increase or decrease
The Tag Manager is divided into two sections. The upper area lists the tags currently defined in the
system. The lower area is used to add new or edit existing Tags.
You can enter the following information for a tag:
Name The name of the Tag
The View Manager is divided into two sections. The upper area lists the Views currently defined in
the system. The lower area is used to add new or edit existing Views.
You can enter the following information for a view:
Match all: A user has to have all selected tags to fit the view
Match any: A user has to have at least one of the selected tags to fit the view
Poll position Sends a request to the device for a single position update
Start tracking Starts tracking with the selected tracking method with the current Update
interval. The Update interval can be changed in the Track Recorder settings
8 Workspaces
A Workspace is a specific layout of the VehicleTracker user interface. You can have multiple
Workspaces with different layouts for different tasks.
A Workspace keeps track of the following information:
• Panel positions and sizes
• Columns visible in lists (e.g. the Vehicle list)
• Sort order in lists
• Current View
Note: VehicleTracker has a Default Workspace that you can always go back to.
Note: If you select Save when you are using the Default Workspace you will be prompted for a
name as the Default Workspace can not be over written.
9 Device Mappers
Note: This chapter is mainly aimed at Application Administrators.
VehicleTracker can handle status messages and alarms from supported devices. Device specific
messages are mapped to GpsGate messages using Device Mappers for each device type.
Device specific inputs are mapped to the common GpsGate message format. For example: the
message “SOS Alarm“ can be different for different devices, such as: “SOS”, “SOS Button”,
“Alarm1”, “Input1”, “In1”. The Device Mapper is used to transform these device specific messages
to a GpsGate “SOS Alarm” message.
For example: If your vehicle tracking device sends fuel level represented as 0 – 255 for 0 to
70 liters your multiplier should be set to 70/255 = 0.2745098. This way the GpsGate “Fuel
level” message will contain the actual fuel level in liters. The constant can be used to add an
offset to the value.
Note: You can add several Device Mappers for one device type. For example you would want to do
this if you have two types of trucks with different fuel tank volumes or different fuel level meters.
Note: When you add devices to your system you can select one Device Mapper for each device.
The picture below shows a list of device mappers.
The picture below shows a sample device mapper for the StarsNav Rover device.
10 Event Rules
Note: This chapter is mainly aimed at Application Administrators.
Event Rules decide under which conditions incoming messages should create alerts and how they
should be handled in VehicleTracker.
This approach enables flexible implementations where alarm monitoring can be customized to
include exactly the right messages.
Click on “Add new Event Rule” to create a new event rule. The wizard below opens to assist in the
process.
Give the rule a name and description and click “Next” to configure who the rule applies for.
Select the tags that you want to include in the rule and click “Next”.
A rule can either be active at all times or at certain time periods such as weekends or office hours.
Leave the rule as “Always active” or set a specific schedule for the rule and click “Next”.
An event rule is evaluated using expressions. You can add multiple expressions to a rule. The table
below describes the available expression characteristics.
Match all or Select if all conditions should be true, or if one is enough to make the event
Match any true. In other words, decide if your rule is an AND or OR rule.
Analog Analog Expressions let you create an expression for analog inputs. The
Expression expression compares the input value to the value you set. To use this expression
you need to map an analog input from your device to a GpsGate variable using
the Device Mapper.
Changes Changes Expressions let you create an expression based the change over time
Expression or distance for an input. You can for example detect a rapid temperature change
or fuel loss. To use this expression you need to map an analog input from your
Digital Digital Expressions let you create create an expression for digital inputs. The
Expression expression compares the input value to the value you set. To use this expression
you need to map an analog input from your device to a GpsGate variable using
the Device Mapper.
Geofence Geofence Tag
Expression
An event can be triggered immediately when the expressions are evaluated as true, or after a set
delay. Delayed events are used to fulfill conditions such as “Create an alert if a vehicle has its
engine on for more than 30 minutes without moving”.
Leave the event as an Immediate event, or add a delay if appropriate and click “Next” to setup
notifications.
Application Events can be displayed in the Alarm panel or just be stored in the database
Icon The Icon notifier creates an additional column in the Vehicle list for real time event
status monitoring. The column gets a green or red icon or is left blank depending on
the event status.
email The email notifier is used to send emails. The email can contain template variables
(as shown in the picture above). Variables include event details and map links.
When you are done adding notifiers, click “Next” and Save the event rule.
11 Reports
VehicleTracker Reports are found on the “Reports” tab in the “Reports”-menu. To generate a report
you click on a report name in the list of reports. Currently the following report types are available in
VehicleTracker: “Distance Report”, “Distance Report (detailed)” and “Event rule report”. They
are explained in more detail below.
The reports in the list are created from report templates that are created by your application
administrator. Before you have created any report templates the “Reports” tab looks like the picture
below.
When reports have been added to the application they are listed on the “Reports” tab for easy
selection. The “Reports” tab can look like this.
To generate a report you select it from the list. By default the report is shown for the “current” time
period (e.g. today, this week or this month). You can step backwards and forwards in time with the
“Previous” and “Next” buttons in the report header.
You can click the “Print” button to open the reports in a new window for printing.
You can click the address-links in the detailed report to show the start and stop positions for each
trip on a Google map (this requires an Internet connection).
If you select “Weekly” or “Monthly” you also get to select what days to include in the report:
If you select the “Custom period” you can set the actual start and stop dates for the report:
Exporting from the map view page is done by clicking on the “Export” -button in the Track points
list. You export the tracks that are listed in the Track points list, and shown on the map if you have
drawn them. All time stamps are exported in UTC (Universal Time Coordinated) format.
With the split-button menu next to the “Export” button you can select either KML or CSV as the
export format.
Note: The columns currently displayed in the Track points list are exported. Use the “Select
Columns” icon to the right of the Track points list header to select the Status Massage fields you
want to include in the export.
You can export your current selected View as a live KML feed and use it in for example Google
Earth. Click on the KML icon next to the View selector. Press the “Mark URL” -button to high light
the URL to the KML feed. Then use CTRL+C to copy the URL. You can also Save the KML file by
using the “Save as” -button.
13 Application Settings
Under the Settings link in the top menu you can select the Language file of choice, change the
Measurements you want the user interface to display (Metric/EN-US/Nautic) and change your
password.
You can set the minimum time required for a fatpoint (stand still) to be displayed on the map. You
can use this setting to filter out short Fatpoints that you do not want to see.
To enable Track filtering, you check the “Use filtered reader”. This adds Fatpoints and re-calculates
the Track length to better depict the actual movement of the GPS device.
Note: The original Tracks are kept so you can un-check Track filtering at any time to see the raw
un-filtered Track data.
13.3 Localization
Under the “Localization” tab on the Settings menu you can change your preferred language and the
measurements you want your application to use.
Ask you GpsGate Server Site Administrator for help if you would like to add more languages to
your application.
13.4 Style
The “Style” tab contains settings for the number of vehicles that you want to have in the vehicle list
to the right of the map. The default setting is 10 vehicles.
You also have options for map marker style and conntent.
14 Map Selection
In the Maps menu you can choose between the maps available to your VehicleTracker application.
Ask your GpsGate Server Site Administrator if you want to add custom maps to your application.
15 Plug-ins
Note: This chapter is mainly aimed at Application Administrators.
GpsGate VehicleTracker supports plug-ins for easy application extension. The following plug-ins
are supplied with the application in the current version.
Google StreetView Window Adds a floating window with Google map and Google StreetView
for the selected vehicle
OpenLayers Map Plug-in Enables OpenaLayers plugin for OpenLayers, Yahoo, Bing and
Google Maps
Terminal Window Adds a floating windows with the Terminal to analyze traffic
between the server and the device for the selected vehicle
Note: Please contact us at support@gpsgate.com if you have a device you would like us to support!