omm-ed-091001 - omm user guide 2_7

76
onBoard Mobility Manager onBoard Mobility Manager User Guide For oMM 2.7 oMM 2.7 Rev. 1.0 March 2010

Upload: thomas-tarabelli

Post on 07-Apr-2015

75 views

Category:

Documents


4 download

TRANSCRIPT

Page 1: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager

onBoard Mobility Manager

User Guide

For oMM 2.7

oMM 2.7

Rev. 1.0

March 2010

Page 2: oMM-ED-091001 - oMM User Guide 2_7

© 2010 In Motion Technology Inc. All rights reserved. No part of this publication may be used, in any form by any means, without the prior written permission of In Motion Technology Inc.

In Motion Technology, In Motion, oMG1000, and onBoard are trademarks of In Motion Technology Inc.

Wi-Fi is a trademark of the Wi-Fi Alliance. All other trademarks are the property of their respective owners.

Page 3: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 i

Contents

0 oMM 2.7: What’s New ........................................................................ iii 0.1 Gateway Tree and Dashboard Usability ...................................... iii

0.1.1 Groups and Sub-Groups .................................................. iv 0.2 VPN Call-Up ................................................................................. iv 0.3 VPN Availability in Reports .......................................................... iv 0.4 WiFi Reports ................................................................................ iv

0.4.1 WiFi Coverage Report ...................................................... iv 0.4.2 WiFi Access Points Report ............................................... v 0.4.3 WiFi Overlap Report ......................................................... v 0.4.4 WiFi Trails Report ............................................................. v

0.5 Show Advanced Config ................................................................ vi

1 Introduction .......................................................................................... 1 1.1 Who Should Read This Guide? ................................................... 1 1.2 What is the onBoard Mobility Manager? ...................................... 1 1.3 Version: onBoard Mobility Manager ............................................. 1 1.4 Related Publications .................................................................... 2

2 Navigation ............................................................................................ 3 2.1 Logging In .................................................................................... 3 2.2 General Layout ............................................................................ 4 2.3 Tabs ............................................................................................. 4 2.4 Option Tabs ................................................................................. 5

2.4.1 Logout ............................................................................... 5 2.4.2 Options ............................................................................. 5 2.4.3 Help .................................................................................. 5

2.5 Gateway Tree .............................................................................. 6 2.5.1 Filter Box .......................................................................... 7

2.5.1.1 Gateway Tree Filter Options .............................. 8 2.5.2 Groups and Sub-Groups .................................................. 8 2.5.3 Changing Gateway Details ............................................... 9

2.6 Main Display: Filtering and Options ........................................... 11 2.6.1 Filter Text Field ............................................................... 11 2.6.2 Time Period .................................................................... 11 2.6.3 Nominal Events .............................................................. 11

3 Main Tabs ........................................................................................... 12 3.1 Dashboard ................................................................................. 12

3.1.1 Dashboard: List View ...................................................... 13 3.1.1.1 Parameters ...................................................... 13

3.1.2 List View: Color Coding .................................................. 14 3.1.3 List View: Sorting ............................................................ 14 3.1.4 Dashboard: Graph View ................................................. 15 3.1.5 Dashboard: Threshold View ........................................... 16

3.2 Events Tab ................................................................................. 17 3.3 Map Tab ..................................................................................... 18

3.3.1 Navigating Within the Map ............................................. 19 3.3.2 View Gateways by Time/Date ........................................ 20 3.3.3 Filter Gateways Visible ................................................... 20

3.4 Stats Tab .................................................................................... 22 3.4.1 Views .............................................................................. 22

Page 4: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

ii oMG-ED-090301

3.5 Admin Tab .................................................................................. 24 3.5.1 Gateways ........................................................................ 24 3.5.2 Users ............................................................................... 26 3.5.3 Stats ................................................................................ 28 3.5.4 Thresholds ...................................................................... 29 3.5.5 Zones .............................................................................. 32 3.5.6 Sessions .......................................................................... 36 3.5.7 Debug .............................................................................. 36

4 Reports ................................................................................................ 37 4.1 New Reports ............................................................................... 37 4.2 Before You Begin ....................................................................... 38

4.2.1 Network: Availability Trend Report.................................. 40 4.2.2 Network: Availability Details Report ................................ 42 4.2.3 Network: Coverage Map Report ..................................... 45 4.2.4 Network: Coverage Trails Report .................................... 48 4.2.5 Network: Link Utilization Report ...................................... 49 4.2.6 Misc: Configuration Audit Report .................................... 51 4.2.7 Misc: Event Viewer Report .............................................. 54

4.3 Reports for Optional Packages .................................................. 55 4.3.1 Telemetry: Driving Behavior ............................................ 55 4.3.2 Telemetry: Fuel Fillup ..................................................... 57 4.3.3 Telemetry: Fuel Consumption ......................................... 58 4.3.4 Telemetry: Fuel Consumption Trend .............................. 59 4.3.5 Telemetry: Vehicle Diagnostics Report ........................... 59 4.3.6 Telemetry: Odometer Check ........................................... 60 4.3.7 Telemetry: Unauthorized Usage ..................................... 61 4.3.8 Assets: Asset Usage Summary ...................................... 61 4.3.9 Assets: Asset History ...................................................... 62 4.3.10 Assets: Vehicle Assets .................................................... 62

4.4 Templates ................................................................................... 63 4.5 Results ........................................................................................ 64

5 Optional Packages ............................................................................. 65 5.1 Tracker Tab ................................................................................ 65 5.2 Telemetry Tab ............................................................................ 66 5.3 Total Reach Tab ......................................................................... 66 5.4 Assets Tab .................................................................................. 67

Appendix A. In Motion Technology Inc. Contacts ................................... 68 A.1 Comments .................................................................................. 68 A.2 Technical Support....................................................................... 68

Page 5: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 iii

0 oMM 2.7: What’s New

Version 2.7 of the onBoard Mobility Manager contains major UI modifications which are included in this section of the oMM User Guide. The remainder of the guide contains information specific to oMM 2.6.

0.1 Gateway Tree and Dashboard Usability

The gateway tree has been modified to eliminate redundancy and improve efficiency. The nominal events, colored icons (for thresholds) have been removed from the list of gateways. Additionally, changes were made to the filter box. The 24-hour icon, which limited the gateways to those which actively reported data, was removed as was the blue circle icon which enabled users to view gateways that did not report in. These features continue to be available in the main panel of the dashboard.

Version 2.7 also includes better organizational capabilities. Gateways can be organized in sub-groups in the gateway tree and the Dashboard maintains the same group (folder) containment (see image below). To display the individual gateways, click on the Name ID link of the folder.

Page 6: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

iv oMG-ED-090301

0.1.1 Groups and Sub-Groups

New in oMM 2.7 is Drag/drop enabled which allows users to easily move (drag and drop) gateways. Note that care must be taken when enabling this option.

0.2 VPN Call-Up

The following change has been made to the Dashboard tab:

VPNUpTime is now displayed as a column

o VPN call-up displays how long the tunnel has been up

If the tunnel does not stay up (i.e. it bounces), there is an issue with the VPN server or configuration

Where the CallUp check displays how long a call has been up (active with the WAN), the VPN call-up displays how long the VPN link has been active

0.3 VPN Availability in Reports

The following reports now include VPN up-time information:

Network Availability

Availability Details

Link Utilization

0.4 WiFi Reports

Version 2.7 introduces new WiFi reports. Note that this is an option that must be purchased and is only available for the Four Port Gateway, versions 3.4.1 and higher.

0.4.1 WiFi Coverage Report

The WiFi Report tallies all gateway WIFI network signal strengths within geographic areas and plots a coverage map, assigning a color from green (good SNR) to red (bad SNR). This report is best used to show an aggregated result where one, or likely more than one, gateway visits each area more than once over a greater period of time. The report is intended

Page 7: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 v

