Statements/parameters for IKJTSOxx

ALLOCATE DEFAULT{(OLD)} | {(SHR)}
Allows you to specify the default value for the data sets required by a program. If you do not specify the ALLOCATE parameter, the system defaults to OLD.
AUTHCMD NAMES(cmd1,cmd2...)
Specifies the authorized TSO/E commands. cmd1,cmd2 list the authorized commands. Each name can contain up to eight characters. See SYS1.SAMPLIB for the current list of authorized commands. If you are using VLF and plan to use the TSO/E VLFNOTE command, include VLFNOTE in the active IKJTSOxx member.

For the latest information about the commands, see the list of parmlib members in z/OS V2R1 Program Directory.

AUTHPGM NAMES(pgm1,pgm2...)
Specifies the authorized programs. pgm1,pgm2 list the authorized programs. Each program name can contain up to eight characters.

For the latest information about the programs, see the list of parmlib members in z/OS V2R1 Program Directory.

AUTHTSF NAMES(name1,name2...)
Specifies the APF-authorized programs that may be called through the TSO service facility. The name1,name2 identify the names of the programs. Each name can contain up to eight characters.
Note: Do not place programs from any IBM® products in this table unless the owning product documentation specifically instructs you to do so. For example, do not put IDCAMS in AUTHTSF.

For the latest information about the programs, see the list of parmlib members in z/OS V2R1 Program Directory.

HELP language(dsname1[,dsname2,...])[,language(dsname1[,dsname2,...])]
Specifies message help texts for the specified languages.
language
Specifies the three character language code. See Table 1 for the table of IBM-supported language codes.
dsname
Specifies the name of the data set that contains help text for the specified language. You can specify up to 255 help data sets for each language.

Default: ENU(SYS1.HELP)

LOGON
Specifies the system settings for the TSO/E LOGON command.
LOGONHERE(ON|OFF)
Specifies whether the RECONNECT option on the TSO/E LOGON panel will be honored even when the system does not detect a disconnected state and the user appears to be logged on. This allows users to reconnect their session from a new terminal without canceling their previous session first, similar to how the LOGONHERE option works under z/VM®.

Default: ON

PASSPHRASE(ON|OFF)
Specifies whether the TSO/E logon panel allows users to enter up to 100 characters in the password field. If eight characters or less are entered, the input is treated as a password. If more than eight characters are entered, the input is treated as a passphrase. For more information about activating passphrase support, see z/OS TSO/E Customization.

Default: OFF

VERIFYAPPL(ON|OFF)
Specifies whether TSO/E determines an APPLID for the system the user is logging onto and passes that APPLID to RACF® for verification during TSO/E logon. This option can be used to limit access to different systems that share the same RACF database. For information about setting up APPLIDs in RACF and implementing APPLID verification, see z/OS TSO/E Customization.

Default: OFF

NOTBKGND NAMES(cmd1,cmd2...)
Specifies the commands that may not be issued in the background. cmd1,cmd2 list these commands. Each can contain up to eight characters. SAMPLIB contains the following commands:
CONSOLE
Specifies the installation's defaults for the TSO/E CONSOLE command.
INITUNUM(nnnn)
Specifies the initial number of unsolicited messages that can be queued to the extended MCS console session (established through the CONSOLE command) at any time. This number does not include messages sent by the TPUT service. For information about the TPUT service, see z/OS TSO/E Programming Services.

When the actual number of queued messages reaches 80% of the specified number, installation exit IKJCNX50 is invoked. When the actual number of queued messages reaches the specified number, installation exit IKJCNX64 is invoked. For information about these installation exits, see z/OS TSO/E Customization.

Default: 1000 (decimal)

INITSNUM(nnnn)
Specifies the initial number of solicited messages that can be queued to the extended MCS console session (established through the CONSOLE command) at any time. This number does not include messages sent by the TPUT service. For information about the TPUT service, see z/OS TSO/E Programming Services.

When the actual number of queued messages reaches 80% of the specified number, installation exit IKJCNX50 is invoked. When the actual number of queued messages reaches the specified number, installation exit IKJCNX64 is invoked. For information about these installation exits, see z/OS TSO/E Customization.

Default: 1000 (decimal)

