SmartBatch 2006 Application Programmatic Interface

OnLineToolWorks.SmartBatch.Data Namespace

Namespace hierarchy

Classes

Class Description
AlertData Defines an Alert List. An Alert List is used to indicate which Operators are notified for Start, Success or Failure of an Operation.
AlertOperatorData Defines an Operator that is contained in an AlertList.
ApplicationData Application Data defines an Application Group to SmartBatch. Currently, the Default Application Group is supported. The ability to manage additional Application Groups will be provided in a future release.
ArchiveData A future version of SmartBatch will provide an archiving capability. This provides a location to save processed output for later retreival.
AuditData This is the abstract base class for most of the classes in this namespace. The purpose is to provide a base set of functionality for the SmartBatch32 Data classes that exist in the database. The serializable constructor allows objects of type AuditData to be remoted.
ComputerGroupComputerData Identifies the computers in a Computer Group.
ComputerGroupData A Computer Group is a list of computers. The Computer Group can be assigned to an Operation. The computer the Operation will run on is determined by the type of Computer Group used.
DependencyData Dependencies are used to determine when certain conditions must be met before the Executive Server can process an object. Several different types of dependencies exist that can be used for different purposes.
FileInfoData Provides the file information for the output file name (application log file) associated with an Operation. The output file is a file that the Operation writes too when the Operation processes. SmartBatch does not write to this file.
HistoryData Summary description for the SmartBatch History -- Log table.
JobData A Job is a sequencing of Steps. Steps in a Job are processed in the order in which they are defined.
JobStepData Identifies a Step that exists within a Job.
NotifyConfigData Defines the gloabl configuration for notification.
NotifyData Summary description for Notification
OperationData An Operation is any program, .NET or COM object to be run. It can have file dependencies, custom dependencies and of course a schedule.
OperatorData An Operator is anyone that needs to be notified of activity (notification event) in SmartBatch.
ParamData Parameters are used in different ways but typically they are used to simplify the configuration. A Parameter can be used to identify values such as paths so that if a location changes you just change the Parameter value once. The Executive Server resolves Parameters at the time objects are run. Builtin Parameters such as date and times are provided.
ParamGroupData A Parameter Group provides for a grouping of Parameters. A Parameter group can be assigned to an Operation, Step or Job to limit the number of Parameters the Executive Server evaluates when processing.
ParamGroupParamData Identifies the Parameters that exist within a Parameter Group.
ProcessInfoData Provides process information.
ProcessModuleData Provides detailed process module information. Represents a .dll that is loaded into a particular process
QueueData The types supported for Queue data (data queued to the ES or RA for Remote Agent processing. This class is internal and should not intended for customer programming use.
RAServerData Provides stats for Remote Agents. Also used by the ES to report its stats.
RequestData Request data for the Remote Agent.
ResponseData The response data provide by the Remote Agent to the Executive Server.
RunbookData Runbook provides the ability to associate documenation for objects in SmartBatch.
ScheduleData Defines a schedule.
ServerData ServerData contains startup values for the Executive Server. This includes the sock port number, database connect info. Information such as the product name and version are provided.
SpecificDateData Identifies dates that are included or excluded from a Schedule.
StatusData The status represents the current activity of the Executive Server. The status maintains: Objects (Operations, Steps and Jobs) that are to process in the current day Objects that are currently processing Objects that have remained in a status that requires operator action from the current or previous day.
StepData A Step is a sequencing of Operations. Operations in a Step are processed in the order in which they are defined.
StepOperationData Identifies an Operation that exists within a Step.
UserObjectAccessData Defines access to objects. Reserved for future use.
UserProfileData Provides configuration settings associted with a SmartBatch user.
UserRoleData Identifies a user role.

Interfaces

Interface Description
IData The interface that each data class must implmenent. Used to obtain polymophic behavior.

Structures

Structure Description
DependencyTypesText The text associated with the dependency types.
FileSettingText The text associated with the FileSetting.
ProcessPriorityText Indicates the Windows priority for an Operation.

Enumerations

Enumeration Description
AccountTypes Identifies an account type.
ActionType The action for the Remote Agent to perform.
ComputerGroupType Identifies the types of Computer Groups supported.
ComputerStatus Indicates the status of a computer to the Executive Server.
DependencyFileCondition Conditions to be used with a File Existence depenedency.
DependencyTypes Indicates the type of dependency.
EditConfirmation Reserved for future use. Identifies when confirmations should be displayed in a user interface.
EmailMessageFormat Identifies the type of email message that is created for notification.
ExitCondition Conditions for the exit processing of an Operation.
FileSetting Indicates for a File Exsistence dependency the file attribute used for comparison.
FlagOption Indicates options provided by the Operation.
HistoryDateSpecifier For listing History records this provides a filter value to determine how to use the date.
HistoryEvents Indicates the event associated with the History record.
HistoryListType Indicates the type of record written to History.
LogLocation Indicates which log to write to when write History records.
LogOption Indicates when to write to History.
NotificationType Identifies the notification type.
NotifyOption Indicates if an Operation notifies on start, success or failure.
ObjectTypes The available objects types.
OnExit The processing that will take place when an error is found on an Operation by the Executive Server.
OperationRunTimeUnit The units for the moreThan and lessThan (run threshold) conditions.
Options Options defines a set of processing options that can be used to alter the behavior of specific values examined by the Executive Server.
ParamTypes The types supported for Parameters
RunOnDateType Indicates if the specific date should be included or excluded from the Schedule/calendar.
ScheduleOnDayOfMonth Schedule day of month values.
ScheduleOnDayOfWeek Identifies the days of the week.
ScheduleRecurringOptions Recurring options for recurring times within a day.
ScheduleRecurringTime Recalculate recurring times based on this value.
ScheduleStartupOptions Restart schedule options that determine how the Executive Server should treat old schedules when the Executive Server is restarted.
ScheduleTypes The type of schedule in ScheduleData.
StatusAction Indicates the action associated with the Status.
StatusCodeValue Defines the available status code values.
UserObjectAccessType Identifies the object type to secure.