/
Time Trigger

Time Trigger

Overview

The Time trigger, similar to the Cron trigger, allows you to specify dates and times at which a task will be triggered.

With both Time and Cron triggers, you can define:

  • Simple date and times, such as "every weekday at 12:00 a.m."
  • Specific dates and times, such as "March 15 at 12:00 a.m."
  • A series of dates and times, such as "every Friday at every hour."
  • A mixture of specific dates/times and a series, such as "every Monday at 9 a.m."
  • Complex dates and times, such as "every 3 hours between 8 a.m. and 5 p.m. on the last business day of the year."

(Read Daylight Saving Time for details about how Universal Controller handles Daylight Saving Time.)

If you want to schedule time intervals for triggering a task on multiple days, use the trigger type (Time or a Cron) that allows you to most accurately select the scheduling parameters (see Scheduling a Time Interval, below).

Creating a Time Trigger

Step 1

From the Automation Center navigation pane, select Triggers > Time Triggers. The Time Triggers list displays.
 
Below the list, Time Trigger Details for a new Time trigger displays.
 

Step 2

Enter/select Details for a new Time trigger, using the field descriptions below as a guide.

  • Required fields display an asterisk ( * ) after the field name.
  • Default values for fields, if available, display automatically.

To display more of the Details fields on the screen, you can either:

  • Use the scroll bar.
  • Temporarily hide the list above the Details.
  • Click the New button above the list to display a pop-up version of the Details.

Step 3

Clicka Save button. The trigger is added to the database, and all buttons and tabs in the Trigger Details are enabled.

Step 4

Enable the trigger(s) as desired.

Note

To open an existing record on the list, either:

  • Click a record in the list to display its record Details below the list. (To clear record Details below the list, click the New button that displays above and below the Details.)
  • Clicking the Details icon next to a record name in the list, or right-click a record in the list and then click Open in the Action menu that displays, to display a pop-up version of the record Details.
  • Right-click a record in the a list, or open a record and right-click in the record Details, and then click Open In Tab in the Action menu that displays, to display the record Details under a new tab on the record list page (see Record Details as Tabs).

Time Trigger Details

The following Time Trigger Details is for an existing Time trigger. See the field descriptions below for a description of the fields that display in the Time Trigger Details.
 

Time Trigger Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in the Time Trigger Details.
 

Field Name

Description

General

This section contains general information about the trigger.

Name


Name used within the Controller to identify this trigger. It can contain a maximum of 255 alphanumerics. It is the responsibility of the user to develop a workable naming scheme for triggers.

Version

System-supplied; version number of the current record, which is incremented by the system every time a user updates a record. Click the Versions tab to view previous versions. For details, see Record Versioning.

Description

Description of this record. Maximum length is 255 characters.

Member of Business Services

User-defined; Allows you to select one or more Business Services that this record belongs to.  (You also can Check All or Uncheck All Business Services for this record.)

You can select up to 62 Business Services for any record type, and enter a maximum of 2048 characters for each Business Service.

If the Business Service Visibility Restricted Universal Controller system property is set to true, depending on your assigned (or inherited) Permissions or Roles, Business Services available for selection may be restricted.

Calendar


Calendar that defines the business days, holidays, and other special days that determine the run dates for the task(s) specified in the trigger.

Select a Calendar from the drop-down list of all existing Calendars. To display detailed information about a selected calendar, click the Details icon next to the Calendar field.


Time Zone

User-defined; allows you to specify the time zone that will be applied to the time(s) specified in the trigger. For example, if you specify 23:00 and a time zone of Canada/Central, the task will run at 11:00 p.m. Central Canada time.

Task(s)

Name of the task(s) being triggered when this trigger is satisfied. When selecting tasks from the Details, click on the lock icon to unlock the field and select tasks.

Purge By Retention Duration


Specification for whether triggered task instances can be purged by retention duration.

Exclude Backup

If Purge By Retention Duration is selected; Specification for whether qualifying task instances can be excluded from the backup when being purged by retention duration.

Retention Duration

If Purge By Retention Duration is selected; Minimum retention duration for the selected Retention Duration Unit before triggered task instances can qualify for purge.

If Retention Duration Unit = Days, valid values are 1 to 366.

If Retention Duration Unit = Hours, valid values are 1 to 24.

Retention Duration Unit

If Purge By Retention Duration is selected; Retention duration unit.
 
Options:

  • Hours
  • Days

Execution User


Read-only; Execution user that has been selected (via the Assign Execution User action) to override the execution user of task instances being launched by the trigger.

Forecast


If checked, the Controller calculates the date and time when this trigger will be satisfied for the next number of days, as specified in the Forecast Period In Days Universal Controller system property.

The Controller writes the forecasting entries to the Forecasts List.
 

Note

If this field is checked on a trigger and the trigger is promoted, it will not be checked for that trigger on the target system.


Simulate

Enables the override of the Enable Trigger Simulation Universal Controller system property specification for whether or not to simulate the launching of tasks when triggers are eligible to fire. (If simulation is enabled, only the scheduled launch of the task by the trigger is inhibited.)
 
