Job Class Members

Gets or sets the batch queue that this job should be submitted to. This overides the default batch queue that is specified in the job's folder definition.

DefaultDate

Gets or sets the default submit date to use when this job is manually submitted.

DefaultSubmitTime

Gets or sets the default submit time to use when this job is manually submitted.

Dependencies

Gets the list of Dependencies for this Job.

DependenciesModified

Gets a boolean which indicates if the Dependencies were modified after the Job was Loaded.

Description

Gets or sets the description of this Job.

Error

Gets an error message that describes the errors in the object. (Inherited from MVPSI.JAMS.BasePublicObject)

ExceptForDate

Gets or sets this job'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.

GoodPattern

A regular expresion that is matched against the job's log file.

HasErrors

The 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)

HomeDirectory

Gets or sets the home directory for this Job.

InEdit

Is this object in the middle of an edit? (Inherited from MVPSI.JAMS.BasePublicObject)

Item

Returns any error messages currently associated with this column. (Inherited from MVPSI.JAMS.BasePublicObject)

JobID

Gets an integer that uniquely identifies this Job definition.

JobName

Gets or sets the name of the Job

KeepLogs

Gets or sets the KeepLogs property. When set to true, the Job's log file is kept upon completion. If specified, this overrides the default in the Job's Folder definition.

Language

Gets the scripting language used by this Job.

LastAutosubmit

Gets the scheduled date and time that this Job was last automatically submitted for. This is a read-only property, it is updated when JAMS automatically submits the Job.

LastAutosubmitUTC

Gets the scheduled UTC date and time that this Job was last automatically submitted for. This is a read-only property, it is updated when JAMS automatically submits the Job.

LastChange

Gets the date and time when this Job definition was last changed.

LastChangedBy

Gets the user who last changed this Job.

LastChangeUTC

Gets the UTC date and time when this Job definition was last changed.

LastError

Gets the date and time of the most recent error completion of this Job.

LastErrorUTC

Gets the UTC date and time of the most recent error completion of this Job.

LastFatal

Gets the date and time of the most recent fatal completion of this Job.

LastFatalUTC

Gets the UTC date and time of the most recent fatal completion of this Job.

LastInfo

Gets the date and time of the most recent informational completion of this Job.

LastInfoUTC

Gets the UTC date and time of the most recent informational completion of this Job.

LastReset

Gets the most recent reset date and time. When a job is reset, all of it's dependencies are reset and they must run again.

LastResetUTC

Gets the most recent reset UTC date and time. When a job is reset, all of it's dependencies are reset and they must run again.

LastSuccess

Gets the date and time of the most recent successful completion of this Job.

LastSuccessUTC

Gets the UTC date and time of the most recent successful completion of this Job.

LastWarning

Gets the date and time of the most recent warning completion of this Job.

LastWarningUTC

Gets the UTC date and time of the most recent warning completion of this Job.

LoadedFrom

Gets the JAMS Server that this Job was loaded from.

LogFilename

Gets 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.

MaxBufferedIOCount

Gets the maximum buffered I/O count for this job.

MaxCount

Gets the number of times that one or more of the job's maximums has been updated.

MaxCpuTime

Gets the maximum Cpu time consumed by this job.

MaxDirectIOCount

Gets the the maximum direct I/O count for this job.

MaxElapsedTime

Gets the maximum elapsed time for this job.

MaxPageFaults

Gets the maximum number of page faults incurred by this job.

MaxWorkingSetPeak

Gets the maximum peak working set for this job.

MinBufferedIOCount

Gets the minimum buffered I/O count for this job.

MinCount

Gets the number of times that one or more of the job's minimums has been updated.

MinCpuTime

Gets the minimum Cpu time consumed by this job.

MinDirectIOCount

Gets the minimum direct I/O count for this job.

MinElapsedTime

Gets the minimum elapsed time for this job.

MinPageFaults

Gets the minimum number of page faults incurred by this job.

MinWorkingSetPeak

Gets the minimum peak working set for this job.

MissedWindowAction

Gets or sets what actions should occur if this job misses it's scheduled window.

Modified

The 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)

Name

Gets or sets the name of the Job

NewObject

The NewObject property indicates that this object has just been created and has never been saved on a JAMS Server. (Inherited from MVPSI.JAMS.BasePublicObject)

NonWorkdayScheduling

Gets or sets how this job should be handled if one of it's automatically scheduled runs falls on a nonworkday.

NotifyEMail

Gets or sets the list of e-mail addresses, separated by commas. If this Job requires notification, a mail message will be sent to this list of addresses.

NotifyJob

Gets or sets the JAMS Job which should be submitted when notification is performed.

NotifyJobID

Gets and Sets the ID of the notification job. This property is designed to be use by JAMS, not user code.

NotifyJobName

Gets or Sets the name of the notification job.

NotifyJobNameIsRelative

Gets 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.

NotifyOfMissedWindow

Gets or sets the NotifyOfMissedWindow property. When set to true, notification will be performed if this job misses it's schedule window.

NotifyOther

