Table of Contents

Class SqlJobStep

Namespace
CENTREL.XIA.Configuration.Types
Assembly
CENTREL.XIA.Configuration.Types.dll

Represents a step for a job.

public class SqlJobStep : BaseTypeSection, IComparable<SqlJobStep>
Inheritance
SqlJobStep
Implements

Constructors

SqlJobStep()

Initializes a new instance of the CENTREL.XIA.Configuration.Types.SqlJobStep class.

public SqlJobStep()

Properties

ActiveScriptingLanguage

Gets or sets the active scripting language.

public string ActiveScriptingLanguage { get; set; }

Property Value

string

AppendAllCmdExecOutputToJobHistory

Gets or sets whether to include the step output in the job history.

public BooleanOption AppendAllCmdExecOutputToJobHistory { get; set; }

Property Value

BooleanOption

AppendToLogFile

Gets or sets whether to append to the file.

public BooleanOption AppendToLogFile { get; set; }

Property Value

BooleanOption

AppendToTableLog

Gets or sets whether to append output to an existing entry in the table.

public BooleanOption AppendToTableLog { get; set; }

Property Value

BooleanOption

Command

Gets or sets the command to execute.

public string Command { get; set; }

Property Value

string

CommandExecutionSuccessCode

Gets or sets the command execution success code.

public int CommandExecutionSuccessCode { get; set; }

Property Value

int

DatabaseName

Gets or sets the database name for the step.

public string DatabaseName { get; set; }

Property Value

string

Id

Gets or sets the identifier of the step.

public int Id { get; set; }

Property Value

int

Identifier

Gets or sets the unique identifier for the table. This is for internal use only.

public Guid Identifier { get; set; }

Property Value

Guid

LogToTable

Gets or sets whether to log to a table.

public BooleanOption LogToTable { get; set; }

Property Value

BooleanOption

Name

Gets or sets the name of the step.

public string Name { get; set; }

Property Value

string

OnFailAction

Gets or sets the action to take on failure.

public SqlJobStepCompletionAction OnFailAction { get; set; }

Property Value

SqlJobStepCompletionAction

OnFailActionString

Gets the action to take on failure.

public string OnFailActionString { get; set; }

Property Value

string

OnFailStep

Gets or sets the identifier of the step to go to on failure.

public int OnFailStep { get; set; }

Property Value

int

OnSuccessAction

Gets or sets the action to take on success.

public SqlJobStepCompletionAction OnSuccessAction { get; set; }

Property Value

SqlJobStepCompletionAction

OnSuccessActionString

Gets the action to take on success.

public string OnSuccessActionString { get; set; }

Property Value

string

OnSuccessStep

Gets or sets the identifier of the step to goto on success.

public int OnSuccessStep { get; set; }

Property Value

int

OutputFileName

Gets or sets the output file for the job.

public string OutputFileName { get; set; }

Property Value

string

ProxyName

Gets or sets the name of the proxy account for the step.

public string ProxyName { get; set; }

Property Value

string

RetryAttempts

Gets or sets the number of retry attempts for this step.

public int RetryAttempts { get; set; }

Property Value

int

RetryInterval

Gets or sets the retry interval for this step in minutes.

public int RetryInterval { get; set; }

Property Value

int

RunAsString

Gets the name of the account for the step.

public string RunAsString { get; set; }

Property Value

string

Server

Gets or sets the name of the server for the job step.

public string Server { get; set; }

Property Value

string

SubSystem

Gets or sets the subsystem.

public SqlAgentSubSystem SubSystem { get; set; }

Property Value

SqlAgentSubSystem

SubSystemString

Gets the subsystem.

public string SubSystemString { get; set; }

Property Value

string

Methods

Clone()

Returns a CENTREL.XIA.Configuration.Types.SqlJobStep cloned from this object.

public SqlJobStep Clone()

Returns

SqlJobStep

A CENTREL.XIA.Configuration.Types.SqlJobStep.

CompareTo(SqlJobStep)

Compares two CENTREL.XIA.Configuration.Types.SqlJobStep objects to allow sorting alphabetically by name.

public int CompareTo(SqlJobStep other)

Parameters

other SqlJobStep

The CENTREL.XIA.Configuration.Types.SqlJobStep to compare to.

Returns

int

The sort order of the two CENTREL.XIA.Configuration.Types.SqlJobStep objects.