Table of Contents

Class ScheduleTrigger

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll

Trigger that executes a job on a date/time-based schedule

public sealed class ScheduleTrigger : Trigger, ISupportJobVariables
Inheritance
object
ScheduleTrigger
Implements

Remarks

A ScheduleTrigger has one or more Schedules that define the days/times when the job should execute. The trigger executes the job once for each unique date/time that matches one of the Schedules (if the job has multiple Schedules that select the same date/time, the job is not executed more than once for that date/time).

The ScheduleTrigger may also define a HolidayTreatment rule and Holidays to define days when the job does not execute. The holiday settings override the date rules defined by the Schedules.

Properties

ClassID

The Class ID for the object

[IgnoreDataMember]
public override ClassID ClassID { get; }

Property Value

ClassID

ClassKeyName

The key name for the class.

public override string ClassKeyName { get; }

Property Value

string

Remarks

This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.

ClockChangeBehavior

Determines what should happen if the clock is changed on the adTempus server so that a scheduled execution time is missed or repeated

public ClockChangeBehavior ClockChangeBehavior { get; set; }

Property Value

ClockChangeBehavior

HolidayTreatment

Determines how the job should behave when a scheduled execution falls on a day defined as a holiday

public HolidayTreatment HolidayTreatment { get; set; }

Property Value

HolidayTreatment

Holidays

A SharedSchedule defining days on which the job should not execute

public SharedSchedule Holidays { get; set; }

Property Value

SharedSchedule

Remarks

Any day that matches the rules defined for this SharedSchedule is handled according to the HolidayTreatment setting.

IsDependent

Indicates whether the object is a dependent of (owned by) another object

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

Remarks

An independent object (IsDependent is false) is an object that can exist on its own without being part of another object. For example, Jobs, Job Groups, etc.

A dependent object (IsDependent is true) is a part of another object. For example, a JobStep cannot exist independently of a Job, so the JobStep is dependent.

Dependent objects cannot be directly fetched from the server: they are only fetched as part of the object they belong to. They also cannot be saved or deleted independently: they are automatically saved or deleted when the owning object is saved or deleted.

ObserveDST

Specifies whether the trigger should observe Daylight Saving Time (DST)

public bool ObserveDST { get; set; }

Property Value

bool

Remarks

If true (the default) the schedule is adjusted to reflect Daylight Saving Time. If false the schedule ignores Daylight Saving Time.

This setting has no effect if TimeZoneRule is SpecifiedTimeZone and ArcanaDevelopment.adTempus.Client.ScheduleTrigger.TimeZoneOffset is set. It is still considered when TimeZoneID is set.

Schedules

Collection of Schedules defining the dates/times when the job should run.

public ScheduleCollection Schedules { get; }

Property Value

ScheduleCollection

Remarks

The trigger executes the job for each unique date/time defined by any of the Schedules. See the general Remarks for ScheduleTrigger for more information.

TimeZoneID

The time zone to use when TimeZoneRule is SpecifiedTimeZone

public string TimeZoneID { get; set; }

Property Value

string

Remarks

Use System.TimeZoneInfo.GetSystemTimeZones() to get a list of time zones defined in Windows. The TimeZoneID should be set to System.TimeZoneInfo.StandardName.

TimeZoneRule

Specifies the time zone that should be used to evaluate the dates and times defined in the Schedules

public TimeZoneRule TimeZoneRule { get; set; }

Property Value

TimeZoneRule

Remarks

If TimeZoneRule is SpecifiedTimeZone use the ArcanaDevelopment.adTempus.Client.ScheduleTrigger.TimeZoneOffset to specify the time zone to observe.

See Also
TimeZoneOffset

Methods

GetTriggerDescription() 

protected override string GetTriggerDescription()

Returns

string

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

Writes the object and any contained objects to a configuration report

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

The report builder to write the object to.

Inherited Members