RightFax 9.3 Administrative Utilities Readme

This document describes the installation and features included with RightFax 9.3 Administrative Utilities.

1. Installing the Administrative Utilities

2. Using the RightFax Administrative Utilities

Installing the Administrative Utilities

RightFax includes several administrative utilities that are installed separately from the RightFax server installation. It is strongly recommended that you install the administrative utilities on the RightFax server immediately after installing the server software. The administrative utilities installation files are available at http://www.captaris.com/support/documentation/rightfax/index.html.

The following table lists each of the administrative utilities that are installed in this procedure.

Utility	Description
ChgUser.exe	Changes RightFax privileges and options for all users or groups of users at once.
DSender.exe	Uploads RightFax user IDs to the HP 9100C Digital Sender so that RightFax can apply users specific fax transmission and notification options.
FaxAge.exe	Deletes faxes from RightFax users mailboxes at scheduled interval.
FaxDump.exe	Outputs fax data in text format for import into other databases.
Fax Reporter	Organizes and presents data from your RightFax database for reporting and billing purposes. The Fax Reporter installation includes components of Crystal Reports 8.0. If you have installed other software that uses a different version of this software, a conflict may occur.
FaxStat.exe	Remotely monitors any RightFax server on the network.
ImpUser.exe	Imports users from a comma-delimited ASCII file.
ModUser.exe	Changes user settings for multiple RightFax users.
ODBCSync.exe	Imports user, printer, and billing code information from an ODBC source.
Perl	The Perl scripting language for use with the RightFax Integration Module.
PhnPrint.exe	Prints the published and private phonebook entries of one or more RightFax users.
RFDiag.exe	Displays diagnostic information about the RightFax server.
ServSync.exe	Compares database objects on two RightFax servers.

To install the RightFax administrative utilities

1. Browse to and run the file AdminUtils\Setup.exe. The RightFax Administrative Utilities install wizard opens.
2. Click Next at the opening screen to open the RightFax license agreement. You must accept the license agreement in order to continue the installation. Enter your name and company name when prompted. Click Next.
3. Select Complete or Custom install. If you select Complete, all of the administrative utilities will be installed except Perl. To install Perl or to install only selected administrative utilities, select Custom. If you select the custom install, a message will appear asking you to specify the applications you want. When you have specified the administrative utilities to install, click Next.
4. Click Install. The Setup program will install the specified utilities on the RightFax server. When the files have all been installed, click Finish to complete the installation.

<< Return to ReadMe Contents

Using the RightFax Administrative Utilities

All of the RightFax administrative utilities are installed in the RightFax\AdmUtils folder or one of its subfolders on the RightFax server. Fax Reporter and Modify User are 32-bit programs that can be launched from the Windows start menu. Each of the administrative utilities is described below.

Running ChgUser.exe

ChgUser.exe is a command line utility that changes RightFax permissions and options for multiple users at once. ChgUser.exe is located in the RightFax\AdmUtils folder on the RightFax server.

Syntax:

chguser [options] [keywords]

Command Line Options

Option	Function
-1number	Specify default fax number for users
-2number	Specify default voice number for users
-3	Display a user list with ID, name, and routing code
-4	Reset all user names to match user IDs
-6	Display a tab-delimited user list with ID, name, routing code, and group ID
-7option	Set auto-print options for users using the following: b = Print fax body c = Print fax cover sheet t = Print transmission history f = Print for failed faxes only s = Print for successful faxes only
-aprinterID	Specify the printer ID to which received faxes should be automatically printed
-bprinterID	Specify the printer ID to which sent faxes should be automatically printed
-cfile	Specify the cover sheet file (i.e. FCS.pcl) for users
-d	Turn on Debug mode
-fserver	Specify the name of RightFax server
-ggroupID	Name of group in which to place users. The group ID must already exist
-iDIDnum	Specify a routing code for the users
-luserID	User ID to log in to the RightFax server
-mVMSID	Specify a voice mail subscriber ID for the users
-nsend,receive	Sets sent and received fax notifications. Separate send and receive values with a comma (i.e., -n0x80,0x00) Values for send are: 0x01 = Send Info incomplete message once 0x02 = Send Info incomplete message periodically 0x04 = Send Sending.... message once only 0x08 = Send Sending... message periodically 0x10 = Send Error, will be retried messages 0x20 = Send Successful send messages 0x40 = Send Error, will be aborted messages 0x80 = Do not notify about faxes held for preview Values for receive are: 0x00 = Do not send messages for received faxes 0x01 = Send new fax message once only 0x02 = Send new fax message periodically To enable multiple notifications, add the values of all desired notification options. For example, to enable send options 0x01, 0x10, and 0x40, use the value 0x51.
-opassword	Password for the user ID used to log in to the RightFax server. To use NT authentication, leave this blank
-pprinterID	Specify the ID of the default printer for users
-rtype	Specify routing types for users using the following: RF = RightFax mailbox GW = GroupWise OCR = Optical Character Recognition CX = Telephony Server EXCH = MS Exchange NOTE = Notes XRT = RightFax Interconnect TRS = TRS NetComm Server SMTP = SMTP mail FILE = network folder Add + to the end of the routing type to delete the original file after routing (e.g., -rSMTP+)
-sformat	Fax file routing format using the following: PCX = PCX format DCX = DCX format G3 = TIFF-G3 format G4 = TIFF-G4 format PDF = PDF format GIF = GIF format
-tprotocol	Force protocol to specific type (rather than assigning automatically) using the following: n = Named Pipes s = SPX t = TCP/IP x = IPX
-uuserIDs	Comma delimited list of users to change
-v	Display current values for users

Command Line Keywords

Keyword	Function
admin/ noadmin	Enables/disables administrative privileges
allowocr/ noallowocr	Enables/disables the permission to OCR faxes
archive/ noarchive	Enables/disables archiving of all sent faxes
auditstamprecv/ noauditstamprecv	Enables/disables the Stamp Pages of Received Faxes With Audit Stamp permission
autoforwardfax	Enables the autoforward feature to a fax machine. Use Noautoforward to disable the autoforward feature Note If this feature has never been enabled in the user configuration in Enterprise Fax Manager, no fax machine information will exist and this feature will not work
autoforwarduser	Enables the autoforward feature to a RightFax user. Use Noautoforward to disable the autoforward feature Note If this feature has never been enabled in the user configuration in Enterprise Fax Manager, no user ID information will exist and this feature will not work
autoprint/ noautoprint	Enables/disables automatic printing of received faxes. Use -7 and -A options to set printer ID and autoprint options
billcodeedit/ nobillcodeedit	Enables/disables changing of default billing code settings
billcodelookup/ nobillcodelookup	Enables/disables ability to select billing codes by ID
bodyfine/ bodynormal	Sets resolution of fax body to fine or normal
bypassbillcodeverify/ nobypassbillcodeverify	Enables/disables permission to bypass billing code verification
coverfine/ covernormal	Sets resolution of fax cover sheet to fine or normal
coverpage/ nocoverpage	Enables/disables sending a cover page with every fax. Use -C option to set cover sheet file
defaultbc/ nodefaultbc	Enables/disables the Assign Default Billing Codes to Received Faxes permission
deleteaftersent/ deletealways/ deletenever	Specifies Autodelete setting for when to delete sent faxes from the FaxUtil mailbox
emptytrash/ noemptytrash	Enables/disables the users option to automatically empty the use the Trash folder when exiting FaxUtil
highp/ nohighp	Enables/disables the availability of High Priority for user
noautoforward	Disables the autoforward feature
nontsecurity	Disables the Use NT authentication feature
protected/ unprotected	Sets user mailbox to protected (requires password) or unprotected (does not require password)
sautoprint/ nosautoprint	Enables/disables automatic printing of sent faxes. Use -7 and -B options to set printer ID and autoprint options
smartresume/ nosmartresume	Enables/disables the Smart-Resume feature
usetrash/ nousetrash	Enables/disables the users option to use the Trash folder when deleting faxes in FaxUtil

