Shutdown AutoMate

 

Declaration

<AMSHUTDOWNAM ENDTASKS="YES/NO" />

See Also

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

Description

Shuts down AutoMate by stopping the AutoMate Task Service, a system service used for the purpose of executing tasks which are manually started from the Task Administrator or automatically started by a trigger.

NOTE: To restart AutoMate, you must reboot the system or manually restart the AutoMate Task Service. Any task scheduled to run while AutoMate is shut down will comply to the parameters set under the Rescheduling properties of the Schedule trigger.

Practical Usage

Can be used with a Schedule trigger to shut down AutoMate at a particular time period, for instance, before scheduled system maintenance takes place.

Parameters

General Properties

Property

Type

Required

Default

Markup

Description

End all running tasks

Yes/No

Yes

No

ENDTASKS="yes"

If set to YES, causes the step to also end all tasks that are currently running. If set to NO (default), currently running tasks will continue to run. AutoMate will shut down upon their completion.

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.

 

 

<AMSHUTDOWNAM ENDTASKS="YES" />

↑ Top of Page