Previous PageTable Of ContentsIndexNext Page

APPENDIX B File Structures


APPENDIX B File Structures


/etc/opt/faximum/faximum.conf File

This describes the format of the system parameter file in detail.This file contains those parameters that affect the operation of the system as a whole.

General Structure

The system parameter file is a flat text file that contains information on system-wide configuration parameters. A sample faximum.conf file appears below:

The parameters themselves are defined below (see "Parameters" on page 98). Note that some parameters are only used with FMS while some others are only used with the FMS+PLUS. Furthermore, some FMS parameters apply only to the SMTP Daemon configuration and some FMS parameters apply only to the Sendmail Delivery Agent configuration. Those below not marked are used in all configurations.

Location

The Faximum Messaging Server configuration file is always named /etc/opt/faximum/faximum.conf.

Parameters

company-addr1..4

company-name

default-retry-delay, default-retry-limit

efg-account

efg-class

efg-style

efg-debug

efg-priority

efg-submitfax

efg-addr-params

efg-addrtype

efg-api

efg-debug

efg-notify

efg-priority[value].

efg-submitfax-faxhost.

fms-banner

fms-config-directory

fms-coversheet

fms-directory

fms-hostname

fms-ip-addr

font-server

fms-submitfax.

resolution

spool-directory


Fax Line File(s)

This describes the contents of the fax line file(s) which describe the parameters associated with each fax phone line connected to (and under the control of) the Faximum Messaging Server.

General Structure

There are two types of fax line files: those that describe external Class 2/2.0 fax modems and those that describe Dialogic Gammalink boards.

Both types of fax devices require the following common set of parameters:

External Class 2/2.0 fax modems require the following set of parameters:

Dialogic Gammalink fax boards require the following set of parameters:

Location

The fax line file(s) are located in the dev directory in the FMS configuration directory (which is /etc/opt/faximum by default). The fax line file(s) can be named anything but Faximum Software recommends that the first be called fax-line-1, the second fax-line-2, etc.

Parameters Common to Fax Modems and GammaLink Boards

device-type

line-type

number-of-rings

pulse-dial

tsi

receive-only

Parameters Used by Fax Modems (only)

class2-type

data-receive

device

fax-speed

modem-init-string

speed

uucp-lock-file

Parameters Used by GammaLink Boards (only)

channel

chassis


Mime Types File

This describes the types of email attachments that the FMS will accept and provides information to the FMS on how to convert attachments into a format that can be faxed.

In order to fully understand the structure of this file it would be useful to review the sections of the manual that describe the Windows File Conversion Daemon (WFCD) and SCO Merge (see "Files, Faxing" on page 48).

Normally it would not be necessary for the FMS administrator to change this file. Indeed, inappropriate changes can cause the FMS to fail to handle any messages at all.

General Structure

The mime types file is a flat text file that contains information used by the FMS to recognise the type of a file attached to an email message and to determine how (or even if) to process it. For example:

Each line contains up to five fields. Continuation lines are not permitted. Fields may be separated by any number of white-space characters.

Field 1 - MIME Content Type

The first field is the mime type as reported by in the message itself. Trailing wildcards are permitted (e.g. text/*).

Field 2 - File Name Extension

The second field is the name of the file extension. It may be either the extension (without the .) or *.

When the SWIIFT EFG has an attachment to convert, it scans this file in order and takes the first line that matches the first two fields.

Field 3 - Processing Flag

Possible flag values:

ascii attachment is (will be) in ASCII format

error attachment cannot be handled, fail entire message

ignore attachment should not be handled, continue with warning

mswin attachment is in an MS Windows file format

pcl attachment is (will be) in PCL-5 format (see also below)

ps attachment is (will be) in PostScript format (see also below)

text attachment is (will be) in ASCII format

tiff attachment is (will be) in TIFF-F format

The difference between ascii and text is that an attachment of type ascii will be added to the fax as a separate attachment starting on a new page, while an attachment of type text will be included on the coversheet message in-line with other text components.

Use of the mswin, pcl, and ps flags requires that the appropriate conversion engine be installed. In particular, use of the mswin flag requires that SCO Merge and the Windows File Conversion Daemon be installed (see "Mechanism I - SCO Merge (SCO OpenServer/UnixWare only)" on page 49). The pcl and ps flags require the installation of a PCL and PostScript (respectively) conversion engine. These components are not part of FMS.

Field 4 - Conditional File (optional unless Field 5 is present)

This field provides a method by which the software can determine on the fly if this type of attachment can be handled. This field can either provide a filename (if not rooted then it is taken as relative to the fax software home directory). For example, if this field contains convert/pcl then this type of conversion will only be supported (attempted) if the file convert/pcl exists in the FMS home directory.

An alternate form of this field is to put an @ symbol in front of a rooted path name. In this case the file named is read to see if the file name extension is contained in the file. If it is not (or the file itself does not exist) then the conversion is failed. This method is used to communicate with the WFCD.

If the conversion fails, then the message as a whole will be rejected.

Field 5 - Conversion Command (optional)

If the fifth field (command) is blank, then it means that the attachment requires no additional processing before being included in the fax. If the field is not blank, then it must specify a shell command line that will convert the attachment into one of the supported file types, as specified by the third column (the flag value).

The shell environment variable $input will contain the name of the input file (to be converted) and $output will contain the name of the output file (to be created and to contain the results of the conversion).

Location

The mime types file is called mime-types and is stored in the configuration directory for the Faximum Messaging Server. The configuration directory is defined by the config-dir parameter in the /etc/faximum.conf file. The user can specify the directory to use during installation but by default the directory is /var/faximum.


Users File

This describes the format of the user parameter file in detail. The users file contains all of the information related to users who are authorised to use the FMS system.

NOTE: Faximum is currently exploring the use of LDAP and LDIF to provide FMS with the equivalent information to the users file. Any FMS customers who are running LDAP are invited to contact Faximum Software for current information on integrating FMS with LDAP.

General Structure

The user parameter file is a flat text file that contains information on every user authorised to use the Faximum Messaging Server. For each user there is a section that contains the user's "account name" (which must be unique) along with the parameters related to that user. For example:

Each section begins with the `[name]' line that provides the common name for this user. The sections for the different users are concatenated one after the other in the file.

Location

The user parameter file is called users and is stored in the configuration directory for the Faximum Messaging Server. The configuration directory is defined by the config-dir parameter in the /etc/opt/faximum/faximum.conf file. The user can specify the directory to use during installation but by default the directory is /etc/opt/faximum.

2001 Faximum Software Inc.

Faximum Technical Support

Previous PageTable Of ContentsIndexNext Page