OpenTP1 Version 7 Programming Guide

[Contents][Index][Back][Next]

2.5.1 Outputting message log from application programs

User-selected information can be output as a message log from OpenTP1 when the function dc_logprint() [CBLDCLOG('PRINT ')] is called from the UAP. The message log is output to the message log file. To display the contents of the message log file, execute the logcat command to output the contents to the standard output.

The message log can also be output to the standard output in real time when it is output to the message log file. Whether to output the message log to the standard output in real time can be specified in the log service definition.

The figure below shows message log output from a UAP.

Figure 2-50 Outline of message log output from UAP

[Figure]

Organization of this subsection
(1) Contents of output message logs
(2) Output format of message logs
(3) Notes on passing messages to NETM

(1) Contents of output message logs

Table 2-2 explains the contents of message log information to be output to the message log file. The request source program ID, message ID, and message log text are the items to be specified from the UAP. The information shown in Table 2-2 and OpenTP1 control codes are output to the message log file.

Table 2-2 Contents of message logs output to message log file

Item number Item Output length Explanation
-- Line header Message log serial numbers 7 single-byte characters Serial numbers of all message logs. If a message log is missing due to an error, the message log is identified because the serial numbers do not include the corresponding message log serial number.
Process ID 5 single-byte characters ID of the process that specified message log output.
Message log serial number for each process 7-digit single-byte number Message log serial number for each process that requested output.
(1) OpenTP1 ID 2 single-byte alphanumeric characters OpenTP1 system ID
(2) Date and time 19-digit integer Output request time of the message log. The message log is output in the year/month/date hour:minute:second format.
(3) Request source node name 8 single-byte alphanumeric characters Name of the node having the UAP that requested message log output.
The first 8 characters of the node name are output.
(4) Request source program ID 3 single-byte alphanumeric characters The first character is fixed as *. Two characters specified as the request source program ID in the UAP are set following *.
(5) Message ID 11 single-byte alphanumeric characters ID given to each message log by a UAP when the UAP requested message log output. The message ID format is as follows:

KFCAn1n2n3n4n5-X

KFCA:
Fixed part

n1n2n3n4n5:
Serial number specified in the UAP. Serial numbers 05000 to 06999 are assigned to message logs output by the UAP.

X:
Uppercase letter which indicates the type of the message log
E: Error message log
I: Informational message log
W: Warning message log
R: Response request message log
(6) Message log text Variable length up to 222 characters Character string in shift JIS code specified by the UAP.

(2) Output format of message logs

The following figure shows the display format of message log data output from a UAP by the function dc_logprint() and viewed in the standard output using the logcat command. The command options are omitted in this example. For details on the logcat command, see the manual OpenTP1 Operation. The circled numbers in the figure correspond to the numbers in Table 2-2.

Figure 2-51 Output format of message logs

[Figure]

(3) Notes on passing messages to NETM

Message logs issued by UAPs can be output to the operation support terminal of the integrated network management system (NETM) in the same manner as for OpenTP1 message logs. The contents of a message log output to the NETM include the following information:

The display color of a message log to be output to the operation support terminal can be specified in the UAP.

Note the following points when outputting a message log output by a UAP to the NETM:

NETM: Integrated Network Management System