New In Version 5

For version 5.0, the client API has changed to add support for new product features. Some other changes have been made to improve usability and consistency of the API.

Breaking Changes

Some breaking changes have been made to properties and methods of the API.

• The CID property of ADTObject has been renamed to ClassID
• Properties and methods that were previously exposed to support COM (ActiveX) have been removed, as the API now has many other features that are not COM-compatible
• Properties that previously used an integer to represent a period of time (number of seconds or minutes, etc.) have been changed to use a TimeSpan instead to eliminate ambiguity over the proper unit to use
• Various other minor changes that will not affect most users. The fixes should be obvious in most cases.

Other Changes

Other notable changes are described below.

DataContext now exposes an ObjectFactory to simplify object creation

In previous versions of the API, the DataContext.CreateObject method was used to create new objects, and the returned object had to be cast to the correct type. The new DataContext.Create property exposes an ObjectFactory that has a method for each type of object. For example, to create a JobStep in previous versions would require this code:

Object Creation in V4 API

var step = (JobStep) context.CreateObject(ClassID.JobStep);

In the version 5 API this call can be replaced with:

Object Creation in V5 API

var step = context.Create.JobStep();

Exclusion Periods

The ExclusionPeriod class is added to represent Exclusion Periods. DataContext.GetExclusionPeriod and DataContext.GetExclusionPeriods are used to retrieve existing Exclusion Periods.

Job Execution Task

The JobExecutionTask class is added to represent the new Job Execution Task.

Last day of month behavior for DaySpecification

In previous versions of adTempus, selecting day 31 for a DaySpecification meant that the rule would apply to the last day of the month regardless of the number of days in the month. Version 5 allows the rule to be configured so that day 31 only applies to days that actually have 31 days (i.e., it is ignored for days with fewer than 31 days). The DaySpecification.Treat31stAsLast property determines how this rule behaves. By default this property is true and a DaySpecification with day 31 selected applies to the last day of all months, as in previous versions. If Treat31stAsLast is false, the rule only applies to months with 31 days.

New properties added to ExecutionHistoryItem

New properties were added to ExecutionHistoryItem to expose new timings recorded by adTempus:

• AgentWaitStartTime
• AgentWaitEndTime
• AgentWaitTime
• ConditionWaitStartTime
• ConditionWaitEndTime
• ConditionWaitTime
• JobSubmittedTime
• QueueEnterTime
• QueueLeaveTime
• TimeInQueue
• ScheduledStart

Object descriptions

In previous versions of adTempus some objects supported user-defined description/notes fields. Starting with version 5 all objects support this. The ADTObject.Description and DescriptionTextType fields store the description and control the text format. The Description and Notes properties previously found on some other objects have been replaced with ADTObject.Description.

Custom properties

ADTObject now exposes a CustomProperties collection that can be used by client applications to associate application-defined data with an object. Custom properties are not exposed in the user interface.