Table of Contents

Class Job

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll
public sealed class Job : ADTIndependentObject
Inheritance
object
Job

Properties

APIExtensionData

public string APIExtensionData { get; set; }

Property Value

string

APITags

public StringList APITags { get; }

Property Value

StringList

AgentType

public int AgentType { get; set; }

Property Value

int

AlreadyRunningBehavior

public AlreadyRunningBehavior AlreadyRunningBehavior { get; set; }

Property Value

AlreadyRunningBehavior

AssemblyReferences

A semicolon-delimited list of any additional assemblies to be referenced when compiling variable functions used in this job.

public string AssemblyReferences { get; set; }

Property Value

string

CID

The Class ID for the object

[IgnoreDataMember]
public override ClassID CID { get; }

Property Value

ClassID

Remarks

Obsolete. Use ClassID instead.

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.

ConditionFailureAction

public ConditionFailureOptions ConditionFailureAction { get; set; }

Property Value

ConditionFailureOptions

ConditionRule

public ConditionRule ConditionRule { get; set; }

Property Value

ConditionRule

ConditionScript

public Script ConditionScript { get; set; }

Property Value

Script

Conditions

public ConditionCollection Conditions { get; }

Property Value

ConditionCollection

Credentials

public CredentialProfile Credentials { get; set; }

Property Value

CredentialProfile

Description

public string Description { get; set; }

Property Value

string

DescriptionOverride

public string DescriptionOverride { get; set; }

Property Value

string

ExtendedDescription

public override string ExtendedDescription { get; }

Property Value

string

FullyQualifiedName

public string FullyQualifiedName { get; }

Property Value

string

Group

public JobGroup Group { get; set; }

Property Value

JobGroup

HistoryRetentionLimit

public int HistoryRetentionLimit { get; set; }

Property Value

int

HistoryRetentionOptions

public HistoryRetentionOptions HistoryRetentionOptions { get; set; }

Property Value

HistoryRetentionOptions

HoldType

public HoldType HoldType { get; set; }

Property Value

HoldType

IsDependent

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

JobQueue

public JobQueue JobQueue { get; set; }

Property Value

JobQueue

JobStatus

public JobStatus JobStatus { get; }

Property Value

JobStatus

JobVariables

public JobVariableCollection JobVariables { get; }

Property Value

JobVariableCollection

LogRetention

public int LogRetention { get; set; }

Property Value

int

Name

public string Name { get; set; }

Property Value

string

NamespaceImports

A semicolon-delimited list of any additional namespaces to be included when compiling variable functions used in this job.

public string NamespaceImports { get; set; }

Property Value

string

Priority

public int Priority { get; set; }

Property Value

int

RemoteAgents

public JobAgentJoinCollection RemoteAgents { get; }

Property Value

JobAgentJoinCollection

ResourceFailureAction

public ResourceFailureAction ResourceFailureAction { get; set; }

Property Value

ResourceFailureAction

ResourceWaitLimit

public int ResourceWaitLimit { get; set; }

Property Value

int

Resources

public ResourceCollection Resources { get; }

Property Value

ResourceCollection

Responses

public ResponseCollection Responses { get; }

Property Value

ResponseCollection

RestartOptions

public RestartOptions RestartOptions { get; set; }

Property Value

RestartOptions

RunElevated

public bool RunElevated { get; set; }

Property Value

bool

ScriptLibraries

public ScriptLibraryCollection ScriptLibraries { get; }

Property Value

ScriptLibraryCollection

StepExecutionRule

public StepExecutionSequence StepExecutionRule { get; set; }

Property Value

StepExecutionSequence

Steps

public JobStepCollection Steps { get; }

Property Value

JobStepCollection

SupportedResponseEvents

public ReadOnlyCollection<SupportedResponseEvent> SupportedResponseEvents { get; }

Property Value

ReadOnlyCollection<SupportedResponseEvent>

SupportedSecurityActions

public override Dictionary<int, string> SupportedSecurityActions { get; }

Property Value

Dictionary<int, string>

Tags

public StringList Tags { get; }

Property Value

StringList

TagsList

Gets or sets the list of tags as a comma-delimited string.

public string TagsList { get; set; }

Property Value

string

Triggers

public TriggerCollection Triggers { get; }

Property Value

TriggerCollection

UpdateCycleID

public bool UpdateCycleID { get; set; }

Property Value

bool

UseInheritedResponses

public bool UseInheritedResponses { get; set; }

Property Value

bool

UserInteractionMode

public UserInteractionMode UserInteractionMode { get; set; }

Property Value

UserInteractionMode

UserInterfaceExtensionData

public string UserInterfaceExtensionData { get; set; }

Property Value

string

UserInterfaceExtensionID

public string UserInterfaceExtensionID { get; set; }

