Table of Contents

Class ProcessCondition

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

A condition that depends on the state of a process (Windows executable) running outside adTempus

public sealed class ProcessCondition : Condition
Inheritance
object
ProcessCondition

Properties

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.

ConditionType

Determines what process state the condition looks for

public ProcessConditionType ConditionType { get; set; }

Property Value

ProcessConditionType

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.

Options

Additional options for the condition

public ProcessConditionOptions Options { get; set; }

Property Value

ProcessConditionOptions

ProcessName

The name of the process

public string ProcessName { get; set; }

Property Value

string

Remarks

The ProcessName must be the name of the Windows executable, optionally including the path. If no path is included, the operation will match to any process with the given name.

The ProcessName can also be set to a job variable token (e.g., "%TheProcessName%") that expands to a process name at runtime.

Methods

GetConditionDescription() 

protected override string GetConditionDescription()

Returns

string

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