226
edits
Changes
mLine 4:
Line 4: + Line 11:
Line 12: − ===Two-Factor Authentication=== − ---- − Firstly, before using Task Manager, your account must have [[Teltonika ID|Two-Factor Authentication]] enabled. − − This can be done by navigating to your RMS Account settings and then the Security page. Any Authentication type (other than None) is viable. − − Once Two-Factor authentication is enabled, you can head over to Devices → Management → Task Manager and start creating new task groups. Line 45:
Line 39: − + + + Line 59:
Line 55: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
no edit summary
[[File:RMS manual task manager location v1.png]]
[[File:RMS manual task manager location v1.png]]
===Introduction===
===Introduction===
This article will provide information on what is needed in order to start using '''RMS Task Manager''' as well as configuration examples with step-by-step instructions for different usage scenarios.
This article will provide information on what is needed in order to start using '''RMS Task Manager''' as well as configuration examples with step-by-step instructions for different usage scenarios.
==Creating a new Task Group==
==Creating a new Task Group==
****'''Stop task group on failure''' - if the box is unchecked, next task will be executed even if the current one fails
****'''Stop task group on failure''' - if the box is unchecked, next task will be executed even if the current one fails
*'''Add additional task +''' - used to add another task to this specific task group
*'''Add additional task +''' - used to add another task to this specific task group
==Executing tasks==
==Executing Task Groups==
Once task groups are created, they will appear inside Task Manager configuration window like so:
Once task groups are created, they will appear inside Task Manager configuration window like so:
Once the task group finishes executing tasks, a status message will be shown whether the task group finished with all tasks completed.
Once the task group finishes executing tasks, a status message will be shown whether the task group finished with all tasks completed.
==Editing Task Groups==
Task groups can be edited by clicking '''"Edit group tasks"''' button, which is located in the Task manager configuration menu Actions column:
[[File:RMS manual Task manager deleting tasks v1.png]]
==Deleting Task Groups==
Task groups can be deleted by clicking '''"Remove group"''' button, which is located in the Task manager configuration menu Actions column:
[[File:RMS manual Task manager removing tasks v1.png]]
==Configuration Examples==
==Configuration Examples==
===Setting Mobile Data Limit===
----
In this example, we will set mobile data limit on SIM1 interface. We will achieve this by creating new Task group in RMS Task Manager and using Command as a task type.
*Create a new task group by clicking '<nowiki/>'''ADD NEW TASK GROUP'''' button inside Task Manager configuration window.
*Define Task group name, select Command as a task type on the first task and insert the following text into Command field:
''uci set quota_limit.mob1s1a1.enabled='1'''
*Click '<nowiki/>'''ADD ADDITIONAL TASK'''' button at<nowiki/> the bottom of the window to add a second task, make settings identical to the first task and insert the following command into the Command field (this will set the mobile limit to 2GB or 2048MB):
''uci set quota_limit.mob1s1a1.data_limit='2048'''
*Add another task with identical setti<nowiki/>ngs and insert the following text into the Command field (this will set the period of the data limit to 1 day:
''uci set quota_limit.mob1s1a1.period='1'''
*Add another task with identical setti<nowiki/>ngs and insert the following text into the Command field (this will commit the changes and restart the mobile interface):
''uci commit && ifdown mob1s1a1 && ifup mob1s1a1''
Here is a review of all 4 tasks in this task group:
[[File:RMS manual Task manager configuration example data limit v1.png|border|523x523px]]
===Installing Additional Packages===
----
In this example, we will install an additional package to the device using opkg commands as well as generate and download a log file to see if package was installed successfully. For this example, we will install DNP3 package.
*Create a new task group by clicking '<nowiki/>'''ADD NEW TASK GROUP'''' button inside Task Manager configuration window.
* Define Task group name, select Command as a task type on the first task and insert the following text into Command field:
''opkg update''
*Set Timeout to 30 seconds, since updating package repository might take longer than the default 10 seconds.
* Add "1" to acceptable codes, since while updating repositories, some links might be unavailable, this is done to avoid getting an error message while executing a task. Alternatively, you can uncheck "Stop task group on failure" box to achieve the same result.
*Configuration of the first task should look like the following image:
[[File:RMS manual Task manager configuration example package v1.png]]
*Click '''ADD ADDITIONAL TASK''' button at the bottom of the window to add a second task, once again select Command as a task type and insert the following text into command field:
''opkg install dnp3 >> /tmp/opkglog.log''
*This will install the package as well as save the installation logs to the defined log file.
*Set the timeout to 30 seconds, since the installation process can take longer than the default 10 seconds.
*Second task configuration should look like the following image:
[[File:RMS manual Task manager configuration example package task2 v1.png]]
*Now we will download the generated log file to read the logs of installation.
*Click '''ADD ADDITIONAL TASK''' button at the bottom of the window to add a second task, this time, select Download file as a task type and inser the following path to the '''File path in device''' field:
''/tmp/opkglog.log''
*Configuration of the third task should look like the following image:
[[File:RMS manual Task manager configuration example package task3 v1.png]]
'''Note:''' Downloaded files can be found by navigating to '''''Management → Files'''''