Control switches

The exit routine tailors logon processing by using the control switches and other parameters. Either the logon processor or the exit sets the different bits in the control switches parameter.

The control switch bits that the logon processor sets indicate to the exit that certain system conditions exist.
The bits that the exit sets indicate one of two things to the logon processor:
- The exit is returning a value in a specific parameter
- The logon processor needs to take some action.

Certain control switch bits that the exit can set relate directly to parameters in which the exit provides information. If the exit returns a value to the logon processor in a particular parameter, it must also set the corresponding control switch bit on. For example, if the exit routine provides its own JCL, it returns the JCL statements to the logon processor in the JCL parameter and sets the JCL control switch bit on.

Table 1 shows the control switch bits that the logon exits must set on if they return data in a particular parameter.

Table 1. Control switch bits the logon pre-prompt exit sets
Parameter	Control switch bit
Input buffer	No control switch bit is required
User ID	Don't Prompt bit
Password	Don't Prompt bit
Account number	Don't Prompt bit
Procedure name	Don't Prompt bit
Region size	Don't Prompt bit
JCL statements	JCL bit
New password	Don't Prompt bit
System attributes	System Attributes bit, or Don't Prompt and No UADS bits.
User attributes	User Attributes bit, or Don't Prompt and No UADS bits.
Generic unit	Generic Unit bit, or Don't Prompt and No UADS bits.
UPT	UPT bit, or Don't Prompt and No UADS bits.
ECT	No control switch bit is required
Performance group	Don't Prompt bit
Default SYSOUT destination	Destination bit
Group	Don't Prompt bit

Table 2 shows additional parameters for IKJEFLD1 only, with the control switch bits that IKJEFLD1 must set on if it returns data in those parameters.

Table 2. Additional control switch bits that logon pre-prompt exit IKJEFLD1 sets
Parameter (IKJEFLD1 only)	Control switch bit (IKJEFLD1 only)
Submit Hold Class	Submit Hold Class bit
Submit Class	Submit Class bit
Submit Message Class	Submit Message Class bit
SYSOUT Class	SYSOUT Class bit
First Command	First Command bit
RBA	RBA bit
SECLABEL	SECLABEL bit
Console Profile	Console Profile bit
Primary Language	Primary Language bit
Secondary Language	Secondary Language bit

Table 3 shows the control switch bit configuration.

Table 3. IKJEFLD and IKJEFLD1 control switch bit configuration
Byte	Bit	Field name	Set by
0	0	User ID ENQ Failed	Logon processor
	1	Don't issue RACINIT	IKJEFLD1
	2	Resource Failure	Logon processor
	3	Disconnect	IKJEFLD, IKJEFLD1
	4	Don't Prompt	IKJEFLD, IKJEFLD1
	5	No UADS	IKJEFLD, IKJEFLD1
	6	JCL	IKJEFLD, IKJEFLD1
	7	No UADSE	IKJEFLD, IKJEFLD1
1	0	System Attributes	IKJEFLD, IKJEFLD1
	1	User Attributes	IKJEFLD, IKJEFLD1
	2	Generic Unit	IKJEFLD, IKJEFLD1
	3	UPT	IKJEFLD, IKJEFLD1
	4	Don't ENQ User ID	IKJEFLD, IKJEFLD1
	5	Destination	IKJEFLD, IKJEFLD1
	6	ABEND	Logon processor
	7	Reconnect	IKJEFLD, IKJEFLD1
2	0	Mail	IKJEFLD, IKJEFLD1
	1	Notices	IKJEFLD, IKJEFLD1
	2	No Full-Screen Panel	IKJEFLD, IKJEFLD1
	3	Store Password in TSB	IKJEFLD, IKJEFLD1
	4	SUBMIT Hold Class	IKJEFLD1
	5	SUBMIT Class	IKJEFLD1
	6	SUBMIT Message Class	IKJEFLD1
	7	SYSOUT Class	IKJEFLD1
3	0	First Command	IKJEFLD1
	1	RBA	IKJEFLD1
	2	SECLABEL	IKJEFLD1
	3	Console Profile	IKJEFLD1
	4	Primary Language	IKJEFLD1
	5	Secondary Language	IKJEFLD1
	6	Don't Save	IKJEFLD1
	7	Reserved	Reserved

A description of the field names follows:

User ID ENQ Failed

If the ENQ on the user ID was unsuccessful, the logon processor sets this bit on to indicate that the user ID is in use.

