(Note that keys in blue are Boolean values: 1 – True; 0 – False)

[User Personal Data]

Key

Description

FS Command or Variable

Name

User full name

USERINFO_NAME

Title

User title

USERINFO_TITLE

Department

User department name

USERINFO_DEPT

Company

User company name

USERINFO_COMPANY

Address Line 1

Address line 1

USERINFO_ADDR1

Address Line 2

Address line 2

USERINFO_ADDR2

City

City

USERINFO_CITY

State

State

USERINFO_STATE

Province

Province

USERINFO_STATE

Zip Code

Zip code

USERINFO_ZIP

Postal Code

Postal code

USERINFO_ZIP

Country

Country


Phone

User/company phone number

USERINFO_PHONE

Fax

User fax number

USERINFO_FAX

Email

User email address

USERINFO_EMAIL

Office

User office name/location

USERINFO_OFFICE

Send As

Sender name

$fax_sender

Voice

User direct voice number


Extension

User phone extension


Pager

User pager number


Notes: The Province name is placed in USERINFO_STATE if no state name is given. The Postal Code is placed in USERINFO_ZIP if no zip code is given. The Voice, Extension, and Pager fields are used for notification when that type of notification is specified. Fax and Email entries are also used for notification and email forwarding. The Email entry must also be present in order for the client to send email (along with email threads on the CopiaFacts server).

 

[User Config Data]

Key

Description

FS Command or Variable

FaxFacts User Profile

User Profile

$fax_user

Default Address Book

Default Address Book


Default Cover Sheet

Default Cover Sheet


Fax Header

Fax header / e-mail subject

$fax_header/$email_subject

Fax Priority

Fax queue (0 - 15)

$fax_tosend

Notify on Fail

Fail notification flag


Notify on Pass

Pass notification flag


Delete Option

Delete bit flags: 1=temp, 2=fail, 4=sent

$delete_option

Job owner

(Legacy) Job Owner


Mailbox

Mailbox number (see notes below)


Phone Account 1

First phone account


Phone Account 2

Second phone account


Test Fax

Test fax number for broadcast

$fax_phone

No Cover Page

Force no cover page


Convert To Single Pages

Split fax into separate pages


Test Email

Test e-mail address for broadcast

$email_address

Post Activity Record

Post contact activity


Fax Privacy Option

Flag private section


Alert on Fax Received

Flag to alert for fax


Notify by Email

Email notification


Notify by Fax

Fax notification


Notify by Voice

Voice notification


Notify by Pager

Pager notification


Autosave Settings

Save settings on exit


AutoExit

Exit after print / send / save


AutoClear

Clear attachments


Force Attachment Copy

Copy attachments to server


Notes:  The mailbox number corresponds to the CopiaFacts mailbox that will contain received faxes for this user, and which will be opened by FFVIEWER when used to view incoming mail. Generally, this is the DID number that is the user’s fax number. Notification and client activity posting and the FS file variables associated with these two operations are discussed in a separate document. The fax privacy and fax alert options are not implemented yet.

 

[PHONEBOOKn]

Key

Description

FS Command or Variable

BOOKNAME

Address book name


BOOKPATH

Address book full path


BOOKTYPE

Address book data type


PIN

Legacy PIN field name


NAME

Legacy recipient field name


CLASS

Legacy class field name


PHONE

Legacy fax number field name

$fax_phone

Email Address Field

Email address field name

$email_address

Other Fax Field

Alternate fax number field name

$fax_phone

NATIVE

Flag to allow updates


Default

Flag for default address book


LinkFile

UDL file name


BCFn

Broadcast field names

BCFn

Profile/User

Address book user name


Password

Address book password


ColumnWidths

Display column widths


TableName

Table containing recipients


Selectn

Selection Criteria


The n in the section title is a sequential numeric value from 1 – 99 that uniquely identifies each address book in the user’s collection. Broadcast fields are also numbered in sequence and will be included as variable information in the generated FS file. Selection criteria are sequentially numbered. Selection criteria are present if only a select portion of a database table is to be considered for the address book. This essentially allows different views of the same address book.

 

[FFClient Special]

Key

Description

FS Command or Variable

FFClient Setup

Flag indicating setup done


FFClient Setup Date

Date setup was done


 

[Last Broadcast Job]

Key

Description

FS Command or Variable

FirstFS

First FS file number for broadcast


LastFS

Last FS file number for broadcast


Date

Date last broadcast run


Time

Time last broadcast run


Owner

Owner for last broadcast


Job

Job identifier for last broadcast


 

[Recent Recipients]

The recent recipient section contains an entry for each of up to 100 of the most recent recipients. The entry consists of the recipient name followed by an equals sign (=) followed by a segmented list containing the recipient fax number, the recipient email address, the class field value, the recipient address book type, and the PIN field value. The segment separator is the broken vertical bar.

 

[FF_CONSTANT]

The FF_CONSTANT section contains entries that will be placed directly in the FS file when it is generated, provided the entries do not conflict with other options. Each entry key has the form FF_CONSTANTn where n is a sequential number starting with 0. The express install creates a zero entry with a $var_def for variable user with a value that is the same as owner name.

 

[Cover Sheet n]

Key

Description

FS Command or Variable

Cover Sheet Name

Cover sheet name


Cover Sheet File

Full path to cover sheet file

$fax_cover

Default

Flag for default cover sheet


 

Notes: The n in the section title is a sequential numeric value from 1 – 99 that uniquely identifies each cover sheet in the user’s collection.