SE.T SETUP - Trace

Use Setup Trace for configuring the product to provide a trace. Most options are created for debugging and diagnostics. Consequently, they are turned off unless you are trying to diagnose a problem. Typically, you do not need to configure these options unless you are asked to do so by IBM customer support. If you select the Trace command, these options can cause errors and unexpected results.

Figure 1 shows the Setup - Trace menu options panel that opens when you select the Setup Trace option from the Setup menu.

Figure 1. Setup Trace panel

                      zSecure - Setup -  Trace
Command ===> _________________________________________________________________ 
 
Diagnose syntax errors or enhance your CARLa knowledge
/  List standard CARLa members    
/  Show errors in context
 
Use following options only at the direction of IBM Security customer support.  
Enter "/" to select option(s)                                                  
_  Show parameters in run              _  Suppress error traps (if selected
_  Show intermediate results during       some parts may fail)
   recursion                           _  Collect C2RIMENU diagnostics
_  Show ISPF dialog errors (if         _  Collect CKGRACF diagnostics
   selected some parts may fail)       _  Collect CKX diagnostics
_  Trace REXX programs                 _  Report files used by program
_  Trace ISPF panel processing         _  Show Collect input parameters and
_  Trace ISPF skeleton processing         messages
_  Pass abends to ISPF                 _  Debug performance
_  Prevent closing/freeing data sets   _  Debug command actions
   during abend recovery

Descriptions for the available Setup Trace options are provided in the following list.

List standard CARLa members

If this option is checked, all included members are shown expanded in the SYSPRINT file. The expanded view can be helpful for understanding the query sent to the product engine by the interface. This option is useful when you are developing or learning about CARLa programs.

Show errors in context

This option switches between displaying high severity errors in context using the SHOWLOG command or browsing the high severity errors that were written to the SYSTERM file.

Show parameters in run

If this option is checked, a panel opens to show the parameters passed to the program.

Show intermediate results during recursion

Selecting this option has the following results:

Commands that are generated during a recursive run are immediately displayed in BROWSE mode. Normally, the commands are presented after finishing the run.
Intermediate results from the first pass of a two-pass query is displayed in the RESULTS panel, before starting the second pass.

Show ISPF dialog errors (if selected some parts may fail)

If this option is checked, the ISPF RETURN error mode is set (

CONTROL
ERRORS RETURN

). Some parts of the interface might fail when this option is selected.

Trace REXX programs

If this option is selected, the panel shown in Figure 2 opens so you can set a specific REXX Trace option.

Figure 2. Setup Trace REXX options

                       zSecure - Setup - Trace Rexx     
Command ===> _________________________________________________________________ 
 
Select one of the following Rexx Trace options, or blank to disable tracing:
_  1. All            Traces all clauses before execution
   2. Commands       Traces all commands before execution
   3. Error          Traces any command resulting in an error or failure
   4. Intermediates  Traces all clauses and intermediate results
   5. Labels         Traces only labels passed during execution
   6. Normal         Traces any command resulting in a negative return code
   7. Results        Traces all clauses before execution and final results

The selected Trace option is effective for all the zSecure REXX programs. For further information about the different Trace options, see the "TSO/E REXX reference".

Trace ISPF panel processing

If this option is checked, a panel trace is activated using the ISPDPTRC command. After leaving the user interface, the output of the panel trace is displayed in VIEW mode.

This option is only available on z/OS 1.7 and later versions. Only use this option at the request of IBM customer support in order to diagnose panel processing problems.

For further information about the ISPDPTRC command, see the IBM manual ISPF Dialog Developer's Guide.

Trace ISPF skeleton processing

If this option is checked, a skeleton trace is activated using he ISPFTTRC command. After leaving the user interface, the output of the skeleton trace is displayed in VIEW mode.

This option is only available on z/OS 1.7 and later versions. Only use this option at the request of IBM customer support in order to diagnose skeleton processing problems.

For further information about the ISPFTTRC command, see the IBM manual ISPF Dialog Developer's Guide

Pass abends to ISPF

If this option is checked, the NOCLEANUP parameter is added to the CARLa ALLOC command. This option can be used for debugging purposes to pass on abends to ISPF instead of recovering from them. Only use this option at the request of IBM customer support when an attempt to cleanup the abend causes additional errors.

Prevent closing/freeing data sets during abend recovery

If this option is checked, the NOCLOSE parameter is added to the CARLa ALLOC command. This option can be used to prevent closing and freeing data sets during abend recovery processing. Only use this option at the request of IBM customer support.

Suppress error traps (if selected some parts may fail)

Suppresses error traps during a debugging session. If this option is checked, the NOESTAE parameter is added to the CARLa ALLOC command. Setting this option can cause the product to stop working.

Collect C2RIMENU diagnostics

Enables tracing of the authority checks made to decide which items are shown on menus and which actions characters are available to the user. The trace is written to the C2RIMENU ddname and can be viewed using the C2RIMENU primary command.

Collect CKGRACF diagnostics

If this option is checked, the CKGRACF DEBUG command (with some additional parameters) is issued before every CKGRACF command. The CKGRACF DEBUG command helps you to explore how CKGRACF works or to diagnose problems in its operation. This option is especially helpful in determining why a certain CKGRACF command is not allowed. The information is written to the CKGPRINT ddname and can be viewed using the CKGPRINT primary command.

Collect CKX diagnostics

Enables collection of CKX diagnostic information. The information is written to the CKXDEBUG ddname and can be viewed using the CKXDEBUG primary command.

Report files used by program

This option enables collection of the input/output files that the program uses to produce the requested reports. When the Print information option was selected, the file usage reports are appended to the normal printed report. Otherwise, the following 4 reports with data that the program uses are displayed (empty reports might be suppressed):

@CARLa: zSecure CARLa input files
@SECDATA: zSecure Security input data
@DEFTYPE: zSecure DEFTYPE input data
@OUTPUT: zSecure output files

Show Collect input parameters and messages

This option enables printing the input parameters and messages, that the CKFCOLL or CKVCOLL programs store in the CKFREEZE file(s), in the SYSPRINT from the program. Selecting this option adds SHOW CKFIN CKFMSG to the CARLa program.

Debug performance

This option enables printing performance debug messages in the SYSPRINT. Selecting this option adds DEBUG PERFORM to the CARLa program.

Debug command actions

This option enables tracing of action character processing by adding message CKR0829 in the SYSPRINT. This is done by adding the CARLa command DEBUG ACTION.