adTempus API
|
The Client component exposes the adTempus client functionality. It provides programmatic access to all of the features and functions available through the adTempus Console.
.NET applications should reference ArcanaDevelopmet.adTempus.Client.dll in the adTempus program directory.
Other applications should reference the "ADTempus 3.0 Type Library," which is implemented in adtempus.dll in the adTempus program directory.
Name |
Description |
The following table lists classes in this documentation. | |
The following table lists interfaces in this documentation. | |
The following table lists structs, records, enums in this documentation. |
Name |
Description |
A collection of IAction objects. | |
The ADError class is used to return error and warning information. | |
A collection of IADError objects. | |
Represents an access-control entries for a SecurityDescriptor. | |
A collection of objects that inherit from IADTObject. | |
The Application is the top-level object in the adTempus object hierarchy; it provides access to the other objects. | |
The CapturedFile class represents a file captured by adTempus due to a File Capture Action. | |
A collection of ICapturedFile objects. | |
The ComputerMonitor is a trigger that triggers a job based on the response (or lack thereof) from another computer. | |
A collection of ICondition objects. | |
| |
The CustomAction allows developers to extend adTempus by adding their own Actions. | |
The CustomCondition allows developers to extend adTempus by adding their own conditions. | |
The CustomTask allows developers to extend adTempus by adding their own task types. | |
The CustomTrigger allows developers to extend adTempus by adding their own triggers. | |
The DateSchedule holds the information necessary to define a range of days on which a job will execute. | |
The DayIntervalCriterion is a DateCriterion that causes a job to execute every x days. | |
The DaySpecification defines a day on which a job will execute, by specifying a specific date or a rule to determine the date. | |
A collection of IDaySpecification objects. | |
An EffectiveSchedule defines a time period when an item (such as a notification recipient) is or is not "effective." For example, in the case of a notification recipient, the EffectiveSchedule specifies a period when the recipient does or does not receive notification messages. | |
A collection of IEffectiveSchedule objects. | |
Represents an event log on the server. | |
The EventLogMonitor is a trigger that runs a job in response to events logged to the system's Event Log. | |
A collection of IEventLog objects. | |
Represents an event source (a source of Event Log messages) on the server. | |
This class is for internal use by adTempus. | |
Represents an instance (execution) of the job. | |
A collection of IExecutionHistoryItem objects. | |
Represents a step in an instance (execution) of the job. | |
A collection of IExecutionHistoryStep objects. | |
The FileCaptureAction allows a job or step to capture files produced by the job or step. | |
The FileCaptureSpec defines a file specification and processing options for a file captured or used by a File Capture Action, Notification Action, or File Trigger. | |
A collection of IFileCaptureSpec objects. | |
A FileCondition is a Condition that causes a job or step to depend on the presence or absence of a file or files. | |
A FileTrigger is a trigger that triggers a job based on the presence, absence, creation, modification, or deletion of specified files. | |
Contains information about an object imported by the ImportExportFacility. | |
A collection of IImportedObject objects. | |
The ImportExportFacility allows you to export and import data. | |
Specifies object import data and settings for the ImportExportFacility. | |
Contains information about the results of an import operation. | |
A collection of objects that inherit from IADTIndependentObject. | |
Represents an adTempus job. | |
A collection of IJobAgentJoin objects. | |
The JobCondition represents a condition that makes a job dependent on the status of another job. | |
The JobControlAction is an action that allows a job to control itself or another job. | |
The JobEventFilter is used to define an event that triggers a Response. | |
A collection of IJobEventFilter objects. | |
The JobExecutionOptions class is used to specify job execution options for the Job.ExecuteJob and JobAgentJoin.ExecuteJob methods. | |
JobGroups are used to organize jobs within adTempus, to visually simplify administration of adTempus. | |
A collection of IJobGroup objects. | |
The JobHistoryFilter class is used in conjunction with the Scheduler.GetObjectsWhere method to return selected job instances. | |
Represents a JobQueue in adTempus. | |
A collection of IJob objects. | |
The JobStatus object contains status information and statistics for a job. | |
Each JobStep object represents a step in the job. | |
A collection of IJobStep objects. | |
| |
| |
A collection of JobVariables. | |
Represents a lock on a client session. | |
The LogEvent class represents log messages written by adTempus. | |
A collection of ILogEvent objects | |
The LogFilter class is used in conjunction with the Scheduler.GetObjectsWhere method to return selected log messages. | |
The MessagingServiceProvider contains the information needed to connect to a notification service provider (such as an SMS service provider). | |
The NetworkConnection class represents network resources that are to be connected by adTempus when the job runs. | |
A NotificationAction is an action that sends e-mail or other notification messages to designated recipients to inform them of the status of a job. | |
The NotificationAddress represents an e-mail address or other target that can receive adTempus notification messages. | |
A collection of INotificationAddress objects. | |
The NotificationGroup is a collection of other notification recipients. | |
A NotificationGroupMember object defines a member of a notification group. | |
A collection of INotificationGroupMember objects. | |
The NotificationIndividual represents a person (or other entity) that can receive notification messages. | |
The NotificationOptions object holds SMTP e-mail notification settings for adTempus. | |
A collection of INotificationRecipient objects. | |
A NotificationTask is a task that sends a notification message. | |
Specifies import settings for an object. | |
A ProcessCondition is a condition that makes a job dependent on the status of an external process. | |
The ProcessTrigger is a trigger that triggers a job based on the state of an external process. | |
The ProgramExecutionTask defines a task that executes a program, batch file, document file, etc. | |
| |
A collection of IQueueAgentJoin objects. | |
The RemoteAgent class represents a remote agent computer that jobs can be targeted to, when distributed scheduling is being used. | |
A collection of IResource objects. | |
The Response class defines how an adTempus job responds to events that occur during execution of a job or step. | |
A collection of IResponse objects | |
Represents a task that shuts down or restarts the computer (referred to as the Computer Shutdown Task in the user guide). | |
The Schedule defines the date(s) and time(s) at which a job should be triggered. | |
The Scheduler class represents a session with adTempus, and provides methods and properties for working with adTempus and its objects. | |
A collection of ISchedule objects. | |
The ScheduleTrigger is a trigger that causes the job to execute at specified dates and times. | |
The Script class represents a script stored in adTempus. | |
The ScriptCondition is a condition that makes execution of the job or step conditional on the outcome of the specified script. | |
The ScriptExecutionTask executes a script. | |
A collection of IScriptLibrary objects. | |
The ScriptLibrary contains a library of code and/or data that can be used by Scripts. | |
A collection of ISecEntity objects. | |
Represents a security user or group | |
Encapsulates the Windows API security descriptor, providing properties and methods to manipulate the security settings for an object. | |
| |
The ServerOption represents a global option setting. | |
The ServerOptions object provides access to various application-wide options used by adTempus. | |
| |
The ServiceControlTask is used to control and monitor services. | |
Contains information about a service installed on the server. | |
A collection of IServiceInfo objects. | |
The SpecifyDaysCriterion allows you to specify dates (or rules for calculating dates) on which the job will be executed. | |
The SpecifyTimeCriterion is used to specify times at which the job will execute. | |
The StartupTrigger causes the job to be executed each time the adTempus service is started. | |
A StringVector is an unordered collection of string values. | |
The TerminateProcessTask terminates a process running outside of adTempus. | |
Specifies an interval (in hours or minutes) at which the job should be executed. | |
A collection of ITrigger objects. | |
The WMITrigger is a trigger that triggers a job based on WMI events. |
|
Name |
Description |
|
The IAction interface is implemented by all Action objects in adTempus. | |
|
A collection of IAction objects. | |
|
The ADError class is used to return error and warning information. | |
|
A collection of IADError objects. | |
|
Represents an access-control entries for a SecurityDescriptor. | |
|
IADIndependentObject is implemented by all objects that are (or can be) independent (see Remarks below). | |
|
The base interface for all data objects in adTempus. | |
|
The IADTObjectCollection interface is the base for for classes that are collections of objects derived from IADTObject. | |
|
This interface is used internally by adTempus. | |
|
A collection of objects that inherit from IADTObject. | |
|
The IADTSecuredObject interface is implemented by objects that can be secured. | |
|
The Application is the top-level object in the adTempus object hierarchy; it provides access to the other objects. | |
|
The CapturedFile class represents a file captured by adTempus due to a File Capture Action. | |
|
A collection of ICapturedFile objects. | |
|
The ComputerMonitor is a trigger that triggers a job based on the response (or lack thereof) from another computer. | |
|
The base interface for Conditions, which place conditions on whether a job or step should be executed. | |
|
A collection of ICondition objects. | |
|
| |
|
The CustomAction allows developers to extend adTempus by adding their own Actions. | |
|
The CustomCondition allows developers to extend adTempus by adding their own conditions. | |
|
The CustomTask allows developers to extend adTempus by adding their own task types. | |
|
The CustomTrigger allows developers to extend adTempus by adding their own triggers. | |
|
The IDateCriterion interface is the base for classes that define the days on which a job should be triggered. | |
|
The DateSchedule holds the information necessary to define a range of days on which a job will execute. | |
|
The DayIntervalCriterion is a DateCriterion that causes a job to execute every x days. | |
|
The DaySpecification defines a day on which a job will execute, by specifying a specific date or a rule to determine the date. | |
|
A collection of IDaySpecification objects. | |
|
An EffectiveSchedule defines a time period when an item (such as a notification recipient) is or is not "effective." For example, in the case of a notification recipient, the EffectiveSchedule specifies a period when the recipient does or does not receive notification messages. | |
|
A collection of IEffectiveSchedule objects. | |
|
Represents an event log on the server. | |
|
The EventLogMonitor is a trigger that runs a job in response to events logged to the system's Event Log. | |
|
A collection of IEventLog objects. | |
|
Represents an event source (a source of Event Log messages) on the server. | |
|
This class is for internal use by adTempus. | |
|
Represents an instance (execution) of the job. | |
|
A collection of IExecutionHistoryItem objects. | |
|
Represents a step in an instance (execution) of the job. | |
|
A collection of IExecutionHistoryStep objects. | |
|
The FileCaptureAction allows a job or step to capture files produced by the job or step. | |
|
The FileCaptureSpec defines a file specification and processing options for a file captured or used by a File Capture Action, Notification Action, or File Trigger. | |
|
A collection of IFileCaptureSpec objects. | |
|
A FileCondition is a Condition that causes a job or step to depend on the presence or absence of a file or files. | |
|
A FileTrigger is a trigger that triggers a job based on the presence, absence, creation, modification, or deletion of specified files. | |
|
Provides information about whether a date is a holiday. | |
|
Contains information about an object imported by the ImportExportFacility. | |
|
A collection of IImportedObject objects. | |
|
The ImportExportFacility allows you to export and import data. | |
|
Specifies object import data and settings for the ImportExportFacility. | |
|
Contains information about the results of an import operation. | |
|
A collection of objects that inherit from IADTIndependentObject. | |
|
Represents an adTempus job. | |
| ||
|
A collection of IJobAgentJoin objects. | |
|
The JobCondition represents a condition that makes a job dependent on the status of another job. | |
|
The JobControlAction is an action that allows a job to control itself or another job. | |
|
The JobEventFilter is used to define an event that triggers a Response. | |
|
A collection of IJobEventFilter objects. | |
|
The JobExecutionOptions class is used to specify job execution options for the Job.ExecuteJob and JobAgentJoin.ExecuteJob methods. | |
|
JobGroups are used to organize jobs within adTempus, to visually simplify administration of adTempus. | |
|
A collection of IJobGroup objects. | |
|
The JobHistoryFilter class is used in conjunction with the Scheduler.GetObjectsWhere method to return selected job instances. | |
|
Represents a JobQueue in adTempus. | |
|
A collection of IJob objects. | |
|
The JobStatus object contains status information and statistics for a job. | |
|
Each JobStep object represents a step in the job. | |
|
A collection of IJobStep objects. | |
|
| |
|
| |
|
A collection of JobVariables. | |
|
Represents a lock on a client session. | |
|
The LogEvent class represents log messages written by adTempus. | |
|
A collection of ILogEvent objects | |
|
The LogFilter class is used in conjunction with the Scheduler.GetObjectsWhere method to return selected log messages. | |
|
The MessagingServiceProvider contains the information needed to connect to a notification service provider (such as an SMS service provider). | |
|
The NetworkConnection class represents network resources that are to be connected by adTempus when the job runs. | |
|
A NotificationAction is an action that sends e-mail or other notification messages to designated recipients to inform them of the status of a job. | |
|
The NotificationAddress represents an e-mail address or other target that can receive adTempus notification messages. | |
|
A collection of INotificationAddress objects. | |
|
The NotificationGroup is a collection of other notification recipients. | |
|
A NotificationGroupMember object defines a member of a notification group. | |
|
A collection of INotificationGroupMember objects. | |
|
The NotificationIndividual represents a person (or other entity) that can receive notification messages. | |
|
The NotificationOptions object holds SMTP e-mail notification settings for adTempus. | |
|
The INotificationRecipient interface is the base for all classes that define entities that can receive notification messages. | |
|
A collection of INotificationRecipient objects. | |
|
A NotificationTask is a task that sends a notification message. | |
|
Specifies import settings for an object. | |
|
Interface implemented by objects that define server-side filtering for object selection. | |
|
Interface implemented by filter objects to perform client-side filtering of objects. | |
|
A ProcessCondition is a condition that makes a job dependent on the status of an external process. | |
|
The ProcessTrigger is a trigger that triggers a job based on the state of an external process. | |
|
The ProgramExecutionTask defines a task that executes a program, batch file, document file, etc. | |
|
The IProvideValidation interface provides a common mechanism for clients to request validation from objects that offer self validation. | |
|
| |
|
A collection of IQueueAgentJoin objects. | |
|
The RemoteAgent class represents a remote agent computer that jobs can be targeted to, when distributed scheduling is being used. | |
|
The IResource interface is the base for all classes that define resources that must be allocated to a job. | |
|
A collection of IResource objects. | |
|
The Response class defines how an adTempus job responds to events that occur during execution of a job or step. | |
|
A collection of IResponse objects | |
|
Represents a task that shuts down or restarts the computer (referred to as the Computer Shutdown Task in the user guide). | |
|
The Schedule defines the date(s) and time(s) at which a job should be triggered. | |
|
The base for classes that define the dates or times at which a job should be triggered. | |
|
The Scheduler class represents a session with adTempus, and provides methods and properties for working with adTempus and its objects. | |
|
A collection of ISchedule objects. | |
|
The ScheduleTrigger is a trigger that causes the job to execute at specified dates and times. | |
|
The Script class represents a script stored in adTempus. | |
| ||
|
The ScriptCondition is a condition that makes execution of the job or step conditional on the outcome of the specified script. | |
|
The ScriptExecutionTask executes a script. | |
|
A collection of IScriptLibrary objects. | |
|
The ScriptLibrary contains a library of code and/or data that can be used by Scripts. | |
|
A collection of ISecEntity objects. | |
|
Represents a security user or group | |
|
Encapsulates the Windows API security descriptor, providing properties and methods to manipulate the security settings for an object. | |
|
| |
|
The ServerOption represents a global option setting. | |
|
The ServerOptions object provides access to various application-wide options used by adTempus. | |
|
| |
|
The ServiceControlTask is used to control and monitor services. | |
|
Contains information about a service installed on the server. | |
|
A collection of IServiceInfo objects. | |
|
The SpecifyDaysCriterion allows you to specify dates (or rules for calculating dates) on which the job will be executed. | |
|
The SpecifyTimeCriterion is used to specify times at which the job will execute. | |
|
The StartupTrigger causes the job to be executed each time the adTempus service is started. | |
|
A StringVector is an unordered collection of string values. | |
|
The ITask interface is the base for all tasks (see the adTempus user guide for more information on tasks). | |
|
The TerminateProcessTask terminates a process running outside of adTempus. | |
|
The ITimeCriterion interface is the base for classes that define the time(s) at which a job should be triggered. | |
|
Specifies an interval (in hours or minutes) at which the job should be executed. | |
|
The ITrigger interface is the base for all trigger classes, which cause a job to execute. | |
|
A collection of ITrigger objects. | |
|
The WMITrigger is a trigger that triggers a job based on WMI events. |
|
Name |
Description |
|
Determines how an ACE for a container object (such as a JobGroup) is inherited by child objects. | |
|
Defines the severity of a message | |
|
Error codes returned by API properties and methods. | |
|
Determines how the job behaves if another instance is already running. | |
|
The available audit events. | |
|
Options used when calling SatisfiesCriteria for various objects | |
|
Defines the class ID (CID) that uniquely identifies a class that implements IADTObject. | |
|
Defines options that determine how a job will be affected if the system clock is changed. | |
|
Options that determine how a computer monitor evaluates a response. | |
|
Specifies the type of a comparison operation | |
|
Options that control the behavior of a ComputerMonitor. | |
|
Indicates the type of monitoring performed by a ComputerMonitor | |
|
Options that determine how a job or step responds to a failed condition. | |
|
Options that control how conditions are evaluated. | |
|
Indicates the status of a client connection to a server. | |
|
Indicates the type of a DaySpecification. | |
|
Specifies the type of a date/time interval. | |
|
Indicates whether an EffectiveSchedule is an include or exclude schedule. | |
|
Defines the Engine Mode of an adTempus server. | |
|
Indicates the type (severity) of a message in the job log. | |
|
Options that control the behavior of an EventLogMonitor | |
|
Specifies the type of threshold type for a JobEventFilter. | |
|
Specifies options that control execution of a job. | |
|
Specifies the type of test that is applied to an exit code. | |
|
For internal use by adTempus. | |
|
Options that control the behavior of a FileCondition. | |
|
Specifies the type of check a File Condition performs. | |
|
Options that control the behavior of a FileTrigger. | |
|
Defines firewall types recognized by notification handlers. | |
|
Defines options used for Job.ClearHistory. | |
|
Specifies the rule that determines how long the history for a job is retained. | |
|
Determines how a ScheduleTrigger will behave if a scheduled execution falls on a holiday | |
|
Indicates the protocol used by an SMS service provider. | |
|
Defines the status of an imported object. | |
|
Defines options that control how a job is distributed to Agents. | |
|
Defines the target instance for a job condition. | |
|
Options that control the behavior of a JobCondition | |
|
Determines the type of a job condition. | |
|
Specifies options that can be used with JobControlActions | |
|
Determines the action that a JobControlAction takes. | |
|
Specifies the event that triggers a response. | |
|
Indicates the status of a job, job step, or instance. | |
|
Used to specify the LogonSessionOptions for a job. | |
|
For internal use by adTempus. | |
|
Defines the level of detail of a message in the message log | |
|
Defines the available messaging service types. | |
|
Indicates the type of a notification address. | |
|
Options that affect the behavior of a NotificationTask. | |
|
Defines the object change types that can be requested using IScheduler::GetObjectChanges. | |
|
Specifies the action that will be taken on an object in an import file. | |
|
Indicates the state of an object being imported. | |
|
Indicates the occurrence type for a DaySpecification. | |
|
Used to specify options for FileCaptureActions and FileCaptureSpecs. | |
|
Options the control the behavior of a ProcessCondition | |
|
Specifies the type of check a Process Condition performs. | |
|
Specifies the priority for an executing process. | |
|
Options that control the behavior of a ProcessTrigger | |
|
Options that define the capabilities of a RemoteAgent. | |
|
Determines how a job behaves if one or more resources cannot be connected or allocated. | |
|
Options that control how a job is restarted if it is missed or abandoned. | |
|
Options that control the behavior of a ScriptCondition | |
|
Indicates the type of a SecEntity. | |
|
Defines the values used for setting and checking permissions for objects. | |
|
Options that control the behavior of a ServiceControlTask | |
|
Specifies the control action that should be performed for a service. | |
|
Options that determine the behavior of a RestartComputerTask. | |
|
Indicates the protocol used by an SMS service provider. | |
|
Options used for SMS providers that use a dial-up connection. | |
|
Defines SMS transmission types. | |
|
Defines miscellaneous special values used by DaySpecifications. | |
|
Determines how steps within the job are executed. | |
|
Defines possible criteria for evaluating the success of a task. | |
|
Defines options used when terminating a job. | |
|
Used to specify the TimeZoneRule for a ScheduleTrigger. | |
|
Defines tri-state boolean values (a value that can be True, False, or Unspecified). | |
|
Indicates the data type of a value. | |
|
Setting for when adTempus considers a process to be started and continues with processing for the step | |
|
Represents the days of the week. | |
|
Determines how the application appears on the desktop. |
adTempus API Reference version 3.0.0.0, revised 10/30/2008
|