JAMS 6.x Help
Submit.Job Class Members
Properties  Methods 


The following tables list the members exposed by Submit.Job.

Public Constructors
 NameDescription
Public ConstructorSubmit.Job ConstructorCreates a new Submit.Job  
Top
Public Properties
 NameDescription
Public PropertyAgentNodeGets or sets the name of the Agent node that will run this job.  
Public PropertyAllowEditSourceGets or sets the AllowSourceEdit property. When set to true, the end-user has access privileges to edit the Job source at submission time.  
Public PropertyAltUserNameGets or sets the alternate username. This is used by some execution methods.  
Public PropertyBatchQueueIDGets or Sets the ID of the Batch Queue the Job should be submitted to.  
Public PropertyBatchQueueNameGets or sets the name of the batch queue that this job will be submitted to.  
Public PropertyDescriptionGets the description of this Job or Setup.  
Public PropertyDetailIDGets the internal Setup Detail ID.  
Public PropertyFolderIDGets the Folder ID of the Folder that this object is a member of.  
Public PropertyFolderNameGet the name of the JAMS Folder that this job belongs to.  
Public PropertyHoldGets or sets the Hold property. When set to true, the entry is held in the schedule until it is manually released.  
Public PropertyInScheduleGets or sets a property that indicates if this job is actually in the schedule for this run.  
Public PropertyJobIDGets the internal ID of the Job.  
Public PropertyKeepLogsGets or sets the KeepLog property. When set to false, the log file is deletes when the job completes.  
Public PropertyLoadedFromGets the JAMS Server that this Submit.Job object was loaded from.  
Public PropertyLogFileGets or sets the LogFile property. When set to false, a log file is not generated for this entry.  
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 PropertyLogLocationGets or sets the location (device/directory) where batch log files should be placed.  
Public PropertyMinimumSeverityGets or sets the MinimumSeverity property. Specifies the minimum completion severity for this Job within a 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 PropertyMissedWindowActionGets or sets the job's missed window action.  
Public PropertyNameGets the name of the Job  
Public PropertyNotifyOfMissedWindowGets or sets the NotifyOfMissedWindow property. When set to true, notification will be performed if this job misses it's schedule window.  
Public PropertyNotifyUserGets or sets the NotifyUser property. If set to true, the user who manually submits the job will be added to the notification list.  
Public PropertyOverrideNameGets or sets the OverrideName for this Job.  
Public PropertyPrecheckIntervalGets or sets the interval between runs of the Job's Precheck job.  
Public PropertyPrecheckJobIDGets the internal ID of this job's Precheck Job  
Public PropertyRequiresSnapshotWhen true, we take a snap shot when inserting the CurJob  
Public PropertyRestartableGets or sets the restartablity of this job. A restartable job can be aborted and restarted.  
Public PropertyRunawayElapsedGets or sets the length of time that this job can run before it is considered a run away job.  
Public PropertyRunPriorityGets or sets the execution priority for this entry.  
Public PropertyScheduleFromTimeGets or sets the beginning of this jobs submit window.  
Public PropertyScheduleToTimeGets or sets the end of this jobs submit window.  
Public PropertyScheduleWindowIDGets the the Schedule Window ID for this Job. This property is designed to be used by JAMS, not user code.  
Public PropertySchedulingPriorityGets or sets the queue scheduling priority for this entry.  
Public PropertyShortElapsedGets or sets 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 PropertyShortSeverityGets or sets the ShortSeverity property. If specified, when a job is determined to be a Short Job, the completion severity will be changed to the severity specified here.  
Public PropertySourceGets or sets this Job's Source.  
Public PropertySourceModifiedTrue when new source has been specified.  
Public PropertyStalledTimeGets or sets the length of time after which, the job is declared stalled if it has not yet started.  
Public PropertyStepGets the step for this Job.  
Public PropertySubmitMethodIDGets the internal ID of the Method used to execute this job.  
Public PropertyTimestampLogsGets or sets the TimestampLogs property. When the field is true, batch log files be time stamped with an extension of .LOG_yyyymmdd_hhmmsscc.  
Public PropertyUserIDGets or sets the ID of the username that this job should run under. Normally, you just set the UserName property and JAMS will retrieve the correct ID.  
Public PropertyUserNameGets or sets the username that this Job should run under. This overrides the username specified in the Job's Folder definition.  
Public PropertyWaitForGets or sets the WaitFor property. When set to true, entries in this Setup that have a higher step than this entry will wait for this entry to complete before they start.  
Top
Public Methods
 NameDescription
Public MethodToStringReturns a string representation of the SetupJob  
Top
See Also

Reference

Submit.Job Class
MVPSI.JAMS Namespace

Send Feedback