The following tables list the members exposed by Setup.
Public Constructors
| Name | Description | |
|---|---|---|
 | Setup Constructor | Creates a new Setup. |
Public Properties
| Name | Description | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
 | ACL | Access Control List | ||||||||||
| AdvanceWarning | Amount of time before an SLA that notification should be sent if the SLA will not be met | ||||||||||
| Alerts | Gets the list of Alerts for this Setup. | ||||||||||
| AlertsModified | Gets a boolean which indicates if the Alerts were modified after the Alert was Loaded. | ||||||||||
| AutoSubmit | Gets or sets the AutoSubmit property. If set to true, this Setup will be automatically submitted based upon it's ScheduleDate and ExceptForDate values. | ||||||||||
| AvgCount | Gets the number of times that the Setup's averages have been updated. | ||||||||||
| AvgElapsedTime | Gets the average elapsed time for this Setup. | ||||||||||
| AvgJobCount | Gets the average number of jobs contained in this Setup. | ||||||||||
| BatchQueue | Gets or sets the JAMS Batch Queue that Jobs within the Setup should be submitted to. | ||||||||||
| BatchQueueID | Gets and Sets the ID of the Batch Queue. | ||||||||||
| BatchQueueName | Gets or sets the batch queue that this setup should be submitted to. This overides the default batch queue that is specified in the setup's folder. | ||||||||||
| DefaultDate | Gets or sets the DefaultDate property, which specifies the default submit date to use when this Setup is manually submitted. | ||||||||||
| DefaultSubmitTime | Gets or sets the default submit time to use when this Setup is manually submitted. | ||||||||||
| DefaultUserName | Gets the default username which will be used if this Setup is automatically submitted and a username isn't specified in the Setup or Folder definition. This name may not be set because it is automatically set to the username of the person who set the Setup to be automatically submitted. | ||||||||||
| Dependencies | Gets the list of Dependencies for this Setup. | ||||||||||
| DependenciesModified | Returns true if the Setup Dependencies have been modified in any given editing session. | ||||||||||
| Description | Gets or sets a description of this Setup | ||||||||||
| Error | Gets an error message that describes the errors in the object. (Inherited from MVPSI.JAMS.BasePublicObject) | ||||||||||
| ExceptForDate | Gets or sets the Setup's exception dates. This is used to specify days when this Setup should not run. You can specify more than one date separated by commas. Use JAMS natural language date specifications. | ||||||||||
| FailShort | Gets 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. | ||||||||||
| 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) | ||||||||||
| 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) | ||||||||||
| Jobs | Gets the list of Jobs for this Setup. | ||||||||||
| JobsModified | Returns true if the Jobs for this Setup have been modified during any given editing session. | ||||||||||
| KeepLogs | Gets or sets the KeepLogs property. When set to true, the Setup's log file is kept upon completion. If specified, this overrides the default in the Setup's Folder definition. | ||||||||||
| LastAutosubmit | Gets the scheduled date and time that this Setup was last automatically submitted for. This is a read-only property, it is updated when JAMS automatically submits the Setup. | ||||||||||
| LastAutosubmitUTC | Gets the scheduled utc date and time that this Setup was last automatically submitted for. This is a read-only property, it is updated when JAMS automatically submits the Setup. | ||||||||||
| LastBad | Gets the date and time of the most recent bad completion of this Setup. | ||||||||||
| LastBadUTC | Gets the UTC date and time of the most recent bad completion of this Setup. | ||||||||||
| LastChange | Gets the date and time when this Setup definition was last changed. | ||||||||||
| LastChangedBy | Gets the user who last changed this Setup. | ||||||||||
| LastChangeUTC | Gets the UTC date and time when this Setup definition was last changed. | ||||||||||
| LastGood | Gets the date and time of the most recent good completion of this Setup. | ||||||||||
| LastGoodUTC | Gets the UTC date and time of the most recent good completion of this Setup. | ||||||||||
| LastReset | Gets the most recent reset date and time. When a setup 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 setup is reset, all of it's dependencies are reset and they must run again. | ||||||||||
| LoadedFrom | Gets the JAMS Server that this Setup was loaded from. | ||||||||||
| LogFilename | Gets or sets the name to be used for the log file when this Setup runs. The default is the name of the Setup with an extension of .log. | ||||||||||
| MaxCount | Gets the number of times that one or more the the Setups maximums has been updated. | ||||||||||
| MaxElapsedTime | Gets the maximum elapsed time for this Setup. | ||||||||||
| MaxJobCount | Gets the maximum number of jobs run by this Setup. | ||||||||||
| MinCount | Gets the number of times that one or more the the Setups minimums has been updated. | ||||||||||
| MinElapsedTime | Gets the minimum elapsed time for this Setup. | ||||||||||
| MinJobCount | Gets the minimum number of jobs run by this Setup. | ||||||||||
| MissedWindowAction | Gets or sets what actions should occur if this Setup misses it's schedule 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 Setup | ||||||||||
| 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 Setup should be handled if one of it's automatically scheduled runs falls on a nonworkday. | ||||||||||
| NotifyEMail | Gets or sets the NotifyEMail property. This is a list of e-mail addresses, separated by commas. If this Setup requires notification, a mail message will be sent to this list of addresses. | ||||||||||
| NotifyJob | Gets or sets a JAMS Job which should be submitted when notification is required. | ||||||||||
| NotifyJobID | Gets and Sets the ID of the notification Setup. This property is designed to be used 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 Setup misses it's schedule window. | ||||||||||
| NotifyOther | Gets or sets the NotifyOther property. This is a list of operator classes, separated by commas. If this Setup requires notification, a message will be sent 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 Setup will be added to the notification list. | ||||||||||
| NotifyUsers | Gets or sets the NotifyUsers property. This is a list of usernames, separated by commas. If this Setup requires notification, a message will be broadcast to these users (if they are logged on at the time.) | ||||||||||
| ParentFolder | Gets or sets the JAMS Folder that this Setup is a member of. | ||||||||||
| ParentFolderID | Gets or sets the ParentFolder ID for this Setup. | ||||||||||
| ParentFolderName | Gets or sets the name of the JAMS ParentFolder that this setup is a member of. | ||||||||||
| PrecheckInterval | Gets or sets the interval between runs of the Setup's Precheck job. | ||||||||||
| PrecheckJob | Gets or sets a JAMS job that will serve as a Precheck job for this Setup. | ||||||||||
| 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 setup | ||||||||||
| RecoverJob | Gets or sets a JAMS job that will serve as a Recovery job for this Setup. | ||||||||||
| 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 | RecoveryInstructions | ||||||||||
| RecoverySeverity | Gets or sets the minimum completion severity that will cause recovery to occur. | ||||||||||
| References | Gets a list of References to this Setup. | ||||||||||
| Requirements | Gets the list of resource requirements for this Setup. | ||||||||||
| RequirementsModified | Returns true if the Setup Requirements have been modified in any given editing session. | ||||||||||
| Restartable | Gets or sets the Restartable property, which specifies the restartablity of this Setup. A restartable Setup can be aborted and restarted. | ||||||||||
| ResubmitBase | Gets or sets the ResubmitBase property, which specifies which time should be used to calculate the resubmit time for a recurring Setup. | ||||||||||
| ResubmitDelay | Gets or sets the delay between runs of a recurring Setup. | ||||||||||
| ResubmitEnd | Gets or sets the time of day that a recurring Setup should stop. | ||||||||||
| ResubmitOnError | Gets or sets the ResubmitOnError property. If set to true, this setup will be automatically resubmitted even when it fails. | ||||||||||
| RetainOption | Gets or sets the retention policy for this Setup. The options are:
Never (N) Error (E) Timed (T)
| ||||||||||
| RetainTime | Gets or sets the length of time the Setup should be retained when the retain option is set to "Timed". | ||||||||||
| RetryCount | Gets or sets the number of times this Setup should be retried if it does not complete successfully the first time. Future functionality - this feature is not implemented in the JAMS Scheduler yet. | ||||||||||
| RetryInterval | Gets or sets the interval that JAMS should use if this Setup should be retried. Future functionality - this feature is not implemented in the JAMS Scheduler yet. | ||||||||||
| RevisionHistory | Get the revision history of a JAMS Setup | ||||||||||
| RunawayAction | Gets or sets the action taken when a setup is declared a runaway | ||||||||||
| RunawayElapsed | Gets or sets the absolute runaway elapsed time. If the setup runs longer than this it is declared a runaway setup and notification will be performed. | ||||||||||
| RunawayElapsedPer | Gets or sets the Runaway Setup Elapsed Time Percent which specifies how long a Setup may run before it is considered a runaway job. This is specified as a percentage of the Setup's average elapsed time. When the Setup is considered runaway, JAMS will perform notification for the Setup. | ||||||||||
| ScheduledDate | Gets or sets the Setup'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 Setup. | ||||||||||
| ScheduledDateStart | Scheduled Start Date for a Setup. | ||||||||||
| ScheduledTime | Gets or sets the Setup's scheduled time, used when the Setup is automatically submitted. | ||||||||||
| ScheduleFromTime | Gets or sets the beginning of this Setup's schedule time window. | ||||||||||
| ScheduleToTime | Gets or sets the ending of this Setup's schedule time window. | ||||||||||
| ScheduleWindow | Gets or sets the Setup's schedule 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 Schedule Window. | ||||||||||
| SchedulingPriorityModifier | Gets or sets the SchedulingPriorityModifier property. This number is used to calculate the scheduling priority for this Setup. When a Setup 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. | ||||||||||
| SetupID | Gets an integer that uniquely identifies this Setup definition. | ||||||||||
| SetupName | Gets or sets the name of the Setup | ||||||||||
| ShortElapsed | Gets or sets the Short Elapsed Time, which specifies a minimum elapsed time for the Setup. If the Setup 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 the Short Setup Elapsed Time Percent which specifies a minimum elapsed time for a Setup. If the Setup completes successfully in less than this amount of time it is considered a Short Job. This is specified as a percentage of the Setup's average elapsed time. When a Setup is determined to be a short Setup, JAMS will perform notification for the Setup and may change the completion severity of the Setup. | ||||||||||
| SLATime | The time of day that a job must be completed by to meet a Service Level Agreement | ||||||||||
| StalledTime | Gets or sets how much time may elapse after a Setup's scheduled time before the Setup is considered to be stalled. When the Setup is considered stalled, JAMS will perform notification. | ||||||||||
| SubmitOnHold | Gets or sets the SubmitOnHold property. When submitted, should this setup be placed on hold until manually released? | ||||||||||
| SuppressMenuDisplay | Gets or sets the SuppressMenuDisplay property. You can prevent this Setup 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. | ||||||||||
| 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) |
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 Setup 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 Setup and all of the attached lists. |
| Clone | Implementation of ICloneable Clone. |
| CompareTo | Implementation of IComparable CompareTo. Compare this instance to the one which is specified. |
| Delete | Overloaded. Delete the Setup definition by Name from the default Server. |
| 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 Setup exists on the default server. |
| ExistsInPath | Test to determine if a Job can be found within the specified Folder's search path. |
| Find | Overloaded. Return a collection of setups contained in the specified folder. |
| ForceModified | Forces the Setup and all of the setup's sub-objects to be marked as modified. |
| GetAccessControl | Overloaded. Gets a SetupSecurity 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 Setup definition from the current JAMS Server. |
| MoveTo | Save the Setup with a new name and/or server and removed the old instance of the Setup. |
| ResetStatistics | Overloaded. Resets the statistics on all matching setups. |
| SaveAs | Save the Setup with a new name and/or server. |
| SetAccessControl | Applies access control list (ACL) entries described by a SetupSecurity 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 Setup. |
| 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. |
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) |
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) |
See Also