MAXUNUM(nnnnn)
Specifies the maximum number of unsolicited messages that can be queued to the extended MCS console session (established through the CONSOLE command) at any time. The system records this value at initialization time; this value can only be changed through the PARMLIB UPDATE command for active extended MCS console sessions. This number does not include messages sent by the TPUT service. For information about the TPUT service, see z/OS TSO/E Programming Services .

This value is used by console activation processing and is passed to the TSO/E message capacity exits (IKJCNX50 and IKJCNX64).

Default: 10000 (decimal)

MAXSNUM(nnnnn)
Specifies the maximum number of solicited messages that can be queued to the extended MCS console session (established through the CONSOLE command) at any time. The system records this value at initialization time; this value can only be changed through the PARMLIB UPDATE command for active extended MCS console sessions. This number does not include messages sent by the TPUT service. For information about the TPUT service, see z/OS TSO/E Programming Services.

This value is used by console activation processing and is passed to the TSO/E message capacity exits (IKJCNX50 and IKJCNX64).

Default: 10000 (decimal)

PLATCMD{NAMES(cmd1,cmd2...)} | {NONE}
Specifies the commands (cmd1, cmd2,...) that will be executed on the TSO/E command/program invocation platform. These commands do not require task termination processing to clean up for them. Each command can contain up to eight characters. SAMPLIB contains the following commands:

Default: NONE (no commands are eligible to run on the TSO/E command/program invocation platform).

For more information about the TSO/E command/program invocation platform, see z/OS TSO/E Customization .

PLATPGM{NAMES(pgm1,pgm2...)} | {NONE }
Specifies the programs (pgm1, pgm2,...) that are to be run on the TSO/E command/program invocation platform. These programs do not require task termination processing to clean up for them. Each program name can contain up to eight characters. SAMPLIB contains the following programs: IEFBR14 and IKJEFF76.

Default: NONE (no programs are to be run on the command/program invocation platform).

For more information about the TSO/E command/program invocation platform, see z/OS TSO/E Customization. 

TEST     TSOCMD(cmd1,cmd2,cmd3.....)
         SUBCMD((scmd1,load1),(scmd2,load2)...)
The TEST parameter specifies that the following commands are authorized to be executed in a test environment. TSOCMD specifies that the following commands (cmd1,cmd2...) are installation-written TSO/E commands that are allowed to be executed under TEST. SUBCMD specifies that the following installation-written command can be invoked as a subcommand of TEST.

The value for scmd1 is the command. The value for load1 is the entry point for the program to be invoked as the subcommand. For each SUBCMD specified, you must include both the command and the program name for the command.

TRANSREC
TRANSREC allows you to specify the characteristics for the RECEIVE and TRANSMIT commands. 
NODESMF{((nodename1,smfid1),(nodename2,smfid2),...)}
       {((*,*))                                    }
NODESMF specifies the correspondence between the system identifiers and the network node names.

nodename specifies the name of the network node. nodename must be the name of a node defined on the NJERMT JES3 initialization statement or on the NODE(xxxxxxxx) JES2 initialization statement.

The smfid specifies the system identifier for a particular processor, paired with a node-name. smfid must be specified for each nodename. smfid must match the system identifier defined for the processor on the SID parameter of the SMFPRMxx member.

*,* specifies that the nodename is to be retrieved dynamically from JES. This specification is recommended because it eliminates the need to specify static values for nodename and smfid.

Default: (NODENAME, SMF)

Note: If you omit the smfid for the host node, TSO/E uses a value of eight question marks (????????) for the nodename associated with the transmitted data.
SPOOLCL(spoolclass)
Specifies the output class default. Use the SPOOLCL operand class to specify your installation's output class default.

This parameter applies to outgoing data only. Incoming data addressed to the issuer of RECEIVE or to the userid specified on the RECEIVE command by an authorized issuer of RECEIVE is eligible to be received regardless of its sysout class.

Value range: A-Z, 0-9, or *

Default: If you do not specify a different SPOOLCL operand, the default of ‘B’ is used.

CIPHER{(ALWAYS) | (YES) | (NO)}
CIPHER indicates the installation specification for controlling data encryption.

ALWAYS indicates that for every transmission, the data will be automatically encrypted.

YES indicates that encryption is a user option; this is the default.

