Standard output redirect facility

OpenTP1 for Windows can output directly to a file the contents of standard output and standard error. This function is called the standard output redirect facility, and it enables the user to save to a file the information that is output to standard output and standard error by the system server and user server (including the KFCA-xxxxx messages and all information specified for standard output by the user). You must open the file each time you want to check the file's contents.

This subsection explains the environment settings required in order to use the standard output redirect facility.

Reference note: If you use the console output facility for standard output redirect files, you can check the output contents in real time at the console. For details about the console output facility for standard output redirect files, see 2.2.2 Console output facility for standard output redirect files.

Organization of this subsection: (1) Environment settings; (2) Notes

(1) Environment settings

To use the standard output redirect facility, you must specify the following system definition:

System environment definition

redirect_file operand
Specifies whether the contents of standard output and standard error are to be saved to a file.
redirect_file_name operand
Specifies the name of the file to which the contents of standard output and standard error are to be saved.
redirect_file_size operand
Specifies the maximum size of the file to which the contents of standard output and standard error are to be saved.

For details about these operands, see System environment definition in 5.3 Details of system definitions.

Note that this facility cannot be used when you specify the prc_port and rpc_port_base operands in the system common definition. If these operands are specified, and Y is specified in the redirect_file operand, OpenTP1 outputs the KFCA26520-W message, ignores the redirect_file operand, and resumes the OpenTP1 startup operation. When the KFCA26520-W message is displayed, either delete the prc_port and rpc_port_base operands or delete the redirect_file operand.

(2) Notes

If initialization of this facility fails, the KFCA00715-E message with reason code 200 is output to the Event Viewer. When this message is output, stop the OpenTP1 service and then restart OpenTP1.
If write operations occur frequently during high workload periods, messages might be discarded.
Standard output and standard error messages from processes running under OpenTP1 are output to a file via the prctee process. If the prctee process is shut down during online operation, standard output and standard error messages from the processes running under OpenTP1 can no longer be output to a file. If this occurs, stop the OpenTP1 service and then restart OpenTP1.
If the redirect_file_name operand is omitted or opening of the file specified in the redirect_file_name operand fails for a reason such as the specified folder being nonexistent, the following files are created as the destinations for standard output and standard error from a process running under OpenTP1:
- %DCDIR%\spool\prclog1
- %DCDIR%\spool\prclog2
When this facility is used, any message in a batch file specified in the user_command_online system environment definition operand or in the executable file cannot be output to standard output or standard error. If a batch file or executable file that uses standard output and standard error is used, OpenTP1 issues the KFCA01819-E message and then shuts itself down. If you use a program that uses standard output and standard error, first execute @echo off within the batch file so that standard output and standard error will be ignored.
If you use a stream such as the printf() function from within a UAP, we recommend that you flush the stream once the output operation has been completed. If the stream is not flushed, its correct contents might not be output to a file. Even when streams are used, this measure is not necessary with respect to the DISPLAY statement in a COBOL UAP, because the contents are output in real time.

2.2.1 Standard output redirect facility

(1) Environment settings

(2) Notes