Class ScriptHostInterface
- Namespace
- ArcanaDevelopment.adTempus.ApplicationIntegration
- Assembly
- ArcanaDevelopment.adTempus.ApplicationIntegration.dll
The ScriptHostInterface allows scripts to interact with the host adTempus server. It is exposed to scripts through the adTempusobject.
public abstract class ScriptHostInterface- Inheritance
-
objectScriptHostInterface
- Derived
Properties
Checkpoint
Gets or sets the Checkpoint for the job.
[CanBeNull]
public static string Checkpoint { get; set; }Property Value
- string
JobID
Gets the unique ID for the job definition.
[CanBeNull]
public static string JobID { get; }Property Value
- string
JobInstanceID
Gets the unique ID for this job instance.
[CanBeNull]
public static string JobInstanceID { get; }Property Value
- string
Remarks
This a GUID for the instance. For the instance number, use JobInstanceNumber.
JobVariables
Gets the Job Variables for the job.
[NotNull]
public static IJobVariableDictionary JobVariables { get; }Property Value
Remarks
This collection contains all Job Variables currently defined for this job instance. You can add or modify variables, but those changes only affect this job instance--they are not permanent changes.
To quickly set or create a variable, use SetJobVariable.
- See Also
ShouldTerminate
Indicates whether the operation has been terminated.
public 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.
[CanBeNull]
public static string StepID { get; }Property Value
- string
StepNumber
Gets the step number
public static int? StepNumber { get; }Property Value
- int?
TerminationEvent
Event that is signalled when the script is being terminated.
public EventWaitHandle TerminationEvent { get; }Property Value
- EventWaitHandle
Methods
CaptureFile(byte[], string, DateTime, string)
Stores data as a Captured File in the job history.
public static void CaptureFile(byte[] fileContents, string fileName, DateTime fileDate, string originalPath = "")Parameters
| Name | Type | Description |
|---|---|---|
fileContents |
byte[] | The contents to write to the file |
fileName |
string | The file name to display for the data. |
fileDate |
DateTime | The timestamp to display for the file. |
originalPath |
string | The path to display for the file. Can be null or empty. |
CaptureFile(string, string)
Captures a file on disk and stores it in the job history.
public static void CaptureFile(string fileName, string newFileName = "")Parameters
| Name | Type | Description |
|---|---|---|
fileName |
string | The path/name of an existing file. |
newFileName |
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.
CaptureFile(string, string, string)
Captures a file on disk and stores it in the job history.
public static 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.
ExecuteOnDemandResponses(string)
Executes on-demand Responses defined for the job or step.
public static 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.
public static 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).
LogDebug(string)
Logs a message to the Script Debug Log for the job.
public void LogDebug(string message)Parameters
| Name | Type | Description |
|---|---|---|
message |
string | The message text. |
Remarks
Equivalent to calling LogMessage with Debug.
- See Also
-
LogInfo(string)LogWarning(string)LogError(string)
LogError(string)
Logs an Error message to the Job Log for the job.
public void LogError(string message)Parameters
| Name | Type | Description |
|---|---|---|
message |
string | The message text. |
Remarks
Equivalent to calling LogMessage with Error.
- See Also
-
LogDebug(string)LogInfo(string)LogWarning(string)
LogInfo(string)
Logs an Informational message to the Job Log for the job.
public void LogInfo(string message)Parameters
| Name | Type | Description |
|---|---|---|
message |
string | The message text. |
Remarks
Equivalent to calling LogMessage with Informational.
- See Also
-
LogDebug(string)LogWarning(string)LogError(string)
LogMessage(MessageType, int, string)
Logs a message to the Job Log for the job.
public static void LogMessage(MessageType messageType, int messageCode, string message)Parameters
| Name | Type | Description |
|---|---|---|
messageType |
MessageType | 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 MessageType.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.
- See Also
-
LogDebug(string)LogInfo(string)LogWarning(string)LogError(string)
LogMessage(MessageType, string)
Logs a message to the Job Log for the job.
public void LogMessage(MessageType messageType, string message)Parameters
| Name | Type | Description |
|---|---|---|
messageType |
MessageType | The message type (severity) |
message |
string | The message text. |
Remarks
This method is equivalent to calling LogMessage(messageType, 0, message)
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 MessageType.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.
- See Also
LogWarning(string)
Logs a Warning message to the Job Log for the job.
public void LogWarning(string message)Parameters
| Name | Type | Description |
|---|---|---|
message |
string | The message text. |
Remarks
Equivalent to calling LogMessage with Warning.
ReplaceVariableTokens(string)
Expands variable tokens in a string
public static string ReplaceVariableTokens(string source)Parameters
| Name | Type | Description |
|---|---|---|
source |
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.
public static void SendNotificationMessage(NotificationMessage message)Parameters
| Name | Type | Description |
|---|---|---|
message |
NotificationMessage | The message to send. |
SetAdditionalResult(string, string)
Communicates additional result information to the host.
public static 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
public static 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
SetJobVariable(string, string)
Sets a value for an existing or new Job Variable.
public void SetJobVariable(string name, string value)Parameters
| Name | Type | Description |
|---|---|---|
name |
string | The name of the variable to add or update. |
value |
string | The value for the variable. |
Remarks
This method updates the existing variable with Name name, or creates a new variable if none exists with that name.
The variable is only defined for the current execution of the job.
- See Also
SetStepOutcome(ExecutionOutcome, string)
Sets the success or failure state of the step in which the script is executing
public static 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.
public static 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
public 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.