The logon processor does not do an ENQ on the user ID before it initially invokes the exit. Therefore, when the exit first receives control, the User ID ENQ Failed bit is off.

If the exit sets the Don't ENQ User ID bit off, the logon processor performs an ENQ on the user ID after the exit returns control to the logon processor. If the user ID is in use (the ENQ failed), the logon processor sets the User ID ENQ Failed bit on and invokes the exit again.

Don't Issue RACINIT (IKJEFLD1 only)

If IKJEFLD1 performs RACF® processing and you do not want the logon processor to issue a RACINIT, IKJEFLD1 must set the Don't Issue RACINIT and the Don't Prompt bits on. This bit will already be on in a z/OSMF ISPF environment. No RACINIT is needed as it was already done before the exit was called.

Resource Failure

If the logon processor was unable to obtain a resource other than the user ID, it sets this bit on.

Disconnect

The exit sets this bit on to tell the logon processor to terminate the session. The logon processor sends no further messages to the terminal. Before the exit returns control to the logon processor, it can issue an explanation to the user, for example, using PUTLINE.

Don't Prompt

If you do not want the logon processor to prompt the user for information, the exit must set the Don't Prompt bit on.

If the exit supplies any of the following information (not in the input buffer), it must set the Don't Prompt bit on:

User ID
Password
Account number
Procedure name
Region size
New password
Performance group
Group
SECLABEL

If the exit sets the Don't Prompt bit on, it must return at least the following information to the logon processor:

User ID
Password
Procedure name
Account number (if your installation uses account numbers)

If the exit supplies any information in the input buffer, that information is ignored.

If you want the logon processor to prompt the TSO/E user for logon information, the exit must not set the Don't Prompt bit on (the bit must be off).

No UADS

The exit sets this bit on to tell the logon processor not to check either the UADS or the RACF data base to verify logon information. If the No UADS bit is on, no logon information is saved. If the user is defined to RACF, TSO/E always verifies the user ID and the password information with RACF even if the exit routine sets the No UADS bit on.

If the exit sets the No UADS bit on, it must supply the following information:

System attributes
User attributes (if your installation uses user attributes)
Generic unit
UPT

If the exit sets the Don't Prompt bit off, the logon processor ignores the No UADS bit. Here, the logon processor prompts the user for information. The logon processor also verifies the logon information with information either in the UADS or the RACF data base, depending on where the user is defined.

JCL

If the exit supplies JCL statements, it must set this bit on. The exit can supply a maximum of ten 80-byte JCL statements (in standard format) in the JCL parameter provided, or the exit can supply its own parameter for JCL. Logon processing will accept a JCL parameter containing up to 409 JCL statements, but your installation's JES capability determines the actual number of JCL statements allowed. Logon processing does not check that number. For information about the format of JCL statements, see .

No UADSE

The exit sets this bit on to tell the logon processor to use the UADS or the RACF data base only for the LISTBC performance enhancement. If the exit sets the No UADSE bit on, it must also:

Set the Don't Prompt and the No UADS bits on
Set the Don't ENQ bit off

System Attributes

If the exit supplies the system attributes, it must set this bit on. If the exit sets this bit on, the system attributes are not saved. The exit supplies the attributes in the system attributes parameter.

User Attributes

If the exit supplies the user attributes, it must set this bit on. If the exit sets this bit on, the user attributes are not saved. The exit supplies the attributes in the user attributes parameter.

Generic Unit

If the exit supplies a generic unit name, it must set this bit on. The exit supplies the name in the generic unit parameter.

UPT

If the exit supplies the UPT, it must set this bit on. If the exit sets this bit on, the UPT is not saved. The exit supplies the UPT in the UPT parameter.

Don't ENQ User ID

The exit sets this bit on to tell the logon processor not to ENQ on the user ID. This bit will already be on in a z/OSMF ISPF environment, where no ENQ is needed. If the exit sets the Don't ENQ User ID bit on, it must also set the No UADS bit on and supply the following information:

System attributes
User attributes (if your installation uses user attributes)
Generic unit
UPT

Destination

If the exit supplies the default SYSOUT destination descriptor, it must set this bit on. The exit supplies the destination descriptor in the default SYSOUT destination parameter.

ABEND

The logon processor's ESTAI retry routine sets this bit on to indicate that an ABEND has occurred and that the logon processor is retrying.

Reconnect

If the user specified RECONNECT on the LOGON command, and the exit sets the "Don't Prompt" bit on, the exit must also set this bit on. The exit determines whether the user specified RECONNECT by checking the input buffer. When the Reconnect bit is on, a user's disconnected session is reconnected when the user logs on again.

