Mapping the installation data parameter list

The installation data parameter list gives your ESM exit programs access to the CICS® security event being processed and details of the current CICS environment. You can map the installation parameter list using the macro DFHXSUXP.

See The installation data parameter list.

The DSECT DFHXSUXP contains the following fields:

UXPLEN

A halfword containing the length of this parameter list in bytes.

UXPARROW

Arrow "eyecatcher" (>).

UXPDFHXS

The name of the owning component (DFHXS).

UXPBLKID

The name of the block identifier (UXPARMS).

UXPPHASE

Address of a 1-byte code that indicates the reason for the call to the ESM (that is, the security event being processed). The code can have one of the following values:

DEFAULT_SIGN_ON (X'01'): Signon of default userid
PRESET_SIGN_ON (X'02'): Signon of preset security terminal
IRC_SIGN_ON (X'03'): Link signon for IRC (MRO) links
LU61_SIGN_ON (X'04'): Link signon for LUTYPE6.1 links
LU62_SIGN_ON (X'05'): Link signon for APPC links
XRF_SIGN_ON (X'06'): XRF tracking of signon
ATTACH_SIGN_ON (X'07'): Attach-time signon of link user
NON_TERMINAL_SIGN_ON (X'08'): Signon of a non-terminal userid
USER_SIGN_ON (X'10'): Normal user signon
PRESET_SIGN_OFF (X'22'): Sign-off when terminal deleted
LINK_SIGN_OFF (X'25'): Sign-off when link is closed
XRF_SIGN_OFF (X'26'): XRF tracking of sign-off
ATTACH_SIGN_OFF (X'27'): End-of-task sign-off of link user
NON_TERMINAL_SIGN_OFF (X'28'): Sign-off of a non-terminal userid
USER_SIGN_OFF (X'30'): Normal user sign-off
TIMEOUT_SIGN_OFF (X'31'): Sign-off forced by the terminal abnormal condition program, or timeout by the CSSC transaction
USRDELAY_SIGN_OFF (X'32'): Sign-off caused by expiry of USRDELAY interval
DEFERRED_SIGN_OFF (X'33'): Sign-off deferred to task end
USER_ATTACH_CHECK (X'40'): Transaction attach check for user
LINK_ATTACH_CHECK (X'41'): Transaction attach check for link
EDF_ATTACH_CHECK (X'42'): Transaction attach check for CEDF
USER_COMMAND_CHECK (X'50'): Command checking for user
LINK_COMMAND_CHECK (X'51'): Command checking for link
EDF_COMMAND_CHECK (X'52'): Command checking for EDF
USER_RESOURCE_CHECK (X'60'): Resource checking for user
LINK_RESOURCE_CHECK (X'61'): Resource checking for link
EDF_RESOURCE_CHECK (X'62'): Resource checking for EDF
USER_SURROGATE_CHECK (X'68'): Surrogate checking for user
LINK_SURROGATE_CHECK (X'69'): Surrogate checking for link
EDF_SURROGATE_CHECK (X'6A'): Surrogate checking for EDF
USER_QUERY_CHECK (X'70'): Query checking for user
LINK_QUERY_CHECK (X'71'): Query checking for link
EDF_QUERY_CHECK (X'72'): Query checking for EDF
INITIALIZE_SECURITY (X'80'): Initialization of CICS security
REBUILD_SECURITY (X'81'): CEMT or command-level SECURITY REBUILD
XRF_TRACK_INITIALIZE (X'82'): XRF tracking of initial or rebuild.
PASSWORD_CHANGE (X'90'): Change of password
PASSWORD_VERIFICATION (X'91'): Verification of password

UXPSUBSY

Address of an area containing the CICS subsystem identifier.

UXPAPPL

Address of an area containing the CICS application ID.

Note: When CICS is a member of a z/OS® Communications Server for SNA generic resource, the area pointed to by UXPAPPL contains the generic, not the specific, applid.

UXPCWA

Address of the Common Work Area.

UXPTRAN

Address of an area containing the transaction identifier.

UXPPROG

Address of an area containing the program name. The address may be zero if no program name can be identified.

UXPTERM

Address of an area containing the terminal identifier. The address may be zero if no terminal is associated with the request.

UXPLUNAM

Address of an area containing the SNA LU name. The address may be zero if no terminal is associated with the request, or the area may be blank if the terminal is not an SNA terminal.

UXPTCTUA

Address of the TCT user area.

UXPTCTUL

Address of a fullword containing the length of the TCTUA.

UXPCOMM

Address of a 2-word communication area.