CA ADS Batch Trace Facility

Runtime Considerations › CA ADS Batch Trace Facility

CA ADS Batch Trace Facility

The CA ADS Batch trace facility is a debugging aid that traces the flow of control and commands executed in an application at runtime.

Steps in the Trace Facility

To use the trace facility, perform the following steps:

During dialog definition, specify that a symbol table is to be included in the dialogs you want to trace. Symbol tables are required by the facility to list the process commands executed at runtime. If you are using the online dialog compiler, you request a symbol table on the Options and Directives screen.
At runtime, include TRACE statements as part of your control statements. TRACE statements specify:
- The dialogs to be traced—One, several, or all dialogs in an application can be traced.
- When the dialogs are to be traced—By default, a selected dialog is traced every time it becomes operative in the application thread. Alternatively, you can specify that tracing begin only after the dialog has become operative for the nth time, that tracing end when the dialog becomes operative for the nth time, or that tracing occur only every nth time that the dialog becomes operative.
- The level of detail of the trace—You can specify one of three levels of detail for the trace of a dialog:
  1. Dialog and process module execution—The trace facility documents the beginning of dialog and premap and response process execution.
  2. Subroutine execution—The trace facility documents dialog and process module execution, as in level one, and additionally documents the beginning of subroutine execution.
  3. Command execution—The trace facility documents dialog, process module, and subroutine execution, as in level two, and additionally documents all commands executed within the dialog.
    Additionally, detailed information is provided on database commands and on database currency saves and restores.
Syntax for the TRACE statement is provided under Runtime Control Parameters.

The trace facility writes trace records to the log file as DEBUG records. You can print the records by using the CA ADS Batch print log utility, as discussed in CA ADS Batch Print Log Utility. Alternatively, you can send all log file output directly to the printer at runtime.

Sample Output

Sample output from a trace facility run is shown in the report below. The output columns are as follows:

Execution number (first column)—The execution occurrence for the dialog. The lines in the sample were created while the dialog was operative for the first time (00000001).
Dialog name (second column)—The name of the dialog currently executing. The sample shows that dialog REPTEDIT executes first, then dialog HDRLINE, and then dialog REPTEDIT again.
Process name (third column)—The name of the premap or response process currently executing. JEB-EMPL-REPT-EDIT is the first process executed in the sample trace facility run.
Note: A line that documents the beginning of a dialog has the following literal in the process name field:
```
********  DIALOG-ENTRY  ********
```
Subroutine name (fourth column)—The name of the process subroutine currently executing. PAGHDR is the first subroutine executed in the sample trace facility run.
Note: A line that documents the beginning of a dialog, the beginning of a process, or a process command that is not within a subroutine has the following literal in the subroutine name field:
```
**MAIN**
```
Sequence number field (fifth column)—The IDD sequence number of the command being executed. The first four commands executed in the sample trace facility run begin at lines 100, 300, 400, and 500. These line numbers are the same ones used by ADSORPTS in its report of a dialog's processes.
Note: For more information about ADSORPTS, see the CA ADS Reference Guide. The line that documents the beginning of a dialog, process, or subroutine has 00000000 in this field.
Process command (sixth column)—The process command currently executing. The first command executed in the sample trace facility run is IF.
Note: A line that documents the beginning of a dialog, process, or subroutine has the literal ENTRY in this field.
Command offset (last column)—The hexadecimal offset of the command from the beginning of the dialog's fixed dialog block (FDB). These offsets are the same ones used by ADSORPTS in its list of command elements (CMEs) for a process.

Note: For more information about ADSORPTS, see the CA ADS Reference Guide.

The process being traced in the sample trace facility report does not include database commands or database currency saves and restores. However, if a process did and if tracing were being performed at the command execution level, the report would include detailed information about these database functions.

If the module is an included module, the included module name appears in the report after the last column.

00000001 REPTEDIT ******** 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 HDRLINE. ******** 00000001 HDRLINE. JEB-HEADER-WRITE 00000001 HDRLINE. JEB-HEADER-WRITE 00000001 HDRLINE. JEB-HEADER-WRITE 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT 00000001 REPTEDIT JEB-EMPL-REPT-EDIT DIALOG-ENTRY ******** **MAIN** 00000000 ENTRY... . **MAIN** 00000000 ENTRY... . **MAIN** 00000100 IF . 0004F8 . **MAIN** 00000300 DC ACC . 000524 . **MAIN** 00000400 MOVE . 000538 . **MAIN** 00000500 CALL . 000574 . CVRTDATE 00000000 ENTRY... . CVRTDATE 00013700 MOVE . 0019DC . CVRTDATE 00013800 MOVE . 001A94 . CVRTDATE 00000000 MOVE . 001B4C . CVRTDATE 00000000 GOBACK . 001C04 . **MAIN** 00000600 MOVE . 00058C . **MAIN** 00000700 CALL . 0005C8 . PAGHDR . 00000000 ENTRY... . PAGHDR . 00010000 MOVE . 0013C0 . PAGHDR . 00010100 ADD . 0013FC . PAGHDR . 00010200 MOVE . 001450 . PAGHDR . 00010300 MOVE . 00148C . PAGHDR . 00010400 MOVE . 0014C8 . PAGHDR . 00010500 MOVE . 001504 . PAGHDR . 00010600 CALL . 001540 . CENTJUST 00000000 ENTRY... . CENTJUST 00012400 MOVE . 001774 . CENTJUST 00012500 COMPUTE. 001818 . CENTJUST 00012600 MOVE . 00189C . CENTJUST 00012700 MOVE . 0018D8 . CENTJUST 00012800 GOBACK . 0019C4 . PAGHDR . 00010700 MOVE . 001558 . PAGHDR . 00010800 LINK . 001594 DIALOG-ENTRY ******** **MAIN** 00000000 ENTRY... . **MAIN** 00000000 ENTRY... . **MAIN** 00000100 ADD . 0003A0 . **MAIN** 00000200 WRT TRAN 0003F4 . **MAIN** 00000000 ENTRY... . PAGHDR . 00010900 MOVE . 0015A4 . PAGHDR . 00011000 MOVE . 0015E0 . PAGHDR . 00011100 MOVE . 00161C . PAGHDR . 00011200 CALL . 001658 . CENTJUST 00000000 ENTRY... . CENTJUST 00012400 MOVE . 001774 . CENTJUST 00012500 COMPUTE. 001818 . CENTJUST 00012600 MOVE . 00189C . CENTJUST 00012700 MOVE . 0018D8