Initiate interactive or batch job
Component: | BS2000 |
Functional area: | Job processing |
Domain: | JOB |
Privileges: | all privileges |
Routing code: | @ (only with NBCONOPI=Y) |
Function
With the SET-LOGON-PARAMETERS command, users can initiate an interactive job on the terminal. When SET-LOGON-PARAMETERS is given as the first command in an ENTER file, it initiates a batch job on starting with the ENTER-JOB command.
The specifications in the SET-LOGON-PARAMETERS command identify the user (system access authorization check), characterize the job and control logging of job execution.
The access authorization specifications are checked against the user entry; further specifications relating to the job class and to the job attributes (job/run priority, system resources) are also checked against the entry in the job class definition. The entries are accessible to the user by means of the SHOW-USER-ATTRIBUTES and SHOW-JOB-CLASS commands. If different specifications appear for RUN-PRIORITY and CPU-LIMIT in the user entry and in the job class definition, the value more favorable to the user is permitted.
The operands of the SET-LOGON-PARAMETERS command are evaluated for batch jobs only if the operator starts the job either on the console or with the ENTER-JOB operand DEFAULT-FROM-FILE=*YES. Explicit specifications in the ENTER-JOB command do, however, have priority, i.e. an operand value from /SET-LOGON-PARAMETERS becomes effective only if this operand also has its preset value unchanged in the ENTER-JOB command (see the ENTER-JOB command).
The JOB-PRIORITY, RERUN-AFTER-CRASH, FLUSH-AFTER-SHUTDOWN operands and a SCHEDULING-TIME not equal to *STD are only possible for batch jobs.
Operator functions on physical consoles
If the “Operator LOGON” function is used (incompatible mode; system parameter NBCONOPI=Y), users can authenticate themselves with the SET-LOGON-PARAMETERS command on physical consoles as well. Values may then be specified for the USER-IDENTIFICATION, ACCOUNT and PASSWORD operands only.
Having successfully logged on, the operator still has no authorization to enter commands (apart from a few SHOW commands). This can be obtained with the REQUEST-OPERATOR-ROLE command; SHOW-OPERATOR-ROLE INFORMATION=*ROUTING-CODES indicates which operator roles a user ID is allowed to assume. The operator task is ended either explicitly by an EXIT-JOB command or by the failure of the console. Without authentication through SET-LOGON-PARAMETERS, all that can be entered at physical consoles is the SHOW-PENDING-MSG command to list any unanswered response messages.
Format
SET-LOGON-PARAMETERS | Alias: STLGP | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Operands
USER-IDENTIFICATION = *NO / <name 1..8>
User ID under which the job is to run.
ACCOUNT = *NONE / <alphanum-name 1..8>
Account number of the user ID under which the job is to run.
PASSWORD = *NONE / <c-string 1..8> / <c-string 9..32> / <x-string 1..16> / *SECRET
Password for the user ID.
The long password mechanism is supported (<c-string 9..32>). See the MODIFY-USER-PROTECTION command for details of the long password mechanism.
The PASSWORD operand has the following special characteristics:
The password entered is not logged.
The input field is automatically blanked out in the guided dialog.
In unguided dialog and foreground procedures, the entry *SECRET or ^, SDF provides a blanked out input field for inputting the password.
JOB-CLASS = *STD / <name 1..8>
Job class in which the job is to run. The job class must be permitted for the job type (e.g. interactive job). The user can ascertain the job classes he is allowed to use from his user entry for the home pubset (SHOW-USER-ATTRIBUTES command output). This also displays the default job class that is preset with *STD. Users can obtain information about the characteristics of job classes (job class definition) by means of the SHOW-JOB-CLASS command.
JOB-NAME = *NO / <name 1..8>
The name of the job. The job can be accessed using this name (e.g. using SHOW-JOB-STATUS). All unnamed jobs started from within this job are also assigned this name.
JOB-NAME = *NO
The job is to run without a name of its own.
If there is a non-S label prefixed to the SET-LOGON-PARAMETERS command, the job is given the name of the label.
JOB-NAME = <name 1..8>
Job name.
MONJV = *NONE / <filename 1..54 without-gen-vers>
Specifies whether the job is to be monitored by a JV.
MONJV = *NONE
The job is not monitored.
MONJV = <filename 1..54 without-gen-vers>
Applies only if the JV software product is being used
Name of the JV that is to monitor the job.
Job monitoring is only started if the job is accepted by the system’s job management facility (JOB ACCEPTED).
The job originator must have write authorization because he instructs the system to write to the JV. If the JV is not accessible at the time of command processing, an error message is output to SYSOUT and the command is rejected. If the specified JV does not yet exist, it is - if the requisite authorization exists - created by the system and made available for all users (ACCESS=*WRITE and USER-ACCESS=*ALL-USERS).
Users can address this job via the specified JV (see the “Job Variables” manual [20]):
$S | Job on queue |
$R | Job running |
$T | Job terminated |
$A | Job aborted |
$M | Job exported with MOVE-JOBS |
JV-PASSWORD = *NONE / <c-string 1..4> / <x-string 1..8> / <integer -2147483648..2147483647> / *SECRET
Applies only if the JV software product is being used
Password for the JV.
The operand is only evaluated when job monitoring has been defined (see the MONJV operand). The operand JV-PASSWORD is defined as “secret”:
The password entered is not logged.
The input field is automatically blanked out in the guided dialog.
In unguided dialog and foreground procedures, the entry *SECRET or ^, SDF provides a blanked out input field for inputting the password.
JOB-PRIORITY = *STD / <integer 1..9>
For batch jobs only
Job priority to be given to the batch job. The lower the value, the higher the priority. The values can be queried with the SHOW-USER-ATTRIBUTES and SHOW-JOB-CLASS commands.
JOB-PRIORITY = *STD
The standard priority specified for the job class applies.
RERUN-AFTER-CRASH = *NO / *YES
For batch jobs only
Specifies whether the batch job is to be restarted during the next system session if processing has been aborted as the result of a system error or termination of the system session.
FLUSH-AFTER-SHUTDOWN = *NO / *YES
Specifies whether the batch job is to be removed from the job queue if it has not been processed by the end of the session.
SCHEDULING-TIME = *STD / *PARAMETERS(...) / *BY-CALENDAR(...)
For batch jobs only
Defines how scheduling times are specified for the batch job.
SCHEDULING-TIME = *STD
The default settings for START and REPEAT-JOB scheduling time specifications for the selected job class apply (see the operands of the SCHEDULING-TIME=
*PARAMETERS(...) structure).
SCHEDULING-TIME = *PARAMETERS(...)
Defines a scheduling time (start time) for the batch job. It is also possible to define job repeats (repeat job).
START =
Starting time for the batch job. Values other than *STD are appropriate only if permitted in accordance with the job class definition (see the SHOW-JOB-CLASS command).
START = *STD
The default value for the chosen job class applies.
START = *SOON
The job is to be started as soon as possible, in accordance with its priority.
START = *IMMEDIATELY
The job is to be started immediately.
START = *AT-STREAM-STARTUP
The job is to be started after the next startup of the job scheduler.
START = *WITHIN(...)
The job is to be started within the specified time period.
HOURS = 0 / <integer 0..23 hours >
Number of hours.
MINUTES = 0 / <integer 0..59 minutes >
Number of minutes.
START = *AT(...)
The job is to be started exactly at the time specified in the following.
DATE = *TODAY / <date>
Date. This can be specified in the form [yy]yy-mm-dd. Only the last two digits of the year are evaluated, which means that the century is ignored in four-digit year specifications.
20 is automatically prefixed to two-digit year specifications < 80, 19 to two-digit year specifications >= 80.
TIME = <time>
Time of day in the format hh:mm, where hh = hours and mm = minutes. Seconds are not interpreted.
START = *EARLIEST(...)
The job is to be started no earlier than the time specified.
DATE = *TODAY / <date>
Date. This can be specified in the form [yy]yy-mm-dd. Only the last two digits of the year are evaluated, which means that the century is ignored in four-digit year specifications.
20 is automatically prefixed to two-digit year specifications < 80, 19 to two-digit year specifications >= 80.
TIME = <time>
Time of day in the format hh:mm, where hh = hours and mm = minutes. Seconds are not interpreted.
START = *LATEST(...)
The job is to be started no later than the time specified.
DATE = *TODAY / <date>
Date. This can be specified in the form [yy]yy-mm-dd. Only the last two digits of the year are evaluated, which means that the century is ignored in four-digit year specifications.
20 is automatically prefixed to two-digit year specifications < 80, 19 to two-digit year specifications >= 80.
TIME = <time>
Time of day in the format hh:mm, where hh = hours and mm = minutes. Seconds are not interpreted.
REPEAT-JOB =
Time interval at which the batch job is to be repeated. Values other than *STD are appropriate only if permitted in accordance with the job class definition (see the SHOW-JOB-CLASS command). The time interval for the repetitions depends on the specification in the START operand; see the note in this regard, “Combinations of the START and REPEAT-JOB operands”. For the repetitions, the following applies:
The i-th repetition (i >= 1) of a job is not started until the (i1)th repetition has ended.
Cancellation of the currently executing job (i) has no effect on the start of (i+1); (i >= 0).
Cancellation of the entire job: Both the currently executing job (i) and the subsequent job (i+1) must be canceled, (i >= 0); (CANCEL-JOB command, or make job (i) the last job in the series using the command MODIFY-JOB ...,REPEAT-JOB=*NO).
REPEAT-JOB = *STD
The default value for the chosen job class applies.
REPEAT-JOB = *NO
The batch job is not repeated.
REPEAT-JOB = *DAILY
Daily repetition at the time specified with START.
REPEAT-JOB = *WEEKLY
Weekly repetition at the time specified with START.
REPEAT-JOB = *AT-STREAM-STARTUP
Repetition following each startup of the job scheduler.
REPEAT-JOB = *PERIOD(...)
Repetition after the specified time interval.
HOURS = 0 / <integer 0..23 hours >
Number of hours.
MINUTES = 0 / <integer 0..59 minutes >
Number of minutes.
SCHEDULING-TIME = *BY-CALENDAR(...)
For batch jobs only
The batch job scheduling time and any repeat jobs are specified in the form of a symbolic date defined in a calendar file (calendar job). The entries in a calendar file can be listed with the SHOW-CALENDAR command. Creation of calendar files with the CALENDAR-EDITOR utility is described in the “Calendar” manual [4].
CALENDAR-NAME = <filename 1..54 without-gen-vers>
Name of the calendar file.
SYMBOLIC-DATE = <filename 1..20 without-cat-user-vers> / <partial-filename 2..20 without-cat-user>
Symbolic date which defines the scheduling time and any repetition cycles within the calendar file. The symbolic date may also be given in partially qualified mode. In this way, several scheduling times can be defined for one calendar day with the appropriate definition of SYSDATs.
Example: | Definition of SYMDATs in the calendar file:
A calendar job considering all three scheduling points is started with |
LIMIT = *STD / <integer 1..32767> / *BY-DATE(...)
Governs how long a calendar job remains in existence. This limit applies in addition to the limits set by the calendar.
LIMIT = *STD
The duration of the calendar job depends entirely on the symbolic date entry in the calendar.
LIMIT = <integer 1..32767>
This specification is only permitted for calendar jobs.
Maximum number of repetitions of the calendar job.
When a single job run ends, the run counter is incremented by 1. Then the run counter is checked against the limit. If this is the case, the entire calendar job is terminated.
LIMIT = *BY-DATE(...)
This specification is only permitted for calendar jobs.
After the specified date has been reached, no repeat jobs for the calendar job are started. A repeat which is currently in progress will abort when the date arrives.
The specified date relates only to the calculated starting date for repeat jobs. Overshoots due to rescheduling of postponed repeats or to delays in the job scheduler are allowed. The date specification consists of the day and the time:
DATE = <date>
Date. This can be specified in the form [yy]yy-mm-dd. Only the last two digits of the year are evaluated, which means that the century is ignored in four-digit year specifications. 20 is automatically prefixed to two-digit year specifications < 80, 19 to two-digit year specifications >= 80.
TIME = <time>
Time of day.
RESOURCES = *PARAMETERS(...)
Values for run priority, CPU time and maximum number of SYSLST records.
RUN-PRIORITY = *STD / <integer 30..255>
Run priority which the job is to be assigned. The lower the value, the higher the priority. The maximum permissible priority value is the lesser of the two values (i.e. the more favorable of the values) from the user catalog and the job class definition.
If no maximum value is defined for the job class, the following rules apply:
If the value specified explicitly is numerically lower than the value in the user entry, the message JMS0045 is issued. The batch job is assigned the higher of the two values (i.e. the less favorable value) for the run priority from the user entry and the default run priority for the job class.
If no value is specified explicitly or if *STD is specified explicitly the job is given the default job priority for the job class.
The values can be queried with the SHOW-USER-ATTRIBUTES and SHOW-JOB-CLASS commands.
RUN-PRIORITY = *STD
The standard run priority specified for the job class applies.
CPU-LIMIT = *STD / *NO / <integer 1..32767 seconds >
Maximum CPU time, in seconds, that the batch job may consume. The maximum time permitted depends on the job class specified. See also section "Time limits in BS2000".
CPU-LIMIT = *STD
The default value for the chosen job class applies.
CPU-LIMIT = *NO
Specifies no time limit (NTL) for the job run. This operand value is permitted only if the requisite authorization exists in the user entry or the job class definition.
SYSLST-LIMIT = *STD / *NO / <integer 0..999999>
Specifies the maximum number of records the job is allowed to output to the system files SYSLST, SYSLST01, SYSLST02, ..., SYSLST99 and SYSOUT. The records for SYSOUT are counted separately from the records for SYSLST files. In interactive mode, output records on SYSOUT are only counted if the output is (also) written to a file. In the case of SYSLST, SYSOUT records are not taken into account, even if the setting LISTING=*YES has been made to ensure that they are also written to SYSLST. This value must not be above the limit set in the job class definition. This limit may be queried using the SHOW-JOB-CLASS command.
SYSLST-LIMIT = *STD
The default value for the chosen job class applies. If the specified number is exceeded:
in interactive mode, the user may specify whether the job is to be continued or terminated. If continued, output is repeated up to “number”.
in batch mode, the job is terminated abnormally.
SYSLST-LIMIT = *NO
Sets no limit on the number of records output.
LOGGING = *PARAMETERS(...)
Job logging parameters.
LISTING = *NO / *YES
Specifies whether the job run is also to be logged on SYSLST.
HARDCOPY = *NO / *YES
Specifies whether the dialog job is also to be logged at a hardcopy printer.
JOB-PARAMETER =
Specifies additional attributes for the selected job class - assuming that systems support has defined some and made them known.
JOB-PARAMETER = *NO
No additional attributes.
JOB-PARAMETER = <c-string 1..127>
c-string = sequence of any characters; assigned by systems support to identify additional job class attributes.
PROTECTION = *NONE / *CANCEL
Specifies whether a job is to be protected against being canceled unintentionally with the CANCEL-JOB command.
PROTECTION = *NONE
The job is not protected against unintentional cancellation.
PROTECTION = *CANCEL
The job is not protected against accidental termination. When an interactive job is terminated with the CANCEL-JOB command, the system demands an additional confirmation from the user. Accidental termination of the job due to incorrect specification of the job number should thus be prevented.
Return codes
(SC2) | SC1 | Maincode | Meaning |
|---|---|---|---|
0 | CMD0001 | Command executed | |
64 | JMS0640 | Command rejected |
If SET-LOGON-PARAMETERS is the first command in the dialog (input after connection setup and LOGON prompt) or in an ENTER file, it is rejected in the event of an error (SC1 not 0) and the task aborted. The command return code cannot be evaluated in this case.