IMPORTANT: Unless you use the -u option to specify individual RightFax user IDs, ChgUser commands will be applied to all RightFax user IDs.

Example:

chguser -frfserver -v
chguser -frfserver -ubob,fred noadmin
chguser -frfserver2 -v -alaser4 autoprint

Running DSender.exe

DSender.exe is a command line utility that synchronizes user IDs between RightFax and an HP Digital Senders on your network. You can either import your RightFax user IDs to each Digital Sender or export the User IDs on each Digital Sender to RightFax (up to a maximum of 1,024 user IDs). The method you choose depends on which system already contains the most comprehensive user ID list. DSender.exe is located in the RightFax\AdmUtils folder on the RightFax server.

IMPORTANT: User synchronization with DSender.exe is not dynamic. If new users are added, you will need to re-run the DSender.exe utility to synchronize the user lists.

Syntax:

dsender -idigsender [-aaccount] -ppassword -ffaxserver [-uuserID] [-t{n|s|t}] [-1] [-s] [-z]

Command Line Options

Option	Function
-idigsender	Specifies the IP address of the Digital Sender.
-aaccount	The account name used to log on to the Digital Sender. Default account name is ADMINISTRATOR.
-ppassword	The password for the account name used to log on to the Digital Sender.
-ffaxserver	The name of the RightFax server to synchronize.
-uuserID	Specifies the user ID to use as the model when creating new users (usually set to DEFAULT).
-tprotocol	Force network protocol to specific type (rather than assigning automatically) using the following: n = Named pipes (default) s = SPX t = TCP/IP
-1	Copies user IDs from the HP Digital Sender to RightFax. The default setting is to copy user IDs from RightFax to the HP Digital Sender.
-s	Disallows synching of the ADMINISTRATOR account.
-z	Deletes existing unmatched users from the destination system.

Example:

dsender -i38.2.54.156 -pmypassword -frfserver -tt -z

This example logs on to the Digital Sender at IP address 38.2.54.156 using the user name administrator and the password joshua. It then copies the user IDs from the RightFax server RFaxServ to that Digital Sender using the TCP/IP protocol and leaves the Administrator user ID on the Digital Sender unchanged.

Running FaxAge.exe

FaxAge.exe is a command line utility that deletes faxes from RightFax users mailboxes. FaxAge.exe is located in the RightFax\AdmUtils folder on the RightFax server.

IMPORTANT: The fax server must be running when executing this utility.

Syntax:

faxage -fserver -auserID -ofile [-dvalue] [-emm/dd/yyyy] [-llevel] [-ppassword][-q] [-smm/dd/yyyy] [-t{n|s|t|x}] [-uuserIDs] [-wfolder] [-y] [-z]

Command Line Options

Option	Function
-auserID	The RightFax user ID to use when logging in to the RightFax server. A password can be required using the -p option.
-dvalue	Specifies which faxes should be deleted: 1 = only received faxes 2 = only sent faxes 3 = all faxes (default) 4 = only viewed or printed faxes 5 = only printed faxes 6 = only non-approved faxes 7 = only approved faxes
-emm/dd/yyyy	Specifies the ending date of the date range to delete. This can also be specified as a day offset, i.e, -e-30 (default is 12/31/2010). Note You must use the 4-digit year format or the date may be read incorrectly.
-fserver	Specifies the name of RightFax server.
-llevel	Information level 0 or 1 (default is 0).
-ofile	Output file listing all deleted faxes. If the file already exists, the new file list will be appended to the end.
-ppassword	The RightFax password for the user ID specified with the -a option. To use NT authentication, leave this option blank.
-q	Prints a table containing field definitions for information levels. This options overrides all other options and causes the program to do nothing else.
-smm/dd/yyyy	Specifies the starting date of the date range to delete. This can also be specified as a day offset, i.e, -s-30 (default is 01/01/1980). Note You must use the 4-digit year format or the date may be read incorrectly.
-tprotocol	Forces protocol to specific type (rather than assigning automatically) using the following: n = Named Pipes (default) s = SPX t = TCP/IP x = IPX
-uuserIDs	Comma delimited list of users (default is all users).
-wfolder	Name of folder in which to restrict the deletions (default is all folders).
-y	Skips any verification questions.
-z	Without this parameter, no deletions will occur.

Example:

faxage -frfserver -aadministrator -odump.out -d2 -s01/01/2004 -z

Running FaxDump.exe

FaxDump.exe is a command line utility that outputs ASCII text files of fax data that you can import into other databases to produce reports. The text file prints one complete fax record per line. Quotes surround string data, and all fields are separated by commas (this can be customized using the -d option). FaxDump can report eight levels of information. For definitions of the fields included in each fax record for each of these information levels, see Fax Dump Data Fields. FaxDump.exe is located in the RightFax\AdmUtils folder on the RightFax server.

Syntax:

faxdump -fserver -auserID -ofile {-ggroupID|-uuserID} [-1] [-dascii] [-emm/dd/yyyy] [-h] [-i{s|f|a}] [-llevel] [-ppassword] [-q] [-smm/dd/yyyy] [-t{n|s|t|x}]

Command Line Options

Option	Function
-1	Fields that contain a delimiter (see the -d option) will not include quotation marks.
-auserID	The RightFax user ID to use when logging in to the RightFax server. A password can be required using the -p option.
-dASCII	The ASCII value (in decimal) of the character to use as a delimiter for FaxDump output. By default, this is set to comma (ASCII 44).
-emm/dd/yyyy	The ending date of the date range to report on. This can be specified as a day offset, i.e, -e-30 (default is 12/31/2010).
-fserver	The name of RightFax server that contains the fax information to output.
-ggroupID	The RightFax group ID for a group of users on which to report.
-h	Prints field headers in the first line of the output file.
-ioption	Ignores faxes of the specified type using one of the following options: s = Ignore successfully transmitted faxes f = Ignore failed faxes a = Ignore all failed fax history records
-llevel	Information level 0-7 (default is 0). See Fax Dump Data Fields for details on the available information levels.
-ofile	Name of the ASCII file to output.
-ppassword	The RightFax password for the user ID specified with the -a option. To use NT authentication, leave this option blank.
-q	Prints a table containing the definitions of the fields in each information level. If you select this option, any other specified options will be ignored.
-smm/dd/yyyy	The starting date of the date range to report on. This can also be specified as a day offset, i.e, -S-30 (default is 01/01/1980).
-tprotocol	Force the protocol used to communicate with the RightFax server to a specific type (rather than assigning automatically) using the following: n = Named pipes (default) s = SPX t = TCP/IP x = IPX
-uuserIDs	Comma delimited list of users to include (default is all users).

