Table of Contents

Class JobExecutionSettings

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

Settings for executing a job on-demand

[ComVisible(true)]
[Guid("943b826a-afdb-400d-b058-b7c297150d29")]
public sealed class JobExecutionSettings
Inheritance
object
JobExecutionSettings

Constructors

JobExecutionSettings() 

public JobExecutionSettings()

Properties

Checkpoint

The checkpoint to pass to the job

public string Checkpoint { get; set; }

Property Value

string

Comments

Optional comments to record for the instance

public string Comments { get; set; }

Property Value

string

Remarks

The comments are stored in Comments.

CurrentLogonSessionID

Gets the logon session ID for the session in which the code is running.

public static int CurrentLogonSessionID { get; }

Property Value

int

CustomProperties

Custom Properties to set for this instance.

[RequiredVersion(5, 0, 3, 6)]
public ICustomProperties CustomProperties { get; }

Property Value

ICustomProperties

Remarks

The custom properties are copied to the CustomProperties of the instance(s) created for this request.

ExecutionRequestID

A unique ID representing this execution request.

public Guid ExecutionRequestID { get; }

Property Value

Guid

Remarks

All job instances started as a result of this request will carry the ExecutionRequestID in the ExecutionRequestID.

After submitting the job you can retrieve the instances using Scheduler.JobServices.GetInstancesForRequest

JobVariables

Specifies Job Variables to be set or overridden for this instance

public JobVariableCollection JobVariables { get; }

Property Value

JobVariableCollection

LogonSessionID

The logon session to run the job in, if UserInteractionMode has SpecifiedSessionRequired or SpecifiedSessionPreferred

public int LogonSessionID { get; set; }

Property Value

int

Remarks

To make the job visible on the calling user's desktop, set LogonSessionID to CurrentLogonSessionID.

See Also

Options

Options specifying execution behavior

public JobExecutionOptions Options { get; set; }

Property Value

JobExecutionOptions

StartingStep

The step to begin execution with, or null to start from the beginning

public JobStep StartingStep { get; set; }

Property Value

JobStep

Remarks

If StepsToExecute is specified, execution begins at that step and runs to the end following normal step execution rules. Use StepsToExecute to selectively execute a single step or multiple steps.

See Also

StepsToExecute

Specifies the step(s) to execute

public Collection<OID> StepsToExecute { get; }

Property Value

Collection<OID>

Remarks

Leave empty to execute all steps. To execute only one or more steps of the job, add their OIDs to the collection.

The order of items in this collection does not matter: the steps will still be executed in their defined order in the job, but steps not included in this collection will be skipped.

See Also

TargetAgents

The Agent(s) on which the job should execute

public List<OID> TargetAgents { get; }

Property Value

List<OID>

Remarks

Specify the OIDs of the RemoteAgent(s) to target, or leave empty to run on all configured agents.

UserInteractionMode

The interaction mode to use for job execution

public UserInteractionMode UserInteractionMode { get; set; }

Property Value

UserInteractionMode

Remarks

This value overrides the options configured for the job