You are on page 1of 56

OpenText RightFax 10.

6
Administrative Utilities

Guide

Edition
OpenText RightFax 10.6 Administrative Utilities.
This document was last updated January 22, 2014.
Trademarks
OpenText is a registered trademark of Open Text Corporation Corporation. All other company names, brand names, and product
names are the property and/or trademarks of their respective companies.
Copyright Notice
2014 Open Text Corporation All rights reserved.
Open Text Corporation
275 Frank Tompa Drive
Waterloo, Ontario, Canada
N2L 0A1
(519) 888-7111
http://www.opentext.com
Copyright Statement
Portions of this product Copyright 2002-2006 Glyph & Cog, LLC. Portions Copyright 2001 artofcode LLC.
This software is based in part on the work of the Independent JPEG Group. This software is based in part on the work of the
Freetype Team.
Portions Copyright 1998 Soft Horizons. Portions Copyright 2001 URW++. All Rights Reserved. Includes Adobe PDF Library
technology. Adobe, Acrobat and the Acrobat logo are trademarks of Adobe Systems Incorporated. Portions Copyright TMS, Inc.
1994-2001. All rights reserved.

OpenText RightFax 10.6

Administrative Utilities Guide

Contents

Chapter 1: Administrative Utilities

Detailed and Summary Logs

43

The RightFax SQL Database

Using the Migration Tool

44

Retrieving data from the Audits table

Using the RightFax Administrative Utilities

Purging Faxes from User Fax Mailboxes

10

Running Server Diagnostics

19

Running the Database Updater tool

20

Migrating and Encrypting Existing Image Directories

21

Chapter 2: Enterprise Fax Reporter

Chapter 5: FaxDump.exe Data Fields

23

Running RightFax Enterprise Fax Reporter

23

Available Fax Reports

25

Running Fax Reporter from a Command Line

40

Chapter 3: RightFax Document Migration Tool

Chapter 4: MESSAGEmanager to RightFax Migration Tool


46

42
42

Migrating Fax Records and Associated Files

42

Selecting Specific Users and Groups

42

Fax Record Marking and Progress Tracking

43

Error Display

43

OpenText RightFax 10.6

48

Information level 0 data fields

48

Information level 1 data fields

49

Information level 2 data fields

50

Information level 3 data fields

52

Information level 5 data fields

52

Information level 6 data fields

53

Information level 7 data fields

54

Fax status fields (FaxStat)

55

Termination status fields (TermStat)

56
56

Administrative Utilities Guide

Chapter 1: Administrative Utilities

The RightFax SQL Database

Chapter 1: Administrative Utilities

The RightFax Admin Utility can be installed as part of the


regular Setup for the RightFax Product Suite. During the
installation process, click the Administrative Utilities feature
located at the bottom of the features list.

It is strongly recommended that you do not make any


changes to the RightFax SQL database. A complete schema of
the RightFax database can be viewed using SQL
Administrator. An image of the schema is also available in
the Docs folder on the RightFax installation DVD in the file
RightFax Database Schema.pdf.

For information on requirements and installation of a


standard or custom version of RightFax, including
components above and beyond the Administrative Utilities,
refer to the RightFax Installation Guide.

Retrieving data from the Audits table


When a user or group is added, modified, or deleted from
Enterprise Fax Manager, a record appears in the Audits table.

All of the RightFax administrative utilities are installed in the


RightFax\AdminUtils folder or one of its subfolders on the
RightFax server.

To retrieve data from the Audits table


1. Access the program you normally use to perform a
SELECT query (for example, Microsoft Excel).

The RightFax SQL Database


RightFax stores all of its data, including information on faxes,
users, and dialing rules in a SQL database (although fax
images are stored separately as graphic files in the
RightFax\Image folder). This database can be installed on the
RightFax server, or can be installed on an existing SQL
server. You select where the SQL database is to be installed
when you install the RightFax Server server software.

2. Using that program, establish a connection to the SQL


Server that contains your RightFax database (whatever
you named it when RightFax was installed. The default
name is RightFax).
3. Using SQL query language:
4. USE RightFax (or whatever you named your database)

The Microsoft SQL Server that is provided with RightFax


includes all of the SQL functionality required by the RightFax
software. This version of SQL does not include all of the tools
and administrative capabilities that the full version does.

OpenText RightFax 10.6

5. Retrieve all of the rows and columns from the table by


executing the following command:
SELECT * FROM dbo.Audits

Administrative Utilities Guide

Chapter 1: Administrative Utilities

Using the RightFax Administrative Utilities

Column

Structure of the Audits table

Description
performed.

The following shows the structure of the Audits table as


viewed in SQL Server Management Studio:

Creator

The RightFax UserID of the user performing


the action.

AuditedValue

The ID of the RightFax object receiving the


action.

ServerGUID

The unique identifier of the RightFax server


receiving the action.

Using the RightFax Administrative


Utilities

Audits table columns

Utility

Description

ChgUser.exe

Changes RightFax privileges and options for all


users or groups of users at one time (see
Running ChgUser.exe on page 6

DSender.exe

Uploads RightFax user IDs to the HP 9100C


Digital Sender so that RightFax can apply
users specific fax transmission and
notification options (see Running DSender.exe
on page 9).

FaxAge.exe

Deletes faxes from RightFax users mailboxes


after a fixed interval (see Purging Faxes from
User Fax Mailboxes on page 10).

FaxDump.exe

Outputs fax data in text format for import into


other databases (see Running FaxDump.exe
on page 11).

Enterprise Fax
Reporter

Organizes and presents data from your


RightFax database for reporting and billing
purposes.

Here is a list of the Audits Table columns and their


descriptions.
Column

Description

ID

Unique identifier for each row, that


increments sequentially

Action

The action performed on the user or group.


Valid values are Added, Modified, or
Deleted.

AuditedType
CreationTime

The RightFax object receiving the action.


User or Group.
The date and time when the action was

OpenText RightFax 10.6

Administrative Utilities Guide

Chapter 1: Administrative Utilities

Utility

Description

Utility

Description

FaxStat.exe

Remotely monitors any RightFax server on the


network (see Running FaxStat.exe on page
12).

Folder.exe

ImpUser.exe

Imports users from a comma-delimited ASCII


file (see Running ImpUser.exe on page 12).

folder structure introduced in RightFax 10.5 and


encrypts them if encryption is licensed and
enabled. (see Migrating and Encrypting Existing Image Directories on page 21).

EncryptImages.exe

If encryption is licensed and enabled, this


encrypts non-encrypted images located in the
folder structure introduced in RightFax 10.5. .
(see Migrating and Encrypting Existing Image
Directories on page 21).

ModUser.exe

Changes user settings for multiple RightFax


users (see Running ModUser.exe on page 15

ODBCSync.exe

Imports user, printer, and billing code


information from an ODBC source (see
Running ODBCSync.exe on page 17).

orphan.exe

Searches the RightFax server for fax image


files that do not have any references in the
RightFax database (see Running
Orphan.exe on page 17).

PhnPrint.exe

Prints the published and private phonebook


entries of one or more RightFax users (see
Running PhnPrint.exe on page 18).

Remote Queue
Creator

Sets up MSMQs on a remote server (see

RFDiag.exe

shows diagnostic information about the


RightFax server (see Running Server
Diagnostics on page 19).

ServSync.exe

Database
Upgrader.exe

MigrateImage

Running ChgUser.exe
ChgUser.exe is a command line utility that changes RightFax
permissions and options for multiple users at one time.
ChgUser.exe is located in the RightFax\AdminUtils folder on
the RightFax server.
Note Unless you use the -u option to specify individual
RightFax user IDs, ChgUser commands are applied to all
RightFax user IDs.
Syntax
chguser [options] [keywords]
The following table shows the ChgUser.exe command line
options.

Compares database objects on two RightFax


servers (see Running ServSync.exe on page
19

Option

Function

-1 number

Specify default fax number for users

Runs the SQL scripts required to upgrade


an existing RightFax 10.0 server to
RightFax10.6 compatibility (see Running the
Database Updater tool on page 20).

-2 number

Specify default voice number for users

-3

Show a user list with ID, name, and routing code

-4

Reset all user names to match user IDs

Places existing (pre 10.5) image files into the

-6

Show a tab-delimited user list with ID, name,

OpenText RightFax 10.6

Administrative Utilities Guide

Chapter 1: Administrative Utilities

Option

Function

Option

routing code, and group ID


-7 option

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

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

-a printerID

Specify the printer ID to automatically print


received faxes

-b printerID

Specify the printer ID to automatically print sent


faxes

-ccoversheetID

Specify the cover sheet ID for users

-d

Turn on Debug mode

-fserver

Specify the name of RightFax server

-g groupID

Name of group. Place users. Use existing group ID

-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

-n send,receive

Sets sent and received fax notifications. Separate


send and receive values with a comma (i.e., n0x80,0x00)

Values for receive are:


0x00 = Do not send messages for received faxes
0x01 = Send new fax message one time 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

-p printerID

Specify the ID of the default printer for users

-r type

Specify routing types for users using the following:


RF = RightFax mailbox
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

Values for send are:


0x01 = Send Info incomplete message one time
0x02 = Send Info incomplete message
periodically
0x04 = Send Sending.... message one time only
0x08 = Send Sending... message periodically

OpenText RightFax 10.6

Function

Add + to the end of the routing type to delete the


original file after routing (e.g., -rSMTP+)

Administrative Utilities Guide

Chapter 1: Administrative Utilities

Option

Function

-sformat

Fax file routing format using the following:

Keyword

machine. Use Noautoforward to disable the


autoforward feature

PCX = PCX format


DCX = DCX format
G3 = TIFF-G3 format
G4 = TIFF-G4 format
PDF = PDF format
GIF = GIF format
-tprotocol

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

Force protocol to specific type (rather than


assigning automatically) using the following:
n = Named Pipes
t = TCP/IP

-u userIDs

Comma delimited list of users to change

-v

Show current values for users

-x

Delete the users specified with the -u command


line option (required)

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
Stamppermission

autoforwardfax

Enables the autoforward feature to a fax

OpenText RightFax 10.6

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

The following table shows the ChgUser.exe keywords.


Keyword

Function

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 selection of billing codes


by ID

bodyfine/
bodynormal

Sets resolution of fax body to fine or normal

bypassbillcodeverify/
Enables/disables permission to bypass
nobypassbillcodeverify 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 ID

Administrative Utilities Guide

Chapter 1: Administrative Utilities

Keyword

Function

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 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

Syntax

protected/
unprotected

Sets user mailbox to protected (requires


password) or unprotected (does not require
password)

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

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

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\AdminUtils 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.

The following table shows the DSender.exe command line


options.

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

OpenText RightFax 10.6

Option

Function

-idigsender

Specifies the IP address of the Digital Sender.

-a account

The account name used to log on to the Digital


Sender. Default account name is
ADMINISTRATOR.

-p password

The password for the account name used to log on


to the Digital Sender.

-ffaxserver

The name of the RightFax server to synchronize.

-u userID

Specifies the user ID to use as the model when


creating new users (set to DEFAULT).

-tprotocol

Force network protocol to specific type (rather

Administrative Utilities Guide

Chapter 1: Administrative Utilities

Option

Purging Faxes from User Fax Mailboxes

Excluded from Group Fax Aging permission in their


RightFax user profiles.

Function
than assigning automatically) using the following:

RightFax also includes a command line utility, FaxAge.exe,


that purges fax records from users mailboxes.

n = Named pipes (default)


t = TCP/IP
-1

Running FaxAge.exe

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

Prevents synching of the ADMINISTRATOR


account.

-z

Deletes existing unmatched users from the


destination system.

FaxAge.exi is a command line utility that purges fax records


from users mailboxes. FaxAge.exe is located in the
RightFax\AdminUtils folder on the RightFax server.
Important Execute this utility as the fax server is running.
Syntax
faxage-fserver-auserID-ofile [-dvalue] [-emm/dd/yyyy] [llevel] [-ppassword][-q] [-smm/dd/yyyy] [-t{n|s|t|x}] [uuserIDs] [-wfolder] [-y] [-z]

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

The following table shows the FaxAge.exe command line


options.

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 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.

Purging Faxes from User Fax Mailboxes


RightFax includes a feature called automatic fax aging that
you can use to delete fax images from user fax mailboxes
after a certain length of time. This can prevent older fax
images from occupying too much hard drive space on your
server. Automatic fax aging is only available if you have a
RightFax Enterprise or Satellite server. This feature is
configured separately for each group . Individual users can
be excluded from automatic fax aging by checking the

OpenText RightFax 10.6

Option

Function

-a userID

The RightFax user ID to use when logging in to the


RightFax server. A password can be required using
the -p option.

-d value

Specifies faxes to delete


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
8 = only faxes with incomplete information
9 = only received faxes with incomplete information

10

Administrative Utilities Guide

Chapter 1: Administrative Utilities

Option

Purging Faxes from User Fax Mailboxes

Function

Option

Function

10 = only red status faxes


11 = only yellow status faxes

-y

Skips any verification questions.

-z

Without this parameter, no deletions will occur.

-e mm/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).

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

Note Use the 4-digit year format.


-fserver

Specifies the name of RightFax server.

-llevel

Information level 0 or 1 (default is 0).

-o file

Output file listing all deleted faxes. If the file already


exists, the new file list is appended to the end.

-p password

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.

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 FaxDump.exe Data
Fields on page 48. FaxDump.exe is located in the
RightFax\AdminUtils folder on the RightFax server.

-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).

-tprotocol

Syntax

Note Use the 4-digit year format.

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}]

