100% found this document useful (1 vote)
186 views

Admin S Guide GpsGate

This document provides an overview and instructions for using an administrative interface called VehicleTracker. It covers main features like map view, vehicle tracking, points of interest, and administrative tools for managing users and settings. The guide is intended for administrators to understand and manage the system.

Uploaded by

Filimone Thumbo
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
100% found this document useful (1 vote)
186 views

Admin S Guide GpsGate

This document provides an overview and instructions for using an administrative interface called VehicleTracker. It covers main features like map view, vehicle tracking, points of interest, and administrative tools for managing users and settings. The guide is intended for administrators to understand and manage the system.

Uploaded by

Filimone Thumbo
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 58

ADMIN'S GUIDE

© 2013 GpsGate AB
Contents

Chapter 1 1 Introduction
2 Overview
Chapter 2 3 Map view
4 Points of Interest
6 Vehicles
8 Drawing tracks
11 Alarms
13 Status
14 Vehicle info
15 Commands
17 Tags and Views
18 Settings
20 Workspaces
22 Maps
Chapter 3 24 Geofences
Chapter 4 26 Driver Journal
Chapter 5 28 Reporting
30 Adding a report
Chapter 6 32 GpsGate Mobile
Chapter 7 35 Admin
36 Users
39 Device Mappers
40 Advanced
41 Event Rules
44 Notifiers
47 Advanced
48 Tags
50 Views
52 Roles

2
Introduction 1
Welcome to VehicleTracker - the system for tracking your GPS Devices.

As an Administrator you can manage Operators, Event Rules and more. This manual covers both the
common functionality as well as administrative tasks.

Recommended web browsers


We recommend that you use a major, updated, web browser for the best experience: Firefox 3 or later /
Internet Explorer 7 or later. The system does, however, also support Internet Explorer 6, Opera 9, Safari
3.1 and Google Chrome.

Terminology

Device
The GPS tracker device(s) you're using with GpsGate Server.

Vehicle
Often we refer to a vehicle as the object you're using devices to track.
You can of course track anything, but for the purpose of this manual we use the term vehicle, or
simply device.

Application
This is usually your organization or unit. If you have access to more than one Application you get to
choose which to log in to after you've entered your username and password.

SiteAdmin
The GpsGate Server administrator has access to the SiteAdmin web site. This is the main
administration site where for example Applications, Plugins and Report templates are managed.

Learn more:
Overview
Map view
Reporting
Admin

Chapter 1 Introduction
1
Introduction 1
Overview
Main menu
At the top of the page you'll find the main menu, which contains some or all of the below (depending on
your installation). Click to read more about each topic:

Map view - the start page


Reports - view and create reports for print / export / mail.
Admin - if you're an administrator, you can manage the Application here (such as Users).
Settings - change password and personal display settings
Workspace - change or create a Work space
Maps - change map if you have more than one available
Help - support options
Logout - log out of the system

M ap View and Workspace


When logging in to the system, the default Map view is displayed.

The Map view interface is made up of a map surrounded by multiple lists that can be freely moved
around and re-sized. Any set of lists can be saved as a custom Workspace. The Work space that
shows includes several lists:

Vehicles - a list of all your vehicles, connected or not.


Tracks - when a vehicle i selected (Track check box in Vehicles) a list of tracks are shown here
Track points will give you a breakdown of any selected track.
Vehicle Info, by default shown below the map, displays details about the selected vehicle

Note: multiple workspaces can be created where lists are moved and re-sized. Therefore your actual
user interface might differ from the pictures in is manual.

Chapter 1 Introduction
2
Map view 2
The first thing you see when logging in is the Map view. Let's take a look at how to work with the map.

M ap context menu
There is also a context menu in the map, that appears when you right click on any location:

Map context m enu

Zoom to street / city or region level will give you a better overview of the selected area.
Draw today's tracks, only appears when you right click on a vehicle and will display the vehicle's
path.

M ap Display Options
Between the main menu and the map you find the following options:

View - change active View.


Zoom to view - changing View will zoom the map to show all vehicles in that View.
Follow selected - the map will automatically center on the position of the vehicle selected in the
Vehicle list.
KML icon - used to generate a KML feed which can be used in for example Google Earth.
Center on click - like Follow selected, but when you click on a vehicle.
Show trace - this option will show a short red line after the vehicle you have selected in the Vehicle
list, the line represents the last 10 position updates for the vehicle.

Learn more:
Vehicles list
Track lists
Alarms
Status tab
Vehicle info
Commands
Tags and Views
Settings
Workspaces
Maps

Chapter 2 Map view


3
Map view 2
Points of Interest
Points of Interest is a VehicleTracker Plugin (the Administrator can install it), enabling you to view and
add POI's on the map. Depending on your configuration POI's may also cause alarms when vehicles
enter or leave them.

POI's on the m ap

Add POI on location


POI location are commonly imported to the system, rather than added manually. But you can however
right click on the map and add a POI at the current location:

The Add POI window is shown and you can give it a Title, Description (optional) and Category.
Choose New.... to add a category, if needed.

Chapter 2 Map view


4
Map view 2

Points of Interest list


By default (with the POI module installed), there should be a Points of Interest list in the bottom right of
the Map view. Here you are able to search, and Add POI (see above).

If this list is empty or no POI's show up on the map, click the Settings link to the left of Add poi:

Settings

Show labels - makes the POI labels always visible, as oppose to only appearing on mouse over.
Max map markers - limit how many POI markers are shown on the map
Categories - choose what categories to display on the list and on the map.

By default no categories are chosen. Make sure to select the appropriate categories and save these
settings in your Workspace. If you are not allowed to make changes in the Workspace, contact your
VehicleTracker administrator.

Chapter 2 Map view


5
Map view 2
Vehicles
A key part of the system is the Vehicle list. There you see the Users and Vehicles in the current view.
By default it shows the Name, the time it was last seen, one check box for Tracks and one for Show.