produce a coverage report showing strong versus weak WiFi coverage. For cases where there is only one gateway and that gateway visits each area only once, use the WiFi Trails report. Aptracker must be enabled on the oMG.

0.4.2 WiFi Access Points Report

The WiFi Access Points report locates and graphs all WiFi access points observed by a gateway over the time range specified. Access points are placed geographically based on weighted SNR triangulation of the individual gateway readings. Green points indicate more reliable readings and red ones less so. Below the graph is a table showing information about every WiFi access point seen. This report is intended as an inventory tool of deployed access points, used to compare against a master list and identify those that are not functioning (missing) or incorrectly configured or placed (weak). Aptracker must be enabled on the oMG.

0.4.3 WiFi Overlap Report

The WiFi Overlap report is similar to the WiFi Coverage report but provides a more critical view. Instead of treating all readings in a geographic area as identical, it requires that there be, at least, a minimum standard for signal strength (SNR) and network redundancy (number of Access Points (AP)) at each location. Clicking on a graphed area displays a detailed view of the distinct geographic locations and APs detected in the area. This report is intended as a means to identify thin coverage areas in the network (i.e. locations that may have good signal but are not redundant or failure safe). The report is best used for smaller time periods (e.g. one day or so) and requires that aptracker be enabled on the oMG.

0.4.4 WiFi Trails Report

The WiFi Trails report graphs gateway position as a trail (continuous line) on the map. Trail color indicates the WiFi signal strength of the gateway (green is good, yellow is OK, red is bad). Circles of various sizes are used to indicate locations where the gateway stops and, along with markers, can display pop-up information for the location with options for greater detail. This report is best used for a single gateway over a smaller time period (i.e. one gateway trip) where the same location is not visited repeatedly. For cases where there are more gateways, greater time periods or repeat visits, consider using the WiFi Coverage report. Aptracker must be enabled on the oMG.

Page 8: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

vi oMG-ED-090301

0.5 Show Advanced Config

New to the oMM with version 2.7 is direct access to displaying the advanced edit fields in the input fields for all reports. The feature continues to be available under Options.

Click on the grey box to enable the feature. When enabled, the box is orange.

Page 9: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 1

1 Introduction

This document provides instruction for the use of reports on the onBoard Mobility Manager (oMM).

1.1 Who Should Read This Guide?

The oMM is the management system that supports a fleet of onBoard Mobile Gateways, typically installed in vehicles. oMM users typically include fleet dispatch operators, fleet managers, IT support staff and vehicle maintenance staff.

It is recommended that anyone using the oMM should read this guide.

1.2 What is the onBoard Mobility Manager?

The oMM is a powerful browser-based software application that enables users to configure, monitor and analyze onBoard Mobile Gateways and associated applications/accessories (such as Asset Manager Wi-Fi tags).

Each onBoard Mobile Gateway collects operational data in a log (e.g. connection status, data transmitted/received, temperature of the unit, voltage of the vehicle, GPS location data, etc.). The data logs from the Gateways are transmitted over the wireless data network to a server. The oMM uses these data logs to present current and historical activity.

The oMM is highly configurable to enable great flexibility between customer situations. Business intelligence-style data presentation and reporting enable users to leverage the large amount of data available from the Gateways.

The oMM also enables over-the-air changes to the Gateway software.

1.3 Version: onBoard Mobility Manager

The version is displayed on the login page, under the user name and password fields.

Version Details

oMM 2.6.1 Released January 2010

Page 10: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

2 oMG-ED-090301

1.4 Related Publications

Title and Publication Number Description

oMM-ED-081001 Tracker User Guide

oMM-ED-081002 Total Reach User Guide

oMM-ED-081003 Telemetry User Guide

oMG-ED-081008 oMG Asset Manager Configuration Guide

Page 11: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 3

2 Navigation The oMM user interface is designed to allow access to important data from large fleets. Navigation is typically via graphical icons and links, with layouts that mirror web page design.

2.1 Logging In

A user name and password is sent to customers for their first log in. To change this password, or to add more users, contact Support at In Motion. See contact details at the end of this document.

To safeguard your login credentials, ensure that your browser does not store your user name and password unless you are confident no one can access your computer.

Note that the version of Mobility Manager is shown below the login fields.

Page 12: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

4 oMG-ED-090301

2.2 General Layout

Several navigation items are consistent throughout the oMM. The Dashboard view, shown below, is the default view.

2.3 Tabs

Located at the top left of the screen, the main tabs are used to select different presentations of available information.

For more details for the individual tabs, see the Main Tabs section.

User Name

Option Tabs Main Tabs

Gateway Tree

Filter Field

&

Nav Icons

Page 13: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 5

2.4 Option Tabs

Located at the top right of the screen, the option tabs are used to select one of the following actions: Logout, Options or Help.

2.4.1 Logout

Click on the Logout tab to log out of the oMM and return to the oMM login page.

2.4.2 Options

Hover over Options for additional actions.

Zoom: Used to toggle between the regular view and the full screen view. When enabled, the Gateway Tree is removed and the results screen is enlarged.

Microsoft Maps: Select to use Microsoft Maps in the oMM. This is the default.

ESRI Maps: Select to use ESRI (Environmental Systems Research Institute) maps.

Show advanced edit fields: Displays advanced edit fields.

Preferences: Select to modify the following preferences: password, units of measure, time zone, dashboard items and configuration permissions.

2.4.3 Help

The Help tab launches a separate browser window/tab to display the oMM help screen. The Help feature provides basic information about the oMM and some sections redirect to In Motion‟s online knowledge base for greater detail.

Page 14: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

6 oMG-ED-090301

2.5 Gateway Tree

Also known as the onBoard Mobile Gateway (oMG), the gateway is the hardware typically installed in a vehicle, although it can be installed in offices or depots to take further advantage of the system‟s capabilities. As such, the term gateway is used instead of vehicle.

Located on the left side of the screen, the gateway tree enables users to select vehicle groups, sub-groups and individual gateways. The look and feel is similar to traditional file management systems with folders and files.

Click on the group/sub-group/individual gateway to select it. This selection will remain active when toggling between the main tabs (e.g. Dashboard to Map). Additionally, when running reports, the gateway field is automatically populated and can be changed by clicking on another group/sub-group/gateway. Multiple items can be selected by holding down the Control (Ctrl) key while clicking.

Page 15: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 7

2.5.1 Filter Box

The Filter field for the gateway tree allows users to enter part or the entire name of a gateway, or any other data label the gateway may have.

The image on the left shows the list of gateways displayed when nothing is entered in the Filter field (i.e. show all gateways). The image on the right shows only gateway names containing “H0”. The Filter field is not case sensitive.

Note that the filter applies to all labels for each gateway. Therefore, a filter will return data based not only on the name as it appears in the gateway tree but also on any of its Dashboard items (e.g. IP address, Callup Link, Battery, etc.).

Text in the Filter field can be edited or deleted by clicking Ion the X icon, to the right of the field.

Page 16: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

8 oMG-ED-090301

2.5.1.1 Gateway Tree Filter Options

To the right of the filter field are three icons:

24: Click to limit the gateways displayed to those which have actively reported data during the previous 24 hours. When selected, the icon appears orange.

Blue Circle: Enable to view gateways that have not reported in

Refresh: Click to update the gateway to the latest information available.

2.5.2 Groups and Sub-Groups

To define groups and sub-groups in the gateway tree, right-click on the main group name.

Delete group: Select to delete a particular group

Rename group: Select to rename a group

Create subgroup: Select to create a subgroup of gateways

Move group here: Select to move a group to a particular group

Paste selected gateways: Click on a gateway to select it. Right-click on a group and select this option to move the gateway to the group.

Talk: This feature is not yet available

Page 17: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 9

2.5.3 Changing Gateway Details

When setting up a fleet of gateways, several fields exist to help identify and group each gateway.

