Line 1: |
Line 1: |
| __TOC__ | | __TOC__ |
| ==Summary== | | ==Summary== |
− | RMS '''Task Manager''' is a remote scripting tool with a user friendly graphics interface integrated into RMS platform. It is located in the '''Management''' top control menu found under '''[[RMS Devices|Devices]]''' section. | + | RMS '''Task Manager''' is a remote scripting tool with a user friendly graphics interface integrated into RMS platform. It is located in the '''[[RMS Management|Management]]''' section. |
| | | |
| [[File:RMS manual task manager location v1.png]] | | [[File:RMS manual task manager location v1.png]] |
Line 12: |
Line 12: |
| 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. |
| | | |
| + | ==Overview== |
| + | [[File:RMS manual Task manager configuration menu v1.png]] |
| + | In the main Task Manager page, you'll be able to: |
| + | #Create a new task group or view files that have been created/imported during task execution. |
| + | #Search through existing task groups. |
| + | #Edit or remove task group |
| + | #Change table settings or refresh data. |
| | | |
| ==Creating a new Task Group== | | ==Creating a new Task Group== |
− | New task group can be created by clicking on the '''"ADD NEW TASK GROUP"''' button inside Task Manager configuration menu. | + | New task group can be created by clicking on the <big>'''<span style="color:#0455a4">+ ADD</span>'''</big> button inside Task Manager configuration menu, which will open this window: |
− | | + | [[File:RMS manual new task group v1.png|1100px|border|class=tlt-border]] |
− | [[File:RMS manual Task manager configuration menu v1.png]] | |
− | | |
| On a new task group window, settings of this task group and its tasks can be edited: | | On a new task group window, settings of this task group and its tasks can be edited: |
− | *'''Task group name''' - it is a name of your entire Task group
| + | #'''Task group name''' - it is a name of your entire Task group |
− | **'''Task name''' - this field names one of your tasks inside this specific task group
| + | #'''Task name''' - this field names one of your tasks inside this specific task group |
− | **'''Task type''' - select one type from the drop down menu for this specific task
| + | #'''Task type''' - select one type from the drop down menu for this specific task |
− | ***'''Command'''[[File:RMS manual new task group v1.png|right|581x581px|alt=|border]]
| + | ##'''Upload file''' |
− | ****'''Command variables''' - when set, value of the key can be changed during the execution of the task group. Press the "+" button to create a new variable
| + | ###'''File to upload''' - select file to be uploaded to the device |
− | *****'''Key''' - variable key to be written into the command
| + | ###'''Target file path''' - location of where this file should be uploaded |
− | *****'''Value''' - default value of the key
| + | ##'''Download file''' |
− | *****'''Description''' - this is an optional field, can be used to clarify the purpose of the variable
| + | ###'''File path in device''' - location of the file in the device to be downloaded |
− | ****'''Command''' - command that needs to be executed on the device
| + | #'''Command''' |
− | ****'''Timeout(seconds)''' - set a time limit of how long the task is allowed to take before timeout
| + | ##'''Command variables''' - when set, value of the key can be changed during the execution of the task group. Press the "+" button to create a new variable |
− | ****'''Acceptable codes''' - add return codes that are accepted as 'non failure', which means the task will count as completed without fail
| + | ##'''Key''' - variable key to be written into the command |
− | ****'''Stop task group on failure''' - if the box is unchecked, next task will be executed even if the current one fails
| + | ##'''Value''' - default value of the key |
− | ***'''Upload file'''
| + | ##'''Description''' - this is an optional field, can be used to clarify the purpose of the variable |
− | ****'''File to upload''' - select file to be uploaded to the device
| + | #'''Command''' - command that needs to be executed on the device |
− | ****'''Target file path''' - location of where this file should be uploaded
| + | #'''Timeout(seconds)''' - set a time limit of how long the task is allowed to take before timeout |
− | ****'''Stop task group on failure''' - if the box is unchecked, next task will be executed even if the current one fails
| + | #'''Acceptable codes''' - add return codes that are accepted as 'non failure', which means the task will count as completed without fail |
− | ***'''Download file'''
| + | #'''Stop task group on failure''' - if the box is unchecked, next task will be executed even if the current one fails |
− | ****'''File path in device''' - location of the file in the device to be downloaded
| + | #'''Add additional task +''' - used to add another task to this specific task group |
− | ****'''Stop task group on failure''' - if the box is unchecked, next task will be executed even if the current one fails
| + | #Save task group |
− | *'''Add additional task +''' - used to add another task to this specific task group
| + | #In this section all tasks in the task group will be displayed. |
− | | |
| | | |
| ==Executing Task Groups== | | ==Executing Task Groups== |