Options:

  • -- System Default -- - Use the system default for enabling / disabling trigger simulation as specified by Enable Trigger Simulation.
  • True - Enable trigger simulation
  • False - Disable trigger simulation.

Status

This section contains information about the current status of the trigger.

Status

System-defined; Specification for whether the trigger is Enabled or Disabled. The user enables and disables the trigger by clicking the Enable / Disable buttons. Only enabled triggers are processed by the Controller.

Next Scheduled Time

System-supplied; for time-based triggers. If Status = Enabled, the next date and time this trigger will be satisfied. See Displaying Trigger Forecast Information.

Enabled By

System-supplied. If Status = Enabled, ID of the user who most recently enabled this trigger.

Disabled By

System-supplied; If Status = Disabled, ID of the user who most recently disabled this trigger. (By default, all new triggers are disabled.)

Enabled Time

System-supplied. If Status = Enabled, Date and time that the trigger was enabled.

Disabled Time

System-supplied. If Status = Disabled, Date and time that the trigger was disabled.

Skip DetailsThis section contains detailed information about skipping the trigger.

Task Launch Skip Condition

User-defined; Controls when launching a task for the trigger will be skipped.

Default is the value of the Trigger Task Launch Skip Condition Default Universal Controller system property.

Options:

  • -- None --
    Do not skip the task launch.
  • Active
    Skip the task launch if a previous instance is still active.
  • Active By Trigger
    Skip the task launch if a previous instance launched by the trigger is still active.

Task Launch Skip Condition is not applicable when using the Trigger Now... command and will be ignored.

Skip Restriction

User-defined; Specification for when this trigger should skip and not launch the task(s).

Options:

  • - - None - -
    No skip restrictions
  • Before
    Trigger will skip if the current date and time is before the specified Skip Before Date and Skip Before Time values.
  • After
    Trigger will skip if the current date and time is after the specified Skip After Date and Skip After Time values.
  • Span
    Trigger will skip if the date and time qualifies based upon the specified Skip After DateSkip After Time, Skip Before Date, and Skip After Date values.

    Note

    If Skip After Date and Skip After Time are prior to the Skip Before Date and Skip Before Time, the Span is a "between" period. In this case, if the triggered time is after the Skip After Date and Skip After Time as well as before the Skip Before Date and Skip Before Time, the Trigger will skip and not launch the configured Task(s).

    If the Skip Before Date and Skip Before Time are prior to the Skip After Date and Skip After Time, the Span is a "not between" period. In this case, if the triggered time is either after the Skip After Date and Skip After Time or before the Skip Before Date and Skip Before Time, then the trigger will skip and not launch the configured Task(s).

  • On
    Trigger will skip on any of the dates specified in the Skip Date LIst.

Default is - - None - -.

Skip Count

User-defined; Allows you to specify that the Controller should skip the next N times this task is triggered.
 
Skip Count is not applicable when using the Trigger Now... command and will be ignored.

Skip Before Date

If Skip Restriction is Before or Span; Date before which the Trigger will skip.

Skip Before Time

If Skip Restriction is Before or Span; Time before which the Trigger will skip on the specified Skip Before Date.

Skip After Date

If Skip Restriction is After or Span; Date after which the Trigger will Skip.

Skip After Time

If Skip Restriction is After or Span; Time after which the Trigger will skip on the specified Skip After Date.

Skip Date List

If Skip Restriction is On;  List of dates on which the trigger will skip.

Time Details

This section contains assorted detailed information about the trigger.

Time Style

Specifies whether this trigger is for a specific time or a series of times.

Options:

Time

Required if Time Style = Time; time of the trigger in hours and minutes, using 24-hour time. For example, 01:45 means trigger the task at 1:45 a.m.; 13:45 means trigger the task at 1:45 p.m. (See also Daylight Saving Time.)

Time Interval

Required if Time Style = Time Interval; number of Time Interval Units. For example, for a Time Interval of every three hours, specify 3 in this field and select Hours in the Time Interval Units field.

Note

See Scheduling a Time Interval, below, for information on using a Time Trigger to schedule a time interval for triggering a task.
 
Also see Time Trigger Minimum Frequency In Seconds Universal Controller system property to the define the minimum time interval that must be used.

Time Interval Units

Required if Time Style = Time Interval; Type of time interval. Used in conjunction with the Time Interval field. For example, for a Time Interval of every three hours, specify 3 in the Time Interval field and select Hours in this field.

Options:

  • Seconds
  • Minutes
  • Hours

Enable Offset

If Time Style = Time Interval, allows you to define (in the Initial Time Offset field) a starting time, in minutes offset from the hour, for the trigger to run.

Initial Time Offset (hh:mm)

If Enable Offset is selected, allows you to define a starting time, in minutes offset from the hour.

The default value ( * ) lets you select a starting hour (0 to 23) other than the next hour.

For example:

Day Details

This section contains assorted detailed information about the trigger day.

Day Style

Allows you to indicate when this trigger will be run:

Options: