Computer - Suspend
Declaration
<AMCOMPUTER ACTIVITY="suspend" WAKEDELAY="number" MEASURE="text (options)" FORCE="YES/NO" />
Description: Suspends the computer with the possibility to wake up at a specified time. Note that this activity is not supported on Windows NT.
Practical Usage
This activity can be used to power saving routines on certain computers or servers that do not need to be on during non-peek periods. It could be placed at the end of a task to reduce or eliminate power consumption when the machine is not doing anything. Furthermore, this activity could set the machine to wake up immediately before the next task runtime (if known).
General Parameters
|
Property |
Type |
Required |
Default |
Markup |
Description |
|---|---|---|---|---|---|
|
Wake Delay |
Number |
No |
0 |
WAKEDELAY="5" |
If enabled, specifies the amount of time that should elapse after the system goes into suspend or hibernate, before the system should automatically resume normal operation. |
|
Wake Measure |
Text (options) |
No |
Minutes |
MEASURE="hours"" |
Specifies the wake measure. The available options are:
|
|
Wake Time |
Number |
No |
current time |
WAKETIME="120002" |
Denotes that the machine should wake at the time specified rather than after a certain delay. |
|
Ignore step if specified time has passed |
Yes/No |
No |
No |
IGNOREWHENLATE="YES" |
If set to YES, the step will be ignored if the time specified in the Wake Time parameter has already passed. This parameter is set to NO by default. |
|
Message to display in the shut down dialog box |
Text |
No |
(Empty) |
MESSAGE="Please begin to panic now" |
A user-defined message that windows should display on the restart notification dialog. This parameter is active only if the Prompt user to log off parameter is set to YES. The message will be displayed for the number of seconds, minutes or hours specified in the Shutdown after parameter. NOTE: Due to operating system limitations this parameter is not supported on Windows 95/98/ME systems. |
|
Force the suspend/hibernate (do not send permission request to applications) |
Yes/No |
No |
No |
FORCE="YES" |
If set to YES, specifies that the system should hibernate or suspend immediately without notifying and waiting for applications to return that they are ready to close. |
Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.
Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)
On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)
Example
The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.
Description: Suspend computer. System will wake up after 1 hours.
<AMSUSPEND WAKEDELAY="1" />