Structure of FaxChange databases

The FaxChange database is located in the directory faxchange/data/database/ (using MS Access) or universally on a SQL server. It contains a table of users, CSID, routing and an archive of faxes.

We do NOT recommend the use of direct access to the FaxChange tables. It more advisable to use fxODBC API. The structure of this database will more than likely be changed in the future, however, for the time being fxODBC API will remain supported.

Description of individual tables in the database faDb:

tUser - table of users
tCsid - CSID routing table and identification
tPabx - PABX and service routing table
tState - table of states and towns
tFax - fax archive
tFile - table of files

tUser - table of users

Within this table is a list of user and their configuration.

Field Name

Description

fName

User Name.

fGate

Gateway (e = exchange).

fEmail

User's E-mail adress.

fId

Unique user ID.

fGroup

Group to which user belongs.

fCostCod

Payment code.

fFlags

Array of characters 'Y', 'N', 'D' (Yes, No, Default) with meaning:
Can user call internationally?
Can user call intercity?
Can user call outside the exchange?
Can user call within the exchange?
Can user send low prioirty faxes?
Can user send normal prioirty faxes?
Can user send low high faxes?
Can user send scheduled faxes?

fControl

Bit map field containing information of user type.

bits 0, 1, 2 - user type identification

bit 2 bit 1 bit 0 Description

0 0 0 Standard user

0 0 1 User with disabled faxing

0 1 1 Distribution lists, public folders (only receive is allowed, not sending)

1 0 0 FaxChange users groups

bits 6, 7 - preview sending

bit 7 bit 6 Description

0 - ^* Use group settings

1 0 Do not send preview

1 1 Send preview

bits 8, 9 - right changing costcode

bit 9 bit 8 Description

0 - Use group settings

1 0 Change allowed

1 1 Change disallowed

bits 10, 11 - right changing coversheet

bit 11 bit 10 Description

0 - Use group settings

1 0 Change allowed

1 1 Change disallowed

* Dash means, that there are no dependency for value of specified bit.

fCover

Users default cover page. Empty = takes itself from user group. "*1" = without cover page.

fLng

Spoken language of user.

fFreetex

Other settings.

tCsid - CSID routing table and identification

This table is for the routing and identification of incoming faxes.

Field Name	Description
fCsid	CSID opposition.
fFrom	Name of opposition (obtained at fax transmission for the particular CSID).
fUserid	User ID (from UsrTb) to which the faxes from this CSID will be directed.
fNumber	Telephone number corresponding the particular CSID.
fCreated	-not used-
fLastuse	-not used-

tPabx - PABX and service routing table

PABX attribute (in the form L<number>, or the physical number of the fax line.

Field name	Description
fPabx	PABX attribute (in the form L<number>, or the physical number of the fax line.
fUserid	User ID (from UsrTb) to which faxes with this PABX will be directed.

tState - table of states and towns

Table of states and towns (free selection, prices and language).

Field name	Description
fType	"c" = town, "s" = state.
fName	Name.
fPrefix	Preselection without international / intercity prefix along with the character "a" for the remainder of the column. For example: Czech Republic here has the code "420aaaaaaa" and Prague the code "2aaaaaaaaa".
fLngcode	Code of used language in this area.
fCost0	Call price per minute at peak times.
fCost1	Call price per minute at off-peak times.
fCost2	Call price per minute at night time.
fCost3	Other price.
fCost4	One more different price.
fAds	The file which ADS should use.

tFax - fax archive

tFax is an index of the fax archive.

Field name	Description
fType	Fax type. 0 = transmitted, 1 = received.
fStatus	0 = OK, other = error.
fCoverid	Link to the table files for the file with a cover page. 0 = no file. Only for sent faxes and not for non-sent faxes.
fDataid	Link to the table Files for the file with a cover page.
fOrigid	Link to the table Files for the file with original fax data. 0 = no file. Only for sent faxes and not for non-sent faxes.
fPriorit	Fax priority ("L", "N" or "H"). Only for sent faxes and not for non-sent faxes.
fId	Unambiguous fax ID.
fLine	Number of line on which the fax was sent / received.
fSpeed	Speed of connection.
fTime	Date and time of connection in UNIX format (total of seconds from date 1.1.1970). Can be resolveed by function localtime() (time.h).
fOnline	Time spent on-line.
fSubject	Subject used for recipient delivery. Only received faxes. Subject of the sent fax. Only with sent and non-sent faxes.
fSpecial	User ID.
fName	Name of sender. Only with sent and non-sent faxes. Name of addressee. Only with sent and non-sent faxes.
fGate	Gateway of sender (e = Exchange). Only with sent and non-sent faxes. Recipent Gateway (e = Exchange). Only received faxes.
fEmail	E-mail address of sender. Only with sent and non-sent faxes. Recipient E-mail. Only received faxes.
fGroup	Group in which the sender is (moment of fax transmission). Only with sent and non-sent faxes.
fCostcod	Fax cost code. Only with sent and non-sent faxes.
fTofrom	Name which has been assigned to sender of fax (if corresponding value CSID is in database). Only received faxes. Display name of addressee. Only with sent and non-sent faxes.
fToname	Name of addressee. Only with sent and non-sent faxes.
fCompany	Addressees' company name. Only with sent and non-sent faxes.
fDept	Addressees' department name. Only with sent and non-sent faxes.
fNumbers	List of all destination telephone numbers. Only with sent and non-sent faxes.
fNumber	Number on which the fax was delivered or on which the last transmission attempt was made. Only with sent and non-sent faxes.
fAttempt	Number of attempts. Only with sent and non-sent faxes.
fCost	Fax price. Only with sent and non-sent faxes.
fCsid	CSID opposition. Only with sent and non-sent faxes.
fFromcsi	CSID of sender. Only with received faxes.
fTopabx	PABX received with fax. Only with received faxes.
fFreetex	Other informations.

tFile - Table of files

A table containing files.

Field name	Description
fId	Unambiguous file ID. It is linked from the table FaxInfo.
fName	Original file name.
fCounter	Number of references of it (if Faxmailing is sending the body of the fax it is archived only once whereas the cover page is created for every addressee).
fData	Previous file data. Coded - processed likely with fxODBC API.