Appendix E: Transaction Log

The transaction log file is a dBASE IV, dBASE III, Clipper, FoxPro, or Paradox compatible file with the following fields defined:

 

Name

Type

Bytes

Columns

Description
 

DELETE

Character

1

1-1

(standard * dBase deletion marker)

CALLNO

Numeric

8.0

2-9

Inbound call number, sequential across the entire system. Zero for outbound calls

LINENO

Numeric

4.0

10-13

Logical line/thread number. This number is unique to each line on the system

IMAGEN

Character

8

14-21

Base filename of the fax image file sent.

GROUPN

Character

8

22-29

Base filename of fax image file requested.

STATUS

Numeric

3.0

30-32

Last processing state. See State List. For outbound, holds count of previous attempts. This is not the outcome code: see FAXSTAT below.

PAGES

Numeric

3.0

33-35

Number of pages sent

TXDATE

Date

10

36-43

Date sent (dBASE date)

TXST

Character

8

44-51

Time (HH:MM:SS) transmission started

TXEND

Character

8

52-59

Time (HH:MM:SS) transmission ended

BAUD

Character

1

60-60

Baud rate code (see below)

CALLS

Character

8

61-68

Time (HH:MM:SS) call started

ID

Character

10

69-78

Caller's Password

PHONE

Character

14

70-92

Caller's Voice Phone Number

FLAGS

Character

5

93-97

Flags (see table below)

ANS

Character

21

98-118

Remote CSID (answerback) / SIP Name for inbound VoIP

FSNUM

Numeric

8

119-126

File number of FS File (or MCF for inbound fax)

DID

Character

4

127-130

DID number if present

FAXSTAT

Numeric

4

131-134

The fax result code, see Error Code List

FAXNUM

Character

25

135-159

Dialed fax number

DATA1

Character

10

160-169

available

DATA2

Character

8

170-177

reserved, see below

DATA3

Character

4

178-181

reserved, see below

DATA4

Character

4

182-185

reserved, see below

(user data)

Character

-

186-

available

Flag Data:

Flag1

Y caller recorded message
N no message was recorded
For outbound operations: a code letter for the board/port used in the attempt
A - Commetrex Sangoma
B - Brooktrout
C - VSP
D - Dialogic
E - Email
G - Gammalink
H - VSP
I - Dialogic Diva
M - FaxModem
N - PHONESIM
O - Commetrex SIP
P - Powerfax
R - Preview
S - SMS
T - TE Systems
V - Copia VoIP
X - No attempt

Flag2

H fax sent in fine resolution
L fax sent in normal resolution

Flag3

I one-call (inbound) call
P polling used for one-call call
Ooutbound call
R request call
M mail call
v voice outbound call
e e-mail outbound call
F fax remote image update
V voice description update
U fax and voice remote update
H caller hung up call
Xrejected call
Ttransferred call

Flag4

B voice broadcast item
D DATAx field assigned from infobox
A Advice of charge shown in GROUPN field
V voice file played
P caller message played back
R caller recorded message
T call transferred
L call transferred using another line and SC-Bus connection
X invalid infobox reference has been encountered

Flag5

A..O        (outcome class) transmission rescheduled
a..o,z(lowercase outcome class) final log for failed transmission
S        final log for successful transmission
Z        final log for failed transmission (with log option logz)

DATAx contents:

The DATA3 value contains a number of seconds and the DATA4 value contains the number of pages sent in those DATA3 seconds. Provided that DATA4 is non-zero, you may therefore always divide DATA3 by DATA4 to obtain the number of transmit seconds to be counted for each outbound log record. In some cases, data is available for each separate document, and the DATA4 value will then be the same as the PAGES value in the same document log record.

In other cases, data is only available for the entire transmission, and in this case the DATA3 and DATA4 values will each be the same for all document log records involved in the transmission. The uses of DATA3 and DATA4, and DATA6 and DATA7 if defined, can be modified by using the $log_options command.

For log records with code 'D' in Flag 4, DATAx fields contain values assigned in infoboxes, for example using $set_var. If more than one field is assigned in the same infobox, the data will all appear in the same log record.

For outbound calls such as fax broadcasts, where the origin code in the FS file is user_request, you may assign values to the DATAx fields using $var_def commands in the FS file. In this case any such assignment will override the use of the same field for fax-board-specific system data such as call seconds. If the origin code is caller_request, then such assignments in the FS file are not logged if they would otherwise overwrite system data.

Baud Rate

The following codes are used:

0=2400, 1=4800, 2=7200, 3=9600, 4=12000, 5=14400,
6=16800, 7=19200, 8=21600, 9=24000,
A=26400, B=28800, C=31200, D=33600.

Code 0 is also used when no fax transmission has taken place.

Reporting from the CopiaFacts Log File

The DBF format is suitable for analysis using Excel, Access, R&R Report Writer, Crystal Reports, and most other reporting packages.  The DBF log file can be used for reporting on general system utilization and for monitoring total numbers of inbound and outbound calls and e-mails. The CATDBFX utility is provided to concatenate log files.

For job-specific reports we recommend using the JOBXLDATA, JOBXDATA or JOBDDATA programs to extract data for individual jobs into XLSX, tab-separated-value or DBF format files.