Delete: Select to delete a particular gateway

Talk: This feature is not yet available

Details: Opens the editing panel in a new browser

Users may enter/change details in each field. This can be used to segment a fleet. For example, when using search filters, entering Winter Tires will only display vehicles equipped with winter tires.

Nearby vehicles: Displays the nearby vehicles

Show Hosts: Displays the list of IP addressable devices that are connected to the gateway‟s LAN

Access console: Remotely connect to the gateway‟s terminal

Page 18: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

10 oMG-ED-090301

Access LCI: Remotely connect to the gateway‟s UI configuration screens

Force Reboot: Force a reboot of the gateway

Copy today’s log files: Import the current day‟s log files from an oMG to the oMM

Browse log files: Browse through the log files imported into the oMM

Page 19: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 11

2.6 Main Display: Filtering and Options

2.6.1 Filter Text Field

Filter gateways by name or group name. In addition to selecting a group of gateways from the gateway tree, the Filter Text field allows users to further filter selections by entering part or all of the gateway or gateway group name.

Click on Search to initiate the search request.

2.6.2 Time Period

Select a time period from the drop down list. Only gateways which have reported location data within the selected time period will be displayed on the map. This allows users to focus solely on active gateways.

2.6.3 Nominal Events

Nominal events include any event where a threshold is exceeded. See the Admin > Thresholds section for further details.

Use the nominal events icons to display the gateways for the defined thresholds.

The colored circles are defined as:

− Green: Operating normally within the thresholds

− Blue: No data available.

− Yellow: Warning level threshold exceeded

− Red: Error level threshold exceeded

The Default setting has the Green, Yellow and Red events on for all gateways.

Filter Text Box

Nominal Events

Time Period

Page 20: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

12 oMG-ED-090301

3 Main Tabs

Located at the top left of the screen, the main tabs are used to navigate through the various presentations of the information available in the oMM. Click on a tab to select the view.

The tabs available depend upon the purchased options and the overall configuration of the system. The main tabs cannot be altered by individual users. However, administrators can add and remove tabs (go to Admin > Users) if they own their own appliances. Clients using hosted services from In Motion do not have the Admin > Users option.

3.1 Dashboard

Dashboard provides the main management view of the fleet. There are three views available: List, Graph and Threshold.

Notes:

The Auto Refresh feature refreshes the screen at the same rate that the gateways report data. The default setting is On.

Click on the Manual Refresh icon to manually refresh the screen.

Threshold settings can be configured by going to Admin > Thresholds. Hovering over the threshold definition displays the threshold settings (i.e. which threshold setting has been crossed).

The list of statistics displayed on the dashboard is also configured through Admin > Thresholds.

List View

Graph View

Threshold View

Auto Refresh

Manual Refresh

Page 21: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 13

3.1.1 Dashboard: List View

The List view is the default view for the dashboard. Each parameter is presented in columns, with each gateway appearing as a single row.

3.1.1.1 Parameters

The Dashboard items are made available by creating thresholds (see the Admin > Thresholds section). Listed as parameters in the column headings, descriptions for them can be found by hovering over the text in the list of statistics (see the Admin > Stats section).

The default parameters are:

Name (ID): Displays the name given to the gateway by the user at set-up, plus the gateway serial number (in brackets).

CallUPLink: The amount of time the call is up for the PCMCIA/Cardbus slot 1 connection.

Heartbeat: The time since the gateway last sent data to the server. The format is HH:MM:SS.

IP Address: The IP (Internet protocol) address assigned to the most recent Internet connection made by the gateway.

Battery: The voltage level of the vehicle‟s battery supplying power to the gateway. The gateway has a built-in voltage meter which monitors voltage and shuts down the unit if voltage levels are too low or too high.

GPS Satellites: The gateway is equipped with a 12-channel GPS receiver. The number shown is the number of GPS satellites from which the gateway is currently receiving signals.

Rx Data: The volume of data received by the gateway for the current day (since midnight). Volume is measured in Megabytes (MB). E.g. 26.836MB.

Tx Data: The volume of data transmitted by the gateway for the current day (since midnight). Volume is measured in Megabytes (MB). E.g. 13.526MB.

Temp Check: The temperature of the gateway, measured in Celsius (0C).

The gateway has a built-in temperature sensor.

Page 22: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

14 oMG-ED-090301

3.1.2 List View: Color Coding

Color coded icons are used to show parameters which are outside of the defined thresholds. Each parameter typically has two threshold levels.

Green: Operating normally, within thresholds

Yellow: Warning level threshold exceeded

Red: Error level threshold exceeded

Blue: No data available

Note that the colored icon next to the address (in the gateway tree panel) indicates the overall health of the gateway, where the worst threshold level for all parameters is shown.

For example, the 12V battery in the vehicle is typically set up with a warning threshold (yellow) of less than 10.8V or greater than 14.7V. The error threshold is set using less than 10.5V or greater than 15.0V. If all other parameters are within the thresholds set (i.e. green) but the battery falls at 10.7V, then the colored icon next to Battery will be yellow. A yellow icon will also be present in the far left of the main screen.

3.1.3 List View: Sorting

Data displayed in the list view columns can be sorted by clicking on the column header. The triangle indicates which column is being sorted. When the triangle is pointing up, data is in ascending order. When pointing down, it is in descending order. The default is Name (ID).

Page 23: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 15

3.1.4 Dashboard: Graph View

The Graph view displays the same parameters as the List view but represented in graphical form. Gateways are represented on the Y axis, with the parameter value on the X axis.

Values within defined thresholds appear green. Any values that are outside of defined thresholds appear as yellow (warning state) or red (error state).

To enlarge a graph, click on the bars within the graph. To return to the multi-graph view, click on Reset.

Some graphs can provide even greater detail. For further details for a single gateway, click on a bar or data point within the graph. A new browser window/tab will open, displaying the Stats for the gateway. The image below shows greater detail for ReportIdleTime for a single gateway. For more information, see the Admin > Stats tab section.

Note: Readonly distinguishes items that can be modified from those that cannot.

Page 24: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

16 oMG-ED-090301

3.1.5 Dashboard: Threshold View

The Threshold view provides a summary for each parameter, including:

1. Totals of each threshold status for the group of gateways selected

2. Minimum value for each parameter for the group of gateways selected

3. Maximum value for each parameter for the group of gateways selected

This view is beneficial because it provides a quick view of the parameters that are out of threshold.

To display additional information about the status of the gateways, click on a numeric value in a column.

For additional information about a particular parameter and to open the Editing Threshold panel (in a new browser window), click on the ellipsis (…) after the parameter name.

Click on Reset to return to the multi-graph display.

Page 25: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 17

3.2 Events Tab

The Events tab provides a quick way to view events received by the Mobility Manager for a specific time period. For advanced users, this feature is useful for testing or troubleshooting gateways.

Select a group, sub-group or individual gateways from the gateway tree.

Enter text in the Filter field to help narrow the scope of the search.

Use the drop-down box to select the time period for which to display the data. The options are All, Previous Hours, Previous Days, Previous Months and Range. Enter the numerical information in the corresponding box. The above image shows data from the previous 1 hour. Click on Search to call up the data.

The data can be sorted by clicking on the column header.

Click on the Excel icon to export the list of events to Excel.

Note: Readonly distinguishes items that can be modified from those that cannot.

Page 26: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

18 oMG-ED-090301

3.3 Map Tab

The Map tab provides a geographical view of your fleet. Use the gateway tree to select the group, sub-group or individual gateway to view on the map. Each gateway is shown as a location on the map according to the most recent location data transmitted.

Gateways are identified using numerical markers, with a list of details by gateway shown to the right of the map. If the gateway is in warning or error state for any threshold, the gateway marker will be yellow (warning) or red (error), rather than green (no issues). To obtain detailed event information, click on a gateway marker on the map.

To center the map for a single gateway, click on the gateway name in the list to the right of the map.