Gets or sets the NotifyOther property, which is used to 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.

NotifySeverity

Gets or sets the minimum completion severity that will cause notification to occur.

NotifyUser

Gets or sets the NotifyUser property. If set to true, the user who manually submits the job will be added to the notification list.

NotifyUsers

Gets or sets a list of usernames, separated by commas. If this Job requires notification, a message will be broadcast to these users (if they are logged on at the time.)

Parameters

Gets the list of Parameters for this Job.

ParamsModified

Gets a boolean which indicates if the Parameters were modified after the Job was Loaded.

ParentFolder

Gets or sets the JAMS Folder that this Job is a member of.

ParentFolderID

Gets the Folder ID for this Job. This property is designed to be used by JAMS, not user code.

ParentFolderName

Gets or sets the name of the JAMS Folder that this job is a member of.

PrecheckInterval

Gets or sets the interval between runs of the Job's Precheck job.

PrecheckJob

Gets or sets the JAMS Job that will serve as a Precheck Job for this Job.

PrecheckJobID

Gets and Sets the ID of the precheck job. This property is designed to be used by JAMS, not user code.

PrecheckJobName

Gets or Sets the name of the Precheck Job.

PrecheckJobNameIsRelative

Gets 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.

QualifiedName

Return the full qualified name of the job

RecoverJob

Gets or sets the JAMS Job that will serve as a Recovery Job for this Job.

RecoverJobID

Gets the the Recovery Job ID for this Job. This property is designed to be used by JAMS, not user code.

RecoverJobName

Gets or Sets the name of the Recovery Job.

RecoverJobNameIsRelative

Gets 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.

RecoveryInstructions

RecoverySeverity

Gets or sets the minimum completion severity that will cause recovery to occur.

References

Gets a list of References to this Job.

Reports

Gets the list of Reports for this Job.

ReportsModified

Gets a boolean which indicates if the Reports were modified after the Job was Loaded.

Requirements

Gets the list of Resource Requirements for this Job.

RequirementsModified

Gets a boolean which indicates if the Requirements were modified after the Job was Loaded.

Restartable

Gets or sets the restartablity of this job. A restartable job can be aborted and restarted.

ResubmitBase

Gets or sets the property which specifies which time should be used to calculate the resubmit time for a recurring job.

ResubmitDelay

Gets or sets the delay between runs of a recurring job.

ResubmitEnd

Gets or sets the time of day that a recurring job should stop.

ResubmitOnError

Gets or sets the ResubmitOnError property. If set to true, this job will be automatically resubmitted even when it fails.

RetainOption

Gets or sets the retention policy for this Job. The options are:

Not Specified	The retention policy is taken from the Job's Folder definition.
Always (A)	Job is always retained until specifically deleted.
Never (N)	Never retain job.
Error (E)	Job is retained if it completes with a severity of Warning or worse.
Timed (T)	Job is retained for the specified time after completion.

RetainTime

Gets or sets the length of time the Job should be retained when the retain option is set to "Timed".

RetryCount

Gets or sets the number of times to retry the job if it fails.

RetryInterval

Gets or sets the delay between automatic retries

RevisionHistory

Gets a list of Job version.

RunawayAction

Gets or sets the action taken when a job is declared a runaway

RunawayElapsed

Gets or sets the absolute runaway elapsed time. If the job runs longer than this it is declared a runaway job and notification will be performed.

RunawayElapsedPer

Gets or sets 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 the job.

RunPriority

Gets or sets the execution priority for this job.

ScheduledDate

Gets or sets this job's scheduled date. You can specify more than one date separated by commas. Use JAMS natural language date specifications.

ScheduledDateEnd

Scheduled End Date for a job.

ScheduledDateStart

Scheduled Start Date for a job.

ScheduledTime

Gets or sets the Job's scheduled time, used when the job is automatically submitted.

ScheduleFromTime

Gets or sets the beginning of this job's scheduled time window.

ScheduleToTime

Gets or sets the ending of this job's schedule time window.

ScheduleWindow

Gets or sets the Job's Scheduled Window using a JAMS Time definition.

ScheduleWindowID

Gets the the Schedule Window ID for this Job. This property is designed to be used by JAMS, not user code.

ScheduleWindowName

Gets or Sets the name of the Scheduled Window.

SchedulingPriorityModifier

Gets or sets the SchedulingPriorityModifier property. This number is used to calculate the scheduling priority for this Job. When a Job is submitted by the JAMS submit sub-system, the scheduling priority is calculated by adding together the default scheduling priority, the Folder’s priority modifier and the Job’s priority modifier.

ShortElapsed

Gets 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.

ShortElapsedPer

Gets 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. 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.

ShortSeverity

Gets 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.

SLATime

The time of day that a job must be completed by to meet a Service Level Agreement

Source

Gets or sets the command procedure.

SourceModified

Gets a boolean which indicates if the Source was modified after the Job was Loaded.

SpecificInformational

A comma seperated list of specific informational values. Used when the executions method's ExitCodeHandling is set to SpecificValuesGood or SpecificValuesBad. Matching one of these values will result in a final severity of Informational.

