Changes

__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 '''[[RMS Management|Management]]''' section.  

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.  

[[File:RMS manual task manager location v1.png]]

[[File:RMS manual task manager location v1.png]]

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==

 

==Creating a new Task Group==

 

[[File:RMS manual Task manager configuration menu v1.png]]

[[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

##'''Upload file'''

***'''Command'''[[File:RMS manual new task group v1.png|right|581x581px|alt=|border]]

###'''File to upload''' - select file to be uploaded to the device

****'''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

*****'''Key''' - variable key to be written into the command

*****'''Value''' - default value of the key

*****'''Description''' - this is an optional field, can be used to clarify the purpose of the variable

****'''Command''' - command that needs to be executed on the device

##'''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

****'''Timeout(seconds)''' - set a time limit of how long the task is allowed to take before timeout

##'''Key''' - variable key to be written into the command

****'''Acceptable codes''' - add return codes that are accepted as 'non failure', which means the task will count as completed without fail

##'''Value''' - default value of the key

****'''Stop task group on failure''' - if the box is unchecked, next task will be executed even if the current one fails

##'''Description''' - this is an optional field, can be used to clarify the purpose of the variable

#'''Command''' - command that needs to be executed on the device

#'''Timeout(seconds)''' - set a time limit of how long the task is allowed to take before timeout

#'''Acceptable codes''' - add return codes that are accepted as 'non failure', which means the task will count as completed without fail

#'''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 Task Groups==

==Executing Task Groups==

Once task groups are created, you can execute them on selected devices.

Once task groups are created, they will appear inside Task Manager configuration window like so:

After selecting them, in the top menu, under '''Management''', click on '''Execute task'''.

[[File:RMS manual task group list v1.png|border]]

[[File:RMS manual task group list v1.png|border]]

To execute a task group, devices on which this task group needs to be executed on must be selected by checking the boxes in your device list.

'''Note:''' Only devices that are online at the moment can be selected.

'''Note:''' Only devices that are online at the moment can be selected.

Once devices are selected, access the task manager configuration menu shown in the image above (''Devices → Management → Task Manager''), once again check the boxes of the devices on which task group needs to be executed and press '''"Execute task group for selected devices"''' button in the Actions column. A new window will open where information of the task group can be reviewed before pressing '''"Execute Task Group"''' button.

Once devices are selected, access the task manager configuration menu shown in the image above (''Devices → Management → Task Manager''), once again check the boxes of the devices on which task group needs to be executed and press '''"Execute task group for selected devices"''' button in the Actions column. A new window will open where information of the task group can be reviewed before pressing '''"Execute Task Group"''' button.

[[File:RMS manual executing task group v1.png]]

[[File:RMS manual executing task group v1.png]]

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.

 

[[File:Rmstaskmanager1.png|border]]

 

==Editing Task Groups==

==Editing Task Groups==

Task groups can be edited by clicking '''"Edit group tasks"''' button, which is located in the Task manager's main page:

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]]

[[File:RMS manual Task manager deleting tasks v1.png]]

==Deleting Task Groups==

==Deleting Task Groups==

Task groups can be deleted by clicking '''"Remove group"''' button, which is located in the Task manager's main page:

Task groups can be deleted by clicking '''"Remove group"''' button, which is located in the Task manager configuration menu Actions column:

'''Note:''' Downloaded files can be found by navigating to '''''Management → Files'''''

'''Note:''' Downloaded files can be found by navigating to '''''Management → Files'''''