Example:

faxdump -frfserver -aadministrator -odump.out -l2 -s01/01/2002 -e01/31/2004

Running FaxStat.exe

FaxStat.exe is a Windows-based utility that monitors the fax database, BoardServer, server status, WorkServer, e-mail gateways, and RPC server status on any RightFax server. FaxStat.exe is located in the RightFax\AdmUtils folder on the RightFax server.

Running ImpUser.exe

ImpUser.exe is a command line utility that imports users into RightFax from a comma-delimited ASCII file. ImpUser.exe is located in the RightFax\AdmUtils folder on the RightFax server.

To import user IDs from a file, you must create a comma-delimited ASCII file containing all of the user records to import. Each individual user record must appear on a separate line and must contain 22 fields. The following table lists each of these fields in the order the fields must appear (use quotation marks around any field that contains an embedded comma).

ImpUser.exe Import File Required Fields

Field	Maximum length	Description
User ID	21	Unique RightFax user ID (If a user with this ID already exists, the existing user will be changed)
User name	29	Descriptive user name
Password	11	Password used to access FaxUtil and administrative functions
Group	21	The users group ID. The group must already exist
Routing code	7	Unique routing code for the user
Cover sheet	12	File name (no path) of default cover sheet file in RightFax\FCS folder. The file name must end with .pcl. Leave blank to use groups default cover sheet
Permissions flags	31	Characters that specify assigned user permissions see ImpUser.exe Import File Permissions Flags
Notification type	2	Notification type for received faxes: 0 = Use groups type 19 = Custom type 12 = GroupWise 14 = CallXpress 16 = Notes 17 = Exchange 18 = SMTP
Routing info	99	Routing information formatted as Type:Info or +Type:Info where Type must be one of the following: RF, CC, MS, FILE, OCR, GW, NOTES, RFIC, TRS, CX3, or EXCH; and where Info is the address for the specified type. +Type:Info is identical but enables the Delete After Routing option
Routing format	4	File format to use when routing. Must be one of the following: PCX, DCX, TIFF-G3, or TIFF-G4
Subscriber ID	7	Voice mail subscriber ID, if telephony system routing is enabled
From name	59	Default From Name for cover sheet
From phone	31	Default From Voice Number for cover sheet
DID fax num	31	Default DID Fax Number for cover sheet
General fax	31	Default General Fax Number for cover sheet
Operator num	31	Default Operator Voice Number for cover sheet
Distinguished name	79	The Microsoft Exchange distinguished name, used to confirm accurate RightFax/Exchange user synchronization
Default billing code 1	15	Default Billing Code 1 setting
Default billing code 2	15	Default Billing Code 2 setting
Pager notify	99	User pager notification formatted as Service:PagerID where Service is one of the defined pager services on the fax server, and PagerID is the pager number
Pager alert	99	Administrator pager notification formatted as Service:PagerID where Service is one of the defined pager services on the fax server, and PagerID is the pager number
Pager flags	31	Characters that specify pager notification events see Impuser.exe Import File Pager Flags

The following table lists user permission flags that can be used in the import file. A plus (+) or minus () sign must follow each character to indicate whether to add or remove the permission.

ImpUser.exe Import File Permissions Flags

Flag	Function
a±	Administrative access
b±	Bypass billing code verification
c±	Can change cover sheet
d±	Disallow fax deleting
f±	Can add/update forms
h±	Can use high priority
i±	Cannot search billing codes
l±	Can add/update library documents
m±	Must have password
o±	Can OCR faxes
r±	Can run reports
s±	Sent fax archiving
u±	Unprotected mailbox
v±	View first page only

The following table lists pager flags that can be used in the import file. A plus (+) or minus () sign must follow each character to indicate whether to add or remove the alert.

Impuser.exe Import File Pager Flags

Flag	Function
a±	All BoardServer services down
b±	BoardServer service down
c±	Critically low disk space
e±	Server Event Queue full
h±interval	Periodic server heartbeat. Specify heartbeat interval in minutes
i±	Server improperly started
l±	Low disk space
n±	New fax received
o±	Outbound fax has been abandoned
p±	Probable line failure
q±faxes-pages	Send queue too deep. Specify fax and page maximum depths

After you have created the ASCII file to import, run the ImpUser.exe command line utility.

IMPORTANT: The fax server must be running when executing this utility.

Syntax:

impuser -ffaxserver -uuserID -ppassword -isourcefile -nsource [-dtemplateID] [-ggroupname] [-ooutputfile] [-r][-tprotocol] [-1]

ImpUser.exe Command Line Options (Continued)

Option	Function
-dtemplateID	Specifies the RightFax user ID to use as a template for imported users settings. If not specified, uses the Default RightFax user ID.
-ffaxserver	Specifies the name of a fax server to import to.
-ggroupname	Specifies the name of a Windows NT group from which to import. If not specified, imports all users in the domain.
-isourcefile	Specifies the name of the file to import.
-nsource	Specifies the name of the Windows NT server to import the Windows NT domain accounts from.
-ooutputfile	Outputs the user list to a file rather than importing directly to RightFax. This file can then be edited and re-imported.
-ppassword	The RightFax password for the user ID specified with the -u option. To use NT authentication, leave this option blank.
-tprotocol	Forces protocol to specific type (rather than assigning automatically) using the following: n = Named Pipes s = SPX t = TCP/IP
-uuserID	The RightFax user ID to use when logging in to the RightFax server. A password can be required using the -p option.
-1	Imports from an Omtool Userdb.dat file.

Example:

impuser -frfserver -ujanedoe -ppassword -iuserfile.txt -nsourceserver -tt

When you execute this command, users from the specified ASCII file will be imported as fax users. If an imported user ID already exists, that users record will be updated based on the data from the file. If a user ID does not already exist, it will be added.

Running ModUser.exe

ModUser.exe is a Windows-based utility available only with RightFax Enterprise servers that changes RightFax permissions and options for multiple users at once. You must have RightFax administrative privileges to run ModUser.exe. ModUser.exe can be run from any workstation on your network; however, if you will be using ModUsers Windows NT user import function, you must be at a computer running Windows NT 4.0, Windows 2000, or Windows XP. ModUser.exe is located in the RightFax\AdmUtils folder on the RightFax server.

Once it is installed, you can run ModUser.exe by selecting the Captaris Modify User option in the Programs list in the Windows Start menu. When prompted for a server name, enter the name of the RightFax server you want to modify, and then click Next. Choose the network protocol for the server and click Next. Finally, enter your RightFax administrator user ID and password, and then click Finish. The Modify User window opens.

Figure 1. The Modify User Dialog Box

This window lists each RightFax user on the server you selected. To make global changes that will affect a group of selected users, select the users you want by clicking the user IDs while holding down either the shift or ctrl key. When you have selected the users to edit, click Edit in the menu bar. The User Information for Multiple Selections dialog box opens.

Figure 2. The User Information for Multiple Selections Dialog Box

For each option, a black check mark indicates that the option is enabled for all selected users, a gray check mark indicates that the option is enabled for some users, and if there is no check mark, the option is disabled for all users.

For information on each of the options on this dialog box see .