Click on Manual Refresh to refresh the map.

Page 27: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 19

3.3.1 Navigating Within the Map

Microsoft Live Maps provides intuitive ways to zoom and pan within the map view.

− Zoom in or out using the scroll button of your mouse. Hold the mouse pointer over the map location you wish to remain centered.

− Pan in any direction by clicking and holding the left button of your mouse, and dragging the map.

− To zoom using the map controls, use the (+) and (-) icons (shown above) to zoom in and out.

− To pan using the map controls, press one of the four arrows in the blue circle

Additional controls:

2D: Standard two-dimensional view. Recommended view.

3D: Links you to Microsoft‟s Virtual Earth software, which is not integrated with onBoard Mobility Manager. Not recommended.

Road: Standard road map view.

Aerial: Satellite view, useful for viewing terrain and natural landmarks.

Bird’s Eye: Available in most metropolitan areas, Bird‟s Eye view provides a photographic view from several hundred feet up.

Labels: Turns street and place names on/off.

Page 28: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

20 oMG-ED-090301

3.3.2 View Gateways by Time/Date

When viewing maps, users can select which time period they view. Time used is the data transmission time from the gateway.

Latest: View gateways on the map using the latest information received. This option also ensures that every gateway is visible (note that the filters in the top right of the screen also affect which vehicles are visible).

Last Hour: View only gateways which have sent information in the last hour

Last Day: View only gateways which have sent information in the last day.

At: Select the specific time first and then the date. Gateway locations for that particular time and date will be displayed.

3.3.3 Filter Gateways Visible

Additional filters are available for the map view.

Filter field: Similar to the filter in the gateway tree. Enter part of the name (or other gateway labeling data) in the box to limit the gateways displayed.

Page 29: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 21

All: Drop-down box allows users to select a time period (All 10minutes,30m, 1hour, 2h, 6h, 12h, 24h). Only gateways that have reported within that time period are displayed.

Nominal Events: Green circle icon. When selected, shows all gateways, including those operating within threshold limits (green). When de-selected, only gateways in warning (yellow) or error (red) state are visible.

Manual Refresh: Refresh the page to show the latest information.

Page 30: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

22 oMG-ED-090301

3.4 Stats Tab

The Stats tab provides a high level of detail and is recommended for advanced users only.

Parameter (statistic) names are listed on the left of the screen. Results are displayed for the gateway(s) selected - group, sub-group or single gateway. Hovering over the parameter name provides the description for it.

If All is selected, each parameter reported will be displayed.

3.4.1 Views

The user may choose from several different views of the data found in the stats tab:

HTML: List of data in columns. Data may be sorted by clicking the column header.

Graph: Provides a graphical view of the data.

Readonly: Distinguishes items that can be modified from those that cannot.

Export: Export the data to Excel.

Refresh: Manually refresh the information.

HTML View

Graph View Export

Readonly

Refresh

Page 31: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 23

For the default view (HTML), the results are sorted by date, with the most recent at the top of the list. However, data may be sorted by clicking on column headers. In the example below, data is sorted by temperature, in descending order. This is denoted by the triangle pointing down. Click on the column header a second time and the data will be sorted in ascending order, with the triangle pointing up.

Use the drop-down box to select the time period for which to display the data. The options are Latest, Previous Hours, Previous Days, Previous Months and Range. Enter the numerical information in the corresponding box. The image below shows the time period for the previous 2 hours. Click on Search to call up the data

The example below shows a sample of data exported to Excel:

Date Stat Gateway Value

3/21/2009 5:05 Link1-TotalrxBytes H078 740,069

3/19/2009 17:01 Link1-TotalrxBytes H078 2,050,218

3/19/2009 16:37 Link1-TotalrxBytes H078 1,996,618

3/19/2009 16:11 Link1-TotalrxBytes H078 1,937,808

3/19/2009 15:47 Link1-TotalrxBytes H078 1,878,855

3/19/2009 15:03 Link1-TotalrxBytes H078 1,803,895

3/19/2009 14:41 Link1-TotalrxBytes H078 1,752,574

3/19/2009 14:13 Link1-TotalrxBytes H078 1,700,738

Page 32: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

24 oMG-ED-090301

3.5 Admin Tab

The Admin tab provides access to seven administrative panels.

Note that on the hosted server, only Thresholds and Zones are available options.

3.5.1 Gateways

The Gateways panel is used to add, modify and delete gateways.

Page 33: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 25

Add a new gateway:

− Click on Add to open the Adding Node panel

o ESN*: Electronic Serial Number (used to uniquely identify the gateway)

o Name: enter the name or alias for the gateway

o Group: use the drop-down menu to select the group to which the gateway will belong

o Customer: enter the customer information for the gateway

o Location: enter the location information for the gateway

o Contact: enter the contact information for the gateway

o Notes: enter additional information regarding the gateway

− Click on Save to create the new gateway

Gateways can be deleted by clicking in the checkbox next to the gateway label and then on Delete.

To edit an existing gateway, click on its gateway link in the Label column to open the Editing panel (or click on Edit). Gateways can be moved from one group to another from this panel.

* denotes a required field

Notes:

The Add a gateway feature is only available on the Appliance version of the oMM.

Administrators can add gateways before they go online. When a gateway boots up, the oMM matches it based on the ESN. Thus, administrators can pre-assign gateways to a fleet and configure additional properties.

Page 34: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

26 oMG-ED-090301

3.5.2 Users

The Users panel is used to set-up, modify and delete user IDs for the oMM.

Add a new user:

Page 35: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 27

− Click on Add to open the Adding new user panel

− Enter the Identification parameters

o In the Name* field, enter the new user name

o For Customer group, use the drop-down menu to select the group for which the ID is being created

o Enter the password in both fields

o If an expiry date is required for the ID, click in the expiry field and a calendar will open. Select the expiry date for the ID.

− Select the Privileges

o oMM: select the privilege - None, Read or Read/Write

o Tabs: select the tabs for which the user will have access. Note that the tabs available depend upon the optional packages purchased.

o Reports: select which reports will be available to the user

o Stats: click All to enable Stats (default)

− Configure Preferences

o Measurement units*: select Imperial (default) or Metric

o Tracker refresh*: enter the refresh rate, in seconds, for the tracker refresh

o Dashboard refresh*: enter the refresh rate, in seconds, for the dashboard refresh

o Oldest report*: enter the number, in days, for the oldest report available

o Restricted IP: limits logins from a range of IP addresses

o Maximum threshold emails per day: enter the maximum number of threshold emails the user will receive per day (blank implies unlimited)

o Time zone: use the drop-down to change the time zone for the user. The default is the server‟s time zone.

o Dashboard items: use this to limit the dashboard items available to the user. The default is all.

− Click on Save to create the user ID

Users can be deleted from the gateway by clicking in the checkbox next to the user label and then on Delete.

* denotes a required field

Page 36: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

28 oMG-ED-090301

3.5.3 Stats

The Stats panel lists the stats that have been created. Stats can be deleted from the gateway by clicking in the checkbox next to the stat label and then on Delete.

Add a new stat:

− Click on Add to open the Add a Stat panel

o Label*: enter a label name for the new stat

o Unit*: enter the type of data (e.g. percentage, Celsius, etc. See image above for additional examples.)

o Delete after*: enter the number, in days, after which the stat will be deleted from the oMM

− Click on Save to create the new stat

Stats can be deleted from the gateway by clicking in the checkbox next to the stat label and then on Delete.

* denotes a required field

Page 37: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 29

3.5.4 Thresholds

The Thresholds panel allows users to specify threshold settings that can be applied to one or multiple gateways. Thresholds can be created without warning or error conditions. Once created, it is available, for display, on the Dashboard.

Adding a new threshold:

Page 38: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

30 oMG-ED-090301

− Click on Add to open the Adding a Threshold panel

− Configure the Properties

