$TRANSCRIPT_LOG_FILE

Copy the Transcript window contents to file.

$TRANSCRIPT_LOG_FILE | $TRANSCRIPT_LOGFILE{=} Filename {/append}

$TRANSCRIPT_LOG_FILE | $TRANSCRIPT_LOGFILE {=} Filename {totalsize=n} {,count=p }

Arguments

Argument Meaning
Filename Full path name to the output log file; can have a maximum length of 64 characters. The name can include one or more of the following identifiers, in any order, to differentiate individual log files.
  • %p—process ID of the started application. If specified, /append is ignored.
  • %t—time stamp. Using this adds an extra performance penalty, because the file names must also be saved.
  • %h—host name
  • %u—user name
  • %j—job number. If specified, /append is ignored. (iSeries only)
totalsize=n Total disk space in kilobytes that can be used for all rotating log files together. This size will not be exceeded. If not specified, the default value is 10000 (10 MB).
count=p Number of files used in rotating log files.

The minimum value of count is 2. There is no maximum. However, there is a lower limit to the log file size of 3 KB. If the combination of totalsize and count produce a file size that is less than that, the count will be reduced to achieve the minimum file size.

Note:  Rotating through a large number of files imposes a large overhead and performance penalty.

/append

Append any transcript information to the specified Filename.
NONE Do not create log files for Uniface Router or Uniface Server processes. If specified, use uppercase.

Defaults

Assignment file: Any application assignment file
Section: [SETTINGS]
Default value: None

Description

$TRANSCRIPT_LOG_FILE copies all logging information in the transcript window to the specified Filename. The transcript window is still created, however, so that you can follow Uniface’s processes.

With the $TRANSCRIPT_LOG_FILE setting defined, you do not normally need to close the transcript window manually. It is closed automatically unless there is a problem, such as an error in the assignment file or a network error. In this case, the transcript window must be closed manually. This behavior is useful when running Uniface in batch mode because Uniface usually stays active until the transcript window is closed. Using $TRANSCRIPT_LOG_FILE allows Uniface to end its processing without losing the information in the transcript window.

If $PUTMESS_LOG_FILE is also defined and specifies the same Filename as $TRANSCRIPT_LOG_FILE, all logging information is copied into that file. If $PUTMESS_LOG_FILE is set with a different Filename, the transcript logging information is added to the file specified by $TRANSCRIPT_LOG_FILE.

When a new file is created, a file banner is written to the file with information about the application. For rotating log files each banner line starts with the [logsegmentN]. For non-rotating files, the banner starts with [startup].

Rotating Log Files

Adding the optional totalsize=n and count=p parameters enables you to use rotating log files. The first and most recent file always has the name specified in the assignment setting.

When the file size reaches the maximum size, as determined by the totalsize divided by the count, the file is renamed, appending _1, and logging continues in a newly created file with the name specified in the assignment. When this file reaches the specified maximum size, the _1 file is renamed to _2, and the new file has _1 appended, and logging continues in a newly created file. This process is repeated until the number of log files matches the value of count, and then the oldest is deleted as new log files are created. As files are renamed, any existing file with that name is deleted.

As the log proceeds through the rotation, the oldest part of the log is deleted. Make sure you have defined a totalsize large enough to maintain a reasonable history, otherwise error messages written earlier may be lost.

If an error occurs during the rotation and it is no longer possible to guarantee that the total file size is below the totalsize argument, logging will stop. The error will be written to a uniface_app_type_%p.log in the working directory of the application, not in the directory specified for the $PUTMESS_LOG_FILE.

Using /append

You can use /append for rotating files to continue the rotation. If files exist with the same name and sequence numbers they will continue to be used.

Note: Never share rotating log files over multiple concurrent sessions. The size calculations will not be accurate.

For non-rotating log files, /append can be useful when two sessions are started, either simultaneously or sequentially. The file will contain the logging information from both sessions.

If /append is not defined, the file will contain only the logging information of the last session.

Related Topics