Idle Condition

See Also

 Setting an Idle Condition, About Conditions, All Available Conditions, Using AMTrigger

Description

Starts the task when no keyboard or mouse input occurs for the specified period of time (i.e. the system is idle). Can also be used in the middle of a workflow to wait for the system to be idle for the specified time period or determine the path of a workflow depending on the system's idle state.

Practical Usage

Occasionally tasks are better run when the machine is not in use by a real person. The Idle condition allows a task to be configured to run when the system has not been in use.

Parameters

General Tab

Launch task when machine has been idle for:

Specifies the amount of time the system should remain idle before the trigger is activated. Available time values are:

Behavior Tab

All available Conditions contain Behavior properties that dictate how it should handle a monitored event or condition. These properties determine whether the Condition should act as a trigger, a wait object or conditional (or decision making) object. By default, new Conditions are set to wait for the specified event/condition indefinitely, allowing it to act as a trigger object. For more details, see Condition Behavior.

AMTrigger Parameters

When this condition is used as a trigger in the beginning of a workflow, a dataset called AMTrigger is created. This dataset can be used within the task to determine specific characteristics about the object that initially triggered the task.

Common AMTrigger Fields

Every instance of AMTrigger populates a list of common fields which are described in the table below.

Name

Data Type

Return Value

AMTrigger.Trigger

String

Returns the name of the event or condition that triggered the task. Each event or condition contains a unique name. For this trigger, the value is always AMIDLETRIGGER.

AMTrigger.TaskName

String

Returns the name of the managed task that the trigger was attached to. Useful to determine the responsible task when two managed tasks point to the same AML file.

AMTrigger.TriggerredDateTime

String

Returns the date and time when the trigger occurred.

AMTrigger.TriggeredOn

String

Returns the machine name where the trigger occurred.

AMTrigger.WasLocked

Boolean

If the workstation was locked when the trigger occurred, the value returned is 1. Otherwise, it will be 0.

AMTrigger.WasLoggedOff

Boolean

If the workstation was logged off when the trigger occurred, the value returned is 1. Otherwise, it will be 0.

AMTrigger.AML

String

Returns a verbose set of information about the triggered event or condition in AML (AutoMate Markup Language) format.

 

AMCondition Parameters

When this condition is used in the middle of a workflow (as opposed to triggering condition) it automatically passes the AMCondition object to the task.

Common AMCondition Fields

Each condition contains its own set of unique AMCondition values. Therefore, the total number of fields that AMConditon creates during runtime and what they are called depend largely on the condition that was activated. However, every instance of AMCondition is populated with the following general fields:

Name

Data Type

Return Value

AMCondition.Agent

String

Returns the name of the agent where the condition activated.

AMCondition.DateTime

String

Returns the date and time of when the condition occurred.

AMCondition.Name
 

String

Returns the name of the activated condition. Each condition contains a unique name. For example, if the File condition was initiated, the value returned would be . See the help topic for each condition to determine that object's unique name.

AMCondition.Result
 

String

Returns the result of the activated condition (True or False).

AMCondition.WasLocked

Boolean

If the workstation was locked when the condition occurred, the value returned is 1. Otherwise, it will be 0.

AMCondition.WasLoggedOff

Boolean

If the workstation was logged off when the condition occurred, the value returned is 1. Otherwise, it will be 0.

AMCondition.AML

String

Returns verbose data about the activated condition in AutoMate Markup Language (AML) format.

Specific AMCondition Fields

There are no AMCondition specific fields created for the Idle Condition.

 

NOTE: A full list of AMTrigger and AMCondition objects exclusive to each Event/Condition can be viewed from the Expression Builder by expanding the Objects folder and selecting the desired object from either the Triggers or Conditions folder .

See Also

About Events & Conditions

All Available Events & Conditions

Condition_Behavior