Professional Documents
Culture Documents
User Manual
User Manual
User Manual
1
9.1.1 Report selection view............................................................................................... 24
9.1.2 Report result view .................................................................................................... 25
Alarms report .................................................................................................................. 26
9.2.1 Report selection view............................................................................................... 26
9.2.2 Report results view .................................................................................................. 27
Unread Notifications ....................................................................................................... 29
9.3.1 Notifications View .................................................................................................... 29
Engine hours .................................................................................................................. 29
9.4.1 Report selection view............................................................................................... 29
9.4.2 Report result view .................................................................................................... 29
Equipment status ............................................................................................................ 30
9.5.1 Report selection view............................................................................................... 30
9.5.2 Report results view .................................................................................................. 30
Fuel consumption ........................................................................................................... 34
9.6.1 Goal......................................................................................................................... 34
9.6.2 Report selection view............................................................................................... 34
9.6.3 Report results view .................................................................................................. 34
Equipment on/off ............................................................................................................ 36
9.7.1 Report selection view............................................................................................... 36
9.7.2 Report results view .................................................................................................. 36
Signals (ex CAN-BUS).................................................................................................... 38
9.8.1 Report selection view............................................................................................... 38
9.8.2 Report results view .................................................................................................. 38
CAN Bus Sniffing report .................................................................................................. 41
9.9.1 Report selection view............................................................................................... 41
9.9.2 Report results view .................................................................................................. 41
Performance report ......................................................................................................... 42
9.10.1 Report selection view............................................................................................... 42
9.10.2 Report results view .................................................................................................. 42
Automatic reports ........................................................................................................... 43
9.11.1 Main features ........................................................................................................... 43
9.11.2 Scheduled reports setup .......................................................................................... 44
10 Maintenance .......................................................................................................................... 46
Maintenance dashboard ................................................................................................. 46
10.1.1 Report selection view............................................................................................... 46
10.1.2 Report results view .................................................................................................. 46
Maintenance history........................................................................................................ 49
11 Administration/settings/equipment configuration .................................................................... 51
General administration/settings/equipment configuration pages ..................................... 51
11.1.1 Generic list view ...................................................................................................... 51
11.1.2 Generic detail view .................................................................................................. 52
2
Company hierarchy, view and inheritance ...................................................................... 52
11.2.1 Equipment view ....................................................................................................... 52
11.2.2 User view and brand separation .............................................................................. 52
11.2.3 Configuration/data view and inheritance .................................................................. 52
Administration section ..................................................................................................... 53
11.3.1 Equipment ............................................................................................................... 53
11.3.2 Devices ................................................................................................................... 53
11.3.3 Fleets ...................................................................................................................... 53
11.3.4 Companies .............................................................................................................. 53
11.3.5 Users ....................................................................................................................... 54
11.3.6 Notification groups ................................................................................................... 54
Settings section .............................................................................................................. 54
11.4.1 CAN BUS data......................................................................................................... 54
11.4.2 DM1 data ................................................................................................................. 55
11.4.3 Maintenance data .................................................................................................... 56
12 Equipment configuration ........................................................................................................ 57
Alarm setup panel........................................................................................................... 57
Operation status ............................................................................................................. 58
CAN BUS/DM1 ............................................................................................................... 58
12.3.1 CAN BUS tabs ......................................................................................................... 59
12.3.2 DM1 tabs ................................................................................................................. 61
Geofence ........................................................................................................................ 62
12.4.1 Drawing tools ........................................................................................................... 63
12.4.2 Assignment page ..................................................................................................... 64
Curfew ............................................................................................................................ 64
Input ............................................................................................................................... 64
12.6.1 AMX ............................................................................................................................ 64
Power management........................................................................................................ 65
12.7.1 Values allowed based on user level ......................................................................... 66
12.7.2 Alarm notification ..................................................................................................... 66
Maintenance ................................................................................................................... 66
12.8.1 Assign ..................................................................................................................... 66
12.8.2 Last service and maintenance setup........................................................................ 67
Assign configuration ....................................................................................................... 67
12.9.1 Model configuration ................................................................................................. 67
12.9.2 Assign configurations............................................................................................... 68
Customizable Statuses ................................................................................................... 71
13 Subscription ........................................................................................................................... 71
Service management ...................................................................................................... 71
13.11.1 Activation ................................................................................................................. 71
13.11.2 Renewal .................................................................................................................. 71
3
Expiration ....................................................................................................................... 72
13.12.1 Report selection view............................................................................................... 72
13.12.2 Report results view .................................................................................................. 72
First subscription activations ........................................................................................... 73
13.13.1 Report selection view............................................................................................... 73
13.13.2 Report results view .................................................................................................. 73
14 Landing page set-up .............................................................................................................. 74
15 My Notifications ..................................................................................................................... 75
My Notifications - Configuration ...................................................................................... 75
15.1.1 My Notifications page .............................................................................................. 75
My Notifications – setting for other users ........................................................................ 77
15.2.1 Notifications page on behalf of another user ............................................................ 77
4
1 Version tracking
Version Changes
1.0 First version
1.1 – Sep 2019 • Equipment Status Summary
• Equipment On/Off Summary
• Last Alarms
• Set as Home
• New images for every section
2.0 – Aug 2020 • Equipment dashboard
• New login page
• Signals Report, ex CAN BUS
2.1 – Nov 2020 • Export Performance Report
• Export History Report
• Scheduled Equipment ON/OFF Report
• Change status name and color by company
2.2 – Mar 21 • 80 Can Parameters
• TAG on can parameters
3.0 – Mar 21 • New Notifications
5
2 Introduction
Goal
This document deals with the web application, illustrating and focusing on:
• User Interface design
• User Experience (look & feel)
• Feature behaviors
Purpose
The purpose of this document is to improve the user’s understanding of the web application graphic layout and its behavior, providing
the user with an overview of the application.
Project overview
The application has been designed to provide the user with a full Fleet Management System that, in summary, can:
• Geo-localize equipment on a map
• Retrieve details for equipment and positions
• Generate performance and productivity reports about the equipment
• Define geofences on a map to assign specific work areas for the equipment
• Manage the device's subscriptions
• Configure the administration settings
• Configure the user settings
6
3 General behaviors
The goal of this section is to describe the generic elements present across the whole application, specifically:
• Main template
• Menu items
• Field types
• Fleet panel
A detailed description of each application's section/page will be provided in the later sections.
Main template
The main template is valid for all the web application pages. The design has been conceived to fully adapt to common display
resolutions.
7
Menu items
Each application page can be accessed by navigating the menu.
The menu is structured according to the following hierarchy:
• Home
• Map
o Fleet view
o History
• Report
o Productivity
• Engine hours
• Performance
• Equipment status
• Equipment on/off
• Fuel consumption
o Alarms
o Signals (ex CAN BUS)
o Scheduled report
• Maintenance
o Maintenance dashboard
o Maintenance history
• Settings
o CAN BUS data
• CAN BUS protocols
• CAN BUS parameters
o DM1 data
• DM1 platform
• DM1 source address
• DM1 description
o Maintenance data
• Maintenance type
• Maintenance service
o Equipment configuration
• Operating status
• CAN BUS/DM1
• Geofences
• Curfew
• Power management
• Digital input
• Maintenance
• Assign configuration
• Model configuration
• Administration
o Equipment
o Fleet
o Companies
o Users
o Notification Groups
• Subscriptions
o Subscription management
o Subscription expiration
o Subscription first activation
• User
o User Settings
o Change password
o Terms of use
o Privacy
o Support
o Logout
8
Field types
This section describes all the possible field types used throughout the application to set data or display data after processing.
Name Description
String Simple text input
9
Fleet panel
This fleet panel has been designed to show the following hierarchy of items for browsing:
• Company
• Fleet
• Equipment
The search field functionality has been designed to work at all levels.
As shown on the image, the user’s company is shown on top of the fleet panel. All the fleets belonging to that company will be shown.
The other section of the fleet panel consists of the hierarchy of subsidiary companies. The user can navigate through the company’s
whole hierarchy.
If the user belongs to a company that doesn’t have subsidiary companies, only the top section is shown.
It is also possible to see all the equipment under the logged user view by clicking the “See all equipment” button.
Each company element consists of:
• Company's name
• Company's fleet number
• Company's equipment number
When the user clicks on a company item, the Fleets panel slides in (from the right).
On the top, the user sees the name of the parent company and an arrow to go back to the previous level.
10
4 Login
Login process
To log into the website, the user must have an account already created in the system and should have authorized login credentials to
access the application.
The login process consists of the following steps:
1. User enters his/her username and the password;
2. After entering this data, there are two possible scenarios:
a. The credentials are correct, so the user enters the website and the landing page is shown;
b. The credentials are wrong, so an error message is displayed, as in the picture below. In this case, the form fields are emptied and
the user has to type in the credentials again.
11
Forgot password page
When a user knows his/her username but not his/her password and has an e-mail address associated with the account, he/she can
12
5 Privacy and Terms of Use disclaimer
This section describes the Legal Disclaimer wizard.
The disclaimer is shown only after a new user’s first login. It is structured as a wizard, and the user must take the following steps:
1. When the new user logs in, the disclaimer is shown.
2. The user has to select the region.
3. Once the region has been selected, the user can go to the next step.
4. Then the user must select the language. The list of available languages depends on the region previously selected.
5. Once the language has been selected, the user can go to the next step.
6. Now the Privacy and Terms of Use is shown. The “Next” button is enabled only if the user accepts both of them.
7. Once the “next” button is enabled, the user can click on “next.”
8. The personal data acceptance check boxes are shown. User can either accept or not.
9. User can click on “Finish.”
13
6 Desktop page
This section describes the desktop page, that is, the user’s landing page after a successful login:
14
7 Equipment Dashboard
Using this page, the customer should be able to see many data related to the equipment.
1. Through the main menu, below the DASHBOARDS item in the main horizontal menu
2. Through the main dashboard, in the FLEET PANEL. For each equipment there is the icon that will lead the user to the
correspondent equipment dashboard
3. Through the MAP → FLEET VIEW panel. For each equipment there is the icon that will lead the user to the correspondent
equipment dashboard
15
Equipment dashboard view
On this page, the user can see (see screen in the previous page):
• Fleet navigator on the left side
• Equipment Data INFO on the right side
Fleet navigator
On the left side of the page the users can select the equipment.
All data are available in read-only mode.
16
• EQUIPMENT MAINTENANCE STATUS
• SUBSCRIPTION
Equipment Data
On this section are reported:
• Name
• Status
• Machine S/N
• Company
• Brand
• Type
• Model
• Last Update
• Last Position (address display is optional)
• Last KEY OFF
• Note
Map section
It shows the last position of the equipment.
It is possible to see STREET and SATELLITE views on the map.
Zoom in and zoom out
Performance
The Performance section is composed by 3 TABs:
• Hours (displayed by default)
• Distance
• Fuel
The sections are visible only if the user has already configured it (e.g. it shows the fuel report only if the user has already configured it).
This section must show the same info as in the "Performance Report - Daily" (week overview is not required)
17
Quick reports section
The Quick Reports is a widget that helps users to have shortcuts to a particular report for the chosen equipment.
The user can configure which signals are enabled to be showed in the Equipment Dashboard page.
The signal configurations are made in the page below in Settings → EQUIPMENT CONFIGURATION → MODEL CONFIGURATION.
The user will click on the Dashboard parameters button.
18
After clicking the Dashboard parameter button, the user will land in the page below, where he/she can choose the 9 CAN-Bus parameters
and associate a customized icon for each of them.
19
8 Map
Fleet view
The fleet view is the page where users can check their equipment locations. Once the option has been selected, a map is shown on the
screen.
As shown in the image, the map can show two types of items:
1. Pin: this is a precise indication for the equipment’s location and has two variable elements: the equipment icon in the center and the
status color.
2. Cluster: this represents the number of the agglomerated equipment items per area.
20
When a pin is clicked on, an info balloon appears.
A search box is provided on the map to allow searching for a precise address. The map will be centered on the address desired.
In the left section, there are the three following panels:
• Fleet panel (as in the home page)
• Equipment summary, which indicates how many equipment items are in each status
• Fences, where the user can select the fence he/she wants to see on the map
21
History
8.2.1 Report selection
The user can generate the equipment's history by following these steps:
• Select the date range (max 180 days)
o by using the set of quick options
o by manually selecting a date range
• Select one or more vehicles (20 max) from the equipment selector
• Check the selected equipment
• Launch the report by clicking on the "Generate report" button
22
8.2.2 Report result view
The result is a path listed on the left side of the screen (info-tiles) and shown on the map with a sequence of little colored circles. The
first and last position of the path are represented with a pin.
Based on the zoom level on the map, positions can be tightly grouped, and it could be difficult to single out a specific position. The
system provides the user with the option of expanding the group by showing all positions arranged in a whirl layout.
In this way, the user can easily identify a position to click.
The user can check each position on the map by clicking on it. The related information balloon is shown and the current point is
enlarged.
The information contained in the info balloon is the same as reported in the fleet view page.
It is possible to change the date range by clicking on the icon in the left margin.
23
9 Report
General report pages
24
1.1.1.1 Date selector
When the user opens a report page, the date selector is initialized with the default values. The default selection is the current day.
The user can set the date manually with the from/to calendar and clock or can use the quick selectors, which work as follows:
Quick
From date From time To date To time
selection
today current day midnight current day 23:59:59
last 7 days current day - 7 days midnight the day before 23:59:59
last 30 days current day - 30 days midnight the day before 23:59:59
25
Alarms report
This section describes the alarms report page.
The Alarms report page allows the user to report and check the alarms generated by the selected equipment. The reported alarms
belong to all types.
The available alarm types, with example descriptions, are the following:
CAN (e.g.) Engine RPM is equal or greater than 2000 rpm. Actual
value is 2004.875 rpm.
Curfew The equipment has violated the curfew TEST CURFEW
Equipment not reporting Equipment has not reported for more than 7 days
26
9.2.2 Report results view
When the user has selected assets and time frames, the report result view is shown.
27
It is possible to select show details/hide details. When “show details” is selected, the following fields will be shown:
• Text
• Time stamp
• Received time
The alarm key is the identifier for the alarm group and what it displays depends on the alarm type, as shown in the following table:
Type Key
CAN CAN parameter
Curfew Curfew configuration name
#days of not reporting (7 or
Equipment not reporting
14)
Fence Fence name
Input Input name
Maintenance Maintenance service
Motion -
Ping -
Power state -
DM1 DM1 code
The alarms will be grouped by priority, equipment, type and alarm key.
When an alarm subsides, another item will be added to the group.
In each group, the alarms are sorted by equipment name. For each piece of equipment, they are sorted by time stamp.
Clicking on the “view on maps” button displays on the map all the equipment with the "view on maps" check box checked.
Clicking on the icon on the map displays the info balloon.
28
Unread Notifications
A Bell icon on the HEADER of the site shows the configured notifications.
By clicking on MORE in the notification, the user can see the alarm message.
Engine hours
This section describes the engine hours report.
The engine hours report allows the user to report and check how many hours the equipment has been keyed on. This is a cumulative
report, so the value shown is the last updated one. It is not possible to see the engine hours value in a certain time frame. The engine
hours source is set in the data source setting page.
29
The report is structured as follows:
1. The report’s name
2. The Back button, which allows the user to go back to the report selection view
3. A summary of the data reported, with the following information:
a. Total equipment: the number of selected pieces of equipment
b. Total hours: the total amount of engine hours when the equipment has been keyed on
4. The “order by” section, which allows the user to order the histogram by equipment ID or hours and/or sort in ascending and descending
order. By default, the histograms are ordered by equipment ID and sorted in ascending order.
5. An export in Excel format.
6. The engine hours histograms, with the engine hours data for each equipment item. The engine hours are shown on the X axis and the
equipment is shown on the Y axis.
Equipment status
This section describes the Equipment Status report.
The Equipment Status report allows the user to report and check the status history of a selected device. Although the possible statuses
are predefined, this report is strictly dependent on the status configuration associated with the device, because the user sets the status
conditions in that configuration. The data is shown in the “Status by device” report.
Please note that, to generate a report status contribution, the selected start time in the Equipment Status report must precede the report
status start, and the selected end time must follow the report status end.
30
1.1.1.5 Overview Section
Clicking on a status name in the legend will cause the clicked status not to be shown in the pie chart, and the name will seem to have
been deleted from the legend. To reintroduce the removed status, the user has simply to click again on the name in the legend.
Furthermore, on a color indicator in the legend will cause only the selected status to be shown, while the others are switched off
31
1.1.1.6 Summary Section
32
d. Distance for each status
e. Fuel used for each status
f. Grand Total section with the sum of each value for all equipment
g. A legend (not configurable)
33
Fuel consumption
9.6.1 Goal
This section describes the Fuel Consumption report.
The Fuel Consumption report allows the user to report on and check the average level of fuel consumption in a certain time interval, the
fuel burned during the selected time frame and the average fuel consumption.
The fuel consumption is calculated based on CAN data. The CAN parameter used for the fuel source is set in the data source settings.
Furthermore, that parameter should be set using the detection type average in the CAN configuration.
Please note that the measurement equipment shown depends on the current user's preset.
34
The report is structured as follows:
1. The report’s name
2. The “Back” button, which allows the user to go back to the report selection view
3. A summary of the data reported, with the following information:
a. total equipment: the number of selected equipment items
b. total fuel burned: the sum of the fuel burned by each equipment item
c. total hours: the total number of engine hours when the equipment has been keyed on
d. total fuel burned/total hours (average of the averages)
4. The “order by” section, which allows the user to order the histogram by equipment ID, hours, fuel consumption or fuel burned and/or
sort in ascending and descending order. By default, the histograms are ordered by equipment ID and sorted in ascending order.
5. The data selector section, which allows an update of the selected time frame for the report
6. An export to an XLS file.
7. The fuel consumption and fuel burned histograms, with the engine hours data for each piece of equipment. The fuel
consumption is displayed on the X axis, and the equipment is shown on the Y axis.
Moving the mouse over the icons displays the equipment data:
• The equipment name and the fuel consumption value
• The equipment name and the fuel burned value
35
Equipment on/off
This page describes the Equipment On/Off report.
The Equipment On/Off report allows the user to report and check when the equipment has been keyed on/off during the selected period.
The report is generated at key off when the device sends the Engine Off report, which also contains the “engine on” info.
Furthermore, the user can get a real-time update every time a new message is delivered to the system.
If more than one equipment item has been selected for the report, the fields are repeated for each equipment item.
36
There are three possible statuses for the device:
1. ON: the time period that starts with a key on and ends with a key off, or the time interval between two different messages during real time
(it is only to advise the user that the equipment is sending data; however, the data are updated when the equipment is keyed off). It is
shown with yellow both in the pie chart and in the clustered bar chart.
2. OFF: the time period between a key off and the next key on. Shown with dark gray both in the pie chart and in the clustered bar chart.
3. NO DATA: the time period after the last key off sent by the device but included in the selected time frame. Because the key on/off data are
updated only at key off, the system doesn't know the equipment status before the next key off. If the report is generated again after the
next key off, the previous NO data contribution will be substituted with ON or OFF. Furthermore, NO DATA is also shown during the real-
time update: the whole time after the last message received time is marked as NO DATA. For example, the equipment is keyed off on Friday
at 8:00 PM. The device isn't keyed on during the weekend. On Monday morning, the report is generated containing the data from Friday at
6:00 PM to Monday at 11:00 AM. The report will show ON (yellow) from 6:00 PM to 8:00 PM on Friday and NO DATA from Friday at 8:00 PM
to Monday at 11:00 AM. At the next Engine OFF report (next Key on/off), when the report is generated again, the NO DATA becomes OFF.
Furthermore, the time period before the equipment activation is reported as NO DATA.
Upon mouseover, a pop-up is shown with data related to status, interval and amount of time in the selected status expressed in
hh:decimals.
Moving the mouse out of the report selection (e.g., considering from 6:00 PM to 12:00 PM for the last day in the image) will make the
pop-up show OUT OF RANGE as the status. It is shown in white and it is also expressed in hh:decimals and percentage of 24 hours.
37
Signals (ex CAN-BUS)
This section describes the Vehicle Data report.
The Vehicle Data report allows the user to monitor and report the CAN parameters and signals values sent by the device. The list of
the signals shown depends on multiple factors:
• The device's service plan. If the service plan is basic, the only parameters shown are the engine hours. Other CAN parameters in the CAN
configuration may be used only for status conditions in the status configuration. With the advance service plan, there are 40 parameters
available.
• The detection type for the parameters is selected in the CAN or Input configuration. Only parameters with a detection type set as "Report"
and "Report/alarms" are shown.
• The signals actually sent in the selected time frame.
The values shown can differ from one user to another because they reflect the user's time preset (UK, international or US).
38
1.1.1.9 Table report
39
1.1.1.10 Chart report
The maximum number of points the chart can show is 500. If the report has more than 500 samples, they are grouped. The total time is
divided into time intervals and, for each of them, samples belonging to the same time interval are arithmetically averaged. The time
interval value depends on how many pieces of equipment are selected and the timeframe duration is:
Tgroup=Htotal/(500/Utotal),
where:
• Tgroup is the grouped time interval duration
• Htotal is the total hours in the selected timeframe for the report generation
• Utotal is the number of selected equipment items.
For example:
• A selected period of 90 days = 2160 hours
• selected equipment items = 2
• # samples > 500
Passing the mouse over a point on the chart will show the information on date, equipment name and value.
40
Clicking on the equipment name in the legend causes the clicked icon to be no longer shown in the chart and the equipment name
seems to have been deleted from the legend. To reintroduce the removed equipment, the user has simply to click on the name in the
legend again.
The user will be able to request log immediately or at next key on. User can select log length (from 1 to 10 min)
1. User has to click on CAN BUS REQUEST button, and a modal window in shown
2. Select request type by drop down menu
3. Select Time Log
4. Send Request or cancel, after this there are 5 status:
a. PENDING REQUEST: we are waiting for a response from the device
b. PROCESSING:
i. We are processing your request
ii. as soon as the machine is turned on, we will send you the data (this case when request type is NEXT KEY ON)
iii. During processing status, user can cancel request by CANCELLING REQUEST button
c. DONE: your request is successful
d. FAILED: the device is not reachable
i. In this case user has to check if device is turned on
e. REQUEST CANCELED: user canceled the request
CAN Bus Log Now: the server will contact the device in real time and check if it is on and connected. If yes, the sniffing will start
immediately.
At next key on the server will contact the device in real time and check if it is on and connected. If yes, the sniffing will start at next key
on.
41
From this section, the user can download the last 20 files received.
Important
CAN BUS request button should be enabled only if there isn't another request ongoing, so if the status of the Last Request is Done or
Failed.
Performance report
This section describes the behavior of the Performance report. The Performance report provides an overview of a single unit and how
this unit worked during the selected period.
42
See the following example:
• If the data source is not configured for a specific date, the report section will not be shown.
• If the data source is configured for a specific date but there isn’t valid information in the time frame, the report section will be shown
empty.
• The report is exportable in Excel formats
• The report should be schedulable in PDF and Excel formats
• Each report page is for only one piece of equipment. If the user selects more than one piece of equipment, various tabs will be created (one
for each piece of equipment).
• On the desktop page, when the user selects the performance report as a quick link, the default selection will be “today - 6 days” and not
today.
Automatic reports
This section describes the functionality of the automatic report, which the user can use to schedule the generation of some Excel reports
and their delivery to selected users.
43
The schedule configuration is done through the website in an ad-hoc section (see scheduled reports setup).
The automatic reports available are:
• Engine hours (equal to the related export in the Engine Hours report page)
• Fuel consumption (equal to the related export in the Fuel Consumption report page)
• Maintenance (equal to the export in the Maintenance Fleet report page)
• Equipment utilization (equal to the related export in the Equipment Utilization report page)
• Alarm report (with the counter of the alarm types generated for each piece of equipment selected in the selected time frame, e.g., 5 CAN
alarms, 3 geofence alarms, etc.)
• Equipment ON/OFF
• Expiration (equal to the related export in the Expiration report page)
• Performance report (TO BE)
44
1.1.1.13 Clone
The user can clone a schedule and all the fields in it will be cloned.
1.1.1.14 History
This is a high-level history. It is available only for users with setup permissions. It differs from the User History, because this report
contains all the events generated by the selected schedule, broken out by version, and also the list of notified users.
The available search box works on user and report type. The date selector panel can be used for the time frame selection.
1.1.1.15 Delete
A schedule is really deleted only before the first report has been generated. After that, it is only a “soft delete” that removes the schedule
from the list but keeps its history.
45
10 Maintenance
Maintenance dashboard
This section describes the Maintenance Dashboard.
The Maintenance Dashboard is a sort of snapshot for the maintenance data for the selected equipment. Furthermore, it allows the user
to access the maintenance card, the core of the maintenance management function.
46
• It is possible to enable the “view-on-map” function for a single vehicle or for a group, enabling the "view on map" check box for each piece
of equipment.
• An export to an XLS file.
Please note that hours/distance left to next service value can have three different possible meanings:
1. Positive value: if the equipment has services based on the interval type specified in the column and the service’s status is not overdue (e.g.,
hours left to next service for the first two items of equipment in the picture)
2. Negative value: if the equipment has services based on the interval type specified in the column and the service's status is overdue (e.g.,
hours left to next service for the last piece of equipment in the picture)
3. Null value: if the equipment doesn't have services based on the interval type specified in the column (e.g., distance left to next service for
the piece of equipment in the picture)
47
• The user can perform actions on a group of services or on a single service.
• For each group/single service, only the actions allowed are shown.
• When the action is performed on the group, the group's status is updated, the status of each single service is forced to change and the notes
are related to the whole group.
• When the action is performed on the single service, the group's status doesn't change, and the notes are applied to the single service.
Moreover, the action can change the service's group membership.
In other words, this option to manage service groups and services independently allows the user to keep records of the information on
the individual services.
• The user can print a group with the services included
• The user can print the maintenance card with the included group (services excluded)
• The user can also delete a group or a single service, so that the selected entities will be deleted only from the equipment maintenance card,
not from the configuration.
The actions change the status and each action is an entry in the “Maintenance History” page.
Examples:
If the current status is OVERDUE, the user can select one of these choices:
• Start
• Postpone
If the current status is IN PROGRESS, the user can select one of these choices:
• Close
• Undo start
48
1.1.1.19 Last services closed
By clicking on the "Manage Closed Services" button, all last services that have been closed are shown (if there is more than one closed
instance for a service, only the most recent one can be included in the list; in other words, it is not possible to have more than one entry
for each service).
The services that can be reopened are:
• Non-recurrent services that have been closed
• Recurrent services for which at least one instance has been closed and the new instance is not in due soon and overdue.
On each line there is a “Reopen” button that allows you to reopen the service.
Maintenance history
The goal of this page is to describe the Maintenance History page.
Maintenance History is a report of all the Maintenance actions performed on the selected equipment in the selected time frame.
49
The main features of the Maintenance History are the followings:
• The History is a report, shown as a table, in which all the actions (not statuses) are shown, except for reopen.
• The equipment selection can be performed as usual using the vehicle selection tree.
• For each piece of equipment, the number of rows is equal to the number of actions.
• Each action row can be expanded in N read-only lines, where N is the number of services involved in that action. So, the latter can refer
to a group of services or to a single one.
When an action row is expanded, the single services rows are shown and the service name and type fields are added. The information
shown for each row is:
• Equipment
• Company
• Action
• Service
• Interval, with measurement equipment
• Engine hours
• Km at action
• Date
• Mechanic name (if present)
• Cost (if present)
• Notes (if present)
When the action is “postpone,” the hours/kms postpone value is reported in brackets.
The report is also exportable in an XLS file.
50
11 Administration/settings/equipment configuration
General administration/settings/equipment configuration pages
• The administration page name (USER in the picture reported in the example)
• The search bar, which allows the user to quickly retrieve the data desired.
• The Add button, which allows the user to add a new item to the list.
• The settings panel, used to customize the list view
• The items list and the related tool buttons Edit, Delete and Assign (Assign only in case of configurations, such as CAN, IO, Power
Management, Curfew, Geofence and Status).
Clicking on the Settings panel button displays the Settings panel. From the settings panel, the user can set up:
• Display density, which represents the density of items per page (as reported in the following table), both in terms of row and font size. The
options available are:
o Large
o Medium
o Small
• Pagination, which is the number of items per page
• Columns, which allows the user to select the number of columns preferred.
51
11.1.2 Generic detail view
Every Administration/Settings/Configuration page allows the user to add a new item or to edit an existing one.
Clicking on the “Edit” button or on the “Add” button makes the system show the Details view:
If there are fields that have not been filled in correctly, they are highlighted with bars for validation and a message describes the error.
52
If a user belonging to a company creates his/her own configurations, CAN parameters or protocols, or modifies one cloned starting from
the default, these items will be available only to users belonging to his/her company (not available to child companies nor to parent
companies).
Administration section
The Administration section is composed of the pages described below.
11.3.1 Equipment
This page provides the list of the equipment items visible to the user who is logged in. The equipment is physically the vehicle on which
the device is installed. An equipment item is automatically created when the connected device is activated. Once an equipment record is
created, some fields are assigned default values during the activation process; the user must edit the defaulted fields afterwards. For
example, the equipment can be added or removed by fleets (except for the default one) through the fleet field.
In the “equipment detail view” page there are two important section:
• Fleets: the label "Fleets of Company XXX" changes according to the company selected during the previous step. Once the company has been
selected, the fleets shown are only the selected company's fleets. Furthermore, the default fleet of the selected company cannot be
deselected. If the equipment belongs to other customized fleets, they are not shown in this page but only in Fleets.
• Configuration panel: in this panel, it is possible to see the configurations assigned to the equipment and the assignment day and time.
Furthermore, it is possible to deselect the configuration by using the “delete” button. If an equipment item is under the view of the current
user, but the assigned configuration is a customized one (not a default configuration or not created in the user's company), the
configuration name is replaced with "-".
• Brand/Type/Model: this section allows the user to select the proper brand, type and model. This operation has a double use: assign the
proper icon and assign the proper default configuration to the equipment itself (see the “model configuration” section for further details).
11.3.2 Devices
This page contains the list of all the devices visible to the user. Each entry on the list represents a device physically installed on the
equipment and contains the main device data.
Any kind of user can add new devices into the system. Creating a new device is possible only with a factory tool, which inserts the
device in a virtual warehouse. When the device is associated with a subscription and activated, it becomes visible in the “device”
section.
11.3.3 Fleets
This page provides the list of the fleets (groups of equipment) visible to the user who is logged in. When a company is created, the
default fleet for that company is created as well with the same name of the company, so that each piece of equipment that belongs to
the company also belongs to its default fleet. Default fleets cannot be deleted or modified.
In addition to the default fleet, a user can create also customized fleets, selecting the equipment to include.
11.3.4 Companies
This page provides the list of companies visible to the user who is logged in. There is a sort of hierarchy among companies. When a
new company is inserted, it is created under the company of the user who created it.
53
11.3.5 Users
This page contains all the users viewable to the user and the user’s preferences and settings. In this section the user can choose the
preset desired and thus the measurement system that will be used throughout the website.role
Area ha ac ac
Temperature °C °F °F
Time h h h
Weight ton lb lb
Please note that if a user is selected as “external,” he/she will not have access to the web site, but he/she will only receive email alarms
and reports.
Settings section
The “Settings” section is composed of the pages described below.
54
Furthermore, once metric has been chosen, the user can insert some "encoded values" that are recurrent and/or significant
values which can be replaced by a string. After clicking on “add,” the user has to set the value to be encoded and the string.
• Identifier: the CAN parameter ID defined by the standard.
• Mask: the CAN parameter mask. It has the same length as the identifier and indicates the bit in the identifier in which the parameters can be
identified.
• Byte order: this indicates if the frame should be read in Little Endian (Intel) or Big-Endian order (Motorola).
• Frame format: this fields set whether the parameter frame is Standard (11 bit) or Extended (29 bit).
• Start bit: the first bit from which the parameter is written in the payload.
• Resolution/bit: the parameter's resolution per bit. It is the quantity by which the raw value is multiplied.
• Bit length: the length of the CAN parameter in the payload
• Offset: the quantity added to the product “resolution*raw value,” by which the parameter can assume negative values.
• Notes: free-form notes field
.
11.4.2 DM1 data
*required field
“DTC code” will accept not only numbers/letters but also special characters.
The field “Description” is not required because some DTCs have only a code and not a name. FMI is editable by the user; only values
between 0 – 31 are allowed as per j1939-73.
“Platform” is a radio list and it is populated by the user in another section called DM1 Platform Group.
It is possible to choose the name of the ECU that generated the fault in the field “Source address.” The ECUs displayed are the ones
previously added in the “Source Address Group” section.
Since the DTC has its own severity (it is the lamp activated on the machine), it is registered in the DM1 parameter section. The light can
be green, amber or red.
55
When the description field is not empty, in the alarm report section, the DM1 parameter will be displayed with the description also and
not only with a code.
Note that if the DM1 has not been registered in the parameter section, it will not be visible in the reports section.
For each selected item, the system will provide the user with the following details:
• Description
• Type
• Recurrent
• Interval type
• Interval
• Due soon
• Description: this is the service name.
• Type: this is the field that specifies the type of service. Each user can see the types under his view (created by the Expert or in his/her
company).
• Recurrent: this indicates whether the service will be recurrent or not.
• Interval type: this indicates whether the service scheduling will be based on engine hours or the odometer reading.
• Interval: this indicates the interval from the last service when the service should be performed.
• Due soon interval: this indicates when a service should be indicated as "due soon." For example, if the next service is scheduled at 1,000 km
and the “due soon” interval is set to 100 km, when the machine reaches 900 km, the service status changes from "not due" to "due soon."
56
12 Equipment configuration
Alarm setup panel
Except for the operating status, when a configuration is created, one or more alarms can be associated with it. Where, to whom and with
which priority an alarm should be issued is specified in the Alarm Notification panel.
On the top right in the “Configuration Edit” view, there is an alarm notification button.
The Alarm setup panel is composed by a priority, that is an indicator of the alarm impact. This information will be shown both on the
desktop page and in the alarm report.
Please note that when a configuration is cloned, the alarm settings are not cloned.
57
Operation status
The “Operations status” configuration allows the user to identify a particular work condition for the equipment. Mixing CAN information,
with speed and digital input, the user can categorize the status conditions.
Clicking on Operating status in the Equipment configuration menu shows the list of all the available status configurations. The user can
add a new configuration or edit, delete or clone an existing one.
Selecting the "Edit" option shows the detail view.
The possible statuses are:
1. High workload
2. Key on/Engine off
3. Long idle
4. On/idle
5. Transport
6. Work
7. Light workload (the default when the equipment is on; not configurable)
8. Off (not configurable; this is used when the equipment is off)
The name and the number of all possible statuses is not customizable by the user, but only the conditions that lead to each one.
Furthermore, this configuration is very delicate, because the user must be careful not to overlap the different conditions in different
statuses. Each of them could be defined based on only one condition or on a combination of several. These conditions could be based
on:
• One or more CAN BUS parameters
• Odometer
• Digital input 0 and/or 1
For each entry. the condition (=, !=, <, <=, >, >= ) and the threshold value should be defined.
The “Long Idle” status represent an exception, because in this case only a time threshold should be defined. This value represents the
time interval after which “On/Idle” becomes “Long Idle.”
There is also the "Light workload" status. This is the default status and is not configurable. When the device's data fit none of the
conditions, the status is set to “Light workload.”
To create a status configuration, the user should perform the following steps:
1. Insert the configuration name;
2. Select the CAN BUS protocol. As mentioned above, the status conditions could be based on CAN parameters, meaning the CAN protocol
from which those parameters must be selected. Moreover, this protocol must match the one used for the CAN configuration. In particular,
the parameters selected in the CAN configuration must match those in the status one. If there is a mismatch, the system returns an error
message and the status configuration will not be saved.
3. Select the preferred conditions for each status. Conditions can be added for each status, or it is possible to edit or delete ones that were
already created. The maximum number of conditions for AM53 is 6 and for AM50 is 5.
CAN BUS/DM1
The CAN BUS/DM1 configurations allow the user to indicate to the device the list of CAN BUS parameters/DM1s he wants to monitor.
58
The “edit/add” page for the configuration is structured as follows:
When the user clicks on the light edit button the system shows a modal panel used to edit the CAN BUS line data.
59
For each row in the parameters list, the user can:
• Check or uncheck, to add or remove parameters from the configuration (as shown in the image below). The number of selected parameters
changes as a consequence. Please note that it is not possible to uncheck the required parameters and that the edit button is enabled only
when the related parameter has been checked.
• Edit, through a modal panel.
After saving and refreshing the page, the user can see the CAN parameters list with the selected parameters at the top in alphabetical
order followed by the others (also alphabetically ordered).
60
12.3.2 DM1 tabs
On DM1 tab of the configuration:
• Set the name of the DM1 configuration. It will be unique for the CAN and DM1 configuration.
• Set protocol DM1. To avoid association with incorrect DM1 parameters (some DM1s of different platforms have the same SPN and FMI),
DM1 will check the correspondence only in the DM1 of the platform selected. When the DM1 protocol is set, the DM1 configuration is
enabled and the list of all DM1s is shown in the configuration section, the same as the CAN configuration. The only difference with CAN is
that the DM1 list is only in view mode (DTC code and description of the fault are shown). “Protocol not selected” means that DM1
configuration is not enabled.
• Set CAN line. The user can set line 0, line 1 or both (e.g., if he wants to receive DM1 from CAN0, he will set only CAN0).
• Set conversion method. As per j1939 it could be set to 0 (Version 4) or 1 (Version 1, Version 2, Version 3) but it is not available in the
platform specs. To be sure to cover the possibility of the bit being equal to 0 and 1, the user can select different combination of versions. It
is recommended to use the 1&4 combination because it is more commonly used.
• Filter the DM1 you want to receive. This is optional and if you want to receive all DM1s manifested on the machine (you are a technician and
for analysis purposes you need to go into detail) don’t complete this section. The filter is based on:
o Source address. The user manually added one or more control units for which he/she doesn’t want to receive the faults (e.g., the
ECU is 00 and if selected this means that the AM53 doesn’t send faults from it). If not completed, faults from every control unit will
be send on the web. A maximum of 10 SAs can be added.
o CAN parameters. Some errors could depend on external factors (e.g., a freezing external temperature could cause the engine
coolant temperature to be too low with a resulting fault that can be solved in a few minutes by running the engine). To avoid
alerting the user for no reason, you can set a filter on the CAN parameter. You can choose the threshold (e.g., when DM1 is
manifested, send it only if the CAN signal “Engine Coolant Temperature” is greater than 0°C for at least 30 seconds). A maximum of
2 CAN signal conditions can be added, and when selected they are in an AND condition: The user will receive a DM1 alarm only if
they are both valid.
o Timing. The DM1 and CAN parameter conditions must be active for at least the configured period in seconds. The DM1, CAN
parameters and timing are in an AND condition regarding each other. The same timing is used to determine the subside of the
DM1/CAN condition.
Note that if the user tries to include a CAN parameter not flagged in the CAN configuration, an error message will be
displayed.
Also, if the CAN condition is added on the DM1 configuration, the same CAN signal used cannot be removed in the CAN
configuration.
61
Geofence
This section allows the user to design areas where the equipment should not enter or exit.
The geofence detail page is different from other administration detail pages because the user should both be seeing data and
interacting with the map.
• On the left, the system shows all entries with the related input field for editing.
1. Description: geofence name/description (required field)
2. Transition alert options: the user can select the way in which the transition generates alarms. The available choices are: from
inside to outside, from outside to inside, or both (required field).
• On the right, there is the map section composed of:
1. Draw tool, for the fence design
2. Erase tool, for deleting a fence that was already drawn
3. Search bar, for searching specific places on the map
4. Equipment switch, for opening the equipment panel, to locate equipment on the map.
5. Fence switch, for opening the fence panel, to view the existing fences.
On the map, the user can also consult the fleet panel and the fence panel as described in the “Fleet view” section.
62
12.4.1 Drawing tools
The drawing tools are used to design a new fence. The user must follow these steps to obtain the desired fence.
Clicking on the fence icon allows the user to start to design the fence. The fence shape can be polygonal.
By clicking on the map, the user can start to add vertices. In draw mode, the shape is orange with dotted lines. In this situation, the user
can move the shape on the map with a simple drag or move vertices by clicking on a point and moving it. With a double click on the
point, the shape is automatically closed.
Clicking on the map outside of the shape ends drawing mode. The shape becomes blue and cannot be changed.
63
12.4.2 Assignment page
When a Geofence is created, the user can assign one or more pieces of equipment to it. This operation can be done by clicking on the
"Assign" tooltip in the list view.
The “Geofences Assign” page is structured in three sections:
• Fence, which in turn is composed of:
o A bar showing the number of selected items, with an expand/collapse button to display the selected fences.
o A search bar, to search for a desired fence in the list of all available fences
o The “select all/select none” button, for a quick selection
• Fleet panel
• Configuration assets, which displays the list of all equipment associated with each fence selected in the first section.
When the user wants to assign one or more geofences to one or more pieces of equipment, he/she should follow these steps:
1. Select the geofences the user wants to assign in the "Fences" section. For each selected geofence, the list of all equipment that already has
those fences will be shown in the “Configuration assets” section.
2. Select the company that has the desired equipment.
3. Select the fleet that has the desired equipment.
4. The list of all the equipment for that fleet is shown. Please remember that the selectable equipment items are only the ones that have been
transmitted at least once.
5. Select an equipment item. Once the equipment is selected, it appears in the list of equipment in the "Configuration asset” section for all
selected fences in the "Fences" section.
6. Click on the "Apply" button.
7. The assignment procedure has been completed successfully.
Curfew
The curfew section allows the user to configure alarms to be notified when the equipment is keyed on during certain days or hours when
it should be off.
The user should fill in the following fields:
• Name: the user must set the name (required)
• Time zone: this is a radio list in which the user must set the time zone to which the curfew will be applied (required)
• The day sections: it lists each day, with:
o The name of the day the user is editing
o The set of all time intervals the user can configure, split into blocks (each one is 30 minutes). For each interval, the start time and
the end time are highlighted in bold. Please note that this set is shown adapting to the display resolution: the higher the display
resolution, the larger the number of intervals in each row, so the number of rows for each day depends on the display resolution
(two rows in this case). The maximum interval number per day is four. Furthermore, when applying the selected time zone, if the
number of selected intervals becomes greater than 4, an error is shown while saving.
o The clone button, which allows copying the intervals already set in the previous day of the week (indeed, it is not present for
Monday)
o The delete button, which allows removal of all the intervals that have already been set in the current day
o The sum of the total times of day when the curfew is active
Please note that a summary of the configurations is shown in the left section of the page.
Input
12.6.1 AMX
The equipment input/output page allows the user to configure how the digital input should work.
In the detail view page, the same edit section is replicated for both inputs, 0 and 1.
The user has also to set the configuration name (required field).
The input edit section is structured as follows:
• Enabled: this is a check that enables the input usage. When an input is enabled, the name and the states become required fields.
• Name: this is the name with which the input will be recognized in alarms.
• State: this is a checklist for the input state. There are three available choices, and the user can click on the information button to show the
related configuration:
o Pull down: in status 0, the input is connected to a low voltage, so that the input becomes 1 when the voltage becomes high (the
specific threshold depends on the hardware in use).
64
o Pull up: in status 0, the input is connected to a high voltage, so that the input becomes 1 when the voltage becomes low (the
specific threshold depends on the hardware in use).
o Push pull: this is like the push pull but with a voltage-controlled resistor.
Alarm on input: this is a check box which enables the alarm to be sent for that input. When an alarm is enabled, the threshold and the
duration become required and the alarm notification panel is enabled.
• Alarm threshold: this is the value the input must reach in order to generate the alarm.
• Alarm duration: this is the minimum time interval the alarm must persist at the value equal to the one set in the threshold field in order to
generate the alarm.
Please note that if the engine hours source is set as "Alternator D+" in the status configuration, the input 0 should be set as “:Pull down.”
Power management
Depending on its current power state, the system is designed to activate/deactivate a given set of functionalities. Power management is
composed of six states:
1. ON: the key is on and the system is completely up and running.
2. WAKE: the key is off, but the system has been turned ON by the RTC (scheduled wake up); a few features could be disabled
3. MOTION: the system has been tuned ON by motion detection (the same behavior as STANDBY).
4. STANDBY: the key is off, most of the system functionalities are disabled. This is the time interval between key off and the sleep status.
5. SLEEP: the system is OFF, but a scheduled wake up or motion detection could turn it ON again.
6. HIBERNATE: the system is OFF (it can be turned ON only manually).
7. REBOOT: the system is rebooting itself.
The power management configuration allows the user to set the configuration the device has to reflect.
The user can insert the following information:
• Standby duration: this is a time interval which defines how long the device takes when passing from standby to sleep and from wake up for
motion detection to sleep if there is an internal battery. This value should be set in minutes.
• Sleep duration: this is a time interval which defines how long the device takes between two different RTC scheduled wake ups. This value
should be set in hours.
• Forced hibernate time: this is the time interval, calculated from the key off, after which the device goes to hibernate. This value should be
set in hours.
• Breadcrumb frequency: this is the position tracking period used by the equipment woken up by a motion detection event. The position
tracking starts when the device is moved for a distance greater or equal to 500m from the wake position.
• Max number of wakeup events: this is the total wake up events (scheduled or motion detection) allowed. Once the total wake- up events
are reached, the device goes into hibernate even if the forced hibernate time is not expired.
• Motion detection mode: this specifies when the motion detection alarm should be notified:
o Always in key off: the motion detection is always notified when the device is keyed off.
o Curfew: the motion detection is notified only during curfew.
o Never: the motion detection is never notified.
• Motion detection sensitivity: this specifies the motion sensitivity.
• Alarm on power state change: this specifies when the power state change alarm should be notified:
o Never
o Engine off: meaning every time the equipment is switched off.
65
12.7.1 Values allowed based on user level
In order to avoid problems with the device, the following checks are made on the power management values. These checks are also
based on role: the lower the role, the lower the possibility to set high-risk potential values.
Maintenance
This section allows the user to create a configuration for the services that needs to be done for the equipment. With this configuration,
the system will notify the user when the engine hours and /or the odometer reach values for which services are overdue or will due
soon.
To add a service to the current list associated with the configuration, the “add service” button must be used. This button will display a
modal window with existing services based on customer visibility. The user can select the desired additional services using the proper
check button and the new selected services are hence appended to the previous list after pressing the Save button. The services that
are already checked will be shown grayed and are not changeable.
12.8.1 Assign
The assign page differs in some particulars from the other assign pages.
The configuration assignment can be performed through the Assign button as with all the other configurations.
The following sentences must be taken into account:
• It is possible to associate ONLY one configuration with each piece of equipment.
• If the user tries to assign a second configuration to an equipment item that has already one, a warning message is shown: "The equipment
has already a maintenance configuration assigned that will be lost. Are you sure you want to continue?"
• Also, the visibility of the configuration's assignment to the equipment is the same one already used for the other configurations: through the
equipment page, it is possible to see if there is already a maintenance configuration assigned; if the configuration belongs to another
company, a generic name is given ("Customized configuration").
• Independently from the visibility of configurations and their assignment, the user can perform actions on the maintenance card through the
Maintenance/Fleet report for equipment he/she can view.
• After a configuration is assigned to a certain piece of equipment, if the user modifies the configuration and/or the service constituting the
configuration, this change has no impact on the equipment impacted by the previous assignment. The user must perform a new
configuration assignment to have the changes active. Thus, the maintenance configuration is related to its version number.
66
12.8.2 Last service and maintenance setup
The last service is a value at which the user can assume that all the services associated with the intervals before the “indicated”
hours/kms are correctly accomplished and closed and marked as “closed with last service function.” Example: if the last service is set to
1,000 hours, it means that all the previous services at 250/500/750/1000 have been done and closed. Please note that no historical
record will be inserted for services performed in the past (in the example 250, 500 and 750), so they will not be shown in the
“Maintenance History” page.
During the configuration assignment (both for the first setup or a configuration change), a table is shown for the last service setting. This
table displays the list of the equipment involved in the assignment with hours, kilometers and date (the latter will be used only in the
History Report, so it is not used for any computation). By default, the hours and kilometers are set to zero and the date is set to
assignment time, but these values are editable in the table.
The user can also override the default values on the equipment page only after the configuration assignment (which also coincides with
the start of service). This involves a recalculation of the status of the service.
Assign configuration
The Assign configuration section allows the user to assign one or more configurations to one or more pieces of equipment at the same
time.
To assign one or more configurations to one or more pieces of equipment, at first the user has to select the equipment he/she wants to
assign. This action is performed through the Fleet panel.
Once the equipment has been selected, the user has to click on "Go to assign." The multiple assignment configurations page is shown.
The page is structured as follows:
• The search bar is present on the top right to allow a quick search for the desired configuration.
• The list of configurations the user can assign:
o CAN bus and status: in the same part to avoid errors during the assignment, because of the CAN protocol chosen in the status
configuration. Once a CAN bus configuration is selected, the status list is updated with only the allowed configurations.
o Digital inputs
o Power management
o Geofence
o Curfew
The user can assign one, several or all configurations to the selected equipment.
The proper list for the selected configuration type, paginated if necessary.
The save button, every page is saved independently from the others. For "CAN bus & status," the save button will be enabled only if
both configurations are set.
When the user wants to set a configuration, first he has to select the configuration type, then choose the configuration and click on
Save.
67
tenant (and is case insensitive). It will not be possible to save a model with an empty name.
When the user selects the brand, type and model, a new triplet is created. It will not be possible to create the same brand type and
model twice in a tenant.
Sections 1, 2, 3 and 4 will contain the paginated list of configurations already created. Through a save button, every page can be saved
independently from the others. For "CAN bus and Status," the save button will be enabled only if both configurations are set. When the
user wants to set a configuration, he/she at first has to select the configuration type, then choose the configuration and click on “save.”
68
Digital Input (not selectable if a digital Based on the Digital Input configuration
input configuration is not associated with already associated with the model, the
the model). list of available digital input channels will
be shown.
Status (not selectable if a status The user will check with status should be
configuration is not associated with the considered as “working statuses.”
model). The working hours value will be
the sum of all selected statuses.
Fuel consumption Based on the CAN configuration already
associated with the model, the list of
available CAN parameters will be shown
(not selectable if a CAN configuration is
not associated with the model).
Working fuel consumption Status (not selectable if a status The user will check which statuses
configuration is not associated with the should be considered to be “working
model). The working fuel consumption statuses.”
value will be the sum of all selected
statuses.
Distance CAN (not selectable if a CAN Based on the CAN configuration already
configuration is not associated with the associated with the model, the list of
model) available CAN parameters will be shown.
GPS
Working distance CAN (not selectable if a CAN Based on the CAN configuration already
configuration is not associated with the associated with the model, the list of
model) available CAN parameters will be shown.
Status (not selectable if a status The user will check which status should
configuration is not associated with the be considered to be “working statuses.”
model or if the source for the distance
has not been selected). The working
distance value will be the sum of all
selected statuses.
Working load Based on the CAN configuration already
associated with the model, the list of
available CAN parameters will be shown
(not selectable if a CAN configuration is
not associated with the model).
For each data source, only one selection can be made (radio button).
Data source usage.
69
Here you can find where the selected data source is used throughout the file.
So, the Model configuration will act only as a sort of template. The configuration assignment to the unit will not be different from others
that do not have a BTM. There isn’t a strong link among equipment, model and configurations. Changes to the configuration will affect
only the unit that in the future will be associated with the model, but not the unit that already belongs to the model.
70
Customizable Statuses
This function is per Company, so if an Expert or Administrator wants to change a status name or colour is only for the own company.
Other roles can see this page but not change this
User can select one or more statuses and change names and colours and User can reset all by RESET button and save.
13 Subscription
Service management
This page describes the Service Management wizard. The Service Management is a wizard to manage the service operations:
• Activation
• Renewal
13.11.1 Activation
The first available option is the device activation.
1. The user must select "Activation" and then click on “next.”
2. The Activation wizard starts.
a. The wizard breadcrumb is shown on the top left.
b. In the device ID section, the user can start to search the wanted device and the matching devices will be listed during
the typing
c. Once the device has been selected, the user has to select the company to which the device should belong.
3. When the user has selected both the device ID and the company (both fields are required), he/she can click on “next.”
4. The following page is shown.
a. The wizard breadcrumb is shown on the top left.
b. The left section shows a summary of the ongoing activation with the type of action (activation), the device ID and the
company selected in the previous step;
c. The right section shows the list of the available subscriptions. The list is based on the user who is logged in.
d. The bottom right section shows the "Terms and conditions" section with the check to accept.
5. The user has to select the subscription and check the acceptance, because thesefields are required, then click on “next.”
6. The activation has been successfully completed and the Unique ID is provided to the user. Now the user has completed the first part
of the activation.
7. After the subscription activation, the user can configure the equipment by clicking on "Go to Equipment Configuration." If you define a
brand, type and model, a default configuration is assigned to the equipment.
13.11.2 Renewal
The second available option is the device activation.
1. The user has to select "Renewal" and then click on Next.
2. The Renewal wizard starts.
a. The wizard breadcrumb is shown at the top.
b. A search bar is shown to allow a quick search for the device to renew.
c. The main section displays the list of all devices, whether with expired subscriptions or not.
3. The user has to select the device he/she wants to renew/upgrade (only one selection can be performed). Then he/she can click on
“next.”
4. The following page is shown.
a. The wizard breadcrumb is shown on the top;
b. The left section shows a summary of the ongoing renewal with the equipment name, the device serial number, the current
subscription and the expiration date;
c. The "Unique ID" field is shown on the top of the right section (this information is available in the "Equipment" page);
d. The list of the available subscriptions is shown in the center of the right section.
e. The "Terms & conditions" is shown at the bottom of the right section with the check to accept.
5. After the "Unique ID" insertion and the check of the subscription and the acceptance (these three fields are required), the user can
complete the procedure by clicking on "Finish."
Please note that the Renew process can be performed even with a device which subscription has not already expired.
If the subscription has expired, the user can select any of the available ones. The selected subscription will be applied to the device with
a start time stamp set to the current day and time, but the end time stamp will be set to the same time and the day will be calculated
based on the subscription duration.
Otherwise, if the subscription has not expired yet, there are two possible situations: the new subscription can be different from the
current one or not. In the former case, the start and the end time stamp will be set as with an expired subscription, but the subscription
71
type will be changed (e.g., upgrade). However, if the new subscription is equal to the current one, the new subscription duration
will be added to the current end time stamp (e.g., subscription extension).
Expiration
This section describes the expiration report page.
The expiration report page allows the user to see at a glance all the activated equipment in his view (whether still active or not).
72
1.1.1.30 Expiration date
Please note that the equipment is ordered from the closest expiration date to the most distant one.
First subscription activations
This section describes the First Subscriptions Activation report page. The First Subscriptions Activations report page allows the
user to see at a glance all the activations performed on equipment in his/her view.
Please note that the equipment is ordered from the nearest activation date to the most distant one.
73
14 Landing page set-up
Users can set-up their landing page through the website.
In this way, users can replace the standard HOMEPAGE with another page of their
74
15 My Notifications
This section allows the users to configure their notifications.
My Notifications - Configuration
Users must select My Notifications item under the User Menu.
75
Afterwards, the page content will appear below the toggle. On the left side there are all the type of alarms that the user can configure.
On the right, the available equipment that has that alarm type enabled.
By clicking on an alarm type in the list on the left side of the page, the user can:
• Select to enable which type of notifications
o E-mail
o Web
o Push
• Select which equipment
o One or more than one
o All by bulk selection
o Search the desired equipment
76
My Notifications – setting for other users
The user can configure notifications for other users only if they are at the same level or below them, from a hierarchical point of view.
The user can have access to the notification page by clicking on the ADMINISTRATION menu → USERS and by selecting this icon
.
77