Table of Contents

Namespace ArcanaDevelopment.adTempus.Shared

Classes

AgentUpdateOptions

Options for updating a Remote Agent

AndNode
Bitmask

Helper functions for working with bitmasks

CertificateValidationException

Exception thrown if the security certificate returned by the server is invalid or untrusted

ChangeLogParameters

Supplies information for creation of an object change log (snapshot and/or audit) entry.

ChangeLogQueryParameters

Supplies parameters for querying the Object Change Log using ArcanaDevelopment.adTempus.Client.Scheduler.QueryChangeLog.

ConnectionClosedException

Exception thrown if an established connection to the adTempus server fails.

ConnectionDescriptor

Reads or writes an adTempus server connection string

ConnectionDescriptor.IdentityInfo

Defines the identity information used for a server connection

Constants

Miscellaneous constants

DataValidationException

Exception thrown if a Save operation fails due to a data validation error

DatabaseConnectionSettings

Settings used to test a database connection for a DatabaseOperationTask using ArcanaDevelopment.adTempus.Client.Scheduler.TestDatabaseConnection.

DatabaseTypes

Constants for database types supported by adTempus

DateTimeHandling

Utilities for working with dates and times

DateTimeRange

Represents a date/time range

Describe

Provides methods to get the user-friendly (display) names for enumeration values and other constants.

DiagnosticSubmissionInformation

For internal use by adTempus

EmailRecipient

Represents an email recipient.

EmailRecipientList

A collection of email recipients

EnumHelpers

Extension methods for working with various enums

EnumSerializer
ErrorMessageCodes

Constants specifying the MessageCode for various error messages

EventLog

Contains information about a Windows Event Log

EventLogSource

Contains information about an Event Log source

EventLogSourceCategory

A category of event supported by an EventLogSource

ExportOptions

Specifies options for exporting data.

ExpressionList
ExpressionNode
ExtensionConfigurationException

Thrown if a custom object or other items requires an extension that is not configured correctly

ExtensionMemberAttribute
ExtensionNotRegisteredException

Thrown if a custom object or other items requires an extension that is not registered on the computer

ExtensionTypeNotFoundException

Exception that is thrown if an extension object is of a type that is not registered on the current computer.

FastTreeGroup

Represents a Job Group

FastTreeItem
FastTreeJob
FeatureInformation

Carries information about an installed feature.

FeatureNames

Constants defining feature names

FeatureNames.Actions
FeatureNames.Conditions
FeatureNames.Tasks
FeatureNames.Triggers
FeatureNotSupportedException

Exception thrown if the client attempts to use a feature that is not supported by the server

FileServiceTypes

Service types used by FileServiceProvider.

FoundFileInfo

Substitute for System.IO.FileInfo so that found file info can be serialized.

HistoryQueryParameters

Parameters used when querying job history

ImportException

Thrown if an exception occurs during import

ImportExportOptions

Specifies options for export and importing data.

ImportFileInformation

Contains information about an import source and its contents.

ImportObjectHeader

Contains information about an object found in an import source.

ImportOptions

Specifies options for importing data.

InstanceQueryParameters

Parameters for querying for job instances.

InternalServerErrorException

Exception thrown when an unexpected internal error occurs in the adTempus server.

InvalidFetchTargetException

Thrown if you attempt to fetch an object that does not support direct retrieval

InvalidImportValueException

Thrown if an import file contains an invalid value

InvalidOperationContextException

Thrown when an ApplicationIntegration client attempts to connect after the session its execution context has ended

InvalidParameterException

Exception thrown for invalid parameters

InvalidSessionException

Exception thrown when the session with the server is no longer valid

JobExecutionTimes

A list of execution times for a job.

JobFetchFilter

Parameters used when fetching jobs

JobLookupInfo

Information returned by a fast job lookup

JobQueryParameters

Parameters used when querying for jobs

JobStatusHelpers

Providers helpers for classifying and describing JobState values.

JobVariableExpander

Utility class to expand variable reference tokens in a string

JobVariableHelper
JunctionNode
LinkedServer

Contains information about a linked (trusted) peer adTempus server

LogQueryParameters

Parameters used when querying for log messages

LogonFailureException

Exception thrown for a logon failure

Message

Represents an error or other message generated by adTempus

MessageCollection

A collection of Messages

MessageException

Base class for exceptions that carry a Message.

MissingDataException

