Difference between revisions of "FOTA WEB Files menu"

From Wiki Knowledge Base | Teltonika GPS
 
(20 intermediate revisions by 6 users not shown)
Line 2: Line 2:
  
  
−
This chapter is an overview of '''FILES''' menu.<br />
+
FOTA WEB supports various tasks that require files to be used (Update configuration, update firmware, upload TLS certificate...). The files section on FOTA WEB is used to manage all your files for easy and quick use with the task system.
  
−
=='''Files section'''==
+
[[File:FOTAFILES1.png]]
  
−
This section displays files that have been uploaded to FOTA by a user. Two possible file types: Firmware and Configuration.
+
 
 +
==Files section==
 +
 
 +
This section displays files that have been uploaded to FOTA WEB by a user. There are three possible file types: Firmware, Configuration and Certificate.
  
 
{| class="wikitable" style="width: 100%;"
 
{| class="wikitable" style="width: 100%;"
Line 14: Line 17:
 
! style="width: 40%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | '''DESCRIPTION'''
 
! style="width: 40%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | '''DESCRIPTION'''
 
|-
 
|-
−
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | '''DESCRIPTION''' <br />
+
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | '''ID'''
−
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | String: description; default: N/A<br />
+
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | String: ID
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | Shows the ID number of the uploaded file.
 +
|-
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | '''DESCRIPTION'''  
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | String: description; default: N/A
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | Description shows user-defined explanation for this file. <br />
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | Description shows user-defined explanation for this file. <br />
 
In case of configuration download from the device – it shows “From device”.<br />
 
In case of configuration download from the device – it shows “From device”.<br />
 
|-
 
|-
−
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | '''FILE''' <br />
+
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | '''NAME'''  
−
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | String: file name <br />
+
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | String: file name  
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | Exact filename of uploaded file.<br />
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | Exact filename of uploaded file.<br />
 
In case of configuration download '''from''' device – it includes IMEI + Unix timestamp.<br />
 
In case of configuration download '''from''' device – it includes IMEI + Unix timestamp.<br />
 
|-
 
|-
−
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | '''TYPE''' <br />
+
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | '''FILE TYPE'''  
−
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | Firmware | configuration <br />
+
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |  
−
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | Shows whether file is firmware or configuration.<br />
+
* Firmware  
 +
* Configuration
 +
* Certificate<br />
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | Shows whether the file is firmware, configuration, or certificate.<br />
 
|-
 
|-
−
| 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'''  
−
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | String: Company name <br />
+
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | String: Company name  
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | Shows to which company this file is assigned.<br />
 
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | Shows to which company this file is assigned.<br />
 
If a file is assigned to a '''child''' level company – then only that particular company and its root level company can utilize this file.<br />
 
If a file is assigned to a '''child''' level company – then only that particular company and its root level company can utilize this file.<br />
 
|-
 
|-
−
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | '''CREATED AT''' <br />
+
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | '''CREATED AT'''  
−
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | String: date and time<br />
+
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | String: date and time
−
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | It shows when the file was uploaded to the FOTA. Date/Time is adjusted by the browser according to the time of local PC.<br />
+
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | It shows when the file was uploaded to the FOTA WEB. Date/Time is adjusted by the browser according to the time of local PC.<br />
 +
|-
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | '''SIZE'''
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | String: size
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | Shows the uploaded file's size.
 
|}
 
|}
  
−
=='''Actions'''==
+
==Upload==
  
−
'''ACTIONS''' button allows to add a new file or remove (delete) already uploaded ones.
+
'''Upload''' menu allows to select a '''Company''' and assign Firmware, Configuration, or Certificate files to it.
  
−
{| class="wikitable" style="width: 100%;"
+
[[File:FOTAFILES4.png|frameless|]]
−
|+
+
 
−
! style="width: 20%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | '''FIELD NAME'''
+
{| style="width: 100%;"
−
! style="width: 40%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | '''ACTIONS'''
+
! style="width: 20%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |'''FIELD NAME'''
−
! style="width: 40%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | '''DESCRIPTION'''
+
! style="width: 80%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |'''DESCRIPTION'''
 +
|-
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | '''File type'''
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | Allows user to select, if the file being uploaded is Firmware, Configuration, or Certificate.<br />
 
|-
 
|-
−
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | '''Add new file''' <br />
+
|style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;"|'''Company'''
−
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | Firmware | Configuration <br />
+
|style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;"|Select which company the uploaded file will be assigned to.
−
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | '''Add new file''' menu allows to select a '''Company''' and assign Firmware and Configuration files to it.<br />
 
−
It is possible to upload multiple Firmware files and Multiple configurations at the same time.<br />
 
 
|-
 
|-
−
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | '''Remove''' <br />
+
|style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;"|'''Description'''
−
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | - <br />
+
|style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;"|Ability to add a user-defined description about the file being uploaded.  
−
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | Removes selected file(s) from FOTA WEB.  
+
In case it is left empty, it will show the import date.
−
Once file is removed it shall not appear in '''Devices -> Actions -> Create task -> Update configuration''' options.
+
 
 +
'''NOTE''':  Non-mandatory field.
 
|}
 
|}
  
−
'''NOTE:''' configuration files that were downloaded via '''Devices -> Actions -> Create task -> Receive configuration''' shall appear in '''FILES''' tab.
+
== Availability of files for task creation ==
 +
Depending on the company and its place in the hierarchy, the file uploaded by this company (FW, configurations, etc.) will have a different access range.
 +
 
 +
Let's imagine that we have the following hierarchy of companies:
 +
 
 +
* A (parent company)
 +
** B (child company of A)
 +
** C (child company of A)
 +
*** D (child-child company of C)
 +
 
 +
In this case, depending on which company the file was uploaded to, the following options will be available for creating tasks:
 +
 
 +
* A can create task for B with A file (straight downwards);
 +
* A can create task for D with C file (straight downwards);
 +
 
 +
== Delete ==
 +
'''Delete''' menu allows the user to delete selected files from the FOTA WEB. The files that should be deleted can be selected by just adding a checkmark next to them, filtering them,
 +
 
 +
or listing the ID's of the files in a .csv file.
 +
 
 +
'''NOTE:''' Scenario files can '''not''' be deleted from the FOTA WEB files menu.
 +
 
 +
[[File:FOTAFILES3.png|frameless]]
 +
 
 +
'''NOTE:''' configuration files that were downloaded via '''Devices -> Create task -> Receive configuration''' shall appear in '''FILES''' tab.
  
 
Configuration files can be '''downloaded''' to your PC from '''FILES''' menu. Configuration files can be opened only with the FM configurator.
 
Configuration files can be '''downloaded''' to your PC from '''FILES''' menu. Configuration files can be opened only with the FM configurator.
  
 +
== Download ==
 +
While viewing the Files section you are able to download any of the already uploaded files for usage within your system.
 +
 +
To download you should locate your file from the list and click on the <b> Download Button </b> [[image:FOTAFILES6.png]]
 +
 +
== Edit ==
 +
'''Edit''' menu allows the user to edit the information of a selected file from the list on FOTA WEB.
 +
 +
[[File:FOTAFILES5.png|frameless]]
 +
 +
The editable fields are ''Company'' that the file is under and ''Description''.
 +
 +
 +
{|style="width:100%;"
 +
|-
 +
|[https://wiki.teltonika-gps.com/view/Device_Groups '''Device Groups'''] - Previous page
 +
|style="text-align:right;| Next page - [https://wiki.teltonika-gps.com/view/FOTA_WEB_Companies '''Companies''']
 +
|}
  
−
Next chapter [[FOTA Company and User role structure|'''Company and User role structure''']]
 
  
−
[[Category:FOTA]]
+
[[Category:FOTA WEB]]

Latest revision as of 15:57, 20 March 2024

Main Page > Software & Applications > FOTA WEB > FOTA WEB Files menu


FOTA WEB supports various tasks that require files to be used (Update configuration, update firmware, upload TLS certificate...). The files section on FOTA WEB is used to manage all your files for easy and quick use with the task system.

FOTAFILES1.png


Files section

This section displays files that have been uploaded to FOTA WEB by a user. There are three possible file types: Firmware, Configuration and Certificate.

FIELD NAME VALUE DESCRIPTION
ID String: ID Shows the ID number of the uploaded file.
DESCRIPTION String: description; default: N/A Description shows user-defined explanation for this file.

In case of configuration download from the device – it shows “From device”.

NAME String: file name Exact filename of uploaded file.

In case of configuration download from device – it includes IMEI + Unix timestamp.

FILE TYPE
  • Firmware
  • Configuration
  • Certificate
 Shows whether the file is firmware, configuration, or certificate.
COMPANY String: Company name Shows to which company this file is assigned.

If a file is assigned to a child level company – then only that particular company and its root level company can utilize this file.

CREATED AT String: date and time It shows when the file was uploaded to the FOTA WEB. Date/Time is adjusted by the browser according to the time of local PC.
SIZE String: size Shows the uploaded file's size.

Upload

Upload menu allows to select a Company and assign Firmware, Configuration, or Certificate files to it.

FOTAFILES4.png

FIELD NAME DESCRIPTION
File type Allows user to select, if the file being uploaded is Firmware, Configuration, or Certificate.
Company Select which company the uploaded file will be assigned to.
Description Ability to add a user-defined description about the file being uploaded.

In case it is left empty, it will show the import date.

NOTE: Non-mandatory field.

Availability of files for task creation

Depending on the company and its place in the hierarchy, the file uploaded by this company (FW, configurations, etc.) will have a different access range.

Let's imagine that we have the following hierarchy of companies:

  • A (parent company)
    • B (child company of A)
    • C (child company of A)
      • D (child-child company of C)

In this case, depending on which company the file was uploaded to, the following options will be available for creating tasks:

  • A can create task for B with A file (straight downwards);
  • A can create task for D with C file (straight downwards);

Delete

Delete menu allows the user to delete selected files from the FOTA WEB. The files that should be deleted can be selected by just adding a checkmark next to them, filtering them,

or listing the ID's of the files in a .csv file.

NOTE: Scenario files can not be deleted from the FOTA WEB files menu.

FOTAFILES3.png

NOTE: configuration files that were downloaded via Devices -> Create task -> Receive configuration shall appear in FILES tab.

Configuration files can be downloaded to your PC from FILES menu. Configuration files can be opened only with the FM configurator.

Download

While viewing the Files section you are able to download any of the already uploaded files for usage within your system.

To download you should locate your file from the list and click on the Download Button FOTAFILES6.png

Edit

Edit menu allows the user to edit the information of a selected file from the list on FOTA WEB.

FOTAFILES5.png

The editable fields are Company that the file is under and Description.


Device Groups - Previous page Next page - Companies
Retrieved from "https://wiki.teltonika-gps.com/index.php?title=FOTA_WEB_Files_menu&oldid=96862"