SpecificValues

A comma seperated list of specific values. Used when the execution method's ExitCodeHandling is set to SpecificValuesGood or SpecificValuesBad.

SpecificWarning

A comma seperated list of specific warning values. Used when the execution method's ExitCodeHandling is set to SpecificValuesGood or SpecificValuesBad. Matching one of these values will result in a final severity of Warning.

StalledTime

Gets or sets how much time may elapse after a job's scheduled time before the job is considered to be stalled. When the job is considered stalled, JAMS will perform notification for the job.

SubmitMethod

Gets or Sets the JAMS Submit Method for this Job.

SubmitMethodID

Gets the the Submit Method ID for this Job. This property is designed to be used by JAMS, not user code.

SubmitMethodName

Gets or Sets the name of the Submit Method.

SubmitOnHold

Gets or sets the SubmitOnHold property. When submitted, should this job be placed on hold until manually released?

SuppressMenuDisplay

Gets or sets the SuppressMenuDisplay property. You can prevent this job from being displayed on submit menus by setting this property to true.

TimestampLogs

Gets or sets the TimestampLogs property. When the field is true, batch log files be time stamped with an extension of .LOG_yyyymmdd_hhmmsscc.

TimeZone

Updates or Returns the value of TimeZone

TimeZoneID

A Time Zone ID number. Represents a specific Time Zone in the TimeZoneTable.

TimeZoneName

A Time Zone Name. Represents a specific Time Zone in the TimeZoneTable.

UserID

Gets or sets the user that this Job should run under. This overrides the username specified in the Job's Folder definition.

UserName

Gets or sets the username that this Job should run under. This overrides the username specified in the Job's Folder definition.

UserSecurity

JAMS UserSecurity.

Validated

The 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)

WorkingSetDefault

Gets or sets the default working set for this job. Not currently used.

WorkingSetMax

Gets or sets the maximum working set for this job. Not currently used.

WorkingSetQuota

Gets or sets the working set quota for this job. Not currently used.

Top

Public Methods

	Name	Description
	BeginEdit	Starts an edit of this object. (Inherited from MVPSI.JAMS.BasePublicObject)
	CancelEdit	Cancels an edit of this object. (Inherited from MVPSI.JAMS.BasePublicObject)
	Check	Checks a Job against a JAMS Server.
	ClearError	Clears the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
	ClearModified	Overridden. Clear the modified flag of this Job and all of the attached lists.
	Clone	Clone this Job. Clone always assumes that the new object might be saved on a different JAMS Server so it doesn't copy internal things like IDs.
	CompareTo	Implementation of IComparable CompareTo. Compares this instance to the one specified.
	Delete	Overloaded. Delete the Job definition.
	EndEdit	Ends an edit of this object. Any changes are saved. (Inherited from MVPSI.JAMS.BasePublicObject)
	Equals	Checks for equality.
	Exists	Overloaded. Test to determine if a given Job exists on the default server.
	ExistsInPath	Test to determine if a Job can be found within the specified Folder's search path.
	Find	Overloaded. Returns a collection of jobs matching the given search string.
	ForceModified	Forces the job and all of the jobs's sub-objects to be marked as modified.
	GetAccessControl	Overloaded. Gets a JobSecurity object that encapsulates the access control list (ACL) entries for the Job described by the current Job object.
	GetHashCode	Returns a hashcode.
	Initialize	Initializes all properties to their default values.
	Load	Overloaded. Load a Job definition from the specified JAMS Server.
	MoveTo	Move the job to a different folder, removing it from the old location.
	ResetStatistics	Resets the Job's Statistics
	SaveAs	Save the Job with a new name and/or server.
	SetAccessControl	Applies access control list (ACL) entries described by a JobSecurity object to the Job described by the current Job object.
	SetError	Sets the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
	SetModified	Marks the object as modified. (Inherited from MVPSI.JAMS.BasePublicObject)
	ToString	Returns the string equivalent of this Job.
	UndoEdits	Overridden. Undo changes that have not been saved to the database.
	Update	Overloaded. Save updates to the JAMS Server
	Validate	Overloaded. Overridden. Validate all properties.

Top

Protected Methods

	Name	Description
	RaisePropertyChanged	Attempts to raise the PropertyChanged event (Inherited from MVPSI.JAMS.BasePublicObject)
	RaisePropertyChanging	Attempts to raise the PropertyChanging event (Inherited from MVPSI.JAMS.BasePublicObject)
	SaveOriginal	SaveOriginal is called when an edit is about to begin. You override this method to save the original values. (Inherited from MVPSI.JAMS.BasePublicObject)

Top

Public Events

	Name	Description
	PropertyChanged	Event Handler for Property Changed Event (Inherited from MVPSI.JAMS.BasePublicObject)
	PropertyChanging	Event Handler for Property Changing Event (Inherited from MVPSI.JAMS.BasePublicObject)

Top

Reference

Job Class
MVPSI.JAMS Namespace