o Label*: enter the name of the threshold

o Group or Gateway*: the group/gateway listed will be the one selected in the gateway tree

Click on Filter to open the Sub-Filter Options to configure the following options:

Version pattern: specify the gateways on a particular software version (e.g. 2.8.1)

Name pattern: specify the gateways with this patter in their name

Customer, Contact, Location: enter the appropriate information

Notes: enter any notes for which to search

Reporting within (days): only consider the gateways that have reported within the days specified in this field

Matching vehicles: Use ctrl+click to select more than 1 vehicle

o Share with child groups and nodes: By default, this option is selected to set the threshold to all of its members/children

o Stat: Use the drop-down to select the stat

o Default value: Specifies a value for which reporting is not expected

o Matching Labels: Some stats use sub-keys (e.g. AssetTemperature) and the sub-key is the asset tag ID. This provides a way to limit the threshold to a specific asset. E.g. AssetTemperature:1234567890 > 50c = error.

o Dashboard position*: Enter a value between 1 and 99, where 1 is farthest left, 98 is farthest right and 99 is off of the dashboard. Items with the same position value are sorted alphabetically.

o Notes or instructions: Enter the instructions that will be included in alerts and email messages.

− Set the Warning Conditions

o Warning Criteria*: This field propagates its value from the the Stat field, so if AssetBattery is selected in the Stat field, the Warning Criteria will reflect this

o Actions*: Select the actions to be taken to report a warning

Log Event: Default action. It is recommended that this stay enabled so that all warning are written to a log file.

Send Email: Select to enter the email address(es) to which an email will be sent, advising of the warning condition.

Record Video: If a camera is installed, it can be set to start recording when a threshold is crossed

Page 39: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 31

Tweet: Select to enter the Twitter credentials so that a tweet will be sent, advising of the warning condition.

Hold Time*: Enter a value between 0 and 600. This holds this state even if the value clears for that number of minutes.

Delay Time*: Enter a value between 0 and 600. This delays raising this state for that number of minutes.

− Set the Error Conditions

o Warning Criteria*: This field propagates its value from the the Stat field, so if AssetBattery is selected in the Stat field, the Error Criteria will reflect this

o Actions*: Select the actions to be taken to report a warning

Log Event: Default action. It is recommended that this stay enabled so that all warning are written to a log file.

Send Email: Select to enter the email address(es) to which an email will be sent, advising of the warning condition.

Record Video: If a camera is installed, it can be set to start recording when a threshold is crossed

Tweet: Select to enter the Twitter credentials so that a tweet will be sent, advising of the warning condition.

Hold Time*: Enter a value between 0 and 600. This holds this state even if the value clears for that number of minutes.

Delay Time*: Enter a value between 0 and 600. This delays raising this state for that number of minutes.

− Click on Save to create the new threshold

Thresholds can be deleted from the gateway by clicking in the checkbox next to the threshold label and then on Delete.

* denotes a required field

Page 40: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

32 oMG-ED-090301

3.5.5 Zones

From the Zones panel, users can identify, add and delete zones (i.e. virtual boundaries or geofences). Zones allow administrators to monitor vehicles traveling out of designated zones. If a vehicle is expected to only travel within a certain area, a threshold can be set up that triggers an alert when the vehicle leaves that zone.

Adding a new zone:

− Click on Add to open the Adding a Zone panel

o Label*: Enter the name for the new label

o Owner group: Use the drop-down menu to select the preferred group

o Color*: Click on the field to open the color picker or enter the 5-digit code (if known)

− The default map is a view of the world. Zoom in on the map to the area in which to create the new zone.

o Under Map area*, click on Add to add a 4-point rectangle on the map (the color will be the one chosen above)

Page 41: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 33

o Each point is labeled. The top-left point is point1. Click and drag it to the first boundary for the zone.

o Click and drag the remaining points to define the boundary.

To refine the boundary, click on Add (in the Map area toolbar) to add additional points. The new points will be labeled in numeric order.

Adding more points results in a better defined boundary, especially if there is a curve in the boundary.

Use Zoom In/Out and drag the map to achieve the best views of the boundary areas.

Page 42: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

34 oMG-ED-090301

To remove a point, click on Del.

To clear the zone from the map, click on Clear (note that once cleared, there is no way to retrieve the zone).

Click on Find to locate a location on the map.

To display other zones on the map, click on Show Other Zones.

To import a zone into the new zone, use the drop-down menu to select it. Importing is a way to create a zone based on an existing one and eliminates the need to start from naught.

Click on Advanced to define the zone using raw point text in latitude/longitude position pairs. Click on Update when complete.

− Click on Save to save the new zone.

Page 43: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 35

Editing an existing zone:

− From the main Zones panel, click on an existing zone name to open the editing panel.

− From this panel, users can change the name and color of the zone, add and delete points to redefine the boundary, change the owner group and import an existing zone.

− Click on Save to save the changes.

To delete a zone, select it from the main Zones panel and click on Delete. Alternatively, click on Delete from the editing panel.

Page 44: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

36 oMG-ED-090301

3.5.6 Sessions

The Sessions panel displays the login IDs currently logged onto the oMM. It also provides the host IP address and the last page visited.

To force a logout, select the ID(s) and click on Logout.

3.5.7 Debug

The Debug panel provides a system log dump of the oMM and is used by In Motion Technology for advanced troubleshooting. It lists the user ID, the host (if applicable) and the message. Use the filter options to narrow the results. The results can also be exported to Excel.

Page 45: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 37

4 Reports

Reports provide the true power of the onBoard Mobility Manager. In addition to reports for the Core Mobility Manager functionality, reports are also available for the optional applications - Tracker, Telemetry and Asset Manager. Details for these reports can be found in the respective user guides for each application.

For the purposes of this user guide, only the Core Mobility Manager Reports are covered.

To generate a report, select Reports > New > Report Type

4.1 New Reports

The reports that are available depend upon whether optional packages were purchased. By default, the available reports are Network and Misc.

Page 46: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

38 oMG-ED-090301

4.2 Before You Begin

There is information that is required in the report input panels for the reports.

The common input fields are:

Gateway(s)*: The gateway(s) that is selected in the gateway tree will be selected by default. To change it, enter the name manually. Click on Filter to open the sub-filter options.

Report time range*: Use the drop-down menu to select from Previous Months, Previous Weeks, Previous Days or Range. Enter the numeric value in the field. When Range is selected, use the calendar pop-up to select the dates. Alternatively, enter the date and time manually (yyyy/mm/dd hh:mm).

Correct vehicle timestamp against universal standard time (from GPS): Enable when generating a report to compare results across vehicles.

Show friendly names if available: If user-friendly links are used, enable this and they will be used in the report.

Enable Background Generation: Enable to create reports that can be saved for future use.

For every report, there exists the option to run the report once (click on Run Now) or to create a schedule for the report.

Report Name*: Enter a name for the report

Run as user: Use the drop-down menu to select the user for which the report will be run (users may have varying privileges)

Email format: Select the format in which the report will be emailed (HTML, the standard report format or as an Excel spreadsheet)

Page 47: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 39

Generate every: Use the drop-down to select from Do Not Generate, Once, Daily, Weekly or Monthly

Start reporting: Click in the field for a calendar pop-up and select the start date for the report schedule (note that the current day‟s date is the default)

Stop reporting: Click in the field for a calendar pop-up and select the end date for the report schedule (leave blank for no end date)

Email results to: Enter the email address(es) to which the report will be sent. Separate addresses with a comma.

Retain results for: Enter the number of days for which the server will retain the report (default is 30 and 0 implies that the report is never retained). Hosted customers can retain reports for up to 90 days. Customers who host their own appliance can determine their own retention policies.

* denotes required information

Click on Options > Show advanced edit fields to display additional fields.

Active link colors: Click on each link to change the default color (use the color picker)