When you have made the changes you want, click OK to return to the Modify User dialog box. Asterisks (*) appear next the users names to indicate that they have unsaved changes. You will be prompted to save all your changes when you close the Modify User dialog box. To immediately apply changes without quitting, select Save Changes from the File menu.

Running ODBCSync.exe

ODBCSync.exe is a command line utility that imports RightFax users, printers, and billing codes from an ODBC source. ODBCSync.exe uses a configuration file that you create to map ODBC fields to RightFax. ODBCSync.exe, a sample configuration file called ODBCDemo.ini, and a text file that documents the configuration file called ODBCSync.txt are all included in the RightFax\AdmUtils folder on the RightFax server.

Syntax:

odbcsync -ffaxserver [-o] [-t{n|s|t}]

ODBCSync.exe Command Line Options

Option	Function
-ffaxserver	Specifies the name of a fax server to update.
-o	Overwrite any records that already exist on the server.
-tprotocol	Forces protocol to specific type (rather than assigning automatically) using the following: n = Named Pipes s = SPX t = TCP/IP

Example:

odbsync -frfserver -tt -o ODBCImport.ini

Running PhnPrint.exe

PhnPrint.exe is a command line utility that prints the published and private phonebook entries of one or more RightFax users to a file or printer. PhnPrint.exe is included in the RightFax\AdmUtils folder on the RightFax server.

IMPORTANT: The fax server must be running when executing this utility.

Syntax:

phnprint -fserver -uuserIDs -ofile [-g{0|1}] [-lformat] [-ppasswords] [-q] [-t{n|t|s|x}]

PhnPrint.exe Command Line Options

Option	Function
-fserver	Specify the name of RightFax server that contains the users whose phonebooks you want to print.
-goption	Optionally print phonebook groups from the specified users phonebooks. Specify option 0 or 1 where: 0 = Include phonebook groups 1 = Do not include phonebook groups (default)
-lformat	Output format 0, 1, or 3 where: 0 = Multi-line format, designed to be printed for reference (default) 1 = Space-delimited format 3 = Tab-delimited format
-ofile	Output file listing phonebook entries for all specified users
-ppassword	Comma delimited list of passwords for specified users
-q	Lists the field definitions for all of the output formats. This option overrides all other options
-tprotocol	Force protocol to specific type (rather than assigning automatically) using the following: n = Named Pipes (default) s = SPX t = TCP/IP x = IPX
-uuserIDs	Comma delimited list of users whose phonebooks you want to print

Example:

phnprint -frfserver -ujaned,johns -odump.out -psecret,password -g0 -l1

IMPORTANT: Because the last two lines in all of the output formats list the total number of entries, attempting to directly re-import the phonebook into RightFax will fail. To import the file back into RightFax, you must manually edit the file and delete the entry-count lines. The level 0 output format is designed for reference and cannot be used for importing phonebook entries from a file. When creating a file that will be imported back into RightFax, you must select output level 1 or 3.

Running RFDiag.exe

RFDiag.exe is a command line utility that displays information about the RightFax server on which RFDiag.exe is run. RFDiag.exe is included in the RightFax\AdmUtils folder on the RightFax server.

IMPORTANT: The fax server must be running when executing this utility.

Syntax:

rfdiag options

RFDiag.exe Command Line Options

Option	Function
-all	Display all available configuration information.
-app	Display information about your Microsoft Office, Microsoft Exchange, and Lotus Notes applications, if any.
-brd	Display BoardServer configuration.
-dev	Display installed devices.
-dir	Display a summary of the contents of the RightFax subfolders.
-dir0	List files in the RightFax folder.
-dir1	List files in the RightFax\Bin folder.
-dir2	List files in the RightFax\Image folder.
-dir3	List files in the RightFax\Database folder.
-dir4	List files in the RightFax\Outgoing folder.
-dir6	List files in the RightFax\FCS folder.
-dir7	List files in the RightFax\Sig folder.
-dir8	List files in the RightFax\Papers folder.
-dir9	List files in the RightFax\Boardsrv folder.
-hw	Display fax hardware configuration.
-net	Display network configuration.
-srv	Display fax server configuration.
-svc	Display installed services.
-sys	Display information about the fax server system configuration.

Example:

rfdiag -all -dir3

Running ServSync.exe

ServSync.exe is a command line utility that compares one or more categories of information between two RightFax servers. ServSync.exe is included in the RightFax\AdmUtils folder on the RightFax server.

IMPORTANT: The fax server must be running when executing this utility.

Syntax:

servsync -auserID server1[:{n|s|t}] [server2[:{n|s|t}]] -c{b|f|g|p|u|*} [-spassword] [-v]

ServSync.exe Command Line Options

Option	Function
-auserID	The user ID to use to log in to the RightFax server.
-spassword	Password for the user ID used to log in to the RightFax server. To use NT authentication, leave this option blank.
-ccategories	Categories of information to be compared using the following: b = Billing codes f = Forms g = Groups p = Printers u = Users * = All categories
:protocol	The network protocol to use to communicate to each of the RightFax servers using the following: n = Named Pipes (default) s = SPX t = TCP/IP
-v	Verbose output. This option gives you the most comprehensive comparison.

Example:

servsync rfserver:t -aadministrator -spassword -c* -v

<< Return to ReadMe Contents

Fax Reporter

The RightFax database stores detailed information about each sent and received fax. The Fax Reporter administrative utility organizes and presents this information for reporting and billing. With Fax Reporter you can:

Create fax information reports from new and existing data sets.
Save data sets as Microsoft Access (.mdb) files.
Export reports to other file formats including HTML, Word, Excel, text, Rich Text Format (RTF), and e-mail through MAPI or Exchange.
Generate graphs or lists of fax information.
Preview reports before printing.
Fax Reporter can be run from the RightFax server or from a client workstation.

Fax Reporter can be run from the RightFax server or from a client workstation.

You can install Fax Reporter as an optional administrative utility, and it includes components of Crystal Reports 8.0. If you have installed other software that uses a different version of this software, a conflict may occur. For information on installing the administrative utilities, refer to Installing the Administrative Utilities above.

Running Fax Reporter

To run Fax Reporter, select Start > Programs > Fax Reporter. The Fax Report Generator dialog box opens.

Figure 3. The Fax Report Generator Dialog Box

IMPORTANT: Although any user can run Fax Reporter, the user must be granted the Can Run Reports permission in his or her RightFax user profile in order to access report data from the specified server.

A list of data sets appears in the Data Sets list. A data set is a set of fax data for a selected period of time.

A list of report formats appears in the Reports list. Report formats define the type and format of data that is generated from the selected data set. Report formats are organized in folders, and each report format is indicated by a black and white report icon. Double-click a folder to open it.

Creating Data Sets

A data set is a set of fax data for a selected period of time. You can create two types of data sets: dynamic and absolute. A dynamic data set represents data captured during a relative time range. For example, a data set representing last month can be created that collects fax data for the past calendar month from the date of creation. This data set can then be refreshed at any time and new data will be collected for the last calendar month from the date of the refresh.

An absolute data set represents an absolute date range, from a fixed start date to a fixed end date.

Creating a new data set

To create a new data set, open the Fax Report Generator dialog box and click New. The Data Set dialog box opens.

Figure 4. The Data Set Dialog Box

Data Set Name A descriptive name for the new data set.

