Logon Condition

See Also

 About Conditions, All Available Conditions, Using AMTrigger, Using AMCondition

Description

Launches a workflow when a user logs onto the assigned Agent system. The workflow starts when AutoMate detects the desktop of the Agent machine.

Practical Usage

Starts tasks that should run when the user logs on.

Parameters

General

Logon Type

Specifies which user log on events should be monitored by this condition.

The available options are:

Any user logon: If enabled, the workflow will run when any user logs on (default).

Specific user logon: If enabled, the workflow will run when any of the specified users log on.

NOTE: Multiple users may be specified by delimiting entries with a semi-colon (i.e. User1;User2;User3).

Behavior

AMTrigger Parameters

When this condition is used as a trigger, it automatically passes the "AMTrigger" object to the task. AMTrigger can be used within a task to determine whether or not the task was started by a trigger, which trigger started the task, when the trigger was activated and other trigger related properties. For more details, see Using AMTrigger.

 

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 AMWINDOWTRIGGER.

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.

 

AMTrigger-Specific Parameters

Parameters available only in this condition.

AMTrigger.UserName

Text

Returns the username of the user who logged on when the task was triggered.

 

AMCondition Return Value

When this condition is activated during the path of a workflow, it automatically passes the AMCondition object to the task.

The following properties are populated:

AMCondition.UserName

Text

Returns the username of the currently logged on user when the condition was activated.