Table of Contents

Class JobControlAction

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll
public sealed class JobControlAction : ResponseAction, ISequencedCollectionMember
Inheritance
object
JobControlAction
Implements

Properties

ActionOptions

public JobControlActionOptions ActionOptions { get; set; }

Property Value

JobControlActionOptions

AuthorizationToken

An authorization token authorizing execution of the target job.

public string AuthorizationToken { get; set; }

Property Value

string

Remarks

See the discussion in AuthorizingLoginOID.

See Also

AuthorizingLoginOID

The OID of the SecurityLogin with permission to run the target job.

public OID AuthorizingLoginOID { get; set; }

Property Value

OID

Remarks

If the target job is another job, you must store the identity of a login with permission to execute that job (the AuthorizingLoginOID) and an AuthorizationToken generated by the server.

To generate the authorization token, call Scheduler.SignDelegationToken with action "RunJob" and pass the job's
ObjectID as the targetObject. The value returned by the server should be saved as the AuthorizationToken. If the 
TargetJob is on another computer (TargetComputer is set), SignDelegationToken must be called on a Scheduler session
connected to the remote computer.
See Also

CID

The Class ID for the object

[IgnoreDataMember]
public override ClassID CID { get; }

Property Value

ClassID

Remarks

Obsolete. Use ClassID instead.

Checkpoint

public string Checkpoint { get; set; }

Property Value

string

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.

ControlType

public JobControlActionType ControlType { get; set; }

Property Value

JobControlActionType

ExecutionOptions

public JobExecutionOptions ExecutionOptions { get; set; }

Property Value

JobExecutionOptions

IsDependent

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

JobVariables

public JobVariableCollection JobVariables { get; }

Property Value

JobVariableCollection

RestartDelay

public int RestartDelay { get; set; }

Property Value

int

RetryLimit

public int RetryLimit { get; set; }

Property Value

int

TargetComputer

public string TargetComputer { get; set; }

Property Value

string

TargetJob

public Job TargetJob { get; set; }

Property Value

Job

TargetJobName

The name of the target job. Stored only when the target job is on a remote computer.

public string TargetJobName { get; set; }

Property Value

string

TargetJobOID

The OID of the target job.

public OID TargetJobOID { get; set; }

Property Value

OID

TargetServerID

The adTempus instance ID for the target computer. Required if TargetComputer is set.

[ComVisible(false)]
public Guid? TargetServerID { get; set; }

Property Value

Guid?

TargetStepOID

public OID TargetStepOID { get; set; }

Property Value

OID

Methods

GetActionDescription()

protected override string GetActionDescription()

Returns

string

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

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

Inherited Members