Exception thrown when the server is unable to find expected data

MultipleMatchException

Thrown if an operation matches multiple possible results

NotNode
OID

Object Identifier used to uniquely identify ADTObject objects within adTempus.

ObjectComparer
ObjectImportParameters

Options to control how a particular object is imported.

ObjectNotFoundException

Exception thrown when the requested object cannot be found

ObjectSearchOptions

Options for a search/replace operation

OrNode
OwnerNotFoundException

Exception that is thrown if the owner of an object cannot be found.

PermissionDeniedException

Exception thrown when the caller does not have permission to perform an action.

PermissionHelper

Contains helper methods for working with permissions.

QueueLoadInfo

Information about the workload of an adTempus queue

RangeList<T>

A collection of Range<T> values.

Range<T>

Represents a range of values

ReadOnlyDictionaryWrapper<TKey, TValue>
ReadOnlyDictionary<TKey, TValue>

Read-only dictionary.

ReferentialIntegrityViolationException

Exception thrown for a referential integrity violation

RegistryUtility
ResponseParameters

Contains parameters used for Response evaluation and execution.

ScheduleMatchDate

A scheduled execution time for a job.

ScriptLanguages

Script language name constants

SecurityCertificate

Information about an X.509 certificate

SecurityIdentifier

Wrapper for System.Security.Principal.SecurityIndentifier to make it serializable.

ServerLoadInfo

Information about the workload on an adTempus instance.

ServerNotFoundException

Thrown if a connection cannot be made to an adTempus server because the server cannot be found.

ServiceInfo

Represents a Windows service.

SoftwareUpdateMessage

Contains information about an available software update for adTempus.

StringExtensions
StringUtil

Utilities for working with strings

SupportedResponseEvent

Information about a Response Event supported by an object

TagInformation

Contains information about an object tag.

TokenSearchOptions

Options for searching for job variable and inline function references

UnexpectedErrorException

Exception thrown when an unexpected error occurs.

Utf8StringWriter

Subclass of StringWriter to make sure we use UTF8 encoding for the XML.

ValidationMessageCodes

Constants specifying the MessageCode for various validation-related messages

ValueNotSupportedException

Thrown when an attempt is made to use a value that is not valid for the target adTempus server.

Wait

Constants defining special wait intervals

WellKnownOIDs

List of OIDs of predefined (well-known) objects

WellKnownOIDs.SecurityRoles
WellKnownOIDs.SecurityTemplates

Interfaces

ICollectionReportWriter
IFoundFileInfo

Contains information about files found by a File Trigger

IJobVariable

Interface implemented by job variables

IJobVariableContainer

Interface implemented by a container of IJobVariable

IJobVariableDictionary

A collection of Job Variables keyed by name.

IObjectConfigurationReportWriter

Interface implemented by a class that generates configuration reports for objects

IReadOnlyDictionary<TKey, TValue>
IVariableExpansionProvider

Interface implemented by classes that can expand job variables and function calls in text blocks.

Enums

AgentConnectionOptions

Special options for connections to a Remote Agent.

AgentMatchRule

Specifies which agent(s) a JobTrigger or JobCondition applies to.

AgentSoftwareUpdateStatus

Statuses for Remote Service updating.

AgentUpdateTiming

Specifies when an agent update will be applied

AlreadyRunningBehavior

Determines how the job behaves if another instance is already running.

AuditTypes

The available audit events.

CMResponseMatchOptions

Options that determine how a computer monitor evaluates a response.

CacheUsageOptions

Specifies how cached objects should be handled.

ChangeAuditSetting

Sets the level for change log (audit) and snapshot settings.

CheckOptions

Options used when calling SatisfiesCriteria for various objects

ClassID

Defines the class ID (CID) that identifies the type of an object derived from ADTObject

ClockChangeBehavior

Defines options that determine how a job will be affected if the system clock is changed.

CloudStorageEncryptionAlgorithm

The algorithm used to encrypt files for cloud storage

ComparisonOperator

Specifies the type of a mathematical comparison

ComputerMonitorOptions

Options that control the behavior of a ComputerMonitor.

ComputerMonitorType

Indicates the type of monitoring performed by a ComputerMonitor

ConditionFailureOptions

Options that determine how a job or step responds to a failed condition.

ConditionRule

Options that control how conditions are evaluated.

ConditionState

The status of a job or step condition.