Forces protocol to specific type (rather than


assigning automatically) using the following:

The following tables shows the FaxDumpe.exe command line


options.

n = Named Pipes (default)


t = RCP/TCP_IP
-u userIDs

Comma delimited list of users (default is all users).

-wfolder

Name of folder in for restricted deletions (default is


all folders).

OpenText RightFax 10.6

11

Option

Function

-1

Fields that contain a delimiter (see the -d option) will


not include quotation marks.

-a userID

The RightFax user ID to use when logging in to the


RightFax server. A password can be required using
the -p option.

Administrative Utilities Guide

Chapter 1: Administrative Utilities

Option

Function

-d ASCII

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).

Purging Faxes from User Fax Mailboxes

Option

can also be specified as a day offset, i.e, -S-30


(default is 01/01/1980).
-tprotocol

-e mm/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.

-g groupID

The RightFax group ID for a group of users for


reporting.

-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:

Limits the output to P2P faxes.

-llevel

Information level 07 (default is 0). See


FaxDump.exe Data Fields on page 48,
FaxDump.exe Data Fields on page 48 for details on
the available information levels.

-o file

Name of the ASCII file to output.

-p password

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 is ignored.

-u userIDs

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, DocTransport, server status, WorkServer, e-mail
gateways, and RPC server status on any RightFax server.
FaxStat.exe is located in the RightFax\AdminUtils 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\AdminUtils folder on the RightFax
server.
To import user IDs from a file, create a comma-delimited
ASCII file containing all of the user records to import. Each
user record appears on a separate line and contains 22 fields.
The following table lists each of these fields in the required

-smm/dd/yyyy The starting date of the date range to report on. This

OpenText RightFax 10.6

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)
t = RPC/TCP_IP

s = Ignore successfully transmitted faxes


f = Ignore failed faxes
a = Ignore all failed fax history records
-j

Function

12

Administrative Utilities Guide

Chapter 1: Administrative Utilities

Purging Faxes from User Fax Mailboxes

order (use quotation marks around any field that contains an


embedded comma).
Field

Maximum
length

Description

User ID

21

Unique RightFax user ID (If a user


with this ID already exists, the
existing user is changed)

User name

29

Descriptive user name

Password

11

Password used to access FaxUtil


and administrative functions

Group

21

The users existing group ID.

Routing code

Cover sheet

12

Permissions
flags

31

Notification type 2

Routing info

99

OpenText RightFax 10.6

Field

Maximum
length

Description

Type Use a required format: RF,


CC, MS, FILE, OCR, 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

File format to use when routing. be


one of the following: PCX, DCX,
TIFF-G3, or TIFF-G4

Unique routing code for the user

Subscriber ID

File name (no path) of default cover


sheet file in RightFax\FCS folder.
The file name ends with .pcl or
.doc. Leave blank to use groups
default cover sheet

Voice mail subscriber ID, if


telephony system routing is
enabled

From name

59

Default From Name for cover


sheet

From phone

31

Characters that specify assigned


user permissions (see Running
ImpUser.exe on page 12)

Default From Voice Number for


cover sheet

DID fax num

31

Default DID Fax Number for cover


sheet

Notification type for received faxes:

General fax

31

0 = Use groups type


19 = Custom type

Default General Fax Number for


cover sheet

Operator num

31

Default Operator Voice Number


for cover sheet

11 = MS Mail
14 = CallXpress
16 = Notes
17 = Exchange
18 = SMTP

Distinguished
name

79

The Microsoft Exchange


distinguished name, used to
confirm accurate
RightFax/Exchange user
synchronization

Routing information formatted as


Type:Info or +Type:Info where

Default billing
code 1

15

Default Billing Code 1 setting

13

Administrative Utilities Guide

Chapter 1: Administrative Utilities

Field

Maximum
length

Description

Default billing
code 2

15

Default Billing Code 2 setting

Pager notify
(User)

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
(Admin)

Pager flags

99

31

Purging Faxes from User Fax Mailboxes

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
Characters that specify pager
notification events (see Running
ImpUser.exe on page 12 on 12)

Email

255

The reply-to email address of the


user.

Notify Addr/Info

100

The email address of the user for


email notification, or other
information necessary for sending
fax notifications.

Flag

Function

Disallow fax deleting

Can add/update forms

Can use high priority

Cannot search billing codes

Can add/update library documents

have password

Can OCR faxes

Can run reports

Sent fax archiving

Unprotected mailbox

View first page only

Administrator can bypass privacy restrictions.

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

The following table lists user permission flags that can be


used in the import file. A plus (+) or minus () sign follows
each character. Use it to add or remove permission.

Flag

Function

All DocTransport services down

DocTransport service down

Critically low disk space

Server Event Queue full

hinterval

Periodic server heartbeat. Specify heartbeat


interval in minutes

Flag

Function

Administrative access

Server improperly started

Bypass billing code verification

Low disk space

Can change cover sheet

New fax received

OpenText RightFax 10.6

14

Administrative Utilities Guide

Chapter 1: Administrative Utilities

Flag

Function

Outbound fax is abandoned

Probable line failure

qfaxes-pages

Send queue too deep. Specify fax and page


maximum depths

Purging Faxes from User Fax Mailboxes

Option

Function
this option blank.

-tprotocol

Forces protocol to specific type (rather than


assigning automatically) using the following:
n = Named Pipes
t = TCP/IP

After you create the ASCII file to import, run the


ImpUser.exe command line utility.
Important The fax server be running when executing this
utility.

-u userID

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.

Syntax
Example

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


Option

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


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

Function

-d templateID 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.

Running ModUser.exe

-g groupname Specifies the name of a Windows NT group for


importing. If not specified, imports all users in the
domain.
-isourcefile

Specifies the name of the file to import.

-n source

Specifies the name of the Windows NT server to


import the Windows NT domain accounts from.

-o outputfile

Outputs the user list to a file rather than importing to


RightFax. This file can be edited and re-imported.

-p password

The RightFax password for the user ID specified


with the -u option. To use NT authentication, leave

OpenText RightFax 10.6

ModUser.exe is a Windows-based utility available only with


RightFax Enterprise servers that changes RightFax
permissions and options for multiple users at one time.
RightFax administrative privileges are needed to run
ModUser.exe. ModUser.exe can be run from any workstation
on your network.To use ModUsers Windows NT user import
function, Use a computer running Windows NT 4.0.
ModUser.exe is located in the RightFax\AdminUtils folder on
the RightFax server.

15

Administrative Utilities Guide

Chapter 1: Administrative Utilities

Purging Faxes from User Fax Mailboxes

After it is installed, run ModUser.exe. When prompted for a


server name, enter the name of the RightFax server you
want to modify, and click Next. Choose the network protocol
for the server and click Next. Finally, enter your RightFax
administrator user ID and password, and click Finish. The
Modify User window opens.

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 and 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.

For each option, a check mark means 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.
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 show that they have unsaved
changes. you are prompted to save all your changes when
you close the Modify User dialog box. To immediately apply

OpenText RightFax 10.6

16

Administrative Utilities Guide

Chapter 1: Administrative Utilities

Purging Faxes from User Fax Mailboxes

changes without quitting, select Save Changes from the


File menu.

record of their existence and cannot access them. Using


Orphan.exe, orphan image files can be deleted from the
server, or their records can be restored in the RightFax
database.

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\AdminUtils folder on the
RightFax server.

Orphan.exe is located in the RightFax\Database folder on the


RightFax server. The fax server is not running when
executing this utility.
Syntax
orphan -fcomputer-ipath-uuserID [-a] [-n] [-z]

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

Option

Function

-n

Do not prompt.

-ipath

Specifies the path to the IMAGE files. (e.g. iC:\RIGHTFAX\IMAGE).

