Start Task

Declaration

<AMSTARTTASK TASKFILE="text" />

See Also

Call Function | Stop Task | Write to Log | Enable/Disable Task | Shut Down AutoMate | Start Task | Trigger Task

Description

Starts another task using the task name specified. When the sub-task starts, the parent task will wait for it to complete before continuing. Public variables from the parent task are available to the newly started sub-task (see Create Variable action for more details). This action supports starting both managed and unmanaged (or external) tasks. More on managed and external tasks

Practical Usage

Used to start a secondary task (or sub-task) from a "parent" task. Especially useful for code reuse so the same code does not have to be written over and over again. Rather, one task (usually an unmanaged/external task) can be created and called repeatedly.

Parameters

General Properties

Property

Type

Required

Default

Markup

Description

Run a task file

Text

No

(Empty)

TASKFILE=C:\ProgramData\Network Automation\AutoMate 9\Tasks\Task1.aml

If set to YES, specifies the task file to run, which is usually an unmanaged or external task.

Start a managed task

Text

No

(Empty)

  1. MANAGEDTASK="Task1"

  2. MANAGEDTASK="Folder1\Task1"

If set to YES, specifies the name of the managed task to start (as specified in the Task Administrator or default managed task location). The task must exist in the current machine's default managed task location (entered in System -> Options -> System of the Task Administrator) at runtime or the step will fail.

NOTE: Later moving the task to another folder or modifying the task name or parent folder name can break this linkage once created.

Password (Optional)

Text

No

(Empty)

PASSWORD="password"

If the task has been encrypted (as specified in the managed task's Security properties) this parameter indicates the password that should be used to decrypt it so that it can start.

 

Description Properties

The Description tab allows you to customize the text description of any step when it appears in the Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab is part of AutoMate's Error Handling functionality which allows you to select / omit specific errors that will cause a particular step to fail.

More about error causes properties

On Error Properties

The On Error tab is part of AutoMate's Error Handling functionality which allows you to determine what the task should do if a particular step encounters an error.

More about on error properties

Notes

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

 

Sample 1 - Start a task file

 <AMSTARTTASK TASKFILE="C:\Temp\Task1.aml" />

 

Sample 2 - Start a password protected managed task

 <AMSTARTTASK MANAGEDTASK="Task2" TASKID="{64E417BC-613B-4303-B23A-93420B42FE04}" PASSWORD="AM1J0nE7Y6UQP/qp+Ajw5KWSA==aME" />

↑ Top of Page