You select a vehicle either by clicking on it on the map, or in the Vehicle list in the Vehicles list. A
selected vehicle will be marked in green on the map and highlighted in bold in the Vehicle list.

Search user
In the top of the Vehicle list there is a Search function where you can make free text searches for your
Operators and Vehicles.

Sometimes the vehicle isn't included in the current view and the below message appears. Click Show
to include all users.

In the search result you will see how many hits each user got and can hover the user to see on what it
matched.

List Settings
In the list's upper right corner you'll find the column selector icon. Left click on this icon to choose what
columns to display.

Chapter 2 Map view


6
Map view 2

You can also reorder the columns using the right edge handle (dots).

The available columns are:

Vehicle color identifier – identifies the vehicle in the track list


Vehicle Name – the name of the vehicle
Login ID – the vehicle login id
Last seen – time stamp for the last valid position update
Track – the check-box for selecting tracks for a vehicle
Show vehicle on map – the check-box for showing a vehicle
Status – the vehicle connection status icons:
o Connected and sending position
o Connected but not sending position (it may take a while to get GPS fix)
o Not connected (no data for at least 10 minutes caused by for example sleep mode or ignition
off)
o Never been seen
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
Tag - tag(s) associated with this vehicle
Description – vehicle description

Learn more:
Tracks lists
Alarms
Status
Vehicle info
Commands
Tags and Views
Workspaces
Maps

Chapter 2 Map view


7
Map view 2
Drawing tracks
In this chapter we will look at the Track lists and how they're used to display vehicle tracks - both in the
lists and on the map.

Selecting tracks - Tracks list


You can show multiple tracks for multiple Operators/Vehicles at the same time on the map. First you
select the desired Operators/Vehicles by checking the Track box next to the name in the Vehicle list.
This will populate the Tracks list with the tracks of the selected Operators/Vehicles.
The default sort order is with the newest
track first, you can sort the lists in
another order by clicking the column
headers. You can limit the tracks you
wish to show by narrowing the start and
stop time stamps. By doing so you will
only display Tracks that have Track
points inside the selected time period.

To view a Track click on the check-box


in the Select column in the track list. This will open the Track points list and fill the track points list
with all the track points from the selected track.

You can also delete tracks in this list by clicking the delete icon ( ) to the right of a track.
If you have selected the Auto update points option all you changes in the Track s list will instantly
take effect in the Track Points list. If you are working with many tracks and Track Points at the same
time you can disable this function by clearing the check box. This will speed up load time. If you have
done this then use the Update button to load the track points into the Track Points list.

List Settings
In the upper right corner of the Track s list you'll find the column selector icon. Left click on this icon to
choose what columns to display.

Vehicle Color identifier - this will display a square to the left of each
track matching the vehicle color (see Vehicles list).
Track Color identifiers - adds a circle to the left of each track
matching the track segment color on map.
Name - vehicle name
Start - date and time the track began
Stop - date and time the track ended
Dist - track travel distance
Select - populates the Track points list
Del - shows the delete button (see above)

Drawing tracks - Track points list


When you select a track in the Tracks list it is opened the Track points list, where you see the individual
positions in the track.
Clicking on the Draw Tracks button will draw the chosen tracks on the map in different colors for each track.
There is also a button here for clearing all tracks from the map.

Chapter 2 Map view


8
Map view 2

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 clear tracks icon.

Track Settings
Next to the Draw tracks button you have a drop down menu . Clicking it displays options for track
drawing. Check the check box next to the specific option to enable it for track drawing:

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.

Advanced Filters
You can narrow down your search further based on different search criteria. This is done by expanding
the Advanced filters options found on top of the Track points list.
You have the options time, speed and altitude.

Chapter 2 Map view


9
Map view 2

By default the search options are disabled. You enable them by checking the check box to the right of
each field.

Live Filtering
When this option is enabled the Track Point list below will update directly when you change your
search criteria. If you are working on large amounts of data you have the option to disable the Live
Filtering by clearing the check-box and using the Apply Filter button to the right.

List Settings and Status Signals


In the upper right corner of the Track points list you'll find the column selector icon. Left click on this
icon to choose what columns to display.

Track color identifier – identifies the vehicle in the track list


Date – date
Time – time stamp
km/h – speed (shown in the selected unit)
Alt – altitude
Heading – heading in degrees
Lat – latitude
Lon – longitude
Valid – validity of the position update

Below the standard fields your available device signals are displayed (SOS,
Battery low etc). These vary depending on device used.

Learn more:
Alarms
Status tab
Vehicle info
Commands
Tags and Views
Settings
Workspaces
Maps

Chapter 2 Map view


10
Map view 2
Alarms
Alarms on the map
When an alarm occurs it is displayed on the map with a red radius at the location the alarm was
reported.

Alarm on the m ap

If there are multiple alarms in the same are and you are zoomed out a bit on the map (i.e normal zoom)
a cluster icon is shown with the number of active alarms in the middle.

Alarm Cluster (3 alarm s)

Zoom in to see the individual alarms.

Alarms list
Alarms has a normally collapsed list, by default below the map, with (no active alarms) in the title.

Once an alarm has activated, the Alarms list has (X active alarms) in its title (where X is the number
of active alarms).

In the Alarms list you can manage current alarms:

In the top of the list there's an option to Show all alarms and Zoom all alarms, to get a better
overview on the map.

To the right of Zoom all alarms button you'll find Close all. This will mark all alarms as managed, so
they don't show up on the map any more. You can also close them individually with the Close alarm
button to the far right.

Clicking the small black arrow to the left expands the alarm and shows details such as signal

Chapter 2 Map view


11
Map view 2
arguments.

Learn more:
Alarms
Status tab
Vehicle info
Commands
Tags and Views
Settings
Workspaces
Maps

