Table of Contents

Class NotificationAction

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

Response action that sends a notification message

public sealed class NotificationAction : ResponseAction
Inheritance
object
NotificationAction

Properties

AdditionalHeaders

Optional additional headers to be added to SMTP notification messages.

public string AdditionalHeaders { get; set; }

Property Value

string

Remarks

Specify headers in RFC822 format, with newlines between headers: header-name-1: value 1 header-name-2: value 2

Attachments

Specifies additional files to be attached to the message

public FileCaptureSpecCollection Attachments { get; }

Property Value

FileCaptureSpecCollection

Remarks

If Options contains CaptureAttachments the files are also saved as Captured Files in the job history (as if they had been captured by a FileCaptureAction. If this option is not set, the files are not saved in the history.

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.

FromAddress

Optional override of the default return address for notification messages.

public string FromAddress { get; set; }

Property Value

string

Remarks

If omitted, the name is taken from the SenderNamesee> of the used to send the message.

If specified, the address must be a valid address for the service type being used. For email notifications, most servers will validate that it is a valid address for the account being used to send the message.

FromName

Optional override of the default sender name for notification messages.

public string FromName { get; set; }

Property Value

string

Remarks

If omitted, the name is taken from the SenderNamesee> of the used to send the message.

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.

MessageAddressMode

Specifies how multiple recipients are treated for email messages

public MessageAddressMode MessageAddressMode { get; set; }

Property Value

MessageAddressMode

NotificationMessage

The body of the message to send

public string NotificationMessage { get; set; }

Property Value

string

Remarks

If omitted, a default body is generated based on the context.

For email notifications, if the NotificationMessage begins with "<html", the content is treated as HTML and the email message is created as an HTML-formatted message. Otherwise the body is treated as plain text.

NotificationSubject

The subject of the message to send

public string NotificationSubject { get; set; }

Property Value

string

Remarks

If omitted, a default subject is generated based on the context.

Options

Additional options that affect the behavior of the notification operation

public NotificationTaskOptions Options { get; set; }

Property Value

NotificationTaskOptions

Recipients

The recipients to send the message to

public NotificationRecipientCollection Recipients { get; }

Property Value

NotificationRecipientCollection

SendConsoleOutput

Determines whether captured Console output is attached to the notification message

public bool SendConsoleOutput { get; set; }

Property Value

bool

Severity

The severity of the notification

public int Severity { get; set; }

Property Value

int

Remarks

The default severity for new objects is 5.

The Severity is used to determine which recipients receive notification messages when severity thresholds are defined for recipients.

Methods

GetActionDescription() 

protected override string GetActionDescription()

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