Schedule Event

Description

Launches a task/workflow at the date, time or interval specified. This event can be used for scheduling tasks to run at night or at the end of every work-day, week, month or other time frame. In addition, a custom schedule can be created to allow task execution only on the custom dates and times specified.

Practical Usage

The Schedule 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 Properties

Property

Description

Interval

The time interval on which the schedule will be based. For example, if the workflow should run every day, select daily. If the workflow should run every month, select specific days of the month. The entries that appear depend on which interval is selected. The available options are:

  • daily - Fires off once every X number of days (except dates/times matching exclusions entered in the Exclude properties).

  • hours - Fires off once every X number of hours (except dates/times matching exclusions entered in the Exclude properties).

  • minutes - Fires off once every X number of minutes (except dates/times matching exclusions entered in the Exclude properties).

  • seconds - Fires off once every X number of seconds (except dates/times matching exclusions entered in the Exclude properties).

  • specific days of the week - Fires off once every X number of weeks on the days specified (except dates/times matching exclusions entered in the Exclude properties).

  • specific days of the month - Fires off once every X number of months on the days specified (except dates/times matching exclusions entered in the Exclude properties).

  • custom schedule - The task will run only on the custom dates and times specified. Use this option if there is no regular interval for the task to automatically reschedule on.

Next Launch Date/Time

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 (whether or not Exclusions are entered).

NOTE: This parameter is not present if Custom Date is selected as the interval.

Exclude Properties

To set an exclusion, click the Add button and select the type of exclusion. To edit an existing exclusion, select it from the list and click Edit. To delete an exclusion, click Delete.

Property

Description

Do not trigger task

Specifies the time interval to exclude. The entries that appear below the Do not trigger task option changes depending on which interval is selected. The available options are:

  • On specific days - The task will not run on the days specified. Enable the Expression checkbox to allow entry of a date expression. Press the Today button to exclude the present day. Enter the desired time range in the From and To parameters.

  • On specific days of the week - The task will not run on the days of the week specified. Add a check to the day(s) of the week you wish to omit. Enter the desired time range you wish to omit in the From and To parameters. Enable the Expression checkbox to allow entry of a time expression.

  • On specific days of the month - The task will not run on the days of the month specified. Selecting this option allows more specific options to be selected. Enter the desired time range you wish to omit in the From and To parameters. Enable the Expression checkbox to allow entry of a time expression.

End Date Properties

Property

Description

End Date

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

Rescheduling Properties

Property

Description

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:

  • Immediately run the workflow - If enabled, the trigger will fire immediately when the system is available (enabled by default).

  • Ignore and Reschedule - If enabled, the trigger will not fire when the system is available and reschedule itself relative to the option selected under the Reschedule the task parameter set below (disabled by default).

  • Disable the trigger - If enabled, the trigger will disable itself instead of running late and not fire at all (disabled by default).

Reschedule the task

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

 

  • Relative to originally set time - Relative to the original schedule that the trigger was set to fire (enabled by default). For example, a task is scheduled to execute once a day at 11:00 PM. For some reason, the task is late and executes at 1:12 AM instead. This option implies that the task will reschedule itself to run at 11:00 PM the following evening (disabled by default).   

  • Relative to the time the task was launched - Relative to the time the trigger was fired. Using the example above, this option specifies that the task will reschedule itself to execute again at 2:12 AM the following evening.  

  • Disable the trigger - The trigger will disable itself and not fire at all. It must be re-enabled by the user to run as normally scheduled (disabled by default).

AMTrigger

When an AutoMate Event is used to trigger task/workflow execution, a pre-named (or fixed field) dataset called "AMTrigger" is created and populated with a collection of data which is passed onto the associated task. AMTrigger can be used to determine important properties related to the triggered event, such as where (machine name) and when (date/time) the trigger commenced, which AutoMate Event or Condition was responsible for the triggered event and which task started as a result.

Exclusive AMTrigger Parameters

A unique set of AMTrigger values exclusive to each Event/Condition are created and populated along with the collection of common values created by every instance of AMTrigger. The AMTrigger values described in the table below are exclusive only to a Schedule Event.

Name

Type

Return Value

AMTrigger.TaskLate

Boolean

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

Exclusive AMCondition Parameters

There are no AMCondition parameters for this event.

 

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 | Condition Behavior | Event Log Condition | File Condition | Idle Condition | Key Event | Logon Condition | Performance Condition | Process Condition | SNMP Trap Condition | Window Condition | WMI Condition