PMDF System Manager's Guide
PMDF-REF-6.0

37.2.13 Usage logging

The logging channel keyword may be used with the G3_TO_FAX and FAX_TO_DATA channels so as to log outbound and inbound FAX activity. (See Section 2.3.4.84 for general information on PMDF's logging facilities.) When it is used with a G3_TO_FAX channel, however, extended logging information will appear in the usage logs.⁷ Each log entry produced by the G3_TO_FAX channel consists of eight fields followed by as many as 256 additional fields of the form XX-HHMMSS:

The date the entry was made (e.g., "29-NOV-1990").
The time the entry was made (e.g., "12:13:18").
The name of the channel logging the entry (e.g., "g3_to_fax").
The beginning time HH:MM:SS and the ending time hh:mm:ss of the FAX transmission encoded in the format HHMMSShhmmss (e.g., "121034121248" corresponds to the beginning time 12:10:34 and ending time 12:12:48). The beginning time is the time at which the channel began sending data to the FAX modem; the ending time is the time at which the FAX modem sent an "all done" message back to the channel. The difference of these two times will typically exceed the actual amount of time the FAX modem spent on the phone line transmitting (or attempting to transmit) the FAX message.
A single character indicating the status of the transmission: S = success; A = delivery attempt aborted, message requeued (temporary error); F = delivery failed, message not requeued (permanent error); and, M = maximum number of delivery attempts exceeded, message not requeued (permanent error).
Number of FAX pages transmitted (including the cover page).
Envelope From: address (i.e., e-mail address of the message originator, e.g., "bob@hmcvax.claremont.edu").
FAX telephone number to which the FAX was transmitted. This is the number specified by the message originator and not the modified number returned by the optional FAX_NUMBER mapping or FAX_VALIDATE procedure.

The XX-HHMMSS fields log the time, HH:MM:SS, at which the modem response XX was received by the G3_TO_FAX channel. The modem response codes, XX, are given in Table 37-2 .

Table 37-2 FAX modem response codes
Code Interpretation

AC Abnormal end. An incoming call terminated unexpectedly.

BU Busy signal. The FAX modem was answered by a busy signal after dialing the specified telephone number. When this occurs, the message is requeued for retransmission.

CD Connected to a data modem. The FAX modem has connected to a data modem and not a FAX device.

CED Answer tone detected. The FAX modem's call has been answered.

CFR Remote confirmation to receive received. The FAX modem has received a confirmation to receive prompt, CFR, from the remote FAX device.

CO Connected. The FAX modem has connected to a CCITT G3 FAX device, has completed a CCITT T.30 handshake, and will begin transmitting or receiving the FAX image.

CRP Repeat request (CRP) received.

CS CSI received. The Calling Station Identification string has been received from the remote FAX device.

DC, DCN Line disconnected. A telephone problem or unrecoverable data communication error occurred causing the telephone link to be disconnected. When this occurs, the message is requeued for retransmission.

DI Dialing. The FAX modem is dialing the specified telephone number.

DCS Capabilities negotiated. The FAX modem has reported that the capabilities and intentions have been negotiated.

DIS Remote device's capabilities frame received. The FAX modem has received the remote FAX device's capabilities frame.

EC Error count. One or more received FAX scanlines were in error.

ED End of incoming data. A remote FAX device has finished transmitting facsimile data to the FAX modem.

EI End of incoming call. A remote FAX device has completed its call to the FAX modem.

ER Error. The FAX modem could not implement the received instructions.

FI Fine resolution. The FAX modem is switching to high (fine) resolution mode to receive an incoming, high resolution FAX.

HF Host fail. The FAX modem noticed that DTR was dropped for a period of time and has decided to reset itself.

ID Incoming data follows. A remote FAX device has begun to transmit facsimile data to the FAX modem.

IF Incoming FAX. FAX modem has detected an incoming FAX.

IH Incoming handshake received. A FAX device has called the FAX modem and the CCITT T.30 handshake has been received.

IS Incoming statistics. A remote FAX device has just sent facsimile information ( e.g., resolution) to the FAX modem.

MB Mailbox mode request. The remote FAX modem has requested that a proprietary secure mailbox mode be used.

MR Modem reset. The FAX modem has reset itself.

NA No answer. No recognizable FAX signal was detected within 55 seconds of dialing the specified telephone number: either the remote FAX device did not answer the call ( e.g., remote FAX device out of paper, jammed, etc.) or the call was answered but no recognizable signal was detected ( e.g., call was answered and followed by silence or a human voice which was not recognized to be a voice). When this occurs, the message is requeued for retransmission.

NC No connection. The FAX modem failed to connect with a remote FAX device.

ND No dial tone. When the FAX modem went off-hook it failed to detect a dial tone. Is the FAX modem connected to the phone line?

NF Not a FAX number. The FAX modem was answered by a non FAX device after dialing the specified number. When this occurs, the delivery of the message is aborted; it is not requeued for retransmission.

NO No carrier.

NR Modem not ready. The FAX modem is not ready to transmit a FAX. When this occurs, the message is requeued for retransmission.

NS Error in page. One or more errors were reported for a received or transmitted FAX page. These errors are caused by line noise and indicate that one or more scanlines were in error.

NT Normal call termination. The message was successfully transmitted or received.

OK OK response received.

PD Password received. A mailbox password was received.

PS Page sent or received successfully (MCF). A page was sent or received without any transmission errors.

PW Poll wait. The FAX modem is set for a polling operation and is awaiting an incoming call. When this occurs, the message is requeued for retransmission.

RD Modem ready. The FAX modem is ready to begin a transmission or reception.

RI Ringing. The FAX modem has dialed the specified number and a ringing tone is being received. Alternatively, someone is calling the FAX modem.

SN Serial Number. The FAX modem has reported its serial number.

SP New speed. The FAX modem has reported the speed at which it is transmitting or receiving.

ST Standard resolution. The FAX modem is switching to low (standard) resolution mode to receive an incoming, low resolution FAX.

TD Transmission Data. Transmission data and statistics received from the FAX modem.

TS TSI received. The Transmitting Station Identification string has been received from the remote FAX device.

UR Data underrun. The FAX modem was not receiving image data from the G3_TO_FAX channel at a high enough rate to carry out the FAX transmission. When this occurs, the message is requeued for retransmission.

UW Nearing underrun. The FAX modem is not receiving image data from the G3_TO_FAX channel at a high enough rate; its buffers are running low.

VE Version received. Version number of the FAX modem firmware received.

VO Voice. A human or other non-FAX device answered the call.

UN Unknown response code received.

WC Wrong CSI received. The FAX modem did not receive the required CSI string and has therefore terminated the transmission.

WE Modem wedged. The FAX modem is stuck in an unknown state and cannot be reset. Take a trip to the machine room and cycle its power if this persists.

**Table 37-2 FAX modem response codes**
Code	Interpretation
AC	Abnormal end. An incoming call terminated unexpectedly.
BU	Busy signal. The FAX modem was answered by a busy signal after dialing the specified telephone number. When this occurs, the message is requeued for retransmission.
CD	Connected to a data modem. The FAX modem has connected to a data modem and not a FAX device.
CED	Answer tone detected. The FAX modem's call has been answered.
CFR	Remote confirmation to receive received. The FAX modem has received a confirmation to receive prompt, CFR, from the remote FAX device.
CO	Connected. The FAX modem has connected to a CCITT G3 FAX device, has completed a CCITT T.30 handshake, and will begin transmitting or receiving the FAX image.
CRP	Repeat request (CRP) received.
CS	CSI received. The Calling Station Identification string has been received from the remote FAX device.
DC, DCN	Line disconnected. A telephone problem or unrecoverable data communication error occurred causing the telephone link to be disconnected. When this occurs, the message is requeued for retransmission.
DI	Dialing. The FAX modem is dialing the specified telephone number.
DCS	Capabilities negotiated. The FAX modem has reported that the capabilities and intentions have been negotiated.
DIS	Remote device's capabilities frame received. The FAX modem has received the remote FAX device's capabilities frame.
EC	Error count. One or more received FAX scanlines were in error.
ED	End of incoming data. A remote FAX device has finished transmitting facsimile data to the FAX modem.
EI	End of incoming call. A remote FAX device has completed its call to the FAX modem.
ER	Error. The FAX modem could not implement the received instructions.
FI	Fine resolution. The FAX modem is switching to high (fine) resolution mode to receive an incoming, high resolution FAX.
HF	Host fail. The FAX modem noticed that DTR was dropped for a period of time and has decided to reset itself.
ID	Incoming data follows. A remote FAX device has begun to transmit facsimile data to the FAX modem.
IF	Incoming FAX. FAX modem has detected an incoming FAX.
IH	Incoming handshake received. A FAX device has called the FAX modem and the CCITT T.30 handshake has been received.
IS	Incoming statistics. A remote FAX device has just sent facsimile information ( e.g., resolution) to the FAX modem.
MB	Mailbox mode request. The remote FAX modem has requested that a proprietary secure mailbox mode be used.
MR	Modem reset. The FAX modem has reset itself.
NA	No answer. No recognizable FAX signal was detected within 55 seconds of dialing the specified telephone number: either the remote FAX device did not answer the call ( e.g., remote FAX device out of paper, jammed, etc.) or the call was answered but no recognizable signal was detected ( e.g., call was answered and followed by silence or a human voice which was not recognized to be a voice). When this occurs, the message is requeued for retransmission.
NC	No connection. The FAX modem failed to connect with a remote FAX device.
ND	No dial tone. When the FAX modem went off-hook it failed to detect a dial tone. Is the FAX modem connected to the phone line?
NF	Not a FAX number. The FAX modem was answered by a non FAX device after dialing the specified number. When this occurs, the delivery of the message is aborted; it is not requeued for retransmission.
NO	No carrier.
NR	Modem not ready. The FAX modem is not ready to transmit a FAX. When this occurs, the message is requeued for retransmission.
NS	Error in page. One or more errors were reported for a received or transmitted FAX page. These errors are caused by line noise and indicate that one or more scanlines were in error.
NT	Normal call termination. The message was successfully transmitted or received.
OK	OK response received.
PD	Password received. A mailbox password was received.
PS	Page sent or received successfully (MCF). A page was sent or received without any transmission errors.
PW	Poll wait. The FAX modem is set for a polling operation and is awaiting an incoming call. When this occurs, the message is requeued for retransmission.
RD	Modem ready. The FAX modem is ready to begin a transmission or reception.
RI	Ringing. The FAX modem has dialed the specified number and a ringing tone is being received. Alternatively, someone is calling the FAX modem.
SN	Serial Number. The FAX modem has reported its serial number.
SP	New speed. The FAX modem has reported the speed at which it is transmitting or receiving.
ST	Standard resolution. The FAX modem is switching to low (standard) resolution mode to receive an incoming, low resolution FAX.
TD	Transmission Data. Transmission data and statistics received from the FAX modem.
TS	TSI received. The Transmitting Station Identification string has been received from the remote FAX device.
UR	Data underrun. The FAX modem was not receiving image data from the G3_TO_FAX channel at a high enough rate to carry out the FAX transmission. When this occurs, the message is requeued for retransmission.
UW	Nearing underrun. The FAX modem is not receiving image data from the G3_TO_FAX channel at a high enough rate; its buffers are running low.
VE	Version received. Version number of the FAX modem firmware received.
VO	Voice. A human or other non-FAX device answered the call.
UN	Unknown response code received.
WC	Wrong CSI received. The FAX modem did not receive the required CSI string and has therefore terminated the transmission.
WE	Modem wedged. The FAX modem is stuck in an unknown state and cannot be reset. Take a trip to the machine room and cycle its power if this persists.

A single entry is made for each recipient of a FAX message. Thus, each G3 file in the G3_TO_FAX channel queue may produce many log entries in the log file.

With the FAX_LOG_USAGE hook, the G3_TO_FAX channel can pass logging information to a site-supplied subroutine which can then create or access its own log files using a format it controls. See Section 37.2.17.3 for information on the use of this hook.

Note

⁷ There is also a special shareable image hook which allows sites to customize FAX usage logging. See Section 37.2.17.3 .

Previous | Next | Contents

PMDF System Manager's GuidePMDF-REF-6.0

37.2.13 Usage logging

Note

7 There is also a special shareable image hook which allows sites to customize FAX usage logging. See Section 37.2.17.3 .

PMDF System Manager's Guide
PMDF-REF-6.0

⁷ There is also a special shareable image hook which allows sites to customize FAX usage logging. See Section 37.2.17.3 .