Schedule Event

See Also

Setting a Schedule Event, About Conditions, All Available Conditions, Using AMTrigger, Using AMCondition

Description

Launches the task at the date, time or interval specified.

Practical Usage

The Schedule Watcher event is the most commonly used event. It can be used for scheduling tasks to run at night or at the end of every day, week, month or other time frame -- such as running reports, database backups and other routine work.

Parameters

General Tab

Interval

Specifies the time interval on which the schedule will be based. For example, if the task should run every day, select daily. If the task should run every month, select monthly.

NOTE: The entries that appear below the Interval option changes depending on which interval is selected.

The available options are:

 

Next Launch Date/Time

Specifies the date/time the trigger will initially launch. It also determines the relative launch date/time of tasks that are set to run upon a specific interval. To use the current date and time, click Now. This will cause the task to trigger as soon as it is saved.

 

NOTE: The Next Launch Date/Time option boxes are not present if Custom Date is selected as the interval.

Exclude Tab

The Exclude tab provides an option to select specific days, certain days of the week or month or specific time intervals in which to exclude from the current schedule. To set an exclusion, click the Add button and select the type of exclusion under the Do not trigger task parameter.

Do not trigger task

Specifies the time interval to exclude.

NOTE: The entries that appear below the Do not trigger task option changes depending on which interval is selected.

The available options are:

End Date Tab

End Date

If enabled, causes the trigger to disable itself once the selected date and time occurs. To immediately end trigger activity, click Now.

Rescheduling Tab

 

When the task is late

 Specifies what AutoMate should do when a task is late (usually due to the machine being turned off or the AutoMate service being stopped). The available options are:

 

 

Reschedule the trigger

Specifies rescheduling options to select from. The available options are:

 

AMTrigger Parameters

When this trigger is activated, 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 AMSCHEDULETRIGGER.

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.

 

Specific AMTrigger Fields

The AMTrigger fields listed in the table below are specific only to the Schedule trigger.

Name

Data Type

Return Value

AMTrigger.TaskLate

Boolean

Specifies to the task whether the schedule trigger launched past it's next launch date time. This can occur if the computer was off or the AutoMate Task Service was not running or was disabled when the task was scheduled to run. If the task was late, the value returned is 1. Otherwise, it will be 0.

 

 

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:

Name

Data Type

Return Value

AMCondition.ProcessID

Number

Returns the value of the parameter that caused the condition to activate. This is dependent on the condition properties. For example, if the condition is set to watch for total memory to drop below a certain threshold, this value will contain the total amount of memory below that threshold.

AMCondition.ProcessID

Number

Specifies the Process ID that caused the condition to activate. This is dependent on if the condition is monitoring for a specific process threshold. A process ID is a number automatically assigned to a process by Windows. The process ID can be used by other actions in AutoMate to specify an instance of an application.

AMCondition.ThreadID

 

Number

Specifies the Thread ID that caused the condition to activate. This is dependent on the condition properties.

 

Exclusive AMCondition Fields

The AMCondition fields described in the table below are specific only to the Schedule condition.

 

Name

Data Type

Return Value

AMCondition.TaskLate

 

Boolean

Specifies to the task whether the schedule event launched past it's next launch date time. This can occur if the computer was off or the AutoMate Task Service was not running or was disabled when the task was scheduled to run.

 

 

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