Option

Function

-f

The fax server to connect to.

-ffaxserver

Specifies the name of a fax server to update.

-z

Actually erase files.

-o

Overwrite any records that already exist on the


server.

-a

Recovers files to the -u option.

-l

-tprotocol

Forces protocol to specific type (rather than


assigning automatically) using the following:

Login UserID for logging in to the fax server. you are


prompted for a password.

-d

Debug output (show all files being processed).

-u (only used
with the -a
option)

The UserID to recover the files into.

n = Named Pipes
s = SPX
t = TCP/IP
Example

Example

odbsync -frfserver -tt -o ODBCImport.ini

orphan -fjanescomputer -ic:\program files\rightfax\image ujanedoe -a

Running Orphan.exe
Orphan.exe searches the RightFax server for fax image files
that do not have any references in the RightFax database.
The image files are called orphans because RightFax has no

OpenText RightFax 10.6

17

Administrative Utilities Guide

Chapter 1: Administrative Utilities

Purging Faxes from User Fax Mailboxes

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\AdminUtils folder on the RightFax server.

Force protocol to specific type (rather than assigning


automatically) using the following:

Comma delimited list of users whose phonebooks you


want to print

Example

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


Option

Function

-fserver

Specify the name of RightFax server that contains the


users whose phonebooks you want to print.

-g option

Print phonebook groups from the specified users


phonebooks. Specify option 0 or 1 where:

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


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

0 = Include phonebook groups


1 = Do not include phonebook groups (default)
Output format 0, 1, 2, or 3 where:

Running the Remote Queue Creator

0 = Multi-line format, printed for reference (default)


1 = Space-delimited format

Use the Remote Queue Creator to prepare a remote server to


handle the MSMQ queuing functions. Install the AdminUtils on
the remote server before you can run the Remote Queue
Creator.

2 = Comma-delimited format
3 = Tab-delimited format

The Remote Queue Creator files are stored in their own folder
in the RightFax\AdminUtils folder. Install the AdminUtils on
the remote server before you can run the Remote Queue
Creator.

Output file listing phonebook entries for all specified


users

-ppassword Comma delimited list of passwords for specified users


-q

-tprotocol

-u userIDs

Syntax

-o file

Function

n = Named Pipes (default)


t = TCP/IP

Important The fax server must be running when


executing this utility.

-lformat

Option

Lists the field definitions for all of the output formats.


This option overrides all other options

OpenText RightFax 10.6

18

Administrative Utilities Guide

Chapter 1: Administrative Utilities

Running Server Diagnostics

To start the queue creation process, double-click


RemoteQueueCreator.exe from the remote server. The
utililty creates all the queues necessary.

Option

After the remote queue server is set up, change the MSMQ
server string in both the RightFax Server and the
DocTransport modules. Point all RightFax components to the
same MSMQ server. For more detail, see the Configuring
RightFax Server and Configuring the DocTransport
Modules sections in the RightFax Administrators
Guide.

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.

dir5

List files in the RightFax\BFT folder.

Running Server Diagnostics

dir6

List files in the RightFax\FCS folder.

dir7

List files in the RightFax\Sig folder.

Function
subfolders.

Running RFDiag.exe

dir8

List files in the RightFax\Papers folder.

RFDiag.exe is a command line diagnostic utility that shows


information about the RightFax server that runs RFDiag.exe.
RFDiag.exe is included in the RightFax\AdminUtils folder on
the RightFax server.

dir9

List files in the RightFax\DocTransport folder.

hw

Show fax hardware configuration.

net

Show network configuration.

Note The fax server must be running when executing this


utility.

srv

Show fax server configuration.

svc

Show installed services.

sys

Show information about the fax server system


configuration.

Syntax
rfdiagoptions
Option

Function

all

Show all available configuration information.

app

Show information about your Microsoft Office,


Microsoft Exchange, and Lotus Notes applications,
if any.

brd

Show DocTransport configuration.

dev

Show installed devices.

dir

Show a summary of the contents of the RightFax

OpenText RightFax 10.6

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\AdminUtils
folder on the RightFax server.

19

Administrative Utilities Guide

Chapter 1: Administrative Utilities

Running the Database Updater tool

Important The fax server is running when executing this


utility.

Running the Database Updater tool


Using the Database Updater tool, you can deploy and test
new product versions while maintaining an existing product
system.

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

Function

-a userID

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.

The Database Updater tool runs the SQL scripts required to


upgrade an existing RightFax 10.0 database to RightFax 10.6
compatibility. This tool is intended to be run on a RightFax
10.6 server ONLY.
Before running this tool:

-ccategories Categories of information to be compared using the


following:
b = Billing codes
f = Forms
g = Groups
p = Printers
u = Users
* = All categories
:protocol

-v

Stop all RightFax services on the RightFax 10.6 server.

Stop all RightFax services using the target RightFax 10.0


database.

Verify that the database allows remote connections.

This tool is running from the RightFax 10.6 server.

Verify that you have the correct privileges to perform the


upgrade.

To upgrade to the 10.6 database

The network protocol to use to communicate to each


of the RightFax servers using the following:

1. From the start menu, open the OpenText program


group and click RightFax Database Upgrader.exe.

n = Named Pipes (default)


s = SPX
t = TCP/IP

2. For the Upgrade Database Information, click the target


Database you wish to upgrade.

Verbose output. This option gives you the most


comprehensive comparison.

3. Select the SQL authentication mode. If you choose SQL


Account, provide the account and password
information.

Example

4. Click Lookup to choose the database used for the


upgrade. The default name of the RightFax database is
RightFax.

servsync -Cb ns2008r2 -U1administrator -P1password FS-r2prereq:t -U2administrator -P2password

5. Click Perform Upgrade When the upgrade is

OpenText RightFax 10.6

20

Administrative Utilities Guide

Chapter 1: Administrative Utilities

Migrating and Encrypting Existing Image Directories

complete, the log information shows on the screen. If


any errors are encounted they will also be shown. A
message box will let you know if the upgrade was
successful.

RightFax 10.5. If encryption is licensed and enabled, the


images will be encrypted at the same time.
The tool is located in the RightFax\AdminUtils folder on the
RightFax server.

6. To use existing coversheets, manually copy any


coversheet files from your old RightFax 10.0 server to
the RightFax 10.6 coversheet directory (FCS).

Option

Function

-I

7. To use the RightFax 10.6 default coversheets, move


them from the FCS/Imported folder to the FCS folder
itself.

RightFax Image folder. (required).


The location where the RightFax image files are
located.

-r

8. In EFM, select the "RightFax Database" service and hit


Configure.

RightFax server name. (required).


The RightFax server name as displayed in EFM.

-o

Output File directory\Name.txt. Creates an output file


of the process.

9. Change the SQL connection to point to the newly


upgraded database.

When run without this option the output is written to


the screen

10. Change the service account the RightFax services are


running under to be an account that can access the
remote windows server the database is on (if
applicable).

-i

The utility continues if errors are encountered.


When run without this option the utility will stop
running if an error is encountered.

11. Change the image directory to point to the image


directory used by the old 10.0 server.

-w

Overwrites destination files if they already exist.


Files that cannot be deleted from the root because
they are open will be copied into the new folder
structure and a copy is retained at the root level.

12. Restart all services in EFM.


-d

Migrating and Encrypting Existing Image


Directories

Debug mode

Example C:\Program Files (x86)


\RightFax\AdminUtils\MigrateImageFolder.exe -l
"C:\Program Files (x86)\RightFax\Image" -i -w -o
"C:\Output.txt"

Running MigrateImageFolder.exe
MigrateImageFolder.exe is a command-line tool that moves
any existing (pre 10.5) image files from the root of the image
folder into the hierarchical folder structure introduced in

OpenText RightFax 10.6

21

Administrative Utilities Guide

Chapter 1: Administrative Utilities

Migrating and Encrypting Existing Image Directories

Running EncryptImages.exe
EncryptImages.exe is a command-line tool that encrypts
existing unencrypted image files if encryption is licensed and
enabled. Any image files found at the root are placed into a
hierarchical folder structure.
The tool is located in the RightFax\AdminUtils folder on the
RightFax folder.
Option

Function

-r

RightFax server name. (required).


The RightFax server name as displayed in EFM.

-o

Output File directory\Name.txt. Creates an output file


of the process.
When run without this option the output is written to
the screen

-i

The utility continues if errors are encountered.


When run without this option the utility will stop
running if an error is encountered.

-d

Debug mode

Example C:\Program Files (x86)


\RightFax\AdminUtils\EncryptImages.exe -l "C:\Program
Files (x86)\RightFax\Image" -i -o "C:\Output.txt"

OpenText RightFax 10.6

22

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

Running RightFax Enterprise Fax Reporter

Chapter 2: Enterprise Fax Reporter

The RightFax database stores detailed information about


each sent and received fax. The RightFax Enterprise Fax
Reporter administrative utility organizes and presents this
information for reporting and billing.
Fax Reporter can be run from the RightFax server or from a
client workstation.

Running RightFax Enterprise Fax


Reporter
To run RightFax Enterprise Fax Reporter, select Start >
Programs (or All Programs) > OpenText > RightFax
Enterprise Fax Reporter. The RightFax Fax Reporter
program opens.

Note Although any user can run RightFax Enterprise Fax


Reporter, the user needs Can Run Reports permission in
his or her RightFax user profile to access report data from
the specified server.

OpenText RightFax 10.6

23

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

Note If you choose Windows Authentication, the User ID,


Password, and Remember Password boxes will be disabled
because Windows provides this information.

Opening Reports
To open a report
1. Click File > Open Report. The Select Report dialog
box opens.

l
l

Your SQL Server User ID and Password. The ID used to


create the reports require datareader SQL server
permission. Certain reports also require execute
permission; see the individual report descriptions later in
this section.
The name of your RightFax Database.
Check the box to Remember Password, if applicable.

Enter the required parameter values, such as Date Range.


For some reports, other parameter values will also need to
be defined.

2. Use any of the following ways to open a report:


l
l
l

Highlight a report, and click Open.


Double-click a report.
Right-click a report, and choose Select.

3. In the RightFax SQL Server dialog box, enter the


following information to log in:
l

The name of your SQL Server, followed by


\Rightfax.
Your Authentication type (SQL Server or Windows
Authentication). Use Windows Authentication if your
company uses Windows Authentication to
synchronize your RightFax and SQL Server
passwords with Windows.

OpenText RightFax 10.6

24

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

Available Fax Reports

Automation_Inbound_RemoteID.rpt on page 27

Printing a Fax Report

Automation_Inbound_User.rpt on page 27

