Table of Contents

Class EventLogMonitor

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

A trigger that monitors the Windows Event Log and fires based on new events

[ComVisible(true)]
[Guid("8799b5ff-dbd9-4b72-afd0-8dd03d40c90d")]
public sealed class EventLogMonitor : Trigger, ISupportJobVariables
Inheritance
object
EventLogMonitor
Implements

Remarks

GetEventLogs() can be used to retrieve information about the available event logs on the adTempus server.

Properties

Category

The category of events to trigger for

public int Category { get; set; }

Property Value

int

Remarks

Set to 0 for all categories. Otherwise set to a valid category for the specified Sources

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.

EventTypes

The type(s) of events to trigger for

public int EventTypes { get; set; }

Property Value

int

Remarks

Set to 0 for all event types. Otherwise set to any combination of the System.Diagnostics.EventLogEntryType values

ExcludeEvents

Comma-separated list of event IDs to ignore

public string ExcludeEvents { get; set; }

Property Value

string

Remarks

Set to null or an empty string to ignore the event ID when filtering. Otherwise set to a comma-separated list of the event(s) to ignore. Event IDs are specific to the Sources being monitored

IncludeEvents

Comma-separated list of event IDs to trigger for

public string IncludeEvents { get; set; }

Property Value

string

Remarks

Set to null or an empty string to ignore the event ID when filtering. Otherwise set to a comma-separated list of the event(s) to trigger for. Event IDs are specific to the Sources being monitored

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.

LogName

The name of the log to monitor

public string LogName { get; set; }

Property Value

string

Remarks

Specifies which event log this monitor will read. You must specify a valid log name on the adTempus server.

GetEventLogs() can be used to retrieve information about the available event logs on the server.

MessageMatches

The trigger should only fire for messages containing the specified string

public string MessageMatches { get; set; }

Property Value

string

Sources

List of event log sources to monitor

public ICollection<string> Sources { get; }

Property Value

ICollection<string>

Remarks

If Sources is empty, the trigger will look at messages from all sources

TriggerOptions

Options controlling trigger behavior

public EventLogMonitorOptions TriggerOptions { get; set; }

Property Value

EventLogMonitorOptions

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