IBM SC34-6814-04 Server User Manual


 
v If your global user exit is in a domain, you can add extra trace calls to provide
additional diagnostic information by setting the AP option of EXEC CICS SET
TRACETYPE to level 1 or 2.
v Depending on which exit point you are using, you might be able to use the XPI
DFHTRPTX TRACE_PUT macro to create trace entries in the user exit program.
This macro is described in Chapter 3, “The user exit programming interface
(XPI),” on page 305. The individual descriptions of the global user exit points
indicate whether you can use the XPI DFHTRPTX macro.
Parameters passed to the global user exit program
The address of a parameter list is passed to the user exit program in register 1.
The list contains some standard parameters that are passed to all global user exit
programs, and might also contain some exit-specific parameters that are unique to
the exit point from which the exit program is being invoked.
The exit-specific parameters are described with the individual exits in the section
“Alphabetical list of global user exit points” on page 25. The standard parameter list
is described in the following section.
You can map the parameter list using the DSECT DFHUEPAR, which is generated
by the macro instruction
DFHUEXIT TYPE=EP,ID=exit_point_identifier
The ID parameter provides the extra data definitions that you need to map any
exit-specific parameters. For example, the macro instruction
DFHUEXIT TYPE=EP,ID=XTDIN
generates the DSECT to map the standard parameters followed by the parameters
that are specific to exit point XTDIN in the transient data program. If your exit
program is to be invoked at more than one exit point, you can code up to 256
characters of relevant exit identifiers on a single DFHUEXIT macro instruction. For
example:
DFHUEXIT TYPE=EP,ID=(XMNOUT,XSTOUT,XTDIN)
If your exit program is to be invoked at every global user exit point, you can code:
DFHUEXIT TYPE=EP,ID=ALL
If your user exit program is to be used both as a global user exit program and as a
task-related user exit program, you must code both:
DFHUEXIT TYPE=EP,ID=exit_point_identifier
and:
DFHUEXIT TYPE=RM
(in this order) to generate the DSECTs appropriate to both types of user exit.
If a global user exit program needs to use the DFHRMCAL macro to invoke an
external RMI, the DFHRMCAL macro instruction must follow the DFHUEXIT macro.
DFHUEPAR standard parameters
DFHUEPAR DSECT
* STANDARD PARAMETERS
UEPEXN DS A ADDRESS OF EXIT NUMBER
UEPGAA DS A ADDRESS OF GLOBAL WORK AREA
Chapter 1. Global user exit programs 7