NO indicates that encryption is not allowed on any transmission. (The specification of NO overrides the specification of the ENCIPHER operand on the TRANSMIT command and does not allow you to provide encryption through the TRANSMIT encryption exits, INMXZ03 or INMXZ03R.)

Default: YES

OUTWARN(n1,n2)
Allows the installation to specify the intervals at which a warning message is issued to a user who is transmitting a large file.

n1 specifies the number of records to be transmitted before the first warning message is issued to the user. The default is 10000 (decimal).

n2 specifies the number of records to be transmitted before second and subsequent warning messages are issued. The subsequent warning messages are issued each time this number of records is transmitted. The default is 5000 (decimal).

If you specify only one value with OUTWARN, the system uses that value as the first interval and uses the default (5000) for the second and subsequent intervals.

OUTLIM(n1)
OUTLIM specifies the maximum number of records a user can transmit before the transmission is terminated.

If n1 is less than or equal to 16777215, the system passes the value to JES as the OUTLIM value. If n1 is greater than 16777215, the system does not pass the value to JES. However, n1 still serves as the limit for the TRANSMIT command. n1 should be greater than zero.

Note: The TRANSMIT command continues to work when the OUTLIM value is exceeded when writing to an OUTDDN or OUTDSN. The NOWARN option in the TRANSMIT command can be used to skip related warning messages. For more information about the NOWARN option, see z/OS TSO/E Customization and z/OS TSO/E Command Reference.
The TSO/E TRANSMIT command produces punched card output. Punched card output is limited by TSO/E or by JES, depending on which limit is lower. If the TSO/E limit is the lowest and is reached, the transmission is terminated and the following message is displayed at the user's terminal: 
INMX032I   TRANSMIT command terminated.  Transmission limit of 'nn'
records exceeded.
If the JES limit is the lowest and is reached, the transmission is (one of the following):
  • Allowed to continue.
  • Abnormally ended.
  • Abnormally ended with a dump.

IBM suggests that you set the TSO/E limit lower than the JES limit to allow the TSO/E user to receive messages that indicate whether the system successfully transmitted the data set.

For additional information about output limits, see:

Default: 30000 (decimal).

VIO(unitname)
VIO specifies the device type on which temporary space can be allocated for use by the TRANSMIT and RECEIVE commands. The unitname is the name of the device type and can be either an esoteric name (SYSDA) or a specific DASD device (for example, 3380).

If you do not specify VIO, the system defaults to the UNIT specification for the user in the UADS. If there is no UNIT specification, the system defaults to an installation-defined default or to the system default, SYSALLDA. (In each of the three preceding situations, IEBCOPY might fail.)

