OpenText RightFax 10.6 Administrative Utilities Guide

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 2 Administrative Utilities Guide Contents Chapter 1: Administrative Utilities 4 Detailed and Summary Logs 43 The RightFax SQL Database 4 Using the Migration Tool 44 Retrieving data from the Audits table 4 Using the RightFax Administrative Utilities 5 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 3 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 4 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 5 Administrative Utilities Guide .exe on page 12).Chapter 1: Administrative Utilities Utility Description Utility Description FaxStat. Syntax chguser [options] [keywords] The following table shows the ChgUser.exe shows diagnostic information about the RightFax server (see Running Server Diagnostics on page 19). PhnPrint.exe is located in the RightFax\AdminUtils folder on the RightFax server. and billing code information from an ODBC source (see Running ODBCSync.exe If encryption is licensed and enabled.exe on page 17). 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.exe ImpUser.exe on page 12). Remote Queue Creator Sets up MSMQs on a remote server (see RFDiag. -2 number Specify default voice number for users -3 Show a user list with ID.exe on page 17). Folder.exe on page 18). EncryptImages.exe Changes user settings for multiple RightFax users (see Running ModUser. Note Unless you use the -u option to specify individual RightFax user IDs.6 compatibility (see Running the Database Updater tool on page 20).exe Imports users from a comma-delimited ASCII file (see Running ImpUser.exe ChgUser.exe command line options. ChgUser commands are applied to all RightFax user IDs. this encrypts non-encrypted images located in the folder structure introduced in RightFax 10.5) image files into the -6 Show a tab-delimited user list with ID.5 and encrypts them if encryption is licensed and enabled.6 6 Administrative Utilities Guide . OpenText RightFax 10. orphan.exe Prints the published and private phonebook entries of one or more RightFax users (see Running PhnPrint.exe Remotely monitors any RightFax server on the network (see Running FaxStat. printer. and routing code -4 Reset all user names to match user IDs Places existing (pre 10. (see Migrating and Encrypting Existing Image Directories on page 21). ModUser.exe Database Upgrader.exe on page 15 ODBCSync.0 server to RightFax10.exe Searches the RightFax server for fax image files that do not have any references in the RightFax database (see Running Orphan. name.5. folder structure introduced in RightFax 10. Compares database objects on two RightFax servers (see Running ServSync. ChgUser.exe MigrateImage Running ChgUser.exe Imports user. name.exe is a command line utility that changes RightFax permissions and options for multiple users at one time. (see Migrating and Encrypting Existing Image Directories on page 21). 6 Function Add “+” to the end of the routing type to delete the original file after routing (e.Chapter 1: Administrative Utilities Option Function Option routing code. and 0x40. 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. add the values of all desired notification options. n0x80...e. use the value 0x51. will be retried” messages 0x20 = Send “Successful send” messages 0x40 = Send “Error.. -opassword Password for the user ID used to log in to the RightFax server.” message one time only 0x08 = Send “Sending. 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.. To use NT authentication.receive Sets sent and received fax notifications. 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. Separate send and receive values with a comma (i.” message periodically OpenText RightFax 10. For example.g. “-rSMTP+”) 7 Administrative Utilities Guide . 0x10. Place users. to enable send options 0x01. and group ID -7 option 0x10 = Send “Error...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.. no user ID information will exist and this feature will not work The following table shows the ChgUser. Use -c option to set cover sheet ID Administrative Utilities Guide .exe keywords. 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 8 coverfine/ covernormal Sets resolution of fax cover sheet to fine or normal coverpage/ nocoverpage Enables/disables sending a cover page with every fax.6 Enables the autoforward feature to a RightFax user. 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. 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. Use Noautoforward to disable the autoforward feature Note If this feature has never been enabled in the user configuration in Enterprise Fax Manager.Chapter 1: Administrative Utilities Option Function -sformat Fax file routing format using the following: Keyword machine. Keyword Function autoprint/ noautoprint Enables/disables automatic printing of received faxes. 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 user’s 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. DSender.fred noadmin chguser -frfserver2 -v -alaser4 autoprint OpenText RightFax 10. you will need to re-run the DSender.6 9 Option Function -idigsender Specifies the IP address of the Digital Sender.024 user IDs). The method you choose depends on which system already contains the most comprehensive user ID list. -p password The password for the account name used to log on to the Digital Sender.exe is located in the RightFax\AdminUtils folder on the RightFax server. 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 user’s option to use the Trash folder when deleting faxes in FaxUtil Running DSender. If new users are added.exe is not dynamic.exe command line options. -ffaxserver The name of the RightFax server to synchronize. Important User synchronization with DSender. -tprotocol Force network protocol to specific type (rather Administrative Utilities Guide .exe utility to synchronize the user lists. Example chguser -frfserver -v chguser -frfserver -ubob.exe is a command line utility that synchronizes user IDs between RightFax and an HP Digital Senders on your network.exe DSender. 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. -a account The account name used to log on to the Digital Sender. The following table shows the DSender. -u userID Specifies the user ID to use as the model when creating new users (set to “DEFAULT”). Default account name is “ADMINISTRATOR”. 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.54. This example logs on to the Digital Sender at IP address 38.6 Option Function -a userID The RightFax user ID to use when logging in to the RightFax server.exi is a command line utility that purges fax records from users mailboxes. Individual users can be excluded from automatic fax aging by checking the OpenText RightFax 10.Chapter 1: Administrative Utilities Option Purging Faxes from User Fax Mailboxes Excluded from Group Fax Aging permission in their RightFax user profiles.exe Copies user IDs from the HP Digital Sender to RightFax. -z Deletes existing unmatched users from the destination system. Important Execute this utility as the fax server is running. that purges fax records from users mailboxes.exe. This can prevent older fax images from occupying too much hard drive space on your server.54.2. 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.156 using the user name “administrator” and the password “joshua.156 -pmypassword -frfserver -tt -z The following table shows the FaxAge. FaxAge. FaxAge. Function than assigning automatically) using the following: RightFax also includes a command line utility.2. 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 . FaxAge. This feature is configured separately for each group . -s Prevents synching of the ADMINISTRATOR account. Automatic fax aging is only available if you have a RightFax Enterprise or Satellite server.exe command line options.” 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. n = Named pipes (default) t = TCP/IP -1 Running FaxAge.exe is located in the RightFax\AdminUtils folder on the RightFax server. The default setting is to copy user IDs from RightFax to the HP Digital Sender. i. -tprotocol Syntax Note Use the 4-digit year format.exe is a command line utility that outputs ASCII text files of fax data that you can import into other databases to produce reports. To use NT authentication. -z Without this parameter. -llevel Information level 0 or 1 (default is 0). OpenText RightFax 10. If the file already exists. -a userID The RightFax user ID to use when logging in to the RightFax server.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. -o file Output file listing all deleted faxes.6 11 Option Function -1 Fields that contain a delimiter (see the -d option) will not include quotation marks. Running FaxDump. FaxDump. i. This options overrides all other options and causes the program to do nothing else.e.out -d2 s01/01/2004 -z Note Use the 4-digit year format. Quotes surround string data.exe is located in the RightFax\AdminUtils folder on the RightFax server. -fserver Specifies the name of RightFax server. leave this option blank. -smm/dd/yyyy Specifies the starting date of the date range to delete. and all fields are separated by commas (this can be customized using the d option).exe FaxDump. no deletions will occur. -e mm/dd/yyyy Specifies the ending date of the date range to delete. -s-30 (default is 01/01/1980).e.exe Data Fields on page 48. the new file list is appended to the end. Administrative Utilities Guide . see FaxDump. For definitions of the fields included in each fax record for each of these information levels. A password can be required using the -p option.exe command line options. n = Named Pipes (default) t = RCP/TCP_IP -u userIDs Comma delimited list of users (default is all users). -p password The RightFax password for the user ID specified with the -a option. FaxDump can report eight levels of information. The text file prints one complete fax record per line. -q Prints a table containing field definitions for information levels. -wfolder Name of folder in for restricted deletions (default is all folders). This can also be specified as a day offset. -e-30 (default is 12/31/2010). This can also be specified as a day offset. Example faxage -frfserver -aadministrator -odump. 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. The following table lists each of these fields in the required -smm/dd/yyyy The starting date of the date range to report on. Each user record appears on a separate line and contains 22 fields. Running ImpUser. -tprotocol -e mm/dd/yyyy The ending date of the date range to report on.out -l2 -s01/01/2002 -e01/31/2004 Running FaxStat. i. -o file Name of the ASCII file to output. -S-30 (default is 01/01/1980).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 . this is set to comma (ASCII 44). If you select this option. Purging Faxes from User Fax Mailboxes Option can also be specified as a day offset. This OpenText RightFax 10. -p password The RightFax password for the user ID specified with the -a option.exe Data Fields on page 48. -ioption Ignores faxes of the specified type using one of the following options: Limits the output to P2P faxes.e.Chapter 1: Administrative Utilities Option Function -d ASCII The ASCII value (in decimal) of the character to use as a delimiter for FaxDump output. e-mail gateways.exe Data Fields on page 48 for details on the available information levels.exe is located in the RightFax\AdminUtils folder on the RightFax server. leave this option blank.exe is located in the RightFax\AdminUtils folder on the RightFax server. -g groupID The RightFax group ID for a group of users for reporting. FaxStat. -llevel Information level 0–7 (default is 0). This can be specified as a day offset. -fserver The name of RightFax server that contains the fax information to output. any other specified options is ignored.exe ImpUser. -q Prints a table containing the definitions of the fields in each information level. See FaxDump. ImpUser.exe is a command line utility that imports users into RightFax from a comma-delimited ASCII file.exe is a Windows-based utility that monitors the fax database. and RPC server status on any RightFax server. -u userIDs Comma delimited list of users to include (default is all users). WorkServer. To use NT authentication. -e-30 (default is 12/31/2010). DocTransport.e. FaxDump. server status. -h Prints field headers in the first line of the output file. To import user IDs from a file. create a comma-delimited ASCII file containing all of the user records to import. By default. Example faxdump -frfserver -aadministrator -odump. i.exe FaxStat. doc. be one of the following: PCX. or EXCH. Routing code 7 Cover sheet 12 Permissions flags 31 Notification type 2 Routing info 99 OpenText RightFax 10. or TIFF-G4 Unique routing code for the user Subscriber ID 7 File name (no path) of default cover sheet file in RightFax\FCS folder.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 group’s type 1–9 = 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 . RFIC.Chapter 1: Administrative Utilities Purging Faxes from User Fax Mailboxes order (use quotation marks around any field that contains an embedded comma). TIFF-G3. The file name ends with . DCX.pcl or . CC. OCR. CX3. NOTES. +Type:Info is identical but enables the Delete After Routing option Routing format 7 File format to use when routing. Leave blank to use group’s default cover sheet Voice mail subscriber ID. FILE. MS. 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 user’s existing group ID.6 Field Maximum length Description Type Use a required format: RF. and where Info is the address for the specified type. TRS. 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. The following table lists user permission flags that can be used in the import file. Use it to add or remove permission. Flag Function a± All DocTransport services down b± DocTransport service down c± Critically low disk space e± Server Event Queue full h±interval Periodic server heartbeat. A plus (+) or minus (–) sign follow each character. A plus (+) or minus (–) sign follows each character. 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. Use it to to add or remove the alert. Notify Addr/Info 100 The email address of the user for email notification. 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.6 14 Administrative Utilities Guide . The following table lists pager flags that can be used in the import file.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. Flag Function d± Disallow fax deleting f± Can add/update forms h± Can use high priority i± Cannot search billing codes l± Can add/update library documents m± have password o± Can OCR faxes r± Can run reports s± Sent fax archiving u± Unprotected mailbox v± View first page only p± Administrator can bypass privacy restrictions. Specify heartbeat interval in minutes Flag Function a± Administrative access i± Server improperly started b± Bypass billing code verification l± Low disk space c± Can change cover sheet n± New fax received OpenText RightFax 10. or other information necessary for sending fax notifications. exe is located in the RightFax\AdminUtils folder on the RightFax server. To use NT authentication. If not specified. uses the Default RightFax user ID. Use a computer running Windows NT 4. Specify fax and page maximum depths Purging Faxes from User Fax Mailboxes Option Function this option blank. users from the specified ASCII file are imported as fax users. Syntax Example impuser -ffaxserver-uuserID-ppassword-isourcefilensource [-dtemplateID] [-ggroupname] [-ooutputfile] [-r][tprotocol] [-1] Option impuser -frfserver -ujanedoe -ppassword -iuserfile. This file can be edited and re-imported. -n source Specifies the name of the Windows NT server to import the Windows NT domain accounts from. run the ImpUser. -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. RightFax administrative privileges are needed to run ModUser. -ffaxserver Specifies the name of a fax server to import to.txt nsourceserver -tt When you execute this command. ModUser.To use ModUser’s Windows NT user import function.exe -g groupname Specifies the name of a Windows NT group for importing.6 ModUser. Running ModUser.exe. leave OpenText RightFax 10.exe can be run from any workstation on your network. -1 Imports from an Omtool Userdb. A password can be required using the -p option. If an imported user ID already exists.Chapter 1: Administrative Utilities Flag Function o± Outbound fax is abandoned p± Probable line failure q±faxes-pages Send queue too deep. 15 Administrative Utilities Guide . it is added. If not specified.exe is a Windows-based utility available only with RightFax Enterprise servers that changes RightFax permissions and options for multiple users at one time.exe command line utility. ModUser. -u userID The RightFax user ID to use when logging in to the RightFax server. imports all users in the domain. -isourcefile Specifies the name of the file to import. Important The fax server be running when executing this utility.dat file. If a user ID does not already exist. -o outputfile Outputs the user list to a file rather than importing to RightFax. that user’s record is updated based on the data from the file. -p password The RightFax password for the user ID specified with the -u option. Function -d templateID Specifies the RightFax user ID to use as a template for imported users’ settings.0. and if there is no check mark. When you have made the changes you want. click OK to return to the Modify User dialog box. Choose the network protocol for the server and click Next. click Edit in the menu bar. and click Next. The Modify User window opens. Asterisks (*) appear next the users names to show that they have unsaved changes. a check mark means that the option is enabled for all selected users. Finally. you are prompted to save all your changes when you close the Modify User dialog box. When you have selected the users to edit.Chapter 1: Administrative Utilities Purging Faxes from User Fax Mailboxes After it is installed. The User Information for Multiple Selections dialog box opens. run ModUser.exe. To make global changes that will affect a group of selected users. enter your RightFax administrator user ID and password. To immediately apply OpenText RightFax 10. For each option. When prompted for a server name. enter the name of the RightFax server you want to modify. a gray check mark indicates that the option is enabled for some users. select the users you want by clicking the user IDs and holding down either the Shift or Ctrl key.6 16 Administrative Utilities Guide . and click Finish. This window lists each RightFax user on the server you selected. the option is disabled for all users. -z Actually erase files.6 17 Administrative Utilities Guide .exe ODBCSync.ini. printers. Orphan. you are prompted for a password.g. record of their existence and cannot access them. The fax server is not running when executing this utility. a sample configuration file called ODBCDemo.exe uses a configuration file that you create to map ODBC fields to RightFax. or their records can be restored in the RightFax database. -ffaxserver Specifies the name of a fax server to update. n = Named Pipes s = SPX t = TCP/IP Example Example odbsync -frfserver -tt -o ODBCImport. iC:\RIGHTFAX\IMAGE). -a Recovers files to the -u option. Option Function -f The fax server to connect to. -ipath Specifies the path to the IMAGE files. -u (only used with the -a option) The UserID to recover the files into. Using Orphan.Chapter 1: Administrative Utilities Purging Faxes from User Fax Mailboxes changes without quitting. (e.exe searches the RightFax server for fax image files that do not have any references in the RightFax database. Syntax orphan -fcomputer-ipath-uuserID [-a] [-n] [-z] Syntax odbcsync-ffaxserver [-o] [-t{n|s|t}] Option Function -n Do not prompt. orphan image files can be deleted from the server.exe is located in the RightFax\Database folder on the RightFax server. Running ODBCSync.exe. select Save Changes from the File menu.exe is a command line utility that imports RightFax users. and a text file that documents the configuration file called ODBCSync. ODBCSync. -o Overwrite any records that already exist on the server.ini orphan -fjanescomputer -ic:\program files\rightfax\image ujanedoe -a Running Orphan. and billing codes from an ODBC source. ODBCSync.exe. The image files are called “orphans” because RightFax has no OpenText RightFax 10. -l -tprotocol Forces protocol to specific type (rather than assigning automatically) using the following: Login UserID for logging in to the fax server.txt are all included in the RightFax\AdminUtils folder on the RightFax server. -d Debug output (show all files being processed).exe Orphan. select output level 1 or 3. 2 = Comma-delimited format 3 = Tab-delimited format The Remote Queue Creator files are stored in their own folder in the RightFax\AdminUtils folder. -g option Print phonebook groups from the specified users’ phonebooks.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. Install the AdminUtils on the remote server before you can run the Remote Queue Creator. To import the file back into RightFax. attempting to re-import the phonebook into RightFax will fail. 1.password -g0 -l1 Note Because the last two lines in all of the output formats list the total number of entries. 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. The level 0 output format is for reference and cannot be used for importing phonebook entries from a file.Chapter 1: Administrative Utilities Purging Faxes from User Fax Mailboxes Running PhnPrint. Specify option 0 or 1 where: phnprint -frfserver -ujaned.exe is included in the RightFax\AdminUtils folder on the RightFax server. This option overrides all other options OpenText RightFax 10. 0 = Include phonebook groups 1 = Do not include phonebook groups (default) Output format 0. When creating a file that will be imported back into RightFax. or 3 where: Running the Remote Queue Creator 0 = Multi-line format. Install the AdminUtils on the remote server before you can run the Remote Queue Creator. printed for reference (default) 1 = Space-delimited format Use the Remote Queue Creator to prepare a remote server to handle the MSMQ queuing functions.exe PhnPrint. 2. manually edit the file and delete the entrycount lines. 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.6 18 Administrative Utilities Guide . PhnPrint.out psecret.johns -odump. change the MSMQ server string in both the RightFax Server and the DocTransport modules. dir Show a summary of the contents of the RightFax OpenText RightFax 10. dir4 List files in the RightFax\Outgoing folder. brd Show DocTransport configuration.Chapter 1: Administrative Utilities Running Server Diagnostics To start the queue creation process.exe is a command line utility that compares one or more categories of information between two RightFax servers. srv Show fax server configuration. see the “Configuring RightFax Server” and “Configuring the DocTransport Modules” sections in the RightFax Administrator’s Guide. dir0 List files in the RightFax folder. Option After the remote queue server is set up. RFDiag.exe is included in the RightFax\AdminUtils folder on the RightFax server. 19 Administrative Utilities Guide . Running RFDiag. net Show network configuration. dir5 List files in the RightFax\BFT folder. app Show information about your Microsoft Office.exe. RFDiag. The utililty creates all the queues necessary. dir2 List files in the RightFax\Image folder. ServSync. dir9 List files in the RightFax\DocTransport folder. double-click RemoteQueueCreator. Point all RightFax components to the same MSMQ server. Running Server Diagnostics dir6 List files in the RightFax\FCS folder. and Lotus Notes applications.6 Example rfdiag -all -dir3 Running ServSync. hw Show fax hardware configuration. For more detail. dev Show installed devices. dir7 List files in the RightFax\Sig folder. Note The fax server must be running when executing this utility. svc Show installed services. sys Show information about the fax server system configuration. Syntax rfdiagoptions Option Function all Show all available configuration information. if any. dir3 List files in the RightFax\Database folder.exe is included in the RightFax\AdminUtils folder on the RightFax server. Function subfolders. Microsoft Exchange.exe is a command line diagnostic utility that shows information about the RightFax server that runs RFDiag.exe dir8 List files in the RightFax\Papers folder.exe ServSync.exe from the remote server. dir1 List files in the RightFax\Bin folder. Select the SQL authentication mode. l This tool is running from the RightFax 10.0 database to RightFax 10.” servsync -Cb ns2008r2 -U1administrator -P1password FS-r2prereq:t -U2administrator -P2password 5. From the start menu.6 compatibility. you can deploy and test new product versions while maintaining an existing product system. -spassword Password for the user ID used to log in to the RightFax server. This option gives you the most comprehensive comparison.exe. open the OpenText program group and click RightFax Database Upgrader.Chapter 1: Administrative Utilities Running the Database Updater tool Important The fax server is running when executing this utility. If you choose SQL Account. Example 4.6 server.6 database The network protocol to use to communicate to each of the RightFax servers using the following: 1. click the target Database you wish to upgrade.6 server ONLY. l Verify that you have the correct privileges to perform the upgrade. l Stop all RightFax services using the target RightFax 10. leave this option blank. provide the account and password information. Click Perform Upgrade When the upgrade is OpenText RightFax 10.0 database. The Database Updater tool runs the SQL scripts required to upgrade an existing RightFax 10.6 server. l Verify that the database allows remote connections. n = Named Pipes (default) s = SPX t = TCP/IP 2. 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.6 20 Administrative Utilities Guide . To upgrade to the 10. The default name of the RightFax database is “RightFax. Running the Database Updater tool Using the Database Updater tool. For the Upgrade Database Information. 3. Click Lookup to choose the database used for the upgrade. Verbose output. 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 l Stop all RightFax services on the RightFax 10. This tool is intended to be run on a RightFax 10. To use NT authentication. When run without this option the utility will stop running if an error is encountered. -d   Migrating and Encrypting Existing Image Directories Debug mode Example C:\Program Files (x86) \RightFax\AdminUtils\MigrateImageFolder. 11. 9. Change the SQL connection to point to the newly upgraded database.txt.exe -l "C:\Program Files (x86)\RightFax\Image" -i -w -o "C:\Output. A message box will let you know if the upgrade was successful. 12. Change the image directory to point to the image directory used by the old 10. the log information shows on the screen. RightFax Image folder. -i The utility continues if errors are encountered. Option Function -I 7. -o Output File directory\Name.5. move them from the FCS/Imported folder to the FCS folder itself. (required). 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). select the "RightFax Database" service and hit Configure.0 server to the RightFax 10.6 21 Administrative Utilities Guide . -w Overwrites destination files if they already exist.Chapter 1: Administrative Utilities Migrating and Encrypting Existing Image Directories complete. RightFax server name. When run without this option the output is written to the screen 10. 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. -r 8. 6. The tool is located in the RightFax\AdminUtils folder on the RightFax server. The RightFax server name as displayed in EFM.6 coversheet directory (FCS).exe MigrateImageFolder. If any errors are encounted they will also be shown. To use the RightFax 10. The location where the RightFax image files are located.0 server. To use existing coversheets. Creates an output file of the process. RightFax 10. (required). If encryption is licensed and enabled. the images will be encrypted at the same time. In EFM.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. manually copy any coversheet files from your old RightFax 10.txt" Running MigrateImageFolder.6 default coversheets. Restart all services in EFM. When run without this option the utility will stop running if an error is encountered.txt" OpenText RightFax 10. -o Output File directory\Name.exe is a command-line tool that encrypts existing unencrypted image files if encryption is licensed and enabled. Option Function -r RightFax server name.exe -l "C:\Program Files (x86)\RightFax\Image" -i -o "C:\Output. Any image files found at the root are placed into a hierarchical folder structure. (required). The RightFax server name as displayed in EFM.exe EncryptImages. The tool is located in the RightFax\AdminUtils folder on the RightFax folder. -d Debug mode Example C:\Program Files (x86) \RightFax\AdminUtils\EncryptImages.6 22 Administrative Utilities Guide .Chapter 1: Administrative Utilities Migrating and Encrypting Existing Image Directories Running EncryptImages.txt. When run without this option the output is written to the screen -i The utility continues if errors are encountered. Creates an output file of the process. OpenText RightFax 10.6 23 Administrative Utilities Guide . 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. the user needs Can Run Reports permission in his or her RightFax user profile to access report data from the specified server.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 Fax Reporter program opens. Note Although any user can run RightFax Enterprise Fax Reporter. Running RightFax Enterprise Fax Reporter To run RightFax Enterprise Fax Reporter. select Start > Programs (or All Programs) > OpenText > RightFax Enterprise Fax Reporter. l l l Your SQL Server User ID and Password. Use any of the following ways to open a report: l l l Highlight a report. the User ID. Password. 2. Your Authentication type (SQL Server or Windows Authentication). and click Open. and Remember Password boxes will be disabled because Windows provides this information. OpenText RightFax 10. other parameter values will also need to be defined.Chapter 2: Enterprise Fax Reporter Note If you choose Windows Authentication. see the individual report descriptions later in this section. The name of your RightFax Database. Click File > Open Report.6 24 Administrative Utilities Guide . enter the following information to log in: l l The name of your SQL Server. Right-click a report. Check the box to Remember Password. Certain reports also require “execute” permission. The Select Report dialog box opens. Double-click a report. followed by \Rightfax. For some reports. Opening Reports To open a report 1. Enter the required parameter values. 3. In the RightFax SQL Server dialog box. such as Date Range. if applicable. The ID used to create the reports require “datareader” SQL server permission. Use Windows Authentication if your company uses Windows Authentication to synchronize your RightFax and SQL Server passwords with Windows. and choose Select. rpt on page 34 FaxLists_Summary_CompletedFaxes.rpt on page 26 OpenText RightFax 10. Billing_Detailed_BillingCode1_BillingCode2. Depending on the type of report you select.rpt on page 32 Fax_Printing_Group. The ? character represents any single character.rpt on page 32 4.rpt on page 33 Available Fax Reports FaxLists_Detailed_CompletedFaxes. Click Export Report. Saved reports are stored in C:\Program Files\RightFax\Admin_Utils\Reports. The * character represents unlimited characters. click the Print icon. Enter parameters for your report. a location.rpt on page 28 Billing_Detailed_BillingCode1.rpt on page 27 1. Fax_Printing_User. 2.rpt on page 31 To export fax report information to a specific file format Destination_RemoteID.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 31 Destination_FaxNumber. The dialog box looks different depending on the parameters for the specific report. Billing_Detailed_BillingCode2. 2.rpt on page 29 Billing_Summary_BillingCode1.rpt on page 29 Note You can use the standard wildcards * and ? to define a user set.rpt on page 26 FaxLists_Summary_HumanRoutedReceived. you can generate any of the following reports.rpt on page 32 Destination_ToName.rpt on page 28 Automation_Outbound_User.rpt on page 31 1.rpt on page 30 Billing_Summary_BillingCode2. FaxLists_Summary_AllFaxes.rpt on page 29 3. To print the report. Automation_Outbound_Failed_User. Choose the report to export. Click Save. and a format from Save as type. 3. The * character entered in this box by default will run the report on all users. Destination_ToCompany.rpt on page 30 Billing_Summary_BillingCode1_BillingCode2.rpt on page 33 FaxLists_Detailed_AllFaxes.rpt on page 30 Channel_Usage.rpt on page 27 Automation_Outbound_UniqueID.rpt on page 34 AdvancedAuditReport. Open a report in Enterprise Fax Reporter.6 25 Administrative Utilities Guide . an Enter Parameter Values dialog box opens.rpt on page 33 With Enterprise Fax Reporter.rpt on page 30 Exporting Report Information to Another File Format Channel_Usage_Summary.rpt on page 35 Automation_Inbound_Day. Wildcard) RIC_PSTN_Outbound_Usage.rpt on page 35 l l l Outbound_Activity_Users.rpt on page 37 Automation_Inbound_Day.rpt on page 38 l Date and time the fax was received.rpt on page 39 l DID number that the fax was sent to. Report Title: Audit Activity This report shows an audit trail of additions.rpt on page 37 Report Title: Received Fax Report Inbound Faxes by Day Time_of_Day_Outbound_Usage.rpt on page 35 Date/Time of the action Name of the user performing the action Action taken (Added. Wildcard).rpt on page 39 l Status of the fax transmission. deletions. Audited Action Type (String. Usage_Top_10_Inbound_TransmissionTime. and modifications to Group and User accounts.rpt on page 36 DateRange. Usage_Top_10_Outbound_TransmissionTime.rpt on page 37 For each day.rpt on page 38 l RightFax user ID. the report shows: OpenText RightFax 10. Wildcard).6 The only parameter required for this report is the DateRange. the report shows the overall total pages received during the reporting period.rpt on page 39 AdvancedAuditReport.rpt on page 39 l Name or telephone number of the sending fax machine (remote ID). Usage_Inbound_TransmissionTime.rpt on page 40 l Number of pages in the fax. Wildcard). Usage_Top_10_Outbound_Users. Usage_Top_10_Inbound_Users. For each change. Search User (String. the report shows: Time_of_Day_Usage. 26 Administrative Utilities Guide . For all users. or Modified) Type of object modified (User or Group) Name of object modified (User or Group name) Outbound_Completed_Activity_Users. Usage_Outbound_TransmissionTime. the report shows the total pages received. Usage_Inbound_Users.rpt on page 36 RIC_Usage_Inbound_Users. Audited Value (String. Usage_Outbound_Users. Deleted.Chapter 2: Enterprise Fax Reporter Available Fax Reports FaxLists_Summary_HumanRoutedReceived_SubReport_ ReceivedCount.rpt on page 35 l l FaxLists_Summary_HumanRoutedReceived_SubReport_ ReceivedEdcCount. Audited Action (String.rpt Time_of_Day_Inbound_Usage.rpt on page 36 Valid parameters are: RIC_PSTN_Outbound_by_Country.rpt on page 39 l Status of the fax (viewed or printed).rpt on page 40 l Length of time of the transmission.rpt on page 36 RIC_Usage_Outbound_Users.rpt For the day. the report shows the number of pages sent.Chapter 2: Enterprise Fax Reporter Available Fax Reports Automation_Inbound_RemoteID. Date and time the fax was received. For each sending fax machine. Number of pages in the fax. RightFax user ID of the user who received the fax. as assigned by the fax server. Name of the recipient company. the report shows the total pages received.rpt Report Title: Failed Fax Report Unsuccessful Outbound Faxes by User 27 Administrative Utilities Guide . For all received faxes.6 The only parameter required for this report is the DateRange. Overall total number of fax pages received by the user. Name or telephone number of the sending fax machine (remote ID). Fax number of the recipient. Status of the fax transmission. the report shows the overall total pages received. the report shows: l l l l l l l l l Number of pages in the fax. the report shows: l l l l l l For each user. OpenText RightFax 10. Length of time of the transmission. Unique ID of the received fax. Automation_Inbound_User. Automation_Outbound_Day. Date and time the fax was received. DID number that the fax was sent to. Status of the fax (viewed or printed).rpt Report Title: Sent Fax Report Outbound Faxes by Day For each day. For each RightFax user ID. Name of the recipient. Length of time of the transmission. DID number that the fax was sent to. as assigned by the fax server. Length of time of the transmission. l l l l The only parameter required for this report is the DateRange. Status of the fax transmission. Date and time the fax was sent.rpt l l Report Title: Received Fax Report Inbound Faxes by User l Unique ID of the sent fax. Name or telephone number of the recipient fax machine (remote ID). The only parameter required for this report is the DateRange. the report shows: l l l l For each sending fax machine. Status of the fax (viewed or printed). Automation_Outbound_Failed_User.rpt l l Report Title: Received Fax Report Inbound Faxes by RemoteID l For all users. Name or telephone number of the sending fax machine (remote ID). the report shows the overall total pages received. Date and time the fax was transmitted. Number of pages in the fax. Status of the fax transmission. RightFax user ID of the person who sent the fax. The report also shows the overall total number of pages sent during the reporting period. Overall total number of fax pages received by the user. The final date and time that the server attempted to send the fax. Status of the fax transmission. RightFax user ID of the person who sent the fax. RightFax user ID of the person who sent the fax.6 Name or telephone number of the recipient fax machine (remote ID). as assigned by the fax server. Fax number of the recipient. Date and time the fax was sent. The only parameter required for this report is the DateRange. The initial date and time that the server attempted to send the fax. Name of the recipient. Name or phone number of the recipient fax machine (remote ID). Number of pages in the fax. Length of time of the attempted transmission. Name of the recipient. the report shows: l l 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. OpenText RightFax 10. l l l The report shows the overall total pages sent during the reporting period. the report shows the number of pages sent. Length of time of the transmission. Number of pages in the fax. Name or telephone number of the recipient fax machine (remote ID).Chapter 2: Enterprise Fax Reporter Available Fax Reports For each sent fax that failed in transmission. Name of the recipient. The only parameter required for this report is the DateRange. l l Automation_Outbound_UniqueID. the report shows: l l l For each user. as assigned by the fax server. Name of the recipient company.rpt Report Title: Fax Report Outbound Faxes by User For each RightFax user. Automation_Outbound_User. Fax number of the recipient. 28 Administrative Utilities Guide . l l l The only parameter required for this report is the DateRange. Length of time of the transmission. Name of the recipient company. Fax number of the recipient. as assigned by the fax server. The report also shows the overall total number of pages sent during the reporting period. Name of the recipient company. Status of the fax transmission. the report shows the number of pages sent. Date and time the fax was sent.rpt l Report Title: Fax Report Outbound Faxes by Unique ID l For each sent fax. Status of the fax transmission. the report shows: l l l l l l l l Unique ID of the sent fax. For each user. The report also shows the overall total number of pages sent during the reporting period. Date and time the fax was transmitted. Date and time the fax was received by the recipient. Unique ID of the sent fax. the report shows the overall total pages sent. The detailed report lists faxes sorted billing code 1 and billing code 2. the report shows: l l l l l l The only parameter required for this report is the DateRange. RightFax user ID of the person who sent the fax. These are referred to as “Billing Code 1” and “Billing Code 2. the report shows: The only parameter required for this report is the DateRange. RightFax user ID of the person who sent the fax. Caller Subscriber Identification (CSID) from the recipient fax machine. For all faxes. Caller Subscriber Identification (CSID) from the recipient fax machine. Fax number of the recipient.rpt l l Report Title: Detailed Billing Report . For each fax. l Date the fax was sent. Caller Subscriber Identification (CSID) from the recipient fax machine. the report shows: OpenText RightFax 10. These are referred to as “Billing Code 1” and “Billing Code 2.Chapter 2: Enterprise Fax Reporter Available Fax Reports Billing_Detailed_BillingCode1. These are referred to as “Billing Code 1” and “Billing Code 2.” or you can assign unique names to the fields. The only parameter required for this report is the DateRange.rpt l Report Title: Detailed Billing Report . For each fax. Number of pages in the fax.6 Date the fax was sent. Billing_Detailed_BillingCode2. The detailed report lists faxes sorted by billing code 2.” or you can assign unique names to the fields. the report shows the overall total pages sent. Name of the recipient.BillingCode2 Outbound Faxes Only RightFax supports the use of two billing codes for each faxed document. Name of the recipient. l For all faxes. Fax number of the recipient. 29 Administrative Utilities Guide .BillingCode1 Outbound Faxes Only l l l RightFax supports the use of two billing codes for each faxed document. RightFax user ID of the person who sent the fax. Fax number of the recipient.rpt Date the fax was sent.” or you can assign unique names to the fields. The detailed report lists faxes sorted by billing code 1. Number of pages in the fax. the report shows the overall total pages sent.BillingCode 1 and Billing Code 2 Outbound Faxes Only l l l l RightFax supports the use of two billing codes for each faxed document. For all faxes. Name of the recipient. Report Title: Detailed Billing Report . Billing_Detailed_BillingCode1_ BillingCode2. Number of pages in the fax. For each fax. These are referred to as “Billing Code 1” and “Billing Code 2. Send minutes. the report shows: Valid parameters are DateRange. Receive minutes. ServerName (String) Channel_Usage. These are referred to as “Billing Code 1” and “Billing Code 2. ServerName (String) OpenText RightFax 10. l l l l For each value of Billing Code 1 and Billing Code 2.BillingCode 1 and Billing Code 2 Outbound Faxes Only For each fax channel. These are referred to as “Billing Code 1” and “Billing Code 2. the report shows: For each value of Billing Code 1. the report shows: l l Number of pages Elapsed time Total minutes.Chapter 2: Enterprise Fax Reporter Available Fax Reports Billing_Summary_BillingCode1. For each value of Billing Code 2. RightFax supports the use of two billing codes for each faxed document. the report shows: l l l Number of pages Elapsed time l The report also shows a total overall number of pages and elapsed time. ServerName (String) Valid parameters are DateRange.” or you can assign unique names to the fields. Total receive minutes. Utilization percentage.BillingCode1 Outbound Faxes Only Report Title: Summary Billing Report .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. the report shows: RightFax supports the use of two billing codes for each faxed document.rpt Billing_Summary_BillingCode1_ BillingCode2. the report shows: Number of pages Elapsed time l l l The report also shows a total overall number of pages and elapsed time.BillingCode 2 RightFax supports the use of two billing codes for each faxed document. The report also shows a total overall number of pages and elapsed time. Total minutes. For all DocTransports for each day.” or you can assign unique names to the fields. Total send minutes.rpt Billing_Summary_BillingCode2.rpt Report Title: Summary Billing Report .” or you can assign unique names to the fields. For each DocTransport. Valid parameters are DateRange. Report Title: Summary Billing Report .6 30 Administrative Utilities Guide . Valid parameters are DateRange. Send minutes.rpt Total minutes. Name of the recipient company. For each fax number. Unique ID of the fax. The user group of the user. Name of the recipient.6 31 RightFax user ID of the person who sent the fax. Receive minutes. l l l OpenText RightFax 10. Overall total receive minutes. Destination (String. as assigned by the fax server. Administrative Utilities Guide . the report shows: l l l l For all faxes. the report shows: Overall total minutes. Overall total send minutes. Overall total send minutes. the report shows: For all board servers. Total send minutes. The user group of the user. Fax number of the recipient. the report shows: l l l This report lists faxes sent to a specific fax number. Overall total receive minutes. Name or telephone number of the recipient fax machine (remote ID). Status of the fax. Number of pages in the fax. Utilization percentage. l l Channel_Usage_Summary. the report shows the overall total pages sent. For each fax channel.Chapter 2: Enterprise Fax Reporter l l l Available Fax Reports Overall total minutes. Date the fax was sent. Overall total receive minutes. the report shows: l l l l Overall total minutes. Name of the recipient. Total receive minutes.rpt Report Title: Destination Record Outbund Faxes by Fax Number (search parameter) For all DocTransports and all days in the reporting period. For each fax machine. You are prompted to enter a fax number. l l RightFax user ID of the person who sent the fax.rpt l Report Title: Channel Usage Summary Report l The summary report lists the usage of the fax channels on each board server. Destination_FaxNumber. the report shows: l l l Destination_RemoteID. Overall total send minutes. l l l l The only parameter required for this report is the DateRange. Report Title: Destination Report Outbund Faxes by Remote ID (search parameter) This report lists faxes sent to a specific recipient fax machine. Total minutes. Wildcard) For each board server. Date the fax was sent. l You are prompted to enter a remote ID. The user group of the user. Status of the fax. l l Valid parameters are DateRange. For each fax.rpt Report Title: Fax Printing Report Faxes Printed by Group(s) Lists the faxes that have been printed in order by group. OpenText RightFax 10. The user group of he user. Name of the recipient. Status of the fax. For each recipient. Wildcard) Fax_Printing_Group. Valid parameters are DateRange. you are prompted to enter the name of a recipient. Name or telephone number of the recipient fax machine (remote ID). Name or telephone number of the recipient fax machine (remote ID). the report shows: l For all faxes.rpt Report Title: User History Report All Outbund Faxes for User (s) This report lists faxes sent to a specific recipient. RightFax user ID of the person who sent the fax. Unique ID of the fax. as assigned by the fax server. Destination_ToName.rpt l Report Title: Destination Record Outbund Faxes by ToCompany (search parameter) l l This report lists faxes sent to a specific recipient company. Status of the fax. Number of pages in the fax. Destination (String. Wildcard) Name of the recipient company. Fax number of the recipient. the name or telephone number of the recipient fax machine. Name or telephone number of the recipient fax machine (remote ID). the report shows: For all faxes. Destination (String. the report shows the overall total pages sent. Fax number of the recipient. For each company. 32 Event date Printer ID Pages Administrative Utilities Guide . the report shows: l l l l l l l l l l l For all faxes. Wildcard) l l l Destination_ToCompany. as assigned by the fax server. Number of pages in the fax. Name of the recipient company. Date the fax was sent. Destination (String. Number of pages in the fax. Unique ID of the fax. as assigned by the fax server. the report shows the overall total pages sent.6 RightFax user ID of the person who sent the fax. l l you are prompted to enter a company name. the report shows the overall total pages sent. Name of the recipient company. Unique ID of the fax.Chapter 2: Enterprise Fax Reporter l l l l l l Available Fax Reports Valid parameters are DateRange. Date the fax was sent. Name of the recipient. Fax number of the recipient. 6 33 Date and time the fax was sent. Length of time of the transmission. Name of the recipient company. Valid parameters are: Valid parameters are DateRange.rpt Requires “datareader” and “execute” SQL permission. which consists of: l l l Valid parameters are DateRange. Phone Cost (Currency) FaxLists_Detailed_AllFaxes. l l l l l OpenText RightFax 10.rpt Report Title: User History Report Completed Outbound Faxes for User(s) This report lists the details of all faxes. Name of the recipient company. Search User (String. the report shows: l l l l l This report lists the details of all completed faxes. Wildcard). Fax number of the recipient. Fax number of the recipient. the report shows: l 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). RightFax user ID of the person who sent the fax. Search Group (String.Chapter 2: Enterprise Fax Reporter l l l Available Fax Reports Copies Print Time Notes l Estimated cost based on transmission time and standard rates. Name of the recipient. RightFax user ID of the person who sent the fax. 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. the report shows: Date and time the fax was sent. Administrative Utilities Guide . Wildcard) Fax_Printing_User. Name of the recipient.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. For each RightFax user ID. Search User (String. Wildcard) DateRange. Status of the fax transmission Number of pages in the fax. l Transmission history. For each RightFax user ID. Report Title: User History Report All Outbound Faxes for User (s) FaxLists_Detailed_CompletedFaxes. Phone Cost (Currency) l l l Requires “datareader” and “execute” SQL permission. Wildcard). Fax number of the recipient. the report shows: l l l l l Date and time the fax was sent. the report shows the overall total pages sent. Number of pages in the fax.rpt l 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. Name of the recipient. event date and time off hook time Valid parameters are: DateRange. OpenText RightFax 10. Date and time the fax was sent. Wildcard). Status of the fax transmission. fax channel used for the transmission number of pages transmitted board result FaxLists_Summary_CompletedFaxes. Status of the fax transmission. Valid parameters are: DateRange. Length of time of the transmission. For all faxes. Name of the recipient company. Phone Cost (Currency) 34 Administrative Utilities Guide . which consists of: l l l l l l l l l Available Fax Reports l l l l For all faxes. Fax number of the recipient.Chapter 2: Enterprise Fax Reporter l Estimated cost based on transmission time and standard rates. l FaxLists_Summary_AllFaxes.6 Name or telephone number of the recipient fax machine (remote ID). Number of pages in the fax. For each fax. Length of time of the transmission. the report shows the overall total pages sent. Status of the fax transmission Number of pages in the fax. Search User (String. Valid parameters are: l DateRange. l Transmission history. RightFax user ID of the person who sent the fax. Search User (String. Name of the recipient. Name or telephone number of the recipient fax machine (remote ID). Search User (String. Wildcard). Name of the recipient company. RightFax user ID of the person who sent the fax. Length of time of the transmission.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. the report shows: you are prompted to enter a RightFax user ID or phone cost. For each fax. Phone Cost (Currency) Name or telephone number of the recipient fax machine (remote ID). Number of pages in the fax.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. the report also shows total number of pages with estimated cost. Fax number of the recipient.rpt l Report Title: Documents Received l l l This report returns a count of the number of documents received for all users in the selected data set. This report sorts the faxes by user. Search User (String. Wildcard). RightFax user ID of the person who sent the fax. For each fax.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).6 35 Administrative Utilities Guide . For each user. the report lists: l l l l l l DateRange. For each activity. Search User (String. Wildcard). Phone Cost (Currency) l l FaxLists_Summary_HumanRoutedReceived_ SubReport_ReceivedCount. Search User (String. Wildcard).rpt 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. Phone Cost (Currency) Outbound_Activity_Users. l Valid parameters are: l DateRange. the report shows: Valid parameters are: l Date and time the fax was sent. Total Off-Hook Time for this fax l Transmission History for each transmission attempt: l l DateRange. Length of time of the transmission. Report Title: Received Documents sent to EDC Valid parameters are: OpenText RightFax 10. Phone Cost (Currency) l l l FaxLists_Summary_HumanRoutedReceived_ SubReport_ReceivedEdcCount. FaxLists_Summary_HumanRoutedReceived.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. Estimated cost per minute Status of the fax transmission. Name of the recipient. including Deleted faxes. The report shows the total pages received for all users. Number of pages received that day. Wildcard). RIC_PSTN_Outbound_Usage.Chapter 2: Enterprise Fax Reporter Available Fax Reports DateRange. Phone Cost (Currency) Requires “datareader” and “execute” SQL permission. the report shows: l Valid parameters are: l l DateRange. Total number of pages received for all days. Estimated cost per minute Status of the fax transmission. the report shows: l Date and time the fax was sent. Search User (String.6 36 Administrative Utilities Guide . The only parameter required for this report is the DateRange. Phone Cost (Currency) Date. RightFax user ID of the person who sent the fax. Name of the recipient.rpt Requires “datareader” and “execute” SQL permission. Total Off-Hook Time for this fax l 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. including Deleted faxes. For each RightFax user ID. OpenText RightFax 10. Wildcard). RIC_Usage_Inbound_Users. Number of pages in the fax. Search User (String. Report Title: Faxes sent by RightFax Internet Connector (RIC) and PSTN by Country Code Outbound_Completed_Activity_Users. the report also shows total number of pages with estimated cost.rpt Report Title: User History Report Completed Outbound Activities for User(s) For each Country Code. RIC_PSTN_Outbound_by_Country. Number of pages sent using PSTN. Fax number of the recipient. The report shows the total pages. For each fax. This report sorts the faxes by user. Number of faxes sent using both methods.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.rpt Report Title: RightFax Internet Connector (RIC) Inbound Fax Use For each user. the report shows: l This report shows all outbound activities for selected users for completed faxes only. l 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. Length of time of the transmission. the report shows: l l l Date. a utilization of 50% on 4 channels. Receive-Capable Channels (Number) This report shows the total number of minutes used by all inbound channels for each hour of the day. enter the number of channels for the hypothetical calculation. If you entered “1” for the Send-Capable Channels field. The resulting report would show the actual minutes (120). To find out the percentage of capacity if this volume had occurred across only 4 channels. a 16 channel board server receives faxes for 120 minutes in the hour between noon and one pm on a given day. For each RightFax user ID.rpt If you enter a DateRange for more than one day.rpt Valid parameters are: Report Title: Time of Day Usage Report Inbound Faxes DateRange. the utilitization percentage column would show a 200% 37 Administrative Utilities Guide . Time_of_Day_Inbound_Usage. 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. Report Title: RightFax Internet Connector (RIC) Outbound Fax Use When running this report. The report shows the grand total number of minutes for all channels. run the report using “4” for the Send-Capable Channels field.. the report shows: For each hour. Number of pages sent that day. and calculates a utilization percentage for both a hypothetical number of sending channels and for the actual number of outbound channels used. 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. To find out the percentage of capacity if this volume had occurred across only 4 channels. OpenText RightFax 10. run the report using “4” for the Receive-Capable Channels field. and calculates a utilization percentage for both a hypothetical number of receiving channels and for the actual number of inbound channels used. a 16 channel board server sends faxes for 120 minutes in the hour between noon and one pm on a given day. a utilization of 50% on 4 channels.Chapter 2: Enterprise Fax Reporter Available Fax Reports The only parameter required for this report is the DateRange. the Minutes Elapsed column will reflect a total of the reception time for all days for each hour (not an average). and the channel numbers that were actually used during the specified date range. and the actual utilization of 12.5% across all 16 channels. RIC_Usage_Outbound_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.6 For example. If you entered “1” for the Receive-Capable Channels field. Total number of pages sent for all days. The resulting report would show the actual minutes (120). l l l The report shows the total pages sent for all users.5% across all 16 channels. and the actual utilization of 12. For example. 38 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. and calculates a utilization percentage for both a hypothetical number of sending channels and for the actual number of outbound channels used. and the actual utilization of 12. the utilitization percentage column would show a 200% capacity. If you enter a DateRange for more than one day. run the report using “4” for the Send-Capable Channels field. Number of minutes of transmission time for the user’s received faxes that day. a 16 channel board server sends faxes for 120 minutes in the hour between noon and one pm on a given day. Send-Capable Channels (Number) Report Title: Time of Day Usage Report Outbound Faxes Usage_Inbound_TransmissionTime. If you enter a DateRange for more than one day.. When running this report. channels. The only parameter required for this report is the DateRange. The resulting report would show the actual minutes (120). To find out the percentage of capacity if this volume had occurred across only 4 channels. the Minutes Elapsed column will reflect a total of the transmission time for all days for each hour (not an average). Send-Capable Channels (Number) Valid parameters are: Time_of_Day_Usage. Valid parameters are: DateRange. enter the number of channels for the hypothetical calculation. the Minutes Elapsed column will reflect a total of the transmission time for all days for each hour (not an average).rpt DateRange. and the channel numbers that were actually used during the specified date range. a utilization of 50% on 4 channels. For each hour. enter the number of channels for the hypothetical calculation. 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.6 l Date. If you entered “1” for the Send-Capable Channels field. Report Title: Inbound Fax Users by Transmission Time For each RightFax user ID. and the channel numbers that were actually used during the specified date range.5% across all 16 OpenText RightFax 10. the report shows: l l The report shows the grand total number of minutes for all channels. l 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. The report shows the overall number of minutes of transmission receipt time for all users. When running this report.rpt This report shows the total number of minutes used by all outbound channels for each hour of the day.. Total number of minutes of transmission time for the user’s received faxes for all days. the report shows: l l For example. One channel can only transmit for 60 minutes each hour and the actual volume was 120 minutes. Total number of minutes of transmission time for all days. Report Title: Top 10 Inbound Users by Pages This report lists the 10 RightFax users who received the most faxes during the reporting period. the report shows: The only parameter required for this report is the DateRange. the report shows: l l l The report shows the overall number of minutes of transmission receipt time for the top 10 users. Usage_Top_10_Inbound_TransmissionTime. l l l Date. Total number of pages received for all days. For each of the top 10 RightFax user IDs. For each RightFax user ID. Number of pages received that day.rpt l Report Title: Outbound Fax Users by Transmission Time l Date. OpenText RightFax 10. the report shows: l l l Date. Number of minutes of transmission time for the user’s received faxes that day. the report shows: The only parameter required for this report is the DateRange.rpt The report shows the overall number of minutes of transmission time for all users’ sent faxes. Report Title: Inbound Fax Use by Pages The report shows the overall total pages sent for all users. The only parameter required for this report is the DateRange.rpt Report Title: Outbound Fax Use by Pages l l For each RightFax user ID. Number of pages sent that day. The report also provides a bar chart of the top 10 users’ transmission receipt times. Number of minutes of transmission time for the user’s sent faxes that day. Total number of pages received for all days.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.Chapter 2: Enterprise Fax Reporter Available Fax Reports Usage_Inbound_Users. Date.6 39 Administrative Utilities Guide . the report shows: The report shows the overall total pages received for all users. Usage_Top_10_Inbound_Users. l Usage_Outbound_TransmissionTime. Date.rpt l Total number of pages sent for all days. For each of the top 10 RightFax user IDs. Usage_Outbound_Users. The only parameter required for this report is the DateRange. Total number of minutes of transmission time for the user’s sent faxes for all days. For each RightFax user ID. Number of pages received that day. The report shows the overall total pages sent for the top 10 users. For each of the top 10 RightFax user IDs. For each of the top 10 RightFax user IDs. Number of pages sent that day.exe is located in the RightFax\AdminUtils folder on the RightFax server. 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. OpenText RightFax 10. This report lists the 10 RightFax users whose sent faxes used the most transmission time during the reporting period. The only parameter required for this report is the DateRange.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.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 shows: l l l Required Parameters for All Reports Date. Total number of minutes of transmission time for all days.6 -log Error | Info | Off | Verbose | Warning 40 Administrative Utilities Guide . The report also provides a bar chart of the top 10 users’ sent faxes. Number of minutes of transmission time for the user’s sent faxes that day. The only parameter required for this report is the DateRange. -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. Usage_Top_10_Outbound_ TransmissionTime. The utility EnterpriseFaxReporter. Total number of pages sent for all days. the report shows: l l l -outputType “CR” | “XLS” | “XLSR” | “HTML32” | “HTML40” | “PDF” | “RTF” | “WORD” Date. The report also provides a bar chart of the top 10 users’ received faxes.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. -dateStart “mm/dd/yyyy hh:mm:ss [AM][PM]” (Default time is 12am) Usage_Top_10_Outbound_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. April.6 41 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. 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.exe -showParams “C:\Program Files\RightFax\AdminUtils\Reports\Usage_Top_10_Inbound_ Users.pdf where HH_MM_SS_MS is the time when the report was run.exe -reportName “C:\Program Files\RightFax\AdminUtils\Reports\Usage_Top_10_Inbound_ Users.rpt” OpenText RightFax 10. -paramServerName “Name of Server” -paramSearchUser “UserID” -paramSearchGroup “GroupID” EnterpriseFaxReporter. enter the following command line: EnterpriseFaxReporter. and May. Example: Using the Help To generate a list of all of the required parameters for the report that shows the top ten users. 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. PDF images for faxes sent via email as PDF attachments. Additionally. The Migration Tool copies faxes from version 10. these types of information is by a drag-and-drop operation from Enterprise Fax Manager.are moved by manual file copy between systems. Forms. viewed history.6 42 Administrative Utilities Guide . etc. document statuses. including OCR files (in the \RightFax\BFT folder).Chapter 3: RightFax Document Migration Tool Chapter 3: RightFax Document Migration Tool Using RightFax Document Migration Tool (MigrationMFC. The tool does not create groups. Any faxes with missing files in the Image directory are skipped and logged to the activity log files. 10. The easiest way to move Administrators can select all users/groups. fax images and other files associated with the fax are copied to the destination server. user folders. such as server consolidation projects. This utility accommodates staged system migrations between different versions of RightFax.0.. and 10. fax transmission history.) is copied to the destination server. Other key files used by the RightFax Server. etc. All of these items are moved by other methods. 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. use the OpenText RightFax 10.6 fax server. phonebooks.exe) system administrators can migrate fax records and associated data between RightFax systems. If your RightFax database contains a large number of user accounts.6 fax servers of to a 10. etc. All metadata associated with each fax record (to/from information. users. Signatures. and Integration Module Notification files (in \RightFax\CMDDATA). or select individual sets of users or groups with the Migration Tool. Selecting specific users or groups facilitates staged migrations and server consolidations. and to simplify architectural changes that require moving fax records between systems. SMS files.5. such as Cover Sheets. These files are removed after the successful migration of each record.log file is created at the beginning of the migration process. l Server migrations can be performed in incremental stages. without having to worry about what data has already been migrated. l Source servers can remain in production. this folder also contains temporary copies of one or more fax image files associated with the current fax record migration. 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. the tool processes any fax records not already marked. 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. Error Display The administrator can visually monitor progress during a migration run with the Migration Tool. 43 Administrative Utilities Guide . and is constantly updated with the latest action result during the entire process.Chapter 3: RightFax Document Migration Tool Fax Record Marking and Progress Tracking Group selection options to simplify selection of user accounts.log file in the same folder. 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. Errors encountered during the process are visible as they occur. A detailed migration. At the end of the migration process. Detailed and Summary Logs Each time the migration process is started. All records not containing a Migration value are processed and copied to the destination server. and are also written to log files. the errors encountered during the process and a summary of activities are logged in the MigrationSummary. the Migration Tool processes all fax records for the selected users the next time the tool runs. Any records containing the Migrated :<hexadecimal> value are skipped. 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.6 In the event of an unexpected process failure. The Comments field of all fax records for the selected users or groups on the source server are checked. During the migration process. If the migration process is stopped and restarted before all fax records on the source server have been migrated. OpenText RightFax 10. The <hexadecimal> value is the fax handle of the new fax record on the destination server. a new Tool_ Run_<date>_<time> folder is created under the Migration Tool directory. Any new fax records accumulated on the source server are processed the next time the Migration Tool runs. The main Migration tool window opens OpenText RightFax 10. copy the files to a single folder on the destination RightFax Server.6 44 Administrative Utilities Guide . To launch the Migration Tool. 4. Enter the name of the Source and Destination RightFax servers. Use Wordpad.exe. and the credentials of an account with administrator privileges. open the folder where you copied the application files.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 or another text editor to improve the appearance of the logs. error messages can be more detailed if the tool is run from the destination drive. 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. and run MigrationMFC. Using the Migration Tool Installation The RightFax Document Migration Tool is a self-contained application and does not use an installer.exe included with Microsoft Windows. Note Though the tool can be installed on any server that can access both the source and destination drives. 3. 2. To install the tool. Remember. You can select either Users or Groups. 7. To add users/groups to the Destination list.6 45 Administrative Utilities Guide . The Errors indicator shows errors encountered during the process. select the desired users/groups in the Destination list. click the OK button. Select the users or groups that you want to migrate. select from the user/group options: l l l l Important The list of selected users/groups is not stored. and click the last item.Chapter 3: RightFax Document Migration Tool Using the Migration Tool order. the Migration Tool does not create users or groups. and click the left arrow. The folder contains a detailed Migration. If you select either Migrate specific Users or Migrate specific Groups.log and a MigrationSummary. In the Select Users or Groups window. To select non-contiguous items. the Destination list no longer shows in alphabetic/numeric order. Select users/groups each time you run the Migration Tool. 9. click the first item. l 6. The Source list is shown in numeric. then alphabetic OpenText RightFax 10. click the Migrate button. After selecting the desired users/groups. To remove users/groups from the Destination list. 8. but not both. l l To select a contiguous range of items. click either the Load users or Load groups button to load the list from the Source server. hold the Ctrl key and select individual items. hold the Shift key. Click this at any time to stop the migration process. the Migrate button changes to a Stop button. select the desired users/groups in the Source list.log. On the main screen. As you add or remove Items. and click the right arrow.When migration starts. 5. Separate Tool_Run_<Date>_<Time> folders are created at under the Migration Tool directory every time the tool runs. All Users All Groups Specific Users Specific Groups l Note Selecting either All Users or All Groups has the same effect. enter the folder path to the location of the cover pages. On the RightFax server. Database Name. User Name and Password for RightFax. l To retain MESSAGEmanager user types. On the RightFax(Destination) tab. Database Name. OpenText RightFax 10. User Name and Password for MESSAGEmanager. enter the RightFax Server Name. When importing users. 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.Chapter 4: MESSAGEmanager to RightFax Migration Tool Chapter 4: MESSAGEmanager to RightFax Migration Tool 2. l Migrate individual cover pages before users if you want the users to retain their association with cover pages from MESSAGEmanager. point to OpenText. specify the following: To run the MESSAGEmanager to RightFax migration tool 1. Authentication. 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.6 46 l In the Add migrated users to this RightFax group box. select the Administrative Utilities Guide . received faxes. and the SQL Server Name. select the check boxes for the items you want to import. enter the SQL Server Name. 5. on the Start menu. Authentication. the RightFax Installation Path. Administrators can import the following items from MESSAGEmanager to RightFax using the MESSAGEmanager to RightFax Migration tool: l Users l Cover pages l Sent faxes l Received faxes 3. l 4. and sent faxes.rtf cover pages can be migrated. point to All Programs. in the Cover Pages Folder Path box. and then click MESSAGEmanager to RightFax Upgrader Tool. On the MESSAGEmanager(Source) tab. Note the following: l Only . enter the name of an existing RightFax group. Faxes for which no match is found are imported under the Administrator user. l For users. the configuration settings are not saved.LOG. and then click Save. The system validates the settings.6 47 Administrative Utilities Guide . To save the migration log to a location of your choice.Chapter 4: MESSAGEmanager to RightFax Migration Tool Set RightFax user settings based on MESSAGEmanager user type check box. OpenText RightFax 10. click Save Log and specify a name and location. 7. If the validation fails. The system validates the settings. By default. clear the check box. To use the RightFax default user settings. If the validation fails. the migration is not run. click Save Configuration. the log is saved in C:\ProgramData\MMtoRF\Log\MMTORF. 6. click Start Migration. l To start the migration. Do one of the following: l To save the settings. Quotes surround fields in a string. in the sequence they appear in the FaxDump text file. 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. depending on your system configuration.exe Data Fields Information level 0 data fields Chapter 5: 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.6 Size Captured Description from inbound or outbound fax To_ ContactNum 48 Administrative Utilities Guide .exe Data Fields FaxDump. cover sheet data (such as the recipient’s 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 Recipient’s name To_Company String 59 Outbound Recipient’s company To_CityState String 59 Outbound Recipient’s address From_Name String 59 Outbound Sender’s name From_ PhoneNum String 31 Outbound Sender’s phone number BillInfo1 String 15 Outbound Billing code 1 BillInfo2 String 15 Outbound Billing code 2 FaxDIDNum String 31 Both Sender’s or recipient’s DID fax number. and all fields are separated by commas by default . The text file prints one complete fax record per line. For example. Different data is available for sent and received faxes.Chapter 5: FaxDump. when available Field name Type Owner_ID String 21 Both User ID of person who sent fax OperatorNum String 31 Outbound Sender’s company phone number To_FaxNum String 31 Outbound Destination fax GeneralFaxNu String 31 Outbound Sender’s general fax OpenText RightFax 10. if any FineMode Intege 1 r Outbound 0 = normal 1 = fine From_ PhoneNum String 31 Outbound Sender’s 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) Sender’s or recipient’s DID fax number. when available OperatorNum String 31 Outbound Sender’s company phone number GeneralFaxNu String 31 m Outbound Sender's general fax number NumPages Both Includes optional cover sheet.6 49 Intege 4 r Administrative Utilities Guide . 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 Recipient’s name To_Company String 59 Outbound Recipient’s company To_CityState String 59 Outbound Recipient’s address From_Name String 59 Outbound Sender’s 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 OpenText RightFax 10.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. 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.Chapter 5: FaxDump. in seconds. 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 Recipient’s name To_Company String 59 Outbound Recipient’s company To_CityState String 59 Outbound Recipient’s address Administrative Utilities Guide .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 OpenText RightFax 10.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. including all transmission attempts FaxDate String 8 Both Date fax record last OpenText RightFax 10. 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. 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. in seconds. regardless of the number of transmission attempts (HH:MM) Outbound Sender’s company phone number GeneralFaxNu String 31 m Outbound Sender’s general fax number Unique_ID Inbound Unique number assigned to the fax by RightFax NumPages Intege 4 r Both Includes optional cover sheet.exe Data Fields Field name Type From_Name String 59 Outbound Sender’s name From_ PhoneNum String 31 Outbound Sender’s 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 Sender’s or recipient’s DID fax number.Chapter 5: FaxDump.6 Type FaxTime String 31 String 15 Field name 51 Administrative Utilities Guide . 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 . 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 Recipient’s name To_Company String 59 Outbound Recipient’s 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.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 53 Administrative Utilities Guide .Chapter 5: FaxDump.6 Both Includes optional cover sheet.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 Recipient’s name Unique_ID String 15 Inbound To_Company String 59 Outbound Recipient’s 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 Sender’s 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 Recipient’s name NumPages Integ 4 er OpenText RightFax 10. 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.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 Recipient’s 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 Sender’s 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.Chapter 5: FaxDump.6 54 Administrative Utilities Guide . if any To_Name Strin 59 g Outbound Recipient’s name Both 0 = sent 1 = received To_Company Strin 59 g Outbound Recipient’s 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. if any. 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 User’s group ID RouteCode User’s 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. 5 Fax needs to be sent. Fax will be retried. 3 Fax needs to be sent. 6 Fax is done sending or receiving. 11 Error encountered. 4 Fax is in conversion. is not retried. 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. if any NumPages Integ 4 er Both Includes optional cover sheet. 7 Fax uses a manual fax cover sheet.Chapter 5: FaxDump. 10 Fax is a duplicate of another fax.6 Both Fax status fields (FaxStat) Value Definition Date fax record last modified (MM/DD/YYYY) Database handle of the fax 55 1 Fax needs cover sheet. Errors were encountered. 9 Fax is done sending or receiving. 2 Fax needs conversion. 8 Fax is scheduled to be sent. 12 Sent or received fax needs user’s attention (data is required Administrative Utilities Guide . 32 14 Fax is held for preview.34 Dead line 13 Fax needs attachment.9.Chapter 5: FaxDump.2 Line busy 3 Re-order busy signal 8. Successful Termination status fields (TermStat) Value Definition 1.6 56 Administrative Utilities Guide .exe Data Fields Termination status fields (TermStat) Value Definition Value Definition on cover sheet). 19 Fax is being validated. 20 Fax is awaiting approval. 18 Fax is queued for OCR conversion. 16 Fax is printing. Any Unknown error other value 17 Fax is queued for printing. 15 Fax is in OCR conversion.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. 28.