Common parameters

The following table describes the common set of parameters at the start of the communication area for every exit:

Table 1. User exit parameters: common header
Parameter Description Can be updated by exit?  1 
Exit point name The exit point name (also shown in Figure 1):
RANAnn01
Resource attribute update exit point.

nn identifies the target CICS® configuration type:

CP
CICSPlex® SM context
CS
CICS system definition file
EX
Export file
CPppcc01
Change package exit point.

pp identifies the whether the exit point is for pre- or post-processing:

PO
Post-processing
PR
Pre-processing

cc identifies the API command:

AP
Approve
BO
Backout
DA
Disapprove
IM
Import
IN
Install
MG
Migrate
NC
Newcopy
RD
Ready
UR
Unready
 
User ID The ID of the user who requested the API command.  
API command The name of the API command.  
Current API reason module ID The current value set by the API command. Typically, this is 0, except for change package post-processing exits, in which case this is the value after processing the API command.  
Current API return code  
Current API reason code  
User exit return code Initialized to 0. For allowed values, see User exit return codes. Yes
User exit reason code Initialized to 0. For allowed values, see Predefined reason codes. Yes
Parameter list version Version number of this parameter list layout definition. Initialized to "2".  
User exit message text area 2 lines, 150 characters per line. Initialized with blanks. Yes
 1 
Any user exit program can update any parameter in the communication area. However, the CICS Configuration Manager ignores any updates to parameters except those indicated above.