If the Reconnect bit is on and there is no disconnected session, the user is automatically logged on normally when the Don't Prompt bit is off or when all of the following are true:

The Don't Prompt bit is on
The Don't ENQ User ID bit is off
The necessary logon information (user ID, password, procedure, and so on) have been supplied

Mail

If the user is to receive mail, the exit must set this bit on. However, if the user specified MAIL on the LOGON command or the full-screen panel, the exit is overridden unless the Don't Prompt and No Full-Screen Panel bits are set. By default, the Mail bit is off.

Notices

If the user is to receive notices, the exit must set this bit on. However, if the user specified NOTICES on the LOGON command or the full-screen panel, the exit is overridden unless the Don't Prompt and No Full-Screen Panel bits are set on. By default, the Notices bit is off. If the user specified NOTICES on the LOGON command, the exit must set this bit on. The exit determines whether the user specified NOTICES by checking the input buffer.

No Full-Screen Panel

If you do not want the logon processor to display the default full-screen logon panel, the exit must set this bit on.

Store Password in TSB

If you want the logon processor to store logon passwords in the terminal status block (TSB) for RACF users, the exit must set this bit on. By default, the passwords of users defined to RACF are not stored in the TSB. If you use the SUBMIT exit (IKJEFF10) to tailor job processing, you might want to retrieve passwords from the TSB. Passwords are not required on the JOB statement. However, passwords are required on the JOB statement if:

Your RACF users are defined with the same user ID and password on more than one node in a network, and
These users use the JES control statement //*ROUTE XEQ to route jobs to another node.

In this case, if you set the Store Password in TSB bit on to have the logon processor store passwords in the TSB, the SUBMIT exit can retrieve the passwords from the TSB and add them to the JOB statement. For more information about the SUBMIT exit, see Writing an exit for the SUBMIT command.

You should use the Store Passwords in TSB bit only if:

You use the SUBMIT exit, and
Your RACF users are defined with the same user ID and password on more than one node in a network, and these users use the JES control statement //*ROUTE XEQ to route jobs from one node to another.

SUBMIT Hold Class (IKJEFLD1 only)

If you want IKJEFLD1 to return a SUBMIT hold class, IKJEFLD1 must set the SUBMIT Hold Class bit on.

SUBMIT Class (IKJEFLD1 only)

If you want IKJEFLD1 to return a SUBMIT class, IKJEFLD1 must set the SUBMIT Class bit on.

SUBMIT Message Class (IKJEFLD1 only)

If you want IKJEFLD1 to return a SUBMIT message class, IKJEFLD1 must set the SUBMIT Message Class bit on.

SYSOUT Class (IKJEFLD1 only)

If you want IKJEFLD1 to return a SYSOUT class, IKJEFLD1 must set the SYSOUT Class bit on.

First Command (IKJEFLD1 only)

If you want IKJEFLD1 to return a TSO/E command to be issued at the beginning of the user's session, IKJEFLD1 must set the First Command bit on.

If the exit does not set the No Prompt bit on and allows logon to display the full-screen panel, the first command set by the exit will be displayed and the user can modify it.

RBA (IKJEFLD1 only)

If you want IKJEFLD1 to return the relative block address (RBA) within the broadcast data set, IKJEFLD1 must set the RBA bit on.

SECLABEL bit (IKJEFLD1 only)

If you want IKJEFLD1 to return a SECLABEL, IKJEFLD1 must set the SECLABEL bit on.

Console Profile (IKJEFLD1 only)

If you want IKJEFLD1 to return a console profile, IKJEFLD1 must set the Console Profile bit on.

Primary Language (IKJEFLD1 only)

If you want IKJEFLD1 to return a primary language to be used for displaying translated information, IKJEFLD1 must set the Primary Language bit on.

Secondary Language (IKJEFLD1 only)

If you want IKJEFLD1 to return a secondary language to be used for displaying translated information, IKJEFLD1 must set the Secondary Language bit on.

Don't Save (IKJEFLD1 only)

If you do not want the logon processor to save the values the user enters on the full-screen logon panel or values provided in the data areas in IKJEFLD1, IKJEFLD1 must set the Don't Save bit on. This bit is applicable only for users defined to RACF. It has no effect if user information is stored in the UADS instead. The fields that this bit controls are:

Procedure name
Account number
Region size
Performance group
First command
No Mail
No Notices
Reconnect
Operator ID card
Security Label