Interacting with adTempus from Scripts

When adTempus runs a script, the script has access to an integration interface that allows the script to exchange information with the adTempus server. For example, the script can retrieve and set Job Variables, set the Checkpoint for the job, and log messages to the Job Log.

Additionally, .NET scripts derive from a base class that exposes a Parameters object, which provides additional context information to the script. See the script overview topic for more information.

The integration interface is exposed to scripts through a global object named "adTempus" ("$adTempus" for PowerShell scripts).

Integration Interface Members

The adTempus object exposes the following properties and methods. For complete information see the Script Integration API Reference.

Properties

Methods

Message Logging

Scripts can report progress, problems, or other information to be stored in the job history using the LogMessage method. Log messages can be sent to two destinations:

• The main Job Log. Messages appear in the Job Log and the Message Log Query, where you can search for messages based on a message code. Messages are visible in the Job Log as soon as they are reported by the script.
• The Script Debug Log. All messages are written to a single log file that is stored as a Captured File in the job history. Because this file is not saved to the history until the script finishes running, these messages cannot be seen anywhere in the Console while the script is still running. You can search for messages using the search captured file content option in the Search tool.

SWhen a script calls LogMessage with the messageType parameter set to MessageTypeEnum.Debug, the message is sent to the Debug Log. All other messages are sent to the Job Log.

If your script logs a large number of messages for debugging purposes, you should use MessageTypeEnum.Debug to send them to the Debug Log rather than the Job Log. Reporting a large number of messages to the Job Log fills the adTempus database (each message is stored as a separate row in the database), and it can be difficult to review the messages in the Console.

If your script already creates a log file using its own logging mechanism, you can use the CaptureFile method to attach that file to the job history.

Examples

The following examples demonstrate how to perform basic operations using the integration interface.

Logging a Message

To log a message to the job history (see discussion above), use LogMessage:

adTempus.LogMessage(MessageTypeEnum.Error,0,"Failed to process import file")

Getting and Setting Job Variables

A script can retrieve and set Job Variables using the JobVariables collection:

myVariable=adTempus.JobVariables("MyVariable")
adTempus.JobVariables("SomeJobVariable")="A value"