Note: IBM suggests that unitname be a device type that you designated as VIO at IPL. The use of VIO ensures the integrity of sensitive data.
LOGSEL(logselector)
LOGSEL specifies the default middle qualifier for the log data set name. (The name in the :LOGSEL tag in the control section of the NAMES data set takes precedence.) The logselector is 1-8 alphanumeric name of the middle qualifier. The first character must be alphabetic or special (#, @, or $). The names must be separated by a period.
LOGNAME(lognamesuffix)
LOGNAME specifies the default suffix qualifier for the log data set name. The following values take precedence over this parameter:
  • LOGNAME operand of the TRANSMIT command.
  • :LOGNAME tag in the control section of the NAMES data set.
  • :LOGNAME tag in a nickname definition.

The lognamesuffix is the name of the suffix qualifier and must be 1-8 alphanumeric characters, beginning with an alphabetic or special (#, @, or $) character. The names must be separated by a period.

Default: In the absence of any explicit specification, the default log data set name is userid.LOG.MISC.

Maximum Length Restriction: TSO/E prefixes the name of the log data set with the user-specified dsname-prefix from the PROFILE command, so the name is equivalent to prefix.logselector.logname-suffix. The maximum length of the name is 44 characters, including the periods and the prefix.

USRCTL(name)
USRCTL is the name for the NAMES data set. The name must be 1-8 alphanumeric characters beginning with an alphabetic or special (#, @, or $) character. The names must be separated by a period.

Default: In the absence of any explicit specification, the default NAMES data set name is userid.NAMES.TEXT.

Maximum Length Restriction: TSO/E prefixes the name of the NAMES data set with the user-specified dsname-prefix from the PROFILE command. The maximum length of the name is 44 characters, including the periods and the prefix.

SYSCTL(datasetname)
SYSCTL specifies the name of an alternate NAMES data set. You can use this parameter, in conjunction with a routine you write, to provide a global standard set of nicknames within the installation. For example, the routine could manipulate the entries in a directory and store the resulting output — nicknames — in the SYSCTL data set. End users could then use the standard set of nicknames, instead of having to define their own nicknames on an individual basis.

The datasetname identifies the name of the data set and must be 1-8 alphanumeric characters, beginning with an alphabetic or special (#, @, or $) character. The names must be separated by periods. The total characters in the names including the periods cannot exceed 44 characters. TSO/E does not prefix the datasetname.

SYSOUT(sysoutclass | *)
SYSOUT specifies the default SYSOUT class for messages that are written from utility programs, such as IEBCOPY. sysoutclass identifies the sysout class and can be A-Z, 0-9, or asterisk (*).

Default: SYSOUT(*) — the system writes the messages to the terminal.

DAPREFIX(TUPREFIX | USERID)
DAPREFIX specifies how the control and log data sets are to be prefixed for messages written by utility programs, such as IEBCOPY.

TUPREFIX indicates that the control and log data sets are to be prefixed with the PREFIX set in the User Profile Table. If the PROFILE NOPREFIX option is in effect, the log data set is ‘LOG.MISC’ and the control data set is ‘NAMES.TEXT’. TUPREFIX is the default.

USERID indicates that the control and log data sets are to be prefixed with the user ID whenever the PROFILE NOPREFIX option is in effect. This prevents users from logging to ‘LOG.MISC’ and reading ‘NAMES.TEXT’ when PROFILE NOPREFIX is in effect.

SEND
Specifies the installation's defaults for the TSO/E SEND and LISTBC commands, and the OPERATOR SEND command. The defaults are shown here.
OPERSEND(ON| OFF),
OPERSEND specifies whether users who are authorized to use the OPERATOR command can issue the SEND subcommand to send messages or notes. For information about the OPERATOR and SEND commands, see z/OS TSO/E Customization.
USERSEND(ON | OFF),
USERSEND specifies whether users can issue the SEND command to send messages or notes to other terminal users. USERSEND is not valid for the SEND subcommand of the OPERATOR command. Use the OPERSEND parameter to specify whether authorized users of the OPERATOR command can use the SEND subcommand.
SAVE(ON | OFF),
SAVE specifies whether the SEND command processor and the OPERATOR SEND subcommand processor are to save messages in a log that the installation specifies.
USEBROD(ON | OFF)
USEBROD indicates whether messages intended for users who do not have individual user logs are to be stored in the SYS1.BRODCAST data set. (If the installation is not using individual user logs, the system ignores this operand.)

ON indicates that messages are to be stored in the SYS1.BRODCAST data set.

OFF indicates that messages are not to be saved and the user will not receive the messages.

ON is the default.

Table 1 shows how LISTBC and SEND interpret the USEBROD and CHKBROD operands if the installation is using individual user logs. This figure applies to messages only; USEBROD and CHKBROD do not affect the processing of notices.

CHKBROD(ON | OFF)
CHKBROD indicates whether LISTBC processing is to check for messages in the broadcast data set and the user log and retrieve any messages found. LISTBC processing uses CHKBROD only when USEBROD is ON; that is, LISTBC processing ignores the broadcast data set when USEBROD is OFF.

ON indicates that the LISTBC processing is to check both the broadcast data set and the user log.

OFF indicates that the LISTBC processing is to check only the user log for messages.

OFF is the default.
Note:
  1. CHKBROD applies only if you use user logs to store messages. It does not apply if you use only the broadcast data set to store messages. For more information about user logs, see z/OS TSO/E Customization.
  2. If USEBROD is ON and the user log does not exist, LISTBC creates the user log and then checks SYS1.BRODCAST and retrieves any messages found. This checking and retrieval occur regardless of the CHKBROD setting.
LISTBC and SEND processing differ depending on the USEBROD and CHKBROD operands. If LOGNAME is set to 'SYS1.BRODCAST', the following conditions are true:
  • The USEBROD and CHKBROD operands do not affect processing
  • SEND and LISTBC use the broadcast data set for messages.

For the effects of USEBROD and CHKBROD on LISTBC and SEND processing when LOGNAME is not set to 'SYS1.BRODCAST', see Table 1, which assumes the installation is using individual user logs.

Table 1. LISTBC and SEND Results Based on CHKBROD and USEBROD Settings when Installation is Using Individual User Logs
USEBROD ON USEBROD OFF
CHKBROD ON
  • LISTBC:
    • The broadcast data set is always checked for messages, even when a user log exists.
  • SEND:
    • Messages are saved in the broadcast data set when no user log exists.
  • LISTBC:
    • The broadcast data set is not checked for messages.
  • SEND:
    • Messages are not saved in the broadcast data set when no user logs exists. Message IKJ55058I is issued instead.
CHKBROD OFF
  • LISTBC:
    • The broadcast data set is not checked for messages, except when LISTBC creates a new user log or when an existing user log cannot be allocated.
  • SEND:
    • Messages are saved in the broadcast data set when no user log exists.
  • LISTBC:
    • The broadcast data set is not checked for messages.
  • SEND:
    • Messages are not saved in the broadcast data set when no user log exists. Message IKJ55058I is issued instead.
 
BROADCAST (DATASET(data-set-name) VOLUME(volume-name) 
                                TIMEOUT(time-out) switch-prompt)
Identifies the broadcast data set and the processing options to use when switching between broadcast data sets.
data-set-name
Specifies the fully qualified data set name. The use of quotes in the data set name is ignored; that is, ‘SYS3.BRODCAST’ is equal to SYS3.BRODCAST. DATASET is a required sub-keyword.
volume-name
Specifies the volume serial on which the broadcast data set resides. VOLUME is an optional sub-keyword.
time-out
Specifies the number of seconds a switch request will wait for resources before timing out. Valid values for TIMEOUT are integers in the range of 0 to 999, inclusive. TIMEOUT is an optional sub-keyword. The default value is 5 seconds.
switch-prompt
Specifies whether TSO/E should prompt before switching the broadcast data set. Valid values for switch-prompt are PROMPT and NOPROMPT. switch-prompt is an optional sub-keyword. The default value is PROMPT.
Note: When a PARMLIB UPDATE ROUTE command is issued, the switch-prompt setting is valid only when a switch is detected on the system. If no switch is detected, no prompt occurs, regardless of whether the command causes a broadcast data set switch on any systems that the settings are specified. If a separate prompt for each system is needed, consider using the MVS™ ROUTE *ALL,SET IKJTSO=xx command instead.

If the BROADCAST keyword is not specified, the default values are: SYS1.BRODCAST for data-set-name, no volume, five second time-out, and PROMPT for switch-prompt.

The data set must be:
  • Formatted with the TSO/E SYNC command
  • Cataloged or the volume serial must be specified on the BROADCAST keyword.
Note: TSO/E will use the name specified in the BROADCAST keyword or its default. Any entries for the SYSLBC DD name in MSTJCLxx will be disregarded by TSO/E.
MSGPROTECT(ON/OFF)
If you use user logs, use the MSGPROTECT operand to indicate whether the individual user log data set is security protected from the user. Set MSGPROTECT to one of the following values. The default value is OFF.
  • ON — the individual user log is protected from the user and the messages (mail) within the individual user log can be viewed only if the user is logged on with the proper security label.

    If the MSGPROTECT operand is ON, the user log data set name is “logname.userid”, where ‘logname’ is the data set name qualifier you specify on the LOGNAME operand of the SEND PARMLIB parameter and ‘userid’ is the user's TSO/E user ID. This naming convention protects the user log data set from the user when an installation has defined the RACF profile for LOGNAME.* UACC (NONE). Mail in the user log can be viewed by the user if the user is logged on at the proper security label by using the LISTBC command, or by requesting MAIL during LOGON.

    If RACF 1.9 or later is installed and your installation has set up security labels for your users using RACF, and the MSGPROTECT operand is ON, the security label of the sender is stored with the message in the user log data set. When the receiving user issues the LISTBC command to view messages, the security label of the receiving user is checked with the security label stored with the message for each message in the user log. The result of that check determines if LISTBC displays the message(s). If LISTBC does not display a message and the user is authorized at the security label of the message but is not currently logged on at the security label of the message, then the message remains in the user log. The user can log on to TSO/E with the proper security label and view the message at a later time. If LISTBC does not display a message and the user can never log on at the proper security label for the message (user is not authorized by RACF for that security label), the message gets deleted.
    Note: The MSGPROTECT operand should only be used with RACF 1.9 or later. If a lower level of RACF is installed on your system, MSGPROTECT will not protect messages. If you plan to use the MSGPROTECT operand with a lower level of RACF installed, each user log must be allocated by the installation.
  • OFF — users can view their received mail without any security checking by the system.

    If MSGPROTECT is OFF, the user log data set name is “userid.logname,” where ‘userid’ is the user's TSO/E userid and ‘logname’ is the data set name qualifier you specify on the LOGNAME operand. This naming convention allows the user to access the user log data set.

    If MSGPROTECT is OFF, the mail in the user log is not security protected from the user. The user can log on and get the messages by requesting MAIL or by issuing the LISTBC command.

If the MSGPROTECT value is switched from ON to OFF, messages that were left in the individual user logs on one setting cannot be retrieved until the settings are switched back.

Note: IBM suggests that installations create a user catalog and define an alias associated with this user catalog of LOGNAME. This prevents the master catalog from filling up with catalog entries for the new user logs.
LOGNAME(data-set-name/*)
LOGNAME identifies the log name of the data set where the system stores messages and notes.
To store messages (mail) in the broadcast data set, set LOGNAME to *. * is the preferred method to request that the mail be stored in the broadcast data set.
Note: For compatibility, the system accepts the specification of LOGNAME(SYS1.BRODCAST), and the user's mail is stored in the current broadcast data set. The BROADCAST keyword on the SEND statement is used to specify a broadcast data set name other than SYS1.BRODCAST.

To store messages in individual logs, set LOGNAME to the qualifier for the user log data set name. You can also specify a member name in parentheses.

The name of the user log data set depends on the setting of the MSGPROTECT parameter. If MSGPROTECT is off, the user log naming convention is as shown, where userid is the user's TSO/E user ID and LOGNAME is the qualifier you specify on the SEND PARMLIB parameter. 
userid.LOGNAME
If MSGPROTECT is ON, the user log naming convention is 
LOGNAME.userid
For example, suppose you set LOGNAME to ulog.data. If MSGPROTECT is OFF, the user log data set name is: 
userid.ulog.data
If MSGPROTECT is ON, the user log data set name is: 
ulog.data.userid

For more information about user logs, see z/OS TSO/E Customization.

SYSPLEXSHR(ON/OFF)
SYSPLEXSHR indicates whether the broadcast data set is shared outside systems in the sysplex. ON indicates that the broadcast data set is shared only among systems in the sysplex. OFF indicates that the broadcast data set is shared with systems outside the sysplex.
Note: IBM suggests that you set SYSPLEXSHR to the same value in every system's IKJTSOxx member. Doing so avoids confusion in your installation when modifying the the broadcast data set. A system with SYSPLEXSHR set to OFF does not communicate broadcast data set changes to systems with SYSPLEXSHR set to ON.
OPERSEWAIT(ON/OFF)
Indicates whether WAIT or NOWAIT is requested when an OPERATOR SEND command is issued without an explicit WAIT/NOWAIT operand. The default value is ON.
  • ON - indicates you want the OPERATOR SEND command to be issued with WAIT. WAIT on OPERATOR SEND specifies that messages cannot be sent to any specified user until all users can receive them. That is, no user's terminal is busy (no user's output buffers are full).
  • OFF - indicates you want the OPERATOR SEND command to be issued with NOWAIT. NOWAIT on OPERATOR SEND specifies that messages can be sent to any specified user whose terminal is not busy (output buffers not full).
USERLOGSIZE(primary-quantity,secondary-quantity,dir-block)
USERLOGSIZE specifies the amount of space allocated for the USERLOG data set if userlogs are used.

The primary-quantity specifies the number of tracks requested for the primary allocation of the user log data set. The default is 1 track.

The secondary-quantity specifies the number of tracks requested for secondary allocations of the user log. The default is 2 tracks.

The dir-block is an optional parameter that specifies the number of blocks requested for the directory if the user log is a partitioned data set. The default is 20 directory blocks.

Parent topic: IKJTSOxx (TSO/E commands and programs)