Changes

FOTA WEB Devices (view source)

Revision as of 12:36, 22 December 2023

7,540 bytes added ,  12:36, 22 December 2023
→‎Task Types
Line 1: Line 1:  
__TOC__
 
__TOC__
 +
The Device Area is the main area where we can see the devices and all information about them including pending,completed and canceled tasks.
 +
 +
=='''Device Area'''==
    
There are the following columns in the general Device area.  
 
There are the following columns in the general Device area.  
   −
[[Image:FOTADevice.png|1100px|center]]
+
[[Image:FOTANEWDEVICE1.png|1100px|center]]
 
{| style="width: 100%;"
 
{| style="width: 100%;"
 
! style="width: 20%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | '''FIELD NAME'''
 
! style="width: 20%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | '''FIELD NAME'''
Line 35: Line 38:  
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Device’s IMEI<br />
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Device’s IMEI<br />
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Field displays device’s IMEI. <br />
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Field displays device’s IMEI. <br />
 +
|-
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''Status''' <br />
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |<span style="color:grey">'''Inactive'''</span> <br /> <span style="color:orange">'''Offline'''</span> <br /> <span style="color:green">'''Online'''</span><br />
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |<span style="color:grey">'''Inactive'''</span> - not activated or already decomissioned <br /> <span style="color:orange">'''Offline'''</span> - seen at is more than 24h ago <br /> <span style="color:green">'''Online'''</span> - seen at is less than 24h ago <br />
 +
|-
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''Task queue''' <br />
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |<span style="color:grey">'''Empty'''</span> <br /> <span style="color:indigo">'''Pending'''</span> <br /> <span style="color:#0066CC">'''Executing'''</span>
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |<span style="color:grey">'''Empty'''</span> - no task in a queue <br /> <span style="color:indigo">'''Pending'''</span> - created task is awaiting execution<br /><span style="color:#0066CC">'''Executing'''</span> - created task is being executed <br />
 
|-
 
|-
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''SERIAL NO.''' <br />
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''SERIAL NO.''' <br />
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Device’s S/N<br />
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Device’s S/N<br />
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Field displays device’s Serial number.<br />
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Field displays device’s Serial number.<br />
 +
|-
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''GSM NUMBER'''
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |GSM number (MSISDN) of the SIM card installed in the device
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''Note:''' The GSM number is shown in FOTA WEB for all devices that had the SIM card is installed during the device manufacturing process (eSIM or regular SIM) after May 3rd, 2022.
 +
Previously manufactured devices might not have the GSM number available in FOTA WEB.
 +
|-
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''ICCID'''
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |ICCID of the SIM card that is installed in the device
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''Note:''' The SIM card IMSI is shown in FOTA WEB for all devices that had the SIM card is installed during the device manufacturing process (eSIM or regular SIM) after May 3rd, 2022.
 +
Previously manufactured devices might not have the ICCID number available in FOTA WEB.
 +
|-
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''IMSI'''
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |IMSI number of the SIM card that is installed in the device
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''Note:''' The SIM card IMSI is shown in FOTA WEB for all devices that had the SIM card is installed during the device manufacturing process (eSIM or regular SIM) after May 3rd, 2022.
 +
Previously manufactured devices might not have the IMSI number available in FOTA WEB.
 +
|-
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''PRODUCT CODE'''
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Manufacturing code of the device
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Internal manufacturing code, that shows the device hardware/firmware configuration.
 +
 +
'''Note:''' All devices manufactured '''after''' 2022, May 3rd will have the product code displayed in FOTA WEB - devices manufactured before this date, might not have the product code in FOTA WEB.
 
|-
 
|-
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''COMPANY''' <br />
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''COMPANY''' <br />
Line 47: Line 79:  
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Device’s Group<br />
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Device’s Group<br />
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |If device is assigned to a group, this field displays group name device is assigned to.<br />
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |If device is assigned to a group, this field displays group name device is assigned to.<br />
−
|-
  −
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''STATUS NAME'''<br />
  −
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Devices Status<br />
  −
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |This field shall indicate status of device. Possible statuses:
  −
  −
  −
Inactive - Device has not connected to system in last 30 days
  −
  −
Idle - Device has no pending tasks
  −
  −
Pending - Device has queued tasks that have to be executed
  −
  −
Working - Device currently is connected to server and executing task
   
|-
 
|-
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''UPDATED AT'''<br />
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''UPDATED AT'''<br />
Line 73: Line 92:  
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |This field shows the time device was added to the FOTA WEB web system.
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |This field shows the time device was added to the FOTA WEB web system.
 
|}
 
|}
 +
 +
