./O command

Use the ./O command to define the output to be collected and presented, and the options in effect when running in TSO foreground address space. IMS Batch Terminal Simulator output is presented in the BTSOUT data set and at the TSO terminal, depending on the options selected in the ./O command.

Subsections:

Usage note
Format
Keywords and operands
Examples

Usage note

The values specified on the ./O command remain in effect until they are reset by another ./O command, or until the end of the IMS Batch Terminal Simulator run.

Format

 ./O      [ATR=          YES | NO]

          [APS=          YES | NO]

          [EATR=         YES | NO]

          [SCREEN=       INOUT | OUT | NO]

When running in TSO foreground address space, these additional parameters apply:

          [TSO=          YES | NO]

          [TSOAID=       YES | NO]

          [TSOMLVL=      1 | 0]

The following parameters can be used to specify the call trace options for all transactions. These specifications can be overridden for a particular transaction by the call trace options of the ./T command.

          [DB=           YES | NO | SGL]

          [ELAPTIME=     YES | NO | ALL]

          [ICALOLEN=     1000 | the_length_of_output_data_for_a_request_area_
                                or_a_response_area_on_an_ICAL_call]

          [IFI=          YES | NO]

          [MQI=          YES | ALL | NO]

          [MSG=          YES | NO | SGL]

          [REPORT=       YES | NO | T | F | G | C | I | S | M]

          [SPA=          YES | NO]

          [SQL=          YES | ALL | NO]

          [TSODB=        YES | ALL | PROMPT | NO]

          [TSOIFI=       YES | NO]

          [TSOMQI=       YES | ALL | PROMPT | NO]

          [TSOMSG=       YES | ALL | PROMPT | NO]

          [TSOSQL=       YES | ALL | PROMPT | NO]

The following parameters can be used to specify the call trace option for all transactions. However, these specifications cannot be overridden by the ./T command call trace options.

          [SQLHX=        YES | NO]

          [SQLOBLN=      the_length_of_output_data_that_is_of_LOB_data type]

          [TSOSQLHX=     YES | NO]

          [TSSLEN=       144 | the_length_of_the_area_for_a_TSS_call]

Keywords and operands

APS=

Indicates the print option for the application program statistics.

YES: Indicates that the statistics are to be printed. The summary shows the number of calls completed (regardless of status) by PCB name and function code for each application program scheduled. This summary is printed upon application program termination. The default value is APS=YES.
NO: Suppresses collecting and printing of application program statistics.

ATR=

Indicates the print option of the field attribute characters in the 3270 formatted screen image.

YES: Indicates that the hexadecimal field attribute characters are to be included in the screen image. A legend accompanies each screen image to assist in interpreting field attribute characters. The default value is ATR=YES.
NO: Suppresses printing of the field attribute characters.

DB=

Indicates the print option for the DL/I database call trace.

YES: Indicates that the DL/I database call trace is to be included in the print output. The default value is DB=YES.
NO: Suppresses the printing of the DL/I database call trace information.
SGL: Indicates that the DL/I database call trace is to be included as a single-line message to identify each call.

EATR=

Indicates the print option of the extended attribute characters in the 3270 formatted screen image.

YES: Indicates that the hexadecimal extended attribute characters are to be included wherever the print output contains 3270 screen images. The extended attribute character indicates color, extended highlighting, programmed symbols (PS), and Extended Graphic Character Set (EGCS). A legend accompanies each screen image to assist in interpreting extended attribute characters.
NO: Suppresses printing of the extended attribute characters. The default value is EATR=NO.

ELAPTIME=

Indicates whether to include the elapsed time of each call in the output.

YES: Indicates that the elapsed time of each call is to be included in the output.; When ELAPTIME=YES is specified, the elapsed time of each call in seconds ('ELAPSED SEC=x.xxxxxx', 25 bytes) is added to the trace output of each call. When the BTSOUT LRECL is more than 158, the output, which includes the elapsed time, is printed on a single line without being split by the default LRECL 133.
NO: Indicates that the elapsed time of each call is not to be included in the output. The default value is ELAPTIME=NO.
ALL: Indicates that the elapsed time and the start timestamp of each call are to be included in the output.; When ELAPTIME=ALL is specified, the elapsed time in seconds and the start timestamp of each call ('ELAPSED SEC=x.xxxxxx YYYY/MM/DD HH:MM:SS.SS', 48 bytes) are added to the trace output of each call. When the BTSOUT LRECL is more than 181, the output, which includes the elapsed time and the start timestamp, is printed on a single line without being split by the default LRECL 133.

ICALOLEN=

Specifies the length of the output data for a request area, a response area, or a control data area on an ICAL call.

Specify a 1- to 4-digit decimal number. The default is 1000 bytes. When the request length, the response length, or the control data length is equal to or less than the ICALOLEN value, all of the data is included in the output. When the length is longer than the ICALOLEN value, the output data is truncated to the ICALOLEN value. When ICALOLEN is 0, the data of the request, response, and control areas is not included in the output.