To print a fax report

Automation_Outbound_Day.rpt on page 27

1. To print the report, click the Print icon.


2. Depending on the type of report you select, an Enter
Parameter Values dialog box opens. The dialog box
looks different depending on the parameters for the
specific report.

Automation_Outbound_Failed_User.rpt on page 27
Automation_Outbound_UniqueID.rpt on page 28
Automation_Outbound_User.rpt on page 28
Billing_Detailed_BillingCode1.rpt on page 29

3. Enter parameters for your report.

Billing_Detailed_BillingCode1_BillingCode2.rpt on page 29
Note You can use the standard wildcards * and ? to
define a user set. The * character represents
unlimited characters. The ? character represents any
single character. The * character entered in this box
by default will run the report on all users.

Billing_Detailed_BillingCode2.rpt on page 29
Billing_Summary_BillingCode1.rpt on page 30
Billing_Summary_BillingCode1_BillingCode2.rpt on page 30
Billing_Summary_BillingCode2.rpt on page 30
Channel_Usage.rpt on page 30

Exporting Report Information to Another File


Format

Channel_Usage_Summary.rpt on page 31
Destination_FaxNumber.rpt on page 31

To export fax report information to a specific file format

Destination_RemoteID.rpt on page 31

1. Open a report in Enterprise Fax Reporter.


2. Click Export Report.
3. Choose the report to export, a location, and a format
from Save as type.

Destination_ToCompany.rpt on page 32
Destination_ToName.rpt on page 32
Fax_Printing_Group.rpt on page 32

4. Click Save. Saved reports are stored in C:\Program


Files\RightFax\Admin_Utils\Reports.

Fax_Printing_User.rpt on page 33
FaxLists_Detailed_AllFaxes.rpt on page 33

Available Fax Reports

FaxLists_Detailed_CompletedFaxes.rpt on page 33

With Enterprise Fax Reporter, you can generate any of the


following reports.

FaxLists_Summary_AllFaxes.rpt on page 34
FaxLists_Summary_CompletedFaxes.rpt on page 34

AdvancedAuditReport.rpt on page 26

FaxLists_Summary_HumanRoutedReceived.rpt on page 35

Automation_Inbound_Day.rpt on page 26

OpenText RightFax 10.6

25

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

Available Fax Reports

FaxLists_Summary_HumanRoutedReceived_SubReport_
ReceivedCount.rpt on page 35

l
l

FaxLists_Summary_HumanRoutedReceived_SubReport_
ReceivedEdcCount.rpt on page 35

l
l
l

Outbound_Activity_Users.rpt on page 35

Date/Time of the action


Name of the user performing the action
Action taken (Added, Deleted, or Modified)
Type of object modified (User or Group)
Name of object modified (User or Group name)

Outbound_Completed_Activity_Users.rpt on page 36

Valid parameters are:

RIC_PSTN_Outbound_by_Country.rpt on page 36

DateRange; Search User (String, Wildcard); Audited Action


(String, Wildcard); Audited Action Type (String, Wildcard);
Audited Value (String, Wildcard)

RIC_PSTN_Outbound_Usage.rpt on page 36
RIC_Usage_Inbound_Users.rpt on page 36
RIC_Usage_Outbound_Users.rpt on page 37

Automation_Inbound_Day.rpt

Time_of_Day_Inbound_Usage.rpt on page 37

Report Title: Received Fax Report Inbound Faxes by Day

Time_of_Day_Outbound_Usage.rpt on page 37

For each day, the report shows:

Time_of_Day_Usage.rpt on page 38

RightFax user ID.

Usage_Inbound_TransmissionTime.rpt on page 38

Date and time the fax was received.

Usage_Inbound_Users.rpt on page 39

Status of the fax (viewed or printed).

Usage_Outbound_TransmissionTime.rpt on page 39

DID number that the fax was sent to.

Usage_Outbound_Users.rpt on page 39

Name or telephone number of the sending fax machine


(remote ID).

Usage_Top_10_Inbound_Users.rpt on page 39

Status of the fax transmission.

Usage_Top_10_Outbound_TransmissionTime.rpt on page 40

Number of pages in the fax.

Usage_Top_10_Outbound_Users.rpt on page 40

Length of time of the transmission.

Usage_Top_10_Inbound_TransmissionTime.rpt on page 39

AdvancedAuditReport.rpt

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.

Report Title: Audit Activity


This report shows an audit trail of additions, deletions, and
modifications to Group and User accounts. For each change,
the report shows:

OpenText RightFax 10.6

The only parameter required for this report is the DateRange.

26

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

Available Fax Reports

Automation_Inbound_RemoteID.rpt

l
l

Report Title: Received Fax Report Inbound Faxes by


RemoteID

For all users, the report shows the overall total pages
received.

For each sending fax machine, the report shows:


l

l
l
l
l
l
l
l
l

Number of pages in the fax.


Length of time of the transmission.
Overall total number of fax pages received by the user.

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.

The only parameter required for this report is the DateRange.

Automation_Outbound_Day.rpt
Report Title: Sent Fax Report Outbound Faxes by Day
For each day, the report shows:
l
l
l
l

For each sending fax machine, the report shows the total
pages received. For all received faxes, the report shows the
overall total pages received.

l
l
l
l

The only parameter required for this report is the DateRange.

Automation_Inbound_User.rpt

l
l

Report Title: Received Fax Report Inbound Faxes by User

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 RightFax user ID, the report shows:


l

l
l
l
l

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.

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.

OpenText RightFax 10.6

The only parameter required for this report is the DateRange.

Automation_Outbound_Failed_User.rpt
Report Title: Failed Fax Report Unsuccessful Outbound Faxes
by User

27

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

Available Fax Reports

For each sent fax that failed in transmission, the report


shows:
l

l
l

l
l
l
l

l
l

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.

l
l
l

The report shows the overall total pages sent during the
reporting period.
The only parameter required for this report is the DateRange.

Automation_Outbound_User.rpt
Report Title: Fax Report Outbound Faxes by User
For each RightFax user, the report shows:
l
l
l

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.

l
l
l

The only parameter required for this report is the DateRange.

l
l

Automation_Outbound_UniqueID.rpt
l

Report Title: Fax Report Outbound Faxes by Unique ID

For each sent fax, the report shows:


l
l
l
l
l
l
l

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.

OpenText RightFax 10.6

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.

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.
The only parameter required for this report is the DateRange.

28

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

Available Fax Reports

Billing_Detailed_BillingCode1.rpt

l
l

Report Title: Detailed Billing Report - BillingCode1 Outbound


Faxes Only

l
l
l

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.

For all faxes, the report shows the overall total pages sent.

The detailed report lists faxes sorted by billing code 1. For


each fax, the report shows:
l
l
l
l
l

The only parameter required for this report is the DateRange.

Billing_Detailed_BillingCode2.rpt

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.

Report Title: Detailed Billing Report - BillingCode2 Outbound


Faxes Only
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.

For all faxes, the report shows the overall total pages sent.

The detailed report lists faxes sorted by billing code 2. For


each fax, the report shows:

The only parameter required for this report is the DateRange.

Billing_Detailed_BillingCode1_
BillingCode2.rpt

Report Title: Detailed Billing Report - BillingCode 1 and Billing


Code 2 Outbound Faxes Only

l
l

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.

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.
The only parameter required for this report is the DateRange.

The detailed report lists faxes sorted billing code 1 and billing
code 2. For each fax, the report shows:

OpenText RightFax 10.6

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.

29

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

Available Fax Reports

Billing_Summary_BillingCode1.rpt

Billing_Summary_BillingCode2.rpt

Report Title: Summary Billing Report - BillingCode1 Outbound


Faxes Only

Report Title: Summary Billing Report - BillingCode 2


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.

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.

For each value of Billing Code 2, the report shows:

For each value of Billing Code 1, the report shows:


l
l

Number of pages
Elapsed time

The report also shows a total overall number of pages and


elapsed time.

The report also shows a total overall number of pages and


elapsed time.

Valid parameters are DateRange; ServerName (String)

Valid parameters are DateRange; ServerName (String)

Channel_Usage.rpt

Billing_Summary_BillingCode1_
BillingCode2.rpt

Report Title: Channel Usage Report by Day


The detailed report lists the usage of the fax channels on
each board server for each day of the reporting period.

Report Title: Summary Billing Report - BillingCode 1 and


Billing Code 2 Outbound Faxes Only

For each fax channel, the report shows:

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.

l
l
l
l

For each value of Billing Code 1 and Billing Code 2, the report
shows:
l
l

Number of pages
Elapsed time

Total minutes.
Receive minutes.
Send minutes.
Utilization percentage.

For each DocTransport, the report shows:

Number of pages
Elapsed time

l
l
l

The report also shows a total overall number of pages and


elapsed time.

Total minutes.
Total receive minutes.
Total send minutes.

For all DocTransports for each day, the report shows:

Valid parameters are DateRange; ServerName (String)

OpenText RightFax 10.6

30

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

l
l
l

Available Fax Reports

Overall total minutes.


Overall total receive minutes.
Overall total send minutes.

Destination_FaxNumber.rpt
Report Title: Destination Record Outbund Faxes by Fax
Number (search parameter)

For all DocTransports and all days in the reporting period, the
report shows:
l
l
l

This report lists faxes sent to a specific fax number. For each
fax number, the report shows:

Overall total minutes.


Overall total receive minutes.
Overall total send minutes.

l
l
l
l

The only parameter required for this report is the DateRange.

l
l

Channel_Usage_Summary.rpt

Report Title: Channel Usage Summary Report


l

The summary report lists the usage of the fax channels on


each board server.

l
l

RightFax user ID of the person who sent the fax.


The user group of the user.
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 each fax channel, the report shows:


l
l
l
l

For all faxes, the report shows the overall total pages sent.

Total minutes.
Receive minutes.
Send minutes.
Utilization percentage.

You are prompted to enter a fax number.


Valid parameters are DateRange; Destination (String,
Wildcard)

For each board server, the report shows:


l
l
l

Destination_RemoteID.rpt

Total minutes.
Total receive minutes.
Total send minutes.

Report Title: Destination Report Outbund Faxes by Remote ID


(search parameter)
This report lists faxes sent to a specific recipient fax
machine. For each fax machine, the report shows:

For all board servers, the report shows:


l
l
l

Overall total minutes.


Overall total receive minutes.
Overall total send minutes.

l
l
l

OpenText RightFax 10.6

31

RightFax user ID of the person who sent the fax.


The user group of the user.
Date the fax was sent.
Name of the recipient.

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

l
l
l

l
l
l

Available Fax Reports