Property Value

string

WaitStartLimit

public int WaitStartLimit { get; set; }

Property Value

int

Methods

ClearHistory(HistoryClearOptions)

Clears the history for the job, optionally resetting the statistics for the job.

public void ClearHistory(HistoryClearOptions options)

Parameters

NameTypeDescription
options HistoryClearOptions

Remarks

Calling this method initiates an immediate purchase of the history data for the job.

Execute(JobExecutionSettings)

public ExecuteJobResult Execute(JobExecutionSettings options)

Parameters

NameTypeDescription
options JobExecutionSettings

Returns

ExecuteJobResult

GetEffectiveHoldType()

Gets the effective HoldType for the job (combining the HoldType for the job, queue, and group hierarchy).

public HoldType GetEffectiveHoldType()

Returns

HoldType

GetExecutionHistory(InstanceQueryParameters)

public ExecutionHistoryItemCollection GetExecutionHistory(InstanceQueryParameters parameters)

Parameters

NameTypeDescription
parameters InstanceQueryParameters

Returns

ExecutionHistoryItemCollection

GetHistoryAndMessages(InstanceQueryParameters, out ExecutionHistoryItemCollection, LogQueryParameters, out LogMessageCollection)

public void GetHistoryAndMessages(InstanceQueryParameters historyParameters, out ExecutionHistoryItemCollection history, LogQueryParameters logParameters, out LogMessageCollection messages)

Parameters

NameTypeDescription
historyParameters InstanceQueryParameters
history ExecutionHistoryItemCollection
logParameters LogQueryParameters
messages LogMessageCollection

GetInheritedVariables(bool)

Gets a collection containing the JobVariables inherited by this object, and optionally the variables for the object itself.

public JobVariableCollection GetInheritedVariables(bool includeSelf)

Parameters

NameTypeDescription
includeSelf bool

Returns

JobVariableCollection

GetJobChain(Guid?)

Gets all jobs in the chain that contains this job.

public JobLinkResults GetJobChain(Guid? chainID)

Parameters

NameTypeDescription
chainID Guid?

If specified, only jobs participating in the specified chain are returned.

Returns

JobLinkResults

Remarks

GetJobChain returns all jobs that are linked to this job, directly or indirectly, through JobConditions and JobControlActions.

For example, if this job is called by a Response in JobA, and JobA has a condition on JobB, GetJobChain returns this job, JobA, and JobB.

GetLogMessages(LogQueryParameters)

public LogMessageCollection GetLogMessages(LogQueryParameters parameters)

Parameters

NameTypeDescription
parameters LogQueryParameters

Returns

LogMessageCollection

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

GetStandardSupportedResponseEvents()

public static List<SupportedResponseEvent> GetStandardSupportedResponseEvents()

Returns

List<SupportedResponseEvent>

GetStatus(bool)

public JobStatus GetStatus(bool Refresh = false)

Parameters

NameTypeDescription
Refresh bool

Returns

JobStatus

GetTriggerStatus(OID)

Gets the TriggerStatus for the job or for a specified trigger.

public TriggerStatusCollection GetTriggerStatus(OID triggerOID)

Parameters

NameTypeDescription
triggerOID OID

The trigger to get the status for. Specify null (Nothing) to get the status for all triggers.

Returns

TriggerStatusCollection

Remarks

Requires ServerFeatureLevel 40301 or higher. Note that not all triggers report status information.

IsFromMaster()

public bool IsFromMaster()

Returns

bool

OnEntityReloaded()

Called when the entity is reloaded from a DTO.

protected override void OnEntityReloaded()

OnNewEntity()

Called when a new entity is created.

protected override void OnNewEntity()

Resync(int)

Resynchronizes status data for the job.

public void Resync(int options)

Parameters

NameTypeDescription
options int

Reserved for future use.

Remarks

Use this method to initiate a resync if the instance counts for the job are incorrect.

Terminate(TerminationOptions, int)

public void Terminate(TerminationOptions options, int instanceID)

Parameters

NameTypeDescription
options TerminationOptions
instanceID int

UpdateHoldType(HoldType, MissedJobCheckOptions, ChangeLogParameters)

Updates the HoldType for the Job immediately.

public void UpdateHoldType(HoldType newValue, MissedJobCheckOptions missedJobOptions, ChangeLogParameters auditRecord = null)

Parameters

NameTypeDescription
newValue HoldType

The new setting for the object's HoldType

missedJobOptions MissedJobCheckOptions

Indicates how missed executions will be treated if the HoldType.DisableTriggers flag is being turned off.

auditRecord ChangeLogParameters

Optional audit record for change log and snapshot.

Remarks

This method makes an immediate server call to update the HoldType. No Save is required. The caller must have Modify or Hold/Release permission.

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

Inherited Members