Table of Contents

Class JobStatus

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

Contains status and statistics for a job

public sealed class JobStatus : ADTObject
Inheritance
object
JobStatus

Remarks

If the job runs on multiple agents, the JobStatus contains aggregate information across all computers where the job runs. Use RemoteAgents to get the same information for individual agents.

The statistics tracked by the JobStatus can be reset using ClearHistory(HistoryClearOptions)

Properties

ActiveInstances

The number of instances of this job that are currently active.

public int ActiveInstances { get; }

Property Value

int

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.

CurrentStepNumber

The current step being executed (or last step, if the job has finished)

public int CurrentStepNumber { get; }

Property Value

int

ElapsedTime

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

public TimeSpan? ElapsedTime { get; }

Property Value

TimeSpan?

ErrorCount

The number of instances of this job with unacknowledged failures.

public int ErrorCount { get; }

Property Value

int

ExecutionFinish

The end date/time of the most recent execution of the job

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

Property Value

DateTimeOffset?

Remarks

If there are currently active instances of the job (see ActiveInstances)the value will be null

ExecutionStart

The start date/time of the most recent execution of the job

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

Property Value

DateTimeOffset?

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.

KernelModeTime

Total kernel mode CPU time for all instances of this job

public TimeSpan KernelModeTime { get; }

Property Value

TimeSpan

Remarks

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

LastCheckpoint

The most recent checkpoint set by an executing instance

public string LastCheckpoint { get; }

Property Value

string

LastInstanceID

The instance number of the current or most recent instance

public int LastInstanceID { get; }

Property Value

int

Remarks

Will be 0 if no instance has executed since the statistics for the job were last reset

MemoryUsage

Total memory usage for all instances, in KB

public int MemoryUsage { get; }

Property Value

int

NextMirrorStart

Next start time for a mirrored job

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

Property Value

DateTimeOffset?

Remarks

If the job is in a System.Collections.Queue that uses Mirror this time reflects the next scheduled start across all agents where the job is targeted.

NextStart

The next scheduled start date/time for the job

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

Property Value

DateTimeOffset?

Remarks

If the job is in a mirrored queue this time represents the next start on the Controller only. See NextMirrorStart for the next scheduled start on the agents.

Status

The status (state) of the current or most recent instance

public JobState Status { get; }

Property Value

JobState

Remarks

If there is currently more than one active instance, use GetExecutionHistory(InstanceQueryParameters) to get details about the instances.

StatusDescription

Gets the text description of the Status.

public string StatusDescription { get; }

Property Value

string

TotalExecutions

Total number of times the job has been executed

public int TotalExecutions { get; }

Property Value

int

TotalTime

Total elapsed time of all executions for this job.

public TimeSpan TotalTime { get; }

Property Value

TimeSpan

UserModeTime

Total user mode CPU time for all instances of this job

public TimeSpan UserModeTime { get; }

Property Value

TimeSpan

Remarks

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

WarningCount

The number of instances of this job with unacknowledged alerts or warnings.

public int WarningCount { get; }

Property Value

int

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.

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

See Also

GetStatus(bool)