Split table results by: Use the drop-down menu to split the report results by None, Second, Minute, 5 Minutes, 30 Minutes, Hour, 8 Hours, Day, Week or 30 Days. The selection should best reflect the time range (i.e. if the range is one month, splitting the result by minutes or hours may not result in a satisfactory report). The default is Day.

Split graph results by: Use the drop-down menu to split the report results by None, Auto, Second, Minute, 5 Minutes, 30 Minutes, Hour, 8 Hours, Day, Week or 30 Days. The default is Auto

Max bootup time*: Enter the amount of time (0-1800 sec) to allow the gateway to boot before reporting CALLDOWN. The default is 180.

Min call up time*: Enter the amount of time (0-1800 sec) that a call must remain up in order to be considered up.

Max time between events*: Enter the amount of time (0-86400 sec) to allow between gateway events before considering the unit non-responsive.

Page 48: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

40 oMG-ED-090301

Initialize vehicle state at report start: Use this to scan the call state before the call start to avoid an UNKNOWN state at the beginning. The default is enabled and it is recommended that it stays enabled.

Click on Run Now to immediately generate the report. Click on Run in Background to run the report in the background and to save the report on the server (go to Results for the report). Click on Save to save the report for future use without immediately generating it.

Reports also include the following icons:

Save Results: Name and save the report on the oMM. Go to Results to retrieve it.

Excel: Open and/or save the report in Excel.

Change: Change the report but retain the same gateway(s) and information in the input fields

Edit: Edit the existing report input fields to generate different results.

4.2.1 Network: Availability Trend Report

The Availability Trend report shows the availability of each gateway as a percentage, over a selected period of time. Availability percentage is defined as the duration of time a gateway had a data connection (Cellular, Wi-Fi or other) as a percentage of the total time period selected.

Note: the header of each report provides a description of the report.

Additional input fields:

Limit to map area: Use the drop-down menu to filter the search results according to predefined zones (see the Admin > Zones section).

Limit to network types: Use to run the report for a certain type of network. Click in the field to select the network type.

Page 49: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 41

The report presents the results in both graphical and column/row formats for Results by vehicle and results by vehicle and network. Clicking on a gateway in the Node column will generate an Availability Details report for it (see next section). Use the legend at the bottom of the report to determine the results for the average percentages.

Page 50: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

42 oMG-ED-090301

4.2.2 Network: Availability Details Report

The Availability Details report provides a graphical and detailed view of the availability (connected to a wide area data network) of gateways in your fleet. As with the availability trend report, availability percentage is defined as the duration of time a gateway had a data connection (Cellular, Wi-Fi or other) as a percentage of the total time period selected.

This report is best used as an initial bird's eye view into the state of a larger number of gateways.

The fields for the Availability Details report are identical to those in the Availability Trend report.

Page 51: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 43

The results are demonstrated in the following image:

If a group of gateways is selected, the availability average (for the period of time selected) for it is presented, by a bar graph, in the top header of the report.

Below the top header, data for each gateway within the group is also represented. The information includes an overall average availability bar graph and numeric data, and pie charts that present data for the WAN cards used by each gateway. Click on the percentage value link (to the right of a gateway‟s bar graph) to open the Coverage Trail Map Report input form in a new browser window. Run the report to show the actual locations of good/poor coverage.

Note: click on the ellipsis (…) after a gateway name to collapse or expand that gateway‟s results.

Page 52: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

44 oMG-ED-090301

The All unit network summary section uses pie graphs to present a network summary for each type of WAN card used by the group of gateways. This is useful when comparing cards from two data carriers if cards are used side-by-side across the field.

Finally, the Network per vehicle summary section presents numeric data for the group‟s network availability per vehicle.

Note: Green represents good availability; yellow represents time periods during which the gateway was not attempting to connect and red represents time periods during which the gateway was attempting to connect but could not.

The report includes the option to filter the results. Filter the report to only show gateways with availability results that are less than the percentage specified. This helps to highlight the problematic and unstable networks.

Additional information contained in the report:

Report interval: Time period covered by the report

Operational time: Total time excluding boot times

Offline time: Boot times

Overall availability during operation time: Summary of all links. This will be the same as the individual link if only one link is used.

Link active: Total time the card(s) maintained a data connection and is being used for traffic.

Calldown: Total time the card(s) attempted to connect but could not. Note that for multiple cards, the result for calldown that appears in the overall availability section (at the top) is the total time whereby none of the cards could connect.

Callup: Total time that there is a callup but is not being used for traffic. This includes the time it takes to verify a link.

Network boot time: Time taken for the gateway to boot up and the card to make a data connection. Average, minimum and maximum times are shown.

IP Networks: List of IP networks used by the card at some point during the time period.

Page 53: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 45

4.2.3 Network: Coverage Map Report

This Coverage Map report tallies all gateway network connectivity states within geographic areas and plots coverage, assigning a color between green (good) and red (bad).

This report is best used to show an aggregated result where one or (likely) more than one gateway visits each area more than once. It is also intended as a means of identifying geographic regions where connectivity is a systemic issue.

For cases where there is only one gateway and where that gateway visits each area only once, use the Coverage Trail report instead.

Additional input fields:

Average call up %*: The default 95.0. This number determines the color shading scale used, with percentages above this number shown in green.

Bad call up %*: The default 90.0. This number determines the color shading scale. The better the coverage in your area, the higher these numbers should be to highlight results less than 100%.

There is a values-to-color legend at the bottom of the map. By default, locations where the gateway spent less than 30 seconds are not shown.

Page 54: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

46 oMG-ED-090301

Clicking on shaded regions displays information pop-ups about values in that area:

Pop-up details:

# vehicles: Shows the number of vehicles which contributed data to this area.

Time up: Time a call up was maintained as a percentage of the total time a gateway was in this area.

Time running: Total time a gateway was in this area.

Earliest event: First event that contributed data to this square.

Latest event: Last event that contributed data to this square.

# visits: Number of separate data log transmissions in this area that contributed to this report.

Events: Click on the link to generate a more detailed report (below) on the activity in the square. The map shows the specific area while beneath it, is a list of each data point which contributed to the square. The date/time stamp shows how frequently reports were received. In the Text column, the GPS location is shown except where the call up or call down status changes.

Page 55: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 47

Focus on this area: Click on the link to produce a more detailed coverage map for the area covered by the original individual square. This feature is useful for highlighting exact locations of poor coverage.

However, be aware that when focusing on a small area, the time spent by a gateway in the area to generate the data may be small.

Page 56: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

48 oMG-ED-090301

4.2.4 Network: Coverage Trails Report

The Coverage Trail report graphs gateway position as a continuous line (trail) on the map. The trail color indicates the connectivity state of the gateway (a legend is shown below the map).

This report is best used for a single gateway over a smaller time period (i.e.: one gateway trip) where the same location is not visited repeatedly. For cases of more gateways, larger time periods or repeat visits consider using the Coverage Map report instead.

The fields for the Coverage Trail report are identical to those in the Availability Trend and Availability Details reports.

The map displays various gateway event including the trip start and trip stop points, and WAN card events. Small, medium and large green circles indicate where gateways stopped (the larger circle indicates a longer stop time). Black circle indicate where GPS signal was lost (often due to underground parking). Blue triangle markers provide location information.

Click on any of the markers to open a pop-up that provides additional information.

Page 57: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 49

4.2.5 Network: Link Utilization Report

The Link Utilization report shows a high level of detail for WAN data link connectivity state over time. It is best used for a small number of gateways and is ideal for identifying connectivity issues that occur at specific times of day.

The fields for the Link Utilization report are identical to those in the Availability Trend, Availability Details and Coverage Trail reports.

A color-coded legend shows the various connectivity states. The name of the card is used to indicate the link active state. Hovering over any point on the graph displays the date, time, link name and its connectivity state and connection duration.

Page 58: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

50 oMG-ED-090301

