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


MVPSI.JAMS Namespace : Submit.Info Class

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

Public Constructors
 NameDescription
Public ConstructorSubmit.Info ConstructorDefault constructor.  
Top
Public Properties
 NameDescription
Public PropertyAfterTimeGets or sets the date and time that this entry is scheduled to start.  
Public PropertyAfterTimeUTCGets or sets the UTC date and time that this entry is scheduled to start.  
Public PropertyBatchQueueIDGets or Sets the BatchQueueID where this Job should run.  
Public PropertyBatchQueueNameGets or sets the batch queue that this job will be submitted to.  
Public PropertyDebugModeGets of sets the DebugMode property. When set to true, this entry is treated as a debug run. A debug run of a job will not satisfy dependencies or fire triggers.  
Public PropertyDescriptionGets the description of this Job or Setup.  
Public PropertyFailShortGets or sets the FailShort property. If set to true, when a Setup is determined to be a Short Setup, the Setup will be treated as if it had failed.  
Public PropertyFolderIDGets the Folder ID of the Folder that this object is a member of.  
Public PropertyFolderNameGets the name of the Folder that this object is a member of.  
Public PropertyHoldGets or sets the Hold property. When set to true, the entry is held in the schedule until it is manually released.  
Public PropertyInitiatorRONThe run occurance number of the entry that submitted this entry.  
Public PropertyJAMSEntryGets the JAMS Entry number of the job after it has been submitted.  
Public PropertyJAMSIdGets the JAMS Id of the job after it has been submitted.  
Public PropertyJobsGets the collection of Jobs in this Setup.  
Public PropertyKeepLogsGets or sets the KeepLogs property. When set to false, the log file is deletes when the job completes.  
Public PropertyLoadedFromGets the JAMS Server that this Submit.Info 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 of the job's log file.  
Public PropertyLogLocationGets or sets the location (device/directory) where batch log files should be placed.  
Public PropertyManageAccessReturns true if the caller had Manage access to the Job or Setup being submitted.  
Public PropertyMissedWindowActionGets or sets the job's missed window action.  
Public PropertyNameGets the name of the Job or Setup  
Public PropertyNoteGets or sets a note that is attached to this entry.  
Public PropertyNotifyOfMissedWindowGets or sets the NotifyMissed property. When set to true, notification is performed if the job misses it's submit window.  
Public PropertyNotifyUserGets or sets the NotifyUser property. When set to true, the user who submitted the job will be notified when it completes.  
Public PropertyOverrideNameGets or sets the OverrideName for this Job.  
Public PropertyParametersGets the parameters for this Job or Setup  
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 PropertyReportsGets the collection of Reports produced by this Job or Setup  
Public PropertyRestartableGets or sets the Restartable property. When set to true, the job can be aborted and restarted. Also, if the system crashes while the job is running, the job will be restarted.  
Public PropertyResultTextGets the result of the submit as a string.  
Public PropertyRetainOptionGets or sets the job's retention option.  
Public PropertyRetainTimeGets or sets the length of time that this entry is retained if the retention option uses a time.  
Public PropertyRONGets the Run Occurance Number of the job after it has been submitted.  
Public PropertyRunawayElapsedGets or sets the length of time that this job can run before it is considered a run away job.  
Public PropertyScheduleFromTimeGets or sets the beginning time of the submit window.  
Public PropertyScheduleToTimeGets or sets the ending time of the submit window.  
Public PropertyScheduleWindowIDGets the internal ID of the Submit window used by this Job or Setup.  
Public PropertySchedulingPriorityGets or sets the scheduling priority for this entry.  
Public PropertySetSymbolsGets or sets the SetSymbols property. When set to true, JAMS will set an environment symbol for each parameters.  
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 PropertyStalledTimeGets or sets the length of time after which, the job is declared stalled if it has not yet started.  
Public PropertySubmitIDGets the internal ID of the object being submitted.  
Public PropertySubmitIsSimpleReturns true if this is a simple submit. Simple submits are either a single Job, or a Setup without a PreCheckJob which has only one Job.  
Public PropertySubmittedByGets the username of the person who submitted the entry.  
Public PropertySubmitTypeGets the type of object being submitted.  
Public PropertySuppressNotifyGets or sets the SuppressNotify property. If true Job completion notification will not occur.  
Public PropertyTestSubmitGets or sets the TestSubmit property. When set to true, the job isn't actually submitted. This is used for testing parameters and job parsing.  
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 PropertyTodaysDateGets or sets the date that is considered "today" when evaluating dates.  
Public PropertyUserIDSets the ID of the username that this Job should run under. Normally, you just set the UserName property and JAMS will retrieve the ID.  
Public PropertyUserNameSets the username that this Job should run under. This overrides the username specified in the Folder, Setup or Job definition.  
Public PropertyUseSymbolsGets or sets the UseSymbols property. When set to true, JAMS will check for an environment symbol to use as the default value of parameters.  
Public PropertyWaitForEntriesGets and ArrayList of JAMS entries that this entry should depend on.  
Top
Public Methods
 NameDescription
Public MethodSubmitFinish a Submit sequence  
Public MethodWaitForEntryCreates a dynamic dependency on the passed in entry number. The job being submitted will not start until the specified entry completes. You can call this multiple times to create multiple dynamic dependencies.  
Top
See Also

Reference

Submit.Info Class
MVPSI.JAMS Namespace

Send Feedback