ConnectionDescriptor.IdentityInfo.IdentityType

The type of identity used for the connection

ConnectionSecurityType

Indicates the security type used for a server connection

ConnectionStatus

Indicates the status of a client connection to a server.

ConsoleCaptureOptions

Options for capturing console output

CycleIDType

The method used to generate a Cycle ID

DatabaseImportExportType

Options that determine the format used when importing/exporting data in a DatabaseOperationTask.

DatabaseTaskType

The type of action performed by a DatabaseOperationTask.

DatabaseType

The type of database in use by the adTempus server

DateCriterionType

The type of a DateCriterion

DaySpecificationType

The type of a DaySpecification

DayTimeInterval

Specifies the type of a date/time interval.

DiagnosticReportFormat

The format used for a diagnostic report

DiagnosticReportSegments

The sections to include in a diagnostic report

EffectiveScheduleType

Indicates whether an EffectiveSchedule is an include or exclude schedule.

EmailSaveFormat

The format used when saving an email message

EngineMode

Defines the Engine Mode of an adTempus server.

EnumSerializationFormat
EventLogMessageTypes

Filter values for event severity in an ArcanaDevelopment.adTempus.EventLogMonitor

EventLogMonitorOptions

Options that control the behavior of a EventLogMonitor.

EventThresholdType

Specifies the type of ThresholdType for a ResponseEvent

ExecutionOutcome

Indicates the overall result of an execution.

ExecutionType

Indicates the execution reason for an instance

ExitCodeTestType

Specifies the type of test that is applied to an exit code.

ExportEncryptionType

Specifies the type of encryption used for protecting passwords and other encrypted data in an export.

FileBrowseOptions

Options for file browsing

FileConditionOptions

Options that control the behavior of a FileCondition

FileConditionType

Specifies the type of check a FileCondition performs

FileTriggerOptions

Options that control the behavior of a FileTrigger.

FirewallType

Defines firewall types recognized by notification handlers.

FtpAuthenticationMethod

The authentication method used for an FTP connection

HistoryClearOptions

Defines options used for Job.ClearHistory.

HistoryRetentionOptions

Specifies the rule that determines how long the history for a job is retained.

HoldType

Indicates the hold state job a job

HolidayTreatment

Determines how a ScheduleTrigger will behave if a scheduled execution falls on a holiday

HttpAuthenticationMethod

The authentication method used for an HTTP connection

IMAPAuthenticationType

Indicates the authentication method used for an IMAP connection.

ImportResult

Indicates the state of an object or set of objects after import.

IncludeExcludeType

Determines whether a value will be included or excluded

InstanceQueryParameters.HistorySortOrder

Options for sorting the results

JobAgentOptions

Defines options that control how jobs in a JobQueue are distributed to Agents.

JobConditionInstance

Defines the target instance for a JobCondition

JobConditionOptions

Options that control the behavior of a JobCondition.

JobConditionType

Determines the type of a JobCondition

JobControlActionOptions

Specifies options that can be used with JobControlActions

JobControlActionType

Determines the action that a JobControlAction takes.

JobEvent

Specifies the event that triggers a response.

JobExecutionOptions

Specifies options that control execution of a job.

JobExecutionTaskSuccessRule

Rule that determines when a JobExecutionTask is successful

JobExecutionTaskWaitType

Determines wait rule for a JobExecutionTask

JobMonitorViewFetchOptions

Options for use with ArcanaDevelopment.adTempus.Client.DataContext.GetJobMonitorData

JobState

Indicates the status of a job, job step, or instance.

JobTriggerOptions

Options that control the behavior of a JobTrigger.

JobTriggerTargetOptions

Options that control the behavior of a JobTriggerTarget.

JobTriggerType

The event that causes a JobTrigger to fire

JobVariableOverrideRule

Rule determining whether a Job Variable can be overridden

JobVariableType

The type of a Job Variable

JunctionType
LicenseStatus

Indicates the license status of adTempus or a particular feature.

LogMessageClass
LogQueryParameters.LogMessageSortOrder

Options for sorting the results

LogQueryParameters.MessageSource

Options for filtering on type of message

LoginAuthenticationType

Designates the kind of authentication to use when connecting to the adTempus server.

LoginType

The type of a SecurityLogin

LogonSessionType

For internal use by adTempus.

MailFetchProtocol

