Idle Trigger
Description
Triggers a task when the system has been idle due to absence of user interaction (for example, no mouse or keyboard input) within the specified time period.
Practical usage
Occasionally, tasks are better run when the computer is not in use. The Idle trigger can be configured for such a scenario.
Parameters
General
Property | Type | Description |
---|---|---|
Idle period | Number | Combined with the Measurement parameter below, specifies the total time period to delay after the system becomes idle before activating the trigger. |
Measurement | Text (options) | The
time unit in which the idle period should be measured. The available
options are:
|
Behavior
Property | Type | Description |
---|---|---|
Enable trigger | Yes/No | If selected, the trigger will immediately be active upon creation. If disabled, the trigger will stay inactive until it is manually enabled. This parameter is selected by default. |
Trigger after the condition has been met 'X' times. | Yes/No | If enabled, specifies how many times the trigger condition must be met before the task is started. For example, if a Window trigger is set to monitor for the appearance of a Notepad window and this parameter is set to 3, the task will not launch until the third instance of Notepad appears on the desktop. |
Additional notes
AMTrigger
When this trigger is activated, it automatically passes the AMTrigger object to the task. AMTrigger is a standard Automate Desktop dataset and can be used much like the datasets created by the Database - SQL query activity and Email action. The fields of AMTrigger can be used within a task to determine specific values, such as whether or not the task was started by a trigger, which trigger started the task, when the trigger was activated and other properties. AMTrigger populates a unique set of field–value pairs for each Automate Desktop trigger. The following table lists the ones specific to this trigger. For more details about a specific AMTrigger field–value pair, click the associated link.
Name | Data Type | Return Value |
---|---|---|
AMTrigger.IdleDuration | Number | Returns the total idle duration time in the following format: HH:MM:SS:MS |
AMTrigger.IdleSince | Date/Time | Returns the date/time the system initially became idle. The date/time is returned in the following format: MM/DD/YYYY HH:MM:SS |