JAMS 6.x Help
SetupJob Class Members
Properties  Methods  Events


The following tables list the members exposed by SetupJob.

Public Constructors
 NameDescription
Public ConstructorSetupJob ConstructorOverloaded.   
Top
Public Properties
 NameDescription
Public PropertyAgentNodeGets or Sets the AgentNode for this Job within this Setup. If this job is run on a remote node, this specifies the name of that node.  
Public PropertyAlertsGets the list of Alerts for this Setup.  
Public PropertyAlertsModifiedGets a boolean which indicates if the Alerts were modified after the Alert was Loaded.  
Public PropertyAvgBufferedIOCountGets the average buffered I/O count for this Job within this Setup .  
Public PropertyAvgCountGets the number of times that the averages have been updated for this Job within this Setup.  
Public PropertyAvgCpuTimeGets the average Cpu time consumed by this Job within this Setup.  
Public PropertyAvgDirectIOCountGets the average direct I/O count for this Job within Setup.  
Public PropertyAvgElapsedTimeGets the average elapsed time for this Job within this Setup.  
Public PropertyAvgPageFaultsGets the average number of page faults incurred by this Job within this Setup .  
Public PropertyAvgWorkingSetPeakGets the average peak working set for this Job within this Setup .  
Public PropertyBatchQueueGets or Sets the batch queue that this Job within this Setup should be submitted to. This overides the default batch queue that is specified in the job's definition and/or the job's system definition.  
Public PropertyBatchQueueIDGets and Sets the ID of the Batch Queue.  
Public PropertyBatchQueueNameThe name of the BatchQueue where this Setup Job should be submitted to.  
Public PropertyDescriptionReturns the Override job description if present. If no override is entered, the Job's description is returned.  
Public PropertyDetailIDGets the DetailID for this Job within this Setup. This value is system-generated on Insert. It is a unique number.  
Public PropertyErrorGets an error message that describes the errors in the object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyExceptForDateGets or Sets this Job within this Setup's exception dates. This is used to specify days when this job should not run. You can specify more than one date separated by commas. Use JAMS natural language date specifications.  
Public PropertyFailureActionGet or sets the FailureAction property which indicates the action that Setup should take if the Job is not successful.  
Public PropertyHasErrorsThe HasErrors property can be used to determine if the object has any errors. If the object needs to be validated, it is done before returning. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyInEditIs this object in the middle of an edit? (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyIsRelativeGets or Sets the "Is Relative" property. If set to true, it means Name is a relative path. Otherwise, Name is an absolute path.  
Public PropertyItemReturns any error messages currently associated with this column. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyJobGets or Sets the JAMS Job which this Job is based upon.  
Public PropertyJobDescriptionGets the Description of the Job.  
Public PropertyJobIDGets the internal JobID  
Public PropertyJobNameGets or sets the name of the Job  
Public PropertyLastChangeGets the date and time when the Job with this Setup was last changed.  
Public PropertyLastChangeUTCGets the UTC date and time when the Job with this Setup was last changed.  
Public PropertyLoadedFromGets the JAMS Server that the Job within this Setup was loaded from.  
Public PropertyLogFilenameGets or Sets the file specification that should be used for this job's log files. The default is the job name with an extention of .LOG.  
Public PropertyMaxBufferedIOCountGets the maximum buffered I/O count for this Job within this Setup.  
Public PropertyMaxCountGets the number of times that one or more of the maximums has been updated for this Job within this Setup.  
Public PropertyMaxCpuTimeGets the maximum Cpu time consumed by this Job within this Setup.  
Public PropertyMaxDirectIOCountGets the maximum direct I/O count for this Job within this Setup .  
Public PropertyMaxElapsedTimeGets the maximum elapsed time for this Job within this Setup.  
Public PropertyMaxPageFaultsGets the maximum number of page faults incurred by this Job within this Setup.  
Public PropertyMaxWorkingSetPeakGets the maximum peak working set for this Job within this Setup.  
Public PropertyMinBufferedIOCountGets the minimum buffered I/O count for this Job within this Setup.  
Public PropertyMinCountGets the number of times that one or more of the minimums has been updated for this Job within this Setup.  
Public PropertyMinCpuTimeGets the minimum Cpu time consumed by this Job within this Setup.  
Public PropertyMinDirectIOCountGets the minimum direct I/O count for this Job within this Setup.  
Public PropertyMinElapsedTimeGets the minimum elapsed time for this Job within this Setup.  
Public PropertyMinimumSeverityGets or Sets the MinimumSeverity property. Specifies the minimum completion severity for this Job within this Setup. For a Setup to be considered successful, all of the Jobs in the Setup must complete with a severity which meets their minimum.  
Public PropertyMinPageFaultsGets the minimum number of page faults incurred by this Job within this Setup.  
Public PropertyMinWorkingSetPeakGets the minimum peak working set for this Job within this Setup.  
Public PropertyMissedWindowActionGets or Sets what actions should occur if this Job within this Setup misses it's schedule window.  
Public PropertyModifiedThe Modified property keeps track of modified state of this object. You cannot set the Modified property. If you modify the object, the modified property will be true until you end or cancel the update. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyNameGets the Name of this Job within this setup. If the Override property contains a value, that Override value is returned. Otherwise, the JobName from the Job definition is returned.  
Public PropertyNewObjectThe NewObject property indicates that this object has just been created and has never been saved on a JAMS Server. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyNonWorkdaySchedulingGets or Sets how this Job within this Setup should be handled if one of it's automatically scheduled runs falls on a nonworkday.  
Public PropertyNotifyEMailGets or Sets the list of e-mail addresses, separated by commas. If this Job within this Setup requires notification, a mail message will be sent to this list of addresses.  
Public PropertyNotifyJobGets or Sets a JAMS Job which should be submitted when notification is performed for this Job within this Setup.  
Public PropertyNotifyJobIDGets and Sets the ID of the notification job. This property is designed to be used by JAMS, not user code.  
Public PropertyNotifyJobNameGets or Sets the name of the notification job.  
Public PropertyNotifyJobNameIsRelativeGets or Sets the "Notify Job Name Is Relative" property. If set to true, it means NotifyJobName is a relative path. Otherwise, NotifyJobName is an absolute path.  
Public PropertyNotifyOfMissedWindowGets or Sets the NotifyOfMissedWindow property. When set to true, notification will be performed if this Job within this Setup misses it's schedule window.  
Public PropertyNotifyOtherGets or Sets the NotifyOther property for this Job within this Setup. This property is used as an additional notification method. For OpenVMS based JAMS servers, this is a list of operator classes, separated by commas. If the Job requires notification, a message will be sent to these operator classes.  
Public PropertyNotifySeverityGets or Sets the minimum completion severity that will cause notification to occur for this Job within this Setup.  
Public PropertyNotifyUsersGets or Sets the list of usernames, separated by commas. If this Job within this Setup requires notification, a message will be broadcast to these users (if they are logged on at the time.)  
Public PropertyOverrideDescriptionGets or Sets an override description for this Job within this Setup.  
Public PropertyOverrideNameGets or Sets the OverrideName for this Job within this Setup.  
Public PropertyParametersGets or sets the list of Parameters for this SetupJob.  
Public PropertyParamsModifiedReturns true if the Parameter collection for this Job has been modified during an edit.  
Public PropertyParentListGets the list that this object is contained in.  
Public PropertyPrecheckIntervalGets or Sets the interval between runs of the Precheck job for this Job within this Setup.  
Public PropertyPrecheckJobGets or Set a JAMS Job that will serve as a Precheck Job for this Job within this Setup.  
Public PropertyPrecheckJobIDGets and Sets the ID of the precheck job. This property is designed to be used by JAMS, not user code.  
Public PropertyPrecheckJobNameGets or Sets the name of the Precheck Job.  
Public PropertyPrecheckJobNameIsRelativeGets or Sets the "Precheck Job Name Is Relative" property. If set to true, it means PrecheckJobName is a relative path. Otherwise, PrecheckJobName is an absolute path.  
Public PropertyRecoverJobGets or Sets a JAMS Job that will serve as a Recovery Job for this Job within this Setup.  
Public PropertyRecoverJobIDGets the the Recovery Job ID for this Job in this Setup. This property is designed to be used by JAMS, not user code.  
Public PropertyRecoverJobNameGets or Sets the name of the Recovery Job.  
Public PropertyRecoverJobNameIsRelativeGets or Sets the "Recover Job Name Is Relative" property. If set to true, it means RecoverJobName is a relative path. Otherwise, RecoverJobName is an absolute path.  
Public PropertyRecoverySeverityGets or Sets the minimum completion severity that will cause recovery to occur for this Job within this Setup.  
Public PropertyReportsGets or sets the list of Reports for this SetupJob.  
Public PropertyReportsModifiedReturns true if the Reports collection for this Job had been modified during an edit.  
Public PropertyRetryCountGets or sets the RetryCount which indicates the number of times JAMS should resubmit this Job if it fails the first time.  
Public PropertyRetryIntervalGets or sets the amount of time which should elapse between instances of this Job if RetryCount is set. This feature is not implemented yet.  
Public PropertyRunawayActionGets or sets the action taken when a job is declared a runaway  
Public PropertyRunawayElapsedGets or Sets the absolute runaway elapsed time. If this Job within this setup runs longer than this it is declared a runaway job and notification will be performed.  
Public PropertyRunawayElapsedPerGets or Sets the Runaway Job Elapsed Time Percent. This property specifies how long a job may run before it is considered a runaway job. This is specified as a percentage of the job's average elapsed time. When the job is considered runaway, JAMS will perform notification for this Job within this Setup.  
Public PropertyRunPriorityGets or Sets the RunPriority. The RunPriority specifies the execution priority for this Job.  
Public PropertyScheduledDateGets or Sets this Job's scheduled date. If this is left empty, the Job will run whenever the Setup runs. If specified, the Job will be skipped if this date specification doesn't match the date that the Setup is scheduled to run. You can specify more than one date separated by commas. Use JAMS natural language date specifications.  
Public PropertyScheduleFromTimeGets or Sets the beginning of the schedule time window for this Job.  
Public PropertyScheduleToTimeGets or Sets the ending of the schedule time window for this Job.  
Public PropertyScheduleWindowGets or Sets the Schedule Window, using a JAMS Time definition, for this Job within this Setup.  
Public PropertyScheduleWindowIDGets the the Schedule Window ID for this Setup Job. This property is designed to be used by JAMS, not user code.  
Public PropertyScheduleWindowNameGets or Sets the name of the Schedule Window.  
Public PropertySchedulingPriorityModifierGets or Sets the number used to calculate the scheduling priority for this Job within this Setup. When a Job is submitted by JAMS, the scheduling priority is calculated by adding together the default scheduling priority, the System’s priority modifier, the Job's priority modifier, and this priority modifier.  
Public PropertySetupIDGets the internal SetupID.  
Public PropertyShortElapsedGets or Sets the Short Job Elapsed Time for the Job within this Setup. This property specifies a minimum elapsed time for a job. If the job completes successfully in less than this amount of time it is considered a Short Job. When a job is determined to be a short job, JAMS will perform notification and may change the completion severity.  
Public PropertyShortElapsedPerGets or Sets the Short Job Elapsed Time Percent for this Job within this Setup. This property specifies a minimum elapsed time for a job. If the job completes successfully in less than this amount of time it is considered a Short Job. This is specified as a percentage of the jobs average elapsed time. When a job is determined to be a short job, JAMS will perform notification for the job and may change the completion severity of the job.  
Public PropertyShortSeverityGets or Sets the ShortSeverity property for this Job within this Setup. If specified, and this job is determined to be a Short Job, the completion severity will be changed to the severity specified here.  
Public PropertyStalledTimeGets or Sets how much time may elapse after a job's scheduled time before the Job within this Setup is considered to be stalled. When the job is considered stalled, JAMS will perform notification for the job.  
Public PropertyStepGets or Sets the Job's Step within this Setup. Jobs in a Setup run in step order. All of the Jobs in the lowest numbered step are released. When all of the jobs in a step are complete the Setup will advance to the next higher step and release the Jbs in that step. This behavior can be modified with the "Wait for COmpletion of this Job before advancing Step" property.  
Public PropertySubmitOnHoldGets or Sets a boolean value which indicates if this Job within this Setup should be placed on hold until manually released.  
Public PropertyUserIDGets or Sets the user that this Job within this Setup should run under. This overrides the user specified in the Job's definition and/or the Job's System definition.  
Public PropertyUserNameGets or Sets the user that this Job within this Setup should run under. This overrides the user specified in the Job's definition and/or the Job's System definition.  
Public PropertyUserSecurityGets or Sets the user that this Job within this Setup should run under. This overrides the user specified in the Job's definition and/or the Job's System definition.  
Public PropertyValidatedThe Validated property keeps track of the validation state of this object. If the object has been modified, Validated will be false until the object has been successfully validated by the Validate method. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyWaitForGets or Sets the WaitFor property. When set to true, the Setup will wait for the completion of this Job before advancing to the next step. When set to false, the Setup will advance to the next step even though this Job hasn't completed.  
Top
Public Methods
 NameDescription
Public MethodBeginEditStarts an edit of this object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodCancelEditCancels an edit of this object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodClearErrorClears the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodClearModifiedOverridden. Clear the modified flag of this SetupJob and all of the attached lists.  
Public MethodCloneImplementation of ICloneable Clone.  
Public MethodCompareToImplementation of IComparable CompareTo. Compares this instance to the one specified.  
Public MethodEndEditEnds an edit of this object. Any changes are saved. (Inherited from MVPSI.JAMS.BasePublicObject)
Public Methodstatic (Shared in Visual Basic)FindCreates and loads a new SetupJobList.  
Public MethodInitializeInitializes all Setup Job properties to their default values.  
Public MethodSetErrorSets the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodSetModifiedMarks the object as modified. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodToStringUse this method to retrieve a string representation of this Setup Job.  
Public MethodUndoEditsOverridden. Undo changes that have not been saved to the database.  
Public MethodUpdateOverridden. Save pending updates.  
Public MethodValidateOverloaded. Overridden. Validate all properties.  
Top
Protected Methods
 NameDescription
Protected MethodRaisePropertyChangedAttempts to raise the PropertyChanged event (Inherited from MVPSI.JAMS.BasePublicObject)
Protected MethodRaisePropertyChangingAttempts to raise the PropertyChanging event (Inherited from MVPSI.JAMS.BasePublicObject)
Protected MethodSaveOriginalOverridden. Save the original values incase we have to Undo.  
Top
Public Events
 NameDescription
Public EventPropertyChangedEvent Handler for Property Changed Event (Inherited from MVPSI.JAMS.BasePublicObject)
Public EventPropertyChangingEvent Handler for Property Changing Event (Inherited from MVPSI.JAMS.BasePublicObject)
Top
See Also

Reference

SetupJob Class
MVPSI.JAMS Namespace

Send Feedback