For greater detail, click on any point on the graph to open up a new tab showing each contributing event. This feature is recommended for advanced users only.

The data below the map provides individual event records, with a location link.

Page 59: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 51

4.2.6 Misc: Configuration Audit Report

The Configuration Audit report allows users to view log file data which would otherwise only be able to be viewed on the local craft interface (LCI) by attaching a monitor directly to the gateway. This report should only be used by advanced users.

Additional input fields:

Gateways*: The gateway(s) that is selected in the gateway tree will be selected by default. To change it, enter the name manually. Click on Filter to open the sub-filter options.

Config item time range*: Use the drop-down menu to select from All, Previous Months, Previous Weeks, Previous Days or Range. Enter the numeric value in the field. When Range is selected, use the calendar pop-up to select the dates.

Configuration Categories: Select from the list the configuration categories to include in the report

Show standard config items only: Enabled by default, this allows for items not configurable through the LCI

Normalize network configs: Where cards are inserted into different slots, this normalizes by card, not by card slot. The default is enabled.

Convert blank values to default: This returns any blank value to the default given at manufacture. The default is enabled.

Skip disabled config entries: This ignores entries which are disabled. The default is enabled. Uncheck this option to see disabled entries (e.g. VPN, network links).

Find active networks and skip those that are not: The default is enabled. Uncheck the option to see all networks configured on the gateway.

The following report displays configuration items by category. Note that for 6 gateways, 118 configuration items were detected (100+10+8).

See next page for image.

Page 60: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

52 oMG-ED-090301

Page 61: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 53

There is a color-coded legend in the header:

Green (Identical): The number of items that are identical across all gateways

Yellow (Alternate): The configuration varies once across the node list

Red (Varied): The configuration varies twice or more across the node list

The following columns are also contained in the report:

Green circle: Status (same as above)

Config: Name of the configuration item

Popular value: Actual value of the configuration value

# Gateways: Count for the popular value. For green items, this is the total number of gateways

Second popular value: For yellow and red items, where there is more than one value, this value is the second most common

# Gateways: Count for the second popular value

No report: Number of gateways that did not set this configuration item

Note: Click on an item name in the report to expand the details.

A Gateway Exception Report is also available. This is a summary, by gateway, of each configuration item not common to the fleet. The software version is also included.

The following example shows that „Vehicle ID‟ (under „GPS Config‟) has 5 variations (i.e. 5 gateways have different values than Medic 2). This places it in the „Red (varied)‟ category. This is expected because Vehicle ID must be unique within the fleet. Additionally, „Beacon Server‟ (under „Miscellaneous‟), only has 2 variations in „Medic 1‟ and „Truck 4‟, so it, too, falls into the „Yellow (Alternate)‟ category.

Therefore:

Green (Identical): 100 items were identical across 6 gateways

Yellow (Alternate): 10 items had 2 variations

Red (Varied): 8 items had 5 variations

See next page for image.

Page 62: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

54 oMG-ED-090301

4.2.7 Misc: Event Viewer Report

The Event Viewer report provides the raw events that were uploaded by the gateways. These files contain a large amount of data in a format that is not easily decoded. This report is recommended for advanced users only.

Additional input fields:

Log files to look at: The default, MHS1CriticalLog, monitors critical events. Monitor additional events by selecting them from the list of available items.

Limit lines with text: If users know which event type is to be investigated, enter the text from the line as a filter.

Page 63: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 55

4.3 Reports for Optional Packages

The following reports are available only when the optional packages are purchased. For more information about optional packages, see the Optional Packages section.

4.3.1 Telemetry: Driving Behavior

The Driving Behavior report categorizes various telemetry-based, driving behavior safety parameters (e.g. long idles, hard accelerations, excessive speeding, etc.) and summarizes them across a range of vehicles over a time period. This report is best used with multiple vehicles.

Additional input fields:

Speed warning*: The speed for which a warning state will be displayed for being above the speed limit. The default is 70 (mph). Note that this assumes a maximum speed limit of 65 mph. Lower this value if the maximum limit is lower than 65 mph.

Speed error*: The speed for which an error state will be displayed for being above the speed limit. The default is 80 (mph). Note that this assumes a maximum speed limit of 65 mph. Lower this value if the maximum limit is lower than 65 mph.

Acceleration warning*: The acceleration speed (mph/second) for which a warning state will be displayed. The default is 5.

Acceleration error*: The acceleration speed (mph/second) for which an error state will be displayed. The default is 10.

Deceleration warning*: The deceleration speed (mph/second) for which a warning state will be displayed. The default is -5. This value implies hard braking.

Deceleration error*: The deceleration speed (mph/second) for which a warning state will be displayed. The default is -10. This value implies hard braking.

RPM warning*: The RPM value for which a warning state will be displayed. The default is 3500. This value implies high engine revolutions and can contribute to such things as poor gas economy or

RPM error*: The RPM value for which a warning state will be displayed. The default is 6000.

Page 64: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

56 oMG-ED-090301

This report displays the warnings and errors for driving behavior. A vehicle‟s average and maximum speeds are displayed, making identifying good and poor driving easy. The amount of time a vehicle spent above the limits is also available. RMP, quick acceleration and hard braking data is provided in the number of occurrences.

Notes:

− Black text: normal

− Orange text: below average

− Red text: considerably below average

− Green text: best result

− Grey: text: very low run time

− Run Time: the cumulative time that the engine was running

− Drive Time: the cumulative time that the vehicle was moving

− Odometer distance is only reported when the Telemetry package is installed

Page 65: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 57

4.3.2 Telemetry: Fuel Fillup

The Fuel Fillup report displays the data on the date/time, location and fuel fill-up amounts. This report is good for correlating actual vehicle fuel fill-ups with fuel bills and for identifying areas of potential fuel savings as well as for comparing driving behavior across a fleet of the same vehicles performing the same duties

Additional input fields:

Tank size*: Enter the size of the fuel tank (gallons)

Fuel cost*: Enter the cost of fuel (per gallon)

Minimum fill size*: Enter the minimum amount of fuel to be considered as a fill-up (gallons)

The report displays the fuel fill-up locations on the map as numeric markers. Clicking on a marker opens a pop-up with the address of the fueling station and a list of vehicles that visited it for refueling. Additionally, the dates and fill-up amounts are provided. Below the map, the same information is provided in text form, along with distance, efficiency and the cost to fill up.

Page 66: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

58 oMG-ED-090301

4.3.3 Telemetry: Fuel Consumption

The Fuel Consumption report calculates and reports the fuel consumption of a range of vehicles over a period of time. Users must provide fuel capacities and costs and is best used over a range of vehicles with similar fuel capacity.

Fuel consumed and the cost shown is calculated using a value returned for percentage of fuel remaining in the tank. Several factors can affect the accuracy of this, including terrain, ambient temperature and pressure. For fleets with a variety of vehicle models (i.e. different fuel tank sizes and typical fuel economy), it is recommended that similar vehicles be grouped before using this report for multiple vehicle comparisons.

Additional input fields:

Tank size*: Enter the size of the fuel tank (gallons)

Fuel cost*: Enter the cost of fuel (per gallon)

This report displays the cumulative time each vehicle was in use along with the time spent idling. It also calculates the fuel used, including when the vehicle was idling. Finally, the report shows the fuel efficiency and the total amount spent on fuel.

Notes:

− Black text: normal

− Orange text: below average

− Red text: considerably below average

− Green text: best result

− Grey: text: very low run time

− Run Time: the cumulative time that the engine was running

− Drive Time: the cumulative time that the vehicle was moving

Page 67: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 59

4.3.4 Telemetry: Fuel Consumption Trend

The Fuel Consumption Trend report calculates and reports fuel efficiency (mpg) per time period over vehicles and date range. Trends may be the result of factors such as shift changes or peak hour driving versus off-peak driving. Use it to provide more details and greater information from the Fuel Consumption report.

Additional input field:

