| Contents | Index | JAMS Home | Support |
|
||||
|
| Previous | Contents | Index |
1.4 Setup Definitions
Setup definitions are used to create a specific instance, or view, of a
Job or sequence of Jobs. A JAMS Setup can set up a single job
or a sequence of related jobs.
1.4.1 Setup Name
A Setup Name must be a valid OpenVMS identifier. This means that it
must begin with an alphabetic character and contain only the characters
A-Z, 0-9, $ (dollar sign), and _ (underscore). Also the last character
may not be an underscore.
1.4.2 Description
This is a description of this Setup definition. This description will be used on menus which are presented to a user who is selecting a batch job.
The description consists of two lines. If your description requires
only one line, use the first line.
1.4.3 System
The System I.D. specifies to which System this Setup belongs. This is a required field and must be a System which has already been defined.
To create a Setup definition, you need to have ADD access to Setup
definitions and you must have DEFINE_SETUP access to the System I.D.
specified in this field.
1.4.4 Security
If you select the Security option and you have CONTROL access to the Setup (or the OpenVMS BYPASS privilege), the Setup's Access Control List will be displayed. You can then make modifications to the ACL. The following access rights can be specified:
| Right | Meaning |
|---|---|
| CONTROL | Allows modification of this Setup's Access Control List. |
| CHANGE | Allows modification of this Setup definition provided that the user also has CHANGE access to Setup Definitions. |
| INQUIRE | Allows inquiry into this Setup definition provided that the user also has INQUIRE access to Setup Definitions. |
| DELETE | Allows deletion of this Setup definition provided that the user also has DELETE access to Setup Definitions. |
| SUBMIT | Allows submission of this Setup. |
| DEBUG | Allows submission of this Setup but only if the /DEBUG qualifier is used on the JAMS SUBMIT command. This qualifier will submit the Setup under the users OpenVMS username rather than the OpenVMS username specified in the System Definition. |
| OPERATOR | Allows the user to use the JAMS Job Monitor to hold, reschedule, release or delete an occurrence of this Setup. |
| ABORT_JOBS | Allows the user to use the JAMS Job Monitor to abort or restart an occurrence of this Setup. |
The Submit Options form is used to define the options used when this Setup is submitted. The fields on this screen include:
The Scheduling Priority Modifier field is used to calculate the scheduling priority for this Setup. This number may range from -127 to 127, the default being 0. When a Setup is submitted by the JAMS submit sub-system, the scheduling priority is calculated by adding together the OpenVMS default scheduling priority, the System's priority modifier, the Job's priority modifier and the Setup's priority modifier.
Specifies the retention policy for this Setup. The options are:
| Always | Setup is always retained until specifically deleted. |
| Never | Setup is never retained in the queue. |
| Error | Setup is retained if they complete with a severity of Warning or worse. |
| Timed | Setup is retained for the specified time after completion. |
| Not Specified | Use the default specified in the System Definition. |
This field specifies whether or not this Setup should be placed in a "holding" state when it is submitted.
This is useful for jobs which are requested, or submitted, by end-users but require operator approval before execution.
Suppress Display on Submit Menus
This field specifies whether or not this Setup should be excluded from JAMS Submit menus. If you specify "Yes" here, the Setup will never be displayed on a Submit menu. The only way to submit the Setup is via the JAMS SUBMIT command or automatically by specifying a scheduled date and time and a "Yes" in the Automatic submit field.
This field specifies whether or not the /NOTIFY qualifier is used when submitting this Setup. Note that when /NOTIFY is specified, the username who submitted the job is notified, not the username under which the Setup ran.
You can specify the OpenVMS username under which this Setup should run.
This will override the OpenVMS Username specified in the Setup's System
Definition. You must have either the CMKRNL privilege or SUBMIT access
to the Username which you specify. See the JAMS SET USERNAME command
for information on setting access to Usernames.
1.4.6 Submit Times
This field is used to specify the name of a JAMS Named Time which defines this Setup's Submit Window. You can specify a Named Time or a specific time range but not both.
Setup may be scheduled between
These fields are used to specify a specific Submit Window for this Setup. You can specify a Named Time or a specific time range but not both.
This field specifies the action that JAMS should take if this Setup misses it's time window. Possible actions are:
| No Action | The window is only used to limit the time which can be entered when the Setup is manually submitted. |
| Continue | The Setup will not start until the time window opens but will not be rescheduled or aborted if the window closes before the Setup completes. |
| Abort or Delete | The Setup will not start until the time window opens and will be deleted or aborted is the window closes before the Setup completes. |
| Reschedule or Continue | The Setup will not start until the time window opens. If the Setup has not started when the window closes, it will be rescheduled for the next time that the window opens. If it has started, it will be allowed to continue. |
| Restart or Reschedule | The Setup will not start until the time window opens. If the Setup has not complete when the window closes, it will be rescheduled for the next time the window opens. If the Setup is executing when the window closes it will be aborted and rescheduled. |
Defines whether or not JAMS should perform notification if the Setup misses it's time window.
This field is used to specify a default submit date which is used when this Setup is manually submitted.
This field is used to specify a default submit time which is used when
this Setup is manually submitted.
1.4.7 Schedule Options
Schedule Options are used by JAMS to automatically submit a Setup to run unattended.
This is an English language representation of the date, or dates, on which this Setup is scheduled to run.
You can specify multiple scheduled days by separating the text with commas. For example, "MONDAY,WED,FRIDAY" means that this Setup should be run every Monday, Wednesday and Friday.
Note that the quotations shown in the examples should not be entered in the scheduled date field. For a complete description of English language date representations, refer to Chapter 7 of the JAMS User Guide.
This is an English language representation of a date, or dates, on which this Setup should not be run. If you want to schedule a Setup to run every Monday, except for the last Monday of the month, you would enter "MONDAY" into the Scheduled Date field and "LAST MONDAY OF MONTH" into this field.
This is the time of day when this Setup should be run.
If you want this Setup to run many times during a day, you can specify the delta time between runs and the time of day to stop repeating. Then, any time this Setup completes it will be resubmitted to run hh:mm later. The Setup will be resubmitted no matter what its completion status was or how it was submitted. The only way to stop this repetition is to intentionally delete the Setup from the schedule.
You can specify what time to use as the base for calculating the next run time, the base may be the Scheduled, Start or End time.
Automatic Submit at Scheduled Date and Time
This is a Y (yes) or N (no) field and indicates whether or not this Setup should be automatically submitted at the scheduled date and time.
A N (no) entry indicates that the scheduled date and time are to be used only for management and capacity planning.
This field indicates how this Setup should be scheduled if the day it is scheduled to run falls on a non-workday. There are three options:
S - Schedule the Setup, even on non-workdays.
I - Ignore the Setup, do NOT schedule on non-workdays.
D - Defer the Setup until the next workday.
A Setup can run an unlimited number of Jobs. The Jobs can be any mix of Execution Methods. A single Setup can run Jobs on OpenVMS, Windows NT and UNIX. These Jobs can run simultaneously, or one right after the other.
This is where you specify the individual JAMS Jobs to run within this Setup.
Specifies the Job Name.
Defines the Job's Step within the Setup. The 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 Jobs in that step. This behavior can be modified with the Wait for Completion of this Job before advancing Step field.
Minimum Completion Severity for this Job
Specifies the minimum completion severity for this Job. For a Setup to be considered successful, all of the Jobs in the Setup must complete with a severity which meets their minimum.
Wait for Completion of this Job before advancing Step
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.
Let the Setup Continue if the Job fails
When set to true, if this Job fails the Setup will continue with the next Job in this Setup.
When set to false, if this Job fails the Setup will be halted. No further Jobs will be released. Jobs already released will continue. Manual intervention is required.
Used to specify an override name for this Job.
Used to specify an override description for this Job.
You can override the Submit Times which are specified in the Job Definition.
Each Job in a Setup can have it's own schedule. The Job will execute only when the Setup and Job schedules intersect. The default is to have the same schedule as the Setup so any time the Setup runs, the Job is included in the run.
You can override the Submit Options which are specified in the Job Definition.
A Setup definition also consists of default values for a Job's parameters. You can also modify the attributes of a parameter.
When you select the Parameters option, a list which contains the Job's parameters is displayed. An asterisk next to a Parameter signifies that some of the Parameter's attributes are overridden in this Setup.
A Setup's Parameter definitions are very important when the Setup will be automatically submitted because the default values specified here (or in the Job definition) will be used when the Setup is submitted.
When you select a Parameter, a detail screen will be displayed which shows all of the Parameter fields which may be overridden in a Setup definition. The Job's values are shown in parentheses. If you leave a field blank, the value will be inherited from the Job.
In addition to overriding the defaults from the Job definition, you can specify a Global Name for the Parameter. All parameters in this Setup which have the same Global Name and datatype are combined into a single parameter.
A Setup definition also consists of default values for a Job's Reports.
When you select the Reports option, a list which contains the Job's Reports is displayed. An asterisk next to a Report signifies that some of the Report's attributes are overridden in this Setup.
A Setup's Report definitions are very important when the Setup will be automatically submitted because the default values specified here (or in the Job definition) will be used when the Setup is submitted.
When you select a Report, a detail screen will be displayed which shows all of the Report fields which may be overridden in a Setup definition. The Job's values are shown in parentheses. If you leave a field blank, the value will be inherited from the Job.
Displays the Jobs source code.
You can override the Precheck Job which is specified in the Job Definition.
You can override the Recovery Job which is specified in the Job Definition.
You can override the Notify Names which are specified in the Job Definition.
You can override the Notify Options which are specified in the Job Definition.
Displays the execution statistics from this Job when it it executed as
a part of this Setup.
1.4.9 Resources
The Resources option will display a list of the Resource Requirements which are currently defined for this Setup.
Resource requirements specified in a Setup Definition augment the
Resource Requirements specified in the Setup's System Definition. If
the Setup and System both specify the same Resource, the requirements
are summed.
1.4.10 Dependencies
The Dependencies option is used to define dependencies for this Setup.
For more information on dependency definitions, refer to Section 1.3.10.
1.4.11 Precheck Job
The Precheck Job option is used to define this Setup's Precheck Job. A Precheck Job is used to check for user defined prerequisites for this Job. When a Setup which has a Precheck Job is submitted, it will remain in a pending state until the Precheck Job completes successfully. JAMS will automatically submit the Precheck Job when the main Job is ready to run. By ready to run we mean that the Setup is not held or waiting for a specific time, all of the Setup's Dependencies have been satisfied, and there are sufficient Resources available.
A Precheck Job has four options.
If the Precheck Job is parsed or jacketed then the following predefined parameters are available, and defined as DCL symbols:
| JAMS_TRYAGAIN | The integer value of the status JAMS_TRYAGAIN. |
| JAMS_SCANCELJOB | The integer value of the status JAMS_SCANCELJOB. |
| JAMS_ICANCELJOB | The integer value of the status JAMS_ICANCELJOB. |
| JAMS_WCANCELJOB | The integer value of the status JAMS_WCANCELJOB. |
| JAMS_ECANCELJOB | The integer value of the status JAMS_ECANCELJOB. |
| JAMS_FCANCELJOB | The integer value of the status JAMS_FCANCELJOB. |
| JAMS_CANCELJOB | The integer value of the status JAMS_CANCELJOB. This status is also an E level status and is included for backwards compatibility. |
| JAMS_PRECHECK_ENTRY | The entry number of the Job which this Job is doing the checking for. |
| JAMS_PRECHECK_COUNT | The number of times that the Precheck Job has run for this entry. |
The Recovery Job option is used to define this Setup's Recovery actions. The fields on this form include:
If this Setup completes with a severity which is equal to or worse than the severity specified on this screen, the Recovery Job will be automatically submitted.
The Recovery Job is not submitted if this Job is intentionally aborted.
This is the name of a valid JAMS Job which is to be submitted if this Setup completes with a severity which is equal to or worse than the specified severity.
If the Recovery Job is parsed then the following predefined parameters are available:
| JAMS_RECOVERY_ENTRY | The OpenVMS queue entry number of the Job that failed. |
| JAMS_RECOVERY_JAMS_ENTRY | The JAMS entry number of the Job that failed. |
| JAMS_RECOVERY_JOB_NAME | The JAMS Job name of the Job that failed. |
| JAMS_RECOVERY_JOB_STATUS | The most recent status text set by the failed Job using the JAMS SET STATUS command. |
| JAMS_RECOVERY_LOG_FILENAME | The full file specification of the log file for the job which failed. |
| JAMS_RECOVERY_MAIL_ADR | The list of names which will be notified via OpenVMS Mail. |
| JAMS_RECOVERY_OPER_CLASSES | The list of OPCOM classes which will be notified. |
| JAMS_RECOVERY_PID | The OpenVMS PID of the failed Job. |
| JAMS_RECOVERY_REPLY_USERS | The list of names which will receive a broadcast message. |
| JAMS_RECOVERY_RESTART_COUNT | The number of times the failed job has been restarted. |
| JAMS_RECOVERY_RON | The JAMS run occurrence number of the failed Job. |
| JAMS_RECOVERY_STATUS | The final OpenVMS status of the failed Job. |
| JAMS_RECOVERY_SYSTEM_ID | The JAMS System I.D. of the failed Job. |
The Recovery Instructions option is used to edit or view this Setup's restart/recovery instructions. These instructions are included in the OpenVMS mail message notification messages.
You can also create restart/recovery instructions at the Job and System
level.
1.4.14 Notify Names
The Notify Names screen is used to define who should be notified when this Setup requires notification.
These names can augment or replace the names specified on the Job and System definitions. To remove a name which is specified in the Job or System definition prefix the name with a minus sign. To remove all previous names, enter "-*".
Notification is performed when:
The fields on this category include:
This is a list of OpenVMS Mail addresses, separated by commas. You can also specify logical names which equate to one or more OpenVMS Mail addresses.
This is a list of OpenVMS usernames, separated by commas. You can also specify logical names which equate to one or more OpenVMS usernames.
This is a list of OpenVMS operator classes, separated by commas. You can also specify logical names which equate to one or more OpenVMS operator classes.
Valid OpenVMS operator classes are:
CARDS
CENTRAL
CLUSTER
DEVICES
DISKS
NETWORK
OPER1 through OPER12
PRINTER
SECURITY
TAPES
This is the name of a JAMS Job which should be submitted when notification is required. A Job specified here will override a Job specified in the System definition.
If the Notification Job is parsed then the following predefined parameters are available:
| JAMS_NOTIFY_ENTRY | The OpenVMS queue entry number of the job which caused the notification. |
| JAMS_NOTIFY_JAMS_ENTRY | The JAMS entry number of the job which caused the notification. |
| JAMS_NOTIFY_JOB_NAME | The Job Name of the job which caused the notification. |
| JAMS_NOTIFY_JOB_STATUS | The current Job Status value of the job which caused the notification. |
| JAMS_NOTIFY_LOG_FILENAME | The full file specification of the log file for the job which caused the notification. |
| JAMS_NOTIFY_MAIL_ADR | The list of names which will be notified via OpenVMS Mail. |
| JAMS_NOTIFY_OPER_CLASSES | The list of OPCOM classes will receive an operator message. |
| JAMS_NOTIFY_PID | The process ID of the job which caused the notification. |
| JAMS_NOTIFY_REASON | The reason for the notifications. This parameter could be: COMPLETED, FAILED, SHORT, RUNAWAY, STALLED or MISSED_WINDOW. |
| JAMS_NOTIFY_REPLY_USERS | The list of names which will receive a broadcast message. |
| JAMS_NOTIFY_RON | The JAMS run occurrence number of the job which caused the notification. |
| JAMS_NOTIFY_STATUS | The final status of the job which caused the notification. |
| JAMS_NOTIFY_SUBMITTED_BY | The username which submitted the job which caused the notification. |
| JAMS_NOTIFY_SYSTEM_ID | The JAMS System I.D. of the job which caused the notification. |
Notify options specified in a Setup Definition override those specified in a System Definition.
This field is used to define the minimum completion severity which will cause notification messages to be sent. Setups only have two completion severities, Success and Failure. This field must be "S", "F" or "N" (Never).
The Stalled Time specifies how much time may elapse after the Setup's scheduled time before the it is considered to be stalled. When the Setup is considered stalled, JAMS will perform notification.
The Runaway Setup Elapsed Time specifies how long the Setup may run before it is considered a runaway Setup. This is specified as a delta time. When the Setup is considered runaway, JAMS will perform notification.
The Runaway Setup Elapsed Time Percent specifies how long the Setup may run before it is considered a runaway Setup. This is specified as a percentage of the Setup's average elapsed time. When the Setup is considered runaway, JAMS will perform notification.
The Short Setup Elapsed Time 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 Setup. 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.
The Short Setup Elapsed Time Percent specifies a minimum elapsed time for a Setup as a percentage of it's average elapsed time.
Short Setup Completion Severity
If specified, when a Setup is determined to be a Short
Setup, the completion severity will be changed to the severity
specified here.
1.4.16 Log Options
Log File options specified in a Setup Definition override those specified in a System Definition.
When the field is true, or "Y", batch log files will not be deleted at the completion of the Setup.
When the field is true, or "Y", batch log files will be printed when the Setup completes.
When the field is true, or "Y", batch log files be time stamped with an extension of .LOG_yyyymmdd_hhmmsscc.
You can override the default filename for the log file created when
this Setup runs.
1.4.17 Execution Statistics
The Execution Statistics option displays performance statistics for this Setup. These statistics are updated only if the Setup completes with a severity level of Success or Informational. The screen shows the average, minimum and maximum values for the following statistics:
| Count | The number of times that one or more fields in this column has been updated. |
| Elapsed Time | The total wall clock time from the start of execution to completion. |
| CPU Time | The amount of CPU time used. This is weighted according to the CPU rating established by the logical name JAMS_CPU_RATING. |
| Direct I/O | The number of direct I/O operations performed. |
| Buffered I/O | The number of buffered I/O operations performed. |
| Peak Working Set | The largest number of pages of memory used by this Job at any one time. |
| Page Faults | The total number of hard and soft page faults incurred by this Job. |
| Peak Virtual Pages | The largest number of pages of virtual memory used by this Job at any one time. |
The Completion Dates option shows the date and time of the last time this Job completed with each of the five possible completion severity levels.
If a date and time are all spaces, then the Job has never completed with that severity level.
Also shown is the date and time of the last time that this Setup was automatically submitted by the JAMS_AUTOSUBMIT job.
| Previous | Next | Contents | Index |
 | Copyright © 2000, MVP Systems, Inc. All rights reserved. |