Database File Name The path and file name of the data set. This is saved as a Microsoft Access database.

Server Name The name of the RightFax server to retrieve the data from.

Protocol The network protocol for communication with the RightFax server.

Date Range The range of dates for which to collect data. When you select an option, the represented date range appears in the Start Date and End Date boxes. If you select Absolute, specify the date range in the Start Date and End Date boxes.

Refreshing a data set

To refresh an existing data set, click the name of the data set in the Fax Report Generator dialog box and click Refresh. New data will be collected with today as the starting point.

Editing a data set

To edit an existing data set, click the name of the data set in the Fax Report Generator dialog box and click Edit. The Data Set dialog box opens. You can change any of the options in this dialog box. Click OK to save your changes.

Deleting a data set

To delete a data set, click the name of the data set to remove in the Fax Report Generator dialog box and click Delete.

Printing a Fax Report

After you have created a data set, follow these steps to print a fax report.

In the Fax Report Generator dialog box, select the data set. If necessary, click Refresh to update the data.
In the Reports list, select the report format. Report formats are organized in folders. Double-click a folder to open it. Each report format is indicated by a black and white report icon. Select a report format.

The following categories of report formats are available:

Analysis reports
Inbound fax reports
Outbound fax reports
Production inbound fax reports
Production outbound fax reports

IMPORTANT: You must select a report format in this list. If you select a folder, no report will be generated.

You have the following options:
To print the report, click Print.
To preview the report on your monitor, click Preview. To print the report after previewing it, click Printer in the Preview window (this option appears only if the computer is connected to a printer).

Depending on the type of report you select, the Enter Parameter Values dialog box may open:

Figure 5. The Enter Parameter Values dialog box

In the Discrete Value box enter a range for the parameter type highlighted in the Parameter Fields list. The parameter type on which you can of users on which to run the report. You can use the standard wildcards * and ? to define a user set. The * character represents any number of characters. The ? character represents any single character. The * character entered in this box by default will run the report on all users.

Analysis reports

Analysis reports provide data about the utilization of the RightFax server and fax board service.

Analysis Reports (Continued)

Report	Description	File Name
Channel usage, detailed report	The detailed report lists the usage of the fax channels on each board server for each day of the reporting period. For each fax channel, the report shows: Total minutes. Receive minutes. Send minutes. Utilization percentage. For each BoardServer, the report shows: Total minutes. Total receive minutes. Total send minutes. For all BoardServers for each day, the report shows: Overall total minutes. Overall total receive minutes. Overall total send minutes. For all BoardServers and all days in the reporting period, the report shows: Overall total minutes. Overall total receive minutes. Overall total send minutes.	Chanuse2.rpt
Channel usage, summary report	The summary report lists the usage of the fax channels on each board server. For each fax channel, the report shows: Total minutes. Receive minutes. Send minutes. Utilization percentage. For each board server, the report shows: Total minutes. Total receive minutes. Total send minutes. For all board servers, the report shows: Overall total minutes. Overall total receive minutes. Overall total send minutes.	Chanuse2.rpt
Fax printing, by user	By User	Print1.rpt
Fax printing, by group	By Group	Print2.rpt
Time of day usage	This report shows the usage of the outbound fax channels on a BoardServer. For each hour of the day during the reporting period, the report shows the average number of minutes used for outbound faxing. It shows the utilization percentage of the channel compared to all the fax channels on the BoardServer. You are prompted to enter the number of the outbound fax channel on which to report. The report shows the overall total number of minutes for all channels on the BoardServer.	Toduse1.rpt

Inbound fax reports

Inbound fax reports provide data about faxes that are received by the RightFax server.

Inbound Fax Reports (continued)

Report	Description	File Name
User volume in pages, all users	For each RightFax user ID, the report shows: Date. Number of pages received that day. Total number of pages received for all days. The report shows the overall total pages received for all users.	Usage6.rpt
User volume in pages, top 10 users	This report lists the 10 RightFax users who received the most faxes during the reporting period. For each of the top 10 RightFax user IDs, the report shows: Date. Number of pages received that day. Total number of pages received for all days. The report shows the overall total pages received for the top 10 users. The report also provides a bar chart of the top 10 users' received faxes.	Usage2.rpt
User volume in transmission time, all users	For each RightFax user ID, the report shows: Date. Number of minutes of transmission time for the user's received faxes that day. Total number of minutes of transmission time for the user's received faxes for all days. The report shows the overall number of minutes of transmission receipt time for all users.	Usage8.rpt
User volume in transmission time, top 10 users	This report lists the 10 RightFax users whose received faxes used the most transmission time during the reporting period. For each of the top 10 RightFax user IDs, the report shows: Date. Number of minutes of transmission time for the user's received faxes that day. Total number of minutes of transmission time for all days. The report shows the overall number of minutes of transmission receipt time for the top 10 users. The report also provides a bar chart of the top 10 users' transmission receipt times.	Usage4.rpt
Unviewed/ unprinted faxes	For the RightFax user you specify, the report shows: Date and time the fax was received. Sender's name, if available. Name or telephone number of the sending fax machine (remote ID). Status Number of pages received. Total number of faxes received. Total number of pages received for all days. For all users, the report shows the overall total pages received. You are prompted to enter a RightFax user ID.	New1.rpt

Outbound fax reports

Outbound fax reports provide data about faxes that are transmitted by the RightFax server.

Outbound Fax Reports (continued)

