Table of Contents

Class FileCaptureAction

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

Action that captures files and saves them to the job history

public sealed class FileCaptureAction : ResponseAction
Inheritance
object
FileCaptureAction

Properties

AdditionalHeaders

Optional additional headers to be added to SMTP notification messages, if OutputCaptureOptions contains Send

[CanBeNull]
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

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.

FilesToCapture

List of rules specifying the files to capture

[NotNull]
[ItemNotNull]
public FileCaptureSpecCollection FilesToCapture { get; }

Property Value

FileCaptureSpecCollection

FromAddress

Optional override of the default return address for notification messages, if OutputCaptureOptions contains Send

[CanBeNull]
public string FromAddress { get; set; }

Property Value

string

FromName

Optional override of the default sender name for notification messages, if OutputCaptureOptions contains Send

[CanBeNull]
public string FromName { get; set; }

Property Value

string

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

Address mode to use for notification messages, if OutputCaptureOptions contains Send

public MessageAddressMode MessageAddressMode { get; set; }

Property Value

MessageAddressMode

NotificationMessage

The body used for email messages if OutputCaptureOptions contains Send

[CanBeNull]
public string NotificationMessage { get; set; }

Property Value

string

Remarks

Set to null or empty string to use a system-generated default subject

NotificationSubject

The subject used for email messages if OutputCaptureOptions contains Send

[CanBeNull]
public string NotificationSubject { get; set; }

Property Value

string

Remarks

Set to null or empty string to use a system-generated default subject

Options

Options controlling the capture operation

public OutputCaptureOptions Options { get; set; }

Property Value

OutputCaptureOptions

Recipients

Recipients to send the captured files to, if OutputCaptureOptions contains Send

[NotNull]
[ItemNotNull]
public NotificationRecipientCollection Recipients { get; }

Property Value

NotificationRecipientCollection

SendConsoleOutput

Determines whether captured console output should also be included when emailing captured files, if OutputCaptureOptions contains Send

public bool SendConsoleOutput { get; set; }

Property Value

bool

Severity

The message severity for the notification message if OutputCaptureOptions contains Send

public int Severity { get; set; }

Property Value

int

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