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.

Related Topics  

Parameters

General

Property

Type

Description

Interval

Options

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 - Fires off only on the custom dates and times specified. Use this option if there is no regular interval for the task to automatically reschedule on.

  • Holiday(s) - Fires off on the holidays specified. For more details, see Holidays.

Next Launch Date/Time

Date

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 these settings are saved (whether or not Exclusions are entered) and thereafter, . If the Interval parameter is set to Holidays, clicking Now will       

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

Exclude

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

Type

Description

Do not trigger task

Options

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 check-box 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 check-box 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 check-box to allow entry of a time expression.

End Date

Property

Type

Description

End Date

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

Property

Type

Description

When the task is late

Options

Specifies what AutoMate should do when a task is late (usually due to the computer 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

Options

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

Additional Notes

AMTrigger

When the Schedule event is used to trigger workflow execution, it automatically creates an AMTrigger dataset which can be used much like the datasets created by the SQL Query and E-Mail actions. The fields that AMTrigger generates can be used to determine properties of the object that caused the workflow to launch, such as the type of trigger, when the trigger was activated and what system event or condition took place to activate the trigger. Along with a collection of global AMTrigger fields that are created and populated by every instance of AMTrigger, a unique set of AMTrigger fields exclusive to each AutoMate trigger are created as well.

To view AMTrigger values exclusive to the Schedule event, see AMTrigger - Schedule.

AMCondition

When the Schedule event is used in the middle of a workflow as wait or conditional object, it automatically creates an AMCondition dataset. Similar to AMTrigger, the fields that AMCondition generates can be used to determine properties of the object that caused the condition to activate. Along with a collection of global AMCondition fields that are created and populated by every instance of AMCondition, a unique set of AMCondition fields exclusive to each AutoMate condition are created as well.

To view AMCondition values exclusive to the Schedule event, see AMCondition - Schedule.

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