Table of Contents

Class ExecutionHistoryStep

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

Represents a step within an instance of a job

public sealed class ExecutionHistoryStep : ADTObject
Inheritance
object
ExecutionHistoryStep

Properties

CapturedFiles

Files captured by this step

public CapturedFileCollection CapturedFiles { get; }

Property Value

CapturedFileCollection

Remarks

Files are ordered by file name.

Checkpoint

The last Checkpoint reported for the step.

public string Checkpoint { get; }

Property Value

string

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.

ConditionStatuses

A collection of ConditionStatus objects showing the status of each Condition for this step

public ConditionStatusCollection ConditionStatuses { get; }

Property Value

ConditionStatusCollection

ConditionWaitEndTime

The date/time the step finished waiting for conditions

[RequiredVersion(5, 0, 0, 0)]
public DateTimeOffset? ConditionWaitEndTime { get; }

Property Value

DateTimeOffset?

Remarks

Will be null if the step has no conditions.

ConditionWaitStartTime

The date/time the step started waiting for conditions

[RequiredVersion(5, 0, 0, 0)]
public DateTimeOffset? ConditionWaitStartTime { get; }

Property Value

DateTimeOffset?

Remarks

Will be null if the step has no conditions.

ConditionWaitTime

Time spent waiting for conditions to be met

public TimeSpan? ConditionWaitTime { get; }

Property Value

TimeSpan?

Remarks

This is the elapsed between ConditionWaitStartTime and ConditionWaitEndTime, or between ConditionWaitStartTime and the current time if the step is still waiting for conditions.

The value will be null if the job has no conditions or the times were not recorded

ElapsedTime

Time elapsed between ExecutionStart and ExecutionFinish, or between ExecutionStart and current time if step is still active.

public TimeSpan? ElapsedTime { get; }

Property Value

TimeSpan?

ExecutionFinish

The date/time execution ended for the step

[ComVisible(false)]
public DateTimeOffset? ExecutionFinish { get; }

Property Value

DateTimeOffset?

ExecutionStart

The date/time execution started for the step

[ComVisible(false)]
public DateTimeOffset? ExecutionStart { get; }

Property Value

DateTimeOffset?

ExitCode

Gets the exit code/result for the step.

public string ExitCode { get; }

Property Value

string

Remarks

The ExitCode can be a numeric exit code or a string result. The value is limited to 255 characters and will be truncated if it exceeds that length.

<xref href="ArcanaDevelopment.adTempus.Client.ExecutionHistoryStep.Result" data-throw-if-not-resolved="false"></xref> returns the same value.

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.

IsRunning

Indicates whether the step is currently running.

public bool IsRunning { get; }

Property Value

bool

KernelModeTime

The total kernel mode CPU time for this step

public TimeSpan KernelModeTime { get; }

Property Value

TimeSpan

Remarks

Processor time is only accumulated for certain task types. See the user guide for more information

MemoryUsage

The peak working set size for the process, in KB.

public int MemoryUsage { get; }

Property Value

int

ProcessID

The Windows process ID for the process executed by this step

public int ProcessID { get; }

Property Value

int

Remarks

For tasks that don't result in the creation of a new Windows process, the ProcessID will be 0.

QueueEnterTime

The date/time the step began waiting for a queue slot

[RequiredVersion(5, 0, 0, 0)]
public DateTimeOffset? QueueEnterTime { get; }

Property Value

DateTimeOffset?

QueueLeaveTime

The date/time the step finished waiting for a queue slot

[RequiredVersion(5, 0, 0, 0)]
public DateTimeOffset? QueueLeaveTime { get; }

Property Value

DateTimeOffset?

RestartCount

Indicates the number of times the step has been restarted

public int RestartCount { get; }

Property Value

int

Remarks

RestartCount will be 0 for the initial execution of the step. If the step is restarted by a JobControlAction the RestartCount for the ExecutionHistoryStep created by the restart will be 1. Subsequent restarts in the same job execution will each increment the count.

Result

Gets the result returned by the task.

public object Result { get; }

Property Value

object

Remarks

Same as ExitCode.

Status

The status (state) of this step

public JobState Status { get; }

Property Value

JobState

StatusDescription

Gets the text description of the Status.

public string StatusDescription { get; }

Property Value

string

StepDescription

Description of the step

public string StepDescription { get; }

Property Value

string

Remarks

The description is stored at the time of execution and does not reflect changes made to the job since then.

StepNumber

The step number

public int StepNumber { get; }

Property Value

int

StepOID

The OID of the JobStep this instance represents

public OID StepOID { get; }

Property Value

OID

StepSubmittedTime

The date/time the step was submitted for execution

[RequiredVersion(5, 0, 0, 0)]
public DateTimeOffset? StepSubmittedTime { get; }

Property Value

DateTimeOffset?

TimeInQueue

Time elapsed between QueueEnterTime and QueueLeaveTime, or between QueueEnterTime and current time if instance is still queued.

public TimeSpan? TimeInQueue { get; }

Property Value

TimeSpan?

UserModeTime

The total user mode CPU time for this step

public TimeSpan UserModeTime { get; }

Property Value

TimeSpan

Remarks

Processor time is only accumulated for certain task types. See the user guide for more information

Methods

FindOwningObject()

Get the owner of this object based on relationships.

protected override ADTObject FindOwningObject()

Returns

ADTObject

The owning object, or null if the object is not owned by another object or the owner has not been set.

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.

GetStep()

Gets the JobStep to which this item belongs.

public JobStep GetStep()

Returns

JobStep

Remarks

The JobStep may be null if the job has been deleted from the server (execution history may not be deleted at the same time the job is deleted).

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