Automate- Shutdown Automate
Declaration
<AMSHUTDOWNAM ENDTASKS="YES/NO" />
Description
Shuts down Automate Desktop by stopping the Automate Desktop 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 Desktop, you
must reboot the system or manually restart the Automate Desktop Task Service
(AMTS.exe). Any task scheduled to run while Automate Desktop 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 Desktop at a particular time period, for instance, before scheduled system maintenance takes place.
Parameters
General
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
| End all running tasks | Yes/No | Yes | No | ENDTASKS="yes" | If selected, causes the step to also end all tasks that are currently in a running state. If disabled (default), running tasks will continue to run. Automate Desktop will shut down upon their completion. |
Example
NOTE:
- Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
- To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.
Description
This sample task shuts Automate Desktop.
Copy
<AMAUTOMATE ACTIVITY="shutdown_automate" ENDTASKS="YES" />