Report	Description	File Name
Billing	RightFax supports the use of two billing codes for each faxed document. These are referred to as "Billing Code 1" and "Billing Code 2," or you can assign unique names to the fields. Detailed The detailed report lists faxes sorted by billing code 1. By billing info 1 By billing info 2 By billing info 1 - billing info 2 Date the fax was sent. Number of pages in the fax. Name of the recipient. Fax number of the recipient. Caller Subscriber Identification (CSID) from the recipient fax machine. RightFax user ID of the person who sent the fax. For all faxes, the report shows the overall total pages sent. Summary By billing info 1 By billing info 2 By billing info 1 - billing info 2	Bill1.rpt - Bill6.rpt
Destination, by fax number	This report lists faxes sent to a specific fax number. For each fax number, the report shows: RightFax user ID of the person who sent the fax. The user group of which the user is a member. Date the fax was sent. Name of the recipient. Name of the recipient company. Fax number of the recipient. Name or telephone number of the recipient fax machine (remote ID). Status of the fax. Number of pages in the fax. Unique ID of the fax, as assigned by the fax server. For all faxes, the report shows the overall total pages sent. You will be prompted to enter a fax number.	Dest1.rpt
Destination, by remote ID	This report lists faxes sent to a specific recipient fax machine. For each fax machine, the report shows: RightFax user ID of the person who sent the fax. The user group of which the user is a member. Date the fax was sent. Name of the recipient. Name of the recipient company. Fax number of the recipient. Name or telephone number of the recipient fax machine (remote ID). Status of the fax. Number of pages in the fax. Unique ID of the fax, as assigned by the fax server. For all faxes, the report shows the overall total pages sent. You will be prompted to enter a remote ID, which is the name or telephone number of the recipient fax machine.	Dest4.rpt
Destination, by to-company	This report lists faxes sent to a specific recipient company. For each company, the report shows: RightFax user ID of the person who sent the fax. The user group of which the user is a member. Date the fax was sent. Name of the recipient. Name of the recipient company. Fax number of the recipient. Name or telephone number of the recipient fax machine (remote ID). Status of the fax. Number of pages in the fax. Unique ID of the fax, as assigned by the fax server. For all faxes, the report shows the overall total pages sent. You will be prompted to enter a company name.	Dest3.rpt
Destination, by to-name	This report lists faxes sent to a specific recipient. For each recipient, the report shows: RightFax user ID of the person who sent the fax. The user group of which the user is a member. Date the fax was sent. Name of the recipient. Name of the recipient company. Fax number of the recipient. Name or telephone number of the recipient fax machine (remote ID). Status of the fax. Number of pages in the fax. Unique ID of the fax, as assigned by the fax server. For all faxes, the report shows the overall total pages sent. You will be prompted to enter the name of a recipient.	Dest2.rpt
Fax lists, detailed	Detailed (with histories) All faxes Completed faxes only For each RightFax user ID, the report shows: Date and time the fax was sent. RightFax user ID of the person who sent the fax. Name of the recipient. Name of the recipient company. Fax number of the recipient. Estimated cost based on transmission time and standard rates. Status of the fax transmission Number of pages in the fax. Length of time of the transmission. Transmission history, which consists of: event date and time off hook time Name or telephone number of the recipient fax machine (remote ID). fax channel used for the transmission number of pages transmitted board result Total for the user: pages faxed and cost You will be prompted to enter a RightFax user ID or phone cost.	Userhst1.rpt - Userhst2.rpt
Fax lists, summary, all faxes	This report lists all faxes that the fax server attempted to send. For each fax, the report shows: Date and time the fax was sent. RightFax user ID of the person who sent the fax. Name of the recipient. Name of the recipient company. Fax number of the recipient. Name or telephone number of the recipient fax machine (remote ID). Status of the fax transmission. Number of pages in the fax. Length of time of the transmission. For all faxes, the report shows the overall total pages sent.	User1.rpt
Fax lists, summary, completed faxes	This report lists all faxes that were successfully sent. For each fax, the report shows: Date and time the fax was sent. RightFax user ID of the person who sent the fax. Name of the recipient. Name of the recipient company. Fax number of the recipient. Name or telephone number of the recipient fax machine (remote ID). Status of the fax transmission. Number of pages in the fax. Length of time of the transmission. For all faxes, the report shows the overall total pages sent.	User2.rpt
User volume in pages, all users	For each RightFax user ID, the report shows: Date. Number of pages sent that day. Total number of pages sent for all days. The report shows the overall total pages sent for all users.	Usage5.rpt
User volume in pages, top 10 users	This report lists the 10 RightFax users who sent the most faxes during the reporting period. For each of the top 10 RightFax user IDs, the report shows: Date. Number of pages sent that day. Total number of pages sent for all days. The report shows the overall total pages sent for the top 10 users. The report also provides a bar chart of the top 10 users' sent faxes.	Usage1.rpt
User volume in transmission time, all users	For each RightFax user ID, the report shows: Date. Number of minutes of transmission time for the user's sent faxes that day. Total number of minutes of transmission time for the user's sent faxes for all days. The report shows the overall number of minutes of transmission time for all users' sent faxes.	Usage7.rpt
User volume in transmission time, top 10 users	This report lists the 10 RightFax users whose sent faxes used the most transmission time during the reporting period. For each of the top 10 RightFax user IDs, the report shows: Date. Number of minutes of transmission time for the user's sent faxes that day. Total number of minutes of transmission time for all days. The report shows the overall number of minutes of transmission send time for the top 10 users. The report also provides a bar chart of the top 10 users' transmission send times.	Usage3.rpt

Production inbound fax reports

The production inbound fax reports are designed for use with the RightFax Integration Module.

Production Inbound Fax Reports

Report	Description	File Name
By user	For each RightFax user ID, the report shows: Unique ID of the received fax, as assigned by the fax server. Date and time the fax was received. Status of the fax (viewed or printed). DID number that the fax was sent to. Name or telephone number of the sending fax machine (remote ID). Status of the fax transmission. Number of pages in the fax. Length of time of the transmission. Overall total number of fax pages received by the user. For all users, the report shows the overall total pages received.	Autoinus.rpt
By day	For each day, the report shows: RightFax user ID. Date and time the fax was received. Status of the fax (viewed or printed). DID number that the fax was sent to. Name or telephone number of the sending fax machine (remote ID). Status of the fax transmission. Number of pages in the fax. Length of time of the transmission. For the day, the report shows the total pages received. For all users, the report shows the overall total pages received during the reporting period.	Autointm.rpt
By remote ID	For each sending fax machine, the report shows: Name or telephone number of the sending fax machine (remote ID). RightFax user ID of the user who received the fax. Date and time the fax was received. Status of the fax (viewed or printed). DID number that the fax was sent to. Status of the fax transmission. Number of pages in the fax. Length of time of the transmission. Overall total number of fax pages received by the user. For each sending fax machine, the report shows the total pages received. For all received faxes, the report shows the overall total pages received.	Autoinid.rpt

Production outbound fax reports

The production outbound fax reports are designed for use with the RightFax Integration Module..

Production outbound Fax Reports

Report	Description	File Name
By user	For each RightFax user, the report shows: RightFax user ID of the person who sent the fax. Unique ID of the sent fax, as assigned by the fax server. Date and time the fax was sent. Date and time the fax was received by the recipient. Name of the recipient. Name of the recipient company. Fax number of the recipient. Name or telephone number of the recipient fax machine (remote ID). Status of the fax transmission. Number of pages in the fax. Length of time of the transmission. For each user, the report shows the number of pages sent. The report also shows the overall total number of pages sent during the reporting period	Autouser.rpt
By day	For each day, the report shows: Unique ID of the sent fax, as assigned by the fax server. Date and time the fax was sent. Date and time the fax was transmitted. RightFax user ID of the person who sent the fax. Name of the recipient. Name of the recipient company. Fax number of the recipient. Name or telephone number of the recipient fax machine (remote ID). Status of the fax transmission. Number of pages in the fax. Length of time of the transmission. For each user, the report shows the number of pages sent. The report also shows the overall total number of pages sent during the reporting period.	Autotime.rpt
By unique ID	For each sent fax, the report shows: Unique ID of the sent fax, as assigned by the fax server. Date and time the fax was sent. Date and time the fax was transmitted. RightFax user ID of the person who sent the fax. Name of the recipient. Name of the recipient company. Fax number of the recipient. Name or telephone number of the recipient fax machine (remote ID). Status of the fax transmission. Number of pages in the fax. Length of time of the transmission. The report shows the overall total pages sent during the reporting period.	Autoid.rpt
Failed faxes, by user	For each sent fax that failed in transmission, the report shows: RightFax user ID of the person who attempted to send the fax. Unique ID of the fax, as assigned by the fax server. The initial date and time that the server attempted to send the fax. The final date and time that the server attempted to send the fax. Name of the recipient. Name of the recipient company. Fax number of the recipient. Name or phone number of the recipient fax machine (remote ID). Status of the fax transmission. Length of time of the attempted transmission. For each user, the report shows the number of pages sent. The report also shows the overall total number of pages sent during the reporting period.	Autofail.rpt
Successful faxes, by user	For each sent fax that was transmitted, the report shows: RightFax user ID of the person who sent the fax. Unique ID of the fax, as assigned by the fax server. The initial date and time that the fax server attempted to send the fax. The date and time that the fax was transmitted. Name of the recipient. Name of the recipient company. Fax number of the recipient. Name or telephone number of the recipient fax machine (remote ID). Status of the fax transmission. Number of pages in the fax. Length of time of the transmission. For each user, the report shows the number of pages sent. The report also shows the overall total number of pages sent during the reporting period.	Autosucc.rpt

