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

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

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

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

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

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