User descriptor syntax and parameters

Unless noted, the definition of a given user descriptor parameter is the same as that found for the equivalent NAME (NAME macro) and SUBPOOL macro statement (SUBPOOL macro). Also, unless noted, the general rules for creating descriptors apply to the following user descriptors.

Keyword parameters of the user descriptor

The values in the user descriptor statement are described in the following list.

Except for the descriptor type, U, and the user name, all keyword parameters are specified in columns 12 through 72.

U

Indicates the descriptor type is user.

username

The name of the descriptor, which can be a unique user ID you create, a node user name assigned to a TERMINAL or SUBPOOL macro, or the IMS default descriptor name, DFSUSER.

ASOT=a

a is 0 or a value from 10 to 1440. The default comes first from the logon descriptor parameter ASOT. If ASOT is not specified on either the user or logon descriptor, the value from the JCL member is used except for FINANCE, SLU P, and ISC. If ASOT is not specified on either the user or logon descriptor for FINANCE, SLU P, and ISC, or overridden by the logon (DFSLGNX0) or (DFSSGNX0) exits, then a value of 1440 is used, the value from the JCL member is ignored.

AUTLDESC=d

d is a one- to eight-byte alphanumeric logon descriptor name, the first character of which is alphabetic (A-Z, $, #, @). AUTOLDESC=d defines the characteristics of the terminal to be autologged on. This parameter is ignored for LU 6.1 devices.

AUTLGN=b

b is a one- to eight-byte alphanumeric LU name for auto logon, the first character of which is alphabetic (A-Z, $, #, @). Autologon allows IMS to logon and signon your terminal automatically. If you specify the autologon option for a user, the queuing of data to any of the user queues causes IMS to establish a session.

Related reading: For more information, see Autologon.

AUTLID=g

g is a one- to eight-byte alphanumeric ISC other system half session qualifier, of which the first character is alphabetic (A-Z, $, #, @). If the other system is IMS, then this is the name of an ISC user in that system. The AUTLGN parameter must be used with the AUTLID parameter when requesting autologon for an ISC parallel session.

AUTLMOD=e

e is a one- to eight-byte alphanumeric mode table for the autologon terminal.

LTERM=(f,h,i,j)

f,h,i, and j are all positional parameters. f is a one- to eight-byte alphanumeric LTERM name. h is either ULC or UC; the default is ULC. i is the COMPT parameter, and j is the ICOMPT parameter. COMPT and ICOMPT are the same as defined by keyword parameters on the NAME macro. If f is the only parameter supplied, the parentheses can be omitted.

A maximum of eight queues can be specified for each user descriptor.

If no LTERM keyword is specified, the user descriptor control block structure is built with one queue. The name used as the descriptor name is the default.

The queue names specified on the LTERM parameter keyword for the user descriptors must be unique. That is, two user descriptors cannot be created with the same queue name. If duplicate LTERM names are specified, message DFS3669 is issued.

If the LTERM keyword is specified on the user descriptor, the queue name must also be specified. The DFSUSER descriptor must also follow this convention (for example, with queue name DFSUSER).

The queue names (and Remote LTERM names) must follow the same naming conventions as the user names because they can, in some circumstances, take on the same name as the user name. The user name has strict naming conventions because it must follow RACF® naming conventions. Therefore, these names must be alphanumeric (A-Z, 0-9, $, #, @), but the first character in the name must not be 0-9.

OPTIONS=j,k

j is a response mode of FORCRESP, TRANRESP, or NORESP. The default response mode is dependent upon the device type. If the response mode is not explicitly set in the user descriptor, the default cannot be set until signon, when the device type is known. The default setting for each device type, during signon, is indicated in the following table.

Table 1. Default response mode values

Device type	Default response mode
3270	NORESP
FINANCE	NORESP
LU 6	TRANRESP
NTO	TRANRESP
SLU 1	TRANRESPX
SLU 2	NORESP
SLU P	NORESP

k is an MSGDEL option of SYSINFO, NONIOPCB, or NOTERM. The default is SYSINFO.

If OPTIONS=NOTERM is specified for a user descriptor, when that user descriptor is used for a sign on of a FINANCE, SLU P, or ISC terminal, SYSINFO issued instead of NOTERM.

The OPTION parameters are not positional. Refer to the MSGDEL and OPTIONS parameters of the TERMINAL macro for descriptions.

RCVYCONV=

Specifies whether the status of a conversation can be recovered (Y) or not (N). RCVYCONV applies to conversation status, not to output messages. Even if the conversation status is not recovered, conversation output continues to be recoverable and is delivered asynchronously.

The following table shows the default values for RCVYCONV as they relate to the values specified on the SRMDEF keyword.

Table 2. RCVYCONV values related to SRMDEF values

	RCVYCONV=YES	RCVYCONV=NO
SRMDEF=GLOBAL	Valid (default)	Valid
SRMDEF=LOCAL	Valid (default)	Valid
SRMDEF=NONE	Invalid	Valid (default)

If RCVYCONV is specified incorrectly, message DFS1920I is issued and IMS uses the appropriate default from the preceding table.

RCVYFP=

Specifies whether the status of Fast Path can be recovered (YES) or not (NO). RCVYFP applies to Fast Path status and output.

The following table shows the default values for RCVYFP as they relate to the values specified on the SRMDEF keyword.

Table 3. RCVYFP values related to SRMDEF values

	RCVYFP=YES	RCVYFP=NO
SRMDEF=GLOBAL	Valid (default)	Valid
SRMDEF=LOCAL	Valid (default)	Valid
SRMDEF=NONE	Invalid	Valid (default)

Restriction: If SRMDEF=LOCAL, STSN recoverability (RCVYSTSN) and fast path recoverability (RCVYFP) must be the same. They must both specify YES or both specify NO.

If RCVYFP is specified incorrectly, message DFS1920I is issued and IMS uses the appropriate default from the preceding table.

RCVYSTSN=

Specifies whether the status of STSN terminals (SLUP, FINANCE, and ISC) can be recovered (Y) or not (N).

The following table shows the default values for RCVYSTSN as they relate to the values specified on the SRMDEF keyword.

Table 4. RCVYSTSN values related to SRMDEF values

	RCVYFP=YES	RCVYFP=NO
SRMDEF=GLOBAL	Valid (default)	Valid
SRMDEF=LOCAL	Valid (default)	Valid
SRMDEF=NONE	Invalid	Valid (default)

Restrictions: If SRMDEF=LOCAL, STSN recoverability (RCVYSTSN) and fast path recoverability (RCVYFP) must be the same. They must both specify YES or both specify NO. If SRMDEF=GLOBAL, Fast Path is always nonrecoverable, so if there is a failure during the execution of a fast path transaction, the STSN session must be restarted cold.

If RCVYSTSN is specified incorrectly, message DFS1920I is issued and IMS uses the appropriate default from the preceding table.

SRMDEF=

Specifies the status recovery mode for user and node resources. Valid values are GLOBAL, LOCAL, and NONE.

Related reading: In order to understand what the GLOBAL, LOCAL, and NONE values mean, you have to first understand how IMS classifies resource status. For a discussion of these concepts, see IMS Version 15.4 System Administration.

The following list describes the valid values for SRMDEF.

GLOBAL

The significant status of a resource is saved globally in the coupling facility resource structure every time the significant status changes, along with all other recoverable status for that resource. The resource status is restored at the next logon or signon and is available from any IMS system in the IMSplex. Resource status is copied to the local system when that resource becomes active, but is deleted from the local system when it becomes inactive. Status is not recovered in local IMS log records.

Requirement: Using a status recovery mode of GLOBAL requires a Resource Manager and a resource structure in the coupling facility.

LOCAL

The significant status is saved in local control blocks and log records, along with all other recoverable resource status. The resource status is restored at the next logon or signon if the user or node returns to the same local IMS system. This status is not available on any other IMS system in the IMSplex.

LOCAL mode enforces an affinity for the user or node to the IMS system where the local status exists. This is referred to as RM affinity. IMS prevents the user or node from accessing any other IMS while local status exists. If the IMS system that has local status fails, the node and user are allowed access to another IMS system. In this case, the node or user does not recover any status and when the failed IMS restarts, the local status that existed is deleted.

Using a status recovery mode of LOCAL does not require a Resource Manager. If RM is not used to manage node or user resources, then no RM affinity is enforced.

NONE

The significant status is not saved by RM or in local log records. When the user signs on or the node logs on, the corresponding significant status does not exist.