Table of Contents

Class ResponseEvent

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

Represents an event that triggers a Response

public sealed class ResponseEvent : ADTObject
Inheritance
object
ResponseEvent

Remarks

On-Demand Responses

For a Response that can be arbitrarily executed from within a script, use a ResponseEvent with the Event set to OnDemand and set the CustomEventID to a unique value. A script can then use ScriptHostInterface.ExecuteOnDemandResponses(string) to trigger the response using the event ID.

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.

ComparisonOperator

The comparison to perform when Event is TaskCompletedWithExitCode

public ExitCodeTestType ComparisonOperator { get; set; }

Property Value

ExitCodeTestType

Remarks

The ExitCodeMax is only used for BT. For all other test types use ExitCodeMin.

CustomEventData

Data to be used with the CustomEventID

public string CustomEventData { get; set; }

Property Value

string

CustomEventID

The custom event ID to look for when Event is Custom or OnDemand

public string CustomEventID { get; set; }

Property Value

string

Remarks

For a custom event, the event ID is defined by the custom event handler.

For an on-demand event, set the event ID to a unique tag that the script can use when invoking the Response. See the Remarks under ResponseEvent.

Event

The type of event to trigger for.

public JobEvent Event { get; set; }

Property Value

JobEvent

ExitCodeMax

The maximum (inclusive) exit code that represents success when Event is TaskCompletedWithExitCode and ComparisonOperator is BT

public int ExitCodeMax { get; set; }

Property Value

int

Remarks

The ExitCodeMax is only used for BT. For all other test types use ExitCodeMin.

ExitCodeMin

The minimum (inclusive) or single exit code to test against when Event is TaskCompletedWithExitCode

public int ExitCodeMin { get; set; }

Property Value

int

Remarks

When ComparisonOperator is BT the SuccessMinCode represents the minimum value (inclusive) of the range that represents success. For all other test types, the ExitCodeMin is the value that is compared against.

ExitCodeRange

The range(s) of exit codes to use if ComparisonOperator is InRange or NotInRange

[RequiredVersion(5, 0, 0, 0)]
public string ExitCodeRange { get; set; }

Property Value

string

Remarks

This must be a list of exit codes in the form 

1,2-8,12,15-17,23

.

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.

SelectionScript

The script to use to perform additional filtering if other criteria for the event are satisfied

public Script SelectionScript { get; set; }

Property Value

Script

TargetResult

The result to look for when Event is TaskCompletedWithResult

public string TargetResult { get; set; }

Property Value

string

Threshold

The threshold value to use when Event is ArcanaDevelopment.adTempus.Shared.JobEvent.Threshold

public decimal Threshold { get; set; }

Property Value

decimal

ThresholdType

The value to compare to the Threshold when Event is ArcanaDevelopment.adTempus.Shared.JobEvent.Threshold

public EventThresholdType ThresholdType { get; set; }

Property Value

EventThresholdType

Methods

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.

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