Table of Contents

Class FileTrigger

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

Trigger based on presence, absence, or state of files

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

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.

ExcludeFiles

List of file names or patterns to exclude from triggering

public StringList ExcludeFiles { get; }

Property Value

StringList

Remarks

Files that match this list are ignored by trigger processing

FileServiceProvider

The provider to use when monitoring files on a remote service

public FileServiceProvider FileServiceProvider { get; set; }

Property Value

FileServiceProvider

Remarks

For files located on the adTempus server (or on a file share accessible from the server) no FileServiceProvider is needed.

Files

Collection of FileCaptureSpec objects defining the files to watch for

public FileCaptureSpecCollection Files { get; }

Property Value

FileCaptureSpecCollection

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.

PollingInterval

The interval at which to poll for file changes.

public TimeSpan PollingInterval { get; set; }

Property Value

TimeSpan

Remarks

Specify System.TimeSpan.Zero to use the default polling interval. The minimum interval is 5 seconds but intervals below 30 seconds may cause performance issues.

TriggerDelay

Waits for the specified time to elapse after the file was last modified before triggering the job

public TimeSpan TriggerDelay { get; set; }

Property Value

TimeSpan

TriggerOptions

Options controlling trigger behavior

public FileTriggerOptions TriggerOptions { get; set; }

Property Value

FileTriggerOptions

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