Valid parameters are DateRange; Destination (String,


Wildcard)

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.

Destination_ToName.rpt
Report Title: User History Report All Outbund Faxes for User
(s)
This report lists faxes sent to a specific recipient. For each
recipient, the report shows:

For all faxes, the report shows the overall total pages sent.

You are prompted to enter a remote ID, the name or


telephone number of the recipient fax machine.

l
l

Valid parameters are DateRange; Destination (String,


Wildcard)

l
l
l

Destination_ToCompany.rpt

Report Title: Destination Record Outbund Faxes by ToCompany (search parameter)

l
l

This report lists faxes sent to a specific recipient company.


For each company, the report shows:
l
l
l
l
l
l
l

l
l
l

For all faxes, the report shows the overall total pages sent.

RightFax user ID of the person who sent the fax.


The user group of he user.
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.

you are prompted to enter the name of a recipient.


Valid parameters are DateRange; Destination (String,
Wildcard)

Fax_Printing_Group.rpt
Report Title: Fax Printing Report Faxes Printed by Group(s)
Lists the faxes that have been printed in order by group. For
each fax, the report shows:
l

For all faxes, the report shows the overall total pages sent.

l
l

you are prompted to enter a company name.

OpenText RightFax 10.6

RightFax user ID of the person who sent the fax.


The user group of the user.
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.

32

Event date
Printer ID
Pages

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

l
l
l

Available Fax Reports

Copies
Print Time
Notes

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:

l
l

Valid parameters are DateRange; Search Group (String,


Wildcard)

Fax_Printing_User.rpt

l
l

Report Title: Fax Printing Report Faxes Printed by User(s)


l

Lists the faxes that have been printed in order by user. For
each fax, the report shows:
l
l
l
l
l
l

Event date
Printer ID
Pages
Copies
Print Time
Notes

l
l

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 are prompted to enter a RightFax user ID or phone cost.
Valid parameters are:

Valid parameters are DateRange; Search User (String,


Wildcard)

DateRange; Search User (String, Wildcard); Phone Cost


(Currency)

FaxLists_Detailed_AllFaxes.rpt

Requires datareader and execute SQL permission.

Report Title: User History Report All Outbound Faxes for User
(s)

FaxLists_Detailed_CompletedFaxes.rpt
Report Title: User History Report Completed Outbound Faxes
for User(s)

This report lists the details of all faxes. For each RightFax
user ID, the report shows:
l
l
l
l
l

This report lists the details of all completed faxes. 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.

l
l
l
l
l

OpenText RightFax 10.6

33

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.

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

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:

l
l

l
l
l

l
l
l

Available Fax Reports

l
l
l

For all faxes, the report shows the overall total pages sent.

event date and time


off hook time

Valid parameters are:


DateRange; Search User (String, Wildcard); Phone Cost
(Currency)

Name or telephone number of the recipient fax machine


(remote ID).
fax channel used for the transmission
number of pages transmitted
board result

FaxLists_Summary_CompletedFaxes.rpt
Report Title: User Fax Report Outbound Summary of
Completed Faxes for User(s)

Total for the user: pages faxed and cost

This report lists all faxes that were successfully sent. For
each fax, the report shows:

you are prompted to enter a RightFax user ID or phone cost.


Valid parameters are:

DateRange; Search User (String, Wildcard); Phone Cost


(Currency)

l
l
l

Requires datareader and execute SQL permission.

FaxLists_Summary_AllFaxes.rpt

Report Title: User Fax Report Outbound Summary of All


Faxes for User(s)

l
l
l

This report lists all faxes that the fax server attempted to
send. For each fax, the report shows:
l
l
l
l
l

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.

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.

OpenText RightFax 10.6

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.

Valid parameters are:


DateRange; Search User (String, Wildcard); Phone Cost
(Currency)

34

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

Available Fax Reports

This report returns a count of the number of documents


received that were sent to the Electronic Document
Connector for processing.

FaxLists_Summary_HumanRoutedReceived.rpt
Report Title: User Routed Received Documents Report
Activities on Received Documents Peformed by User(s)

Valid parameters are:

This report lists activities that users performed on received


documents (such as viewing or forwarding). For each
activity, the report lists:
l
l
l
l
l
l

DateRange; Search User (String, Wildcard); Phone Cost


(Currency)

Outbound_Activity_Users.rpt

Date and time of the action


RighFax user ID of the person who owns the fax
Operation (the action performed)
Fax number or Remote ID of recipient
Status of fax document
Unique ID of fax document

Report Title: User History Report All Outbound Activities for


User(s)
This report shows all outbound activities for selected users
for all faxes, including Deleted faxes. This report sorts the
faxes by user. For each fax, the report shows:

Valid parameters are:

Date and time the fax was sent.


RightFax user ID of the person who sent the fax.
Name of the recipient.
Fax number of the recipient.
Estimated cost per minute
Status of the fax transmission.
Number of pages in the fax.
Length of time of the transmission.
Total Off-Hook Time for this fax

Transmission History for each transmission attempt:

l
l

DateRange; Search User (String, Wildcard); Phone Cost


(Currency)

l
l

FaxLists_Summary_HumanRoutedReceived_
SubReport_ReceivedCount.rpt

Report Title: Documents Received

l
l

This report returns a count of the number of documents


received for all users in the selected data set.

Valid parameters are:

DateRange; Search User (String, Wildcard); Phone Cost


(Currency)

l
l
l

FaxLists_Summary_HumanRoutedReceived_
SubReport_ReceivedEdcCount.rpt

Event date and time


Remote ID of recipient device
Pages Transmitted
Off-hook Time
RightFax server name/Channel number
Board Result: Call status from fax board.

For each user, the report also shows total number of pages
with estimated cost.

Report Title: Received Documents sent to EDC

Valid parameters are:

OpenText RightFax 10.6

35

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

Available Fax Reports

DateRange; Search User (String, Wildcard); Phone Cost


(Currency)

Requires datareader and execute SQL permission.

RIC_PSTN_Outbound_by_Country.rpt

Requires datareader and execute SQL permission.

Report Title: Faxes sent by RightFax Internet Connector


(RIC) and PSTN by Country Code

Outbound_Completed_Activity_Users.rpt
Report Title: User History Report Completed Outbound
Activities for User(s)

For each Country Code, the report shows:


l

This report shows all outbound activities for selected users


for completed faxes only, including Deleted faxes. This report
sorts the faxes by user. 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.
Fax number of the recipient.
Estimated cost per minute
Status of the fax transmission.
Number of pages in the fax.
Length of time of the transmission.
Total Off-Hook Time for this fax

Transmission History for each transmission attempt:

l
l
l
l
l
l
l
l

l
l
l
l
l
l

l
l

Number of pages sent using RIC.


Number of pages sent using PSTN.
Number of faxes sent using both methods.

The report shows the total pages.


The only parameter required for this report is the DateRange.

RIC_PSTN_Outbound_Usage.rpt
Report Title: Faxes sent by RightFax Internet Connector
(RIC) and PSTN
The report shows:
l
l

Event date and time


Remote ID of recipient device
Pages Transmitted
Off-hook Time
RightFax server name/Channel number
Board Result: Call status from fax board.

Total pages sent using RIC


Total pages sent using PSTN
Number of faxes sent using both methods

The only parameter required for this report is the DateRange.

RIC_Usage_Inbound_Users.rpt
Report Title: RightFax Internet Connector (RIC) Inbound Fax
Use

For each user, the report also shows total number of pages
with estimated cost.

For each RightFax user ID, the report shows:


l

Valid parameters are:

l
l

DateRange; Search User (String, Wildcard); Phone Cost


(Currency)

Date.
Number of pages received that day.
Total number of pages received for all days.

The report shows the total pages received for all users.

OpenText RightFax 10.6

36

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

Available Fax Reports

The only parameter required for this report is the DateRange.

RIC_Usage_Outbound_Users.rpt

If you enter a DateRange for more than one day, the Minutes
Elapsed column will reflect a total of the reception time for all
days for each hour (not an average).

Report Title: RightFax Internet Connector (RIC) Outbound


Fax Use

When running this report, enter the number of channels for


the hypothetical calculation.

For each RightFax user ID, the report shows:

For each hour, the report shows:

l
l
l

Date.
Number of pages sent that day.
Total number of pages sent for all days.

l
l
l

The report shows the total pages sent for all users.

Minutes Elapsed
Percentage of capacity for entered number of channels
Percentage of capacity for the actual number of channels

The only parameter required for this report is the DateRange.

The report shows the grand total number of minutes for all
channels, and the channel numbers that were actually used
during the specified date range..

Time_of_Day_Inbound_Usage.rpt

Valid parameters are:

Report Title: Time of Day Usage Report Inbound Faxes

DateRange; Receive-Capable Channels (Number)

This report shows the total number of minutes used by all


inbound channels for each hour of the day, and calculates a
utilization percentage for both a hypothetical number of
receiving channels and for the actual number of inbound
channels used.

Time_of_Day_Outbound_Usage.rpt
Report Title: Time of Day Usage Report Outbound Faxes
This report shows the total number of minutes used by all
outbound channels for each hour of the day, and calculates a
utilization percentage for both a hypothetical number of
sending channels and for the actual number of outbound
channels used.

For example, a 16 channel board server receives faxes for


120 minutes in the hour between noon and one pm on a given
day. To find out the percentage of capacity if this volume had
occurred across only 4 channels, run the report using 4 for
the Receive-Capable Channels field. The resulting report
would show the actual minutes (120), a utilization of 50% on
4 channels, and the actual utilization of 12.5% across all 16
channels. If you entered 1 for the Receive-Capable
Channels field, the utilitization percentage column would
show a 200% capacity. One channel can only receive for 60
minutes each hour and the actual volume was 120 minutes.

OpenText RightFax 10.6

For example, a 16 channel board server sends faxes for 120


minutes in the hour between noon and one pm on a given
day. To find out the percentage of capacity if this volume had
occurred across only 4 channels, run the report using 4 for
the Send-Capable Channels field. The resulting report would
show the actual minutes (120), a utilization of 50% on 4
channels, and the actual utilization of 12.5% across all 16
channels. If you entered 1 for the Send-Capable Channels
field, the utilitization percentage column would show a 200%

37

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

Available Fax Reports

capacity. One channel can only transmit for 60 minutes each


hour and the actual volume was 120 minutes.

channels. If you entered 1 for the Send-Capable Channels


field, the utilitization percentage column would show a 200%
capacity. One channel can only transmit for 60 minutes each
hour and the actual volume was 120 minutes.

If you enter a DateRange for more than one day, the Minutes
Elapsed column will reflect a total of the transmission time
for all days for each hour (not an average).

