Panel trace command (ISPDPTRC)

The ISPDPTRC command traces the Dialog Manager panel processing that occurs within any screen in the current ISPF session. You can trace both the execution of panel service calls (DISPLAY, TBDISPL, and TBQUERY) and the processing that occurs within the Dialog Manager panel code, including the processing of statements in the )ABCINIT, )ABCPROC, )INIT, )REINIT, and )PROC sections of the panel.

The output from the trace is written to a dynamically allocated VB (variable blocked) data set that has a record length of 255. Where the ddname ISPDPTRC is preallocated, this data set is used, providing it refers to a sequential, VB data set with a record length of at least 255.

The ISPDPTRC command starts the trace if it is not running. If the trace is already active, ISPDPTRC allows you to stop and optionally to view or edit the trace output. ISPDPTRC must be executed while ISPF is active.

The syntax of the command is:


>>-ISPDPTRC--+-----+--+------+--+------+--+-------+------------->
             '-END-'  '-VIEW-'  '-LIST-'  '-QUIET-'   

>--+-------------------------+---------------------------------->
   +-DSP---------------------+   
   |             .-Both-.    |   
   '-DISPLAY--(--+-None-+--)-'   
                 +-In---+        
                 '-Out--'        

>--+-----------------------------+--+-------------------+--)---->
   +-PNL-------------------------+  |       .-Summary-. |      
   |           .-*----------.    |  '-READ(-+-None----+-'      
   '-PANEL--(--+-panel_name-+--)-'          '-Detail--'        
               '-panel_mask-'                                  

>--+-----------------------------+------------------------------>
   +-SCR-------------------------+   
   |            .-0---------.    |   
   '-SCREEN--(--+-*---------+--)-'   
                '-screen_id-'        

>--+---------------------------------------------------------------+-->
   +-SECT----------------------------------------------------------+   
   |             .-*----.                                          |   
   '-SECTION--(--+-All--+--+--------+--+----------+--+--------+--)-'   
                 '-None-'  +-Init---+  +-Reinit---+  +-Proc---+        
                           '-NOInit-'  '-NOReinit-'  '-NOProc-'        

>--+---------------------------+-------------------------------><
   +-SVC-----------------------+   
   |             .-Detail-.    |   
   '-SERVICE--(--+-None---+--)-'

Where:

END

Terminates the trace if it is active. No attempt is made to edit or view the trace data set.

VIEW

Terminates the trace if it is active and views the trace data set. If an allocation for the DD ISPDPTRC is present, this data set is viewed. SYSOUT data sets are not supported.

When VIEW is unable to locate the trace data set, it performs the LIST processing and displays the list of panel trace data sets.

LIST

The panel trace command invokes the Data Set List Utility to display panel trace data sets.

Where the user's prefix is not blank, the data set list displayed is for data sets of the form:

prefix.**.ISPPNL.TRACE

Otherwise, the data set list displayed is for data sets of the form:

userid.**.ISPPNL.TRACE

QUIET

Prevents trace initialization and termination messages being displayed. Error messages continue to be displayed on the screen.

DISPLAY

Controls the generation of trace records resembling the panel as displayed at the terminal. Only the panel for the active screen is shown when a panel is being read into memory.

None: No trace records are produced during panel display processing.
In: Generates trace records showing the panel, including data entered after the user has pressed the Enter key or a function key.
Out: Generates trace records showing the panel as it shown on the screen. Attribute bytes are also represented in the screen display.
Both: Generates both the In and Out display traces. This is the default.

PANEL

Controls the generation of trace records based on the panel name.

*: Generate trace records for all panels. This is the default.
panel_name: Generates trace records only for the panel name as specified.
panel_mask: Generates trace records for panels matching panel_mask. The mask can contain % to represent a single character or * to represent any number of characters.

Note: Panel service calls (DISPLAY, TBDISPL, and TBQUERY) continue to be traced for all panels, regardless of the panel_name or panel_mask parameter specified.

READ

Controls the generation of trace records when a panel is being read into memory.

None: No trace records are produced during the read processing.
Summary: Generates summary information, including where the panel was loaded from (either an ISPPLIB or LIBDEF data set), and the number of records read until the )END statement was detected. This is the default setting.
Detail: Generates the same information as for the summary trace, but includes the panel source. Also shows the return codes and panel source records inserted, modified, and deleted by a panel input exit. Preprocessed panels can not be displayed.

SCREEN

Controls the generation of trace records based on the screen ID.

0: Generate trace records for the all logical screens. This is the default.
*: Generate trace records for the current screen ID.
screen_id: Generate trace records only for the logical screen ID as specified. The screen ID is a single character in the range 1-9, A-W.

SECTION

Controls the generation of trace records for the different panel logic sections. The default is all sections.

* | All: Generates trace records for all sections. Either form of this parameter can only be specified by itself, and not with any of the other SECTION parameter values.
None: Generates no trace records for any of the panel processing logic sections. This parameter can only be specified by itself and not in conjunction with any of the other SECTION parameter values.
Init: Generates trace records for the )ABCINIT and )INIT sections.
Reinit: Generates trace records for the )REINIT section.
Proc: Generates trace records for the )ABCPROC and )PROC sections.
NOInit: Turns off the generation of trace records for the )ABCINIT and )INIT sections.
NOReinit: Turns off the generation of trace records for the )REINIT section.
NOProc: Turns off the generation of trace records for the )ABCPROC and )PROC sections.

SERVICE

Controls the generation of trace records for the panel processing service calls, namely DISPLAY, TBDISPL and TBQUERY.

None: No trace records are produced during the service call processing.
Detail: Generates trace records for the DISPLAY, TBDISPL, and TBQUERY service calls, showing all the parameters. A trace record is produced both before and after the call processing, with the post record showing the return code from the service. This is the default setting.

Note:

Where neither the END nor VIEW parameters is provided, the panel trace is started if it is not already active, otherwise the trace is stopped and where possible you are put into an edit session with the trace output.
When the panel trace is already active, only the END and VIEW parameters have any effect on the command. All other valid parameters are ignored. If invalid parameters are entered the command terminates without starting to process the trace.