Exporting Fax Information to Another File Format

Follow these steps to export fax information to a specific file format on disk or to a MAPI address:

In the Fax Report Generator dialog box, select the data set. If necessary, click Refresh to update the existing fax data.
In the Reports list, select the report format. Report formats are organized in folders. Double-click a folder to open it. Each report format is indicated by a black and white report icon. If you select a folder (as opposed to a report format file) no report will be generated.
Click Preview , and the report appears in the Preview window.
Click Export in the toolbar to display the Export dialog box.
Choose the desired Format and Destination .
Click OK .

Exporting Fax Data to a Text File

In addition to the Fax Reporter utility, RightFax includes an administrative utility, FaxDump.exe, that outputs ASCII text files of fax data that you can import into other databases to produce reports. For information on running FaxDump.exe, see Running FaxDump.

Running Fax Reporter from a Command Line

You can run the Fax Reporter utility from a command line. The utility FaxRpt2.exe is located in the RightFax\FaxRpt2 folder on the RightFax server.

Syntax

faxrpt2 -u userID -p password -n dataset -o printer -r format [ -v ] [ -1 ] [ -2 ]

Fax Reporter Command Line Options

Option	Function
-1	Preview the report (print to the screen).
-2	Turn off automatic refresh of the data set.
-n dataset	The data set for the report, for example -nmonthly.
-o printer	The printer where the report should print.
-p password	The password for the user ID that will log on to the RightFax server.
-r format	The name of the report format to use, for example -rchanuse2.rpt. The report formats must be located in the folder RightFax\AdmUtils \Faxrpt2\Reports.
-u userID	The user ID to log on to the RightFax server.
-v	Verbose. If errors occur while the report is being generated, the process will stop and RightFax will display the error that was encountered.

Example:

faxrpt2 -uadministrator -pmypassword -nmonthly -ohpprinter -ruse2.rpt [-v]

Creating Custom Reports

Fax Reporter can be extended with your own custom-designed reports. Custom reports can be created using the Crystal Reports product from Business Objects www.businessobjects.com. You can create custom reports from scratch or modify one of the provided reports.

Understanding the file format of data sets

In order to create custom reports, you must first know where the data is located in the generated data sets. Fax Reporter data sets are Access 2000 databases. Each database contains several tables, each with unique fields. For a complete description of each table in the Fax Reporter data set and all of the fields in each table, see , .

Adding custom reports to Fax Reporter

To add a custom report to Fax Reporter, create a text file called FaxRpt2.ini in the same folder that the FaxRpt2.exe program is located (the default location is C:\Program Files\

RightFax\AdmUtils\FaxRpt2\Reports). List each report in the FaxRpt2.ini file using the following format:

