RightFax 9.3 Administrative Utilities Readme

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

Contents

1.    Installing the Administrative Utilities

2.    Using the RightFax Administrative Utilities

3.      Fax Reporter

4.      Fax Dump Fields

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.

 

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