Table of Contents

Class Trigger

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

Base class for Triggers that determine when a job will execute

public abstract class Trigger : ADTObject, ISupportJobVariables
Inheritance
object
Trigger
Implements
Derived

Remarks

A Trigger can only be assigned to a single Job; Triggers cannot be shared.

Properties

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.

DescriptionOverride

Override for the system-generated description of the object

public string DescriptionOverride { get; set; }

Property Value

string

Remarks

This property is for use by user interface extensions

Enabled

Indicates whether the trigger is enabled

public bool Enabled { get; set; }

Property Value

bool

Remarks

Disabled triggers are ignored and do not cause the job to trigger

IgnoreExclusionPeriods

Determines whether this trigger ignores any ExclusionPeriods that otherwise would apply.

[RequiredVersion(5, 0, 0, 0)]
public bool IgnoreExclusionPeriods { get; set; }

Property Value

bool

Remarks

This setting is not currently exposed through the UI.

JobVariables

Additional (or overridden) Job Variables that are passed to the job when it is triggered.

public JobVariableCollection JobVariables { get; }

Property Value

JobVariableCollection

MinimumInterval

The minimum interval between triggers.

public TimeSpan MinimumInterval { get; set; }

Property Value

TimeSpan

Remarks

If this value is set, then the trigger will ignore any events that occur within the specified time after the last time this trigger fired.

Name

Optional Name for the trigger

public string Name { get; set; }

Property Value

string

SelectionScript

Optional Script used to perform additional processing before the job is triggered

public Script SelectionScript { get; set; }

Property Value

Script

UserInterfaceExtensionData

Extension data for the customer user interface for this object

public string UserInterfaceExtensionData { get; set; }

Property Value

string

UserInterfaceExtensionID

Extension ID of the customer user interface for this object

public string UserInterfaceExtensionID { get; set; }

Property Value

string

Methods

FindOwningObject()

Get the owner of this object based on relationships.

protected override ADTObject FindOwningObject()

Returns

ADTObject

The owning object, or null if the object is not owned by another object or the owner has not been set.

GetInheritedVariables(bool)

Gets a collection containing the JobVariables inherited by this object, and optionally the variables for the object itself.

public JobVariableCollection GetInheritedVariables(bool includeSelf)

Parameters

NameTypeDescription
includeSelf bool

If true the returned collection contains both inherited variables and variables defined at this level. If false the results only include inherited variables.

Returns

JobVariableCollection

GetObjectDescription()

Gets a description of the object's key settings.

protected override string GetObjectDescription()

Returns

string

Remarks

This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.

GetTriggerDescription() 

protected abstract 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