IFI=

Indicates the print option for the IFI call trace.

YES: Indicates that the IFI call trace is to be printed on BTSOUT as a single-line message to identify each call. The default value is IFI=YES.
NO: Suppresses printing of the IFI call trace information.

MQI=

Indicates the print option for MQI call trace.

YES: Indicates the MQI call trace is to be printed on BTSOUT as a single-line message to identify each call.

ALL: Indicates that the MQI call trace is to be printed on BTSOUT including the MQI message, if the MQI messages are applicable. The default value is MQI=ALL.

NO: Suppresses the printing of the MQI call trace information.

MSG=

Indicates the print option for the DL/I message call trace.

YES: Indicates that the DL/I message call trace is to be included in the print output. The default value is MSG=YES.
NO: Suppresses the printing of the DL/I message call trace.
SGL: Indicates that the DL/I message call trace is to be included as a single-line message to identify each call.

REPORT=

Indicates that program analysis reports are to be included in the output. The page is ejected for each report.

You can specify a REPORT keyword on multiple lines to request multiple reports (for example, ./O REPORT=F and ./O REPORT=C). When the TSOMLVL keyword is set to 0, the report output is not shown on the TSO terminal.

YES: Indicates to print all types of program analysis reports in the output.
T: Prints the program analysis report by PCB total in the output.
F: Prints the program analysis report by function code in the output.
G: Prints the program analysis report by function code and segment name in the output.
C: Prints the program analysis report by status code in the output.
I: Prints the program analysis report by ICAL OTMA descriptor in the output.
S: Prints the program analysis report by SQL statement in the output.
M: Prints the program analysis report by MQI function in the output.
NO: Indicates not to print any of the program analysis reports in the output. The default value is REPORT=NO.

SCREEN=

Indicates the print options for the 3270 formatted screen image.

INOUT: Indicates that both the input and output screen images are to be printed. The default is SCREEN=INOUT.
OUT: Indicates that only the output screen images are to be printed.
NO: Indicates that input and output screen images are not to be printed.

SPA=

Indicates the options for the SPA call trace.

YES: Indicates that the whole SPA that is returned to the I/O area is to be included in the DL/I message call trace. The default value is SPA=YES.
NO: Indicates that only the first 14 bytes of an SPA that is returned to the I/O area is to be included in the DL/I message call trace. The first 14 bytes include the transaction code.

SQL=

Indicates the print option for the SQL call trace.

YES: Indicates that the SQL call trace is to be printed on BTSOUT as a single-line message to identify each call.
ALL: Indicates that the SQL call trace is to be printed on BTSOUT including the IFI SQL statement information, input and output variables, and Db2® messages, if the Db2 messages are applicable. The default value is SQL=ALL.
NO: Suppresses printing of the SQL call trace information.

SQLHX=

Indicates the print option for the hex representation of input and output variables in the SQL call trace. When the printing of input and output variables is suppressed by the SQL= operand, the SQLHX= operand is ignored.

YES: Indicates that the hex representation of input and output variables is to be printed on BTSOUT following the printing of input and output variables. When the data is defined as variable length, the length (LL) of the data is included in the BTSOUT hex representation.
NO: Suppresses printing of the hex representation of input and output variables. The default value is SQLHX=NO.

SQLOBLN=

Specifies the length of output data for LOB (large objects) data type that you want to print in the BTSOUT or that you want to display on the TSO terminal. The length of the LOB data type in SQLDA that is returned by Db2 is always 0. If this parameter is not specified, the LEN= operand on the BTSOUT shows 0, and LOB data is not printed in the BTSOUT or displayed on the TSO terminal.

If the length that is defined in the application program is smaller than SQLOBLN=nn, IMS Batch Terminal Simulator substitutes nn with the actual data length.

TSO=

Indicates whether the FSS option is wanted (YES) or not (NO). TSO=NO is the default unless IMS Batch Terminal Simulator is started in a TSO foreground address space, in which case TSO=YES is assumed. When TSO=NO, all other TSO operands of the ./O command are ignored.

Related reading: For information about the FSS option, see Full screen image support (FSS).

TSOAID=

Indicates whether program function key simulation is required (YES) or not (NO). Either no PF keys are used, or the TSO terminal is equipped with the needed keys. The default value is TSOAID=NO.

When TSOAID=YES is coded, IMS Batch Terminal Simulator prompts the user for PF key simulation each time data is entered onto an IMS formatted screen image and Enter is pressed. You can respond to the prompting message by entering a value of PFK1 through PFK24 and pressing Enter. The appropriate terminal action is simulated by IMS Batch Terminal Simulator. If only Enter is wanted, press Enter again. When TSO=NO, the TSOAID operand is ignored.

TSODB=

Indicates the TSO terminal display options for the DL/I database call trace.

