Interface IApplicationIntegration

Namespace

ArcanaDevelopment.adTempus.ApplicationIntegration

Assembly

ArcanaDevelopment.adTempus.ApplicationIntegration.dll

Provides integration with adTempus.

[ComVisible(true)]
[Guid("26EF214F-8290-4B4F-948B-A1E832689A9B")]
public interface IApplicationIntegration

Properties

Checkpoint

Gets or sets the Checkpoint for the job.

string Checkpoint { get; set; }

Property Value

string

Environment

Gets the Job Variables for the job.

IJobVariableDictionary Environment { get; }

Property Value

IJobVariableDictionary

Remarks

This property is provided for backward compatibility only. It is identical to the JobVariables property, except that when adding variables, they are also added to the environment by default (whereas for JobVariables, they are not added to the environment by default).

JobID

Gets the unique ID for the job definition.

string JobID { get; }

Property Value

string

JobInstanceID

Gets the unique ID for this job instance.

string JobInstanceID { get; }

Property Value

string

JobVariables

Gets the Job Variables for the job.

IJobVariableDictionary JobVariables { get; }

Property Value

IJobVariableDictionary

Result

The result of the script execution

object Result { get; set; }

Property Value

object

ShouldTerminate

Indicates whether the operation has been terminated.

bool ShouldTerminate { get; }

Property Value

bool

Remarks

ShouldTerminate returns True if a termination request has been received for the operation. Consumers of this interface can poll ShouldTerminate during lengthy operations to detect termination. When termination has been requested, the operation should terminate as soon as possible.

StepID

Gets the unique ID for the job step definition.

string StepID { get; }

Property Value

string

StepNumber

Gets the step number

int StepNumber { get; }

Property Value

int

Methods

CaptureFile(string, string, string)

Captures a file on disk and stores it in the job history.

void CaptureFile(string fileName, string originalPath, string displayName)

Parameters

Name	Type	Description
fileName	string	The path/name of an existing file.
originalPath	string	The original path of the file. Specify null or empty string to use the fileName.
displayName	string	The name that the file should use after it is captured. Specify null or empty string to use the original name.

Remarks

The file is copied to the adTempus CapturedFiles directory when you call CaptureFile.

CaptureFileData(byte[], string, string, DateTime, bool)

Stores data as a Captured File in the job history.

void CaptureFileData(byte[] fileContents, string fileName, string originalPath, DateTime fileDate, bool treatAsCapturedConsole = false)

Parameters

Name	Type	Description
fileContents	byte[]	The contents to write to the file
fileName	string	The file name to display for the data.
originalPath	string	The path to display for the file. Can be null or empty.
fileDate	DateTime	The timestamp to display for the file.
treatAsCapturedConsole	bool	If true, this file is treated as captured console output for various purposes

ExecuteOnDemandResponses(string)

Executes on-demand Responses defined for the job or step.

[ComVisible(false)]
void ExecuteOnDemandResponses(string eventTag)

Parameters

Name	Type	Description
eventTag	string	The tag used to match Response Events.

Remarks

This method will invoke any Responses that have a ResponseEvent with type OnDemand and a CustomEventID that matches the eventTag.

Responses are invoked asynchronously (the script does not wait for completion of Response evaluation).

ExecuteOnDemandResponses(string, ResponseParameters)

Executes on-demand Responses defined for the job or step.

void ExecuteOnDemandResponses(string eventTag, ResponseParameters parms)

Parameters

Name	Type	Description
eventTag	string	The tag used to match Response Events.
parms	ResponseParameters	Additional parameters for Response evaluation. Can be null.

Remarks

This method will invoke any Responses that have a ResponseEvent with type OnDemand and a CustomEventID that matches the eventTag.

Responses are invoked asynchronously (the script does not wait for completion of Response evaluation).

LogMessage(MessageTypeEnum, int, string)

Logs a message to the Job Log for the job.

void LogMessage(MessageTypeEnum messageType, int messageCode, string message)

Parameters

Name	Type	Description
messageType	MessageTypeEnum	The message type (severity)
messageCode	int	The message code. Can be used to filter messages. Note: The value 100000 will be added to the messageCode when the message is recorded in adTempus.
message	string	The message text.

Remarks

Each message logged with LogMessage creates a log message in the Job Log for the job and a record in the adTempus database. To avoid cluttering the job log and using large amounts of database space, use MessageTypeEnum.Debug for debug-level messages. These messages will be written to the Job Detail Log instead of the main Job Log. The detail log is a single log file with detailed/diagnostic information for the job, available from the Captured Files list for the job.

ReplaceVariableTokens(string)

Expands variable tokens in a string

string ReplaceVariableTokens(string sourceString)

Parameters

Name	Type	Description
sourceString	string	The string to expand tokens in.

Returns

string

Remarks

This method replaces any valid variable tokens it finds with the corresponding values.

For example, if Job Variable "SomeVariable" has the value of "423", calling ReplaceVariableTokens("Current value: %SomeVariable%") returns the result "Current value: 423".

This method does not support the expansion of inline functions.

SendNotificationMessage(NotificationMessage)

Sends a notification message through the adTempus notification system.

void SendNotificationMessage(NotificationMessage message)

Parameters

Name	Type	Description
message	NotificationMessage	The message to send.

SetAdditionalResult(string, string)

Communicates additional result information to the host.

void SetAdditionalResult(string key, string value)

Parameters

Name	Type	Description
key	string
value	string

SetJobOutcome(ExecutionOutcome, string)

Sets the success or failure state of the job in which the script is executing

void SetJobOutcome(ExecutionOutcome outcome, string message = null)

Parameters

Name	Type	Description
outcome	ExecutionOutcome	Indicates whether the job should be reported as Succeeded or Failed.
message	string	Optional message to log to the Job Log

Remarks

When the outcome is set using SetStepOutcome, this overrides the normal success/failure determination rules for the step. This is equivalent to using a JobControlAction with a ControlType of SucceedJob or FailJob

SetStepOutcome(ExecutionOutcome, string)

Sets the success or failure state of the step in which the script is executing

void SetStepOutcome(ExecutionOutcome outcome, string message = null)

Parameters

Name	Type	Description
outcome	ExecutionOutcome	Indicates whether the step should be reported as Succeeded or Failed.
message	string	Optional message to log to the Job Log

Remarks

When the outcome is set using SetStepOutcome, this overrides the normal success/failure determination rules for the step. This is equivalent to using a JobControlAction with a ControlType of SucceedJob or FailJob

Sleep(int)

Delays execution for the specified number of milliseconds.

bool Sleep(int timeoutMS)

Parameters

Name	Type	Description
timeoutMS	int	The number of milliseconds to sleep.

Returns

bool

true if the wait period elapsed, or false if the script/step/job was aborted before the wait elapsed.

Remarks

Use this method to sleep safely inside a script and abort processing if the script is terminated.

Sleep(TimeSpan)

Delays execution for the specified time

bool Sleep(TimeSpan timeout)

Parameters

Name	Type	Description
timeout	TimeSpan	The time to sleep.

Returns

bool

true if the wait period elapsed, or false if the script/step/job was aborted before the wait elapsed.

Remarks

Use this method to sleep safely inside a script and abort processing if the script is terminated.