[Custom-#]

Name=ReportName

File=FileName

Where the # parameter in the [Custom- # ] header is the number of the entry in the file, ReportName is the descriptive name for the report that will be displayed in the Fax Reporter dialog box, and FileName is the path and file name of the report definition file.

Sample FaxRpt2.ini file:

[Custom-1]

Name=Acme Usage Report

File=X:\FaxRpt2\Custom1.Rpt

[Custom-2]

Name=Acme Analysis Report

File=X:\FaxRpt2\Custom2.rpt

[Custom-3]

Name=Bob's special report

File=Custom3.rpt

Custom reports are only read when Fax Reporter is started. If the .ini file is changed, Fax Reporter must be re-started in order to detect the changes.

<< Return to ReadMe Contents

Fax Reporter Data

The RightFax Fax Reporter is a utility that creates reports of fax activity from new and existing data sets and generate graphs and lists of fax information. Although it comes complete with several useful reports, Fax Reporter can be extended with your own custom designed reports. Custom reports can created using Crystal Reports from Business Objects www.businessobjects.com. You can create new reports or modify one of the RightFax reports.

In order to create custom reports, you must first know where the information you want is located in the generated data sets. Fax Reporter data sets are Access 97 databases. Each database contains several separate tables, each with its own separate fields. This appendix lists each of the tables included in the Fax Reporter data set and the data fields in each table, listed in the order they appear.

Table name	Description	Refer To
ApprovedHistory	Contains a record for every occurrence of a fax that is approved for sending.	See The ApprovedHistory table
DisapprovedHistory	Contains a record for every occurrence of a fax that is disapproved for sending.	See The DisapprovedHistory table
FaxErrorStrings	Translates the FaxErrorCode field in the Faxes table to a readable string.	See The FaxErrorStrings table
Faxes	Contains the fax records.	See The Faxes table
FaxServerInfo	Contains information about the fax server from which the data set was created.	See The FaxServerInfo table
FaxStatStrings	Translates the FaxStatus field in the Faxes table to a readable string.	See The FaxStatStrings table
History	Contains the history records for each fax. Each outbound fax has one history record for each send attempt. Each received fax has only one history record.	See The History table
NetFwdHistory	Contains a record for every occurrence of a fax being forwarded to another network user. This table does not record the occurrence of a fax being forwarded to a fax machine.	See The NetFwdHistory table
OCRHistory	Contains a record for every occurrence of a user requesting that a fax be processed by the OCR engine.	See The OCRHistory table
PrintHistory	Contains a record for every occurrence of a fax being printed to a network printer (either manually or automatically).	See The PrintHistory table
RouteHistory	Contains a record for every occurrence of a fax being manually routed between users.	See The RouteHistory table
TermStatStrings	Translates the TermStat field in the Faxes table to a readable string.	See The TermStatStrings table

Field name	Type	Size	Description
FaxHandle	Number (Long)	4	The handle of the fax record to which the history belongs. This field serves as the foreign key for the ApprovedHistory table and should be used to join with the Faxes table
DateTime	Date/Time	8	The date and time the fax was approved
Flags	Number (Long)	4	A four-byte field where the bits are mapped to specific meanings. The API should be examined for details on the various bits and their meaning
ApproverID	Text	21	User ID indicating who approved the fax
Notes	Memo	453	Notes entered by the approver

Field name	Type	Size	Description
FaxHandle	Number (Long)	4	The handle of the fax record to which the history belongs. This field serves as the foreign key for the DisapprovedHistory table and should be used to join with the Faxes table
DateTime	Date/Time	8	The date and time the fax was disapproved
Flags	Number (Long)	4	A four-byte field where the bits are mapped to specific meanings. The API should be examined for details on the various bits and their meaning
ApproverID	Text	21	User ID indicating who approved the fax
Notes	Memo	453	Notes entered by the disapprover

Field name	Type	Size	Description
FaxErrorCode	Number (Long)	4	The numeric value of the fax status. This field is the foreign key for this table and should be joined with the Faxes.FaxErrorCode field.
FaxErrorString	Text	64	The human readable description of the FaxErrorCode value.

Field name	Type	Size	Description
FaxHandle	Number (Long)	4	Primary key for fax records. Fax handles are used by the fax server to identify faxes at any particular point in time. A fax handle can be reused over time, so do not expect two different data sets to have unique fax handles.
OwnerID	Text	21	ID of the owning fax server user who owns this fax.
GroupID	Text	21	Group ID to which the fax owner belongs.
ToFaxNum	Text	31	Phone number to which to send the fax. This is usually only valid for outbound faxes, though it is possible for users to enter a value in this field on received faxes. This is not the final fax number dialed because the dialing plan on the fax server that ultimately sent the fax may have modified the number in some way.
ToContactNum	Text	31	Information field. This can be completed by the fax owner with any data.
ToName	Text	59	Information field. May be filled in by the fax owner with any data.
ToCompany	Text	59	Information field. This can be completed by the fax owner with any data.
ToCityState	Text	59	Information field. This can be completed by the fax owner with any data.
FromName	Text	50	On outbound faxes not originated via an e-mail gateway, the field may be filled in by the fax owner with any data, though it usually contains the name of the owner/sender. On outbound faxes originated via e-mail, this field contains the e-mail address of the sender. The address is used by the fax server to send acknowledgments to the sender. On inbound faxes, this field is usually blank unless the user enters information manually.
FromPhoneNum	Text	31	Information field. This can be completed by the fax owner with any data.
BillInfo1	Text	15	Information field. This can be completed by the fax owner with any data. This is one of the customizable billing fields. The actual description of the field can be obtained by examining the BillDesc1 field of the FaxServerInfo table.
BillInfo2	Text	15	Information field. This can be completed by the fax owner with any data. This is one of the customizable billing fields. The actual description of the field can be obtained by examining the BillDesc1 field of the FaxServerInfo table.
UniqueID	Text	15	Information field. This field is usually generated by the fax server, though it can be modified/set via an API generated fax or a fax containing the <UNIQUEID:xxx> embedded code. While the field name implies uniqueness, none is guaranteed.
FaxDIDNum	Text	31	Information field. This can be completed by the fax owner with any data. On outbound faxes, this field usually contains the human readable private fax number of the sender/owner.
RemoteID	Text	21	The CSID of the last fax machine to which the fax was sent or the CSID of the machine from which the fax was received. CSIDs are not actually required to complete a fax transmission, so this field may be empty.
EmailType	Number (Long)	4	Valid only on outbound faxes. If the fax was generated via a mail message this field contains a number that indicates what type of mail system originated the fax, else the field is null. Internally, the fax server uses this data so that a reply can be sent to the fax originator via the proper mail system (the FromName field contains the e-mail address of the fax sender when this value is non-null).
FaxDateTime	Date/Time	8	Date and time the fax was created (in local time). This field is fully year-2000 compliant.
FaxSend DateTime	Date/Time	8	If the fax was time-delayed by the owner, i.e. it was not sent ASAP, then this field contains the original date and time scheduled by the owner. If the fax was sent ASAP, then this field is null.
Priority	Number (Long)	4	Priority assigned to the fax by the owner. The values currently possible are: 0 (normal), 1 (low), or 2 (high). Additional values may be used in the future.
FaxStatus	Number (Long)	4	The status of the fax at the time the data set was created/refreshed. The status value can be translated into a human readable form by joining with the FaxStatStrings table. To construct a query where only completed faxes are matched/used, select fax records where the FaxStatus equals six (6) or (9).
FaxErrorCode	Number (Long)	4	The current error associated with the fax. If this value is zero (0) then there is no current error associated with the fax. Because an outbound fax may be tried multiple times, there can be multiple, different errors. The History records can be used to get more detailed error values.
TermStat	Number (Long)	4	If a fax has a FaxStatus of value 6, 9, or 11, then the TermStat contains a better error than the FaxErrorCode with respect to any problem in dialing, sending, or receiving of the fax. The TermStat is not used when other errors occur, e.g. printing, OCR, etc.
ElapsedTime	Number (Long)	4	Total number of seconds spent off-hook for this fax. For inbound faxes, this value is equal to the elapsed time in the related history record. For outbound faxes, this value is the total elapsed time of all send attempts.
Pages	Number (Long)	4	Number of pages in the fax. For outbound faxes, this value includes any optional cover sheet image.
Received	Yes/No	1	Set to Yes if this was a received/inbound fax, else set to No.
Deleted	Yes/No	1	Set to Yes (1) if this fax has been deleted by the user, else set to No. Deleted faxes are maintained in the fax server database until they are purged according to the purge aging date of the fax owners group.
Viewed	Yes/No	1	Set to Yes (1) if the fax has been viewed by the owner.
Printed	Yes/No	1	Set to Yes (1) if the fax has been printed by the owner.
DoNotAudit	Yes/No	1	Set to Yes (1) if the fax should be ignored for billing purposes. The flag is set when a fax is forwarded between users on a network or when an outbound fax is used as a conduit for another operation like creating a library document. If this flag were not present, then a fax sent on behalf of a client might be counted twice if that same fax were forwarded to another network user.
NoCover	Yes/No	1	Set to Yes (1) if this fax does not have a cover sheet.
SmartResume	Yes/No	1	Set to Yes (1) if this fax has the Smart-Resume capability enabled. By itself, it doesn't mean that the fax had to retry during sending.
WasApproved	Yes/No	1	Set to Yes (1) if the fax needed approval and then was subsequently approved for sending. If a fax needing approval is disapproved, then this flag will not be set, the fax status will be set to FAXSTAT_DONE_ERROR and the fax error code will be set to FAXERROR_DISAPPROVED.
NeedsApproval	Yes/No	1	Set to Yes (1) if the fax needs approval before being sent. This flag is not cleared when the fax is approved or disapproved, so merely looking at this flag does not indicate which faxes are waiting for approval (the fax status field should be used for such purposes).
HasTrxNotes	Yes/No	1	Set to Yes (1) if the fax has a network-forward or route history record with embedded notes. This flag is normally used by FaxUtil so that it can flag the existence of the notes for the user.
BodyImage	Text	14	Contains the file name of the fax body images as stored in the fax server Image subfolder. The path is never included. An extension is not normally given and should be ignored if it exists (the extension is used to represent the page number).
FcsImage	Text	14	Contains the file name of the fax cover sheet image as stored in the fax server Image subfolder. Neither the path nor the extension is ever included. A fax may not have a cover sheet image because: the fax is a received fax, the fax is a thermal fax record, the cover sheet has yet to be generated, or the user didn't want a cover sheet generated.
Flags	Number (Long)	4	A four-byte field where the bits are mapped to specific meanings. The API should be examined for details on the various bits and their meaning.
FFRFlags	Number (Long)	4	A four-byte field where the bits are mapped to specific meanings. The API should be examined for details on the various bits and their meaning.
Folder	Number (Long)	4	The folder number in which the fax lives. There are a few predefined folder numbers. All other numbers are defined by the owner's folder definitions. The predefined folder numbers are: 0 (Main) and 0xFFFE (Trash).

Field name	Type	Size	Description
ServerName	Text	64	The name of the fax server from which the data set was extracted.
BillDesc1	Text	15	The field label for the Faxes.BillInfo1 field
BillDesc2	Text	15	The field label for the Faxes.BillInfo2 field