If you enter a DateRange for more than one day, the Minutes
Elapsed column will reflect a total of the transmission time
for all days for each hour (not an average).

When running this report, enter the number of channels for


the hypothetical calculation.

When running this report, enter the number of channels for


the hypothetical calculation.

For each hour, the report shows:


l
l
l

Minutes Elapsed
Percentage of capacity for entered number of channels
Percentage of capacity for the actual number of channels

For each hour, the report shows:


l
l

The report shows the grand total number of minutes for all
channels, and the channel numbers that were actually used
during the specified date range..

Minutes Elapsed
Percentage of capacity for entered number of channels
Percentage of capacity for the actual number of channels

The report shows the grand total number of minutes for all
channels, and the channel numbers that were actually used
during the specified date range..

Valid parameters are:


DateRange; Send-Capable Channels (Number)

Valid parameters are:

Time_of_Day_Usage.rpt

DateRange; Send-Capable Channels (Number)

Report Title: Time of Day Usage Report Outbound Faxes

Usage_Inbound_TransmissionTime.rpt

This report shows the total number of minutes used by all


outbound channels for each hour of the day, and calculates a
utilization percentage for both a hypothetical number of
sending channels and for the actual number of outbound
channels used.

Report Title: Inbound Fax Users by Transmission Time


For each RightFax user ID, the report shows:
l
l

For example, a 16 channel board server sends faxes for 120


minutes in the hour between noon and one pm on a given
day. To find out the percentage of capacity if this volume had
occurred across only 4 channels, run the report using 4 for
the Send-Capable Channels field. The resulting report would
show the actual minutes (120), a utilization of 50% on 4
channels, and the actual utilization of 12.5% across all 16

OpenText RightFax 10.6

Date.
Number of minutes of transmission time for the users
received faxes that day.
Total number of minutes of transmission time for the
users received faxes for all days.

The report shows the overall number of minutes of


transmission receipt time for all users.
The only parameter required for this report is the DateRange.

38

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

Available Fax Reports

Usage_Inbound_Users.rpt

Total number of pages sent for all days.

Report Title: Inbound Fax Use by Pages

The report shows the overall total pages sent for all users.

For each RightFax user ID, the report shows:

The only parameter required for this report is the DateRange.

l
l
l

Date.
Number of pages received that day.
Total number of pages received for all days.

Usage_Top_10_Inbound_TransmissionTime.rpt
Report Title: Top 10 Inbound Fax Users by Transmission Time
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:

The report shows the overall total pages received for all
users.
The only parameter required for this report is the DateRange.

Usage_Outbound_TransmissionTime.rpt

Report Title: Outbound Fax Users by Transmission Time

Date.
Number of minutes of transmission time for the users
received faxes that day.
Total number of minutes of transmission time for all days.

For each RightFax user ID, the report shows:


l
l

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.

Date.
Number of minutes of transmission time for the users
sent faxes that day.
Total number of minutes of transmission time for the
users sent faxes for all days.

The only parameter required for this report is the DateRange.

Usage_Top_10_Inbound_Users.rpt

The report shows the overall number of minutes of


transmission time for all users sent faxes.

Report Title: Top 10 Inbound Users by Pages


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:

The only parameter required for this report is the DateRange.

Usage_Outbound_Users.rpt
Report Title: Outbound Fax Use by Pages

l
l

For each RightFax user ID, the report shows:

l
l
l

Date.
Number of pages received that day.
Total number of pages received for all days.

Date.
Number of pages sent that day.

OpenText RightFax 10.6

39

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

Running Fax Reporter from a Command Line

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.

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.

The only parameter required for this report is the DateRange.

The only parameter required for this report is the DateRange.

Usage_Top_10_Outbound_
TransmissionTime.rpt

Running Fax Reporter from a Command


Line

Report Title: Top 10 Outbound Fax Users by Transmission


Time

You can run the Enterprise Fax Reporter utility from a


command line. The utility EnterpriseFaxReporter.exe is
located in the RightFax\AdminUtils folder on the RightFax
server.

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:
l
l

Required Parameters for All Reports

Date.
Number of minutes of transmission time for the users
sent faxes that day.
Total number of minutes of transmission time for all days.

-reportName Path to Crystal Report to be run


-sqlServer ServerID/InstanceID for RightFax Database
-sqlDatabase RightFax Database Name

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.

-sqlNTAuth true | false

The only parameter required for this report is the DateRange.

-dateStart mm/dd/yyyy hh:mm:ss [AM][PM] (Default


time is 12am)

Usage_Top_10_Outbound_Users.rpt

-dateEnd mm/dd/yyyy hh:mm:ss [AM][PM]

-sqlUser SQL User ID


-sqlPassword SQL User Password

Report Title: Top 10 Outbound Fax Users by Pages

-outputPath Path to directory where report output will be


placed

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:
l
l
l

-outputType CR | XLS | XLSR | HTML32 | HTML40 |


PDF | RTF | WORD

Date.
Number of pages sent that day.
Total number of pages sent for all days.

OpenText RightFax 10.6

-log Error | Info | Off | Verbose | Warning

40

Administrative Utilities Guide

Chapter 2: Enterprise Fax Reporter

Available Fax Reports

Report Specific Parameters

Example: Running a specific report

-paramDestination faxNumber | RemoteID | ToCompany |


ToName for Destination_* reports

RightFax user jsmith wants to generate a report that shows


the top ten inbound users for the months of March, April, and
May. The report is stored in the C:\tmp\RightFaxReports\d
directory as a PDF file called Usage_Top_10_Inbound_Users_
HH_MM_SS_MS.pdf where HH_MM_SS_MS is the time when
the report was run.

-paramServerName Name of Server


-paramSearchUser UserID
-paramSearchGroup GroupID

EnterpriseFaxReporter.exe -reportName C:\Program


Files\RightFax\AdminUtils\Reports\Usage_Top_10_Inbound_
Users.rpt -sqlServer MyMachineName\RightFax sqlDatabase RightFax -sqlNTAuth false -sqlUser jsmith sqlPassword password -dateStart 03/01/2008 01:00:00
AM -dateEnd 05/01/2008 01:00:00 PM -outputPath
C:\tmp\RightFaxReports -outputType PDF -log Verbose

-paramSendCapableChannels Channel Number


-paramPhoneCost Cost of call
-paramAuditedType ALL | User | Group
-paramAuditedAction ALL | Added | Modified |
Deleted
-paramAuditedValue ALL | Name of value modified

Command Line Help


-help Show Help
-? Show Help
-showparams Path to Crystal Report shows the
parameters for a specific report.

Example: Using the Help


To generate a list of all of the required parameters for the
report that shows the top ten users, enter the following
command line:
EnterpriseFaxReporter.exe -showParams C:\Program
Files\RightFax\AdminUtils\Reports\Usage_Top_10_Inbound_
Users.rpt

OpenText RightFax 10.6

41

Administrative Utilities Guide

Chapter 3: RightFax Document Migration Tool

Chapter 3: RightFax Document Migration Tool

Using RightFax Document Migration Tool (MigrationMFC.exe)


system administrators can migrate fax records and
associated data between RightFax systems. This utility
accommodates staged system migrations between different
versions of RightFax, and to simplify architectural changes
that require moving fax records between systems, such as
server consolidation projects.

these types of information is by a drag-and-drop operation


from Enterprise Fax Manager.
Other key files used by the RightFax Server, such as Cover
Sheets, Signatures, Forms, etc.,are moved by manual file
copy between systems.
All metadata associated with each fax record (to/from
information, fax transmission history, viewed history,
document statuses, etc.) is copied to the destination server.
Additionally, fax images and other files associated with the
fax are copied to the destination server, including OCR files
(in the \RightFax\BFT folder), SMS files, PDF images for
faxes sent via email as PDF attachments, and Integration
Module Notification files (in \RightFax\CMDDATA).

The Migration Tool copies faxes from version 10.0, 10.5, and
10.6 fax servers of to a 10.6 fax server.
Key features of the Migration Tool include:
l
l
l
l
l

Option to stop the process at any time


Record marking and migration tracking
Comprehensive and summary activity logging
Selection of specific users or groups
Progress indicator

Note The Migration Tool does not move Deleted fax


records to the new system. Any faxes with missing files in
the Image directory are skipped and logged to the activity
log files.

Migrating Fax Records and Associated


Files

Selecting Specific Users and Groups

The RightFax Document Migration Tool copies fax documents


and associated fax recordsbetween the source and
destination RightFax servers. The tool does not create
groups, users, user folders, phonebooks, etc. All of these
items are moved by other methods. The easiest way to move

Administrators can select all users/groups, or select


individual sets of users or groups with the Migration Tool.
Selecting specific users or groups facilitates staged
migrations and server consolidations. If your RightFax
database contains a large number of user accounts, use the

OpenText RightFax 10.6

42

Administrative Utilities Guide

Chapter 3: RightFax Document Migration Tool

Fax Record Marking and Progress Tracking

Group selection options to simplify selection of user


accounts.

Detailed and Summary Logs


Each time the migration process is started, a new Tool_
Run_<date>_<time> folder is created under the Migration
Tool directory. A detailed migration.log file is created at
the beginning of the migration process, and is constantly
updated with the latest action result during the entire
process.

Fax Record Marking and Progress


Tracking
After each fax record is successfully migrated to the
destination RightFax server, the Comments field of the fax
record on the source RightFax server is replaced with a
Migrated: <hexadecimal> value. The <hexadecimal>
value is the fax handle of the new fax record on the
destination server. All text previously contained in the
Comments field of the fax record on the source RightFax
server is moved to the Comments field of the new fax record
on the destination RightFax server.

At the end of the migration process, the errors encountered


during the process and a summary of activities are logged in
the MigrationSummary.log file in the same folder.
During the migration process, this folder also contains
temporary copies of one or more fax image files associated
with the current fax record migration. These files are
removed after the successful migration of each record.

If the migration process is stopped and restarted before all


fax records on the source server have been migrated, the
Migration Tool processes all fax records for the selected
users the next time the tool runs. The Comments field of all
fax records for the selected users or groups on the source
server are checked. Any records containing the Migrated
:<hexadecimal> value are skipped. All records not
containing a Migration value are processed and copied to the
destination server.

This behavior provides a number of benefits:


l

Note This can result in the duplication of a small


number of fax records on the destination server.
l

Server migrations can be performed in incremental


stages, without having to worry about what data has
already been migrated.

Source servers can remain in production. Any new fax


records accumulated on the source server are processed
the next time the Migration Tool runs. A final run when the
source server is ready to be decommissioned will verify
that all remaining records have been migrated to the
destination server.