Chapter 2 Map view


12
Map view 2
Status
By default shown right beneath the map in Map view, the Status tab will give you a detailed view of the
selected vehicle's signal messages. With the Status tab you can easily see current signals from the
device and when they occurred.

Learn more:
Vehicle info
Commands
Tags and Views
Settings
Workspaces
Maps

Chapter 2 Map view


13
Map view 2
Vehicle info
The Vehicle Info tab, by default shown below the map in Map view, shows information for the vehicle
currently selected in the Vehicles list. It displays information such as Latitude / Longitude, Speed,
Heading and when it was last updated.

Learn more:
Commands
Tags and Views
Settings
Workspaces
Maps

Chapter 2 Map view


14
Map view 2
Commands
The Commands tab, by default located beneath the map in Map view, contains device control and
configuration commands. It will show the commands available for the currently selected vehicle
(Vehicles list).

Here you can start and stop tracking and send a poll-position SMS to request a position from an off-line
device.

Sending Commands to Devices


With the Commands tab you can send commands to your devices:

1. Make sure the vehicle is selected in the Vehicles list.

2. Open the Commands tab (below the map).

3. Select device in the first drop down list and a command in the second one.

4. Click on the Execute button.

A progress bar is displayed and you can click Show status to get a more detailed view.

Note: If the device won't respond the progress bar will never complete, as it waits infinitely. In this case,
click on the Abort button.

Chapter 2 Map view


15
Map view 2
The application Administrator can control which commands are available (read more about Template
Commands below).
The following commands are available in a default installation for most devices:

Device setup Sends default setting to the device


Request position Sends a request to the device for a single position update
Start track ing Starts tracking with the selected tracking method with the current Update
interval. The Update interval can be changed in the Track Recorder settings
Stop track ing Stops tracking

Template commands
To add additional commands, see the Devices tab in SiteAdmin. For further information see the
SiteAdmin manual.

Learn more:
Tags and Views
Settings
Workspaces
Maps

Chapter 2 Map view


16
Map view 2
Tags and Views
Tags and Views are used to group vehicles and users. You can for example create a View based on
vehicle type (e.g. truck or taxi) or any other criteria (e.g. “West coast group”, “Subcontractor ACME” or
“Unit Managers”). This enhances the usability of VehicleTracker as the information on the map can
easily be kept relevant to the task at hand.

If you have any views available in your account they can be found in the top left of the map:

Simply choose a view in the drop down list and the map will be "filtered" according to the view settings.

If you are an administrator of VehicleTracker you can manage these tags.

Learn more:
Settings
Workspaces
Maps

Chapter 2 Map view


17
Map view 2
Settings
In the main menu you can access the Settings window.

General tab
On the General tab you can change your password. Simply Save when you're done.

Track visualization tab


On the Track visualization tab has settings for how vehicle tracks are shown on the map.

Fatpoint duration
The first setting determines how long a vehicle can idle on a position before it is considered a fatpoint.
Fatpoints are then visible on the map.

Use filtered reader


By default this check box is selected, which ensures that tracks are always current when drawn on
map.

Warning: deselecting this check box might make the tracks draw faster, but has them rely on nightly
updates and could cause inconsistencies.

Localization tab
On the Localization tab you can change language and measurement.
Your installation determines what languages are available and the GpsGate Server administrator can
manage languages.

Chapter 2 Map view


18
Map view 2

Style
Settings on the Style tab determines overall look and feel of VehicleTracker.

Marker settings
Settings for how vehicles are displayed on the map. By default they use an arrow marker and show
their Name in a label above the marker. Change this as you see fit.

Workspace Settings - Marker clustering


By default the map clustering feature will be used, but if you always want to see each individual vehicle
on the map, deselect the Enable vehicle marker clustering check box here and click Save.

Learn more:
Workspaces
Maps

Chapter 2 Map view


19
Map view 2
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:

list positions and sizes


Columns visible in list lists
Sort order in lists
Current View

VehicleTracker has a default Workspace that you can always go back to.

Save Workspace
You can save the state of the user interface as a Workspace at any time.

In the Workspace menu, select Save to save changes to the active Workspace.
However, if you try to save the default workspace, the Save as dialog is displayed instead (below).

Create a new Workspace


1. In the Workspace menu, select Save as. The new Workspace window is displayed.

Create new Workspace

The Shared check box is only shown if you're an administrator / have rights to create shared
Workspaces.
This option will make the Workspace available to all users.
You can also use the Manage Workspaces window (below) and select Shared.

2. Enter a name to describe your Workspace.

3. Click on the OK button to save.

Deleting a Workspace
You can delete any workspace you've created (assuming your user has the right to do this).

1. Select Manage Workspaces in the Workspace menu. The Workspace window is displayed.

Chapter 2 Map view


20
Map view 2

2. Click on the Delete link to remove a workspace.

3. Finalize by clicking on the Save button.

Learn more:
Maps

Chapter 2 Map view


21
Map view 2
Maps
In this chapter we'll have a deeper look at different map roles in VehicleTracker.

M ap clusters
A feature that works with all maps is the map clustering: if three or more vehicles are in the visually
same area (1 cm²) a cluster icon is shown, displaying how many vehicles are in that area:

Map Cluster

Zoom in to see the individual vehicles.

Area Search
With the Area Search map tool you can see what vehicles and events occurred in a certain area during
the specified period.

1. Simply click the Area Search icon and select a area on the map. The Area Search window is
shown.

2. Specify period and optionally an Event Rule and click Search.

3. Matching vehicles are shown. You can now click on a vehicle to show the specific track.

Close the Area Search window when you're done.

Google M ap Roles
By default, Google Maps is used in VehicleTracker and you won't have any other options in the Maps
menu.

Your administrator may however have installed additional maps. You can then change map as you
wish.

