Table of Contents

Class NotificationTask

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

A Task that sends notification messages

public sealed class NotificationTask : Task
Inheritance
object
NotificationTask

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

AdditionalRecipients

Additional recipients to receive the message.

public EmailRecipientList AdditionalRecipients { get; }

Property Value

EmailRecipientList

Remarks

AdditionalRecipients allows the message to be sent to ad-hoc recipients not defined as Notification Recipients in adTempus.

The list can also include one or more items with the Address set to a job variable token (e.g., "%RecipientList%"), which is expanded when the notification message is created. See the Remarks under Address for more information.

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.

BodyFormat

The format of the NotificationMessage

public TextType BodyFormat { get; set; }

Property Value

TextType

Remarks

See Remarks under NotificationMessage. Only PlainText and HTML text types are supported for notification messages.

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 notification message

public string NotificationMessage { get; set; }

Property Value

string

Remarks

Unlike with a NotificationAction, adTempus will not generate a default value if this is omitted.

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 HTML or plain text based on the setting of BodyFormat.

NotificationSubject

The subject of the notification message

public string NotificationSubject { get; set; }

Property Value

string

Remarks

Unlike with a NotificationAction, adTempus will not generate a default value if this is omitted.

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.

SupportedResponseEvents

Gets a list of the events that are supported for Responses associated with this task.

public override ReadOnlyCollection<SupportedResponseEvent> SupportedResponseEvents { get; }

Property Value

ReadOnlyCollection<SupportedResponseEvent>

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