Error Display
The administrator can visually monitor progress during a
migration run with the Migration Tool. Errors encountered
during the process are visible as they occur, and are also
written to log files.

OpenText RightFax 10.6

In the event of an unexpected process failure, the tool


processes any fax records not already marked.

43

Administrative Utilities Guide

Chapter 3: RightFax Document Migration Tool

Using the Migration Tool

Note The migration log files do not list one entry per
line in Notepad.exe included with Microsoft Windows.
Use Wordpad.exe included with Microsoft Windows or
another text editor to improve the appearance of the
logs.

Using the Migration Tool


Installation
The RightFax Document Migration Tool is a self-contained
application and does not use an installer.
To install the tool, copy the files to a single folder on the
destination RightFax Server.
Note Though the tool can be installed on any server that
can access both the source and destination drives, error
messages can be more detailed if the tool is run from the
destination drive.

3. Enter the name of the Source and Destination RightFax


servers, and the credentials of an account with
administrator privileges.
4. Click the Users or groups whose faxes you want
to migrate button. The Migrate button remains
unavailable unless a user/group selection is made

Running the Migration Tool


To run the migration tool
1. To launch the Migration Tool, open the folder where you
copied the application files, and run
MigrationMFC.exe.
2. The main Migration tool window opens

OpenText RightFax 10.6

44

Administrative Utilities Guide

Chapter 3: RightFax Document Migration Tool

Using the Migration Tool

order. As you add or remove Items, the Destination list


no longer shows in alphabetic/numeric order.
l

To select a contiguous range of items, click the first


item, hold the Shift key, and click the last item. To
select non-contiguous items, hold the Ctrl key and
select individual items. To add users/groups to the
Destination list, select the desired users/groups in
the Source list, and click the right arrow.
To remove users/groups from the Destination list,
select the desired users/groups in the Destination
list, and click the left arrow.

8. After selecting the desired users/groups, click the OK


button.
9. On the main screen, click the Migrate button.When
migration starts, the Migrate button changes to a
Stop button. Click this at any time to stop the
migration process.

5. In the Select Users or Groups window, select from the


user/group options:
l
l
l
l

Important The list of selected users/groups is not


stored. Select users/groups each time you run the
Migration Tool.

All Users
All Groups
Specific Users
Specific Groups
l

Note Selecting either All Users or All Groups has


the same effect. Remember, the Migration Tool does
not create users or groups.

6. If you select either Migrate specific Users or


Migrate specific Groups, click either the Load
users or Load groups button to load the list from the
Source server. You can select either Users or Groups,
but not both.

The Errors indicator shows errors encountered


during the process.
Separate Tool_Run_<Date>_<Time> folders are
created at under the Migration Tool directory every
time the tool runs. The folder contains a detailed
Migration.log and a MigrationSummary.log.

7. Select the users or groups that you want to migrate.


The Source list is shown in numeric, then alphabetic

OpenText RightFax 10.6

45

Administrative Utilities Guide

Chapter 4: MESSAGEmanager to RightFax Migration Tool

Chapter 4: MESSAGEmanager to RightFax Migration Tool

2. On the MESSAGEmanager(Source) tab, select the


check boxes for the items you want to import.

Administrators can import the following items from


MESSAGEmanager to RightFax using the MESSAGEmanager
to RightFax Migration tool:
l

Users

Cover pages

Sent faxes

Received faxes

3. Click the tab of each item you selected to import and


specify connection details and credentials for getting
access to the items in MESSAGEmanager:
l

For cover pages, in the Cover Pages Folder Path


box, enter the folder path to the location of the
cover pages.

For users, received faxes, and sent faxes, enter the


SQL Server Name, Database Name,
Authentication, User Name and Password for
MESSAGEmanager.

Note the following:


l

Only .rtf cover pages can be migrated.

Migrate individual cover pages before users if you want


the users to retain their association with cover pages from
MESSAGEmanager.

4. On the RightFax(Destination) tab, enter the


RightFax Server Name, the RightFax Installation
Path, and the SQL Server Name, Database Name,
Authentication, User Name and Password for
RightFax.

The tool imports the faxes for each RightFax user by


matching the last four digits of the fax number with the
user's routing code. Faxes for which no match is found are
imported under the Administrator user.

5. When importing users, specify the following:

To run the MESSAGEmanager to RightFax migration tool


1. On the RightFax server, on the Start menu, point to All
Programs, point to OpenText, and then click
MESSAGEmanager to RightFax Upgrader Tool.

OpenText RightFax 10.6

46

In the Add migrated users to this RightFax


group box, enter the name of an existing RightFax
group.

To retain MESSAGEmanager user types, select the

Administrative Utilities Guide

Chapter 4: MESSAGEmanager to RightFax Migration Tool

Set RightFax user settings based on


MESSAGEmanager user type check box. To use
the RightFax default user settings, clear the check
box.
6. To save the migration log to a location of your choice,
click Save Log and specify a name and location, and
then click Save. By default, the log is saved in
C:\ProgramData\MMtoRF\Log\MMTORF.LOG.
7. Do one of the following:
l

To save the settings, click Save Configuration.


The system validates the settings. If the validation
fails, the configuration settings are not saved.

To start the migration, click Start Migration. The


system validates the settings. If the validation fails,
the migration is not run.

OpenText RightFax 10.6

47

Administrative Utilities Guide

Chapter 5: FaxDump.exe Data Fields

Information level 0 data fields

Chapter 5: FaxDump.exe Data Fields

FaxDump.exe is a RightFax utility that outputs ASCII text


files of data about faxes that you can import into other
databases to produce reports. The text file prints one
complete fax record per line. Quotes surround fields in a
string, and all fields are separated by commas by default .

Field name

Type

Size Captured
Description
from
inbound or
outbound fax
number

This section describes the data fields in each fax record at


each level of information, in the sequence they appear in the
FaxDump text file.
Different data is available for sent and received faxes,
depending on your system configuration. For example, cover
sheet data (such as the recipients name and address) is
normally available for received faxes unless it is manually
entered into the fax record after the fax is received. Data
that is captured from inbound or outbound faxes is noted in
the following tables.

Information level 0 data fields

String 31

Outbound

Destination phone
number

To_Name

String 59

Outbound

Recipients name

To_Company

String 59

Outbound

Recipients company

To_CityState

String 59

Outbound

Recipients address

From_Name

String 59

Outbound

Senders name

From_
PhoneNum

String 31

Outbound

Senders phone
number

BillInfo1

String 15

Outbound

Billing code 1

BillInfo2

String 15

Outbound

Billing code 2

FaxDIDNum

String 31

Both

Senders or
recipients DID fax
number, when
available

Field name

Type

Owner_ID

String 21

Both

User ID of person
who sent fax

OperatorNum

String 31

Outbound

Senders company
phone number

To_FaxNum

String 31

Outbound

Destination fax

GeneralFaxNu

String 31

Outbound

Senders general fax

OpenText RightFax 10.6

Size Captured
Description
from
inbound or
outbound fax

To_
ContactNum

48

Administrative Utilities Guide

Chapter 5: FaxDump.exe Data Fields

Field name

Type

Size Captured
Description
from
inbound or
outbound fax

m
RemoteID
Send_Time
Fax_Status
Fax_TermStat

Information level 1 data fields

Information level 1 data fields


Field name

Type

Name/number of
remote fax machine

Owner_ID

String 21

Both

Total elapsed time on


fax card, in seconds

User ID of person
who sent fax

To_FaxNum

String 31

Outbound

Destination fax
number

To_
ContactNum

String 31

Outbound

Destination phone
number

To_Name

String 59

Outbound

Recipients name

To_Company

String 59

Outbound

Recipients company

To_CityState

String 59

Outbound

Recipients address

From_Name

String 59

Outbound

Senders name

number
String 21

Both

Intege 4
r

Both

Intege 2
r

Both

Intege 4
r

Both

See Fax status fields


(FaxStat) on page 55
See Termination
status fields
(TermStat) on page
56

Size Captured
from
inbound or
outbound fax

Description

NumPages

Intege 4
r

Both

Includes optional
cover sheet, if any

FineMode

Intege 1
r

Outbound

0 = normal
1 = fine

From_
PhoneNum

String 31

Outbound

Senders phone
number

Received

Intege 1
r

Both

0 = sent
1 = received

BillInfo1

String 15

Outbound

Billing code 1

BillInfo2

String 15

Outbound

Billing code 2

FaxDate

String 8

Both

Date fax record last


modified
(MM/DD/YYYY)

FaxDIDNum

String 31

Both

FaxTime

String 5

Both

Time fax record last


modified (HH:MM)

Senders or
recipients DID fax
number, when
available

OperatorNum

String 31

Outbound

Senders company
phone number

GeneralFaxNu String 31
m

Outbound

Sender's general fax


number

NumPages

Both

Includes optional
cover sheet, if any

OpenText RightFax 10.6

49

Intege 4
r

Administrative Utilities Guide

Chapter 5: FaxDump.exe Data Fields

Size Captured
from
inbound or
outbound fax

Information level 2 data fields

Field name

Type

FineMode

Intege 1
r

Outbound

0 = normal
1 = fine

Received

Intege 1
r

Both

0 = sent
1 = received

TotalTime

Intege 4
r

Both

Total elapsed time, in


seconds, including all
transmission attempt

FaxDate

String 8

Both

Date fax record last


modified
(MM/DD/YYYY)

FaxTime

String 5

Both

Time fax record last


modified (HH:MM)

TrxLength

Intege 4
r

Both

Total elapsed time for


transmission or
receipt in seconds

Channel_Used Intege 4
r

Both

Channel used to send


or receive

TermStatus

Both

See Termination
status fields
(TermStat) on page
56

Intege 4
r

Description

RemoteID

String 21

Both

Name/number of the
remote fax machine

TrxDate

String 8

Both

Date the fax was


submitted for
transmission,
regardless of the
number of

OpenText RightFax 10.6

Field name

Type

Size Captured
from
inbound or
outbound fax

Description

transmission
attempts
(MM/DD/YYYY)
TrxTime

String 5

Both

Time the fax was


submitted for
transmission,
regardless of the
number of
transmission
attempts (HH:MM)

Server_Used

String 47

Both

RightFax server
name

Information level 2 data fields

50

Field name

Type

Size Captured from Description


inbound or
outbound fax

Owner_ID

String 21

Inbound

User ID of person
who sent fax

To_FaxNum

String 31

Outbound

Destination fax
number

To_
ContactNum

String 31

Outbound

Destination phone
number

To_Name

String 59

Outbound

Recipients name

To_Company

String 59

Outbound

Recipients company

To_CityState

String 59

Outbound