Chapter 2 Map view


22
Map view 2
Different maps have different roles - try to find the one that works best for you.

If your system uses Google Maps (which is default), it has the following functionality:

Map modes - there are currently four different Google Map views: Map, Satellite, Hybrid and Terrain.
Note that if you are using custom maps then you will not have these options.

Zoom control – on the left side of the map you have the zoom control bar. Drag it up or down to
zoom in and out. You can also zoom in with a double left click on the map and zoom out with a
double right click.
Zoom area - click on the button and then hold down left mouse button and drag a square over the
area you would like to zoom into.
Zoom all vehicles - click on the button to zoom in on all vehicles on the map.
Request Address – Click on the button and then drag the marker to the place you want address
information for.
Clear map – click on the button to clear all tracks from the map.
Undo zoom - the button undoes the previous zoom operation.

Learn more:
Points of Interest

Chapter 2 Map view


23
Geofences 3
The Geofence tab, by default located below the map in Map view, is divided in two modes:
Administrator and Operator.
As an Operator you can only view existing Geofences created by an Administrator.

Operator mode
Click on the Geofence tab and select the Geofence Tag you would like to view in the drop-down menu.
You will get a list of all included Geofences. Click on a Geofence to pan the map to the location of the
selected Geofence.

Administrator mode
As an VehicleTracker administrator you have the ability to create and edit Geofences. You also have
the ability to group Geofences using Geofence Tags.

Note that there is also a Points of Interest plugin that works very similar to Geofences, but suit some
scenarios better (visual points with or without alarms).

Create a Geofence
Make sure the Geofence mode radio button is selected.

1. In the dropdown, select -- New circle-- or -- New polygon--.