===Device Information===
 +
 +
By clicking on a device we can see the displayed information about the selected device.
 +
 +
[[Image:Device_Information.png|800px|left]]<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
 
=='''Create Task'''==
 
=='''Create Task'''==
    
The '''Create Task''' pop up menu button is the main tool for all possible actions (tasks) with devices. Successful action results in a [[FOTA WEB Devices#View Tasks|'''queued job''']].
 
The '''Create Task''' pop up menu button is the main tool for all possible actions (tasks) with devices. Successful action results in a [[FOTA WEB Devices#View Tasks|'''queued job''']].
   −
[[Image:Task.png|1100px|center]]
+
[[Image:FOTATaskCreate.png|500px|left]]<br>
−
 
+
<br>
−
This chapter provides an explanation of what each dropdown menu item does and how to use it. There is 4 possible filtering from the beginning to assign your tasks.<br />
+
<br>This chapter provides an explanation of what each dropdown menu item does and how to use it. There is 4 possible filtering from the beginning to assign your tasks.<br />
 
1. For the manually '''selected devices'''.<br />
 
1. For the manually '''selected devices'''.<br />
 
2. For the '''filtered devices'''.<br />
 
2. For the '''filtered devices'''.<br />
Line 85: Line 124:  
4. For '''all devices'''.<br />
 
4. For '''all devices'''.<br />
   −
[[Image:TaskCreation.png|300px|alt=|left]]
+
[[Image:FOTACreateTask.png|400px|alt=|left]]
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
 
 +
=== Cancel task ===
 +
 
 +
By selecting the required device and opening the detailed information you can also cancel the task. Only tasks in the statuses "Pending" and "Running" can be cancelled
 +
 
 +
[[Image:Cancel task.png|400px|alt=|left]]
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
 
 +
 
 +
=== Task Types ===
 +
 
 +
General information about tasks and task types.
    
{| class="sortable" style="width: 100%;"
 
{| class="sortable" style="width: 100%;"
Line 113: Line 194:  
|'''Send TLS file'''
 
|'''Send TLS file'''
 
|<nowiki>Transfer user TLS certificate | Select File | Create </nowiki>
 
|<nowiki>Transfer user TLS certificate | Select File | Create </nowiki>
−
|You can Upload the required TLS certificate over the '''Files menu''' or over the same pop up windown while selecting the task, if you have the TLS certificate uploaded already, task can be created by selecting required TLS certificate.<br />If there is no available TLS certificates, please press on '''Upload new file''' button to add the certificate on the same pop up window.
+
|You can Upload the required TLS certificate over the '''Files menu''' or over the same pop up window while selecting the task, if you have the TLS certificate uploaded already, task can be created by selecting required TLS certificate.<br />If there is no available TLS certificates, please press on '''Upload new file''' button to add the certificate on the same pop up window.
 +
[[File:Alert.png|left|link=]]
 +
<br>
 +
Task type is only supported by devices with '''Firmware version newer than 03.28.01''', otherwise FOTA WEB will not allow to upload certificate to device and error that feature is not supported will be shown.  
 
|}
 
|}
   Line 119: Line 203:  
The "Schedule time" feature allows users to select the time, when the created task can be executed.
 
The "Schedule time" feature allows users to select the time, when the created task can be executed.
   −
[[File:Scheduling_task.png|alt=|frameless|400x400px]]
+
[[File:FOTASchedule1.png|alt=|frameless|600x600px]]
    
Time range can be selected in 30 minute periods, but it cannot be less than 2 hours - for example, user can select a task time from 8:30 to 15:00.  
 
Time range can be selected in 30 minute periods, but it cannot be less than 2 hours - for example, user can select a task time from 8:30 to 15:00.  
Line 126: Line 210:     
'''NOTE:''' The time is selected in the user's time zone.
 
'''NOTE:''' The time is selected in the user's time zone.
−
=='''Add scenario'''==
  −
  −
Feature allows to enable scenario on device as easy as possible. Scenarios e.g.:
  −
  −
*Overspeeding
  −
*Crash Detection
  −
*Towing detection
  −
  −
[[File:2021-12-15 11 26 22-Window2.png|frameless]]
  −
  −
After sending the partial configuration, it will not be portrayed as the current configuration.
  −
  −
Setting scenario doesn't overwrite other parameters apart scenario parameters.
     −
Each scenario has recommended settings.
+
'''NOTE:''' The scheduling feature does '''not''' adjust the time of the device connection to FOTA WEB - the user has to ensure, that the device has the correct connection frequency configured, so the device would connect to FOTA WEB during the set time range. Otherwise, the device will not execute the task.  
   −
Scenarios have info link to scenario Wiki page: [[FMB130 Features settings#Over Speeding|Overspeeding]] | [[FMB130 Accelerometer Features settings#Crash Detection|Crash Detection]] | [[FMB130 Accelerometer Features settings#Towing Detection|Towing Detection]]
+
FOTA WEB connection frequency configuration is described here: [[FMB920 GPRS settings#FOTA%20WEB%20Settings|FOTA WEB Settings]]
−
[[File:2021-12-15_10_19_03-Window1.png|alt=|center|frameless|1109x1109px]]
      
=='''Move'''==
 
=='''Move'''==
   −
This function assigns devices from Device list.
+
This function assigns devices from the Device list.
    
There are 4 possible filtering options for this function..<br />1. For the manually '''selected devices'''.<br />2. For the '''filtered devices'''.<br />3. For the devices '''from .csv file''' (IMEI or Serial No. can be used as identifier).<br />4. For '''all devices'''.<br />
 
There are 4 possible filtering options for this function..<br />1. For the manually '''selected devices'''.<br />2. For the '''filtered devices'''.<br />3. For the devices '''from .csv file''' (IMEI or Serial No. can be used as identifier).<br />4. For '''all devices'''.<br />
Line 154: Line 224:  
'''NOTE:''' a '''Group''' must be created first in '''Groups''' menu.<br />
 
'''NOTE:''' a '''Group''' must be created first in '''Groups''' menu.<br />
   −
[[Image:MoveFOTA.png|1100px|center]]
+
[[Image:FOTAMove.png|600px|left]]<br>
 +
<br>
 +
<br>
 +
<br />
 +
=='''Import'''==
 +
 
 +
This function is used to '''Import''' device attributes from the supported '''.csv''' file.
 +
There are 4 possible attributes that can be imported using this function.<br />
 +
1. Description<br />
 +
2. GSM Number<br />
 +
3. ICCID<br />
 +
4. IMSI<br />
 +
<br />
 +
'''NOTE:''' File syntax is as follows: IMEI, Attribute value.
 +
 
 +
[[File:Import new.png|frameless]]
    
=='''Export'''==
 
=='''Export'''==
    
This function is used to '''Export''' devices to the required '''.csv''' or '''.xlsx''' files.  
 
This function is used to '''Export''' devices to the required '''.csv''' or '''.xlsx''' files.  
−
There is 4 possible filtering options for this function.<br />
+
There are 4 possible filtering options for this function.<br />
 
1. For the manually '''selected devices'''.<br />
 
1. For the manually '''selected devices'''.<br />
 
2. For the '''filtered devices'''.<br />
 
2. For the '''filtered devices'''.<br />
 
3. For the devices '''from .csv file''' (IMEI or Serial No. can be used as identifier).<br />
 
3. For the devices '''from .csv file''' (IMEI or Serial No. can be used as identifier).<br />
 
4. For '''all devices'''.<br />
 
4. For '''all devices'''.<br />
 +
[[File:Export new.png|frameless]]
 +
 +
=='''Device transfer'''==
 +
 +
This function is used to '''transfer devices''' between unrelated companies.
 +
 +
[[File:Transfer new.png|frameless]]
 +
 +
<br>
 +
"Device transfer" function operation principle: <br />
 +
1. Company A (Device receiving company) generates a transfer token by selecting "Receive devices" tab and clicking on the "Create button". Generated token will be visible in the following window.<div style="width: 1000px; height: 250px;">
 +
{{{insert1|[[Image:FotaDeviceTransfer.png|550x270px|left|frameless]]}}}{{{insert2|[[Image:FotaDeviceToken.png|550x270px|right|frameless]]}}}
 +
</div>
 +
 +
<br />
 +
 +
'''NOTE:''' The token is single-use and expires in 21 days. Send this token to the person responsible for transferring devices from their company to yours.
 +
 +
2. Company A provides token to Company B (Device sending company) <br />
 +
3. Company B opens the Device transfer window, Transfer devices tab, and selects the preferred device source (Selected, Filtered or From file). <br />
 +
4. Company B enters the transfer token and clicks on the "Transfer" button to transfer selected devices to the "Receiving company"<br />
 +
 +
<div style="width: 1000px; height: 380px;">
 +
[[Image:FotaDeviceTransfer2.png|500px|left]]<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>
 +
<br>If all steps were correctly done, device/devices will be transferred to the receiving company, and both companies will receive an e-mail regarding the successful device transfer.
 +
</div>
 +
=='''Search'''==
 +
 +
This function is used to search for a device.<br>
 +
 +
You can search for devices by using the:<br>
 +
1. IMEI.<br>
 +
2. Description.<br>
 +
3. Serial Number.<br>
 +
 +
==='''Status'''===
 +
 +
This function is used to search for devices with the specific chosen status.<br />
 +
 +
You can choose the devices that have this status:<br />
 +
1. Inactive.<br />
 +
2. Offline.<br />
 +
3. Online. <br />
 +
 +
==='''Filter'''===
 +
 +
Filter is designed to both: (1) filter out a list of devices based on combinations of parameters, (2) and to make bulk ACTIONS.<br />
 +
 +
You can select/filter devices by:<br />
 +
 +
*Group<br />
 +
*Device Model<br />
 +
*Firmware version<br />
 +
*Configuration version<br />
 +
*Job status<br />
 +
 +
Under '''Active Filters''' section you shall see current filters that have been selected.<br />
 +
Each of the '''Active Filters''' can be removed individually by clicking on a particular filter, or they all can be removed together by clicking '''Reset all'''.<br />
 +
'''Active Filters''' shall maintain current configuration until manually Reset, meaning that navigating through various FOTA WEB menu’s '''Active Filters''' shall remain as last configured.<br />
 +
 +
===='''Bulk assignment'''====
 +
 +
Once '''Active Filters''' section has any number of parameters, the '''ACTIONS''' dropdown button automatically displays how many devices have been filtered. It allows to assign jobs to all selected devices.<br />
 +
 +
Example for the device filtering window is showed below, where FMB120 model selected.
 +
[[Image:FotaFilter.png|1100px|center]]<br />
 +
 +
Clicking on '''Create task''' and then selecting a task from filtering, say Firmware upgrade, would assign a Firmware upgrade job to selected devices.<br />
 +
 +
==='''Table View'''===
 +
This function allows you to manage the amount and what kind of information will be displayed in the table.<br />
 +
 +
Table view has two options:<br />
 +
1. Select columns to show.<br />
 +
2. Rows count per page.<br />
   −
[[Image:ExportFOTA.png|1100px|center]]
+
===='''Columns view'''====
 +
 
 +
This function allows you to filter out what kind of information to be shown about the device.<br />
 +
 
 +
===='''Rows per page'''====
 +
 
 +
This function defines the amount of rows that will be shown.<br />
    
=='''View Tasks'''==
 
=='''View Tasks'''==
Line 203: Line 382:  
In an unlikely event, any other type of error would appear – it should be reported back to us.<br />
 
In an unlikely event, any other type of error would appear – it should be reported back to us.<br />
   −
=='''Filter'''==
     −
Filter is designed to both: (1) filter out a list of devices based on combinations of parameters, (2) and to make bulk ACTIONS.<br />
+
{|style="width:100%;"
−
 
+
|-
−
You can select/filter devices by:<br />
+
|[https://wiki.teltonika-gps.com/view/Dashboard '''Dashboard'''] - Previous page
−
 
+
|style="text-align:right;| Next page - [https://wiki.teltonika-gps.com/view/Task_Groups '''Task Groups''']
−
*Company<br />
+
|}
−
*Group<br />
  −
*Device Model<br />
  −
*Firmware version<br />
  −
*Configuration version<br />
  −
*Job status<br />
  −
 
  −
Under '''Active Filters''' section you shall see current filters that have been selected.<br />
  −
Each of the '''Active Filters''' can be removed individually by clicking on a particular filter, or they all can be removed together by clicking '''Reset all'''.<br />
  −
'''Active Filters''' shall maintain current configuration until manually Reset, meaning that navigating through various FOTA WEB menu’s '''Active Filters''' shall remain as last configured.<br />
  −
 
  −
==='''Bulk assignment'''===
  −
 
  −
Once '''Active Filters''' section has any number of parameters, the '''ACTIONS''' dropdown button automatically displays how many devices have been filtered. It allows to assign jobs to all selected devices.<br />
  −
 
  −
Example for the device filtering window is showed below, where FMB120 model selected.
  −
[[Image:FOTAFilters.png|1100px|center]]<br />
  −
 
  −
Clicking on '''Create task''' and then selecting a task from filtering, say Firmware upgrade, would assign a Firmware upgrade job to selected devices.<br />
     −
Next chapter [[FOTA WEB Users|'''Users''']]
      
[[Category:FOTA WEB]]
 
[[Category:FOTA WEB]]
Retrieved from "https://wiki.teltonika-gps.com/view/Special:MobileDiff/72047...94066"

Navigation menu