Defines the protocol used by a MessagingServiceProvider with service type set to IncomingEmail.

MailProtocol

Defines the protocol used for a mail service

Message.FormatOptions

Options for formatting the message when calling ToString(FormatOptions)

MessageAddressMode

Specifies handling for a notification message with multiple recipient

MessageExceptionType

Indicates the type of the specialized exception. Used to map the generic message exception to the correct type on the client.

MessageRecipientType

Indicates the type of a message recipient.

MessageType

Defines the level of detail of a message in the message log

MessagingServiceType

Defines the available messaging service types.

MissedJobCheckOptions

Options determining whether adTempus checks for missed scheduled executions of jobs when they are released.

NotificationAddressType

Indicates the type of a NotificationAddress.

NotificationRecipientType

The type of a NotificationRecipient.

NotificationTaskOptions

Options that affect the behavior of a NotificationTask.

ObjectChangeType

The type of change for an ObjectChangeLog record.

ObjectFetchOptions

Controls how objects are fetched.

ObjectImportAction

Specifies the action that will be taken on an object in an import file.

ObjectImportState

Indicates the state of an object being imported.

ObjectLinkType

Indicates the type of link for a ObjectLinkInfo.

OccurrenceType

The occurrence type of a DaySpecification

OptionType

Controls the visibility of Option entities.

OptionValueType

Indicates the data type of a server option.

OutputCaptureOptions

Used to specify options for FileCaptureActions and FileCaptureSpecs.

POP3AuthenticationType

Indicates the authentication method used for a POP3 connection.

PostImportAction

Specifies the actions the importer should take after importing data

ProcessConditionOptions

Options that control the behavior of a ProcessCondition.

ProcessConditionType

Specifies the type of check a ProcessCondition performs

ProcessPriority

Specifies the priority for an executing process

ProcessTriggerOptions

Options that control the behavior of a ProcessTrigger.

ProxyType

The type of proxy

QueueState

The state of a queued job instance

RecurrenceStart

Determines the date that a weekly-recurring DaySpecification recurs relative to.

RelativityType

The type of a relative date rule

RemoteAgentOptions

Options that define the capabilities of a RemoteAgent

ResourceFailureAction

Determines how a job behaves if one or more resources cannot be connected or allocated.

RestartOptions

Options that control how a job is restarted if it is missed or abandoned.

SIDNameUse

The type (use) of a SID

SMSNetworkProtocol

Indicates the protocol used by an SMS service provider.

SMSProviderOptions

Options used for SMS providers that use a dial-up connection.

SMTPAuthenticationType

Indicates the authentication method used for an SMTP connection.

ScriptConditionOptions

Options that control the behavior of a ScriptCondition.

ScriptOptions

Options for Scripts.

SearchReplaceType

The type of search/replace operation to perform

SecEntityType

Indicates the type of a SecurityEntity

SecurityInheritanceOptions

Options for security inheritance

SecurityPermission

Defines the values used for setting and checking permissions for objects.

ServiceControlOptions

Options that control the behavior of a ServiceControlTask

ServiceControlType

Specifies the control action that should be performed for a service.

ShutdownOptions

Options that control the behavior of a RestartComputerTask

SpecialMaskValues

Defines miscellaneous special values used by DaySpecifications.

StepExecutionSequence

Determines how steps within the job are executed.

SuccessCriterion

Defines possible criteria for evaluating the success of a task.

TaskExecutionResult

The result of executing a task or operation.

TerminateProcessTaskOptions

Options for a ProcessTerminationTask

TerminationOptions

Defines options used when terminating a job.

TextMatchRule

Rules for matching text

TextTokenType

The type of token reference returned in a TokenFindMatch

TextType

Indicates the format for text.

TimeCriterionType

The type of a TimeCriterion

TimeZoneRule

Used to specify the TimeZoneRule for a ScheduleTrigger.

TriStateBoolean

Defines tri-state boolean values (a value that can be True, False, or Unspecified).

TriggerState

The status of a job trigger.

TrustedServerType

Indicates the type of a Trusted Server

UpdateImportance

Importance of a software update

UserInteractionMode

Specifies the user interaction mode for a job.

VariableUpdateScope

Specifies the level at which the Job Variable will be updated

VariableUpdateType

Specifies the operation to perform on a variable.

WaitOptions

Setting for when adTempus considers a process to be started and continues with processing for the step

Weekday

Represents the days of the week.