Class ExecutionHistoryItem
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
[ComVisible(true)]
[Guid("a4b2363b-b6ce-4d40-b4e5-64272802275d")]
public sealed class ExecutionHistoryItem : ADTObject
- Inheritance
-
objectExecutionHistoryItem
Properties
AgentOID
public OID AgentOID { get; }
Property Value
CID
The Class ID for the object
[IgnoreDataMember]
public override ClassID CID { get; }
Property Value
Remarks
Obsolete. Use ClassID instead.
CallingInstanceOID
The OID of the job instance that called this instance, if any.
public OID CallingInstanceOID { get; }
Property Value
- See Also
CapturedFiles
public CapturedFileCollection CapturedFiles { get; }
Property Value
ChainID
A unique ID value linking all instances that are part of the same execution chain.
public string ChainID { get; }
Property Value
- string
Remarks
All jobs linked together through Responses will have the same ChainID.
- See Also
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.
Comments
public string Comments { get; }
Property Value
- string
ComputerName
public string ComputerName { get; }
Property Value
- string
ComputerNameOrAgentName
Gets the name or address of the RemoteAgent, or the ComputerName if it is a local instance.
public string ComputerNameOrAgentName { get; }
Property Value
- string
Remarks
If RemoteAgent is not null, ComputerNameOrAgentName returns RemoteAgent.NameOrAddress. Otherwise it returns ComputerName. If the client is connected to an Agent, it will always return the ComputerName.
ConditionStatuses
public ConditionStatusCollection ConditionStatuses { get; }
Property Value
CurrentStepRestartCount
public int CurrentStepRestartCount { get; }
Property Value
- int
CurrentStepRestartLimit
public int CurrentStepRestartLimit { get; }
Property Value
- int
CycleID
The value of the CycleID job variable at the time of execution
public string CycleID { get; }
Property Value
- string
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?
ExecutionFinish
[ComVisible(false)]
public DateTimeOffset? ExecutionFinish { get; }
Property Value
- DateTimeOffset?
ExecutionReason
The reason for the execution.
public string ExecutionReason { get; }
Property Value
- string
ExecutionRequestID
Links all instances started as a result of a manual execution request.
public string ExecutionRequestID { get; }
Property Value
- string
Remarks
When a job is submitted for execution using Execute(JobExecutionSettings), the ExecutionRequestID is assigned to all instances created from that request, allowing them to be found and tracked later.
ExecutionStart
[ComVisible(false)]
public DateTimeOffset? ExecutionStart { get; }
Property Value
- DateTimeOffset?
ExecutionType
public ExecutionType ExecutionType { get; }
Property Value
InstanceID
public int InstanceID { get; }
Property Value
- int
IsDependent
[IgnoreDataMember]
public override bool IsDependent { get; }
Property Value
- bool
IsRunning
public bool IsRunning { get; }
Property Value
- bool
IsWaiting
public bool IsWaiting { get; }
Property Value
- bool
Job
The job to which this item belongs.
public Job Job { get; }
Property Value
Remarks
The Job may be null if it has been deleted from the server (execution history may not be deleted at the same time the job is deleted).
JobGroupName
public string JobGroupName { get; }
Property Value
- string
JobGroupOID
public OID JobGroupOID { get; }
Property Value
JobName
public string JobName { get; }
Property Value
- string
JobOID
public OID JobOID { get; }
Property Value
JobQueueName
public string JobQueueName { get; }
Property Value
- string
JobQueueOID
public OID JobQueueOID { get; }
Property Value
KernelModeTime
public int KernelModeTime { get; }
Property Value
- int
LastCheckpoint
The last checkpoint reported by the job.
public string LastCheckpoint { get; }
Property Value
- string
LastStepDescription
The description of the last step executed or executing.
public string LastStepDescription { get; }
Property Value
- string
Remarks
This method does not return the Description value. Rather, it returns the step Name (if present) and the system-generated description of the task.
- See Also
LastStepInstanceOID
The OID of the ExecutionHistoryStep for the most recent step executed.
public OID LastStepInstanceOID { get; }
Property Value
LastStepName
The name of the last step executed or executing.
public string LastStepName { get; }
Property Value
- string
- See Also
LastStepNumber
The step number of the step currently executing, or the last step executed if the instance is not currently executing.
public int LastStepNumber { get; }
Property Value
- int
Remarks
Will be 0 if the information is not available or if no steps were executed.
LocalInstance
public bool LocalInstance { get; }
Property Value
- bool
LogMessages
public LogMessageCollection LogMessages { get; }
Property Value
MemoryUsage
The peak working set size for the job, in KB.
public int MemoryUsage { get; }
Property Value
- int
Remarks
This value will reflect the largest MemoryUsage value for all steps in the instance.
NumberOfSteps
The total number of steps in the job.
public int NumberOfSteps { get; }
Property Value
- int
OriginalQueueOrder
The queue order for the instance, which can be used to reorder pending jobs that have the same priority.
public int OriginalQueueOrder { get; }
Property Value
- int
Remarks
This value is only set when the object was fetched through a call to GetJobMonitorData(JobMonitorViewFetchOptions, InstanceQueryParameters, DateTime, DateTime, out DateTime, ref DateTime?, out ReadOnlyCollection<JobExecutionTimes>, out ExecutionHistoryItemCollection) using the GetQueueOrdering option. Otherwise it will always return 0.
Priority
The Job.Priority for the instance.
public int Priority { get; }
Property Value
- int
Remarks
This value is only set when the object was fetched through a call to GetJobMonitorData(JobMonitorViewFetchOptions, InstanceQueryParameters, DateTime, DateTime, out DateTime, ref DateTime?, out ReadOnlyCollection<JobExecutionTimes>, out ExecutionHistoryItemCollection) using the GetQueueOrdering option. Otherwise it will return 0.
PriorityOrOverride
Returns the PriorityOverride if it has a value, or the Priority otherwise.
public int PriorityOrOverride { get; }
Property Value
- int
PriorityOverride
The priority override for the instance.
public int? PriorityOverride { get; set; }
Property Value
- int?
Remarks
This value is only set when the object was fetched through a call to GetJobMonitorData(JobMonitorViewFetchOptions, InstanceQueryParameters, DateTime, DateTime, out DateTime, ref DateTime?, out ReadOnlyCollection<JobExecutionTimes>, out ExecutionHistoryItemCollection) using the GetQueueOrdering option.
QueueAddTime
The time the instance was added to the execution queue.
public DateTimeOffset? QueueAddTime { get; }
Property Value
- DateTimeOffset?
Remarks
This value is only set when the object was fetched through a call to GetJobMonitorData(JobMonitorViewFetchOptions, InstanceQueryParameters, DateTime, DateTime, out DateTime, ref DateTime?, out ReadOnlyCollection<JobExecutionTimes>, out ExecutionHistoryItemCollection) using the GetQueueOrdering option.
QueueOrderOverride
The queue order override for the instance, which can be used to reorder pending jobs that have the same priority.
public int? QueueOrderOverride { get; set; }
Property Value
- int?
Remarks
This value is only set when the object was fetched through a call to GetJobMonitorData(JobMonitorViewFetchOptions, InstanceQueryParameters, DateTime, DateTime, out DateTime, ref DateTime?, out ReadOnlyCollection<JobExecutionTimes>, out ExecutionHistoryItemCollection) using the GetQueueOrdering option.
QueueState
The queue state of an active instance.
public QueueState? QueueState { get; }
Property Value
Remarks
This value is only set when the object was fetched through a call to GetJobMonitorData(JobMonitorViewFetchOptions, InstanceQueryParameters, DateTime, DateTime, out DateTime, ref DateTime?, out ReadOnlyCollection<JobExecutionTimes>, out ExecutionHistoryItemCollection) using the GetQueueOrdering option.
RecordID
public int RecordID { get; }
Property Value
- int
RemoteAgent
The RemoteAgent this instance is assigned to.
public RemoteAgent RemoteAgent { get; }
Property Value
Remarks
Will be null if the instance ran locally.
RestartCount
public int RestartCount { get; }
Property Value
- int
RestartLimit
public int RestartLimit { get; }
Property Value
- int
Status
public JobState Status { get; }
Property Value
StatusAcknowledged
public bool StatusAcknowledged { get; }
Property Value
- bool
StatusDescription
Gets the text description of the Status.
public string StatusDescription { get; }
Property Value
- string
Steps
public ExecutionHistoryStepCollection Steps { get; }
Property Value
TagList
public string TagList { get; }
Property Value
- string
TriggerClass
public ClassID TriggerClass { get; }
Property Value
UserModeTime
public int UserModeTime { get; }
Property Value
- int
Methods
AcknowledgeStatus(int)
public void AcknowledgeStatus(int options)
Parameters
| Name | Type | Description |
|---|---|---|
options |
int |
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.
- See Also
OnEntityReloaded()
Called when the entity is reloaded from a DTO.
protected override void OnEntityReloaded()
OverrideStatus(JobState)
public void OverrideStatus(JobState newStatus)
Parameters
| Name | Type | Description |
|---|---|---|
newStatus |
JobState |
Refresh()
Reverts the object (and any contained objects) to their last-saved state, discarding any in-memory changes.
public void Refresh()
ReleaseWaitingInstance(int, string)
Forces immediate execution of an instance that is waiting for execution.
public void ReleaseWaitingInstance(int options, string reason)
Parameters
| Name | Type | Description |
|---|---|---|
options |
int | Reserved. Must be set to 0. |
reason |
string | Optional reason for the forced execution. |
Remarks
This forces the job to continue execution if it is waiting for a condition or available queue slot.
SetComments(string)
public void SetComments(string newVal)
Parameters
| Name | Type | Description |
|---|---|---|
newVal |
string |
Terminate(TerminationOptions)
Terminates this instance of the job, if it is running.
public void Terminate(TerminationOptions options)
Parameters
| Name | Type | Description |
|---|---|---|
options |
TerminationOptions |
WriteToConfigurationReport(IADTObjectConfigurationReportWriter)
public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)
Parameters
| Name | Type | Description |
|---|---|---|
reportBuilder |
IADTObjectConfigurationReportWriter |
Inherited Members
- ADTObject.LastModified
- ADTObject.CreationTimestamp
- ADTObject.FromMaster
- ADTObject.OID
- ADTObject.ClassID
- ADTObject.BindingDescription
- ADTObject.ToString()
- ADTObject.ParentObject
- ADTObject.CanPerform(SecurityPermission)
- ADTObject.Duplicate()
- ADTObject.DataContext
- ADTObject.AccessMask
- ADTObject.Validate(MessageCollection)
- ADTObject.SupportedSecurityActions
- ADTObject.SupportedSecurityInheritanceOptions
- ADTObject.GetTopLevelOwner()
- ADTObject.GetConfigurationReport()
- ADTObject.GetConfigurationReport(bool)
- ADTObject.ExtendedDescription
- ADTObject.IsReadOnly
- ObjectBase.IsDirty
- ObjectBase.IsNew
- ObjectBase.IsStub
- ObjectBase.ClassName
- ObjectBase.GetDescription()
- ObjectBase.BeginEdit()
- ObjectBase.BeginEdit(UndoLevelAction)
- ObjectBase.CommitEdit(Guid)
- ObjectBase.CommitEdit()
- ObjectBase.UndoEdit()
- ObjectBase.UndoEdit(Guid)