YES: Indicates that the DL/I database call trace is to be displayed as a single-line message to identify each call. The default value is TSODB=YES.
ALL: Indicates that the DL/I database call trace is to be displayed including the AIB, IOAREA, key feedback area, and SSA, if applicable.
PROMPT: Indicates that the DL/I database call trace is to be displayed as a single-line message to identify each call. A prompt is displayed so that you can request additional information.
NO: Suppresses the display of the DL/I database call trace information.

TSOIFI=

Indicates the TSO terminal display option for the IFI call trace.

YES: Indicates that the IFI call trace is to be displayed as a single-line message to identify each call. The default value is TSOIFI=YES.
NO: Suppresses the display of the IFI call trace information.

TSOMLVL=

Indicates the level of IMS Batch Terminal Simulator information to be presented at the TSO terminal.

1: Indicates that IMS screen images and all IMS Batch Terminal Simulator error messages and information messages are to be presented at the TSO terminal. Call trace information and statistics are displayed if requested. The default value is TSOMLVL=1.
0: Indicates that only IMS screen images and IMS Batch Terminal Simulator error messages are to be presented at the TSO terminal. Other IMS Batch Terminal Simulator output (information messages, call trace, and statistics) are not presented.

TSOMQI=

Indicates the TSO terminal display options for MQI call trace.

YES: Indicates that the MQI call trace is to be displayed as a single-line message to identify each call. The default value is TSOMQI=YES.

ALL: Indicates that the MQI call trace is to be displayed including the MQI message, if the MQI messages are applicable.

PROMPT: Indicates that the MQI call trace is to be displayed as a single-line message to identify each call. A prompting message is displayed to which you can respond requesting additional information.

NO: Suppresses the display of the MQI call trace information.

TSOMSG=

Indicates the TSO terminal display options for the DL/I message call trace.

YES: Indicates that the DL/I message call trace is to be displayed as a single-line message to identify each call. The default value is TSOMSG=YES.
ALL: Indicates that the DL/I message call trace is to be displayed including the AIB, IOAREA, or SPA, if applicable.
PROMPT: Indicates that the DL/I message call trace is to be displayed as a single-line message to identify each call. A prompt is displayed so that you can request additional information.
NO: Suppresses the display of the DL/I message call trace.

TSOSQL=

Indicates the TSO terminal display options for the SQL call trace.

YES: Indicates that the SQL call trace is to be displayed as a single-line message to identify each call. The default value is TSOSQL=YES.
ALL: Indicates that the SQL call trace is to be displayed including the IFI SQL statement information, input and output variables, and Db2 messages, if the Db2 messages are applicable.
PROMPT: Indicates that the SQL call trace is to be displayed as a single-line message to identify each call. A prompt is displayed so that you can request additional information.
NO: Suppresses the display of SQL call trace information.

TSOSQLHX=

Indicates the TSO terminal display option for the hex representation of input and output variables in the SQL call trace. When the display of input and output variables is suppressed by the TSOSQL= operand, the TSOSQLHX= operand is ignored.

YES: Indicates that the hex representation of input and output variables is to be displayed following the display of input and output variables. When the data is defined as variable length, the length (LL) of the data is included in the BTSOUT hex representation.
NO: Suppresses the display of the hex representation of input and output variables. The default value is TSOSQLHX=NO.

TSSLEN=

Specifies the length of the data specified by the second call parameter as the KFB= field in the BTSOUT when the TSS call is issued. Specify a 1- to 4-digit decimal number. The default is 114 bytes. The result from IMS Batch Terminal Simulator can be unexpected when TSSLEN=nn is larger than the actual length of the second call parameter.

Examples

Example 1 for ./O command

Assume that the application is run for the first time in a non-TSO environment and that a full IMS Batch Terminal Simulator trace output is wanted. No ./O command is required. The effective default command is:

 ./O   APS=YES SCREEN=INOUT ATR=YES MSG=YES DB=YES SQL=ALL

Example 2 for ./O command

Assume a TSO environment for running an application in which you want to suppress DL/I call trace, Db2 SQL call trace, and IMS Batch Terminal Simulator information messages to the TSO terminal. The command is:

 ./O   TSOMLVL=0

Example 3 for ./O command

For better performance for TSO execution, enter:

 ./O   TSOMLVL=0 APS=NO SCREEN=NO MSG=NO DB=NO SQL=NO

Example 4 for ./O command

When a DL/I message call trace of IMS Batch Terminal Simulator is requested for application programs running in conversation mode, the scratchpad area is included in the call trace. To truncate the SPA call trace, enter:

 ./O   SPA=NO

Example 5 for ./O command

To print the elapsed time of each call in a single line for each call, and to print program analysis reports, enter:

./O ELAPTIME=Y DB=S MSG=S REPORT=Y

Example 6 for ./O command

To print a program analysis report by function code and a program analysis report by status code, enter:

./O REPORT=F
./O REPORT=C