Table of Contents

Class AlertNotificationRule

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

Defines a rule for sending notification messages in response to Alerts.

[ComVisible(true)]
[Guid("F6F4F161-A05E-44FE-9943-76D71C4C47B8")]
public sealed class AlertNotificationRule : ADTIndependentObject
Inheritance
object
AlertNotificationRule

Properties

BodyFormat

The format of the NotificationMessage

public TextType BodyFormat { get; set; }

Property Value

TextType

Remarks

Currently only HTML is supported.

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.

Enabled

Indicates whether this rule is enabled.

public bool Enabled { get; set; }

Property Value

bool

ExcludeCategories

List of event categories to exclude.

public List<int> ExcludeCategories { get; }

Property Value

List<int>

ExcludeMessageIDs

List of message IDs to exclude.

public List<int> ExcludeMessageIDs { get; }

Property Value

List<int>

ExcludeMessageText

List of text that must appear in message to exclude rule.

public List<string> ExcludeMessageText { get; }

Property Value

List<string>

IncludeCategories

List of event categories to include.

public List<int> IncludeCategories { get; }

Property Value

List<int>

Remarks

If no IncludeCategories are specified, all categories are included except those specified in ExcludeCategories. If any IncludeCategories are specified, only the specified categories are included.

IncludeMessageIDs

List of message IDs to include.

public List<int> IncludeMessageIDs { get; }

Property Value

List<int>

Remarks

If no message IDs are specified, all message IDs are included except those specified in ExcludeMessageIDs. If any IncludeMessageIDs are specified, only the specified message IDs are included.

IncludeMessageText

List of text that must appear in message to trigger rule.

public List<string> IncludeMessageText { get; }

Property Value

List<string>

IncludeMessageTypes

List of message types (severities) to include.

public List<MessageType> IncludeMessageTypes { get; }

Property Value

List<MessageType>

Remarks

If no IncludeMessageTypes are specified, all types are included.

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.

MinimumInterval

The minimum interval for messages to be sent for this rule.

public TimeSpan MinimumInterval { get; set; }

Property Value

TimeSpan

Remarks

Fractional minutes are rounded up.

Name

Optional name for this rule.

public string Name { get; set; }

Property Value

string

NotificationMessage

The body of the notification message to send.

public string NotificationMessage { get; set; }

Property Value

string

Remarks

Leave empty for default message.

NotificationSeverity

The severity of the notification message to send.

public int NotificationSeverity { get; set; }

Property Value

int

NotificationSubject

The subject of the notification message to send.

public string NotificationSubject { get; set; }

Property Value

string

Remarks

Leave empty for default subject.

Recipients

The list of NotificationRecipients who will receive messages for Alerts that match this rule.

public NotificationRecipientCollection Recipients { get; }

Property Value

NotificationRecipientCollection

UseRegularExpressions

Indicates whether to treat IncludeMessageText and ExcludeMessageText as regular expressions.

public bool UseRegularExpressions { get; set; }

Property Value

bool

Methods

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.

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