2. Type in an appropriate name that describes the location in the Geofence name text box (e.g. "Acme
Warehouse", "4th Presinct" etc).

3A. When choosing a circle geofence, 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 Geofence radius. Alternately, you can use the Radius
text box.

3B. When choosing a polygon geofence, left click on the map to start drawing the polygon. Left click
on the map for each new point of the polygon that you wish to create. Finish by left clicking on the
start point (red circle with black border).

Chapter 3 Geofences
24
Geofences 3

4. You connect a single Geofence to a group of Geofences by adding a Geofence Tag. There are two
predefined Geofence Tags that trigger alarms:

Go inside – Alarm - triggers an alarm when a vehicle enters the Geofence area
Go outside – Alarm - triggers an alarm when a vehicle leaves the Geofence area

Select the one you would like to use in the drop down menu Select Tag.

5. Optionally click the Advanced link to add a new Geofence tag. Here you are also able to link the
Geofence to multiple tags. Custom Geofence tags can be used to create more advanced Event Rules.

6. Save your Geofence when you are done. The Geofence will now trigger alarms for all Vehicles in your
application.

Edit a Geofence
You edit an existing Geofences by selecting the Geofence in the drop down menu. You can then
rename, move, resize or remove the Geofence just as you do when creating one.

Tag mode
You can also Edit Geofence Tags by selecting the Tag mode radio button. All the Geofence tags will
then be selectable in the drop down menu. Here you can select and deselect Geofences within each
Geofence Tag. Click Save to apply your changes.

Learn more:
Maps
Points of Interest

Chapter 3 Geofences
25
Driver Journal 4
Driver Journal is used to create detailed reports to justify vehicle usage. You can combine multiple trips
to one journal entry and for each journal entry you can choose a category and add a description. You
can select the categories you want to show in Driver Journal reports.

Select Driver Journal in the Workspace menu to open your Driver Journal.

The Driver Journal Workspace has three main windows, Journal, Trip information and Map. When
you work in the Journal, the currently selected trip is shown in the Trip information and Map
windows.

In the list you can see the trips and vehicles assigned to you. If you drive multiple vehicles you can
select the vehicle you want to work with in the Vehicle drop-down.

When you open the Journal the week with the latest journal entry is shown. You can move forward and
backward in time with the arrows and change time period with the buttons Day / Week / Month. The
Today button takes you back to today.

Add trip to Journal


When you give a trip a category it turns green and is automatically added to the Journal.

1. Select the trip category in the Category drop-down. The trip turns green and is added to the Journal
2. Add a description of the trip in the note field

The trip is automatically saved when you make changes to it.

Note: The odometer values are automatically calculated based on the Accumulator settings for the
vehicle.

Chapter 4 Driver Journal


26
Driver Journal 4

M erge multiple trips


You can merge multiple trips when you add them to the Journal (for example if one customer visit is
listed as several trips).

1. Select the trip category in the Category drop-down. The trip turns green and is added to the Journal
2. Add a description of the trip purpose in the note field
3. Click on the "Plus" sign to include the next trip in this Journal entry (the start and stop times and
addresses are updated)
4. Keep clicking on the "Plus" sign to add more trips
5. Click on the "Save" icon to save the trips as one Journal entry

The Trip information and Map windows are updated as you add more trips to show the current
selection.

Note: You can click on the "minus" sign to remove the last trip from the Journal entry.

Edit Journal entry


At any time you can make changes to the Category and Note fields directly in the list.

You can merge in additional trips to the selected journal entry with the "Plus" sign. If you want to
remove trips from a Journal entry you must first remove the Journal entry and then add it again.

Remove Journal entry


A Journal entry is removed when you change the Category to " - none - ". When you do this the trip
turns gray.

Note: When you remove a Journal entry made of multiple trips they will again show up as separate
trips in the list.

Odometer handling
The Odometer is managed from the Accumulator tab in the administration page for the vehicle.

Show Journal reports


At the bottom of the Journal you can select a report for your Journal (the reports available depend on
your installation).

Select a report and click on Show Report


Your report is opened in a separate window.

Chapter 4 Driver Journal


27
Reporting 5
Assuming your account has access to this feature, you will find Reports in the main menu.

Depending on your VehicleTracker configuration, there might be preconfigured reports available, like
Event Rule, Trip & Idle (Daily) etc, ready to use.

Usually it's only the VehicleTracker administrator who has Manage Reports available in this menu.

Running a report
If you have reports available below the Reports / Manage Reports menu option, click one of these to run
it.
The report preview is shown in a new window:

Report Preview

The parameters may have default values, but change these as you see fit (Period etc).

By default the report will be show as HTML (web layout). But if you for example wish to use the result
in Excel, then choose CSV instead to export as a comma separated list.

Chapter 5 Reporting
28
Reporting 5
Click on the Generate button. The report is shown below the gray list.
When using HTML layout you can print the report. If you chose CSV you'll be able to save the report.

Also, you can select the Send to [email protected] check box to mail the report to
yourself.

Learn more:
Adding a report

Chapter 5 Reporting
29
Reporting 5
Adding a report
Adding a report in VehicleTracker
We will now "create" the report in our Application. This let us choose the report's default settings.

1. Click Manage reports in the Reports menu. The Report manager window is shown.

2. Choose your report in the Report definitions list and click Open. Report settings and preview pops
up in a new windows/tab.

3. Choose suitable Report settings as desired:

Name and Description - this is what the users primarily see


Show Parameters - leave this ticked to let the users choose period and other parameters by
themselves.
You can, however, unselect this check box and make the default parameters (below) static.
Default format is set to HTML as default, which works well for general purposes.
You can also choose PDF if the report is normally printed (requires the users to have a PDF reader
installed).
If the report is primarily to be used for export, and then import to Excel or other compatible
applications, choose CSV instead.

4. Select parameters to set their default values. This can make the report more effective even if Show
parameters is selected, since the user don't have to do more than necessary to run the report.

Hide parameters
Other then hiding all parameters (above), there's an option to hide individual parameters by selecting
the Hide check box to the right. This enables you to choose what event rules to include, for example,
and prevent the Operator (user) from changing these values.

Chapter 5 Reporting
30
Reporting 5

5. Email schedule (optional)


Other than running the report from VehicleTracker you might want to add an email schedule. This often
increases usage of the report significantly. When you select the Activated check box email options
are shown:

Choose interval, users with which tag and format (works in the same way as Default format, above).

6. Preview and/or Save


Preview the result if you like to and then save the report.

Your report should now be available in the Reports menu of VehicleTracker.


All done!

A GpsGate Server administrator control who the report is available for with user roles. To do this, go to
Admin > Roles and enable / disable reports just like in SiteAdmin.

Chapter 5 Reporting
31
GpsGate Mobile 6
You can access roles directly from you mobile device with the GpsGate Mobile interface.
As an administrator you can install the Mobile plugin from SiteAdmin and enable it in the Application.

Logging in
Login to GpsGate Mobile from the same url as you login to VehicleTracker. Your mobile device is
detected at login.

If you want to login from a desktop web browser you add “/m” to the standard login url ( for example
“http:myserver.com/m” or “http://myserver.com/GpsGateServer/m” depending on your installation ).
If not available, ask your system administrator.

You can expect GpsGate Mobile to work well on all modern mobile devices.

Fleet status
The vehicle list is continuously updated showing the address, time
since the last update and all active alarms for each vehicle.

The list can be sorted in date, name and alarm order using the menu
at the top of the list and with the search function you can quickly find
specific vehicles.

Tap on any vehicle for more details or tap a map icon to go directly to
the real time map for the vehicle.

Vehicle list

Chapter 6 GpsGate Mobile


32
GpsGate Mobile 6

Vehicle information and Alarms


The vehicle information page shows more details for the selected
vehicle including current speed and vehicle status. The map icon takes
you to a map page for real time tracking of the vehicle.

Active alarms are listed with detailed information and times stamp.
You can show alarms on a map or close them directly in the list.

The alarm icon in the top right corner is available on every page. As
long as there are active alarms the alarm icon is red. Tap the alarm
icon to show the vehicle list with the vehicles with active alarms first.

Vehicle info

Live maps
Tap the map icon to track a vehicle in real time. The map window shows the vehicle and active alarms.
You can show and hide vehicles and alarms with the menu above the map.

You can show your own position on the map by tapping the Me button below the map. This is great if
you want a visual reference between you and the vehicle.

The All button zooms and pans the map to include all objects.

The Info button brings up the information box showing details and status information for the tracked
vehicle.

As shown in the images multiple maps are supported. In the first version of GpsGate Mobile this
included Google Maps, OpenLayers and OpenStreetMaps.

Chapter 6 GpsGate Mobile


33
GpsGate Mobile 6

Open layers Map w ith alarm

Chapter 6 GpsGate Mobile


34
Admin 7
This section explains how to work with the Admin menu options.

Only administrators of VehicleTracker have this menu available.


If you don't see Admin in the main menu, please ignore this section of the manual.

Adm in m enu in VehicleTracker

Learn more:
Users
Device Mappers
o Advanced
Event Rules
o Notifiers
o Advanced
Tags
Views
Roles

Chapter 7 Admin
35
Admin 7
Users
This chapter will cover the management of Users.

User Roles
There are three different user roles: Operators (login users), Administrators (Operator with admin
rights), Driver, and Unit (vehicle). The table below shows the differences between the user types.

User type Send tracking Viewing Administration Act on Geofence


data rights rights alarms
Administrator Yes Yes Yes Yes Create/Edit
Operator Yes Yes - Yes View
Unit (vehicle) Yes - - - -
Driver - - - - -

Units
Units are users that can send tracking information to by an attached to a Device. These users can not
login to the system like an Operator.

Operators
Operators can be connected to a device, but are also able to login to the system.

Application Administrators
In addition to the Operator functionality Administrators can create, manage and delete other users in
the application, add reports etc. This user may or may not have access to SiteAdmin.

Adding Operators
An administrator can create all type of users. We'll now look at creating an Operator.
Click on the Add new user button in the Vehicle list.

The user creation wizard is shown.

Chapter 7 Admin
36
Admin 7

You navigate the wizard with the Next / Back buttons available in each section.
You can also click on a section to expand it.

1. Choose User Type Operator and click Next.

2. In the Details section, supply username, name, surname, e-mail and password.
The User Type has already selected _Operator in the roles step for us, so you can optionally skip to
Tags now.

3. In the Roles step, optionally select a specific Role (such as _Administrator, _Driver, _Operator or
_Unit).

4. Finally, in the Tags step, add a new tag if necessary and select the tag or tags to associate with
this user. Click Save.

Chapter 7 Admin
37
Admin 7

Adding Vehicles
A vehicle is a user attached to a device, giving the device an identity in the system.
The process is similar to adding an Operator. Click Add new user button in the Vehicle list.

1. Supply username, name, surname, e-mail and password. Click on the bottom right Next button.

2. The permissions step is shown. Select _Unit and click Next.

3. Add a new tag if necessary and select the tag or tags to associate with this user. Click Next.

4. The summary is shown. Now click Next to view the Device 1 step.

Adding a device
Now we will look at adding a Device for one of your users. This will enable you to track the Device.

1. On one of the the Device tabs of a user, choose a Device type.

2. Supply the correct information about your Device:

Device name Your own description


IMEI The device IMEI number (usually printed somewhere on the device).
If IMEI is used the device can use this to log in instead of username
and password from the User - not to be confused with GPRS login.
Device mapper A device mapper matching your device protocol.
Country* Country of the SIM card.
Operator* The SIM card operator.
APN* Access Point Name received from the SIM card's telecom operator.
GPRS username & Login credentials for GPRS traffic on the SIM card's telecom
GPRS password* operator.
* Only be available if your installation has SMS support.

3. Click Save to finish.

Chapter 7 Admin
38
Admin 7
Device Mappers
Device specific signals are mapped to the system variables.

Edit Device M apper


From the Admin > Device
Mappers page, click on a Device
Mapper to edit it.

Map the device specific signals to


system variables. You only need to
map the signals that you actually
use in you implementation.

If you for example want to track the


vehicle's ignition, you could map the
ignition signal (if available) to the
Ignition variable.

You will now be able to see ignition


on, for example, the Status tab and
could create an Event Rule for
"Ignition ON".

Signal names may vary between


different devices. When mapping
the variable SOS, for example, the
input signal may be “SOS”, “SOS
Button”, “Alarm1”, “Input1” or “In1”.

The Device Mapper is used to match these signals to system variables.

Click Save to finish.

Learn more:
Advanced Device Mappers

Chapter 7 Admin
39
Admin 7
Advanced
In this chapter we'll look at some more advanced Device Mapper features.

Add Device Mapper


From the Admin > Device Mappers page, click Add new Device Mapper. Then proceed with normal
editing.
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. When you add
devices to your system you can select one device mapper for each device.

Conversion
If you are mapping analog inputs you can add a multiplier and constant to transform the device specific
input to a usable value.

Input is the device signal.


Multiplier is used to multiply the Input for a correct out value
Constant can be used as an offset to add / subtract a constant value

Output = (Input * Multiplier) + Constant.

Non linear conversion


It is possible to map analog values with a non-linear function. This can be useful when taking a sensor
value from a vehicle (e.g. a fuel tank) and map it to a system variable (e.g. "Fuel level" when the sensor
value is not proportional/linear to the actual fuel volume.

When using a formula the Constant field is not used.

Rather then using a constant in the Multiplier filed you add a formula with the following syntax:

IN1:IN2#OUT1:OUT2,IN3:IN4#OUT3:OUT4, etc.

INx and OUTx are numbers, which defines intervals. The IN-interval maps to the OUT-interval.

Example:
0:2#0:20,2:4#20,80

A value 1.0 from the tracker will map to 10.0 in the system variable. A value 3.0 will map to 50.0

Example 2:
0:1.5#0:15.0,1.5:3#15:45.8,3:10#45.8:0

Ignore values
To ignore values for a range use the format "0:0#null":

0:0#null,-100:100#-100:100

Chapter 7 Admin
40
Admin 7
Event Rules
Event Rules, found under the Admin menu, let you gather report data, create alarms and e-mail when
for example a signal changes or a vehicle enters a Geofence.

Add Event Rule


For ease of use a wizard guides you when you setup an Event Rule. If you make a mistake or omit
something a yellow triangle comes up next to rules that have potential issues. Moving the mouse over a
triangle brings up a detailed explanation as shown in the picture.

From the Admin > Event Rules page, click Add new Event Rule. The wizard is shown.

1. Provide a name and optionally a description. Also choose what Kind of rule to create:

Live and Analyze - will display alarms on the map.


Analyze only - the event is strictly used for reporting.

Then click on Next.

2. Choose which tags the Event Rule applies to - or none for everyone - and click Next.

3. Now decide when the rule should be active. By default Always active is selected, but you can
change it to Active on schedule and make exceptions on for example weekends:

Finish events automatically when outside schedule


This option, selected by default, ends events when they are outside the schedule. Leave this selected if
for example the schedule represents work hours and anything outside that schedule is irrelevant.

Click Next when you're done.

4. In the Expressions step, add the actual condition - or conditions for when the event should start.

Chapter 7 Admin
41
Admin 7

First choose an expression type to the far left:

Driver ID login Use this to track drivers with iButton.


Analog Expression Analog Expressions let you create an expression for analog inputs, like speed.
The signal must be mapped in your Device Mapper for the rule to work.
Digital Expression Digital Expressions let you create create an expression for digital inputs (true/
false) like Ignition on/off.
Geofence Trigger event when vehicles pass through Geofences.
Expression
Offline Expression Offline Expressions let you specify a time period since last connection for a
device to be considered as offline.

When you've chosen a type the menu is replaced by options of that type. For analog and digital
signals, the available system variables (which are generic and not device specific) of the respective type
are listed.

Note: by default events will only stop until the start condition is no longer true, or as mentioned above
they run outside the schema.
You can however control this more in detail with advanced expressions.

Match all or any


When using multiple start/end expressions in the same Event Rule you choose whether to Match all or
Match any below the last rule. Selecting all will require that all the conditions are met, while only one
of them must be met if you choose any.

Click Next when you're finished with the expression.

5. The final step is Notifications. This is both used for reports, to send e-mail / SMS notifications and
to display event information on the map view.

Application
Choose Reports only to send information about the event to your reports or Alarm panel and reports
to also create an alarm in the map view.

The Message window to the right allows you to supply a message for reports and / or the Map view.
This can simply be a static message like "Battery is low" or a dynamic message using variables.

Chapter 7 Admin
42
Admin 7
When you're done with the Event Rule, click Save in the bottom right corner of the page.

Learn more
Notifiers
Advanced Event Rules

Chapter 7 Admin
43
Admin 7
Notifiers
In this chapter we'll look at some of the additional options for Notifiers, when creating an Event Rule.

Using variables
Click on the message drop down list to the right. This brings out a text area where you can compose
your message.

The variable drop down list is located to the far right in the message window. Available variables
depends on the type of Event Rule you're creating.

Choose for example Vehicle name to insert the [USER_NAME] variable in your message. The variable
([USER_NAME]) will be replaced by the name of the vehicle when the alarm is triggered.

Add notification
When you click the far right plus [+] in notifications, a list of notifier types appear:

Driver ID
When using iButton devices, this is used to assign a driver to a vehicle. You only need to add the
notifier. Nothing else is required (in the Event Rule).

Command
Send a command to a device or external server. For example, you could send the device specific "Turn
engine off" command when the vehicle enters a dangerous Geofence.

1. Select the type of action to take, in the left most drop down list:

Back to device - send a command to the device as per the above example.
Other device - send a command to another device.

Chapter 7 Admin
44
Admin 7
Custom server - an advanced feature used to send information to other system (like a intranet or
CRM).

2. Choose the appropriate settings and when this Command should trigger - start or end of the event.

3. Save

Read more about commands in the Complete / SiteAdmin documentation.

Email
Use this notifier to send e-mail alerts. Choose tags in the Recipients list, specify a e-mail Subject
(second drop down), message content (third drop down) and if the notification should be sent at the
start or end of your Event Rule.

To use HTML formatting in the message (like <br> for new line), make sure to select Message
contains HTML in the content editor.

Note: avoid spamming notifiers by using the technique described in the Advanced chapter.

Flag
Used together with Icon notifier to end an event. Different plugins can install different type of Flag
notifiers.

SMS
Sends an SMS to users in the chosen tag, assuming they got a phone number and you're using the
SMS plugin.
Configuration is similar to Email (above) - select Recipients, message content and when the SMS
should be sent (start/end).

Icon
Creates a column with the specified Column header in the Vehicles list (you must enable it in the list
settings) to show an icon for SMS, Ignition etc.

Text - works just like Icon, but with a specified text instead.

Marker attributes
When you've created a Column header for your Icon or Text notification, this can be used to show
information directly on the map view.

Chapter 7 Admin
45
Admin 7
Open Marker attributes in the Workspace menu. Select the Text/Icon notifiers you've created and
save.

These will now be visible on the map as a infobox for each vehicle:

JobNotifier
When using the Dispatch plugin, this allows you to start "jobs" based on the event.

Learn more
Advanced Event Rules

Chapter 7 Admin
46
Admin 7
Advanced
In this chapter we'll look at some of the more advanced procedures when it comes to Event Rules.

Event delays
You also have the option to delay how fast the event triggers. If the vehicle for example must stay in a
Geofence for at least 5 minutes before the event should trigger, Change Immediate to Delayed event
and input 5 in the minutes text box.

Advanced Expressions
The default behavior works excellent for digital expressions, where the event start when for example
the ignition turns on and doesn't end until the ignition turns off. No need for any advanced expressions
in that case.

But when using analog signals such as Speeding 100 k m/h and you want to avoid too many events the
end condition can be used to filter out bad data.

Click Show advanced options in the 4. Expressions step to configure the event end condition.

With our speeding example, an end condition of Analog > Speeding > Less then > "80" would avoid
any new speeding events for the vehicle until it has driven below 80 km/h. This is especially important if
you've configured e-mail or SMS alerts for the event (so the recipient doesn't get spammed).

Chapter 7 Admin
47
Admin 7
Tags
Tags are used in many parts of the system for categorizing and filtering users and vehicles, so the
using tags should be essential for you as an administrator.

Tags may for example be used with a View to only show truck type vehicles, or vehicles on the night
shift.
In reports tags are used to choose what categories of users / vehicles to include.
For login users (Operators and Administrators) tags can be used in Event Rules to determine if they
should receive e-mail and SMS notifications.

Begin by choosing Admin > Tags in the main menu.

Edit tag
Click on a tag to open the Edit Window and proceed as below.

Add new tag


1 .Click the top right Add New button.

2. Provide a tag Name and optionally a Description.

3. Choose which users this tag applies to. Note that the same advance search functions as in the
Vehicle list are available here.

Chapter 7 Admin
48
Admin 7

4. Click the Save button.

Learn more:
Views
Roles

Chapter 7 Admin
49
Admin 7
Views
Views are used to filter users in the user interface. Only the users that fit into the View criteria are
shown in the user interface. This can be used to group vehicles after their status, such as Online /
Offline. It is also possible to add tags for additional filtering such as “Taxi”, “Truck”, “Department A”,
“Operator A”, etc.

Manage Views through Admin > Views in the main menu.

Edit View
Click anywhere on a View to open the Edit Window and see below.

Add new View


1 .Click the Add new View button.

2. Provide a tag Name and optionally a Description.

3. Choose which Status codes to include in this view.

4. In the Tags section, you can choose to include vehicles with all selected tags - Match all - or every
vehicle with any of the tags you select below - Match any. If a tag is missing, click the Add new Tag
button.

5. When you've selected Tags, click the Save button.

Chapter 7 Admin
50
Admin 7

Chapter 7 Admin
51
Admin 7
Roles
You can use Roles to set privileges and available roles per user role (Administrator, Driver, Operator
and Unit).

Click Admin > Roles to show the Roles window.

Copy Role
To the far right of each Role there's an Create copy button. This is a effective way to create a new role,
without having to set every single feature from scratch.

Click the button and continue to edit as described in Edit roles, below.

Edit Role
To edit a role, click anywhere to the left of the Create copy button, on the role's row.

The Role's details are displayed. Make sure Name and Description have appropriate values.

Auto allow new items will add features to this role as they are enabled for the Application.
This way you don't have to update each role with the new features when, a new feature is enabled in
SiteAdmin.

Chapter 7 Admin
52
Admin 7

Click the Next button (or the 2. Users title) to continue.

Role Users
Use the check boxes to select which users to include in this role. Just like in the Vehicles list, you can
use the search box to filter the results. When you're done, click Next (or the 3. Privileges title).

Role Privileges
The role privileges appear in a tree of folders.

Admin
o _EditApplicationPrivileges enables user to edit Roles and Privileges.
o _EditDeviceMapper enables user to edit Device Mappers.
o _EditDialogs enables user to edit dialogs. Some dialogs e.g. the Jobs dialog in Dispatch, have
downward arrow in the upper right corner. This contains a menu where you can edit which fields
are visible in the dialog. Changes are saved in the Workspace.
o _EditEventRule will enables user to edit Event Rules.

Chapter 7 Admin
53
Admin 7
o _EditGateEvent will enable user to close Alarms.
o _EditTags will enable user to edit Tags.
o _EditUsers enables user editing. Select which Roles users may be edited for. For example you
may prevent an _Operator from editing _Administrator users.
o _EditUserTemplates enables user to edit User Templates.
o _ReadData using _ReadData to determine who can see which vehicle data and the _Me tag to
only see your own data.

Commands
o _ExecuteCommandAll lets a user send commands to devices.
o _ExecuteSpecialCommandAll enables the user to also send commands marked as Special.
o _ResetCommandQueue allows the user to reset the outgoing queue when it contains commands.

Further see Template Commands in the SiteAdmin documentation.

Geocoding
o _LiveAddress will enable the Live Address functionality, so addresses are only retrieved when the
user is logged in. _LiveAddress must be enabled for this Application in SiteAdmin first.

Geofences
o _EditGeofence if Geofences is installed and enabled in the Application this enables the user to
edit geofences.

Login - determines how the user can login:


o _DeviceLogin is used for tracking devices to login in and transmit data.
o _MobileLogin controls access to the GpsGate Mobile site.
o _WebLogin refers to VehicleTracker.

Maps
o _UseMapCustom enables imported PEG, PNG, GIF or BMP maps.
o _UseMapNative enable the standard Google Maps.
o _UseMapPlugin - Enable other map plugins.

Further see the SiteAdmin documentation.

Reports and Export


o _UseTrackExport determines of the users have general access to reports and/or can export data
from the track points list.

Tracks - read / edit rights for track lists.

User settings - possibility to change password, localization etc.

Views - read / edit rights for Views.

Workspaces - control usage of private and shared Workspaces.

Plugins - control access and settings for plugins you've installed.


o PointsOfInterest enables the use of Points of Interest
o Reporting controls which reports are available. You will need them enabled as _CreateReport to
add them in the Report Manager.

The Save button is in the very bottom left corner.

Chapter 7 Admin
54
Index
Index

A J
Add 40 Job 46
Add notification 44 Journal 26
Admin 1
Advanced 40, 47 K
Advanced filters 8 KML 3
Alarms 11
Application 1 L
Apply Filter 8 Last seen 6
Area Search 22 Live Filtering 8
Localization 18
C Logout 1
Center on click 3
Clustering 19, 22 M
Command 44 Map 22
Commands 15 Map modes 3
Convert 40 Map view 1, 3
Copy 52 Maps 22
CSV 28 Marker 19
Marker attribute 45
D
Delay 47 N
Device 1, 38 Non linear 40
Device mapper 39, 40 Notification 44, 45
Driver 52 Notifier 46
Driver Journal 26 Notifiers 44
DriverID 44
O
E Operator 52
Edit 52
Email 45 P
Event Rule 41, 44, 45, 47 Password 18
Expression 47 POI 4
Point of Interest 4
F Privileges 53
Fatpoint 9, 18
Flag 45 R
Follow selected 3 Reports 1, 28
Role 52, 53
G
Geofence 24 S
Google 22 Search 6
Settings 1, 18, 19
H Show Fatpoints 8
Help 1 Show points 8
Show polyline 8
I Signal 40
Icon 45 SiteAdmin 1
SMS 45
Status 6, 13

55
Index
Index
Style 18, 19

T
Tag 6, 48
Tags 17, 48
Track 18
Track points 1, 8
Track visualization 18
Tracks 1, 8

U
Unit 52
User 6, 38
Users 1, 6, 36, 53

V
Variables 44
Vehicle 1, 6
Vehicle Info 1, 14
Vehicles 14
View 3, 50
Views 17, 50

W
Workspace 1, 19, 20, 45

Z
Zoom to fit 8
Zoom to view 3

56

You might also like