Recipients address

Administrative Utilities Guide

Chapter 5: FaxDump.exe Data Fields

Field name

Type

From_Name

String 59

Outbound

Senders name

From_
PhoneNum

String 31

Outbound

Senders phone
number

BillInfo1

String 15

Outbound

Billing code 1

BillInfo2

String 15

Outbound

FaxDIDNum

String 31

Both

OperatorNum

Size Captured from Description


inbound or
outbound fax

Size Captured from Description


inbound or
outbound fax
modified
(MM/DD/YYYY)

String 5

Both

Time fax record last


modified (HH:MM)

Billing code 2

TrxLength

Both

Senders or
recipients DID fax
number, when
available

Intege 4
r

Total elapsed time for


transmission or
receipt in seconds

Channel_Used Intege 4
r

Both

Channel used to
send/receive

TermStatus

Intege 4
r

Both

See Termination
status fields
(TermStat) on page
56

RemoteID

String 21

Both

Name/number of the
remote fax machine

TrxDate

String 8

Both

Date the fax was


submitted for
transmission,
regardless of the
number of
transmission
attempts
(MM/DD/YYYY)

TrxTime

String 5

Both

Time the fax was


submitted for
transmission,
regardless of the
number of
transmission
attempts (HH:MM)

Outbound

Senders company
phone number

GeneralFaxNu String 31
m

Outbound

Senders general fax


number

Unique_ID

Inbound

Unique number
assigned to the fax
by RightFax

NumPages

Intege 4
r

Both

Includes optional
cover sheet, if any

FineMode

Intege 1
r

Outbound

0 = normal
1 = fine

Received

Intege 1
r

Both

0 = sent
1 = received

TotalTime

Intege 4
r

Both

Total elapsed time on


fax card, in seconds,
including all
transmission
attempts

FaxDate

String 8

Both

Date fax record last

OpenText RightFax 10.6

Type

FaxTime

String 31

String 15

Field name

51

Administrative Utilities Guide

Chapter 5: FaxDump.exe Data Fields

Field name

Type

Information level 3 data fields

Size Captured from Description


inbound or
outbound fax

Field name

Type

Size Captured from Description


inbound or
outbound fax

BodyFileName String 13

Both

File name of fax body


image

Send_Time

Intege 4
r

Both

Total elapsed time in


seconds

FCSFileName String 13

Outbound

File name of fax


cover sheet

Fax_Status

Intege 2
r

Both

See Fax status fields


(FaxStat) on page 55

BodyUseCount Intege 4
r

Both

Number of faxes
linked to the body
image file

Fax_TermStat Intege 4
r

Both

GoodPages

Intege 4
r

Both

Number of pages
successfully sent

See Termination
status fields
(TermStat) on page
56

NumPages

Both

String 21

Both

Group ID of the fax


owner

Intege 4
r

Includes optional
cover sheet, if any

Received

Intege 1
r

Both

0 = sent
1 = received

FaxDate

String 8

Both

Date fax record last


modified
(MM/DD/YYYY)

FaxTime

String 5

Both

Time fax record last


modified (HH:MM)

Unique_ID

String 15

Inbound

Unique number
assigned to the fax by
RightFax

Group

Information level 3 data fields


Field name

Type

Size Captured from Description


inbound or
outbound fax

Owner_ID

String 21

Both

User ID of person
who sent fax

To_FaxNum

String 31

Outbound

Destination fax
number

To_Name

String 59

Outbound

Recipients name

To_Company

String 59

Outbound

Recipients company

BillInfo1

String 15

Outbound

Billing code 1

BillInfo2

String 15

Outbound

Billing code 2

RemoteID

String 21

Both

Name/number of
remote fax machine

OpenText RightFax 10.6

Information level 5 data fields

52

Field name

Type Size Captured


from
inbound or
outbound fax

Description

Owner_ID

String 21

User ID of person
who sent fax

Inbound

Administrative Utilities Guide

Chapter 5: FaxDump.exe Data Fields

Information level 6 data fields

Field name

Type Size Captured


from
inbound or
outbound fax

Description

Field name

Type Size Captured


from
inbound or
outbound fax

Description

Owner_Name

String 29

Both

User name of person


who sent fax

Received

Integ 1
er

Both

0 = sent
1 = received

Owner_
DsName

String 79

Both

Distinguished name
of person who sent
fax

FaxDate

String 8

Both

Date fax record last


modified
(MM/DD/YYYY)

To_FaxNum

String 31

Outbound

Destination fax
number

FaxTime

String 5

Both

Time fax record last


modified (HH:MM)

To_Name

String 59

Outbound

Recipients name

Unique_ID

String 15

Inbound

To_Company

String 59

Outbound

Recipients company

BillInfo1

String 15

Outbound

Billing code 1

Unique number
assigned to the fax by
RightFax

BillInfo2

String 15

Outbound

Billing code 2

From_Name

String 99

Outbound

Senders name as it
appears on the cover
sheet

Information level 6 data fields


Field name

Type Size

Captured
Description
from
inbound or
outbound fax

RemoteID

String 21

Both

Name/number of
remote fax machine

Send_Time

Integ 4
er

Both

Total elapsed time in


seconds

Owner_ID

Strin 21
g

Inbound

User ID of person
who sent fax

Fax_Status

Integ 2
er

Both

See Fax status fields


(FaxStat) on page 55

Owner_Name

Strin 29
g

Both

User name of person


who sent fax

Fax_TermStat Integ 4
er

Both

See Termination
status fields
(TermStat) on page
56

Owner_DsName Strin 79
g

Both

Distinguished name
of person who sent
fax

To_FaxNum

Strin 31
g

Outbound

Destination fax
number

To_Name

Strin 59
g

Outbound

Recipients name

NumPages

Integ 4
er

OpenText RightFax 10.6

Both

Includes optional
cover sheet, if any

53

Administrative Utilities Guide

Chapter 5: FaxDump.exe Data Fields

Information level 7 data fields

Field name

Type Size

Captured
Description
from
inbound or
outbound fax

Field name

Type Size

Captured
Description
from
inbound or
outbound fax

To_Company

Strin 59
g

Outbound

Recipients company

Unique_ID

Strin 15
g

Inbound

BillInfo1

Strin 15
g

Outbound

Billing code 1

Unique number
assigned to the fax by
RightFax

Outbound

BillInfo2

Strin 15
g

Outbound

Billing code 2

Sending_Server Strin 47
g

Name of the
RightFax server that
sent the fax

From_Name

Strin 99
g

Outbound

Senders name as it
appears on the cover
sheet

ByteCount

Both

Estimated disk space


used by the fax image

RemoteID

Strin 21
g

Both

Name/number of
remote fax machine

Send_Time

Integ 4
er

Both

Total elapsed time in


seconds

Fax_Status

Integ 2
er

Both

See Fax status fields


(FaxStat) on page 55

Board_Error

Integ 4
er

Both

Error number, if any,


generated by the fax
board

NumPages

Integ 4
er

Both

Received

Integ 4
er

FaxDate

FaxTime

Integ 4
er

Information level 7 data fields


Field name

Type Size Captured


Description
from
inbound or
outbound fax

Owner_ID

Strin 21
g

Inbound

User ID of person
who sent fax

To_FaxNum

Strin 31
g

Outbound

Destination fax
number

Includes optional
cover sheet, if any

To_Name

Strin 59
g

Outbound

Recipients name

Both

0 = sent
1 = received

To_Company

Strin 59
g

Outbound

Recipients company

Strin 8
g

Both

Date fax record last


modified
(MM/DD/YYYY)

BillInfo1

Strin 15
g

Outbound

Billing code 1

Strin 5
g

Both

Time fax record last


modified (HH:MM)

BillInfo2

Strin 15
g

Outbound

Billing code 2

OpenText RightFax 10.6

54

Administrative Utilities Guide

Chapter 5: FaxDump.exe Data Fields

Fax status fields (FaxStat)

Field name

Type Size Captured


Description
from
inbound or
outbound fax

Field name

Type Size Captured


Description
from
inbound or
outbound fax

RemoteID

Strin 21
g

Both

Name/number of
remote fax machine

Viewed

Integ 4
er

Inbound

0 = not viewed
1 = viewed

Send_Time

Integ 4
er

Both

Total elapsed time on


in seconds

Deleted

Integ 4
er

Both

0 = not deleted
1 = deleted

Fax_Status

Integ 2
er

Both

See Fax status fields


(FaxStat) on page 55
on

GroupID

Strin 22
g

Both

Users group ID

RouteCode

Users routing code

Integ 4
er

Both

See Termination
status fields
(TermStat) on page
56

Integ 4
er

Both

Fax_TermStat

Fax_Error_Code Integ 4
er

Both

The RightFax error


code, if any

NumPages

Integ 4
er

Both

Includes optional
cover sheet, if any

Received

Integ 1
er

Both

0 = sent
1 = received

Strin 8
g

Both

FaxTime

Strin 5
g

Both

Time fax record last


modified (HH:MM)

Unique_ID

Strin 15
g

Inbound

Unique number
assigned to the fax
by RightFax

FaxDate

FaxHandle

Integ 4
er

OpenText RightFax 10.6

Both

Fax status fields (FaxStat)


Value Definition

Date fax record last


modified
(MM/DD/YYYY)

Database handle of
the fax

55

Fax needs cover sheet.

Fax needs conversion.

Fax needs to be sent.

Fax is in conversion.

Fax needs to be sent.

Fax is done sending or receiving.

Fax uses a manual fax cover sheet.

Fax is scheduled to be sent.

Fax is done sending or receiving. Errors were encountered. is


not retried.

10

Fax is a duplicate of another fax.

11

Error encountered. Fax will be retried.

12

Sent or received fax needs users attention (data is required

Administrative Utilities Guide

Chapter 5: FaxDump.exe Data Fields

Termination status fields (TermStat)

Value Definition

Value Definition

on cover sheet).

28,34 Dead line

13

Fax needs attachment.

32

14

Fax is held for preview.

15

Fax is in OCR conversion.

16

Fax is printing.

Any
Unknown error
other
value

17

Fax is queued for printing.

18

Fax is queued for OCR conversion.

19

Fax is being validated.

20

Fax is awaiting approval.

Successful

Termination status fields (TermStat)


Value Definition
1,2

Line busy

Re-order busy signal

8,9,25 No answer
16

Human answered

17

A call was answered by RightFax

18

No dial tone

19

Special information tone detected

20

No circuits available

21

Transmit/receive error

22

No loop current detected

23

Call collision

24

Dial no loop error

26

Group 2 fax machine detected

OpenText RightFax 10.6

56

Administrative Utilities Guide

You might also like