Tank size*: Enter the size of the fuel tank (gallons)

The report displays the run time for each vehicle along with the average fuel consumption. It also provides the fuel consumption per day.

4.3.5 Telemetry: Vehicle Diagnostics Report

The Vehicle Diagnostics report determines diagnostic information from Telemetry-sourced vehicles (i.e. MIL, Voltage and Temperature) and reports on ranges of values across a fleet of vehicles and a period of time. The report is best used for many vehicles to provide a status overview for the fleet.

Additional input fields:

Low voltage level*: The voltage level at which to be notified (volts)

High coolant temp*: The coolant level at which to be notified (Fahrenheit)

This report provides the minimum and maximum voltage levels to help diagnose battery and electrical issues; the maximum coolant temperature to diagnosis engine problems such as over-heating; the occurrences of MILs (malfunction indicator lamps) and the Odometer distance driven with an MIL. Additionally, if there are any troubles codes (i.e. On-Board Diagnostics Parameter IDs or OBD-II PIDs) for the vehicles, they will appear in the report.

Page 68: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

60 oMG-ED-090301

4.3.6 Telemetry: Odometer Check

The Odometer Check Accuracy Check report compares vehicle‟s odometer and speedometer readings against similar values as reported by GPS, which is considered more accurate. The differences are reported which are intended to identify potential calibration issues across a fleet of vehicles.

Note that the odometer parameter is not a standard parameter and, as such, may not be available on all vehicles. Also, if a vehicle travels in a built-up, mountainous or forested area, acquiring a GPS fix may be intermittent and cause differences between GPS and odometer.

This report displays the run time of the 9 vehicles, the cumulative time each vehicle was in use, the odometer reading at the start of reporting and the distance travelled. It also provides an average for the fleet.

Page 69: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 61

4.3.7 Telemetry: Unauthorized Usage

The Unauthorized Usage report details the time spent driving the vehicle while it is disconnected from the oMG (i.e. off), has no GPS (disconnected GPS antenna), outside of the defined hours, or outside of the designated zones. The intent is to detect when vehicles are being used outside of their expected use conditions.

Additional input fields:

Allowed drive times: Enter the times during which vehicle use is permitted (e.g. a driver‟s work hours). Blank implies all times are permitted.

Drive zones: Select the zones (e.g. a driver‟s territory) within which the vehicles are expected to drive.

The report example shows that, in addition to the odometer details for 9 vehicles, two of them have engaged in unauthorized usage, as defined by the oMM. Note the Distance with no OBD/Telemetry and Odometer Distance with No GPS columns. If either of these readings are a significant portion of the total distance traveled, users should investigate. It could identify an employee who disconnected the GPS antenna for unauthorized vehicle use.

4.3.8 Assets: Asset Usage Summary

The Asset Usage Summary report provides a summary view of assets managed by the fleet of vehicles. Output shows a summary of the percentage of time the Asset was in range of the gateway to which it was assigned.

Page 70: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

62 oMG-ED-090301

4.3.9 Assets: Asset History

The Asset History report provides the known history of a selected asset over a specific time range. Assets are plotted on a map and move over time. Assets can be transferred from one gateway to another and this is reflected on the map. This report is best used to track the performance of a single asset over a period of time and across one or more vehicles.

The length of time is represented visually using small, medium and large circles, corresponding to the small, medium and long idle times entered. To prevent false alarms, it is recommended that the time an asset is away from a vehicle before being marked missing is at least 10 minutes. However, this will delay email alerts for assets that are left behind.

Additional input fields:

Limit to map area: From the drop-down menu, select the area for which to limit the area. The default is none.

Time an asset needs to be lost before marked MISSING: Enter the value after which the asset is considered missing (in minutes). The default is 10.

Report only on assigned assets: When enabled, reporting will be limited to assets which have been assigned to vehicles. The default is enabled.

4.3.10 Assets: Vehicle Assets

The Vehicle Assets report is similar to the Asset History except that this focuses on all assets in a vehicle over a period of time. It graphs the locations of vehicles and assets whether they are in or out of the vehicle. The report does not search for other vehicles recognizing the selected assets within this time frame. It is best used to obtain a summary of asset performance (or usage) for assets assigned to specific vehicles.

The input fields are identical to the Asset History report.

Page 71: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 63

4.4 Templates

Templates are scheduled reports to be run in the future. Users can configure the report to run on a scheduled day at a specific time.

The example below shows that the Availability Trend was scheduled for one gateway, for two different days while the Event Viewer Reports was scheduled for 3 different gateways.

To edit a report, click on its name. To delete a report (or several), checkmark it and click on Delete.

Page 72: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

64 oMG-ED-090301

4.5 Results

The Results panel contains the list of all saved reports. When generating reports, users can save the report to the server.

Reports are listed with the most recent at the top. Click on a report name to view it. Click on a column header to sort the list. To delete a report, select it and click on Delete.

Page 73: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 65

5 Optional Packages

More information about the optional packages can be found in their respective user guides.

5.1 Tracker Tab

The Tracker tab plots all known locations of a selected unit. This tracks the geographical locations of all units/vehicles in a fleet.

The following options are available:

Autocenter: By default, the map will automatically center the gateways on the map

Zones: Display predefined zones on the map

Traffic: Display traffic flow information on the map

Phones: Click to communicate with selected vehicle

Filter: Use to filter vehicles by name or group name

Use the drop-down menu to filter vehicles by time since the previous report. Nominal events (those operating within the threshold limits) are displayed by default (green circle icon). De-selecting it displays only gateways in warning and error states.

Clicking in the purple arrow displays only the gateways that have moved in the last 5 minutes.

To facilitate identifying the gateways, the label font size displayed on the map can be changed by using the drop-down menu. The default is 6pt.

Page 74: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

66 oMG-ED-090301

5.2 Telemetry Tab

The Telemetry tab displays data for vehicle performance and maintenance. Using compatible scanner hardware connected to the vehicle‟s data bus (OBDII), vehicle diagnostic information, such as odometer, fuel level and warning lights, is interpreted and presented.

Not all Dashboard items are applicable to the Telemetry panel. Go to Options > Preferences and add the necessary items to the Dashboard.

5.3 Total Reach Tab

From the Total Reach tab, users can run a VNC (Virtual Network Computing) session to connect to a VNC server on a host (e.g. laptop) connecting to an oMG. By connecting to a device (e.g. laptops, handhelds, etc.) in the oMG LAN or Vehicle Area Network (VAN), this feature is similar to running Remote Desktop. Multiple computers on the oMG can be accessed simultaneously.

To connect to a session, click on the Hostname link.

Page 75: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

oMG-ED-091001 67

5.4 Assets Tab

The Assets tab displays data about the fleet‟s optional equipment and to which gateway the equipment is assigned. The information displayed allows users to track the equipment in transit but also warns when it is no longer in the vehicle (State column). Additionally, the exact location is available which makes for easy retrieval if the equipment is left out of the vehicle.

The default name for the assets is their unique ID. To add a new asset, click on Add. Enter the information and click on Save.

To edit as asset, click on the individual asset, in the Unique RF ID column, to open the Editing panel. Update the information and click on Save.

The Editing panel can also be used to delete assets from the oMM. Alternatively, select the asset from the main panel and click on Delete. The asset returns the next time the unit reports it.

Page 76: oMM-ED-091001 - oMM User Guide 2_7

onBoard Mobility Manager oMM User Guide 2.7

68 oMG-ED-090301

Appendix A. In Motion Technology Inc. Contacts

A.1 Comments

If you have any comments or suggestions that can help In Motion improve the accuracy or usability of this manual, please forward them to the following e-mail address:

[email protected]

Please identify the publication number or title and the specific version of the manual.

A.2 Technical Support

To obtain technical support for this product, contact the In Motion service center in one of the following ways:

Telephone:

1-866-468-2968

E-mail:

[email protected]