SmartBatch 2006 Application Programmatic Interface

StepData Members

StepData overview

Public Instance Constructors

StepData Constructor Default constructor.

Public Instance Properties

AppName An Application Group provides a grouping of objects that you want to manage and secure together. Currently, the Default Application Group is provided. A future release of the product will provide the ability to add and manage additional Application Groups. An Application Group name consist of a combination of letters or numbers up to 32 characters in length.
CompletedDateTime Indicates the last completion date and time for the Step.
ComputerGroup The Computer Group associated with the Step. For no Computer Group, set this property to Util.Msg.DefaultValues.None.
DateTime Reserved for future use.
Description The description for the object. The description consist of a combination of letters or numbers up to 64 characters in length.
Enabled Indicates if the Job is enabled. The Job will only be processed by the Executive Server if it is enabled.
ModDate The date and time that any information pertaining to the object was changed. The value is set by the product in the DataServices assembly.
ModUser The user that last changed any information pertaining to the object. The value is automatically obtained by a custom .NET remoting layer that provides the value of the Windows user/account.
Name The name of the object. The name consist of a combination of letters or numbers up to 32 characters in length.
NewName Reserved for future use.
NextRunDate The next run date and time for the Step.
OperationName Provides a list of StepOperationData objects that represent the Operations in a Step.
ParamList The Parameter List/Group associated with the Step. For no Parameter Group, set this property to Util.Msg.DefaultValues.None.
RestartOperation When executing a Step on demand, this value indicates the name of the Operation in the Step where execution should start.
RestartOperationSeqNbr When executing a Step on demand, this value indicates the name of the sequence number for the Operation in the Step where execution should start.
RunOnce Indicates if the Executive Server should remove the Step from the configuration when the Step completes. If true, the Step will be deleted by the Executive Server after it completes.
SchedName The Schedule Name associated with the Step. If the Step is not scheduled, set this property to Util.Msg.DefaultValues.None.
ScheduleEnabled Indicates if the schedule is enabled.
ScheduleStartTime The start time for the Step.
SeqNbr When processing a Step on demand this is the sequence number associated with the operation name to start with.
StatusCode The last Status Code value associated with the Step. This value is set by the Executive Server.
StepOperations A sortedList of StepOperationData objects that represent the Operations in the Step.

Public Instance Methods

Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object)Gets the Type of the current instance.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

StepData Class | OnLineToolWorks.SmartBatch.Data Namespace