1XFERFAXLOG(5F) XFERFAXLOG(5F)
2
6 xferfaxlog - HylaFAX activity log
7
9 The file etc/xferfaxlog contains information about inbound and outbound
10 activities. The file contains one line per inbound facsimile document
11 or outbound job. The file also contains one line per expired job and
12 one line per job submitted. If the modem config setting LogCalls is
13 set to true, then the file also contains one line per received call.
14 Lines are fixed-format, tab-separated ASCII strings. Each record of a
15 facsimile transmission is of the form:
16 date SEND commid modem jobid jobtag sender ``dest-number'' ``CSI''
17 params #pages jobtime conntime ``reason'' ``faxname'' ``faxnumber''
18 <null> ``owner'' ``dcs'' jobinfo
19 A facsimile document reception record is of the form:
21 date RECV commid modem qfile <null> fax ``local-number'' ``TSI''
22 params #pages jobtime conntime ``reason'' ``CIDName'' ``CIDNumber''
23 ``callid'' <null> ``dcs'' <null>
24 Call records are of the form:
26 date CALL commid modem <null> <null> fax ``local-number''
27 ``<null>'' 0 0 jobtime conntime ``<null>'' ``CIDName'' ``CIDNumber''
28 ``callid'' ....
29 Each facsimile document retrieved by polling has a record of the form:
31 date POLL commid modem jobid jobtag sender ``dest-number'' ``TSI''
32 params #pages jobtime conntime ``reason'' ``faxname'' ``faxnumber''
33 <null>
34 An alphanumeric pager request has a record of the form:
36 date PAGE commid modem jobid jobtag sender ``dest-number''
37 ``<null>'' 0 0 jobtime conntime ``reason'' <null> <null> ``owner''
38 <null> jobinfo
39 Expired job records are of the form:
41 date UNSENT ``<null>'' ``<null>'' jobid ....
42 Job submission records are of the form:
44 date SUBMIT ``<null>'' ``<null>'' jobid ....
45 The following describes the fields in the above records:
47 date The date and time of the transaction in the format
49 MM/DD/YY HH:MM , where MM is the numeric month, DD the
50 numeric day, YY the last two digits of the year, and
51 HH:MM is the time in 24-hour format.
52 commid The communication identifier for the call.
54 modem The device identifier for the modem that was used to do
56 the send or receive.
57 jobid The job number for outbound calls.
59 jobtag The client-specified job tag for outbound calls.
61 qfile The associated queue file for the event.
63 sender The sender/receiver's electronic mailing address (facsim‐
65 ile receptions are always attributed to the ``fax''
66 user).
67 dest-number The phone number dialed for outgoing calls.
69 TSI The Transmitter Subscriber Identification string (as
71 received) for incoming calls.
72 CSI The Caller Subscriber Identification string of the remote
74 machine (as reported) for outgoing calls.
75 local-number The local phone number on which the data was received.
77 params The negotiated facsimile session parameters used for
79 transferring data encoded as described below.
80 #pages The total number of pages transferred.
82 jobtime The duration of the session; in the format HH:MM:SS.
84 This time includes setup overhead and any time spent
85 cleaning up after a call.
86 conntime The time spent on the phone; in the format HH:MM:SS.
88 This should be the time used by the PTT to calculate
89 usage charges.
90 reason A string that indicates if any problem occurred during
92 the session.
93 CIDName The received CIDName value for the session.
95 CIDNumber The received CIDNumber value for the session.
97 owner The login name of the job owner.
99 callid The CallID values other than CIDName and CIDNumber for‐
101 matted by ``::'' delimeters.
102 dcs The T.30 DCS string that was used in the facsimile commu‐
104 nication.
105 jobinfo Other formatted information about the job: totpages,
107 ntries, ndials, totdials, maxdials, tottries, and max‐
108 tries separated by slashes (``/'')
109 Note that fields may have embedded blanks. Session parameters are
111 encoded as a decimal number that contains a packed set of Class 2 ses‐
112 sion parameter values. The format is found in the source code in the
113 Class2Params::decode function. The page counts are always integral
114 numbers. Partial pages that are to be retransmitted are not included
115 in the page count.
116 The simple ASCII format was designed to be easy to process with pro‐
118 grams like awk(1).
119 If an executable named /var/spool/hylafax/etc/FaxAccounting exists then
121 it will be executed every time a record is written to etc/xferfaxlog.
122 The record fields will each serve as separate command arguments. This
123 is designed to allow attachment to external databases and other
124 accounting mechanisms. In earlier versions of HylaFAX FaxAccounting
125 would block the HylaFAX process invoking it; however, this is no longer
126 the case.
127
129 The sender field does not necessarily represent the submitter's actual
130 identity. For example, it reflects the value given by the sendfax(8C)
131 ``-f'' option. Be cautious that this field is not utilized for audit‐
132 ing if the fax user base is not trusted. Use owner instead, if possi‐
133 ble.
134
136 The date format will ``break'' in the year 2000. Information should be
137 recorded on a per-page basis for facsimile communications.
138
140 faxq(8C) faxsend(8C) faxgetty(8C)
141 June 5, 1996 XFERFAXLOG(5F)