OpenText RightFax 10.6 Feature Pack 2 Administrator Guide Edition OpenText RightFax 10.6 Feature Pack 2 Wednesday, August 19, 2015 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 ©2015 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 Feature Pack 2 2 Administrator Guide Contents Chapter 1: Introduction 10 About the RightFax System 10 RightFax Server options 10 Chapter 2: User assistance 12 Using this guide 12 Getting help online 12 Editing contact information in FaxUtil 12 RightFax training services 12 OpenText professional services 13 Customer support 13 Chapter 3: How RightFax works Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM) 18 Starting Enterprise Fax Manager 18 Using the Enterprise Fax Manager window 18 Opening RightFax servers 19 Setting preferences 20 Viewing RightFax server information 22 Working with objects 23 Monitoring the status of RightFax servers and services24 Configuring services 27 Copying service configuration settings to other nodes 27 14 Changing service accounts 28 Synchronizing the RightFax server with external systems 29 Running Enterprise Fax Manager Web Edition 29 Chapter 5: Configuring the RightFax Server module 31 RightFax components 14 Fax image files 14 Fax database 15 RightFax services 15 The RightFax queues 16 RightFax client programs 16 Configuring the general settings 31 Installing the RightFax server 17 Configuring the advanced settings 34 OpenText RightFax 10.6 Feature Pack 2 3 Administrator Guide Configuring feature activation 36 Configuring T.37 Fax over IP 78 Configuring custom messages 36 Configuring Fax over IP failover 78 Configuring user messages 40 Configuring SMS via the Push-Proxy Gateway 79 Configuring admin messages 42 Configuring RightFax Internet Connector channels 80 Configuring data sharing 43 Configuring RightFax Connect 81 Configuring eTransport 44 Configuring Automated Billing Codes 82 Starting and stopping the RightFax server 46 Running DocTransport on remote computers 83 Chapter 6: Configuring the WorkServer modules 48 Telephony server routing 50 InterConnect retry settings 50 Optimize faxing 50 Archive settings 50 Selecting a service account 53 Adding and deleting WorkServers 55 Printing a time strip on faxes 55 Configuring Kofax NetScan 56 Configuring PeopleSoft 57 Installing WorkServers on remote computers 58 Chapter 7: Configuring the DocTransport modules Chapter 8: Configuring server-side application conversion 61 Configuring global DocTransport settings 63 Brooktrout Fax Board configuration 63 Configuring Docs-on-Demand 76 About server-side application conversion 87 About the RightFax Conversion Engine 88 Configuring the service account 93 To configure timeout on a failed conversion 93 Controlling server-side application conversion 94 Troubleshooting the Conversion Engine 94 Chapter 9: Enabling and using the RightFax Sync module 95 61 Adding transport methods About the Sync module 95 Getting started 95 Defining data sources and destinations 96 Configuring a data source 97 Configuring a destination database 102 Creating mappings 103 Verifying user synchronization 103 Chapter 10: Creating RightFax users OpenText RightFax 10.6 Feature Pack 2 87 4 106 Administrator Guide Managing RightFax users 106 Customizing the names of billing code fields 144 Creating a user profile 108 Managing billing codes 144 Using Integrated Windows Authentication 121 Editing billing code properties 145 Importing users 123 Importing Billing Codes 145 124 Requiring billing codes 146 Managing groups 124 Configuring RightFax to validate billing codes 147 Editing group properties 125 Making ODBC billing codes available 147 Chapter 11: Creating groups of users Chapter 12: Creating signatures 132 Chapter 16: Creating library documents 149 Managing signature files 132 Creating a new library document 149 Editing signature file properties 133 Editing library document properties 150 Adding a signature to a fax 134 Managing library documents 151 Chapter 13: Creating overlay forms 135 Managing overlay forms 135 Editing form file properties 136 Using two overlay forms in one fax 137 Adding an overlay form to a fax 138 Chapter 14: Connecting printers and scanners 139 Managing printers 139 Editing printer properties 139 Importing printers into RightFax 140 Configuring RightFax to automatically print faxes 141 Using Scanners with RightFax 141 The Standalone Fax Connector 142 Chapter 15: Creating billing codes OpenText RightFax 10.6 Feature Pack 2 Chapter 17: Text messaging using the Push Proxy Gateway About message types 152 About connectors 152 About two-way SMS support 153 About log files 153 Installing the Push Proxy Gateway 154 Configuring the Push Proxy Gateway 155 Chapter 18: Adding SMS and pager services 5 161 Managing SMS and pager services 161 Editing SMS and pager service properties 162 Logging SMS and pager alerts 164 Chapter 19: Using the Alerting and Monitoring service 144 152 165 Administrator Guide Installing the Alerting and Monitoring service 165 Creating a PCL cover sheet template 205 Configuring the RightFax Alerting service 165 Inserting cover sheet codes 205 Managing statistics to monitor and alerts 167 Managing cover sheet template files 209 Editing Alert Properties 168 Granting user permission to select a cover sheet 210 172 Setting default cover sheets 211 Setting required cover sheet information 211 Chapter 20: Using SNMP Alerting Configuring the SNMP Service on the RightFax server172 Configuring the Network Monitor application 173 Receiving RightFax alerts in your network monitor 173 Querying RightFax status variables 175 Chapter 23: Using Optical Character Recognition 213 Enabling OCR processing on the WorkServers 213 Configuring the Conversion Engine for OCR 214 Controlling RightFax services from your network monitor 181 Configuring RightFax users for OCR conversion 214 Troubleshooting the RightFax alerts 181 Using OCR to route received faxes 216 Creating and managing OCR text files 218 Chapter 24: Routing inbound faxes 220 Chapter 21: Creating dialing rules and LeastCost Routing plans 185 Creating, deleting, and copying dialing rules 185 Editing dialing rules 186 Load balancing 195 Creating, deleting, and copying destination tables 196 Testing dialing rules and fax routes 198 Blocking calls and handling spam 200 Least-Cost Routing examples 201 Chapter 22: Creating fax cover sheet templates 204 Creating an HTML cover sheet template 204 Creating a Microsoft Word (.doc) cover sheet template 205 OpenText RightFax 10.6 Feature Pack 2 Configuring DID/DNIS routing 220 Configuring DTMF routing 221 Configuring channel routing 221 Configuring ANI routing 222 Configuring CSID routing 223 Configuring delivery methods for users 224 Distributing faxes to a group of users 225 Assigning unique ID numbers to fax file names and routing to a network folder 226 Chapter 25: Responding to inbound faxes with AutoReply 6 227 Administrator Guide Requirements 227 Installing AutoReply 227 Installing the E-mail Gateway software 262 Configuring AutoReply 228 Sending a fax via SMTP/POP3 264 Customizing the reply fax 230 Configuring users to receive faxes via email 266 Troubleshooting the AutoReply Service 232 Email notification of faxes 267 Embedded codes in mail messages 268 Running the email gateway remotely 269 Troubleshooting the email gateways 270 Adding and configuring email gateways 271 Chapter 26: Creating, sending, and managing faxes 233 Creating and sending a fax 233 Using embedded codes 241 Viewing received faxes 242 Managing faxes 245 Chapter 27: Working with PDF files Chapter 29: Using RightFax email gateways Chapter 30: Inbound faxing with Microsoft Exchange Unified Messaging (UM) 262 277 248 Overview 277 Converting received faxes to PDF 248 Requirements 277 Creating and sending a PDF by email 248 Configuring Exchange UM for faxing 277 Configuring RightFax for Exchange UM 278 Using the PDF module to convert PDF files for faxing 249 Chapter 28: Creating phonebooks and broadcasting faxes Chapter 31: Configuring the Web Client 251 Using the RightFax phonebook 251 Importing entries into the RightFax phonebook 253 Saving phonebook entries to a comma-separated value (CSV) file 255 Using MAPI phonebooks 255 Using ODBC phonebooks 256 LDAP phonebooks 258 Fax broadcasting 259 OpenText RightFax 10.6 Feature Pack 2 Configuring the RightFax Web Client 280 280 Chapter 32: Using TeleConnect to access faxes by phone 283 Configuring TeleConnect 283 Retrieving faxes via TeleConnect 290 Chapter 33: RightFax Dashboard 292 Configuring the RightFax Dashboard 292 Viewing the RightFax Dashboard 292 Chapter 34: RightFax Internet Connector 7 296 Administrator Guide Creating a RightFax Internet Connector account 296 Configuring RightFax Internet Connector in the RightFax Sync Module 297 Registering the fax system 298 Configuring the RightFax Internet Connector transport 299 Enabling the dialing rule 299 Configuring the RightFax Internet Connector receiver300 ATTIME 312 BILLINFO1 + 312 BILLINFO2 + 313 BROADCAST 313 CHANNEL 313 COMPLETEEVENT 314 COVER 314 DELETE 314 Chapter 35: Backing up and maintaining RightFax 302 DELETEALL 314 Changing the connection to the SQL server 302 DELETEFIRSTPAGE 314 DELETELASTPAGE 314 FCSFILE 315 FINE 315 FORMTYPE 315 FROMFAXNUM 315 FROMGENFAXNUM 315 FROMGENPHONE 315 FROMNAME 316 FROMPHONE 316 IGNORE 316 LIBDOC 316 LIBDOC2 316 NEWDEST 316 NEWLIB 317 Enabling RightFax to use SQL Server database mirroring 304 Backing up and restoringthe RightFax server and database 305 Purging deleted fax records from the database 308 Purging fax records using DBPurge 308 Purging faxes from users’ fax mailboxes 309 Removing orphaned faxes 309 Supported database collations 309 Chapter 36: RightFax embedded codes 310 ADDDOC2 311 ADDDOC3 311 ADDDOC4 311 ATDATE 312 OpenText RightFax 10.6 Feature Pack 2 8 Administrator Guide . NEWLIB2 317 NOBODY 317 NOCOMPLETEEVENT 318 NOCOVER 318 NORMAL 318 NOSMARTRESUME 318 NOTE 318 NOTIFY_ERROR 318 NOTIFY_OK 318 NOTIFY_RETRY 318 PREVIEW 319 PRIORITY 319 RETRYCOUNT 319 RETRYINTERVAL 319 SAVE 319 SIGNATURE 319 SMARTRESUME 320 TOALTFAXNUM 320 TOCITYSTATE 320 TOCOMPANY 320 TOCONTACTNUM 320 TOFAXNUM 320 TONAME 320 UNIQUEID 321 OpenText RightFax 10.6 Feature Pack 2 Chapter 37: File formats that convert to fax format 322 Chapter 38: Error and status messages 324 Chapter 39: Alerting and Monitoring Statistics 330 Fax Server Statistics 330 Database Statistics 331 Workserver Statistics 333 Gateway Statistics 334 Local BoardServer Statistics 335 All BoardServers Statistics 339 RPC Server Statistics 340 Paging Server Statistics 340 Local Document Transport Server Statistics 341 Chapter 40: Registry keys and values DocTransport Registry Entries 346 FaxServer Registry Entries 350 Gateway Registry Entries 354 RightFaxRegistry Entries 355 WorkServer Registry Entries 357 Chapter 41: Web Services API 9 345 360 Starting the Web Services 360 Inquiring about fax status 361 Sample Web.aspx 381 Administrator Guide .config 378 Sample Default. 10 Administrator Guide . and routes incoming faxes. This server includes the RightFax Web Client™ and the OCR Router™. expandable to support unlimited fax channels. The server consists of several services that run on one server computer or several networked computers to distribute heavy workloads. but is expandable to up to 30 fax channels.Chapter 1: Introduction About the RightFax System Chapter 1: Introduction A RightFax email gateway acts as a communication link between the RightFax server and an email server. RightFax Enterprise Server and Enterprise Suite Similarly. overlaying a form. RightFax Business Server l RightFax Enterprise Server and Enterprise Suite l RightFax Server with the Integration Module l RightFax Branch Office Server RightFax Business Server The RightFax Business Server supports unlimited user accounts. Advanced gateways for Microsoft Exchange and Lotus Notes are available as separate modules. RightFax fax board services can be installed on remote servers to distribute the workload across several computers and to provide expanded channel capacity and system redundancy. The RightFax server manages network print queues assigned to faxing. and delete faxes. the user’s customary email client software can serve as the fax client. converts outgoing faxes. RightFax Server options A user can enhance the fax by adding a cover page. OpenText RightFax 10. With FaxUtil. and manage faxes. It includes one fax channel. It includes three WorkServers and one fax channel. RightFax includes an email gateway for SMTP/POP3. RightFax offers the following fax server software options: FaxUtil is the RightFax mailbox where users create. sending. attaching documents. users can forward. With an email gateway. About the RightFax System The RightFax system is a comprehensive network fax solution for creating. and inserting graphics. schedules outgoing faxes. print.6 Feature Pack 2 l The RightFax Enterprise Server supports unlimited user accounts. and managing faxes from a user’s desktop computer. receiving. route. view. Routing can be optimized with Intelligent Least-cost Routing™ rules. RightFax features and intuitive design make faxing as easy as printing to a network printer. the Document Management Connector™. The Enterprise server is also available as a product suite that includes the RightFax Enterprise server. RightFax Branch Office Server This RightFax Branch Office server supports up to 100 user accounts. OpenText RightFax 10. and TeleConnect™ modules. and local area network host systems. the SNMP Alerting™. The RightFax Enterprise Integration module can be installed on the Enterprise server. mid-range. The Integration module integrates RightFax with applications on mainframe. the Gateway for Lotus Notes®. l l The RightFax Small Business Integration module can be installed on the RightFax Business and Enterprise servers. and can be updated for a total of four fax channels. RightFax Server with the Integration Module The RightFax server and the RightFax Integration module enable applications for information exchange. and the PDF modules. plus the Gateway for Microsoft® Exchange. Docs-on-Demand™.6 Feature Pack 2 11 Administrator Guide . It includes three WorkServers and two fax channels.Chapter 1: Introduction OCR Converter™. 6 Feature Pack 2 Open the text file Contact.Chapter 2: User assistance Using this guide Chapter 2: User assistance Using this guide The RightFax Administrator Guide is for RightFax administrators who install and configure the RightFax software on both client and server computers. Regularly scheduled courses are delivered virtually. select Contact Information. OpenText RightFax 10. The information appears in English. configuring and maintaining Fax Servers. 12 Administrator Guide . This guide assumes you have knowledge of the Windows operating systems as well as knowledge of networking systems and your own organization’s network. To look up OpenText Customer Support contact information l In FaxUtil. On-site and custom training are also available.com has the latest product information. on the Help menu.opentext. You can enter 24 lines of text and up to 59 characters per line. such as: l Updated documentation l A searchable customer support knowledge base l Software downloads To customize the Contact Information text that appears in FaxUtil l RightFax training services Editing contact information in FaxUtil RightFax training from OpenText facilitates successful deployment and saves time installing.txt located in the \RightFax\Bin folder on the RightFax server. Getting help online The OpenText Knowledge Center at http://knowledge. com. customers have access to: To get more information and register for RightFax training l Visit our web site at: http://www.com. OpenText RightFax 10. systems assessment and health check. To view OpenText customer support contact information Go to www.opentext.6 Feature Pack 2 13 Administrator Guide . OpenText’s team of Technical Support Engineers and Product Specialists To open the OpenText Knowledge Center Go to http://knowledge.htm OpenText Professional Services provides a cost effective alternative for organizations in need of getting their enterprise fax infrastructure up and running quickly. Customer support OpenText Customer Support maximizes the value of your RightFax server by providing access to a wide variety of resources and support tools.opentext. Through the OpenText Knowledge Center. configuration review. particularly with limited resources or expertise. upgrades and migrations.Chapter 2: User assistance OpenText professional services We can help you develop a customized training plan for your organization.com/what-we-do/services/trainingand-learning-services/course-catalogue/opentext-faxand-document-distribution-solutions-learning-offerings l l Email us at: l System upgrades and maintenance l An extensive product knowledgebase l Product documentation l Product discussion groups IX-learning@opentext. To view OpenText’s complete line of Customer Support offerings Go to http://www.com/2/global/services-home/servicessupport-contact.com OpenText professional services Experienced OpenText implementation engineers can help you quickly and efficiently deploy RightFax in your production environment. Services can be performed remotely. or a combination of both. deployment and integration of RightFax solutions. Services include basic installation and configuration.com/support.opentext. on-site. To contact professional services l Send an email at FaxSolutions@opentext. and other advanced integration services.opentext. OpenText Professional Services engineers and consultants are experts in the implementation. Chapter 3: How RightFax works RightFax components Chapter 3: How RightFax works SQL database. RightFax components Each individual page of a fax is saved as a separate file. All files associated with a single fax will have the same file name, but different file extensions will indicate the page number. File extensions for RightFax image files are numeric, starting with number 301, indicating the first page of the fax. The file extension increments by 1 for each subsequent page of the fax. Basic RightFax components include: l Fax image files l Fax database (SQL) l RightFax services l Fax client programs Caution If you re-name RightFax image files, they will not be recognized by the RightFax server. Before configuring RightFax for your particular network installation, you should understand the function of each component. Size A typical fax consumes 35 Kb, though some can be as large as 150 Kb or as small as 5 Kb per page. Because fax images can consume a large amount of disk space dedicate at least 500 Mb of storage to your RightFax server. More space may be required depending on the number of faxes sent and received, and how frequently old faxes are deleted. Fax image files By default, all sent and received faxes are stored as compressed graphic image files (CCITT Group III format) in the RightFax\Image folder and are not encrypted. With the appropriate license the RightFax server can be configured to encrypt the image folder so that they can only be viewed using RightFax applications. See Configuring the general settings on page 31. Disk space RightFax monitors the amount of free disk space on the server and shuts down certain processing elements when available disk space falls below 50 Mb. When sufficient disk space is restored, fax processing continues automatically. Names Fax image files are assigned file names by the RightFax server and these file names are referenced by the RightFax OpenText RightFax 10.6 Feature Pack 2 14 Administrator Guide Chapter 3: How RightFax works Fax database outgoing faxes, and works with the DocTransport module to schedule outgoing faxes and route incoming faxes. Fax database RightFax uses a SQL database to manage RightFax system objects (such as users, groups, and printers) and to organize, track, and route faxes. RightFax provides some database management and diagnostic utilities. Third-party and custom SQL utilities can also be applied to the RightFax database. For more information on the RightFax database and applicable SQL database management tools, see Backing up and maintaining RightFax on page 302. The RightFax WorkServer module The RightFax WorkServer module performs one or more functions on behalf of the RightFax Server module. It periodically asks the RightFax database if its services have been requested, executes requested tasks, and notifies the database when tasks are complete. You can configure multiple WorkServer modules to handle processor-intensive tasks such as print-to-fax file conversions. For example, one WorkServer can convert PCL5 print files into fax images while another WorkServer handles automatic printing of incoming faxes. RightFax services The RightFax server consists of several services: l RightFax Server module The RightFax DocTransport module l RightFax WorkServer modules l RightFax DocTransport module l RightFax Database module l RightFax RPC Server module l RightFax Queue Handler l Email gateway modules (optional) The RightFax DocTransport module acts as an interpreter between the fax boards and the Server module. It handles requests to schedule outgoing faxes for transmission and informs the Server module when a new fax has been received and needs to be processed. Multiple DocTransport modules can be installed on remote servers to distribute the workload across several machines and provide expanded channel capacity and system redundancy. l Integration modules (optional) In the RightFax DocTransport module you configure the different methods by which documents are transmitted. You can configure fax boards for conventional fax transmission or Fax-over-IP boards as well as set up RightFax for SMS messaging. In most cases, all the services run on the same machine so that the Server module can automatically start and stop the programs as necessary. The RightFax WorkServer and DocTransport modules can run on different computers to redistribute heavy workloads. The RightFax Database module The RightFax Database module accesses the SQL fax database to provide client programs with the information used in fax transactions including deleting, forwarding, creating, viewing, and printing faxes. The RightFax Server module The RightFax Server module manages the network print queues assigned to faxing, controls the conversion of OpenText RightFax 10.6 Feature Pack 2 15 Administrator Guide Chapter 3: How RightFax works The RightFax queues can be viewed by running Server Manager. The queues that relate to RightFax are Private Queues in the Message Queuing Feature. The RightFax RPC module The RightFax RPC module acts as an interpreter between the RightFax client programs and the fax database on the server. RightFax Queue Handler The RightFax queues RightFax Queue Handler monitors the HPFAX print queue for inbound jobs and directs them to RightFax for processing. RightFax Internal Event Queue The RightFax Server module is responsible for queuing and monitoring each of the fax server internal processes, which are collectively called the “Event Queue.” The status of the Event Queue is measured as a percentage of server resources that are occupied with Server module functions (such as sending and routing faxes). RightFax client programs FaxUtil FaxUtil is RightFax’s Windows-based client application. With FaxUtil, users can view, print, and manage their faxes and faxes for which they are delegate or administrator. Version 10.6 servers support versions 10.0 or higher of the FaxUtil client. The Event Queue is represented as the ratio of fax traffic volume to server resources. The higher the traffic volume, the higher this number will be. The Event Queue status appears in Enterprise Fax Manager when you open and select a RightFax server. RightFax Web Access RightFax Web Access (WebUtil) is a browser-based client application that includes most of the functionality of FaxUtil. It does not work with Internet Explorer 10 or later. When the Event Queue of a RightFax server reaches 90 percent, the server will suspend certain functions. At 90 percent, all new outbound and inbound faxes will be held (temporarily set aside) as the server processes the existing workload. After the Event Queue falls to 75 percent, these held faxes will be scheduled for processing along with all new fax traffic. RightFax Web Client RightFax Web Client is a RightFax browser-based client application that includes the basic functionality of FaxUtil. It can be accessed from any HTML5-compliant browser. Enterprise Fax Manager Enterprise Fax Manager is the primary RightFax administrator application. With Enterprise Fax Manager, the RightFax administrator can manage items such as users, groups, printers, cover sheets, and billing codes, as well as least-cost routing, and the general functions of the fax system. This internal workload regulation is handled by the Server module and cannot be overridden. If the fax server is consistently reaching the 90 percent capacity level, consider upgrading the fax server’s system resources and/or fax channels. Microsoft Message Queue Enterprise Fax Manager Web Edition RightFax uses the Microsoft Message Queue (MSMQ) protocol to communicate with the RightFax DocTransport service. MSMQ is installed with RightFax Version 10.5 and later and OpenText RightFax 10.6 Feature Pack 2 Enterprise Fax Manager Web Edition is a browser-based RightFax management tool. It includes most of the 16 Administrator Guide Chapter 3: How RightFax works Installing the RightFax server functionality of Enterprise Fax manager, but can be accessed from a Web browser. Installing the RightFax server For information and instructions on installing the RightFax server software, refer to the RightFax Installation Guide. OpenText RightFax 10.6 Feature Pack 2 17 Administrator Guide Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM) Starting Enterprise Fax Manager Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM) Use RightFax Enterprise Fax Manager (EFM) to administer multiple RightFax servers, configure their services, and manage administrative components, such as users, groups, signatures, forms, printers, billing codes, library documents, and more. Using the Enterprise Fax Manager window The Enterprise Fax Manager window shows in the left pane all open RightFax servers and below each server, the administrative components you can define for it. When you click a server in the left pane, the right pane shows the RightFax services; when you click a component, the right pane shows a list of items defined for the selected component. For information about opening a RightFax server, see Opening RightFax servers on page 19. Starting Enterprise Fax Manager To start EFM l On the Start menu, click All Programs, Open Text, and then RightFax Enterprise Fax Manager. Note When you start EFM for the first time, it attempts to log on under your network user ID. If you did not log on to the network as “Administrator,” the Login dialog box opens. Enter a user ID and password with RightFax administrative access. The RightFax Enterprise Fax Manager window opens. To quit EFM l On the File menu, click Exit. All of your changes and additions are saved. OpenText RightFax 10.6 Feature Pack 2 18 Administrator Guide Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM) To configure a RightFax service l Opening RightFax servers To open a RightFax server 1. To show a server name in the list, on the File menu, click Open Server. In the left pane, click the server, and in the right pane, right-click the service, and then click Configure Service. To create, delete, or modify administrative components l In the left pane, expand the server and then click the component type. l l To create a new object, on the Edit menu, click New. To edit or delete an object, select it in the list in the right pane, and on the Edit menu, click Edit or Delete. 2. In the Server Name box, type the name of the RightFax server to open. In the Protocol box, enter the network protocol used by that server. To display administrative components added or modified in FaxUtil l After one or more RightFax servers have been opened in EFM, the servers, by default, open each time you run the program. This default setting can be changed in Preferences. On the Edit menu, click Refresh. Opening RightFax servers To close a RightFax server You can open the same servers on all computers using a master list created on one computer: l 1. On one computer, a. Open the servers. As needed, move the servers into the desired position in the list. Click the server name and on the File menu, click Close Server. To move a server to a different position in the list 1. Click Fax Servers on the left. b. Export the list and save it to a text file in an easily accessible location. 2. In the tree view on the left or the server list on the right, drag the server into the desired position. 2. On all other computers, import the text file into EFM. The same servers open and appear in the same order a on the master list. To create a master list of servers 1. Make sure the servers you want are open and appear in the desired position. 2. On the File menu, click Export Server List, and then OpenText RightFax 10.6 Feature Pack 2 19 Administrator Guide Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM) Setting preferences save the serverlist.txt file to an easily accessible location. To open multiple RightFax servers from a master list 1. On each computer where you want to open the same servers, on the File menu, click Import Server List. 2. Browse to the serverlist.txt file, and then click Open. Any open servers close and the servers in the master list open. Setting preferences EFM has several customizable preferences. Always Prompt To open the Preferences window Before copying users, RightFax will prompt with this list of options and require a selection. l On the Edit menu, click Preferences. The Preferences window opens. Copy for InterConnect (no faxes or phonebooks) The user information will be copied and the users’ Routing Type will be set to RightFax InterConnect, pointing back to the server that the user was copied from. The User Copy Defaults settings The User Copy Default settings determine which information is copied when you drag selected users to another server in the list to copy them to the other RightFax server. For information about users, see Creating RightFax users on page 106. Not copied: faxes and phonebook entries. Copy without Faxes or Phonebooks The user information will be copied. Not copied: faxes and phonebook entries. To open the User Copy Defaults settings l Copy with Faxes and Phonebooks In the Preferences window, click the User Copy Defaults tab. Select one of the following options to specify what information is copied when copy users to another server.. The user information, faxes, and phonebook entries will be copied. Duplicate users will receive all faxes in the source account, even if these faxes already exist on the destination server, creating multiple copies of the same fax. Copy with Faxes Only The user information and faxes will be copied. Duplicate users will receive all faxes in the source account, even if OpenText RightFax 10.6 Feature Pack 2 20 Administrator Guide The Dialing Rule Copy Options settings The General Preferences settings The Dialing Rule Copy Options settings determine which information is copied when you drag selected dialing rules to another server in the list to copy them to the other RightFax server. All phonebook entries from the source user account will be added to the destination user account. Administrator Guide . Copy ‘Send Locally’ rules If selected. creating multiple copies of the same fax. these rules are ignored. Not copied: user information and phone book entries. the dialing rules on the destination server will be deleted before the dialing rules from the source server are copied to the destination server. Copy ‘Receive into Local’ rules Append Phonebooks Only If selected. In the Preferences window. Not copied: user information. OpenText RightFax 10.Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM) these faxes already exist on the destination server. creating multiple copies of the same fax. even if these faxes already exist on the destination server. Replace all rules on destination If selected. Otherwise. even if these faxes already exist on the destination server. dialing rules set to receive into the local server will be included. creating multiple copies of the same fax. click the Preferences tab. these rules are ignored. Setting preferences To open the Dialing Rule Copy Options settings l Not copied: phonebook entries. Append Faxes and Phonebooks All faxes and phonebook entries for duplicate users will be copied. To open the General Preferences settings l 21 In the Preferences window. click the Dialing Rule Copy Options tab. All phonebook entries for duplicate users will be copied. Append Faxes Only All faxes for duplicate users will be copied. see Creating dialing rules and Least-Cost Routing plans on page 185. Duplicate users will receive all faxes in the source account. Copy with Phonebooks Only The user information and phonebook entries will be copied. Not copied: user information and faxes.6 Feature Pack 2 The General Preferences settings set general preferences for views and actions in Enterprise Fax Manager. Otherwise. Duplicate users will receive all faxes in the source account. dialing rules set to send via the local server will be included. For information about dialing rules. Not copied: faxes. This option does not affect the column widths in any other EFM view. In the left pane. such as when an object with the same name is copied into the system. but the columns resize each time the screen image is refreshed. the user must confirm overwriting an object. Column Description Automatically adjust status display column width If selected.Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM) Viewing RightFax server information Use black and white icons Select this check box if your monitor is set to high contrast black and white. the user must confirm the deletion before an object. To view the status of all open RightFax servers Confirm object overwrites l If selected. Otherwise you have to open the servers each time. see Monitoring the status of RightFax servers and services on page 24 OpenText RightFax 10. If selected. Confirm object deletions Viewing RightFax server information If selected. Automatically re-open servers upon startup Enable database locked warning If selected. at the top of the list. a warning message appears when you make any changes to the state of any of the RightFax services. The right pane shows the following information about each open server. click Fax Servers. the widths of the columns in the Server Status and Services pane will be adjusted to fit the column’s contents.6 Feature Pack 2 22 Administrator Guide . You can still manually adjust the column widths. the servers that were open when you last quit EFM will be opened upon startup. such as a user or library document. For information about the Server Status and Services pane. is deleted. a warning message appears when you attempt to access the database when it has been locked by certain database management tools. a warning message appears when a user is created with a routing code already assigned to another user. Enable duplicate routing code warning If selected. This changes the EFM server status icons to colors that can be read in this color mode. Enable service control warning If selected. Yellow . Version The version of the RightFax server software. OpenText RightFax 10. For more information on the RightFax Event Queue. and to sort the objects in a list. Determine a block of routing codes sufficient for the entire system and decide upon any custom notification types desired. l l l The higher the number. Consider groups within the organization. make sure you plan the structure and anticipate the needs of your network users. Queue usage The percentage of the fax server’s internal Event Queue that is currently in use. Create new objects in RightFax only after you carefully consider these issues. group or department cover sheets. Time running The length of time that has elapsed since the RightFax Server service was last started.6 Feature Pack 2 The relative availability of the server’s fax boards expressed as a number. Working with objects Fax board availability index An icon to the left of the name indicates the status of the RightFax service. Character set mode The OEM or ANSI code page being used by the server. the more available the server is for sending faxes. 23 Administrator Guide . Serial Number The serial number entered when the RightFax server was installed. The code page determines the language character sets that are supported for fax conversion. RightFax sends the fax via the server with the highest availability index.All services are running normally. Green . Display is in the format DDDD:HH:MM:SS.Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM) Server name The name of the open RightFax server and network protocol. RightFax uses this value when an outgoing fax number has two equally weighted dialing rules that send it to two different servers. You must provide this number when you contact OpenText Customer Support. Normal fax operations are available. Red .One or more services are not running. move columns. Working with objects You can use standard Windows procedures to select objects.One or more services are not running. Before adding objects. Normal fax operations are not available. and who will act as administrator or alternate administrator for the group. see RightFax Internal Event Queue on page 16. click Update Now to recompile and update the server statistics. the top line of this window shows the most recent update time for the data display. RightFax sends the fax via the server with the highest Availability Index. Current Faxes Queued for Sending The current number of outgoing faxes waiting to be sent. If you logged on to EFM as administrator from a client machine. EFM shows statistics and fax channel information and manages services on each RightFax server. RightFax uses this value when an outgoing fax number has two equally weighted dialing rules that send it to two different servers. In such a case.6 Feature Pack 2 24 Current Pages Queued for Sending The current number of outgoing fax pages waiting to be sent. The following server statistics are available: Note Remote DocTransports can be displayed in EFM but will not include data. OpenText RightFax 10. Fax Availability Index The relative availability of the fax boards on the server. To view and manage the status and services of each RightFax server l Click the name of the server. Server Statistic Description RightFax Event Queue Usage The percentage of the fax server’s internal Event Queue currently in use. Administrator Guide . All-Time Send Attempts The total number of faxes sent from this server since the AllTime Counter Starting Date. the more available the server for sending faxes. The higher the number.Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM) Monitoring the status of RightFax servers and services Monitoring server statistics Monitoring the status of RightFax servers and services Statistics about the server appear in the lower-left corner in the right pane of the window. seeRightFax Internal Event Queue on page 16. For more information. This button is only active from the client software. If you are viewing EFM from the server. RightFax Events Processed The total number of events processed by the fax server since the Server module was started. Each fax channel that is available on this RightFax server. Note All of the All-Time statistics report an error message if you are running fax boards in simulation mode. l Right-click the service. User ID The destination user ID of this fax channel for incoming faxes. All-Time Pages Received The total number of fax pages received on this server since the All-Time Counter Starting Date. Monitoring queues Fax channel information Description Channel You can display a list of RightFax queues that show actions that are currently in process. OpenText RightFax 10.com/enus/sqlserver/default. and then select Start all Services or Stop all Services from the shortcut menu. Starting and stopping services To monitor the health and performance of the SQL Server for your RightFax Server l To start or stop a service Use the Microsoft SQL tools.Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM) All-Time Pages Sent The total number of fax pages sent from this server since the All-Time Counter Starting Date. All-Time Faxes Received The total number of faxes received on this server since the All-Time Counter Starting Date.6 Feature Pack 2 Right-click any service. and its startup method (manual or automatic).microsoft. To start or stop all services in the appropriate sequence Monitoring fax channel information l Information about the fax channels on the server appears in the upper-right corner in the right pane of the window. 25 Administrator Guide . and then select Start Service or Stop Service from the shortcut menu. the length of time it has been running. Monitoring services The lower-right pane of the window lists each RightFax service. Routing Code The inbound routing code of this fax channel for incoming faxes. All-Time Counter Starting Date Monitoring the status of RightFax servers and services Operation The current operational status of each channel. The starting date from which the “All-Time” statistics are calculated. its status (running or stopped). Note Monitoring services on remote servers requires network administrative access to the server as well as RightFax administrative access. See your SQL documentation or the Microsoft site at http://technet. the number of items in the queue is shown. PCL5 conversion requests Number of requests to convert PCL documents. The following queues appear: Displayed queue Description Pending conversion results Number of results from WorkServer conversions not yet processed by a Server module.Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM) To view the queues l In the left pane. Total server events Total number of events currently scheduled on a Server module. The queues appear in the right pane. Documents in queue on FaxServ (s) Total number of document-related events currently scheduled on a Server module. Documents in queue on DocTransport(s) (on DocTransport. in the Fax Servers list. and then click Queues. including compound requests for multiple types of conversion. Total documents All documents in the system. Deleted documents All documents flagged in the database as deleted. click the server. but not yet processed by a Server module. Gateway route requests Number of requests from a Server module to gateways to pick up documents. Conversion events Number of events in the queue that are preparing an outbound fax to be scheduled for transmission. Documents sent by DocTransports(s) (send completed but not yet discovered by a FaxServ) Number of documents sent by DocTransport.6 Feature Pack 2 Monitoring the status of RightFax servers and services Transmission check events Number of "Scheduled to be sent" and "Sending" documents that are pending Server module action. System messages in the database Messages from a Database module to a Server module that have deferred fax processing. Coversheet creation requests Number of requests to create cover sheets. Associated value fluctuates based on the days to keep deleted fax records setting of each user group. For each queue. not yet sent) Number of documents on DocTransport scheduled to be sent. General purpose conversion requests Number of requests to convert documents from any format. 26 Quick kicks from Database module to Server module Messages kicked by a Database module and passed to a Server module. Postscript conversion requests Number of requests to convert Postscript documents. OpenText RightFax 10. with the Value column showing the numeric and the Scale column showing the graphic format. Administrator Guide . save them. and then copy them to the other nodes. Using RightFax email gateways on page 262 or respectively: Server Module All settings. start RightFax Enterprise Fax Manager. The following table shows the services and settings that will be copied. exclude this server. 3. except event log level settings. except service account and logging settings. you can create service configuration settings on one server. right-click the name of the service. you can save time by creating the service configuration settings on one server. 27 Administrator Guide . and service account settings. A configuration window opens. 2. except event log level. saving them.Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM) Configuring services l Configuring services Copying service configuration settings to other nodes Double-click the service. and then click Copy Settings to Other Nodes. AutoReply Responding to inbound faxes with AutoReply on page 1 Integration Module All settings. The RightFax Integration Module Administrator Guide. To configure … See… RightFax Server Configuring the RightFax Server module on page 31 DocTransport Configuring the DocTransport modules on page 61 Service WorkServer Configuring the WorkServer modules on page 48 Conversion Engine All settings.6 Feature Pack 2 Settings copied The other nodes in your shared services environment appear in the Copy the current settings to these shared services nodes list. and then copying them to the other nodes. RightFax email gateway l l RightFax Integration The RightFax Connector for Microsoft Exchange Administrator Guide. Click the name of the RightFax server that has the desired settings. In a shared services environment. To copy the configuration settings of a service to other nodes The RightFax Lotus Notes Module Administrator Guide . except logging settings. Sync Module All settings. you can change the service accounts used for the different services. 1. OpenText RightFax 10. except logging settings. While configuring a service. In the Service Name list. In a shared services environment. Remoting Service All settings. On the RightFax server. To view the service account settings l On the Data Sharing tab in the Server Configuration window or the configuration window of another service. The default is to use one of the To change service accounts 1. In the Service Account Editor window.6 Feature Pack 2 28 Administrator Guide . first modify the Server Service Account. For each service. Changing service accounts predefined accounts. and then click OK. OpenText RightFax 10. for all services. You can use a separate account for each service or a single account for multiple services. One service account is initially selected during the RightFax installation. click Modify. the service account used must have access to all the network resources required by that service. first set the account for the Server Service and then copy the settings to the other services. To define account settings once and then copy them to all other services. To change service accounts. click Select Service Account. Changing service accounts You can change the service accounts used for the services while configuring a service. Clear the check boxes of those nodes to which the settings should not be copied. next to the account you want to change. The Service Account Editor window opens. showing for each service the currently defined account.Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM) 4. click OK. you may encounter errors in services performed by the WorkServer. As needed enter the case-sensitive password for the selected user account in both the Password and Confirm Password boxes. make the following entries: On the Utility menu. without change of schedule. and then click ASAP. click Object Types. and then either type a new service account name or click Browse to find all user accounts on a specified network. select the user by clicking Browse. 5. and then select Built-in security prinicipals. and then click Check Names. and then click OK. and then click OK. Caution If you manually type a name that is longer than 15 characters. In the text box. click Synchronize External Systems. click Copy to all. enter a name or partial name. You can force the server to synchronize immediately. l Synchronizing the RightFax server with external systems Click This Account. Do one of the following: l Click Built-in Account. Users. You can remotely manage your RightFax servers using the Web-based version of Enterprise Fax Manager (EFM). To change the types of objects to search for. 4. The RightFax WorkServer modules synchronize with external systems such as the Kofax NetScan user tables.6 Feature Pack 2 29 Administrator Guide . and import files for billing codes on a periodic. select one of the accounts from the list.Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM) Synchronizing the RightFax server with external systems c. To change the location to search. or both. Running Enterprise Fax Manager Web Edition a. To force the server to synchronize l In the Select User window. EFM Web Edition is included with all RightFax servers but must be installed separately on an IIS server on your OpenText RightFax 10. and then select a location. scheduled basis. To copy the Server Service account information to the other services. 3. 2. After entering or selecting an account. A list of account names appears from which to choose. library document catalogs. click Location. Click OK. b. If the desired user account resides on a domain whose name is longer than 15 characters. Managing RightFax servers in EFM Web Edition is similar to managing RightFax servers in EFM for Windows. see the RightFax Installation Guide.Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM) Changing service accounts 3. Enter your logon information to log on to the IIS server. Enter the name of the RightFax server and a RightFax user ID and password that has administrative access to the RightFax server. network. Example http://server. references to EFM describe the Windows version of EFM. select the language. In almost all cases. Throughout this guide. 4. To open Enterprise Fax Manager Web Edition 1. Click Logon RightFax Server. the instructions also apply to the Web Edition.domain. The RightFax server opens in the frame in the left side of the page. For more information. Open a Web browser and point the URL to the /webefm folder on the IIS server. and then click OK. The browser prompts you for information to open a RightFax server. 5.6 Feature Pack 2 30 On the Language menu in the upper-right corner of the page. Administrator Guide . Unless your IIS server is configured to allow anonymous access. To change the language of EFM Web Edition l OpenText RightFax 10.com/webefm 2. a logon dialog box appears. and notifications about document processing and server status. Configuring the general settings To open the general settings l CSID data is information about the calling party sent to the fax board by the phone company. To configure the RightFax Server module 1. start RightFax Enterprise Fax Manager. 2. click the General tab. click the name of the RightFax server.The list of services appears at the lower-right pane of the window. For more information. 3. and can be anything from a phone number to a company name. You can configure the RightFax Server module to customize global fax settings. Enable CSID Routing Select this check box to enable automatic inbound routing using CSID (caller subscriber identification). The Server Configuration window opens. and works with the RightFax DocTransport module to schedule outgoing faxes and route inbound faxes. In the Server Configuration window. inbound fax routing.Chapter 5: Configuring the RightFax Server module Configuring the general settings Chapter 5: Configuring the RightFax Server module The RightFax Server module manages the network print queues assigned to faxing. double-click RightFax Server Module.6 Feature Pack 2 31 Administrator Guide . The CSID is different for each caller. OpenText RightFax 10. On the RightFax server. In the left pane. see Starting Enterprise Fax Manager on page 18. controls the conversion of outgoing faxes. In the list of services. Faxes with errors will still be available through FaxUtil with the status "Incompletely Received. If you select to enable quick headers. l Terse Critical errors only. and fax ID at the top of each fax page. See Notify_Freq on page 350. Clear the check box if you are using a load balancing solution for your client connections. time. l Normal Errors and major events only." Enable Notifications Event Log Level Select this check box to send notification messages to RightFax users based on the notification options specified in FaxUtil. Auto Delete Failed Gateway Faxes Create New User when Printing to the Fax Queue Select this check box to remove faxes that fail gateway routing. To send faxes without delay. Delay All Faxes Until Specify the time of day after which all faxes sent by users without RightFax administrative access will be sent. Enable Quick Headers Select this check box so that a second line can be added below the TTI line and to apply quick headers to all outgoing faxes. modify the Notify_Freq keyword in the Windows Registry. The TTI line lists the date. For more information on CSID routing and creating a CSID routing table see Configuring CSID routing on page 223. For more information on groups.6 Feature Pack 2 Verbose All significant events. l Caution Leaving the verbose log level for long periods of time can fill up the Event Log and may prevent new events from being logged. you can customize the text in the DocTransport module (see Configuring Brooktrout global transport settings on page 64). To change this interval. OpenText RightFax 10. RightFax uses the user ID called "Default" as a template when creating new users. Use temporarily to track and resolve problems. Enable Shared Services client failover Select this check box to supply client applications in a Shared Services environment with a list of alternative servers to connect to.Chapter 5: Configuring the RightFax Server module If you select to enable CSID routing. Select at which level to log information in the Application Event Log under the service name “RightFax Server Module. The RightFax client application writes the list of currently active members to its local registry. see Creating groups of users on page 124. Note By default. Disable Routing of Faxes with Errors Select this check box to prevent routing of incomplete faxes through an email gateway or network directory. Select this check box to assign a new RightFax user ID to network users who print to the fax queue but do not have a RightFax user ID. you must create a CSID routing table listing RightFax routing codes and the CSIDs to route to them. page number. Forced delays can also be set for groups of RightFax users.” l None No information. the RightFax server sends periodic notifications to users every five minutes. total pages. 32 Administrator Guide . select None Set. select Duration. select Once. Reminder notifications settings Interval The settings under Reminder Notifications determine if and when different user types are sent reminders of faxes not yet viewed or printed and of faxes needing approval. By default. the settings for the next user type come into effect. Reminders will be sent in this sequence While a fax is being retried. SMS Count Specify the number of times an outgoing notification will be attempted.Chapter 5: Configuring the RightFax Server module When using notifications. it appears with a yellow status icon in the sender’s FaxUtil mailbox.6 Feature Pack 2 l 33 Administrator Guide . Reminder notifications are escalated from user to group administrator and from group administrator to alternate group administrators. enter a number for the time interval at which to send reminders. files in the image directory are stored in compressed graphic image (CCITT Group III) format and are not encrypted. Retry settings The settings under Retry Settings determine how many times an outgoing fax transmission and outgoing notification will be attempted in case of a non-fatal error. Alternate Group Administrator) specify if reminder notifications should be sent. The sender can force RightFax to For each user type listed (User. After notifications have been sent or not sent according to the settings for one user type. such as a busy signal. You can encrypt the image directory if you have a license to do so. Count Specify the number of times an outgoing fax transmission will be attempted. Specify the minimum delay in minutes before a failed notification is rescheduled to send. Send reminders every SMS Interval In the minutes box. specify how often to send reminders to users and administrators that a fax has not yet been viewed or printed. select Never. OpenText RightFax 10. enter in minutes for how long this user type will receive reminder notifications. Note The count of attempts includes the first attempt. Caution This check box cannot be cleared after you select it and confirm the selection. it will be abandoned and saved in the sender’s FaxUtil mailbox with a red status icon. To not send reminders to this user type. You are asked to confirm the selection as this setting cannot be changed after it has been made. l Encrypt Image Directory Select this check box to store all files in the image directory in encrypted format so that they can only be viewed using RightFax applications. l To send a reminder once. If the fax has not been successfully sent after the specified number of attempts. Group Administrator. See Reminder notifications settings on page 33. Specify the minimum delay in minutes before a failed fax transmission is rescheduled to send. To send multiple reminders. and in the minutes box. In the days box. but do not prevent faxes from being sent. Select at which level to log information in the Application Event Log under the service name “RightFax Database Module:” l None No information. and purging). billing codes can be added. the fax will not send and the user will receive notification that the fax did not send due to an invalid billing code. OpenText RightFax 10. Purge audit data older than Select to specify when to purge audit data. Choose a time with low server activity.Chapter 5: Configuring the RightFax Server module Configuring the advanced settings manually retry sending the fax by selecting the fax and pressing CTRL+K. Maintenance cycle Scheduled Time Enter the time of day when the server will perform its daily maintenance (such as automatic file backup. If a billing code cannot be validated. Caution Leaving the verbose log level for long periods of time can fill up the Event Log and may prevent new events from being logged. Billing code settings Billing code settings can be changed without stopping and restarting the RightFax services. Exclude this server In a shared services environment. l Terse Critical errors only. enter the number of days after which to purge the data.6 Feature Pack 2 34 Administrator Guide . Database settings Validate from Email Gateways Event LogLevel Select this check box to validate all billing codes added to fax-bound email messages. l l Configuring the advanced settings Verbose All significant events. If this check box is cleared. Use temporarily to track and resolve problems. click the Advanced tab. In the Server Configuration window. select this check box if maintenance should not be run on this server. fax aging. To open the advanced settings l Normal Errors and major events only. Clear it to use the default OEM code page and character sets. see the RightFax XML GeneratorAdministrator Guide or the RightFax Vault Administrator Guide. not just billing codes.]. see Changing the connection to the SQL server on page 302. Select the Enabled check box. All servers on the RightFax system must point to the same MSMQ Server. ANSI Mode Select this check box to use the ANSI code page for the character sets used in faxed documents.. In all other cases. Separate Validation Select how required billing codes will be validated against the RightFax database: l l l l Both Fields Both the Billing Code 1 and the Billing Code 2 field must contain valid codes. For more information on changing and editing the connections to the RightFax database on the SQL server. This gives the user the ability to validate faxes based on several different criteria. Character Set Mode Field 1 or Field 2 One of the billing code fields must contain a valid code. External document connector RightFax installed on non-English language operating systems such as German or Turkish may not display special characters (such as umlauts) correctly. The external document connector is used to: MSMQ server l l Integrate RightFax and third-party systems such as FileNet. Web delivery To integrate RightFax with a third-party system Specify the web application that will open faxes for web delivery and the IIS server where it is installed.com. For information on downloading and using the RightFax API. Field 2 Only The Billing Code 2 field must contain a valid code. Enter the name of the server on which the Microsoft Message Queue service is installed. clear the check box. Selecting the ANSI code page can resolve this. This requires a program written using the RightFax API to perform the verification of billing codes. Field 1 Only The Billing Code 1 field must contain a valid code.opentext. visit the OpenText Knowledge Center at knowledge.. For information about the remaining external document connector settings. OpenText RightFax 10. Save faxes with XML metadata to be used by an external archiving or document management system. SQL connections These fields display the connection strings that define the RightFax server’s connection to the SQL database. To make changes to either SQL connection click [.6 Feature Pack 2 35 Administrator Guide .Chapter 5: Configuring the RightFax Server module Configuring the advanced settings Use External Validation To save faxes with XML metadata Select this check box to have RightFax use an external program to verify billing codes on outbound faxes. but not both. For more information on upgrading your server license. if necessary. The link and URL provided in the email notification will open the fax in Web Access. Select to send the link as a secure ("https://) HTTP link. then Open Text. In the Server Configuration window. In the Service Name list.6 Feature Pack 2 36 Administrator Guide .The list of services appears at the lower-right pane of the window. Click the name of the RightFax server in the tree in the left pane of the Enterprise Fax Manager window. OpenText RightFax 10. Configuring custom messages Configuring feature activation You can customize the text of messages that are sent for fax status notifications for users (described in The Notification tab on page 120). refer to the RightFax Installation Guide. The status shows the enabled services with information about each license. Use SSL 3. The Licensing Service Status dialog box opens. Provide link to Specify the web application for web delivery of faxes: l l 4. double-click RightFax Licensing Service (or right-click and choose Status from the menu). To launch the Product Licensing Utility (PLU) 1. 2. Click Product Licensing Utility. and then click RightFax Enterprise Fax Manager.Chapter 5: Configuring the RightFax Server module Configuring feature activation 2. Web Access. click the Feature Activation tab. Use the scroll bars to view additional services. on the Start menu. IIS server Enter the IIS server where Web Access or Web Client is installed. On the RightFax server. The link and URL provided in the email notification will open the fax in Web Access. To show the current licenses on a server 1. adding additional fax channels. Web Client. Use the Product Licensing Utility (PLU) to change or add to your feature set. point to Programs. and adding new RightFax components. If you are unsure about the current licenses on a server. you can look them up in Enterprise Fax Manager. 6 Feature Pack 2 A bad form was specified. The variable options for each message are described in the following table. ~3 = Unique ID of the fax The server cannot generate a fax image. If you include a URL. ~2 = Recipient’s name ~3 = Recipient’s fax number ~4 = Billing code 1 When used ~5 = Billing code 2 ~2 = Recipient’s fax number The fax starts to send or is still sending after a few minutes. The maximum length of a notification message is 200 characters.Chapter 5: Configuring the RightFax Server module Configuring feature activation Notification messages can contain a combination of text and variable data. 37 Administrator Guide . the maximum length is for both the URL and the message text. The maximum length of the URL is 80 characters. ~4 = Subject line of original fax ~3 = Recipient’s fax number ~4 = Error encountered ~5 = Unique ID of the fax ~6 = Subject line of original fax email Bad form type ~1 = User ID ~2 = Unique ID of the fax OpenText RightFax 10. ~6 = Unique ID of the fax ~7 = Subject line of original fax email ~3 = User ID Bad fax phone ~1 = User ID number ~2 = Fax phone number ~4 = Recipient’s company Imaging error Notification message ~1 = User ID ~2 = Recipient’s name The fax number contains invalid characters. Notification message Variable options Sending fax ~1 = Recipient’s name Variable options When used Ready for preview ~1 = User ID The fax was held for preview and is now ready. 6 Feature Pack 2 38 Administrator Guide .Chapter 5: Configuring the RightFax Server module Notification message Variable options Too many retries ~0 = Unique ID of the fax The fax was abandoned after the maximum ~1 = Recipient’s name number of send attempts. ~2 = Recipient’s fax number Configuring feature activation When used Notification message Variable options When used Sending error ~0 = Subject line of original fax email The fax could not be sent. original fax email ~A = Subject line of original fax email Invalid billing code ~1 = User ID ~2 = Billing code 1 The sender did not provide a valid billing code. ~3 = Billing code 2 ~4 = Unique ID of the fax ~5 = Subject line of original fax email OpenText RightFax 10. ~1 = Recipient’s name ~2 = Recipient’s fax number ~3 = Fax error code ~3 = Fax error code ~4 = Number of retries ~4 = Number of retries ~5 = User ID ~5 = User ID ~6 = Billing code 1 ~6 = Billing code 1 ~7 = Billing code 2 ~7 = Billing code 2 ~8 = Recipient’s company ~8 = Recipient’s company ~9 = URL link to the fax on the RightFax server (this option can only be used with RightFax email gateway) ~9 = Unique ID of the fax Incomplete fax ~1 = User ID The sender did not complete all of the ~2 = Unique ID of the fax required fax information ~3 = Subject line of fields. ~3 = Recipient’s fax number ~4 = Unique ID of the fax ~5 = Subject line of original fax email OpenText RightFax 10.Chapter 5: Configuring the RightFax Server module Configuring feature activation Notification message Variable options When used Notification message Variable options When used New fax ~1 = Number of pages received A new fax was received. Successful send ~1 = Recipient’s name The fax transmission was successful. Fax needs approval ~1 = User ID ~2 = Recipient’s name One of the sender’s outgoing faxes needs approval. ~2 = User ID ~3 = Received remote ID ~3 = Recipient’s company ~4 = TeleConnect ID ~4 = URL link to the fax on the RightFax server (this option can only be used with a RightFax email gateway) ~5 = Unique ID of the fax ~6 = URL link to the fax on theRightFax server (this option can only be used with a RightFax email gateway) ~5 = Unique ID of the fax ~6 = Fax transmission speed ~7 = Fax transmission speed ~7 = Subject line of original fax email ~8 = Fax status Viewed or printed fax ~1 = User ID ~2 = Unique ID of the fax ~2 = Recipient’s fax number A received fax has not been viewed or printed.6 Feature Pack 2 39 Administrator Guide . Fax numbers can be blocked using either dialing rules or the call blocking Windows Registry entry on the DocTransport. and then click OK.Chapter 5: Configuring the RightFax Server module Configuring user messages Notification message Variable options When used Notification message Fax number blocked ~1 = Recipient’s name The recipient’s fax number is blocked by the RightFax DocTransport. ~9 = Unique ID of the fax To return a notification message to the default setting.6 Feature Pack 2 40 Administrator Guide . Fax blocked by ~0 = Subject line of Do Not Dial original fax email ~2 = Recipient’s fax number ~3 = Fax error code ~4 = Number of retries ~5 = Billing code 1 ~6 = Billing code 2 ~1 = Recipient’s name ~2 = Recipient’s fax number ~3 = Fax error code A fax was not sent because the destination fax number was blocked by the Do Not Dial feature. (described on The DnD Notifications tab on page 195. The next time you open the dialog box. the default message will be listed. Users receive pager/SMS notifications only if they have been configured to do so in the Pager Notification tab of their user configuration in Enterprise Fax Manager (described in Creating a user profile on page 108). For more information ~7 = Subject line of original fax email OpenText RightFax 10.) ~5 = Billing code 1 ~6 = Billing code 2 ~7 = Recipient’s company ~8 = URL link to the fax on the RightFax server (this option can only be used with RightFax email gateway) ~8 = Unique ID of the fax ~9 = Subject line of original fax email ~3 = Fax error code When used ~4 = Sender’s user ID ~7 = URL link to the fax on theRightFax server (this option can only be used with RightFax email gateway Human ~1 = Recipient’s name Answered Fax ~2 = Recipient’s fax number Variable options The fax was canceled (not accepted) by the recipient when the recipient responded to the RightFax voice prompt. select the text. delete it. ~4 = Number of retries ~5 = User ID Configuring user messages ~6 = Unique ID of the fax You can replace the default pager/SMS fax notification messages for users with customized messages. Alert Variables When used New fax received ~1 = Page count ~2 = CSID or ANI of sender ~3 = TeleConnect ID ~4 = CSID ~5 = ANI Sent to a RightFax user when a new fax is received. select the text. delete it. and then click OK. described in the following table.Chapter 5: Configuring the RightFax Server module Configuring feature activation on configuring SMS and pager notifications. The next time you open the dialog box. To return a notification message to the default setting.6 Feature Pack 2 Recipient has been sent a fax ~1 = From name ~2 = To name Sent to the fax recipient to notify that a fax has been sent from the RightFax server. the default message will be listed. The fax recipient notification address is entered by the RightFax client user when creating a new outbound fax. Alert Variables Outgoing fax ~1 = Recipient’s name abandoned ~2 = Recipient’s fax number When used Sent to a RightFax user whose outbound fax has failed to send for any reason. 41 Administrator Guide . ~3 = Short error description (last attempt) ~4 = Send attempts ~5 = Owner ID ~6 = Billing code 1 ~7 = Billing code 2 ~8 = Recipient’s company ~6 = URL link to the fax on the RightFax server (this option can only be used with RightFax email gateway For each user message type. see Adding SMS and pager services on page 161. OpenText RightFax 10. Each message type has its own set of variables. enter the custom message text you want. For information about configuring SMS and pager notifications in RightFax. load:~3. Disk space getting low One or more drives on the None fax server are approaching critically low disk space (<150MB).6 Feature Pack 2 42 Administrator Guide . Configuring admin messages Use the options on the Admin Messages tab in the Server Configuration window to customize the text of SMS or pager administrative alerts (described in Creating a user profile on page 108). Each message type has its own set of available variables. enter the custom message text you want. Many fax server functions have been suspended. see Using the Alerting and Monitoring service on page 165. rcvd:~5.Chapter 5: Configuring the RightFax Server module Configuring admin messages For each admin message type. described in the following table. Fax server ~1 up for ~2 (d:h:m:s). Fax machine running sending and receiving operations are functioning on other DocTransports. and alert messages to send. none down. Fax sending and running receiving is not currently operating. ~1 = Fax server name ~2 = Up time (dd:hh:mm:ss) ~3 = Fax server internal queue usage ~4 = Total faxes sent since install date ~5 = Total faxes received since install date OpenText RightFax 10. faxes sent:~4. Alert Default message BoardServer All DocTransports are failed. alert types. RightFax Enterprise includes a more comprehensive Alerting and Monitoring service where you can select from hundreds of server statistics to monitor and define the event thresholds. Heartbeat (periodic status including statistics on fax activity). Variables None BoardServer The DocTransport on ~1 ~1 = DocTransport failed. For more information about the RightFax Alerting and Monitoring service. see Adding SMS and pager services on page 161. one is no longer running. Disk space critically low One or more drives on the None fax server are critically low on disk space (<50MB). Configuring data sharing ~2 = Queue depth (pages) ~3 = DocTransport machine Server shutdown incorrectly The fax server process was not properly shut down. None Send queue too deep ~1 = Queue depth (faxes) The send queue depth on server ~3 is currently: ~1/~2 (faxes/pgs). In the Server Configuration window. To return a notification message to the default setting. Installing and configuring multiple RightFax servers to share a RightFax database and corresponding resource folders increases the capacity of your RightFax servers. and then click OK. The following table lists and describes the shared data folders.Chapter 5: Configuring the RightFax Server module Alert Default message Variables Internal The fax server internal queue queue is more than 90% reached 90% utilized. Select the Use this root path for all file types check box to use a single path for all file types or select for each file type the folder that must be shared. Signatures SIG Contains graphic images of user signatures for placement on faxes. None Probable bad Probable bad phone line line detected. Configuring data sharing The Data Sharing tab shows the folders that must be shared among all RightFax servers in a shared environment. The next time you open the dialog box. the default message will be listed. Field Folder Name Description Images IMAGE Contains sent and received faxes stored as compressed graphic image files. click the Data Sharing tab. select the text.6 Feature Pack 2 43 Administrator Guide . OpenText RightFax 10. To configure data sharing 1. ~1 = Fax server name 2. Specify the file paths for the resource files. delete it. To specify this account. Attachments BFT Contains text files created by the OCR process. Configuring eTransport Account. or network access to a local drive on one of the RightFax servers. Open the Windows Registry on the RightFax server. 2. If they do not exist. click Select Service OpenText RightFax 10. Share permissions must be given to the account used to run both the Server module and DocTransport module. This account must have full control of these folders. Troubleshooting performance issues with Windows Server 2008 and 2008 R2 If you use data sharing and encounter performance issues. To save all sent and received faxes to two image folders. Outgoing Files OUTGOING Contains outbound files from all submission methods that are held while being processed into fax images. 3. such as temporary fax queue spool files. 3. such as a storage area network (SAN).6 Feature Pack 2 44 Administrator Guide . network share on file server. you can try to address the issue by setting the following two Windows registry keys to zero to disable the caches DirectoryCacheLifetime and FileNotFoundCacheLifetime. The folders must be accessible to all the servers in the shared configuration. Browse to the subkey of HKEY_LOCAL_ MACHINE\System\CurrentControlSet\ Services\Lanmanworkstation\Parameters Native Documents CMDDATA Contains transaction files for each fax sent via email or via SecureDocs. 4. To set the registry keys 1. See Selecting a service account on page 53. l DirectoryCacheLifetime l FileNotFoundCacheLifetime Configuring eTransport The eTransport options configure the server to send outbound fax documents to email addresses in addition to fax numbers.Chapter 5: Configuring the RightFax Server module Field Folder Name Description Forms PAPERS Contains the names of overlay form files. select the Use second image path check box. and then specify the file path for the second image folder. create the following REG_DWORD entries and edit them to contain a value of 0 (zero): Each of these folders can be located in common disk storage. Account and Password 2. refer to the RightFax SecureDocs Module Administrator Guide. leave the Account and Password fields blank. Do not use TLS security on the SMTP server. 3. SMTP service extensions start an SMTP session by issuing the EHLO command instead of the HELO command. Email Subject You can customize the subject line of messages sent through the eTransport module. RightFax users using the FaxUtil client will not have the option to address fax documents to an email address. 4. Use the following variables: l ~1 = Page count l ~2 = Sender's name. Leave this window open. From FaxUtil.6 Feature Pack 2 45 Administrator Guide . If the specified server uses anonymous access. select debug to open a command prompt window. Right-click the eTransport service. SMTP Hostname Enter the name of the SMTP mail server to which outbound documents sent to email addresses via the RightFax client applications will be sent.Chapter 5: Configuring the RightFax Server module Configuring data sharing SMTP service extensions (ESMTP) If the SMTP mail server uses SMTP service extensions. If the specified server uses basic or Windows Integrated Security. enter the user name (in the format Domain\Username) in the Account field and the password for that account in the Password field. Web Server Enter the Internet host name of the machine running the IIS server that the RightFax SecureDocs module is installed on. OpenText RightFax 10. Check the open debug window for potential error messages. If no SMTP mail server is specified here. From EFM. This field is required if you have installed the RightFax SecureDocs module. select this check box. The default message is: E-Document: ~1 page from ~2. For more information on this option and configuring RightFax for certified document delivery. To verify that eTransport is configured correctly 1. stop the RighFax eTransport service. Note Anonymous authentication requires relay to be enabled on the SMTP server. submit an email. and then click Start. called modules.Chapter 5: Configuring the RightFax Server module Starting and stopping the RightFax server Note Never start the RightFax Database. and then click Start. 46 Service name Short name Startup Description RightFax Conversion Engine RFIsoConv Auto Configurable server that controls conversion of Office. it can be stopped and started as needed. and then click Stop. HTML. These services are configured and started during installation. and then click Start. RightFax Sync module CapaSync Auto Configurable server that controls one-way synchronization from Active Directory or LDAP data sources. To stop the RightFax server at a command prompt 1. be sure to select Classic View in Control Panel. Click RightFax DocTransport Module. and the RightFax WorkServer modules. You should only need to stop and start RightFax services during server or network maintenance. type the following: l 2. or Email Gateway modules separately. net stop serviceshortname (for example. They must be started by the RightFax Server module. Starting and stopping the RightFax server The RightFax server includes several services. do the following: l Starting or stopping the RightFax server requires starting or stopping the separate processes. RightFax Server module. To start the server at a command prompt In a command prompt window at any prompt. About the services 4. enter the following command: net start serviceshortname (for example.6 Feature Pack 2 Click RightFax Server Module. net stop rfemail) 3. net start rfserver) OpenText RightFax 10. From a command prompt. and OCR documents. Note To view the RightFax control panel icons on x64 systems. On the Start menu. This starts the RightFax Database module. l To start the server using the Services program Click RightFax DocTransport Module. and then click Stop. WorkServer. To stop the RightFax server using the Services program In the Services program. The following table describes each RightFax service and tells whether the service is started automatically or manually by Windows on startup. Click RightFax RPC Server Module. under Administrative Tools. Click RightFax Server Module. Administrator Guide . Note that if the startup is automatic. click Services. RightFax Server module RFSERVER Auto The bridge between all other RightFax services.Chapter 5: Configuring the RightFax Server module Service name Short name Startup RightFax RFDB Database module Manual RightFax DocTransport module RFDOC TRANS RightFax Licensing RFLicensing Auto RightFax eTransport RFMIME RightFax Email RFEMAIL Gateway module Auto Description Service name Short name Startup Description A multi-threaded module that handles communication between the database files (located in the RightFax\Database folder) and the fax clients. OpenText RightFax 10. Manages license distribution for RightFax services. RightFax Queue Handler RFQUEUE Auto Monitors the RightFax print queue for jobs to be forwarded to the server for fax conversion. RightFax Integration module RFPROD Auto Allows applications on a mainframe to send custom faxes through the fax server. Manual The communication bridge to an optional email gateway. RightFax Remoting RFRemote Auto Handles communication with remote RightFax services and applications. Allows configuration of the methods by which RightFax will transmit documents. RightFax RPC Server module RFRPC Auto The communication bridge to fax clients that use IPX. and email gateway modules. RightFax Paging module RFPAGE Auto Monitors RightFax for pager notification events and handles communication between RightFax and the SMS or pager services.6 Feature Pack 2 Starting and stopping the RightFax server 47 Manual Administrator Guide . and optical character recognition. RightFax WorkServer modules RFWORK# One or more modules responsible for RightFax’s most processor-intensive functions such as cover sheet generation. Database. SPX or TCP/IP via remote procedure calls. Also responsible for stopping and starting the WorkServer. PCL5to-fax conversion. Manual Automates delivery of email documents from the fax server. Click the WorkServer number in the left pane. 4. you can send and receive fax documents and you can customize the WorkServer modules to meet the needs of your enterprise. Each WorkServer is configured separately. They regularly query the Database module for jobs to be performed. With the default configuration of the RightFax WorkServer modules. showing all Workservers in the left pane. If this check box is selected. the WorkServer service will not be started automatically by the RightFax Server service. In the list of services. see Starting Enterprise Fax Manager on page 18.6 Feature Pack 2 48 Administrator Guide . 3. Configuration window opens. On the RightFax server. Remote WorkServer Service 2. To configure the RightFax WorkServer modules 1. start RightFax Enterprise Fax Manager. execute those jobs. see Configuring Kofax NetScan on page 56 and Configuring PeopleSoft on page 57. click the name of the RightFax server. For more information. For more information on running WorkServers remotely.The list of services appears at the lower-right pane of the window. You can also enable product integrations with Kofax and PeopleSoft through the RightFax WorkServer modules. Tells RightFax that this WorkServer will execute on a separate Windows machine on the network. The WorkServer OpenText RightFax 10. For more information. In the left pane.Chapter 6: Configuring the WorkServer modules Chapter 6: Configuring the WorkServer modules Each RightFax WorkServer module performs one or more processor-intensive functions on behalf of the RightFax Server module. see Installing WorkServers on remote computers on page 58. double-click RightFax WorkServer1 Module. and notify the database when finished. Print Handle requests for both on-demand and automatic fax printing. How you configure your WorkServers depends on your organization's needs and RightFax workload. InterConnect Route received faxes to another RightFax server. l Terse Critical errors only. 49 Administrator Guide . CVL Handle faxes with multiple LIBDOC or LIBDOC2 and ADDDOC embedded codes. If you notice that PCL or ASCII text files are not converting to fax format as accurately as you expect. a longer time (for example. OpenText RightFax 10.” Click the services you want to assign to the current WorkServer. OCR Optical Character Recognition (requires the RightFax OCR Converter or OCR Router module). Delete Image Files Delete fax image files. Frequency Specify how often.6 Feature Pack 2 l None No information. You can assign a single service to multiple WorkServers or dedicate a WorkServer to one service only. Caution Leaving the verbose log level for long periods of time can fill up the Event Log and may prevent new events from being logged. The following table lists the available WorkServer services and their functions. or shift-click to select multiple services.Chapter 6: Configuring the WorkServer modules Use PCL Converters for Text Files Service Function Uses the RightFax Printer Control Language (PCL) when converting PCL and ASCII text files to fax format. Event LogLevel Services Select at which level to log information in the Application Event Log under the service name “RightFax WorkServer Module. clear this check box to return to using the RightFax native document conversion engine. Network Messaging This service no longer functions with any of the supported Windows operating systems. PCL PCL-to-fax conversion. 5 to 10 seconds is an appropriate setting. PostScript PostScript-to-fax conversion (requires the RightFax PDF or SecureDocs module). the WorkServer will query the Database module for new requests. If you only have one WorkServer module. This conversion usually produces more accurate fax images of PCL and ASCII text files than the RightFax native document conversion engine. Service Function Archive Archive sent faxes. Coversheets Create cover sheets. If you run multiple WorkServers. FileRoute Route received faxes to network folders. Use temporarily to track and resolve problems. l Verbose All significant events. l Normal Errors and major events only. 15 seconds) will prevent requests from overloading the Database module. Overlay Overlay faxes with forms. in seconds. rather than via the phone lines. InterConnect retry settings These settings are only available if you select InterConnect under Services. Any other assigned service will be ignored by this WorkServer. l Automatically route faxes received on one RightFax Enterprise server to a fax mailbox of the same name on a different RightFax Enterprise server on the same network. This may produce partial pages on some destination fax machines. Count Specify the number of times the originating RightFax server will attempt to forward the fax to the destination RightFax server when it encounters a non-fatal error such as server temporarily down. changes.6 Feature Pack 2 50 Administrator Guide . Archive settings To use WorkServer archiving the following must be set: Use RightFax InterConnect to: OpenText RightFax 10. potentially reducing transmission times. the WorkServer imports the additions. For information on custom integrations with your RightFax server. Optimize faxing Caution Any WorkServer that has telephony server routing enabled must be dedicated to telephony routing only. If the file exists. This may produce a partial page on some destination fax machines. see Importing Billing Codes on page 145. Telephony server routing Enable Select Enable to integrate the RightFax system with your enterprise telephony server system. This file is used to query billing codes from external billing code source. between retries. Send interoffice faxes via the network that links the RightFax Enterprise servers. Select the network protocol to use for communicating between the RightFax and telephony servers. For information on enabling and configuring InterConnect. Short Bodies Protocol Select this check box to make each page in the body of the fax only as long as the text requires (ignoring any blank space at the end of pages). refer to your telephony server documentation.Chapter 6: Configuring the WorkServer modules Telephony server routing Billing Code Import Interval l Specify how often. in minutes. and deletions specified in the file. Interval Specify the time delay. in minutes.csv. Server Specify the name of the telephony server on your network to integrate with the RightFax server. the WorkServer will check for a new billing code delta file Codechg. Optimize Covers Select this check box to make fax cover sheets only as long as the cover sheet text requires (ignoring any blank space at the end of the cover sheet). see RightFaxInterConnect on page 225). For more information on using billing codes from an external source. potentially reducing transmission times. exe working directory. The fax history is an ASCII file with the file extension . Note If you enter an incomplete path.trx and the same file name as the fax. the image can be found at C:\PROGRA~2\RIGHTFAX\WORKSRV\ XXX\ZZZ \. For example. the fax destination. in UNC (universal naming convention) format. Each fax is archived individually upon completion. Specify the folder. Using WorkServer archiving you can track and store your organization's outbound faxes or integrate RightFax with archiving software systems. the date. see Archive Sent Faxes on page 110.3 FAT format) ~8 Week as decimal (00–51) ~9 Billing Code #1 (up to 12 characters in 8. or any combination of these. up to 12 characters in 8. where archived faxes will be stored. For information about configuring a RightFax user for fax archiving. see the RightFax XML GeneratorAdministrator Guide or RightFax Vault Administrator Guide. The file format you choose depends on how you use the archived faxes. By default. each instance of that outbound fax is archived. Using variables in the path name you can archive faxes to separate folders based on the sender. For information about XML Generator.3 FAT format) ~A Remote ID (left to right.3 FAT format) ~0 Billing Code #2 (up to 12 characters in 8.Chapter 6: Configuring the WorkServer modules l l l InterConnect retry settings Path At least one WorkServers must have Archive selected under Services.3 FAT format) Administrator Guide . The “Archive Sent Faxes” permission must be enabled for all users whose outbound faxes should be archived.6 Feature Pack 2 51 Variable Definition ~1 Date (YYYYMMDD) ~2 Day of the week (SUN-SAT) ~3 Month (JAN-DEC) ~4 Year (YYYY) ~5 Day of the month (DD) ~6 Month as decimal (01–12) ~7 User ID (up to 12 characters in 8. if you enter XXX\ZZZ. regardless of whether it was sent successfully. Important WorkServer archiving is disabled and its archive settings ignored if you use the optional XML Generator module to archive inbound and outbound faxes. the path you entered will be created relative to the worksrv. The following table lists each of the archive path variables and their definitions. The path can be customized using special variables that are replaced in the path name each time a fax is archived. files are archived in a multi-page TIFF-G3 format with Group III data compression. Format Select the file format for archived faxes. If a user configured for archiving sends a fax to multiple recipients. The archive settings must be configured for each WorkServer that manages archiving. OpenText RightFax 10. History Select this check box to include a fax transmission history with each archived fax image in the archive folder. The WorkServer creates the specified path if it does not already exist. If you do not enter a path. organized into separate subfolders each month.3 FAT format) To_CityState String 59 Recipient’s city and state From_Name String 59 Sender’s name ~C Group ID (up to 12 characters in 8. in seconds Fax_Status Integer N/A A number corresponding to the fax’s last reported status. Each index entry appears on a separate line and includes 24 data fields. an entry of \\Faxserver\Archive\~C\~7\~3~4 might appear as \\Faxserver\Archive\DEVELOPM. if any FineMode Integer N/A 0=normal. after variable replacement. faxes will not be archived. NumPages Integer N/A Includes optional cover sheet. cannot exceed 128 characters. 1=fine Caution Because “~1” is interpreted as a macro in the path name. you cannot use short path names (such as \Progra~1\RightFax\Archive) in this field. up to 12 characters in 8. GeneralFaxNum String 31 Organization’s general fax number RemoteID String 21 Received remote ID Send_Time Integer N/A Total time on fax board.Chapter 6: Configuring the WorkServer modules InterConnect retry settings Variable Definition Field Type Length Definition ~B Remote ID (right to left.6 Feature Pack 2 52 Administrator Guide . The index is a commadelimited ASCII file. Billinfo1 String 15 Billing code 1 Billinfo2 String 15 Billing code 2 FaxDIDNum String 31 DID routing number OperatorNum String 31 Organization’s general phone number The total path length. 1=received Owner_ID String 21 User ID of the fax “owner” FaxDate String 10 To_FaxNum String 31 Recipient’s fax number Date the fax record was last modified (mm/dd/yyyy) To_ContactNum String 31 Recipient’s phone number FaxTime String 5 To_Name String 59 Recipient’s name Time fax record last modified (hh:mm) To_Company String 59 Recipient’s company name OpenText RightFax 10.ENT\JDOE\JAN2015. A number corresponding to the fax’s last reported transmission status. Field Type Length Definition Received Integer N/A 0=sent. You must use the full path names. The following table lists all of the fields for each index entry in the order the fields appear.3 FAT format) From_PhoneNum String 31 Sender’s phone number Example After the variables have been replaced. All faxes sent by user ID “JDoe” in the “Development” group will be stored in a unique archive folder. Index file Fax_Termstat Integer N/A Specify the UNC path and file name of the file where all archive events will be logged. RightFax services log on to the network using a Windows user account that you specify. clear this check box. Do not grant a third party write access. RightFax will not log archive events. Always Delete After Archive Select this check box to remove all archived faxes from the user’s FaxUtil mailbox. If you do not specify a log file name. Archive Cover Sheet Select this check box to include the cover sheet with the saved image file. To archive only the body of each fax. EquiTrac Archive Select this check box to log all successfully sent faxes to a file called RightFax. The optimal method for third-party access is to make a copy of the log file. indicating success Fax date mm/dd/yy Fax time hh:mm Because this log file is dynamic. This check box is only available if you select TIFF-G3 or TIFF-G4 in the Format box.6 Feature Pack 2 To change service accounts. you can set the account for the Server Service and then copy these settings to the other services. make sure the file is opened in shared mode. Separate file per page output Selecting a service account Select this check box to archive each page of each fax as a separate TIFF file (that is. Configure to leave log file open for a maximum of twenty seconds. ensure that the WorkServers’ service accounts also exist as accounts within Novell. Note If you will be storing or accessing files on a NetWare volume. Field Maximum length or format RightFax user ID 21 characters Phone number dialed 31 characters BillInfo1 15 characters OpenText RightFax 10. The EquiTrac Archive log is a comma-delimited ASCII file. if you use a third-party application to access the log information. 53 Administrator Guide . Each log entry appears on a separate line and includes the following data fields in the the order listed. and access data from the copy.txt in the WorkServer folder.Chapter 6: Configuring the WorkServer modules Selecting a service account Field Type Length Definition Field Maximum length or format UniqueID String 15 Unique ID for the fax assigned by RightFax server BillInfo2 15 characters Fax transmission duration hh:mm:ss Archived_Name String 256 File name used for the image archive Number of pages in fax ### NewLine N/A N/A CR–LF combination record separator Fax error code Always 32. This account is initially selected during the RightFax installation. The user account for a service must have access to all the network resources that the tasks managed by that service require. a five-page fax is archived as five separate files). you may encounter errors in services performed by the WorkServer. and then select Built-in security principals. click Location. first modify the Server Service Account. select the user by clicking Browse. To change the types of objects to search for. If the desired user account resides on a domain whose name is longer than 15 characters. Caution If you manually type a name that is longer than 15 characters. In the Service Account Editor dialog box. click Object Types. To define account settings once and then copy them to all other services. make the following entries: To change service accounts a. and then select a location. To change the location to search. 1.Chapter 6: Configuring the WorkServer modules InterConnect retry settings To view service account settings l Click Select Service Account. and then click OK. showing for each service the currently defined account.6 Feature Pack 2 b. click OK. or both. In the Select User window. Do one of the following: l Click Built-in Account. After entering or selecting an account. select one of the accounts from the list. and then either type a new service account name or click Browse to find all user accounts on a specified network. 2. l Click This Account. next to the account you want to change. The default is to use one of the predefined accounts. Users. click Modify. 54 Administrator Guide . The Service Account Editor window opens. OpenText RightFax 10. l PostScript conversions l Fax printing To add a new WorkServer 3. l 5. WorkServer #3 can be configured to perform the greater than average load of PCL5 conversions. instead of other lower-priority functions. By default the time strip is printed as black text. Click the WorkServer to remove. and then click Check Names. In the left pane. The time strip can include the time of arrival of received faxes. Other processor-intensive tasks that may require a dedicated WorkServer include: l Running OCR (Optical Character Recognition). 1.Chapter 6: Configuring the WorkServer modules Adding and deleting WorkServers c. elapsed transmission time. A list of account names appears from which to choose. In the text box. To enable time strip printing Example If the server is used primarily for broadcast faxing. l Click Add WorkServer. l l Two WorkServer modules devoted to the most frequent tasks. To print it as white text on black background. you may want to reconfigure the WorkServers or add WorkServers. To copy the Server Service account information to the other services. enter a name or partial name. As needed enter the case-sensitive password for the selected user account in both the Password and Confirm Password boxes. and then click Delete WorkServer. click Printer Configuration. Click OK. time printed. To delete an existing WorkServer 4. under the WorkServer. One WorkServer module dedicated to deleting image files. The other WorkServers are renumbered. set the Windows registry key PrintTimeReverse value to 1. click Copy to all.6 Feature Pack 2 55 Administrator Guide . See PrintTimeReverse on page 359. either for routing or conversion OpenText RightFax 10. Depending on your RightFax server usage. and then click OK. Adding and deleting WorkServers Printing a time strip on faxes The following default WorkServer setup on the RightFax server is optimal for most RightFax configurations: A time strip can be printed at the top of every fax that is printed to a network printer. and the fax image file name. ” Images can be faxed by double-clicking the image in FaxUtil and completing the required boxes in the Fax Information dialog box (see Specifying addressing information on page 236). Macro Macro RightFax can be configured to work in conjunction with the Kofax NetScan network integration tool for scanners. Using the Kofax NetScan. 56 Administrator Guide . This makes it convenient to fax printed pages when no electronic version is available.6 Feature Pack 2 Definition ~6 WorkServer number ~7 Image file name ~8 Date and time printed (MM/DD/YYYY HH:MM) ~9 Unique ID ~0 RightFax user ID ~A Remote ID ~B Name of the fax recipient ~C Fax number of the fax recipient ~D Company name of the fax recipient ~E Last transmission/receive date (YYYY/MM/DD) ~F Date and time printed (YYYY/MM/DD HH:MM) ~G Date and time printed (system locale setting for short date and long time) ~H Last transmission/receive date (system locale setting for short date and long time) Configuring Kofax NetScan The following table lists each of the variable options that can be used in this box. Example An entry of Fax ~1: ~2 ~3 places text such as the following at the top of the printed fax: Fax received: 01/05/2014 10:42. 3. specify the type of information to print in the Time Strip. The Time Strip can contain any combination of text and variables. In the Name box. Select the Enable Time Strip check box. Scanned images appear in the selected FaxUtil mailbox with the message “Info not complete. you can scan documents into the FaxUtil mailbox of any RightFax user on your network. Definition ~1 The word “Sent” or “Received” ~2 Last transmission/receive date (MM/DD/YYYY) ~3 Last transmission/receive time (HH:MM) ~4 Last connection duration ~5 Last channel used OpenText RightFax 10.Chapter 6: Configuring the WorkServer modules Configuring Kofax NetScan 2. overriding the PeopleSoft built-in ObjectFax server. to update NetScan users. l If this check box is not selected. To remove a directory. and then click Add Directory. refer to your NetScan documentation. At least one WorkServer must have the PeopleSoft integration enabled. Automatically Update NetScan Users To configure RightFax to work with PeopleSoft Select this check box to automatically update NetScan users with the latest list of RightFax users every six hours or every time the RightFax Server module is restarted. Enable NetScan Interface Select this check box to enable RightFax integration with a Kofax NetScan. RightFax queries PeopleSoft for outgoing faxes. Purchase a separate license to use PeopleSoft with the RightFax server. Configuring PeopleSoft Companies use the PeopleSoft application for enterprise resource planning to manage multiple resources from one integrated platform. Location for Scan-to-Disk Images Specify the UNC path to the folder where images that are scanned to disk from the Kofax NetScan will be saved. PeopleSoft must be used with the RightFax Enterprise or Business Integration module.6 Feature Pack 2 57 Click PeopleSoft Configuration under the selected WorkServer. Each WorkServer is Administrator Guide . Location of NetScan Directories Specify the UNC path to the folders that RightFax will monitor for new NetScan images. type the UNC path in the Location of NetScan Directories box. At least one WorkServer must have the Kofax integration enabled. Each WorkServer is separately configured for Kofax NetScan integration.Chapter 6: Configuring the WorkServer modules Configuring PeopleSoft Synchronizing the RightFax server with external systems on page 29. See OpenText RightFax 10. you must manually force Netscan to synchronize. To add a directory. For more information about configuring the Kofax NetScan for RightFax integration. and then click Remove Directory. click the directory. Communication and integration with the Kofax NetScan will only be handled by the WorkServers with this check box selected. making it possible to take advantage of the RightFax least-cost routing and load balancing features with your PeopleSoft platform. To integrate RightFax with the Kofax NetScan l Click Kofax NetScan Configuration under the selected WorkServer. Caution Do not delete WorkServers from your RightFax configuration after you install a remote WorkServer. In most other installations. Select this check box to enable RightFax integration with PeopleSoft. Remote WorkServers can also provide support for ServerSide Application conversion. three or four properly configured WorkServers installed locally on the RightFax server are sufficient. separately configured for PeopleSoft integration. Location of PeopleSoft directory Specify the UNC path to the folder where PeopleSoft stores its outgoing fax jobs. thus freeing up resources on OpenText RightFax 10. Requirements Enable PeopleSoft Interface This section describes the supported Windows systems. Running remote WorkServers is helpful in systems with 24 or more fax channels in high volume fax broadcast situations. Deleting a WorkServer after installing a remote WorkServer disrupts the order of the services and the remaining WorkServers may fail to function as expected. The service account for this WorkServer (see Selecting a service account on page 53) must have read and write access to this folder.6 Feature Pack 2 58 l Windows Server 2012 R2 Datacenter l Windows Server 2012 R2 Standard l Windows Server 2012 R2 Essentials l Windows Server 2012 Datacenter l Windows Server 2012 Standard l Windows Server 2012 Essentials l Windows Server 2008 R2 Enterprise x64 l Windows Server 2008 R2 Standard x64 Administrator Guide .Chapter 6: Configuring the WorkServer modules Installing WorkServers on remote computers the RightFax server. Installing WorkServers on remote computers You can install and operate remote WorkServers to perform processor-intensive functions. Supported Microsoft Windows operating systems RightFax server software is supported on the following server operating systems. See About the RightFax Conversion Engine on page 88 for more information. Communication and integration with the PeopleSoft system are handled by the WorkServers with this check box selected. 8. Review the welcome screen. 5. OpenText RightFax 10.exe. l Microsoft . 7. Setup prompts you to install it. you must share the \RightFax folder on the RightFax server. select the WorkServer Module check box. verify you have an active HTTP connection. select Do not check for updates. Grant the WorkServer service account full control of the shared folder. 9. share the installation folder using “RightFax” as the share name. Click Next. and then click Next. If your RightFax installation is not in the default \RightFax folder.Chapter 6: Configuring the WorkServer modules l Windows Server 2008 Enterprise x86 and x64 l Windows Server 2008 Standard x86 and x64 Installing WorkServers on remote computers 2. Setup can check for RightFax updates and other latebreaking information.5 yourself. Run Setup. and then click Next. l A Windows account to run RightFax services. Click Next.6 Feature Pack 2 To check for updates. To install.5. The Preview Requirements list shows third-party software required by your chosen features and the status of setup operations. l Microsoft Messaging Queuing* l Microsoft Visual C++ runtime components* 4. This account must also have write access to the Windows registry on the RightFax server. and then click Next. Local server requirements To cancel Setup and install . Installing the WorkServer on a remote computer To install the WorkServer on a remote computer 1. To skip the update check and continue with Setup. If your server does not already have Microsoft Message Queuing installed. click Cancel. This must be a domain user that is a member of the local administrators group and has the “Log on as a service” right on the local computer.NET Framework * l Microsoft Data Access Components * 3. Click Custom. l * installed during setup l RightFax server requirements Before installing remote WorkServers. RightFax WorkServers require Microsoft . Verify that it is the only selected check box in the list. In the list of setup components. click OK. follow the instructions in the Result section. and then click Next. If updates are found.NET Framework 4. The RightFax Product Suite Setup wizard opens. 59 Administrator Guide . and then click Check for Updates. under RightFax Server Modules. Carefully read and accept the license agreement.NET Framework 4. 6. Setup prompts you to install it. If this software is not installed on your system. Required software that will be installed automatically appears with a status of Must Install. 4. In Windows Control Panel. open Administrative Tools. This will take several minutes. and then click Check Access. Do not install the RightFax software in the Program Files folder on x64 systems. Double-click the service to open its properties dialog. If the connection was successful. 14. Click Test Account to verify account credentials. click Apply. the remote WorkServer service may not be able to log on to the network. To begin installing RightFax software. 13. A report will appear in the Results box that indicates if the connection to the RightFax server was successful.Chapter 6: Configuring the WorkServer modules Installing WorkServers on remote computers Select your option. click Next. and then click Next. The WorkServer is listed in the services as RightFax WorkServer Module. When finished. 15. and then click Next. 3. click Next. On the Log On tab. Click Browse to load and select a user account. 1. click Next. specify a new service account name. 2. This account must also have full-control over the \RightFax folder on the RightFax server and have write access to the Windows registry on the RightFax server. This may take several minutes. To apply your settings and install required third-party software.6 Feature Pack 2 60 Administrator Guide . Changing the remote WorkServer’s service account 10. When finished. Enter a Windows account to run RightFax services. When finished. The Program Files folder is reserved for x64 programs. OpenText RightFax 10. click Apply. Caution On x64 systems. the default folder is Program Files (x86). and then click Close. and then Services. the remote WorkServer uses the same service account information as the WorkServers on the RightFax server. 16. you must change the service account used by the remote WorkServer so that it has administrative permissions to the computer on which it is installed. Click Apply. Choose your installation folder. Enter the main RightFax server name. If so. This account must be a domain user that is a member of the local administrators group and must have the right to log on as service on the local computer. To change the WorkServer’s service account on the remote computer 12. When it is installed. You must repeat this procedure locally at the WorkServer before the changes will take effect. If this is a local administrative account on the RightFax server. click Next. 11. The DocTransport OpenText RightFax 10. start RightFax Enterprise Fax Manager. see Starting Enterprise Fax Manager on page 18. You can configure fax boards for conventional fax transmission. On the RightFax server. The DocTransport module acts as an interpreter between some fax board drivers and the RightFax Server module for conventional fax transmission. as well RightFax for SMS messaging and Fax-over-IP fax boards. Configuration dialog box opens.6 Feature Pack 2 61 Administrator Guide .Chapter 7: Configuring the DocTransport modules Adding transport methods Chapter 7: Configuring the DocTransport modules The RightFax DocTransport modules specify the methods by which RightFax can transmit documents. For most other types of installations. Adding transport methods By default. you need to add the specific transport method for your fax transport type. 2. To configure the DocTransport modules 1. The DocTransport module must be properly configured to allow the RightFax server to send and receive documents. the DocTransport module includes the Brooktrout transport method. In the left pane. In the list of services. double-click RightFax DocTransport Module. It handles requests to schedule outgoing faxes for transmission and informs the Server module when a new fax has been received and needs to be processed. as shown in the following table. click the name of the RightFax server. 3. RightFax supports a maximum of 120 fax channels per DocTransport service.The list of services appears at the lower-right pane of the window. For more information. you must select also a specific fax board in the right pane. Simulation Device Allows simulated fax sending for testing or demonstration purposes. Required if you are using the RightFax Connect service. 3. See Configuring T. 2. To add a transport method 1. T. See Text messaging using the Push Proxy Gateway on page 152. RightFax Internet Connector Peer-toPeer Device RightFax Connect Required if you are using the RightFax Internet Connector module. See Configuring RightFax Connect on page 81. configure each for your system. Click Add Transport.6 Feature Pack 2 62 Administrator Guide . Note You must configure the gateway to send faxes to IP addresses and to collect route codes. 4. Repeat these steps for each optional transport method you want to add. The Transport Selection dialog box opens.37 Fax over IP Required for creation of administrative dialing rules that route faxes to T. OpenText RightFax 10. SR140 Required for installation of all Brooktrout TR1034-series fax boards or the Brooktrout SR140 Fax over IP software platform. Simulation mode can be used with no fax boards installed. 5. See Configuring RightFax Internet Connector channels on page 80. Outgoing faxes appear to send but do not.Chapter 7: Configuring the DocTransport modules Transport method Description Brooktrout TR1034 Series. Expand the tree in the left pane and select a transport method. 6. After you add the transport methods you will be using.37 Fax over IP on page 78. SMS Via Push Proxy Required for installation of the Push Proxy Gateway Gateway. Click Select to add the new transport method.37-compatible fax machines. If you select Brooktrout. Any DocTransport service on any other RightFax server communicating with this server must be started using a valid account and password rather than a local system account.] to the right of this option and enter a login name and password. including TR1034-series and the SR140 boardless Fax-Over-IP. l Terse Critical errors only. OpenText RightFax 10.” After you add a Brooktrout transport method to the DocTransport service. Normal Errors and major events only. click [. or channel in use. though some fields may apply only to some l None No information.. To specify a user account. Event LogLevel Brooktrout Fax Board configuration Select at which level to log information in the Application Event Log under the service name “RightFax DocTransport. you must specify a user account that the DocTransport service can use for authentication to and from other DocTransport modules on the network. Select this check box to encrypt the data exchanged between multiple RightFax DocTransports (for example. Use temporarily to track and resolve problems.Chapter 7: Configuring the DocTransport modules Configuring global DocTransport settings Configuring global DocTransport settings l l Global DocTransport settings apply to all enabled transport methods.. fax board. If you select this option. you must configure it for use with RightFax. MSMQ Server Enter the name of the server on which the Microsoft Message Queue service is installed. Verbose All significant events.6 Feature Pack 2 63 Administrator Guide . The configuration steps apply to all Brooktrout boards. RightFax uses these settings regardless of the transport method. click Global DocTransport Settings. All servers on the RightFax system must point to the same MSMQ Server. Caution Leaving the verbose log level for long periods of time can fill up the Event Log and may prevent new events from being logged. To configure global DocTransport settings l Secure RPC Enabled In the left pane. Remote DocTransports) or between a RightFax DocTransport module and the FaxStat program. in seconds. Configuring Brooktrout global transport settings CD Timeout Brooktrout Global Transport Settings apply to all of the Brooktrout fax boards and channels configured in the DocTransport module. RightFax collects information about the dialing party’s phone number for display in FaxUtil and for CSID routing (if used). 1. 2. OpenText RightFax 10.Chapter 7: Configuring the DocTransport modules Configuring global DocTransport settings boards. RightFax uses these settings regardless of the fax board or fax channel in use. Configure the following elements for each board: l l l Configure the default settings for the board. Configure each of the RightFax channels. Some organizations receive additional information (such as ANI or DNIS) along with the caller’s phone number. ANI Pattern Match Specify the pattern of the dialing party information string that will be received during incoming calls. and each channel must be configured separately for each board. 3.6 Feature Pack 2 64 Administrator Guide . This box specifies the pattern of the extra data so that it can be removed prior to display or routing. Each board must be configured separately. Configure the Brooktrout Global Transport Settings. Use the Brooktrout Configuration Tool to license channels and set additional parameters(see the Brooktrout documentation). Configure the Advanced settings (optional) for all Brooktrout boards. click Global Transport Settings. To configure global transport settings l To configure a Brooktrout transport method for use with RightFax In the left pane. Specify the length of time. that the RightFax server will wait for a fax answer tone (CED tone) from a remote fax machine when sending a fax. Select this check box to have the DocTransport module record all incoming and outgoing faxes in a log. For example. This will be ignored. # A pound character. OpenText RightFax 10. This is the only number sequence that is used for ANI routing. Example The string “5205554762” consists of 10 ANI digits. Z An extraneous digit. Modifiers with a space. enter the printer port instead of a file name. all other information is ignored.” l Level 1 prints a single line summary of each fax event. l Example The string “015205554672#1234**” consists of a combination of ANI digits.6 Feature Pack 2 65 Field name Type/format Length Description Direction String 1 Sent/received flag (“S” or “R”) Administrator Guide . If you output to a network printer. l Level 3 outputs a comma-delimited file of each fax event. Y A digit in the DNIS number. Specify the path and file name of the log file to use. If the file does not exist. The following table lists all of the fields for each log entry in the order the fields appear. asterisks. RightFax will create it when it logs the first entry. Separate literal digits from Max. Level Specify the level of information to include in the log. Max.Chapter 7: Configuring the DocTransport modules Configuring global DocTransport settings Enter the pattern of ANI data you receive using the symbols in the following table. and pound characters. To output the log file to a network printer. l Level 2 prints a detailed description of each fax event. Level 5 is primarily for troubleshooting purposes. and begins with the digits 01. It matches the patterns strings “01XXXXXXXXXX#ZZZZ**” and “01X10#Z4*2. Beeping Level 3 Select this check box if the computer in which the fax boards are installed should beep each time a call is placed or received. File X A digit in an ANI number. Literal Digits (0–9 and A–D) Valid phone digits. you must also select the Close File Between Each Page check box. Modifier (1–9) The maximum number of each of the prior characters. “x2*y” represents up to 2 ANI digits followed by an asterisk and a single DNIS digit. and outputs Brooktrout debugging information. It matches the pattern strings “XXXXXXXXXX” and “X10. Each log entry appears on a separate line and includes 15 data fields.” l Level 4 outputs a tab-delimited file each hour containing that hour’s fax events. Audit Settings Allow Auditing Symbol Represents * An asterisk character. There are five levels of detail. Contact number String 31 Sent faxes only: The recipient’s voice number Channel Numeric 5 Channel used by RightFax. The following table lists all of the fields for each log entry in the order the fields appear. Each log entry appears on a separate line and includes 28 data fields. will be saved. do not specify a file name in the File box. which are given default names.Chapter 7: Configuring the DocTransport modules Field name Type/format Date sent MM/DD/YYYY 10 Time sent HH:MM Channel Configuring global DocTransport settings Length Description Field name Type/format Length Description Date that the call was initiated Billing code 2 String 15 5 Time that the call was initiated Level 4 Numeric 2 Channel used by RightFax (0–32) Duration Numeric 5 Total transmission time in seconds Phone number Alphanumeric 31 Sent faxes: Fax number dialed Sent faxes only: Billing code 2 Because a separate file is created for each hour’s fax events. OpenText RightFax 10. Duration Numeric 5 Contact name String 59 Sent faxes only: The recipient’s name. Good pages Numeric 5 Billing code 1 String 15 Sent faxes only: Billing code 1 Number of pages transmitted successfully. Page count String 79 Number of pages transmitted Time sent HHMM 4 Time that the call was initiated.6 Feature Pack 2 66 Administrator Guide . You can specify a path to a folder where the log files. Remote ID String 49 Remote fax machine ID Result String 59 Result of the fax transmission Date sent YYYYMMDD 8 Date that the call was initiated. Total transmission time (in seconds). 127 Fax number dialed. Received faxes: Routing code (or DTMF) used Field name Type Length Description Direction String 1 Sent/received flag (“S” or “R”). String 59 Sent faxes only: The recipient’s company name Phone number String Company name Remote ID String 47 User ID String 21 Sent faxes only: RightFax user ID of the sender CSID of recipient fax machine. To name String 59 The recipient’s name. Source server String 47 Source server IP address or name.Chapter 7: Configuring the DocTransport modules Configuring global DocTransport settings Field name Type Length Description Field name Type Length Description Page count Numeric 5 Total number of pages in the fax. Enter a text message to include at the beginning of every page in the audit file. Sender ID String 21 RightFax user ID of the sender. BT fax line status Numeric 5 Brooktrout fax result line status value. 0 = Brooktrout ISDN cause value String 5 ISDN call setup cause value (only valid if indicated by flags). Brooktrout call result line status value. 0x0000 = No flags set 0x0001 = PartialRetry 0x0002 = SchedRemote 0x0004 = SendForRemote 0x0008 = Has_ANI (automatic number identification) 0x0010 = Had_AOC (advice of charge) 0x0020 = Had_ ISDNCauseVal Billing code 1 String 15 Billing code 1. Unique ID String 15 Assigned unique ID for fax job. From name String 59 Name of sender (descriptive name. Billing code 2 String 15 Billing code 2. Secure CSID String 21 CSID match code for secure send operation. InitialString AOC data value #1 (only valid if indicated by flags). BT call status Numeric BT call line status Numeric 5 5 Brooktrout call result status value. Relates to the call itself. Contact number String 31 The recipient’s voice number. BT fax status Numeric 5 Brooktrout fax result status value.6 Feature Pack 2 67 Administrator Guide . AOC value 2 Numeric 9 AOC data value #2 (only valid if indicated by flags). AOC value 1 Numeric 9 OpenText RightFax 10. not the ID). CDR flags Numeric 4 Hex value of CDR (call detail record) flags Company name String 59 The recipient’s company name. Relates to the faxing portion of the call. Board type Numeric 1 Type of fax board used to send the fax AOC value 3 Numeric 9 AOC data value #3 (only valid if indicated by flags). Notation Example Represents \x## \x1b Hexadecimal character values \### \027 Decimal character values ^x ^[ ASCII representation of a control character l l Close File Between Each Page Closes the log file after each entry. use the following notation. and the total page count. l Abandon Abandon the fax transmission. To add control codes to this string. In Windows Control Panel. you must also specify how the TTI line will be placed on the fax page. TTI Line Settings Allow TTI Line Display Time Select this check box to place a TTI line at the top of every page of a fax. Type the desired company name in the Fax ID box. This erases existing fax data from the first line but the overall length of the fax stays the same. 1. 2. With Brooktrout fax boards. This retains any fax data on the first line but increases the length of the fax by one line. l Error Correction ECM is disabled Select this check box if Error Correction Mode (ECM) is disabled or does not exist. Select Replace TTI Line to replace any existing text or image on the first line of the fax with the TTI line. The date format in your TTI line is a function of the Windows international or regional settings as installed on the RightFax server. double-click RightFax DocTransport. the fax page number. The TTI line includes the transmitting fax machine. This can obscure the TTI information.6 Feature Pack 2 Select Insert TTI Line to add a new line to the top of the fax page for the TTI information. this option functions the same as inserting the TTI line. The transmit terminal information (TTI) line is a line of text that prints at the top of each received fax page. If this check box is selected.Chapter 7: Configuring the DocTransport modules Configuring global DocTransport settings The line can contain control codes to convey page formatting or other information to the application reading the file. the date and time of the transmission. Repeat these steps on all RightFax servers and Remote DocTransport computers. Display Time as Server to set the TTI time stamp to Administrator Guide . Select one of the following: l l 68 Display Time as GMT to set the TTI timestamp to Greenwich Mean Time (GMT). OpenText RightFax 10. You can then output the log to a network printer. In the Transport Configuration window. Specify how RightFax will respond to RTN messages: Ignore Ignore error and proceed to the next page. To add your organization’s name to the TTI line: RTN Response l Select Overlay TTI Line to add the TTI line text to add any existing text or image on the first line of the fax. 3. click each fax channel for each fax board listed in the left pane. 4. Example A quick header format entry of “Please deliver to: ~2 at ~5” might appear as “Please deliver to: Jane Doe at Acme. see Dialing characters supported by dialing rules on page 189. The default setting (WW) instructs the fax boards to automatically detect a dial tone before dialing.6 Feature Pack 2 69 Administrator Guide . click the board name. Postfix Enter one or more dialing characters to add at the end of every outbound fax number dialed by the RightFax server.” To configure a Brooktrout board l Dialing Settings In the left pane. Call Grouping checks the queue for another fax going to the same number. see Enable Quick Headers on page 32. For a list of valid dialing characters. Whenever a fax is placed in the fax queue. If another fax to the same number is scheduled. l Display Time as UTC to set the TTI time stampt to Universal Corrdinated Time (UTC). it keeps the line open and transmits the second fax. ~3 To-contact number field (31 characters maximum) Maximum Grouping ~4 To-company field (59 characters maximum) ~5 Shortened to-company field (23 characters maximum) ~6 BillInfo1 field (15 characters maximum) Enter the maximum number of pages (1-256) that the RightFax server will send to one phone number before hanging up and sending another set of fax pages. For a list of valid dialing OpenText RightFax 10.Chapter 7: Configuring the DocTransport modules Configuring global DocTransport settings characters.All Brooktrout board types use the same configuration window. ~7 BillInfo2 field (15 characters maximum) Configuring a Brooktrout board ~8 Unique ID (15 characters maximum) After you add a new Brooktrout fax board. Inc. For more information. Macro Definition ~1 To-name field (59 characters maximum) ~2 Shortened to-name (23 characters maximum) Select this check box to allow the grouping of calls to the same number. Quick Headers are enabled in the RightFax Server module. Depending on the functionality of Prefix Enter one or more dialing characters to add at the beginning of every outbound fax number dialed by the server. under Brooktrout. it must be configured to work with RightFax. server time. Call Grouping Settings Allow Grouping The quick header line can be customized using special macros that are replaced in the quick header of each fax. Quick Header Format Enter heading text to include under the TTI line on outbound faxes. see Dialing characters supported by dialing rules on page 189. Chapter 7: Configuring the DocTransport modules Configuring global DocTransport settings Set Capability for All Channels each board, some fields may be unavailable. Select this check box to set the same capability (dial-only, answer-only, or both) for all the channels on the fax board. To specify the capability of each channel separately, see Configuring Brooktrout channels on page 71. Configure Brooktrout Click to configure Brooktrout-related board settings. The Brooktrout Configuration Tool opens. For more information, see the Brooktrout documentation. Number of SR140 Channels (SR140 configuration only) After having activated your SR140 channel licenses using the Brooktrout Configuration Tool, select the number of licensed channels in the list. Calling Party This field applies to calls using SIP or H.323 internet protocols or ISDN. Enter any combination of text, numbers, and variables to send with each fax sent from the RightFax server. This is the SIP From field for SIP systems and the ISDN Calling Party for FoIP and ISDN channels. Board module number Select the number in the list that matches the number on the rotary switch on the fax board. For data transmitted via SIP, select the Apply SIP character restrictions check box to ensure proper formatting. When selected, SIP restricted characters are stripped and their entry disallowed. Restricted characters include all tabs and spaces, as well as : / ? # [ ] @ ! $ & ‘ ( ) * + , ; and =, where @ is allowed once as part of the SIP From field which must always be formatted as an email address. DID Settings In the Number of digits for routing list, select the number of digits used for routing fax calls. This matches the number of digits in RightFax user routing codes. Set Fax ID for All Channels Before specifying to send additional data to a PBX system, verify that the PBX is able to accept the data in the calling party number field of the ISDN string. If it is not, the call will be rejected. Select this check box to specify a fax ID for all the channels on this fax board. Each channel transmits this fax ID to the remote fax machines. Usually, this is set to your company name or general fax number. To specify a unique fax ID for each channel, see Configuring Brooktrout channels on page 71. OpenText RightFax 10.6 Feature Pack 2 You can use any of the following variable options. 70 Administrator Guide Chapter 7: Configuring the DocTransport modules Macro Data ~1 Fax number dialed. ~2 RightFax user ID of the sender. ~3 The recipient’s voice number. ~4 The recipient’s name. ~5 The recipient’s company name. ~6 Billing code 1. ~7 Billing code 2. ~8 Assigned unique ID for fax job. ~9 CSID match code for secure send operation. ~10 Name of the sender. ~11 Source server IP address or name. Configuring global DocTransport settings Configuring Brooktrout channels Activate Channel Each fax channel on a Brooktrout fax board can be individually configured. Select this check box to activate this channel for use by RightFax. To deactivate the channel, clear the check box. To configure a Brooktrout channel l Fax ID In the left pane, under the Brooktrout board, click the channel number. Specify the fax ID for this channel only. The fax ID is transmitted to remote fax machines to identify the sender. Usually, this is set to your company name or general fax number. This box is not available if you configured the Brooktrout board to set the Fax ID for all channels. Capability Select one of the following capabilities of this channel: OpenText RightFax 10.6 Feature Pack 2 71 l Both l Dial l Answer. Timed Ability becomes unavailable. Administrator Guide Chapter 7: Configuring the DocTransport modules l Both w/VM-Notify l Dial w/VM-Notify l RESERVED l Dial w/Ring Detect. Timed Ability becomes unavailable. Configuring global DocTransport settings 2. In the Capability box select the capability for the time period. Example To set different capabilities for business hours and after hours and to use the evening hours for broadcast faxing, you might define the following: Start: 0 End: 0659 Capability: Both Start: 0700 End: 1759 Capability: Answer Start: 1800 End: 2359 Capability: Both The capability you select here become the defaults in the Capability fields under Timed Ability. When you select “Answer” or “Dial w/Ring Detect” the Timed Ability option becomes unavailable. Inbound routing These settings apply if you enable DTMF routing. DTMF routing is a method for routing faxes to an individual based on the routing code entered manually by the caller. Max. Pages This Channel May Send Enter the maximum number of pages per fax that can be sent by this channel, from 0 to 999 (up to 1000 pages per fax). Use this option to reserve channels for smaller faxes. Enable DTMF Routing Select this check box to use DTMF inbound routing for this channel. Channel Extension Assigns a routing code to all incoming faxes on this channel if no routing information is specified. Because DID, T1 with DNIS, and ISDN telephone lines require routing codes, this setting only applies to loop-start lines and T1 lines without DNIS. The Channel Extension is also used when DTMF routing is enabled on the line but the caller does not enter a routing code. Initial Tone / Initial Speech Specify how callers will be prompted to enter a routing code for the fax: l Timed Ability You can use the channel with one capability throughout the day (0000 to 2359) or you can define up to three time periods with changing capabilities: l 1. In the Start and End boxes, enter the start and end times for the time period in 24 hour notation. The first time period always starts at 0 (midnight) and the last time period always ends at 2359 (a minute before midnight). OpenText RightFax 10.6 Feature Pack 2 Click Initial Tone to play a tone, and then select the tone to play and the duration of the tone in seconds. For information on the available tones, refer to your Brooktrout documentation. Click Initial Speech to play a voice prompt, and then specify the file of the voice prompt. This option requires a special voice module license for your Brooktrout board. You can use the default voice prompt Prompt.ipk as is or re-record it via telephone. The file is located in the RightFax\DocTransport\Brooktrout folder. 72 Administrator Guide Chapter 7: Configuring the DocTransport modules Configuring global DocTransport settings located in the RightFax\DocTransport\Brooktrout folder. This prompt file can be played or re-recorded via telephone. To play the voice prompt for review 1. At a command prompt on the server, enter the following command: Confirmation Specify the file to play when a caller has correctly entered DTMF digits for routing. The default file, Gotdigit.ipk is located in the RightFax\DocTransport\Brooktrout folder. This prompt file can be played or re-recorded via telephone. RightFax\DocTransport\Brooktrout\voice -p cphonenumprompt.ipk The Brooktrout board dials the phone number you specified in phonenum. No Terminator 2. After you answer the phone, the board plays the message. Hang up when the playback is complete. Select this check box to have RightFax accept the DTMF code entered by the caller as soon as the correct number of digits have been entered. No additional terminator key is needed. To play back the Failure or Confirmation prompts, replace PROMPT.IP with BADDIGT.IP or GOTDIGIT.IP respectively. Terminator Enter the telephone key that the caller must press to indicate that all DTMF digits have been entered. This is required if the Max. Digits and Min. Digits are not set to the same value To re-record a voice prompt 1. Save a backup copy of the old Prompt.ipk file. 2. At a command prompt on the server, enter the following command: Max. Digits Specify the maximum number of DTMF digits that can be entered by the caller. RightFax\DocTransport\Brooktrout\ voice -r -cphonenum-u 0 prompt.ipk Min. Digits The Brooktrout board dials the phone number you specified in phonenum. Specify the minimum number of DTMF digits that can be entered by the caller. 3. After you answer the phone, the board begins recording your message. Tone Wait Specify within how many seconds after the prompt the caller must enter a routing code, or if a terminator key is defined, the routing code and the terminator key. 4. When you are done, press the [#] key (pound key). To re-record the Failure or Confirmation prompts, replace PROMPT.IP with BADDIGT.IP or GOTDIGIT.IP respectively. Configuring the Human Answered Fax feature Failure Use the Advanced Settings options for Brooktrout boards to enable: Specify the file to play when a caller does not enter enough DTMF digits to route the fax. The default file, Baddigit.ipk is OpenText RightFax 10.6 Feature Pack 2 73 Administrator Guide Chapter 7: Configuring the DocTransport modules l l l Configuring global DocTransport settings The Human Answered Fax feature. Human Answered Fax options appear in the right pane. The TeleConnect module For information about configuring Teleconnect, see Using TeleConnect to access faxes by phone on page 283 The optional Docs-on-Demand module. For information about configuring Docs-on-Demand, see the RightFax Docs-on-Demand Module Administrator Guide. Exchange Unified Messaging. for information about configuring Exchange Unified Messaging, see The Human Answered Fax feature detects when a person answers an outbound fax call rather than a fax machine. An automated voice message informs the recipient that a fax is being sent and offers one or more options for receiving the fax. The feature uses Dialogic .vox voice files located on the RightFax server. These files can be played or modified using any sound editor that supports the .vox file format. Enable Human Answered Fax At least one Brooktrout fax boards with licensed voice capability must be installed. For more information, refer to your fax board documentation or contact your Brooktrout fax board distributor. Select this check box to enable the Human Answered Fax feature. Calling Mode Select how the RightFax server will respond if a human voice is detected on a fax call: To enable and configure the Human Answered Fax feature l In the left pane, under Brooktrout, click Advanced Settings, and then click Human Answered Fax. The l l OpenText RightFax 10.6 Feature Pack 2 74 Switch to Voice Mode if a Human is detected on a Fax Call The RightFax server will immediately switch to voice mode. If a fax machine is detected, the fax will be sent. Call back in Voice Mode if a Human is detected on a Fax Call The RightFax server will briefly hang up before calling back in voice mode. If a fax machine is Administrator Guide Chapter 7: Configuring the DocTransport modules Configuring global DocTransport settings detected on either call, the fax will be sent. l l Always start each Fax Call in Voice Mode The RightFax server will initiate all outbound fax calls in voice mode. Voice Mode l Specify if a voice will be played or a voice message and a menu of options requiring the recipient to respond: l Click Voice Prompt Only to play a voice message informing the call recipient that this is an incoming fax, and then wait for a fax tone before transmitting. The voice prompt used by the RightFax server can be simple or detailed. l l Select this check box to use a detailed voice prompt. The detailed voice prompt (“This is a n page fax.”) consists of several separate voice files that combine into a unique message. Do not select this check box if you are using the Human Answered Fax feature with a language other than English. Your calling mode is “Always start each Fax Call in Voice Mode.” Selecting “Voice Prompt Only” ensures that the fax will be sent after a short delay. Otherwise RightFax will wait indefintely for a response from the call recipient, and the fax will never be sent. The simple voice prompt plays the file HAF_ThisisaFax.vox (“This is a fax,”) followed by HAF_PressStart.vox (“Please press start on your fax machine to receive your documents.”) Translating the voice files You are using the Human Answered Fax feature with a language other than English. If you are using the Human Answered Fax feature with a language other than English do not use the voice menu or detailed voice prompts. Click Voice Menu to play a voice message followed by a menu of options. The voice prompt used by the RightFax server can be simple or detailed. Note Translating the voice menu or the detailed voice prompts could result in text with improper syntax. The file HAF_MainMenu.vox contains the menu of options: “To receive this fax press 1 or stay on the line. To cancel this fax press 9.” Use the following guidelines for languages other than English: l Depending on the call recipient’s response, one of the following messages plays: l OpenText RightFax 10.6 Feature Pack 2 HAF_Cancelled.vox (“This fax has been canceled. We apologize for any inconvenience” ) plays after the recipient presses 9. The fax is not sent. Detailed Voice Prompts Always select this option if: l HAF_PressStart.vox (“Please press start on your fax machine to receive your documents”) plays if the recipient presses 1 or fails to respond within 10 seconds. After playing the message, the RightFax server attempts to send the fax. 75 Record a new translated version of the file HAF_ ThisisaFax.vox that informs the call recipient that a fax transmission is being attempted. Under Voice Mode, select Voice Prompt Only. Administrator Guide Chapter 7: Configuring the DocTransport modules Configuring Docs-on-Demand To cancel a fax call that has been answered by a human Demand options appear in the right pane. 1. Under Voice Mode, select Voice Menu. 2. Edit the Windows Registry to set the HAF_ CancelIfNoResponse value to 1. For more information, see HAF_CancelIfNoResponse on page 349. Configuring Docs-on-Demand With the Docs-on-Demand module anyone can call into your RightFax server to request faxes. These can be marketing or sales material, informational material, or any kind of fax document your organization wants to make available via touch-tone phone. For more details on how to use Docs-onDemand, see the RightFax Docs-on-Demand Module Administrator Guide. To use the Docs-on-Demand module with all defined Brooktrout fax boards l In the left pane, under Brooktrout, click Advanced Settings, and then click Docs on Demand. The Docs-on- Enable Docs on Demand Select this check box to enable the two Docs-on-Demand applications, Fax-on-Demand and Web Fax Tools. System Password Enter the numeric password the Fax-on-Demand administrator will use to access the Fax-on-Demand Sysop (System Operator) menu. The password must be numeric so that it can be entered from a touch-tone phone. Routing Code/Channel Ext Enter the routing code (such as DTMF extension or DID number) to assign to Fax-on-Demand. Calls arriving on this extension will automatically enter the Fax-on-Demand system rather than being received as an incoming fax: OpenText RightFax 10.6 Feature Pack 2 76 Administrator Guide Chapter 7: Configuring the DocTransport modules l l Configuring Docs-on-Demand If you have a bank of numbers dedicated to your RightFax server, assign one of the numbers to Fax-on-Demand by entering the extension here. Name on Cover Sheet If you have channel routing configured on POTS (plain-oldtelephone system) lines, dedicate one of your fax channels to Fax-on-Demand: Call Type Enter the name or text that will appear in the “To:” field on fax cover sheets sent by Fax-on-Demand. Select how Fax-on-Demand will connect to the user requesting faxes. a. Enter a unique four-digit number in the in this box. l b. In the left pane, under Global Board Settings, click the channel you want to dedicate. c. In the Channel Extension box, enter the same four-digit value. l Note The channel cannot be part of a hunt group unless all the channels in that hunt group are dedicated to Faxon-Demand. Otherwise, dialing the number may cause users to hear a fax tone instead of accessing Fax-onDemand. l l Two Call causes Fax-on-Demand to request the user’s fax number and initiates a separate call to send faxes. Prompt asks each user to specify a one- or two-call session. Maximum Documents Enter the maximum number of fax documents that a Fax-onDemand user can request per call. If you have DTMF routing configured for a particular analog channel, enter a unique four-digit extension in this box. To connect to the Fax-on-Demand system, callers will dial this extension after hearing a tone or voice prompt. If this number is not entered after a few seconds (depending on the DTMF timeout value), the channel provides a fax tone and attempts to receive a fax. BrookTrout registry settings You can set the following configuration options through the registry editor. Defining an RTI line The RTI (Receipt Terminal Information) line is a line of text that can be printed at the bottom of each received fax page. User Account The RTI line includes information about the fax that supplements the TTI line such as the total number of pages received, the name of the RightFax server that received the fax, and the sender’s caller ID. Enter the RightFax user ID that Fax-on-Demand will use when sending faxes. All cover sheet information and attributes of the selected user ID will apply to faxes sent by Fax-on-Demand. This setting is also used by Web Fax Tools for assigning a RightFax user ID to outgoing faxes. OpenText RightFax 10.6 Feature Pack 2 One Call requires the user to be calling from a fax machine. Fax-on-Demand uses the same connection to send faxes back to the caller without initiating a second call. In this way, the Fax-on-Demand system incurs no phone charges. 77 Administrator Guide Chapter 7: Configuring the DocTransport modules Configuring T.37 Fax over IP You can enable or disable the RTI line, specify the information you want it to include, specify the font size, and specify where on the fax page to print the line: l l l l right pane. To turn the RTI on or off, see StampReceivedPages on page 353. To specify which data appears, see ReceiveStampFormat on page 352. To specify where the RTI appears, see ReceiveStampLocation on page 353. To specify how large to print the RTI, see ReceiveStampFontSize on page 352. Configuring T.37 Fax over IP Use the T.37 Fax over IP (FoIP) fax transmission protocol to transmit faxes to T.37-compatible devices over IP instead of dedicated fax channels. The fax is packaged as an email message with a TIFF attachment and sent over IP via an SMTP server. This email message is automatically interpreted as a fax by the receiving device, which prints it. SMTP Server Address By default, Fax over IP messages are sent via the SMTP server that you specified during the RightFax server installation. If you did not specify an SMTP server name then, enter the name of the SMTP server on your network that transmits fax-over-IP messages. To send documents using Fax over IP, you must create dialing rules that route the documents based on the fax numbers or email addresses entered by your RightFax client for outbound faxes. For information on how to configure a dialing rule to route to a fax over IP destination, see The Destination tab on page 191. Email Address in the “From” Section of the T.37 fax message Enter the email address that will be transmitted to the receiving T.37-compatible device. To configure T.37 Fax over IP. 1. Add a T.37 Fax over IP transport method. For more information, see Adding transport methods on page 61. Configuring Fax over IP failover 2. In the left pane, under FoIP, click T.37 Fax over IP. The fax over IP configuration options appear in the OpenText RightFax 10.6 Feature Pack 2 In a Fax over IP environment with multi-router topology you can set up dialing rules that configure RightFax for real-time FoIP failover. When the primary FoIP router or gateway is 78 Administrator Guide Chapter 7: Configuring the DocTransport modules Configuring SMS via the Push-Proxy Gateway 5. Repeat the previous steps to define a dialing rule for the secondary FoIP router, on the Number Adjustments tab, in the Append this box, typing @ followed by the IP of the secondary FoIP router, and on the Other tab, setting the Extra Rule Weight value to a number lower than that of the primary FoIP router. unavailable or times out, faxes are automatically routed to a secondary router or gateway. FoIP failover is compatible with both SR140 and T.37 board-based architecture. To enable FoIP failover Do the following: l l Create two dialing rules that route faxes based on the outgoing router number. Set the rule that points to the primary router with a higher weight than the rule that points to the secondary router. 6. On the File menu, click Save Dialing Plan. Configuring SMS via the Push-Proxy Gateway Edit the registry keyword value DisableDialingRuleOnTimeout to have a value of 1. See DisableDialingRuleOnTimeout on page 348. You can configure the RightFax server to send fax notifications and alerts via SMS (short message service) communication protocol to SMS compatible devices such as cell phones. RightFax clients can also send and receive SMS messages. Important When using FoIP you must remove the wait for wink (or WW) setting in the dialing settings, prefix box located in the DocTransport, Global Transport Settings. Because SMS is a text-only protocol, sent SMS messages include only the notes added to the fax cover sheet. You can also create dialing rules that automatically route outbound faxes to SMS numbers. SMS functionality requires that you have installed the RightFax Push-Proxy Gateway on the server running the DocTransport service. To define the dialing rules for FoIP failover 1. In the left pane, under Dialing Plan, right-click Dialing Rules, and then click New on the shortcut menu. The Rule Edit window opens. 2. On the Matching tab, in the Pattern box, enter a number that, when dialed, is sent via FoIP. To configure SMS via the Push-Proxy Gateway 1. Add an SMS transport method. For more information, see Adding transport methods on page 61. 3. On the Number Adjustments tab, in the Append this box, type the at sign (@) followed by the IP address of your network’s primary FoIP router, and then click OK. For more information, see The Number Adjustments tab on page 188 2. In the left pane, under SMS, click Mobility PushProxy Gateway. The options for configuring the Push- Example @192.168.0.1 4. On the Other tab, in the Extra Rule Weight box, set the weight to a value greater than 0, and then click OK. OpenText RightFax 10.6 Feature Pack 2 79 Administrator Guide Chapter 7: Configuring the DocTransport modules Configuring RightFax Internet Connector channels Proxy Gateway appear in the right pane. Configuring RightFax Internet Connector channels When using RightFax Internet Connector transmission between Rightfax servers (either within a company or between companies), faxes go over the Internet instead of through phone lines. To configure RightFax Internet Connector channels 1. Add a RightFax Internet Connector transport method. For more information, see Adding transport methods on page 61. 2. In the left pane, under RightFax Internet Connector, click Peer to Peer Channels. The options for configuring the Peer to Peer device appear in the right pane. Configure PPG Click to run the Push-Proxy Gateway configuration program. For information on completing these configuration options, see Text messaging using the Push Proxy Gateway on page 152. Number of Digits for Routing When the RightFax server receives an incoming SMS message, it can route the message to one or more mailboxes. Each RightFax mailbox (user ID) has a unique routing code. SMS mailboxes should be configured to use routing codes based on the phone number that the message was sent to, typically the last three or four digits of the number. Enter the number of digits that are read from the end of the receiving phone number that is used for routing SMS messages. OpenText RightFax 10.6 Feature Pack 2 80 Administrator Guide Chapter 7: Configuring the DocTransport modules Configuring RightFax Connect right pane. Fax ID Enter the fax ID for this channel only. The fax ID is transmitted to remote fax machines to identify the sender. Usually, this is set to your company name or general fax number. Number of Digits for Routing The RightFax Internet Connector includes the destination fax number with each transmission. Enter the number of digits from the end of the destination phone number that will be used for routing faxes. Configuring RightFax Connect To configure RightFax Connect, you need to have on hand the User Name and Password that were set up when you purchased RightFax Connect. Number of channels Note A single RightFax Connect account can be shared among multiple DocTransports that use the same database, including remote DocTransports and Shared Services systems. Enter a number between 1 and 34. The number should be just high enough to handle your faxing volume in a timely manner. While higher numbers increase the speed of fax submission, they also increase network traffic and the need for more bandwidth. To configure RightFax Connect 1. Add a RightFax Connect transport method. For more information, see Adding transport methods on page 61. RightFax Connect Credentials 2. In the left pane, under RightFax Connect, click RightFax Connect Device. The options for configuring the RightFax Connect device appear in the To test the connection, click Test Connection after entering the user name and password. Enter the User Name and Password for RightFax Connect. RightFax Connect Data Centers By default the United States data center is used. Changing the data center setting requires changes to your RightFax Connect account. To change to a different data center option, contact OpenText customer support. OpenText RightFax 10.6 Feature Pack 2 81 Administrator Guide Chapter 7: Configuring the DocTransport modules Configuring Automated Billing Codes Caution If you do not inform OpenText customer support before selecting a different data center, RightFax Connect will not function as expected. To use a specific service URI 1. Under RightFax Connect Data Centers, click Custom. 2. In the Service URI box, enter the URI. By default, the Ignore Certificate Errors is not selected. Caution Selecting the Ignore Certificate Errors check box can lead to security breaches. Only select this option if you are certain that your connection is secure. 2. Select the Enable User Specific Phone Codes check box to enable the Automatic Billing Codes feature. Configuring Automated Billing Codes 3. Add RightFax user IDs and domestic and international phone codes individually or load them from a tabdelimited ASCII file. This feature automatically applies billing codes to outbound faxes based on the user ID of the sender. Configuring automatic billing codes includes assigning domestic and international phone codes to specific RightFax users and specifying dialing rules that tell RightFax when to dial those codes. 4. After you have created a list of RightFax users and their phone codes, you must specify dialing rules that tell RightFax when to dial those codes. See Creating dialing rules and Least-Cost Routing plans on page 185 You can add users and their phone codes individually or load them from a tab-delimited ASCII file containing the user IDs and codes. To add RightFax user IDs and domestic and international phone codes individually To configure automatic billing codes 1. Click Add Entry. 1. In the left pane, click Auto Billing Code Settings. The auto billing code settings options appear in the right pane. 2. In the UserID box, enter a RightFax user ID. 3. In the Dialing Code boxes enter that user’s domestic and international long distance phone codes. 4. Click OK. The new entry appears in the list. OpenText RightFax 10.6 Feature Pack 2 82 Administrator Guide Chapter 7: Configuring the DocTransport modules Running DocTransport on remote computers and one or more remote computers. This distributes the workload of the RightFax server across several computers and provides expanded channel capacity and system redundancy. To create a tab-delimited ASCII file of entries Each entry in this file must include the RightFax user ID, followed by the domestic phone code, followed by the international phone code. Individual entries are separated by a carriage return. For example: JDoe JSmith BJones 1345 1678 1111 One RightFax Enterprise server can support a maximum of 16 separate DocTransport modules. 0345 0678 011 Caution When running DocTransport modules over a WAN, ensure that sufficient bandwidth is available across the network to allow the DocTransport and RightFax server to communicate efficiently. Insufficient bandwidth when running remote DocTransport modules across a WAN may result in timeout errors causing both inbound and outbound documents to fail. To load the tab-delimited ASCII file 1. In the Phone Codes File Name box, type the path and file name of the tab-delimited ASCII file containing the user IDs and phone codes. The following diagram shows remote DocTransport modules in a clustered server configuration. 2. Click Load File. The entries from the file appear in the list. After you load the file, additions, deletions, and editing changes you make in the DocTransport Configuration dialog box are saved. Specify dialing rules that tell RightFax when to dial those codes. To edit an entry l Click the entry in the list, and then click Edit Entry. To delete an entry l Click the entry, and then click Delete Entry. Running DocTransport on remote computers Installation of multiple DocTransport modules is only supported in RightFax Enterprise servers. With the RightFax Enterprise server, you can install and run multiple DocTransport modules simultaneously on the local OpenText RightFax 10.6 Feature Pack 2 83 Administrator Guide remote DocTransports automatically reactivate licensed RightFax OEM channels and resume sending and receiving faxes. When the connection to the RightFax Licensing Service is restored. l Microsoft . the remote DocTransport will stop trying to send and receive faxes.6 Feature Pack 2 l 84 Administrator Guide .Chapter 7: Configuring the DocTransport modules Running DocTransport on remote computers Supported Microsoft Windows operating systems About Channel Licensing with Remote DocTransports RightFax server software is supported on the following server operating systems. OpenText RightFax 10. If the total number of channels on all DocTransport modules exceeds the number of channel licenses. To reassociate the RightFax OEM channels with the original DocTransport. Requirements * installed during setup This section describes the supported Windows operating systems. About RightFax OEM Channel Licenses If a remote DocTransport loses contact with the RightFax Licensing Service on the RightFax server for more than 30 minutes. the remote DocTransport will shut down and an entry will be added to the event log. After three days out of contact with the Licensing service. its licensed RightFax OEM channels will be released.NET Framework * l Microsoft Data Access Components * l Microsoft Messaging Queuing* l Microsoft Visual C++ runtime components* l A Windows account to run RightFax services. the administrator must reduce the number of RightFax OEM channels on the new DocTransport. This must be a domain user that is a member of the local administrators group and has the “Log on as a service” right on the local computer. Windows Server 2012 R2 Datacenter l Windows Server 2012 R2 Standard l Windows Server 2012 R2 Essentials l Windows Server 2012 Datacenter l Windows Server 2012 Standard l Windows Server 2012 Essentials l Windows Server 2008 R2 Enterprise x64 l Windows Server 2008 R2 Standard x64 l Windows Server 2008 Enterprise x86 and x64 l Windows Server 2008 Standard x86 and x64 Local server requirements If the remote DocTransport will be out of service for some time. and the licensing service will automatically associate the released channels with the new DocTransport. the administrator can assign more RightFax OEM channels to a different DocTransport. You must manage the number of activated channels across all DocTransport modules and not attempt to activate more channels than your organization has licensed. The Preview Requirements list shows third-party OpenText RightFax 10. See the RightFax Installation Guide. Required software that will be installed automatically appears with a status of Must Install. Caution If you have changed the default DSN for the SQL connection on the main RightFax server. Click Next. you must manually change the DSN on the remote DocTransport computer to match the DSN on the server. Carefully read and accept the license agreement. 5. 13. 12. click Apply. 34987 and 34988 (Remoting). 11. Do not choose any other Setup components.Chapter 7: Configuring the DocTransport modules Running DocTransport on remote computers software required by your chosen features and the status of setup operations. click Apply. Enter a Windows account to run RightFax services. When finished. The RightFax Product Suite Setup wizard opens. and then click Next. 4. and then click Next. If this software is not installed on your system.6 Feature Pack 2 85 Administrator Guide . This account must also have write access to the Windows registry on the RightFax server. 7. 14. and then click Next. 3. Browse to that location and then run Setup. Click Custom. This will take several minutes. and 36363 (Licensing). Installing DocTransport on a remote computer 9. RightFax DocTransports require Microsoft . add an exception to the windows firewall. Download the RightFax installation program from the OpenText Knowledge Center to a network location. This may take several minutes. click OK to install it. Review the welcome screen. 8. 2. 10. Select your installation folder.NET Framework 4. you must share the RightFax image folder on the RightFax server and grant the DocTransport service account full control. RightFax requires the following TCP ports: 10520 and 10521 (RPC (API and clients)). Select the DocTransport Module Setup component. RightFax server requirements Before installing remote DocTransports. This may take several minutes. and then click Next. click Next. To begin installing RightFax software. and then click Next. Note The Windows firewall on Windows Server blocks incoming connections on port 10520 and 10521. click OK to install it. This must be a domain user that is a member of the local administrators group and has the “Log on as a service” right on the local computer. click Apply. click Next.5. When finished. To install the DocTransport on a remote computer 1. If your server does not already have Microsoft Message Queuing installed. and then click Next. click Next. To prevent other applications from using these ports. When finished. To apply your settings and install required third-party software. To make client connections (faxutil) work. Select your option. 6.exe. To apply your settings and install required third-party software. and then click Next. click Reserve ports. 10062 (DocTransport). To apply your settings and complete Setup. 20. enter the path to the shared image directory to be used by both the RightFax server and the remote DocTransport. click Apply. 19.Chapter 7: Configuring the DocTransport modules Running DocTransport on remote computers This account must also have full control over the \RightFax folder on the RightFax server and have write access to the Windows registry on the RightFax server. 15. In the RightFax Server Name box. and then click Close. enter the name of the server on which the Microsoft Message Queue service is installed.6 Feature Pack 2 86 Administrator Guide . In the DocTransport Queue Server Name box. Click Browse to load and select a user account. 18. click Check Access. In the Image Folder Path box. OpenText RightFax 10. To verify remote access to the RightFax server. All servers on the RightFax system must point to the same MSMQ Server. click Next. and then click Next. When finished. enter your RightFax server. Click Test Account to verify account credentials. 17. 16. About server-side application conversion Where possible. Before configuring your RightFax server to perform serverside application conversion. consider the potential drawbacks of launching an application on the RightFax server each time a file attachment fax image is generated. server-side application conversion supports multiple concurrent document conversions to save processing time and server resources. SMTP. If the conversion quality of faxed file attachments is unacceptably low. Server-side application conversion is available when faxing from: l Files attached using FaxUtil. blank pages are removed from the fax image to save on channel resources and fax costs.Chapter 8: Configuring server-side application conversion About server-side application conversion Chapter 8: Configuring server-side application conversion By default. Document attachments are typically delivered to the RightFax server from one of the email gateway modules (as mail message attachments) or from RightFax Web Access. File attachments sent through the Microsoft Exchange. Also. l Files attached using Web Access. the RightFax server uses its built-in conversion engine to generate fax images from document file attachments that are passed to the RightFax server in their original format. The standard RightFax conversion engine is very fast and efficient. or Lotus Notes email gateways. such as Microsoft Word. or PowerPoint. Excel. The printto-fax conversion is handled by the native application on the client computer before it is sent to the RightFax server. l The Send To shortcut menu.6 Feature Pack 2 87 Administrator Guide . such as: OpenText RightFax 10. l Files attached by using the <ADDDOC> embedded code. your RightFax servers can be configured to use the application that created the attachment instead of the RightFax conversion engine. l The RightFax API and COM API. but there are occasional variances between the fax image it generates and the original document. This is known as server-side application conversion or SSA. l Note Server-side application conversion is not used for documents that are printed directly from the native applications to the RightFax print-to-fax driver. The Conversion Engine can also be configured to use Optical Character Recognition (OCR) technology. 2003. If one or more faxes being processed through server-side application conversion fail to send. versions 2000. see Configuring HTML conversions on page 90. especially if your organization generates a lot of faxes with attached files. Microsoft PowerPoint. OpenText RightFax 10. and 2013. RightFax uses a dedicated HTML conversion engine. Note Files that fail to convert are saved to servername\%ProgramData%\RightFax\Conversion Engine\Errors on the server that attempted the conversion. you can change the sequence. The files can be used when troubleshooting conversion issues. 2007. Install Microsoft Office 2010 or Microsoft Office 2013 32-bit edition on the RightFax server and any WorkServers that you want to perform SSA conversions. 2010. see Controlling server-side application conversion on page 94. Microsoft Excel. It detects when an SSA supported attachment is passed to the RightFax server and launches the appropriate application to convert the file. 88 Administrator Guide . see Using Optical Character Recognition on page 213. If needed. versions 2000.6 Feature Pack 2 Microsoft Word. document templates. You may need to upgrade the RightFax server memory or processing capacity to support server-side application conversion. 2003. and 2013. l l l If server-side application (SSA) conversion does not succeed in creating a fax image. To convert HTML documents. The version of the serverside application installed on the server or WorkServer must be able to open the document versions submitted by client computers.Chapter 8: Configuring server-side application conversion l l l About the RightFax Conversion Engine Full applications are much larger and more processorintensive than the standard RightFax conversion engine. such as incorrect fax image output or conversion failure. Situations may arise in which an application waits for user input (such as a password). 2003. They are automatically deleted after 30 days. The RightFax Conversion Engine converts documents from the following programs: To minimize unpredictable results. and 2013. and other components used by your organization must be installed on the computer or computers that provides server-side application conversion. fault tolerant service that is used to invoke applications used in server-side application (SSA) conversion. For more information. 2007. versions 2000. For more information. the application on the server is not stalled and may be waiting for attention. RightFax uses its built-in conversion engine to create the fax. macros. 2007. RightFax cannot guarantee that it will in all cases be able to prevent or bypass such occurrences. all TrueType fonts. RightFax uses RecoStar to perform OCR conversion. 2010. About the RightFax Conversion Engine The RightFax Conversion Engine is a stand-alone. 2010. For information about OCR setup and configuration. Most applications require some user intervention. Launch each Office application that you have installed on the server and then close it to ensure that any additional setup requirements at the user profile level are completed. Select the defaults for all other options. disable the Exchange Events service. Excel 2010 can create two types of XML output. When the installation is complete. follow these guidelines to install the Microsoft Office Word. and PowerPoint applications (versions 2010 or 2013). SSA conversion through Microsoft Office 2010 or Microsoft Office 2013 32-bit edition converts these file types: To install Office applications 1. l 4. see the RightFax Connector for Microsoft Exchange Administrator Guide and RightFax Lotus Notes Module Administrator Guide. restart Windows. RightFax can convert spreadsheets that have been saved in XML Spreadsheet 2003 format. OpenText RightFax 10. set the security for macros to the lowest setting and clear all check boxes for Protected View. 3. Restart the RightFax server. both with the extension . During the installation.xml. but not Excel 2010 XML Data format. select the following options. RightFax supports Word 97-2013 format cover sheets. run Setup.6 Feature Pack 2 89 Running the Exchange Events service on the RightFax server causes SSA conversion through Word to fail.exe. Excel. l 5. l Microsoft Office versions 2000–2013 l RTF (rich text format) Installation option Select this Destination folder Default destination Installation type Custom installation Components to install Excel Password-protected files are not converted unless the correct password is included in the document conversion options (available only for Outlook or Lotus Notes file attachments). Microsoft Office applications may require some configuration to ensure that server-side application (SSA) conversion works properly. See Creating fax cover sheet templates on page 204. If you must run Exchange Server on the same computer as your RightFax server. For more information.) Word Note the following: PowerPoint l Office Tools Shared Features l 2. For each Office application.Chapter 8: Configuring server-side application conversion Installing Office applications Configuring Office application conversion On each of your RightFax servers and any other computers where RightFax WorkServers will be executed for server-side application (SSA) conversions. Office 2007 Excel documents using the column feature have problems converting. On the RightFax server. Some of the features in Excel 2007 (such as conditional formatting icon sets and data bars) may prevent Administrator Guide . Use this setting to allocate memory (in megabytes) as needed. you can specify memory. Document Monitoring l Maximum conversion time (factor) Application Monitoring Move the slider to the right to use a multiplication factor that increases the estimated conversion time. You can OpenText RightFax 10. use Paste Special to store only the values to a new file. but may just require more time. time out. double-click RightFax Conversion Engine. and then click RightFax Enterprise Fax Manager. copy the data from the worksheet. 4. RightFax uses a dedicated HTML conversion engine to fax HTML files. On the HTML tab. double-click RightFax Conversion Engine. 4. In the Service Name list. point to All Programs. click the name of the RightFax server to configure. The Conversion Engine estimates the conversion time based on the size of the document. Local testing ultimately determines the optimal settings for your environment.The list of services appears at the lowerright pane of the window. click the Open Text folder. To configure HTM and HTML conversions 3. For each application.0 (more). 1. In the Service Name list. click Start. conversion. complete the following fields. Application Monitoring 3. click the name of the RightFax server to configure.0 (less) and 2. Documents that fail conversion are marked as Problem Converting Fax Body or Coversheet. On the RightFax server.6 Feature Pack 2 90 Administrator Guide . l Maximum number of retries Specify the maximum number of conversion attempts per document. Use this setting to allocate memory (in megabytes) as needed. To remedy this. Configuring HTML conversions 2. The Conversion Engine Configuration window opens. The default value of 70 MB is usually adequate for all but the largest documents. click the Open Text folder. In the left pane. and retry settings by completing the following fields. The Conversion Engine Configuration window opens. and then click RightFax Enterprise Fax Manager. To configure Office applications 1. This is useful to troubleshoot documents that seem hopelessly blocked. Local testing will ultimately determine the optimal settings for your environment.Chapter 8: Configuring server-side application conversion increase this time by specifying a multiplication factor on a scale between 1. click Start. In the left pane.The list of services appears at the lowerright pane of the window. The default value of 70 MB is usually adequate for all but the largest documents. 2. point to All Programs. These features convert correctly from Excel 2010 or 2013. On the RightFax server. This is useful to troubleshoot documents that seem hopelessly blocked. the values are in millimeters (19. the values are in inches (. click the Open Text folder. Page Headers and Footers If your conversions require header and footer print codes. double-click RightFax Conversion Engine.6 Feature Pack 2 91 Administrator Guide . In the Service Name list. In the left pane. Specify the maximum number of conversion attempts per document.0 (less) and 2. You can increase this time by specifying a multiplication factor on a scale between 1. Document Monitoring l Maximum conversion time (factor) Page Margins Move the slider to the right to use a multiplication factor that increases the estimated conversion time. You can increase this time by specifying a multiplication factor on a scale between 1. The Conversion Engine Configuration window opens.0 millimeters). 2. If the format includes a comma as a decimal separator. click the name of the RightFax server to configure. If the format includes a period as a decimal separator.0 (more). l 3. Local testing will ultimately determine the optimal settings for your environment. The default value of 70 MB is usually adequate for all but the largest documents. click Start. Application Monitoring Use this setting to allocate memory (in megabytes) as needed. point to All Programs. and then click RightFax Enterprise Fax Manager.0 (less) and 2. Move the slider to the right to use a multiplication factor that increases the estimated conversion time. but may just require more time. This is useful to troubleshoot documents that seem hopelessly blocked. but may just require more time.75 inches). you must add them to the Header and Footer fields. the following fields. OpenText RightFax 10. 4. Use the up and down arrows to configure page margins. On the XPS tab. Number format varies with regional settings. On the RightFax server. Configuring XPS conversions RightFax uses a dedicated XPS conversion engine to fax Microsoft XPS files.0 (more). Documents that fail conversion are marked as Problem Converting Fax Body or Coversheet.The list of services appears at the lowerright pane of the window. The Conversion Engine estimates the conversion time based on the size of the document.Chapter 8: Configuring server-side application conversion Document Monitoring l Maximum conversion time (factor) To configure XPS conversions 1. The Conversion Engine estimates the conversion time based on the size of the document. Maximum number of retries setting. errors and warnings are written to the Windows Event Logs based on event log settings. Note The RightFax Conversion Engine configuration program cannot be opened from a remote computer. l Error Records critical errors only. while the diagnostics window shows all messages in real-time. OpenText RightFax 10. On the RightFax server. click the Open Text folder. 5.Chapter 8: Configuring server-side application conversion l Maximum number of retries setting. 2. For more information about debug mode. l Verbose Records all significant events and is most useful for tracking and resolving problems. l Off No information is saved. click Start. l Warning Records errors and major events only. major events. Documents that fail conversion are marked as Problem Converting Fax Body or Coversheet. Each of these messages can be customized using categories and logging levels. point to All Programs. Controls the maximum number of conversion attempts per document.6 Feature Pack 2 Info Records errors. By default. Caution If you leave this value set to “Verbose” for long periods of time.The list of services appears at the lowerright pane of the window. and informational messages. 4. 92 Administrator Guide . select the level of logging for the selected categories. Click OK. and then click RightFax Enterprise Fax Manager. In the Service Name list. click the name of the RightFax server to configure. In the left pane. double-click RightFax Conversion Engine. select the message categories and in the list below. Click the Logging tab. 3. l To configure the conversion logging 1. When the service is running in debug mode. all output is written to the Windows Event Logs. see Troubleshooting the Conversion Engine on page 94. 5. Configuring conversion logging The Logging tab provides RightFax administrators with control over the types of messages logged by the Conversion Engine. In the Select one or more message categories to change box. the Event Log can become full which may prevent new events from being logged. In case server-side application conversion fails. 7. 6. In Windows Control Panel. On the RightFax server. In the list of services. When prompted to restart the server. stop all WorkServer services. open Services. Edit the Windows Registry length of time indicated by the KillServiceTimeout value on the RightFax server for each workserver. 3. double-click RightFax Conversion Engine. you can configure RightFax to automatically time out. 2.The list of services appears at the lower-right pane of the window. click Yes. For more information. To have the WorkServers recover after being stopped by this feature To set the service account 1. 1. see Starting Enterprise Fax Manager on page 18. be sure to select View 32-bit Control Panel Items in Control Panel.6 Feature Pack 2 93 Administrator Guide . 1. Click OK until you have closed the configuration windows. start RightFax Enterprise Fax Manager. and then open RightFax WorkServer. Restart the services. 4. and cannot be used as the service account. In the left pane. Enter the information for an account that has permission to: l Open the Microsoft Office programs. The Local System account does not have these permissions. stop the conversion. l Print. \ 2. click Service Account. In the Conversion Engine Configuration window. 3. l Create a printer. open Administrative Tools. Note To view the RightFax control panel icons on x64 systems. and set the fax status to conversion failed. This account must also have a profile on the RightFax Server. click the name of the RightFax server. On the RightFax server. See KillServiceTimeout on page 358.Chapter 8: Configuring server-side application conversion Configuring the service account Configuring the service account To configure timeout on a failed conversion The Conversion Engine must be run under an account that has permission to open the conversion applications and permission to create a printer. 2. To configure the timeout 5. OpenText RightFax 10. On the Recovery tab select the service's response to the shutdown. The conversion type with the higher number is attempted first. you can temporarily set the service that runs the Conversion Engine (RfIsoConv. and save the output to an RTF or TXT file. Note the following about making configuration changes to the conversion engine while it is running in debug mode: l l Configuration changes are not reflected in the diagnostics window until you restart the service. Saving configuration changes by clicking OK in the OpenText RightFax 10. you can run the Conversion Engine in debug mode for real-time monitoring. and then click Debug. the SSA conversions are set to the higher numbers and thus attempted first. Note When editing the xml file.The list of services appears at the lower-right pane of the window. Controlling server-side application conversion To control whether server-side application (SSA) conversions or built-in conversions are attempted first l To run the Conversion Engine in debug mode Edit the ConversionQuality number value in RightFax\Worksrv\Converters\ConversionControl. For more information. click the name of the RightFax server.exe) to manual startup. 3. The diagnostics window shows errors and warnings in different colors and allows the service to be started. On the RightFax server. group by processes. Troubleshooting the Conversion Engine Like all RightFax services. You can customize the trace (logging) level. and troubleshooting. In the left pane. The Diagnostics window opens. start RightFax Enterprise Fax Manager. paused and resumed. while built-in conversion is set to the lowest numbers and attempted only if the SSA conversion fails. In the list of services.0 and 1. right-click RightFax Conversion Engine. 1. logging. By default. To avoid this during troubleshooting.Chapter 8: Configuring server-side application conversion Controlling server-side application conversion configuration window will automatically restart the service.6 Feature Pack 2 94 Administrator Guide . stopped. see Starting Enterprise Fax Manager on page 18.xml. 2. Enter a number between 0.0. 4. take care to change all entries that have the same ConversionFileQuality ConverterId to the same ConversionQuality value. such as Microsoft Active Directory or any LDAP (Lightweight Directory Access Protocol) compliant data source. and permissions. l LDAP support. About the Sync module The Sync module is an XML/XSLT based tool that allows RightFax administrators to create and update users from Active Directory (domains. preferences. Configure the RightFax databases to update. 2. The original data source is not changed. See Configuring a data source on page 97. Features Synchronization data is not stored in Active Directory. Configuration overview When you use the RightFax Sync module.6 Feature Pack 2 Synchronization is managed as a standalone service. See Creating mappings on page 103. OpenText RightFax 10. Getting started Select the Windows account from which to run the Sync module. See Defining data sources and destinations on page 96. and organizational units) and LDAP compliant data sources. If synchronizing with Active Directory. 3. you can import and update this information in real-time or at definable intervals from other data sources. groups. Configure the data sources from which to sync users. logon information. l l 1. 4. Map which data sources will update each RightFax database and how often. With the RightFax Sync module. This database defines each user’s RightFax-specific contact information. Define one or more Active Directory (AD-) or other LDAP compliant (LDAP-) data sources from which to update user information and one or more RightFax destination databases to update. l Nested groups are not automatically included when synchronizing from parent groups. the account must be a member of the Active Directory Domain Users group.Chapter 9: Enabling and using the RightFax Sync module About the Sync module Chapter 9: Enabling and using the RightFax Sync module RightFax maintains a database of users. l Support for multiple domain environments. 95 Administrator Guide . See Configuring a destination database on page 102. only the RightFax destination database is updated. l Robust real-time logging and diagnostics. Note The Sync module cannot be configured from a remote computer. 2. 96 Administrator Guide . type a unique name for the destination database. click Sources & Destinations. double-click RightFax Sync Module. 4. Click OK. or LDAP . The RightFax Sync Module Configuration opens. This name becomes the label of the associated tab.Chapter 9: Enabling and using the RightFax Sync module Defining data sources and destinations that source or destination is added in the Sync Module Configuration window. After you define a data source or destination. In the Name box. In the Type box. This name becomes the label of the associated tab. select either: l l Active Directory (Source) for an Active Directory source LDAP (Source) for an LDAP-compliant source. It is not cached. 2. Defining data sources and destinations You can define as many data sources and destinations as you need. Click New.for Active Directory sources. preceded by the code RF. select OpenText RightFax (Destination). On the General tab. The Define Source or Destination window opens. Click Service Account to select a Windows account from which to run the Sync module. 5. In Windows Control Panel. The Sync Sources and Destinations window opens. 1. 4. To define a new data source To get started 1. 3. In the Type box. On the General tab. To define a new destination database 1.for RightFax.for other LDAP-compliant sources. Important The service account password is only retained until the control panel closes. 3. The Sync Sources and Destinations window opens. a tab for OpenText RightFax 10.6 Feature Pack 2 5. preceded by the code AD . 2. The Define Source or Destination window opens. type a unique name for the source. Click OK. In the Name box. click Sources & Destinations. Click New. a new property collection and a new transform is created. Note To include domain user accounts in the synchronization. 4. Click OK. click Sources & Destinations. click Import.source. Select the source or destination you want to delete and click Delete. You can include and exclude users based on groups. deleted. Click Yes to confirm that you want to delete the source or destination. OUs do not include domain users.You must choose a domain and at least one Organizational Unit (OU) or group for each set of users. l 4.Chapter 9: Enabling and using the RightFax Sync module Configuring a data source To rename a data source or destination Note If you need to change the filter type for a data source from OU to group or group to OU. LDAP sources have the prefix LDAP-. To delete a data source or destination 1. Filters specify which users will be synchronized into RightFax. do the following: Configuring a data source l For each data source. on the General tab for the source. When you import a profile. you must configure how the Sync module will bring the data into the RightFax database. you must first delete the data source and recreate it for the new filter type. On the General tab. Select the source or destination you want to rename and click Rename. 2. In the Sync Module Configuration window. See Defining data sources and destinations on page 96. Click OK. To select an existing AD sync profile or LDAP configuration. click Sources & Destinations. Filters. This data is transformed into a format suitable for the RightFax database. This includes defining the following: l Output. Active Directory sources have the prefix AD-.6 Feature Pack 2 97 Administrator Guide . On the General tab. OpenText RightFax 10. select a configuration from the list or create a new configuration file (see Creating a new LDAP schema on page 101). In the Name box. 2. 3. click the tab for the source you want to configure. The output configurations specify how to synchronize users into the RightFax database if they are found to be new or modified. 3. or disabled (for AD sources only). 1. l For an AD.source. on the Special tab for the source. 2. select a group filter type. type the new name. Without filters synchronization does not occur. To configure a data source 1. For an LDAP. On the Filters tab for the source. For AD sources only. 2.6 Feature Pack 2 98 Administrator Guide . See To define the output for new/modified users on page 99. add or remove groups you want to include and exclude. On the Output tab. click New. OpenText RightFax 10. The output for deleted users for the source. Click Apply. Click OK. 4.The filter appears on the Filters tab of the source. 5. See To define the output for new/modified users on page 99. and click OK. As needed. Next to the Domain box. click Browse and select the check boxes next to the units you want to select. 4. select your domain. 3. On the Filters tab. As needed. See To define the filters on page 98. click Browse. 3. in the Included Groups box and the Excluded Groups box.Chapter 9: Enabling and using the RightFax Sync module Configuring a data source To define the filters 1. the output for disabled users. 5. See To define the output for disabled user accounts on page 100. define the filters for the source. define the following: l l l The output for new and modified users. The Define Filter window opens. click Edit Collections. highlight the properties you want to update each time the Sync program runs. Default property collections cannot be edited. b. but you can make a copy of the default to create a new collection. To select a predefined collection of typical properties for OpenText RightFax 10. l To create a new property collection. By default. In the Property Picker dialog box. To add properties to the selected collection. a. and then click OK. and then click Copy. the Windows browser selects the parent domain for directory searches. click Add. enter a unique name for the collection.Chapter 9: Enabling and using the RightFax Sync module Configuring a data source Windows or Exchange users. Under New/Modified Users. highlight the collection in the list. Click the Output tab for the source. click Default Windows Properties or Default Exchange Properties respectively. Note When synchronizing with Active Directory. highlight the properties and click Remove. If this is a new property collection. Click Locations to browse to and select the correct domain. Do one of the following: l To define the output for new/modified users l 1. The Property Collections dialog box opens. To create a new property collection based on an existing one. hightlight the collection you want to copy in the list. click New. in the Name/Description box. 2. and then click Edit. define a collection of any number of Active Directory text-based properties that will be used update the RightFax database.6 Feature Pack 2 99 Administrator Guide . To remove properties from the selected collection. This allows for finer control of which groups and OUs to include. c. nested groups and OUs are NOT automatically included. e. Note When browsing for a group that resides in a child domain. change the Windows browser to point to the child domain. To create a new or edit an existing property collection. To edit an existing collection. d. Click Apply. 100 Administrator Guide . Selecting a delete option will result in unintended deletions of users. Use this option only in combination with the 'Only delete if user is empty' or the 'Never delete users' option. To define the output for deleted users Caution Do not select any of the delete options for syncs with multiple sources.Chapter 9: Enabling and using the RightFax Sync module Configuring a data source entries).6 Feature Pack 2 These options apply only to AD data sources. If a user that was created on the RightFax server through an Active Directory synchronization does not subsequently appear in Active Directory. users created by a preceding source will be detected as “no longer included” in the current source within the same sync. Caution Selecting this check box when 'Always delete users' is selected can result in a large-scale deletion of users and their faxes. On the Output tab for the source. l l Never delete users. f. This is also true when using filters to sync subsets of previously-synced users. 1. Click OK to close the Property Collection dialog box and then the list of Property Collections. select the OPTIONAL: Treat users that were previously synced but are no longer included in the sync as if they had been deleted check box. Select this option when synching multiple sources. the specified deletion action will be performed. under Deleted Users. The user is only deleted if the record is empty (meaning there are no documents or phonebook OpenText RightFax 10. Always delete users b. Select one of the following: l To define the output for disabled user accounts Only delete if user is empty. you can treat that user as a deleted user. a. To do so. If the check box is selected. 2. specify how RightFax will synchronize users deleted from Active Directory. Caution In syncs with multiple sources. Delete disabled users only if empty.. Under Server. On the Schema tab. Click Apply.change the default and standard LDAP values as needed. click [. configure how deleted 101 Administrator Guide . To move disabled user accounts that are not deleted according to the above setting to a specific RightFax group every time sync is run. click OK. you receive the message Validation Successful. Under Security. type the name of the group in the box. If correct. On the General tab of an LDAP .. b. 2. 4. enter a unique name for the configuration. Users disabled in AD who have an Exchange mailbox are imported into RightFax independent of whether they exist in RightFax and whether you selected to delete disabled users. name/organization) followed by a port number used by your LDAP server. Caution Selecting this option can result in a large-scale deletion of users and their faxes. To use a different group. Select one of the bundled configuration options such as Default LDAP or Default Notes LDAP. Select this option when synching multiple sources.source. enter the authentication method employed by your LDAP server. do the following: a. Click OK. Disabled users are deleted if the record is empty (meaning there are no documents or phonebook entries. The LDAP Configurations window opens. Delete disabled users. On the Deleted Objects tab.. select the Always import disabled users who have Exchange mailboxes check box. By default. You can fine-tune the settings for disabled user accounts by selecting any of the following options: l l To import disabled user accounts that have an Exchange mailbox every time sync is run. select the Always OpenText RightFax 10. d. c. enter a host and base DN (i. The Select Default Configuration window opens.e. Click Validate to confirm your information. 2. 1. Disabled users are deleted. 7. 1. Disabled users are not deleted. in the Configuration Name box.6 Feature Pack 2 6. On the Connection tab. a RightFax group "SyncedDisabled" is created. Click New. Select one of the following: l l 3. On the General tab. Selecting a delete option will result in unintended deletions of users. Under Disabled Users.Chapter 9: Enabling and using the RightFax Sync module Configuring a data source move disabled users to this RightFax group check box. Caution Do not select any of the delete options for syncs with multiple sources.].) 5. specify how RightFax will synchronize user accounts disabled in Active Directory. Creating a new LDAP schema Ignore disabled users. l 3. To configure a destination database 1. each with a different model user. Click RightFax Account and select a RightFax account that has Administrative Access permission and is dedicated solely to the Sync module. Under Incoming User Account Mapping. create a search filter to provide results associated only with deleted objects. In the Sync Module Configuration window. and OUs) will be tracked.6 Feature Pack 2 102 Select the Replace empty routing code with RightFax User Template's routing code check box to replace the pre-existing routing code of a RightFax user whose fax number was deleted in the Active Directory with the RightFax User Template's routing code. You can set up multiple RightFax/Destination profiles. Administrator Guide . On the Server tab. 3. in the Server Name box. and if necessary. enter the RightFax server name. click the tab for the destination you want to configure. you must configure how the data is brought into the RightFax database. 2. You will not have to manually change the routing code. customization. such as having different users synchronized into different RightFax groups. 5. groups. This allows for OpenText RightFax 10. Configuring a destination database For each destination database. 6. New users inherit all settings associated with the specified user. On the Users tab. This feature can only be used in LDAP environments that support object tracking. use NT authentication. or with different RightFax permissions. select the Attempt to map onto existing RightFax users check box if you want the Sync module to check for potential user matches before creating new RightFax users. The Sync module uses this account to create and delete users on the RightFax server. Under Modified User Account Mapping. Specify a deleted objects storage container.Chapter 9: Enabling and using the RightFax Sync module Configuring a destination database objects (users. To avoid this. the RightFax account password will be saved as an encrypted registry item on the RightFax server. enter a RightFax user account to use as a template or model for creation of new synchronized users. specify how the Sync module will handle modified users: l 4. Important If you do not use NT authentication. Under Schedule. On the General tab. You can define as many mappings as you need and use sources and destinations in more than one mapping. For example. Mappings define how and when sources and destinations are synchronized. The transform file is responsible for transforming data generated by the source into an XML file translated by the destination. Creating mappings After you have defined and configured data sources and destinations. and select the transform file relevant to your environment. In the Source and Destination boxes. Click OK.6 Feature Pack 2 103 Administrator Guide . Verifying user synchronization In Enterprise Fax Manager. 5. you can synchronize a single Active Directory source into two different RightFax servers. click New. you must map sources to destinations to specify which sources will update each destination database. select your source and destination. specify when synchronization is to occur. Under Transform File. 3. The Sync Mapping window opens.Chapter 9: Enabling and using the RightFax Sync module l Creating mappings Select the Allow sync to change RightFax UserIDs check box to automatically change the User ID of a RightFax user whose ID was changed in the Active Directory. click Browse. To create a new mapping 1. OpenText RightFax 10. This file together with the RightFax User Template can be edited to create a custom synchronization template. You will not need to manually modify the User ID. or two different sources into a single RightFax server. 4. users created or updated by the Sync module appear with a dot next to their user icon. open \RightFax\Capasync\Config. 2. you can temporarily set the service that runs the Sync module (CapaSync. group by processes.exe) to manual startup. logging. you can run the Sync module in debug mode for real-time monitoring. RightFax administrators can control which types of messages are logged by the Sync module. When the service is running in debug mode. To avoid this during troubleshooting. Using the Logging tab. all output is written to the Windows Event Logs. paused and resumed.Chapter 9: Enabling and using the RightFax Sync module Creating mappings Troubleshooting The Sync module provides administrators with convenient and customizable real-time logging and troubleshooting tools. You can customize the trace (logging) level. The diagnostics window shows errors and warnings in different colors and allows the service to be started. Administrator Guide . stopped. Diagnostics Logging Like all RightFax services. Each message can be customized using categories and logging levels. Note the following about making configuration changes to the Sync module while it is running in debug mode: l l OpenText RightFax 10. By default.6 Feature Pack 2 104 Configuration changes are not reflected in the diagnostics window until you restart the service. while the diagnostics window shows all messages in real-time. Saving configuration changes by clicking OK in the configuration window will automatically restart the service. errors and warnings are written to the Windows Event Logs based on event log settings. and save the output to an RTF or TXT file. and troubleshooting. 6 Feature Pack 2 105 Administrator Guide . and browse to the services view in the lowerright corner. Open Enterprise Fax Manager. click your fax server name. 2. When the service has stopped. The Diagnostics window opens. right-click the service and select Debug. OpenText RightFax 10. 3. Right-click the RightFax Sync module and choose Stop.Chapter 9: Enabling and using the RightFax Sync module Creating mappings To run the Sync module in debug mode 1. see About the RightFax user DEFAULT on page 107. start EFM. You can customize each user’s access to and usage of the system in the user profile. The list of users appears in the right pane. see Starting Enterprise Fax Manager on page 18. Administrator Guide . Managing RightFax users To open the list of users 1. A dot: The user is synchronized with another application. and then click Users. The RightFax server uses the user ID to assign ownership to sent faxes and route received faxes to their intended recipients. For more information about this user. For more information. expand the RightFax server. In the left pane. The icon next to the user ID shows if the user has administrative access or is synchronized with another application: 2. It always includes the DEFAULT user. Blue icon: The user does not have administrative access. l l l OpenText RightFax 10.6 Feature Pack 2 106 Red icon: The user has administrative access. On the RightFax server. Editing changes should be made in that application only.Chapter 10: Creating RightFax users Managing RightFax users Chapter 10: Creating RightFax users Every RightFax user in your organization must be assigned a unique user ID and profile on a RightFax server. click Delete. Password. User Name. deleting. To create a new RightFax user 1. or automatic enrollment — on the user profile of the DEFAULT user. see Enabling and using the RightFax Sync module on page 95 Creating. On the Edit menu. synchronization. and editing users 3. the profile settings for Active Directory synchronization override any user profile settings of the DEFAULT user. Open the list of users. To delete a user 1. Note If you use Active Directory synchronization. On the Edit menu.Chapter 10: Creating RightFax users About the RightFax user DEFAULT RightFax bases the creation of new users — including through importing. 2. Caution Do not delete or rename the DEFAULT user ID. except for User ID. The new user has the same attributes as the DEFAULT user ID. All other boxes are optional. see Creating a user profile on page 108. It is required for many functions and deleting or renaming it could lead to parts of RightFax not functioning as intended. For information about completing these options.6 Feature Pack 2 107 Administrator Guide . copying. 2. click New. It is good practice to customize the DEFAULT user profile with the attributes of the majority of your fax users. In the User ID box enter a unique user ID for the new user. Open the list of users and make your selection. For more information. and Distinguished Name. and then confirm the deletion. OpenText RightFax 10. see the RightFax Administrative Utilities Guide. The User Edit window opens. this ID should be the same as the user’s network login name. Use Integrated Windows NT Security 1. 1. see Setting preferences on page 20. On the Edit menu. To edit the properties of an existing user l Select the user in the list of users.Chapter 10: Creating RightFax users Creating a user profile To copy users from one server to another The Identification tab 1. In Enterprise Fax Manager. For more information. select the user. 2. The User Edit window opens. Click Select NT Account and select the user’s OpenText RightFax 10. On the Edit menu. click Edit. User ID Creating a user profile Enter a unique identifier to be used throughout the RightFax system to identify a user. any configuration data not supported by the older version will be lost. see Creating a user profile on page 108. 2. The amount of information copied depends on settings in the Enterprise Fax Manager Preferences window. For more information. For more information. click Edit. Select this check box to link this RightFax user to a Windows user account and use Windows authentication to access the user account. 2.6 Feature Pack 2 108 Administrator Guide . Open the list of users and make your selection. In most cases.exe. Note If you copy users from a new RightFax server version to an older one. To make global changes to selected groups of users l Use Moduser. The ID can be up to 21 characters long. A RightFax password will not be used. Drag the selection to another server. You can also select from a list of all user accounts in each domain. E-mail address User Name Enter the user's email address to ensure that: Enter a descriptive name to identify the user. RightFax can determine the correct RightFax user as the sender. l l Password If you did not select to use Windows Authentication. enter the password for the user to access his personal FaxUtil mailbox and to gain access to the RightFax settings in Enterprise Fax Manager. For information on creating new groups. and editing groups of users on page 124. deleting. If you leave this box blank. click Change Password and enter a new password. All users must belong to a group. This is the number to which SMS notifications about the user’s sent and received faxes will be sent. The user will be able to send documents to email as well as fax addresses When email gateways are used. This box is also used to assign TeleConnect mailbox numbers to RightFax accounts (requires the TeleConnect module. the user will not be required to enter a password when accessing RightFax client applications. Group ID Select the name of the RightFax group to which the user belongs. To change a user’s password. purchased separately). see Using Integrated Windows Authentication on page 121 and Linking RightFax user IDs to Windows accounts on page 122. copying. To add user names with diacritical or other characters refer to the RightFax Installation Guide for information about character sets and code pages on your RightFax server. SMS/Mobile Address Enter the user’s SMS-capable cell phone number. OpenText RightFax 10. see Creating. Distinguished Name Enter the Microsoft Exchange distinguished name used to confirm accurate RightFax and Exchange user synchronization. For more information. Voice Mail Subscriber ID Enter the mailbox number to use when routing faxes to a telephony server.Chapter 10: Creating RightFax users Creating a user profile Windows user account. Compute Disk Usage Click to calculate the space on the server that is taken by this user’s faxes.6 Feature Pack 2 109 Administrator Guide . You can grant this OpenText RightFax 10. This attribute is only effective if billing code verification is required systemwide. Assign Default Billing Codes to Received Faxes If selected. the user can send faxes without supplying correct billing codes. Note This check box applies only to WorkServer archiving of outbound faxes. the user can change cover sheets and is not restricted to use the cover sheet specified in the Default Outbound Settings tab (The Default Outbound Settings tab on page 114). the user's outbound faxes are archived according to the Archive options defined in the WorkServer configuration program (see Archive settings on page 50). the user can add new overlay forms to the RightFax system using the Store as Form feature of FaxUtil. This does not exclude the user from having to supply other required fields to send faxes. Administrator Can Bypass Privacy Restrictions If selected in addition to Administrative Access. the user's default billing code settings (see The Other tab on page 115)are applied to all received faxes. Can Edit/Add Forms If selected.6 Feature Pack 2 110 Administrator Guide . the user can view faxes in other users’ mailboxes. This includes running Enterprise Fax Manager and performing administrative tasks on the mailboxes of other users. This is most useful if RightFax is set up to require billing codes on received faxes (see Requiring billing codes on page 146).which is disabled when XML Generator or Vault are configured. the Administrator Can Bypass Privacy Restrictions option must also be selected. The Permissions tab Archive Sent Faxes If selected. Administrative Access If selected. Administrative access does not grant permission to view the faxes of other users. Can Change Cover Sheets If selected. the user has access to the administrative functions of RightFax. To give an administrator access to faxes in the mailboxes of other users. Bypass Billing Code Verification If selected.Chapter 10: Creating RightFax users Creating a user profile permission to other users only if you are an administrator that has this permission. In addition. the user can OCR faxes. This attribute does not affect OCR routing and does not have to be enabled if OCR routing is being used. the user cannot delete faxes. the user can send documents to SMS addresses from within the RightFax client applications. Can Run Reports If selected. see the RightFax Administrative Utilities Guide. or configure MAPI. If selected. For more information about Fax Reporter. the user cannot view the list of valid billing codes. For more information about Web Reports. the user cannot change the default billing code settings for outgoing faxes. the user cannot change his or her notification options. OpenText RightFax 10. EDC Process on Forward. see the Web Reports Help. the user can add new library documents to the RightFax system using the Store in Library feature of FaxUtil. Disallow Creating and Editing of Phonebooks If selected. You must have licensed the RightFax OCR Conversion module for any OCR functions to be available. and ODBC phonebooks. the user can use only “normal” and “low” priorities. the user cannot add notes to faxes. Can Send SMS Messages Disallow Modification of Delegates If selected. the user cannot create or edit phonebook entries and phonebook groups. Disallow Fax Annotations If selected. For more information. as defined in FaxUtil. Disallow Editing of Billing Codes If selected.Chapter 10: Creating RightFax users Creating a user profile Can Edit/Add Library Docs Disallow Changing of Notification Options If selected. This setting can be useful for persons doing manual fax routing. the user can create reports using the RightFax Fax Reporter utility and the Web Reports web site. Can Use High Priority If selected. requiring the user to know at least one valid billing code. LDAP. the user cannot control delegate access to mailboxes. Can OCR Faxes If selected. Excluded from Group Fax Aging Note You must select both Disallow Billing Code Lookup and Disallow Editing of Billing Codes to ensure that users cannot modify their default billing code settings. If selected.6 Feature Pack 2 If selected. 111 Administrator Guide . If not selected. either manually or automatically. see the RightFax XML GeneratorAdministrator Guide. Delete EDC Process Received Faxes EDC Process Sent Faxes Disallow Billing Code Lookup These settings are used with RightFax connectors that are purchased separately and apply to the XML Generator module. Disallow Fax Deleting If selected. the user's faxes are not subject to the automatic fax aging (image deletion) attributes of the group to which he belongs. Route. the user can send faxes using “high” priority. If selected. any billing codes specified in phonebook entries are ignored as are any <BILLINFO> embedded codes. Unprotected Mailbox If selected.of sender. View First Page Only If selected. the fax is routed to the user’s mailbox. CSID (caller subscriber identification). or channel number you have assigned to this user. The restriction applies to the mailbox regardless of the permissions of the user viewing the mailbox. group. Routing Code (DID/DNIS Number) The routing code is a unique number that RightFax uses to route received faxes to the correct user. Stamp Pages of Received Faxes with Audit Stamp If selected. When a fax is received by the server. fax server used. Enter the DTMF extension. This does not affect the security of phonebook entries belonging to the user.Chapter 10: Creating RightFax users Creating a user profile Must Have Faxes Approved The Inbound Routing tab If selected. printing of the RTI line is enabled and one line of text will be added to the bottom of each received fax page listing total pages. For more information on routing faxes. all other RightFax users can view. inbound routing code used. OpenText RightFax 10. any routing information included is compared to each user’s Routing Code. incoming faxes are only delivered to one of the specified users. This does not restrict the user from changing his password. date and time received. If you use the same routing code for multiple users. the user must have a password.6 Feature Pack 2 112 Administrator Guide . Must Have Password If selected. see Routing inbound faxes on page 220. This is useful when manual routing is employed. Faxes must be routed out of the restricted mailbox before subsequent pages can be viewed or printed. or alternate group administrator. manipulate and delete documents in this user’s mailbox. Note Ensure that each routing code is assigned to only one user. If a match is made. DID phone number. the user can view or print only the first page of a received fax. every fax sent by the user must be approved by a full. and transmission duration. Chapter 10: Creating RightFax users Creating a user profile TIFF-G3/ TIFF-G4 Routing Type Select where incoming faxes will be routed after they arrive in the user’s fax mailbox. see Routing inbound faxes on page 220. you must enter the email address here. PDF The searchable portable document format includes a (searchable) searchable text component. because PCX is a large format and users have to sift through multiple attachments when viewing multiple page faxes. notification of received faxes will not work. For more information. Format Description DCX DCX combines multiple PCX pages into a single file. It does not improve the appearance of graphics. TIFF TIFF (Enhanced) can help improve the readability of text (Enhanced) by straightening skewed pages and removing background noise. see the RightFax Connector for Microsoft Exchange Administrator Guide. 113 Administrator Guide . The portable document format. If you route faxes to an email mailbox. and you can associate the RightFax Fax Viewer with TIFF-G3 files to view these faxes in any application. OpenText RightFax 10. This format is not recommended for Windows client applications. It solves the multiple attachment problem of PCX files but maintains the large file size (average of 135 Kb per page). It is useful for routing received faxes to DOS and Macintosh users because DOS and Macintosh have built-in capabilities to view PCXformatted fax pages. See Notification about received faxes on page 121. GIF The graphics interchange format is available for routing in Microsoft Exchange. If this check box is selected. PCX PCX produces a single page per file with an average fax page size of 135 Kb. Received Fax Routing Form If you selected Exchange Mailbox as the Routing Type. PDF Delete After Routing Select this check box to delete a received fax from the user’s FaxUtil mailbox after the fax has been successfully routed to the application specified in the Routing Type list. select the Outlook form to which you want to route incoming faxes.6 Feature Pack 2 TIFF-G3 is a structured file type that is best for monochromatic images like fax pages (average of 35 Kb per page). Most email systems can read TIFF-G3 files. The available formats vary depending on the routing type you choose. Select the file format in which faxes are delivered when routed. It requires additional licensing. For information on the required Routing Info for each Routing Type see Routing inbound faxes on page 220. all received PDFs are searchable regardless of which PDF format is selected. For more information on each of the routing types. Routing Info Specify how to route the fax to the correct destination for the Routing Type specified. File Format TIFF-G4 is a more compressed file format. When licensed. Select System Default to use the form set in the Email Gateway configuration program. and notifications of sent faxes (Sent Fax Notifications) will not be sent. Normal resolution (200×100 DPI) creates draft quality images and allows shorter transmission times. Only If Successfully Sent Select this option if the account will be used to send large broadcast faxes. The user can set a different priority when creating a fax. even if this option is enabled. Specify whether to auto-delete faxes: l l l Never Sent faxes are never automatically deleted. Fine resolution (200×200 DPI) is recommended for high quality printed documents and Optical Character Recognition (OCR). Fax image files. The user can review and forward sent faxes and notifications of sent faxes are sent. or enabled autoprinting of sent faxes in the FaxUtil client application. The list shows the fax cover sheet files created in EFM\Cover 114 Administrator Guide . are deleted. All Faxes Select this option to prevent large numbers of faxes from accumulating in the user’s fax box and to save disk space. Default Fax Resolution Use Smart-Resume Specify the resolution of the body of the user's outbound faxes: l l Select this check box to have the fax server resend only the portion of a fax which failed to send.6 Feature Pack 2 Specify the default fax cover sheet file to use for this user. Select this option for most users. sent faxes will not be automatically deleted. Send Cover Sheets Select this check box if the user should be able to send cover sheets with faxes. not original documents created in other applications. This option can also be set by fax users on a per-fax basis from the Fax Information dialog box (see Specifying addressing information on page 236). OpenText RightFax 10. If the user has the Archive Sent Faxes permission.Chapter 10: Creating RightFax users Creating a user profile Auto-Delete Setting The Default Outbound Settings tab Caution Auto-deleting sent faxes prevents users from reviewing or forwarding their sent faxes. Default Priority Cover Sheet Model Select default priority for the user’s faxes. Sender Information Fields Specify the user’s name. and phone number information as it appears on fax cover sheets.6 Feature Pack 2 115 Administrator Guide . Automatic Fax List Updates Configures the user’s FaxUtil mailbox to automatically refresh (scan for new faxes). Default printer Specify a default printer. Select System Default to use the fax cover sheet specified for the user's group or Set System Default if no group cover sheet assigned. OpenText RightFax 10. Default Billing Codes Specify the Billing Code #1 and Billing Code #2 settings that will appear in the Fax Information dialog box each time the user sends a fax. Fine resolution (200×200 DPI) is recommended for high quality printed documents and Optical Character Recognition (OCR). Update Interval in Seconds Specify the interval at which automatic fax list updates occur. fax number.Chapter 10: Creating RightFax users Creating a user profile Sheets. The Other tab Cover Sheet Resolution Specify the resolution of the user’s cover sheets: l l Normal resolution (200×100 DPI) creates draft quality images and allows shorter transmission times. For information on configuring pager or SMS services. the RightFax server includes the TeleConnect ID with all notifications of incoming faxes. If you have not added and properly configured paging/SMS services for this user. For more information.6 Feature Pack 2 116 Administrator Guide . you must do so before completing this dialog box (See Adding SMS and pager services on page 161). you must configure a list of SMS and pager service types and providers. OpenText RightFax 10. see Configuring user messages on page 40. Patterns Enter the CSID or ANI numbers that. The text of these status messages can be customized in RightFax Server configuration. This is usually a numeric ID and is often the phone number for the pager.Chapter 10: Creating RightFax users Creating a user profile Description Pager ID Enter any information you want to record about this user account. These settings determine how and when SMS messages or pages are sent to RightFax users to notify them about the status of sent and received faxes. The Pager Notification tab Pager/SMS Service Select the pager or SMS service to use for delivering the notification. Test SMS Click to send a test message to an SMS-capable device after selecting an SMS service in the Pager/SMS Service box and typing a phone number in the Pager ID box. when received. Specify the user’s pager ID. will send a page alert to the user. Users can retrieve faxes without first requesting a fax list. Before completing this dialog box. If the TeleConnect module is installed. see Adding SMS and pager services on page 161 New Fax is Received Select this check box to page the user each time a new fax is received. Separate multiple numbers with semicolons. New Fax is Received from Specific CSID/ANI Select this check box to page the user each time a new fax is received from the sender or senders you enter in the Patterns box. Outbound Fax has been Abandoned Select this check box to page the user each time one of his outbound faxes fails to send for any reason. Chapter 10: Creating RightFax users Creating a user profile The Administrative Pager Alerts tab You can define to send SMS or pager alerts to RightFax administrators about specific RightFax events. see Adding SMS and pager services on page 161. OpenText RightFax 10. For more information. Test SMS Click to send a test message to an SMS-capable device after you type a phone number in the Pager ID box and select an SMS service in the Pager/SMS Service box. To configure pager and SMS services. see Configuring admin messages on page 42). and alert messages to send. you must have configured a list of SMS and pager service types and providers. you can use the more comprehensive RightFax Alerting and Monitoring service to select from hundreds of server statistics to monitor and define the event thresholds. see Using the Alerting and Monitoring service on page 165. see Adding SMS and pager services on page 161. Pager/SMS Service Select the pager or SMS service to use for delivering the alert message. The text of the alert messages can be customized in RightFax Server configuration. For more information. This is usually a numeric ID and is often the phone number for the pager. Pager ID Enter the user’s pager ID. In addition to defining these settings.6 Feature Pack 2 117 Administrator Guide . Before you can complete this tab. Low Disk Space Select this check box to send an alert when free hard drive space on the RightFax server falls below 150 MB. For more information. alert types. 6 Feature Pack 2 118 Administrator Guide . Different types of alerts have different delays and repeat intervals as listed in the following table. For example. About alert frequencies After an alert is triggered. 30 min 90 min Select this check box to send an alert when multiple phone lines have failed in such a way that the DocTransport suspects a T1 line is not operating correctly. This may indicate that the operating system has failed or the server has lost power. Alert Delay Repeat interval All DocTransports down. in minutes. when the alert condition occurs.Chapter 10: Creating RightFax users Creating a user profile Critically Low Disk Space Periodic Server Heartbeat Select this check box to send an alert when free hard drive space on the RightFax server falls below 50 MB. see RightFax Internal Event Queue on page 16. When you select this check box. All DocTransports Down Select this check box to send an alert when all DocTransports are unable to send or receive faxes. DocTransport Service Down Select this check box to send an alert when one of the DocTransports are unable to send or receive faxes. Send Queue too Deep Select this check box to send an alert when the number of faxes or fax pages queued to send exceeds the numbers you select in the Faxes box and the Pages box. 30 min 90 min Select this check box to send an alert when an error or a series of errors has indicated to the DocTransport that a phone line is not operating correctly. 10 min 60 min Probable Line Failures Disk space is critically low (<50MB). 10 min 60 min Probable T1 Failure Send queue too deep. If an alert condition persists. 20 min 60 min DocTransport service down. Server improperly shut down Select this check box to send an alert when the RightFax Server module shut down unexpectedly. the alert is repeated periodically. OpenText RightFax 10. RightFax Event Queue Full Select this check box to send an alert when the percentage of the fax server’s internal Event Queue reaches 90%. For more information. this prevents free disk space fluctuating around 50 Mb from causing repeated alerts. RightFax internal queue has reached 90% utilization. the problem causing the alert must be remedied within a set length of time before a fault of the same type causes another alert. Select this check box to send a brief notification of the RightFax server’s status. 10 min 30min Disk space is getting low (<150MB). you must also specify the Heartbeat Interval. including statistics on fax activity. Alerts that are not listed here are sent only one time. select the Enabled check box. faxes that were not successfully sent. select whether to forward to a fax machine or network users: When to Print Select the option to either print successfully sent faxes. 2. select Forward to a fax machine and in the Phone number box. select a printer in the Printer box. select Forward to network user(s) and in the text box. and copying a printer on page 139. For more information about defining the printers. and the fax body. Administrator Guide . or both. If this check box is selected. To forward to one or more RightFax user IDs.6 Feature Pack 2 l 119 To forward to a fax machine. In the Forwarding Type list. OpenText RightFax 10. the fax cover sheet. Under Automatic Forwarding Options. enter the fax number. 1. deleting.Chapter 10: Creating RightFax users Creating a user profile The Outbound Auto-Printing tab The Default Receive Settings tab Enable automatic printing of sent faxes To forward the user’s faxes as soon as the faxes are received Select this check box to print a copy of the user’s sent faxes. see Creating. l What to Print Select the check boxes next to what you want to print: the fax history. notifications for received faxes are not sent. The text of these status messages can be Method Select a notification method for the user: OpenText RightFax 10. To open Notification settings In the Server Configuration window. select the Enabled check box. select a print resolution. 3. For more information. If you are routing inbound faxes to an email gateway or other destination on your network and you have selected the Delete After Routing check box on the Inbound Routing tab. To convert all received faxes to text using OCR (optical character recognition) This option requires the RightFax OCR Converter module. For information about adding a printer. click the text format used to interpret your fax pages: l l ASCII produces a plain text file. To use notifications via SMS text messaging. see Creating. Under Automatic OCR Options. 2. first configure the SMS service types and providers. customized. In the Extension box. 3. select a printer.6 Feature Pack 2 120 Administrator Guide . Separate multiple user IDs by comma. Under Automatic Printing Options. The Notification tab The Notification settings determine whether to notify RightFax users by email or SMS about the status of sent and received faxes. In the Resolution list. see Configuring custom messages on page 36.Chapter 10: Creating RightFax users Creating a user profile enter the user IDs. 1. see Adding SMS and pager services on page 161. deleting. To automatically print received faxes 1. In the Layout box. In the Printer list. RTF (rich text format) preserves fonts and formatting but is only available for Windows clients. In the Format list. Left Justified means that left justified text starts from the left margin of the fax. enter a three-letter file extension for the output file. and copying a printer on page 139). 2. click the Notification tab. select the Enabled check box. For more information. 4. in the SMS Service box. see Adding SMS and pager services on page 161). or other information necessary for sending fax notifications of the type selected in the Notification Method list. In the During Transmission list. To send a test message to an SMS-capable device for the selected SMS method and service. and then click Test SMS Using Integrated Windows Authentication Notification Address/Info Enter the user’s email address for email notification.When initially received. select when this user should be notified about incomplete faxes: Never. or Periodically. to include the fax in the email. Custom notification methods Custom notification methods are created using the RightFax API. 2. To add and configure SMS services. in the Notification Address/Info box. select when this user should be notified about sent faxes in transmission: Never. select the format (TIF or PDF). select the Include fax with notifications check box. and then select whether to include only the First Page of the fax or All Pages. select the Reroute to user check box . Select the check boxes next to the events about which to notify this user.Chapter 10: Creating RightFax users l l l Using Integrated Windows Authentication Sent Fax Notifications Use Group’s Method Uses the notification method defined for the group to which the user belongs. specify the email address of the user. select when this user should be notified about received faxes: Never. or Periodically. OpenText RightFax 10. E-mail notifications When using email notifications. enter a phone number. Alternate User Notification Test SMS To reroute received fax notifications to another user. or Periodically . In the Incomplete Faxes list. If you select this option. Once Only . 1. Email Systems Sends the notification to the user’s email box. For more information. Once Only. 3. select the RightFax user ID.6 Feature Pack 2 With RightFax Enterprise server you can link each RightFax user ID to a Windows user account to take advantage of your network’s established Windows authentication. l In the Received Faxes list. SMS Service Select the SMS service to use for delivering the notification. see the RightFax API Reference Guide. 121 Administrator Guide . In the Notification Address/Info box. SMS Uses the notification to an SMS-capable device. select an SMS service .While fax has not been viewed or printed. Notification about received faxes Note Notifications for Notes and Exchange require you to purchase and license a separate module. For more information about the notification type for a group. Once Only. and in the Select User list. see The Basic Information tab on page 125. select the Use Integrated Windows NT Security check box. This RightFax ID can only be accessed when the user is logged on to Windows NT based network with the linked account. Right-click any selected user. and on the shortcut menu. such as Enterprise Fax Manager or FaxUtil. RightFax attempts to use the Windows account name and password with which the user is currently logged on: l l To manually select a Windows account to which to link Note You can only use the Windows account lookup when you are running Enterprise Fax Manager on the RightFax server or a Windows workstation. and on the Edit menu.Chapter 10: Creating RightFax users Creating a user profile When a user logs on to a client application that requires authentication. If there is no matching Windows account name in the current domain. open the User Edit window and on the Notification tab select Use Integrated Windows NT Security. select the DEFAULT user ID. To link existing users to matching Windows accounts No NT Account Assigned The user is required to log on via Windows NT authentication but is not linked to a Windows account. RightFax links each selected user ID to the matching Windows account in the domain to which you are currently logged on. In RightFax Enterprise Fax Manager.6 Feature Pack 2 l 122 In RightFax Enterprise Fax Manager. Linking RightFax user IDs to Windows accounts To by default link new users to a Windows account All new RightFax users are created based on the DEFAULT user ID . the user is logged on automatically with their RightFax ID using Windows authentication.) 1. 1. RightFax Enterprise server provides several methods for linking one or more RightFax user IDs to existing Windows accounts. Administrator Guide . (This user is allowed to log on manually. NT Account Assigned The user is required to log on via Windows NT authentication and is linked to a Windows NT based account. 2. In RightFax Enterprise Fax Manager. Enterprise Fax Manager shows each user’s link status in the NT Account Link Status column: l l l N/A The user is not required to log on via Windows NT authentication. in the user list. 2. 3. If the Windows account is not linked to a RightFax user ID. Linked to domain\account name appears in the text box on the Identification tab. click Enable NT Authentication and Link. in the user list. click Edit. If the Windows account is linked to a RightFax user ID. and then click Select NT Account. On the Identification tab. select the user. a link is not created. select one or more users. OpenText RightFax 10. Type or select the Windows domain and account names and click OK. the user is must enter the RightFax user name and password. exe to import users from a comma-delimited ASCII file. select the Automatically Assign Routing Codes check box. 5.6 Feature Pack 2 123 Administrator Guide . it is skipped. Click Import. Importing users To simplify the process of setting up all your network users in the RightFax server. In Enterprise Fax Manager. on the Utility menu. click Import Users from NT Domain. 3.Chapter 10: Creating RightFax users Importing users (usually Default). a link is not created. To automatically assign a routing code to each user. Select the group to import. The first imported user receives the starting routing code and each additional user’s routing code increments by one. Use the RightFax administrative utility ImpUser. you can import users into the fax server from your network or from an ASCII file. Specify the RightFax user ID to use as a template OpenText RightFax 10. If there is no matching Windows account name in the current domain. see the RightFax Administrative Utilities Guide 2. Enter the computer name of the Primary Domain Controller (PDC) or Backup Domain Controller (BDC) from which the users are imported.exe. For information about running ImpUser. Each new RightFax user ID will link to the matching Windows account in the domain you are currently logged on to. 6. and enter the starting code. To import users from a Windows NT based network To import users from an ASCII file 1. If the system increments to a routing code that already exists. 4. It can be deleted. Note If you delete a group that is the only group assigned a specific library document. OpenText RightFax 10. and then confirm the deletion. For information on completing these options. fax options. and notification options to different groups in your organization. In the Group ID box. expand the RightFax server. On the Edit menu.6 Feature Pack 2 124 Administrator Guide . The list of groups appears in the right pane. To delete a group 1. enter a unique group ID. see Starting Enterprise Fax Manager on page 18. and then click Groups. or reassigned to another user group. All remaining options are optional. For more information. click Delete. and editing groups of users Managing groups To create a new group of RightFax users 1. 2. click New. In the left pane. see Editing group properties on page 125 2. On the RightFax server. edited. 2. To open the list of groups 1. copying. Select the group or groups in the list. Creating. On the Edit menu. deleting. then that library document will be marked as expired. start EFM. fax cover sheets. The Group Edit window opens.Chapter 11: Creating groups of users Managing groups Chapter 11: Creating groups of users Create groups of RightFax users to assign different RightFax administrators. click Edit. select the group. Group ID Enter a unique ID for this group. In Enterprise Fax Manager. The Group Edit window opens. The Group Edit window opens. and on the Edit menu. any configuration data not supported by the older version will be lost. Editing group properties To edit the properties of an existing group 1. click Edit. Note If you copy groups from a new RightFax server version to an older one. 2. and then drag the selection to another server.Chapter 11: Creating groups of users Editing group properties To copy groups from one RightFax server to another l The Basic Information tab Select the groups in the list. On the Edit menu. The primary administrator has access to all the mailboxes in OpenText RightFax 10. Administrator Enter the user ID of the primary administrator of this group. To edit the properties of an existing group l Select the group in the list.6 Feature Pack 2 125 Administrator Guide . In the Default Cover Sheet box. If selected. all users in the group must use a cover sheet on outbound faxes. the administrator and the alternate administrators are notified about all faxes that need approval. All available library documents appear in the Available to this Group list. click Select. separating multiple entries by commas. This may include expired and inactive documents. RightFax will purge deleted fax records after the indicated number of days starting with the date the fax was received. Alternate administrators have access to all the mailboxes in the group and receive messages about faxes belonging to group members if neither the user nor the primary administrator have printed or viewed a fax in the designated interval. select System Default. select it in the Available to this Group list. 3. To change access to cover sheets for the group. All faxes must have cover sheets All faxes must be held for preview If selected. Group members cannot edit delegates If selected. Library Documents 1. Click OK. and then click the right arrow to move it to the Unavailable to this Group box. click Select. and then click the left arrow to move it to the Available to this Group box. select it in the Available to this Group box. To make a cover sheet available. 2. RightFax will not automatically purge deleted fax records.Chapter 11: Creating groups of users Editing group properties the group and receives alerts when a user has not printed or viewed a fax before the time specified in User Notify Time in the RightFax Server configuration program expires (see Reminder notifications settings on page 33). and then 126 Administrator Guide . Users must view the faxes and verify that they should be sent. select it in the Unavailable to this Group list. 2. OpenText RightFax 10. The primary group administrator can edit the group’s settings in EFM. To make a library document unavailable to this group. Notify administrators about faxes that need approval If selected. Do one of the following: Alternate Administrators l Enter up to 9 user IDs of the alternate administrators of this group. To change access to library documents for the group. To use the default cover sheet assigned by the administrator. select the default cover sheet for the group. l Notification Type Select the default notification method for the group. All cover sheets currently available to the group appear in the Available to this Group list. but cannot change it. all faxes for users in the group will be held for preview before they are sent. Group members will be able to use this library documents after the defined activation date. Cover Sheets 1. Days to keep deleted fax records Enter the number of days to keep records of deleted faxes in the RightFax database. If set to 0 (zero).6 Feature Pack 2 To make a cover sheet unavailable. See Setting default cover sheets on page 211. members of the group can view delegate information. 4. You can also perform manual fax aging using the Faxage. Note This option is only valid if you are using the XML Generator module.exe utility program. To disable fax aging. To set automatic fax aging 1.6 Feature Pack 2 127 Administrator Guide . OpenText RightFax 10. see the RightFax XML GeneratorAdministrator Guide. For more information. To enable this group's faxes in XML Select the Enable External Document Connector processing check box. For each type of fax. When using the XML Generator module. see the RightFax Administrative Utilities Guide. clear the check box. You can still run reports about the faxes. The Aging and Archiving tab Automatic fax aging is only available if you have a RightFax Enterprise or Satellite server. select the check box Settings apply to all user folders. With automatic fax aging you specify how many days after having been sent or received faxes will be removed from the user’s FaxUtil mailbox. To apply these settings to all the user folders. For more information.Chapter 11: Creating groups of users Editing group properties click the right arrow to move it to the Unavailable to this Group box. enter the number of days the fax will remain before it is deleted. enter 0 (zero). Automatic fax aging does not delete the fax records from the RightFax database. you can enable EDC processing so that this group's faxes can be saved with XML metadata which can then be used by an external archiving or document management system. 2. To specify that faxes should not be deleted. Note Entering a time that falls between the Starting and Ending times. Starting/Ending Time Example Every hour. To avoid this.M. you define that between 8 A. Enabled Enables the Forced Scheduling feature. Maximum Concurrent Faxes Specify the maximum number of faxes that can be scheduled at one time by all the users in the group. you can restrict the total number of pages or total number of faxes that are sent simultaneously by users in a group during a specified time period.. Delay Until Time Enter a time after the Ending time at which to send delayed faxes.M. more important faxes from other departments could be delayed and incoming faxes blocked.M. The Smart Fax Distribution tab With smart fax distribution. With all fax channels continuously processing these faxes. and 5:30 P. You can reschedule delayed faxes at any time in FaxUtil.M. a group routing code is created and all faxes received by the group are distributed systematically between all the users in that group. This is written in 24-hour HHMM format. Example If you enter 0800-1730 for the Start/Ending time and 1800 for the Delay Until Time. OpenText RightFax 10. members of the Sales group can only send up to 20 pages at a time and that all faxes exceeding that limit will be delayed until 6 P. For example. Enter the time in 24-hour HHMM format. will be delayed until 6:00 P. and 5 P. and set the Ending Time to 1730. to 5:30 P.6 Feature Pack 2 128 Administrator Guide .Chapter 11: Creating groups of users Editing group properties Maximum Concurrent Pages The Forced Scheduling tab Specify the maximum number of fax pages that can be scheduled at one time by all the users in the group.M. The starting and ending times for the period that the restriction applies. will cause delayed faxes to be continuously bumped to the next day and to never be sent. all faxes exceeding the limit between 8 A.M.M.M. The restriction applies to simultaneously scheduled faxes within a time period only. the 50 sales representatives in your organization send 100 faxes each. set the Starting Time to 0800. With forced scheduling. to set the restriction from 8:00 A. smart fax distribution is enabled for the group. With balanced distribution. Routing Code Assigns a routing code to the group. faxes are distributed to each group member in succession. users can take themselves temporarily out of the distribution loop. including the tab and option in the Fax Information dialog box that each check box customizes. With linear distribution. OpenText RightFax 10. Note The Fax Dialog Customization tab is available with Enterprise editions of RightFax only. For more information on the options in the Fax Information dialog box. sending. Distribution Type Specify either linear or balanced distribution. Member Refusal Allowed If selected. This option is enabled by default and must be disabled to allow per user customization. When this check box is selected.6 Feature Pack 2 129 Administrator Guide . selecting Refuse Distributions. see Creating.) You can remove options that do not apply or are off-limits to users in this group. users can refuse faxes by running FaxUtil and on the Tools menu. fax distribution is determined by each user’s processing rate. Enabled If selected.Chapter 11: Creating groups of users Editing group properties The Fax Dialog Customization tab Use the options on this tab to customize the appearance of the Fax Information dialog box (the dialog box used to create and address outgoing faxes. If one user is faster at processing faxes than another. the faster user is distributed faxes at a faster pace. The following table lists each check box in this dialog box. and managing faxes on page 233. Chapter 11: Creating groups of users Check box Fax Information dialog box tab Editing group properties Option Check box Fax Information dialog box tab Option Acquire Attachment Attachments from Scanner Scanner button (scanner icon) Cover Sheet Selection Button More Options Cover Sheet File selection box Add Phonebook Entry Button Main Add Entry button Cover Sheet Toggle Main Use cover sheet text box Delay Send Controls Main Alternate Body Attachment Checkbox Attachments Show Alt. Body column in Selected Attachments list Delay send check box and time/date fields Form Type Selection More Options Use form check box and selection list Alternate Fax Number Main Alt. Fax Number text box From Name Entry Field Name text box Auto-Delete Control More Options Automatic Deletion selection box From Phone Number More Options Entry Field Voice Number text box Billing Information #1 Main Entry Field Billing Code 1 text box (title may vary) General Fax Number More Options Entry Field Company Fax Number text box Billing Information #2 Main Entry Field Billing Code 2 text box (title may vary) General Voice Number Entry Field More Options Company Voice Number text box Billing Information Lookup Button Main Lookup button Attachments Browse for File Attachment Attachments Browse button (folder icon) Library Document/ Attachments Selection Available Attachments library document list and File Attach button (paper clip icon) Certified Checkbox Main Use certified delivery check box ‘More Options’ Tab More Options All tab contents Main City/State text box Native Attach Document Checkbox Attachments City/State Entry Field Native column in Selected Attachments list Comments Text Cover Sheet Notes Comments for your Records text box ‘Notes’ Button/Tab Cover Sheet Notes All tab contents Company Entry Field Main Company text box Notes Text Cover Sheet Notes Notes to be Placed on the Cover Sheet text box OpenText RightFax 10.6 Feature Pack 2 130 More Options Administrator Guide . Recipient Type Field Main Down arrow button next to the Fax number text box where users can select the Email address option.6 Feature Pack 2 131 Administrator Guide . Secure Send/Recipient Fax ID Control More Options Recipient Fax ID text box Smart-Resume Checkbox Main Use smart-resume check box Transmission Quality Control Main Fine mode check box Use PDF Checkbox Main Create PDF image check box Voice Number Entry Main Field Voice Number text box OpenText RightFax 10.Chapter 11: Creating groups of users Editing group properties Check box Fax Information dialog box tab Option PDF Options Main PDF Options button (next to Create PDF image check box) Phonebook Import Main Menu Option Main Phonebook button Phonebook Selection Button Main Phonebook button Preview Checkbox Main Hold for preview check box Priority Checkbox More Options Priority selection box Private Fax Number N/A Entry Field Phonebook Import option on the Tools menu in FaxUtil. 2. expand the RightFax server. After you create a signature file. The Edit Signature window opens. you can create signature files from signatures included in faxes in your FaxUtil mailbox. select the signature. copying. select Store. You can also specify up to three RightFax user IDs or group IDs who will be authorized to use the signature in addition to its owner. see Editing signature file properties on page 133. Managing signature files With RightFax administrative access. Enterprise Fax Manager catalogs all the signatures and maintains the file names. and authorized user information. The list of signatures appears in the right pane of the window. 1. and then select Make Signature. and editing signature files To create a signature file in FaxUtil With RightFax administrative access.Chapter 12: Creating signatures Managing signature files Chapter 12: Creating signatures RightFax can personalize outbound faxes with graphic images of the users’ signatures. Note Signature files are currently not supported in outbound PDF documents. In the left pane. descriptions. it appears as an object in Enterprise Fax Manager in the list of signatures. Signature images are created in FaxUtil and stored in the RightFax\SIG folder on the server. and then double-click it to open it. Using the Select tool.6 Feature Pack 2 132 Administrator Guide . On the RightFax server. Creating. For more information. deleting. and a description of the signature. In FaxUtil. Enter a unique ID for the signature. start EFM. For more information. 2. 3. OpenText RightFax 10. you can create signature files from signatures included in faxes in your FaxUtil mailbox. scan a signature into your mailbox or fax a signed document to yourself. 4. see Starting Enterprise Fax Manager on page 18. On the Fax menu. the user ID of the owner. and then click Signatures. To open the list of signatures 1. The User Edit window opens. Enter a unique ID for the signature. Click OK again to confirm that you want to delete the signature file itself. RightFax will not be able to use the signature image. and then drag the selection onto another server. 4. the user ID of the owner. Note If you copy signatures from a new RightFax server version to an older one. This file name is automatically generated and stored in the RightFax\SIG folder on the RightFax server when the signature file is created. On the Edit menu. For more information. any configuration data not supported by the older version will be lost. Description A description of the signature file for easy reference in Enterprise Fax Manager. Click OK to confirm that you want to remove the signature from Enterprise Fax Manager. see Creating a user profile on page 108. click Signatures. On the Edit menu. click Delete. 2.6 Feature Pack 2 133 Administrator Guide . click New. see Editing signature file properties on page 133. Image File Name To edit the properties of an existing signature l The name of the signature image file. and a description of the signature. The Edit Signature window opens. On the Edit menu.Chapter 12: Creating signatures Editing signature file properties To create a signature in RightFax Enterprise Fax Manager Editing signature file properties 1. You can also specify up to three RightFax user IDs or group IDs who will be authorized to use the signature in addition to its owner. The Edit Signature window opens. 3. In the left pane. 2. click Edit. Signature Code To copy one or more signatures from one RightFax server to another l The name of the signature file that appears in Enterprise Fax Manager. Select the signatures in the list of signatures. 2. select the signature. and on the Edit menu. If this box contains an invalid file name. Select the signature in the list of signatures. To delete a signature file 1. Select the signature in the list of signatures. In Enterprise Fax Manager. click Edit. To edit the properties of an existing signature 1. OpenText RightFax 10. For more information. Owner’s User ID The user ID of the owner of the signature file. For information on using this and other embedded codes see RightFax embedded codes on page 310. Adding a signature to a fax Use the <SIGNATURE> embedded code to insert signature files into fax-bound documents. Data 0–100 (default 35) Increasing the data for this value causes all newly created signatures to be shifted upwards by a percentage of the height of the signature image (the actual distance depends on the height of the signature). Decreasing the data causes signatures to shift down an equal distance. You can use a Windows registry entry to modify the vertical alignment of new signatures that are created on the client workstation where the registry value is present. Note This registry value only affects signatures when they are initially created. Important Signature files do not appear correctly in documents that have been converted to PostScript. Controlling signature placement Signature images are positioned so that the left-middle point of the signature aligns with the left-middle point of the <SIGNATURE> embedded code in the document.6 Feature Pack 2 134 Administrator Guide .Chapter 12: Creating signatures Adding a signature to a fax Authorized Users Category Value Up to three RightFax user IDs or group IDs who are authorized to use this signature in addition to the owner of the signature. If you change the data for this value. Category Value Key 32-bit or 64-bit client operating systems: HKEY_CURRENT_USER\Software\ RightFax Client\VWR32 Value SignaturePositionPercent Type DWORD OpenText RightFax 10. you need to recreate each signature to which you want to apply the new setting. 3. Create the form image in a word processor or any other application from where you can print to the RightFax fax printer. click Store as Form. For more information. OpenText RightFax 10. 2. To open the list of forms 1. deleting. After you create a form file. it appears as an object in Enterprise Fax Manager in the list of forms. To create an overlay form file 1. 2. select the Use Fine Mode check box. start EFM. To set fine resolution as the default in FaxUtil. see The Permissions tab on page 110. expand the RightFax server. On the RightFax server.6 Feature Pack 2 135 Administrator Guide . Typically they are replicas of documents that your organization uses such as the company letterhead.Chapter 13: Creating overlay forms Managing overlay forms Chapter 13: Creating overlay forms Overlay forms are fax image files that RightFax can superimpose over outgoing faxes to give them the appearance of having been printed on the form prior to faxing. Send the fax image to your FaxUtil mailbox and then double-click it to open it. see Starting Enterprise Fax Manager on page 18. In the left pane. and copying form files You can create new overlay forms from faxes in your FaxUtil mailbox if your user profile includes that permission. The list of forms appears in the right pane of the window. click Options. For more information. and then click Forms. on the Tools menu. Creating. On the Fax menu. On the Sending tab. Important Always create forms using fine resolution. Managing overlay forms New form files are created from the FaxUtil mailbox. On the Edit menu. and then drag the selection to another server. Note If you copy overlay forms from a new RightFax server version to an older one. click Edit. Form Number The number that identifies the form. The remaining boxes are the same as those in the Edit Form dialog box. 3. In Enterprise Fax Manager. This is assigned by RightFax when the form is created.Chapter 13: Creating overlay forms Editing form file properties To copy one or more forms from one RightFax server to another l Select the forms in the list of forms. 2. For more information. 4. OpenText RightFax 10. Select the form in the list of forms. 2. 5. Editing form file properties To edit the properties of an existing form 1. The new form appears in the Forms list in Enterprise Fax Manager. Form ID Enter a unique name to identify the form. 4. Click OK again to confirm that you want to delete the form file itself. click Delete. enter a unique ID for the form. Click OK. select the form. any configuration data not supported by the older version will be lost. In the Form ID box. Click OK to confirm that you want to remove the form from Enterprise Fax Manager. see Editing form file properties on page 136. To delete a form 1.6 Feature Pack 2 136 Administrator Guide . On the Edit menu. You can set up two forms to be applied one after the other in a single document. Edit the first and second form according to the instructions in Editing form file properties on page 136. none of the pages will include the form. In the Authorized Group or User list. this value is set to 2. the form will appear on the first body page. the first form might be a form with your company letterhead for page 1 and the second form an invoice form for all remaining pages of the document. select the users or groups authorized to use the form. If the first form is only used on the first page. Next Form Number You can use two overlay forms in one fax. 2. 1. To use a second form. If you set the start page to 3 and a document only has two pages. l To edit the properties of the first form: a. In the Next Form Number box. The image file is generated automatically when the form file is created and stored in the RightFax\Papers folder on the RightFax server. If you enter 1. In the Number of Pages box. enter 1. deleting. enter the first page after the cover sheet to which to apply the first form. OpenText RightFax 10. d. Create two forms according the instructions in Creating. enter the number of pages to which to apply the first form. For example. If you enter 1. see Using two overlay forms in one fax on page 137. enter the form number of the second form. enter its form number. Otherwise. In the Start Page box. RightFax will not be able to use the form image. Image File Name Select the name of the image file of the form. enter 0 (zero). In the Start Page box. Click OK. For more information on using two overlay forms in a single fax. b. Start Page Enter the first page after the cover sheet to which to apply the form. l To edit the properties of the second form: a. and copying form files on page 135. enter the number of fax pages to which to apply the form. such as a form with the company letterhead for page 1 and an invoice form for all subsequent pages. enter the first page number to which to apply the second form.6 Feature Pack 2 137 Administrator Guide . To configure two forms for use in a single fax document Note Page numbers are absolute. c.Chapter 13: Creating overlay forms Using two overlay forms in one fax Description Using two overlay forms in one fax Enter a short description of the form for easy reference in Enterprise Fax Manager. Secure Form Select this check box to restrict the form to specific groups or users. In most cases. If this box contains an invalid file name. Number of Pages To overlay each page of the fax with the form. the form will appear on the first body page. c. Click OK.Chapter 13: Creating overlay forms Adding an overlay form to a fax b. see Specifying addressing information on page 236. For information about the Fax Information dialog box. enter the number of pages to which to apply the second form. In the Number of Pages box.6 Feature Pack 2 138 Administrator Guide . Adding an overlay form to a fax Use the <FORMTYPE> embedded code to insert overlay forms into fax-bound documents or specify the form to use in the Fax Information dialog box. to have the second form appear on all subsequent pages. enter 0 (zero). Otherwise. OpenText RightFax 10. On the Edit menu. and copying a printer 2. For more information. see Faxing from an external application on page 234. To edit the properties of an existing printer 1. and then drag the selection to another server. In Enterprise Fax Manager. Confirm that you want to delete the printer. and on the Edit menu. For more information. Note If you copy printers from a new RightFax server version to an older one. To copy one or more printers from one RightFax server to another. click Delete. Editing printer properties 2. On the RightFax server. Creating. click Edit. select the printer. deleting. see Starting Enterprise Fax Manager on page 18. or delete printers on the RightFax server Select the printer in the list of printers. and then edit the printer properties. and then click Printers. OpenText RightFax 10. any configuration data not supported by the older version will be lost. Printers can be added individually or imported in groups from your network. edit.Chapter 14: Connecting printers and scanners Managing printers Chapter 14: Connecting printers and scanners You can define an unlimited number of network printers in RightFax and make them available for automatic printing of faxes and other automated network print functions. 1. In the left pane. expand the RightFax server. click New.6 Feature Pack 2 139 Administrator Guide . Select the printer in the list of printers. The list of printers appears in the right pane of the window. start EFM. l Managing printers To add. To add a new printer to RightFax l On the Edit menu. To delete a printer l To configure printers and print-to-fax devices that allow RightFax users to fax documents from native applications. see Editing printer properties on page 139. for example “LASER1. select Fit Letter/Legal or Fit A4/Legal to let the laser printer select the size paper that corresponds to the size of the fax page.” On LAN Server and Windows NT based networks. the Distinguished Name of the queue object. Select this check box to allow faxes to be printed to an IP port on a printer using the LPR. this can be one of the following: OpenText RightFax 10. a TCP/IP utility. If your laser printer supports both PostScript and PCL5. or A4 (210 × 297 mm).). On NetWare 4. Printer Type None The image is not scaled which can result in some portion of the page being truncated.5 × 11 in. Fit Legal.S.SALES. Select None if the default paper size is set to Fit Letter/Legal or Fit A4/Legal. Queue Name Depending on your network operating system.Chapter 14: Connecting printers and scanners Importing printers into RightFax l l l On NetWare 3. To show only the Printer ID in the Print dialog box. letter (8. Server Name Importing printers into RightFax Indicate on which file server the queue exists. for example “LASER1. the Bindery name of the queue. If you receive faxes in a mix of letter and legal sizes and use dual-bin laser printers. Fit Letter.6 Feature Pack 2 140 Administrator Guide . l Description l Enter a description of the printer for easy reference in Enterprise Fax Manager. U. choose one of the HP LaserJet types rather than PostScript for faster printing.” Default Paper Size Select how RightFax scales a fax page to fit onto the printable area of a laser printer and the paper size: Printer ID The printer’s network ID. Select the printer driver used by RightFax to format faxes printed to this printer. Choose the one that most closely corresponds to your printer. If the queue is in NDS.S.ACME.x servers that are using NDS. this is the value at the top of the tree. legal (8.5 × 14 in.). Default Paper Source Direct TCP/IP Printing Determines which paper tray selection command RightFax sends to the printer.x. leave this box blank. You can import printers from your network into RightFax in groups or you can import all printers. the share name of the queue. Fit A4 The fax page is scaled to fit onto the printable area of the indicated paper size: U. To configure a user to automatically print sent and received faxes 1. 3. and then click Import Selected Printers. In Enterprise Fax Manager. and whether the printer is set to print to an IP port. Configure the user profile settings to automatically print sent and received faxes. paper size. copying. see The Outbound AutoPrinting tab on page 119. 4. and editing users on page 107. paper type. click Import Printers from Network. deleting. this scan can take several minutes. 2. 2. you can configure RightFax user profiles to automatically print sent or received faxes.Chapter 14: Connecting printers and scanners Configuring RightFax to automatically print faxes printer list. The list of available printers appears in the Current OpenText RightFax 10. click Set Default Printer Information. Depending on the size of the network. For more information about printing sent faxes. 1. 3. and then set the printer driver. To import printers 5. and copying a printer on page 139.6 Feature Pack 2 Using Scanners with RightFax If a document has already been printed you can scan it into RightFax using a local or network scanner. For more information. Add at least one network printer. For more information about printing received faxes. deleting. 141 Administrator Guide . Click Find Printers in Selected Context. on the Utility menu. Select the printers. To search for printers with specific characteristics. Configuring RightFax to automatically print faxes After at least one network printer has been set up in Enterprise Fax Manage. click Stop Loading. Note The ability to automatically print sent and received faxes can also be configured by individual users in the FaxUtil client application. see Creating. Select the network context from which to import. The Import Network Printers dialog box opens. see Creating. Open the user ID you want to configure. see The Default Receive Settings tab on page 119. To cancel the search. For more information. RightFax automatically detects the TWAIN32 drivers and makes the scanner available when creating a fax document. it appears in the list of Selected Attachments.Chapter 14: Connecting printers and scanners The Standalone Fax Connector 3. Connecting a stand-alone fax machine to the RightFax server To connect a stand-alone fax machine to the RightFax server. The Document Scan window opens. OpenText RightFax 10. To make your local scanner available in RightFax l Install the scanner. Scan the document according to your scanner’s operating instructions. Using the Kofax NetScan RightFax integrates with the Kofax NetScan network scanner. such as least-cost routing and automatic retries. For more information. Note TruFax 100 and 200 fax boards do not support this feature. Open the Fax Information dialog box and click the Attachments tab. available to conventional fax machines throughout your organization. and managing faxes on page 233. and then click Start Scan. select the scanner. For more information. its drivers. Each stand-alone fax machine connects to the RightFax server on a specific channel or DID extension via a phone line or PBX. To scan a document for fax transmission The Standalone Fax Connector 1. Click the scanner button. By using the Standalone Fax Connector with Brooktrout TR1034 fax boards you can make RightFax features. After the document has been scanned. sending. Using a desktop scanner You can scan documents into RightFax using any TWAIN32compliant scanner connected to your computer. see Configuring Kofax NetScan on page 56 and the documentation for your Kofax NetScan scanner. you must define a dedicated RightFax user ID to host the Standalone Fax Connector. it is redirected to the RightFax server for processing and transmission. In the Current Scanner box. see Creating. When a fax is sent. and the TWAIN32 drivers according to the installation instructions provided with the scanner.6 Feature Pack 2 142 Administrator Guide . You assign this user ID a unique extension (routing code) that users will dial to access the 2. The user is prompted with voice or tones to enter the destination fax number and other required fax recipient information. 3. see Creating. See Extensions (in SFC Key) on page 349. and editing users on page 107. 2. press the Start button on the fax machine. Dial the Standalone Fax Connector extension. and then press the pound [#] key. deleting. After the Standalone Fax Connector has been enabled. To send a fax using the Standalone Fax Connector 1. After RightFax reads the new values. l To manually enter a destination fax number. users can access it from any fax machine that can dial into the dedicated extension. enter the numeric ID of the phonebook entry. On the RightFax server. See Change (in SFC Key) on page 347. In the Routing Code box. l To use a phonebook entry. To enable stand-alone fax machine support 1. Your phone system determines how this is accomplished . When a tone or voice prompt instructs you to begin transmitting the fax. enter an extension that is dedicated to the Standalone Fax Connector. You can create individual or group phonebook entries under the Standalone Fax Connector user ID assigning each entry a numeric ID. The fax machine proceeds to scan the pages and send the fax to the specified phone number or to the destination(s) in the phonebook entry. Change the Windows Registry Change value (in the SFC key) to 1 hex. RightFax server from the fax machine. Depending on your Brooktrout fax board configuration. copying. For information on creating a new user. either a tone or voice message prompts you for the destination fax number. Users have the option of dialing their intended recipients or entering the ID of a phonebook entry that dials the recipient(s) listed in that entry. run Enterprise Fax Manager and create a new user. it resets the Change value to 0 hex.Chapter 14: Connecting printers and scanners where the fax number and the optional billing codes are separated by asterisk [*] and the end of the dial string is indicated by the number sign [#].6 Feature Pack 2 143 Administrator Guide . 2. enter the dial string using the format FaxNumber*billInfo1*billInfo2# OpenText RightFax 10. Edit the Windows Registry Extensions value (in the SFC key) to include the Routing Code for each stand-alone fax user. for example to track the individual or department sending the fax. click Customize Cover Sheet Fields. The new names appear throughout your RightFax client applications. Only one billing code. In the left pane. 2. For more information. No billing codes. and then click Billing Codes. or delete billing codes 1. and then click the Billing Codes tab. expand the RightFax server. RightFax supports the use of two billing codes for each faxed document: l Billing Code 1 l Billing Code 2 example in the Fax Information window that opens when a user creates a fax. Your organization can use: l l l Managing billing codes Both billing codes on faxes. In your RightFax client applications. Open Enterprise Fax Manager. Enter new descriptions for the Billing Code 1 and 2 fields in the description boxes. The list of billing codes appears in the right pane of the window. the default names for the RightFax billing codes are Account and Matter. For more information. To add. Billing codes can be validated internally against a master table or externally using a separate application. such as one code for account number and one for a matter number . To change the names of the billing code fields 1. On the Utility menu. Users can be required to enter one or two codes for every fax before it can be sent or deleted.6 Feature Pack 2 144 Administrator Guide . such as an accounting program.Chapter 15: Creating billing codes Customizing the names of billing code fields Chapter 15: Creating billing codes RightFax tracks and reports fax activity using billing codes. To validate billing codes internally. see Starting Enterprise Fax Manager on page 18. On the RightFax server. You can create a list of billing codes to be used to validate the codes entered by fax users when sending faxes. edit. for OpenText RightFax 10. see Starting Enterprise Fax Manager on page 18. start EFM. you must create a list of valid billing codes in RightFax. 3. Customizing the names of billing code fields 2. click New. or deleted. click Delete. change (C). Operation. and then drag the selection to another server. To edit the properties of an existing billing code In Enterprise Fax Manager. After such a system is configured. 2.csv while you are still working on it. and then confirm the deletion. Such systems can be programmed to periodically generate a formatted ASCII file that the RightFax server will recognize and process.$$$) to build the file. Editing billing code properties 1. the WorkServer may attempt to open and process it before it has been built. and only then re-name it to Codechg. Editing billing code properties on page 145. changed. After all lines have been written. the Edit menu. any configuration data not supported by the older version will be lost. To delete a billing code l Select the code in the list of billing codes. Importing Billing Codes You can import billing code records from an ASCII text file. To create a billing code l Description On the Edit menu. For each record that needs to be added. or delete (D) the record. billing code maintenance can be fully automated.Description Note that: l OpenText RightFax 10. select the billing code. Note If you billing codes from a new RightFax server version to an older one. deleting. Enter a descriptive name for the billing code. The Edit Billing Code dialog box opens. Administrator Guide . For information on completing each of the options in this dialog box. To copy billing codes from one server to another l Select the codes in the list of billing codes.BillInfo1. This is most useful when using systems such as EquiTrac or central databases to store a master set of billing codes. If the file is named Codechg.Chapter 15: Creating billing codes Editing billing code properties Billing Code 1 and 2 Creating. the file must include a line of text in the following format: On the Edit menu.BillInfo2. The ASCII file containing the billing codes must be located in the RightFax\Worksrv folder and named Codechg. close the file. To create the ASCII billing code file Use a temporary name (such as Codechg.6 Feature Pack 2 145 Operation is a letter indicating to add (A).csv. and copying billing codes Enter one or two billing codes.csv. click Customize Cover Sheet Fields. Requiring billing codes After you create a list of billing codes. C.5687. The log file is overwritten each time an import is executed.csv file in RightFax\Worksrv. In the Billing Code Import Interval box. Codechg.Smith. To set RightFax to import the ASCII billing code file To require the billing code fields be completed before a fax can be sent 1. Users can manually assign billing codes to their received faxes by double-clicking the fax in FaxUtil to open the RightFax viewer and selecting Assign From Information in the Fax menu. 2.2390 You can also use billing codes to track information about your received faxes. and deletions. getcodes codechg.csv. Run the WorkServer configuration program and select the WorkServer where you saved the Codechg.BillInfo2 are billing codes 1 and 2. Example A. D. click Customize Cover Sheet Fields. Fields that you have marked as required will appear bold in the Fax Information dialog box. 1. In Enterprise Fax Manager. Click the Receive Required Fields tab. 1. on the Utility menu.$$$ ren codechg. Click the Sending Required Fields tab. 2. the WorkServer erases Codechg.9054. enter the number of minutes at which the WorkServer should check for the Codechg.Harry Smith Inc.Chapter 15: Creating billing codes l l Requiring billing codes BillInfo1. Select either or both the First Billing Info or Second Billing Info fields. changes. GETCODES is a program supplied by the user that creates an ASCII file of billing code changes in the required format. the WorkServer imports the specified additions.$$$ codechg.log.Jones. After processing the file. that shows what codes were imported from the most recent Codechg. you can require all users to enter one or both billing codes with each fax sent. They may not contain spaces. In Enterprise Fax Manager.Bob Jones Corp. Do not include for delete operations as it is ignored. on the Utility menu. 2. To require billing codes on received faxes The WorkServer also produces a log file.csv file. so it does not grow indefinitely.csv Description is the billing code description. j: cd \rfax\worksrv OpenText RightFax 10. You can automate this process by creating a batch file. If the file exists. A dialog box appears with fields for entering the necessary billing code information.csv so that it is not picked up again at the next check. Assign billing codes when you require billing codes on received faxes. Select either or both of the First Billing Info or Second Billing Info check boxes.Smith.6 Feature Pack 2 146 Administrator Guide . Example In code below. The Configure ODBC Billing Table window opens.com or contact OpenText for implementation services. you must create a custom utility using the RightFax API. For more information. In Enterprise Fax Manager. see the OpenText Knowledge Center at knowledge. 2. 147 Administrator Guide . After you configure the ODBC information on a user’s workstation. and click ODBC Configuration. To access the ODBC billing codes 1. In the Windows task bar. For more information. Each client workstation must be configured individually. and managing faxes on page 233. click Add. select the Verify Billing Codes for Sent and Received Faxes check box. 2. Fill in the information according to your ODBC database specifications. sending. To validate billing codes against an external application. that user can look up ODBC billing codes when sending faxes.Chapter 15: Creating billing codes Configuring RightFax to validate billing codes ODBC Tables window opens. Configuring RightFax to validate billing codes You can configure the RightFax server to validate billing codes against the billing code list in the RightFax server. see Creating. click Customize Cover Sheet Fields.6 Feature Pack 2 3. If a supplied billing code does not match a billing code in your list.opentext. The Configure OpenText RightFax 10. On the Billing Codes tab. Making ODBC billing codes available You can make billing codes from an external ODBC source available to your users so they can use them in their outbound faxes. Under ODBC Billing Tables. it is rejected and the fax is not sent. on the Utility menu. To configure RightFax to validate billing codes 1. right-click the RightFax tray icon. In most cases. you can select those check boxes instead. Records to Load at once Select a number to limits the number of records listed at one time during billing code lookup. SQL Cursor Type Select an SQL cursor type. This is done with simple SQL query statements. If the ID and password match those used to log into RightFax. OpenText RightFax 10.6 Feature Pack 2 148 Administrator Guide . ODBC Field Names Relates the fields of the ODBC database to the standard RightFax billing code fields. ODBC User ID and Password Enter the ID and password to access the ODBC database. this option should be set to Dynamic.Chapter 15: Creating billing codes Making ODBC billing codes available Billing Table Name Enter a descriptive name for this billing codes table. ODBC Source Enter the name of your ODBC billing codes data source. To set fine resolution 1. In FaxUtil. For more information. see The Basic Information tab on page 125. 5. 2.Chapter 16: Creating library documents Creating a new library document Chapter 16: Creating library documents You can store frequently faxed documents (such as company literature. Library documents are stored in the RightFax\Image folder on the RightFax server. and then select Options. click Store in Library. select Tools. On the Fax menu. To create. or manage library documents. 4. Send the fax image to your own FaxUtil mailbox. see RightFax embedded codes on page 310. Create the document in a word processor or other application from which you can print to the RightFax fax printer. Specify a Document ID and Description for the new library document. Library documents can be added as attachments when sending a fax or specified in the embedded codes <LIBDOC> or <LIBDOC2> to be sent in addition or instead of other documents. select the Use Fine Mode check box. The Store Fax in Document Library dialog box appears. Creating a new library document You create a library document by sending a fax to your FaxUtil mailbox and then saving it to the document library. Run FaxUtil and click the document in the list of received faxes. set FaxUtil to use fine resolution. or employment forms) in a fax document library for easy retrieval. To create a new library document 1. The new document will be available in the Library Documents list for all users except those in groups which do not have access to all library documents. 3. OpenText RightFax 10. on the Sending tab. 2. For information about editing this group property. your user profile must include the Add/Edit Library Documents permission (see The Permissions tab on page 110). These fields and the remaining options are the same as the Edit Library Document dialog box (see Editing library document properties on page 150). Click OK. In the Options dialog box. credit applications. To ensure high quality of each library document. edit.6 Feature Pack 2 149 Administrator Guide . Image File Name The name of the library document file. Request Password Enter the numeric password that is required by Fax on Demand when users request this document. After selecting the check box. Use the <NEWLIB> and <NEWLIB2> embedded codes. To make the library document available via the Web or Faxon-Demand. For information about using these and other embedded codes see RightFax embedded codes on page 310. Accessible via LAN Select to make the library document available on the local area network for faxing from client workstations. All library document files are saved in the RightFax\Image folder on the RightFax server. Accessible via Web Select to make the library document available to users via your Web site using Web Fax Tools. See RightFax Docs-on-Demand Module Administrator Guide. Activation Date The library document becomes available immediately unless you select this check box to set a later activation date. Editing library document properties To edit the properties of an existing library document Pages 1. enter the date when the library document will become available for use. Document ID Enter a unique code that identifies the library document. Select the document to edit. This is generated automatically when the library document is created and remains the same. Accessible via FOD Select to make the library document available to users via touch tone phone using Fax on Demand.Chapter 16: Creating library documents Editing library document properties To automate the creation of new library documents l Description Enter a descriptive name for the library document. Enter the number of pages in the document. Include in Catalog Select to include this document in the Fax on Demand catalog of available faxes. and on the Edit menu. Run Enterprise Fax Manager. 2.6 Feature Pack 2 150 Administrator Guide . click Edit. assign a numeric document ID. OpenText RightFax 10. 2. On the Edit menu. and then drag the selection to another server. expand the RightFax server. In the left pane. After selecting the check box. or local area network. and shows the totals in the right pane of the Enterprise Fax Manager window. see Starting Enterprise Fax Manager on page 18. Select the document in the list of library documents. 1. For more information. click Reset Usage Counts.Chapter 16: Creating library documents Managing library documents Expiration Date To reset the usage counts of a library document to zero The library does not have an expiration date unless you select this check box to set an expiration date. any configuration data not supported by the older version will be lost. and then confirm the deletion. Resetting the usage statistics counter Enterprise Fax Manager keeps a record of each time a library document is sent via Fax-on-Demand. Note If you copy library documents from a new RightFax server version to an older one. On the RightFax server. To copy one or more library documents from one RightFax server to another l Select the library documents. click Delete on the Edit menu. and then click Library Documents. start EFM. 3.6 Feature Pack 2 151 Administrator Guide . the Web. enter the date when the library document will become unavailable. OpenText RightFax 10. Managing library documents To delete a library document 1. 2. Select the library document. Modem and SMPP connectors are supported. The GSM modem can be a card connected to your server or a mobile phone (with a GSM modem) connected to your server via a data cable. Plain text messages are sent by the PPG as text-only SMS messages. using API. l Note Plain text messages should only be used with a Modem or SMPP connector. PPG functionality can be accessed locally and/or remotely.6 Feature Pack 2 152 Single Modem: l Sending Outbound only: 14 per minute l Receiving Inbound only: 14 per minute l Two-way (in and out simultaneously): 10 per minute Two Modems: Administrator Guide . is as follows: PPG is capable of two-way SMS messaging and can receive SMS messages in reply to the outgoing SMS messages that it sends. About message types The PPG supports the delivery of plain text SMS messages.Chapter 17: Text messaging using the Push Proxy Gateway About message types Chapter 17: Text messaging using the Push Proxy Gateway The Push Proxy Gateway (PPG) enables applications to deliver information to mobile users via Short Message Service (SMS) text messaging. PPG supports two serial port modems on a single server.05 AT commands. The PPG throughput via a modem connector. It can also be a natural extension of the RightFax enterprise fax and e-document delivery solution channels. All GSM handsets can receive these SMS messages.07 and 07. l OpenText RightFax 10. About connectors PPG uses connectors (sometimes called channels) to support different methods of delivering SMS messages. You can use any GSM modem that provides a serial-port (COM) interface and supports the GSM 07. Modem connectors Modem connectors allow messages to be submitted to the carrier's Short Message Service Center (SMSC) through a GSM modem that is attached to the PPG server. It uses a Global System for Mobile Communications (GSM) modem or direct connection to a Short Message Service Center (SMSC) to deliver information to the target device via the mobile network. new log files are created with file names based on the current time. When PPG sends an SMS message. Error log files display error and warning messages that are also viewable in the debug log file. all of which are intercepted by the SMSC and routed to PPG. The wireless carrier allocates a reply number—a phone number or short code—to the PPG Administrator.4. The log files are rotated. The recipient device sends an SMS message back to one of the reply numbers. Debug log files do not need to be enabled to generate and view the error log files. Rolled logs and the current logging file use the file name format prefix-GYYYYMMDDHHMM. You can specify a directory to which to save the transaction log files. is as follows: l l Two-way (simultaneously): 120 per minute About two-way SMS support l PPG supports two-way SMS messaging via SMPP or modem connectors. Outbound only: 14 per minute Inbound only: 30 per minute About log files Two-way (in and out simultaneously): 10 per minute PPG maintains the following types of log files in its program directory: SMPP connectors SMPP connectors allow a high volume of messages to be sent via an SMSC. The supported protocol is SMPP version 3. or rolled. where prefix is one of the following and G is the gateway ID: By the SMSC to receive the incoming SMS messages that are then sent to the PPG.6 Feature Pack 2 Debug logs. Two-way SMS and SMPP connectors l Transaction logs. This reply number is used: l Error logs. 153 l cppg. l The PPG throughput via an SMPP connector. as shown in the following table. it specifies one of these available numbers in the From field. and the replying device’s address to RightFax. where each roll occurs at zero-hundred hours (0000). message contents. Transaction log files are generated in a standard format that external applications can parse or save.LOG. PPG can send the reply number. By the mobile devices to reply to the SMS messages sent to them via PPG. When this occurs. every 24 hours.Chapter 17: Text messaging using the Push Proxy Gateway l About two-way SMS support Then. for transaction log files l dbgp for debug log files l errp for error log files Administrator Guide . using API. PPG can use SMPP connectors to assist RightFax in associating incoming SMS messages with RightFax user mailboxes for routing purposes. You can change the interval setting for transaction logs so that the roll occurs anytime between 10 minutes and 24 hours. OpenText RightFax 10. 4.Type: Outbound. On the Select features page. NotifyTo: . Inbound. 4. Service is used for PPG Service Startup/Shutdown messages. select Custom. Example 12/03/2003 13:50:36:923 . (destination) destination extracted from PAP message 2. expand Server Modules and DocTransport Module.separator - 4 Push Initiator IP address of the address Push Initiator PI: 1. and then complete the remaining prompts. Device Subscriber number Device: address or address of +14255551212.3. Status: Delivered 5 Push ID PushID: PI/64. Type Example Example Status: delivered The transaction logs use the format: Type: value. MessageID: value. and then click Next. ToAddress: +14255551212.6 Feature Pack 2 154 Administrator Guide .2. PI: 1. Installing the Push Proxy Gateway 6 Push ID extracted from the PAP message To install the Push Proxy Gateway 1.2. NotifyTo: value. Notification. 7 Notification URL Address to be NotifyTo: . 8 Status Status of the message. Select the Push Proxy Gateway check box. PI: value. FromAddress: 14255551234. notified when the message has been sent. Does not apply to Modem connector. On the Select a typical feature set or create your own page.Chapter 17: Text messaging using the Push Proxy Gateway Installing the Push Proxy Gateway Transaction log formats Column Value Description The following table lists the formats used in a PPG transaction log.4. 3.3. Column Value Description 1 The type of Type: Outbound message: Outbound. and Service. On the RightFax Server. Click Next. Status: value 2 Date and time Date and time of request 12/03/2003 13:50:36:923 3 - Static . MessageID: PI/64. FromAddress: value. ToAddress: value. run the RightFax installation program. either Delivered or Failed. Note the following: OpenText RightFax 10. Note Do not use the remote feature of the Windows Service Control Manager. double-click Mobility Push Proxy Administration. use Remote Desktop Services or Terminal Services to log on to the server and use the Windows Service Control Manager.6 Feature Pack 2 155 Administrator Guide . To control the service from a remote computer. OpenText RightFax 10. The PPG Administration window opens. If the PPG accepts connections from the Internet. See Configuring the DocTransport modules on page 61. See Starting and stopping services on page 25. The connector options change depending on the active connector you select. Click the Interfaces tab to establish the connection details for the PPG. it is especially important to keep Microsoft IIS up to date with security patches. you must stop and restart the PPG service before the changes take effect. The following shows the Interfaces tab with GSM Modem selected as the Active Connector.Chapter 17: Text messaging using the Push Proxy Gateway l l Configuring the Push Proxy Gateway 3. especially the internal port (default 5001) and the administration port (8901) should not be accessible from the Internet. Start EFM. take care to keep the server up to date with any necessary patches. 2. see Starting Enterprise Fax Manager on page 18. In the Service Name list. For more information. After you make changes in the PPG interface via RightFax. The PPG's public port (default TCP 8980) should be accessible to any computer that sends messages to the PPG. expand the RightFax server where PPG is installed. depending on the operating system. To configure PPG 1. In the left pane. The other ports. Configuring the Push Proxy Gateway You must add PPG as a transport in the DocTransport module before you can configure and use the PPG. Configuring Interfaces options l Caution As with all servers. The default is “AT+CMGF=0”. Change the fields for Baud Rate.iana. Refer to the Service Name and Transport Protocol Port Number Registry at http://www. Data Bits.org/assignments/port-numbers for a list of registered ports. Select the connector to be used by the PPG. Data Bits. Message Encoding Format For the standard US ASCII character set. The initialization string can be found in the phone’s manual. Send Message Port Enable Modem The port number of the Internal Interface. OpenText RightFax 10. GSM Modem or SMPP. and Stop Bits This port must be on the machine where PPG is installed.Chapter 17: Text messaging using the Push Proxy Gateway Configuring the Push Proxy Gateway SMS message size limits Important Some of the ports used by the PPG by default are registered as service contact ports with the Internet Assigned Numbers Authority (IANA). Enter the telephone number of the SMSC used by the carrier to which your modem is subscribed. The default value is 5001. select US ASCII . a single SMS message holds 140 bytes of information. When sending messages via the Modem connector. Administration Port SMSC The PPG Administration service listens on this port for configuration requests. In the GSM environment. The default value is 5002. select UCS-2. and Stop Bits as appropriate for the modem in use. The default value is 8901. Modem Init String Active Connector Enter the initialization string. Select this check box to instruct PPG that the selected port is active and should use these configuration settings. If you need diacritical characters and for most double-byte languages. This port should not be accessible by outside/Internet computers. Baud Rate. This is a port used for communication between the IIS extension and the PPG service.INI file. GSM Modem-specific options Modem Select an available modem from the list. The phone number of the cell phone or cellular modem that connects to the communications port. you can assign a different port number by modifying the entries on the Interface page or editing the CPPG. Parity.6 Feature Pack 2 156 Administrator Guide . Contact your carrier to get this number. Receive Message Port Number The PPG service sends inbound messages to RightFax via this port. Parity. all messages are carried in a single SMS message. If you encounter a port conflict. This is the default. Single Port Select to instruct PPG to communicate with the SMSC via a single port.Chapter 17: Text messaging using the Push Proxy Gateway Configuring the Push Proxy Gateway UDP-specific options SMPP-specific options: Default Destination Port SMSC IP Address The PPG uses port number 2948. Double Port Select to instruct PPG to communicate with the SMSC via a dual port.6 Feature Pack 2 157 Administrator Guide . OpenText RightFax 10. The IP address of the carrier. Max Msg/Min The maximum number of messages sent per minute. l Retry Interval The number of seconds the PPG waits to retry a connection. Short Code Select if using a shortened phone number. Add a range of numbers by entering the beginning of the range in the upper field and the end of the range in the lower field. such as a user name. then clicking Add Range. and then clicking Add Range. SMPP Version Managing licenses The version number is generally 3. Input the range of phone numbers assigned to your SMPP connection. It is provided by the carrier. The message is discarded if it is not delivered within this time frame. An SMS message that includes a list of Timeout Interval The connection is no longer valid if a response is not received within this number of milliseconds. The assigned numbers in the range are automatically generated. Click the License Management tab to add or remove PPG licenses. An SMS message sent to one phone. Port Clear Range The port used to connect to the SMSC. Add an individual number by entering it in the upper field. Click to delete all of the numbers currently assigned to this connection. It is provided by the carrier. equals one transaction. It is provided by the carrier.Chapter 17: Text messaging using the Push Proxy Gateway Configuring the Push Proxy Gateway System ID Address Range This is identification on the carrier’s system. Msg Lifetime The number of hours a message is considered valid. in the format IP Address:Port. Note A transaction is defined as one message sent to one address. OpenText RightFax 10. System Type l This is additional information used to identify the user.6 Feature Pack 2 158 Administrator Guide . after a connection fails. if one was assigned to you. l Password This password is used to connect to the SMSC. depending on the SMSC implementation. OpenText RightFax 10.6 Feature Pack 2 159 Administrator Guide . Delete Click to remove a selected license from the list.LOG. Configuing logging l Click the Logging tab to define collecting transaction and debug log files. and the date and time are the date and time the log file started. A license is automatically installed that allows 6000 transactions per minute. The transaction log contains the Call Detail Records (CDR). where G is the gateway ID. Add Click to add the license entered in the Serial Number field to the list of available PPG licenses.Chapter 17: Text messaging using the Push Proxy Gateway Configuring the Push Proxy Gateway Licensed transaction per minute 10 phone numbers equals 10 transactions. See About log files on page Serial Number The full license key. Transaction file logs are saved with a name in the format cppg-GYYYYMMDDHHMM. This number is high enough that there should never be a need for additional licenses. They cannot be saved to a mapped network drive. Type the value in hours and minutes (00:10 to 24:00). Specifies how often log files should be rotated. the rotated log files are saved in the PPG installation directory. 90 days of previous log activity are saved. By default. Debug logs can be quite large.Chapter 17: Text messaging using the Push Proxy Gateway Configuring the Push Proxy Gateway Rotate logs every n minutes 153.6 Feature Pack 2 160 Administrator Guide . Debug Log Select to enable a detailed log file of gateway activity. To save the log files in a different directory. Retain Debug Logs for (Days) Enter a value for how many days the debug log files will remain on the system. If the debug log is enabled. so this setting should be off for normal operation. then the PPG service must be stopped and restarted before it takes effect. Automatically rotate logs Select to rotate log files automatically. By default. Rotate logs to separate directory By default. OpenText RightFax 10. the server’s log file is closed and a new log file is created at midnight each day. This option closes the current log file and opens a new one more frequently. Note Log files must be saved on a local drive. type the complete path of the target directory in this box. Number of days to retain transaction logs Enter a value for how many days old log files will remain on the system. The default is 90. You can also configure a default notification method per group of users. See Starting Enterprise Fax Manager on page 18. Under the local server. To add an SMS or pager service to RightFax l 2. select New. you can configure the notifications and alerts: l 4. On the Destination tab. 161 Configure fax status notifications and their mode of delivery for individual users. The Edit SMS/Pager Service Definition window opens. See The Notification tab on page 120. and then click SMS/Pager Services under the desired RightFax server in the Fax Server tree. Routing plans on page 185. See Configuring the DocTransport modules on page 61. and then select SMS. 3. pager messages. first install and configure the RightFax Push-Proxy Gateway (see Text messaging using the Push Proxy Gateway on page 152). add a dialing rule. Add SMS functionality to the RightFax server by adding and configuring the SMS Via Push-Proxy Gateway (Mobility Push-Proxy Gateway) doc transport. Managing SMS and pager services To configure SMS notifications. See Creating dialing rules and Least-Cost l OpenText RightFax 10. See Notification Type on page 126 For administrative users. or SMS messages to fax users and administrators to alert or notify them of specific RightFax events. 5. To install the RightFax Push Proxy Gateway for SMS messaging Adding SMS and pager services 1. After adding the necessary SMS and pager services. start RightFax Enterprise Fax Manager (EFM). Create a pager service configuration for each type of service. See Editing SMS and pager service properties on page 162. To send these alerts and notifications from RightFax. Install the RightFax Push Proxy Gateway.Chapter 18: Adding SMS and pager services Managing SMS and pager services Chapter 18: Adding SMS and pager services You can configure the RightFax server to send emails. you must create a list of available services and providers. run Enterprise Fax Manager. configure administrative alerts Administrator Guide . After the computer restarts.6 Feature Pack 2 On the Edit menu. Click OK. See Installing the Push Proxy Gateway on page 154. select Send Via Transport. select the service to delete and press Delete or select Delete from the Edit menu. Users can be paged via SMTP email (requiring Internet connectivity). To delete SMS or pager services l To delete a pager service. Enter the SMTP mail address from which the page will be sent.6 Feature Pack 2 162 Administrator Guide . OpenText RightFax 10. The service ID of an existing pager service cannot be changed. To create and customize a list of server statistics to monitor and alert on. Some SMTP message servers require the sender’s Select the pager service. Each type of service you add requires different configuration settings. any configuration data not supported by the older version will be lost. see The Administrative Pager Alerts tab on page 117).and on the Edit menu. When you type a new service ID for an existing pager service. To copy one or more pager services from one RightFax server to another l Service ID Enter a descriptive ID for the service provider or type of service. see Using the Alerting and Monitoring service on page 165. SMTP Server To edit the properties of an existing service SMTP Sender Address l Enter the name of your service provider’s SMTP server. and then drag the selection to another server.Chapter 18: Adding SMS and pager services Editing SMS and pager service properties either in the standard user configuration or using the more complex RightFax Alerting and Monitoring service: l l Configuring SMTP services To configure alerts for individual administrative users. Service Type Editing SMS and pager service properties Select SMTP. click Edit. Enterprise Fax Manager creates a copy of the service with the new name. Select the pager services. or send SMS messages (requiring the RightFax Push-Proxy Gateway). via TAP or UCP protocols (requiring any TAPIcompatible or AT-compatible modem). Note If you copy pager services from a new RightFax server version to an older one. Message Transaction Timeout Enter the number seconds after which RightFax will stop attempting to send a message to the TAP or UCP messaging system. If a connection cannot be established in the specified time. The service ID of an existing pager service cannot be changed.Chapter 18: Adding SMS and pager services Editing SMS and pager service properties SMTP address to process transactions. OpenText RightFax 10. Service Type Select TAP Dial-up or UCP Dial-up respectively. Connection Timeout Enter the number of seconds after which RightFax will stop attempting to establish a connection to the TAP or UCP messaging system. If you select a TAPI modem. Service ID Enter a descriptive ID for the service provider or type of service. If you installed one or more TAPI modems on your RightFax server.6 Feature Pack 2 163 Administrator Guide . Enter your service provider’s modem phone number (for TAP and UCP messaging only). Ignore TAPI Dialing Location Rules Terminal Phone Number Select this check box to ignore any specified dialing location rules (such as add 9 to dial out) if you have specified a TAPI modem in the Modem Communication Driver box. TAP and UCP dial-up use the same configuration options. When you type a new service ID for an existing pager service. Maximum Message Size Enter the maximum number of characters allowed by your service provider for pager or SMS messages. RightFax will abandon the call and a message will not be sent. select None. you can select from those modems as well. If your provider is not listed here. enter the password your service provider requires to access their TAP or UCP messaging systems. RightFax will abandon the call and a message will not be sent. the Direct Modem Parameters settings are unavailable because those settings are taken from your TAPI modem configuration on the RightFax server. Provider Specify the specific provider for your UCP or TAP service. Modem Communication Driver Specify the COM port for the modem on the RightFax server. Service Password Configuring TAP and UCP Dial-up services As required. Enterprise Fax Manager creates a copy of the service with the new name. If the message cannot be sent in the specified time. PPG Port Number Use the default value for the PPG Port Number. OpenText RightFax 10.Chapter 18: Adding SMS and pager services Logging SMS and pager alerts Direct Modem Parameters PPG Host (IP or Name) These parameters are configured according to your modem type and phone system dialing requirements. set up at least one user to receive it. Enterprise Fax Manager creates a copy of the service with the new name.6 Feature Pack 2 164 Administrator Guide . The service ID of an existing pager service cannot be changed. To ensure that logging occurs using the special event identifier l For each alert type. Use the default value for the PPG Host. enter the baud rate in the Port Speed box. To filter on these events l Enter the following: source = “RightFax Server Module” and Category = “Administrative Alert” Service ID Enter a descriptive ID for the service provider or type of service. none are logged in the NT Event Log using the special event identifier. When you type a new service ID for an existing pager service. Windows monitoring systems can identify when an alert has occurred without monitoring the contents of the event entry. Using this identifier. If no users are set up to receive alerts. If your pager or SMS service provider recommends a baud rate for connecting to their TAP or UCP systems. Service Type Select SMS . Logging SMS and pager alerts Configuring SMS services to another server SMS and pager alerts are logged in the Windows Event Log with a special event identifier. For installation instructions. 2. Configuring the RightFax Alerting service To install the Alerting and Monitoring service l To configure the Alerting and Monitoring service Select the Alerting module check box either after selecting a Custom install during first installation of RightFax or while changing the RightFax product suite installation via the Windows Control Panel once RightFax has been installed. When the Alerting service is installed on a remote computer. all of the configuration for the service and the individual alerts is managed on the RightFax server that the service is monitoring. No additional configuration on the remote computer is required. you OpenText RightFax 10. Installing the Alerting and Monitoring service The Alerting and Monitoring service is not part of the standard RightFax installation. In the Alerting & Monitoring Configuration window. When the Alerting service is installed on a remote computer. you must install and configure the service. double-click RightFax Alerting Monitoring. see the RightFax Installation Guide. To use the RightFax Alerting and Monitoring service. 1. For some statistics you can define alerts when certain conditions are met.Chapter 19: Using the Alerting and Monitoring service Installing the Alerting and Monitoring service Chapter 19: Using the Alerting and Monitoring service Using the RightFax Alerting and Monitoring service you can select statistics you want to monitor. Installing the Alerting and Monitoring service on a remote computer Because the RightFax Alerting service provides information about and sends alerts relating to the RightFax server. may choose to run the Alerting service on a computer other than the RightFax server.6 Feature Pack 2 165 Administrator Guide . it continues to operate and send alerts even if the RightFax server shuts down or experiences other problems. In Windows Control Panel. and then define the statistics to monitor and their alert thresholds. click the tab you want to configure. Use temporarily to track and resolve problems. OpenText RightFax 10. Repeat delay Specify the frequency. See Selecting a service account on page 53. that the Alerting service will poll the RightFax server for statistics. you must select a Windows user account that has a corresponding RightFax user with NT authentication enabled. Using the RightFax Alerting service you can run a program. such as a batch file or other process when thresholds for monitored statistics are reached. Configuring the Launch Program tab l Normal Errors and major events only.” You can select: When you select this option. If you want the Alerting service to authenticate to the RightFax server using NT authentication. in minutes. l Terse Critical errors only. the Select service account window opens. Select service account By default. Event log level Specify the level of information logged in the Application Event Log under the service name “RightFax Alerting Module. l Verbose All significant events.6 Feature Pack 2 166 Administrator Guide .The Alerting service will not be started automatically by the Server module. Use this option to log on using different Windows user account . Use the options on the Launch Program tab to configure how these programs are launched by the Alerting service. Caution Leaving the verbose log level for long periods of time can fill up the Event Log and may prevent new events from being logged.Chapter 19: Using the Alerting and Monitoring service Refresh delay Configuring the General tab Specify the frequency. the RightFax Alerting service logs on to the network using the local system account. in minutes. that alerts will be sent when statistic thresholds are met. l None No information. Remote alerting service Select to indicate that the Alerting service operates on a computer separate from the RightFax server. Chapter 19: Using the Alerting and Monitoring service Managing statistics to monitor and alerts Configuring the SMTP tab Log on as Programs launched by the Alerting service require a Windows user account to access the network. Managing statistics to monitor and alerts Allow program to interact with desktop To open the list of monitored statistics Specifies whether the program launched is accessible from the Windows desktop and usable by whomever is logged on when the service is started. Programs launched by the Alerting service will use the same user account information as the Alerting service. Specify a Windows user account other than that used by the Alerting service. start RightFax Enterprise Fax Manager. SMTP Server Enter the name of the SMTP server that will transport these alerts. On the RightFax server. Same credentials as alerting service account. The email addresses to which alerts will be sent are configured for each individual alert in Enterprise Fax Manager (described in Managing statistics to monitor and alerts on page 167). This account. you must also enter the password for the specified user account in the NT password box. Select one of the following options: l l Using the RightFax Alerting service. see Starting 167 Administrator Guide . For more information.6 Feature Pack 2 1. OpenText RightFax 10. If you select this option. you can deliver alerts as email messages via SMTP when thresholds for monitored statistics are reached. and on the Edit menu. 2. Indicates that the statistic has an associated alert condition. and then click Alerts & Monitors. and. Green. The list of monitored statistics appears in the right pane of the window. Yellow. Either an alert has not yet been set or the statistic cannot be defined to deliver an alert. click Edit.Chapter 19: Using the Alerting and Monitoring service Editing Alert Properties Enterprise Fax Manager on page 18. OpenText RightFax 10. a colored icon in the ID column will indicate its current state: l l l l Select the item in the list. Note If you copy items from a new RightFax server version to an older one. click New. l Blue. on the Edit menu. Editing Alert Properties Red. select the alert. Modifying or Deleting monitored statistics and alerts 2. any configuration data not supported by the older version will be lost. To add a statistic and an alert. and then confirm the deletion. Indicates that the statistic is being monitored. but that an alert is not defined. Some statistics can trigger alerts. On the Edit menu. 168 Administrator Guide . Indicates an error retrieving the value of the statistic. see Alerting and Monitoring Statistics on page 330. and the condition has been met. In the left pane. if the statistic can trigger an alert.6 Feature Pack 2 To edit the properties of an existing alert 1. The current value for the statistic you are monitoring appears in the Value column. Select the items. while others can only be monitored. In the list. See Editing Alert Properties on page 168. The Alert Properties window opens. under Fax Servers. click the name of the RightFax server. if available 1. on the Actions and Message tabs. Indicates that the statistic has an associated alert condition. For more information about each available statistic. Fill in the information on the Monitor tab. and then drag the selection to another server. click Delete. but the condition has not been met. Adding. To delete a monitor or alert l To copy monitors or alerts from one RightFax server to another For each statistic you add to be monitored. Statistics related to the BoardServer service on the RightFax server. l l l l l 2. The description will appear in the Description column of the list of alerts and monitors. Statistics related to the RPC server which coordinates communication between the RightFax server and other resources on the network. l Gateway. Statistics related to activity and events on the RightFax server. Enter a name for the statistic or alert.6 Feature Pack 2 169 Administrator Guide . If the statistic does not support configuring an alert. On the Actions tab. l Workserver. Local Document Transport Server. Defining properties on the Monitor tab Statistic to monitor Name Select the statistic. Statistics related to WorkServers and the OpenText RightFax 10. Statistics related to the paging server used to send notifications via SMS and pages. as well as the alert action to take when the condition is met. Category Select the type of statistic: l Fax Server. you can define the conditions and thresholds for generating an alert. Paging Server. fill in the additional information to uniquely identify the statistic to monitor. Statistics related to email gateways. If additional options become available. RPC Server. Local BoardServer (Legacy). Statistics related to the local BoardServer and any remote BoardServer services.Chapter 19: Using the Alerting and Monitoring service processes they control. The name will appear in the ID column of the list of alerts and monitors. l Database. All BoardServers (Legacy). Description Defining properties on the Actions tab Enter a description for the statistic or alert. Statistics related to the DocTransport service on the RightFax server. Statistics related to the RightFax database. only the Monitor tab appears. l Threshold Specify a threshold value. Under Actions. A message will be sent to an SMS-capable device such as a cell phone or PDA. Alerts can be sent using the following methods: Condition Select the operator by which the threshold value will be evaluated. click the Create a new action button. 4. Measurement of system state or activity to be used by Windows Performance Monitor or other data center management systems. In the Action box. type a name for the alert. The Edit Action window opens. To limit when the alert occurs. SMS. To create a new alert action 1. 5. edit. When thresholds for monitored statistics are reached the specified program (such as a batch file or other process) will be launched. an alert will be generated if the value for the statistic cannot be generated due to errors or other problems with the RightFax service being polled. An alert will be generated only if the condition you select meets this threshold value. click the Time of Use OpenText RightFax 10. 3. Program. SMTP. l Alert on error If this option is selected. You can configure multiple actions for each alert. in the Name box.6 Feature Pack 2 170 Administrator Guide . and delete alert actions that will be taken when the statistic threshold is met. On the Action tab.Chapter 19: Using the Alerting and Monitoring service 2. Note The Network Broadcast Action is no longer functional in any of the currently supported Windows operating systems. Performance Counter. Complete any additional options that appear for the selected alert type. An email message will be sent to a specified user via an SMTP server. select the type of alert to send. l l Actions Use the Actions options to create. Click OK. Note The Start and End times cannot span days.6 Feature Pack 2 171 Administrator Guide . Message Enter the message text of the alert. The new alert will appear in the list of alerts on the Actions tab of the Alert Properties window. An example of the alert message appears in the box below this option. 6. Macros The list of macros that can be included in your message text. OpenText RightFax 10. To have the alert occur only on specific days. You can use any combination of text and macros from the Macros list. under Days of the week to use this alert. Defining properties on the Message tab On the Message tab. Place the cursor in the Message box where you want the macro text to appear.Chapter 19: Using the Alerting and Monitoring service tab. To have the alert occur only at specific times. select the Limit use to the specified time check box. and then double-click the macro in the Macros list. select the check box next to its name. To create an overnight alert. and then select a start and end time. 9. To add a macro to the message l 8. you define the message text that will be sent as an alert when the condition defined on the Actions tab has been met. To enable the alert. 7. select the check boxes next each day of the week when the alert should occur. create one alert that ends at 11:59 PM and another one that begins at 12:00 AM. In the Features area. SNMP Alerting also actively sends status messages and alerts to your network monitor application for real-time monitoring of RightFax processes. 2. RightFax alerts are categorized by severity: Critical.6 Feature Pack 2 172 Administrator Guide . They can be enabled or disabled according to their severity. 6. On the RightFax server. and then click Services. 4. Double-click SNMP Service in the list of network services. In the Community Name box. 3. 5.exe located in the RightFax\SNMP folder after installing the service. Verify that SNMP Service does not yet appear in the OpenText RightFax 10. Error. To use SNMP Alerting. click Administrative Tools and click Services. 3. 1. After the SNMP service is installed. 2. enter the IP address of each machine on your network where you want to send RightFax SNMP alerts (each machine used for network 1. and then click the Traps tab. from the Start menu. close the Network dialog box. the Microsoft SNMP service must be installed on both the RightFax server and on the network server that monitors messages. 4. on the Start menu. Click the checkbox next to SNMP Service and click OK.Chapter 20: Using SNMP Alerting Configuring the SNMP Service on the RightFax server Chapter 20: Using SNMP Alerting The RightFax SNMP Alerting feature collects status data from the RightFax server and returns it to a monitoring application for processing and reporting. run SNMPFirewallTool. click Add Features. From the Start menu. and Informational. add the community name Public. click Administrative Tools. click Administrative Tools and click Server Manager. In the Trap Destinations box. Configuring the SNMP Service on the RightFax server To install the Microsoft SNMP Service To configure the SNMP service properties Follow these steps if the SNMP service has not already been installed on the RightFax server. Services list. Warning. On the RightFax server. Note If adding the SNMP service on Windows Server 2012 after RightFax has been installed. The RightFax SNMP Alerting feature also allows RightFax services to be stopped and restarted directly from your network monitor application. Note that (<150 MB). Critical is severity level one. This file is installed by default to the RightFax server in the RightFax\SNMP folder. 5.” the actual amount of disk space that triggers this warning is configurable. helps you verify that problems with the RightFax server are reported and addressed promptly. Configuring the Network Monitor application The following table defines each RightFax alert and the default RightFax severity.6 Feature Pack 2 Alert message 173 One or more drives on the RightFax server have less than 50 Mb free. Default Definition severity “All BoardServers are down. Fax sending and receiving is not currently operating. The fax server can send up to nine alerts to your SNMP network monitor.conf. The MIB variables for RightFax SNMP Alerting are located in a file called Avtc. RightFax alerts can be sent to an unlimited number of network monitoring stations on your network.Chapter 20: Using SNMP Alerting Configuring the Network Monitor application monitoring). Before it can receive SNMP alerts from the RightFax servers. and then click Add. Your network monitor software can be configured to use different terminology. your organization’s network monitor application must be configured to recognize the RightFax SNMP Alerting Management Information Base (MIB) variables and trap definitions. In the network monitor.bat from a command line on the Network Node Manager machine. “One or more drives on the Critical fax server are critically low on disk space (<50 MB). Error is severity level two. and Warning is severity level three. execute the appropriate command(s) to load new SNMP MIB variables and trap definitions. Note that the actual amount of disk space that triggers this warning is configurable. In RightFax terms. To automatically load the MIB variables and trap definitions in Network Node Manager.” Receiving RightFax alerts in your network monitor RightFax SNMP Alerting actively pushes RightFax alerts to your SNMP-capable network monitoring application. This OpenText RightFax 10. run the file Rfhpov. Many fax server functions have been suspended. Both of these files are installed by default to the RightFax server in the RightFax\SNMP folder.” Critical All DocTransports attached to this fax server have gone down. RightFax includes a utility that automates this configuration for HP OpenView Network Node Manager. You can also use SNMP Alerting to query several variables on the RightFax server so you can view the status of the fax server in real-time. Administrator Guide . “One or more drives on the Warning One or more drives on the fax server are approaching RightFax server have less critically low disk space than 150 MB free. Click OK.mib and the trap definitions are located in Rftrapd. Each alert severity indicates how vital the component is to the operation of the RightFax server. One or more fax channels have gone down due to line failure. “The send queue depth on Critical server ServerName is currently: #/# (faxes/pgs). but at least one other DocTransport is still running. Error Because SNMP alerts are generated from the Windows Event Log on the RightFax server machine. For information about displaying and managing alarm messages. Warning and Informational alerts indicate a loss of fax capacity. see the documentation for your network monitoring application. the event log level of each individual RightFax service must be set to an appropriate level.” Critical “The fax server process was not properly shutdown. Critical and Error alerts indicate a loss of fax functionality. Enabling and disabling RightFax alerts The RightFax SNMP MIB contains the following editable (read/write) variables that you can use to enable or disable the RightFax alerts according to severity.6 Feature Pack 2 The Terse setting records critical errors only.000 faxes or 10. This setting can cause the event log to fill up quickly. “RightFax Email Gateway Warning The RightFax server is module on unable to communicate with FaxServerName: The the Exchange server. which may prevent new events from being logged. Alerts generated by RightFax SNMP Alerting are stored in your network monitor under the RightFax Server Alerts category. These severity levels may use different names in your network OpenText RightFax 10.“ “The fax server internal queue is more than 90% utilized. “Unable to communicate with BoardServer ServerName (error 2)” One DocTransport is down. three consecutive no-dial tone errors within 45 minutes. Exchange Connector has not responded in a timely fashion. The RightFax internal event queue is more than 90 percent utilized. For information on configuring the event log level for each RightFax service. but the severity hierarchy is the same.” Critical A fax server was shut down unexpectedly.Chapter 20: Using SNMP Alerting Alert message Receiving RightFax alerts in your network monitor monitoring application.” There are more than 1. 174 l rfSvrEnableCriticalTraps l rfSvrEnableErrorTraps Administrator Guide . Inbound message processing temporarily disabled.” Note RightFax does not send specific clearing alerts that indicate when the cause of an alert has been resolved. refer to Using the Alerting and Monitoring service on page 165. l l The Verbose setting records all significant events and is most useful for tracking and resolving problems. Default Definition severity “Possible phone line failure Critical on channel #.000 fax pages in the fax queue. The following tree lists each object in the RightFax SNMP MIB tree.4.4.9.AVTC. each made up of several variables.internet.rfServerTraps rfDatabaseModule (.2.5) rfRPCServerModule (.2.1) Querying RightFax status variables rfWorkSvrModuleEntry (. expand the MIB tree to: rfWorkSvrFunctionTable (.1) rfBoardInfoEntry (.2.6 Feature Pack 2 175 Administrator Guide .AVTC. Please refer to your network monitoring application’s documentation for information on editing variables in the MIB.org.4) OpenText RightFax 10. To query the RightFax variables in your network monitoring application. rfFaxServer.2) To edit the variables.1) rfChannelInfoTable (.1) rfEMailGateway (.iso.1.2) Variables in the rfFaxServer_OV_v1Traps_ MIB Object rfBoardServerModule (.4.7) rfPagingServer (.iso.10.dod.0) rfServer (.3.dod.4.1) rfFaxServer_OV_v1Traps_ (.10.1) rfFaxServer_OV_v1traps_ rfServerModule (. expand the MIB tree to: rfChannelInfoEntry (. These variables provide real-time status information on the RightFax server.enterprises.1.1) .6.1.3529.9) rfWorkSvrModuleTable (.Right-FAX. rfQueueHandler (. The following tables list each of the RightFax SNMP variables and their definitions grouped according to the objects they are contained in.1.Chapter 20: Using SNMP Alerting l rfSvrEnableWarningTraps l rfSvrEnableInformationalTraps Querying RightFax status variables rfBoardInfoTable (.6) Each variable can be set to either “objectENABLE” or “objectDISABLE. rfFaxServer rfGatewayModuleEntry (.11) All addresses below this branch point to a RightFax SNMP object or variable.9.4. rfFaxServer (.10) rfGatewayModuleTable (. see the documentation for your particular application. Objects in bold contain variables.3) rfBoards (.enterprises.9.1.internet.1.private.1) rfServerTraps (.1) The RightFax SNMP MIB contains 12 objects. Right-FAX.1) . For information about using your network monitoring application to access the MIB tree and query variables in the MIB.” Changes to the variables take effect immediately.9.private.8) rfWorkServers (.org.2) rfWorkSvrFunctionEntry (. Variables in boldface are editable. Text of informational alert reported by the RightFax server. rfSvrDiskAvailForfaxImages Integer Percentage of disk space on the fax server available for storing fax images. Text of warning alert reported by the RightFax server. Text of critical alert reported by the RightFax server. This is a notification type variable and cannot be queried or edited. rfSvrAllTimeFaxesReceived Integer Total number of faxes received on this server since the All-Time Counter starting date (rfSvrAllTimeCounterStart). rfSvrAllTimePagesSent Integer Total number of fax pages sent from this server since the All-Time Counter starting date (rfSvrAllTimeCounterStart). rfSvrWarningTrap Notif. rfSvrAllTimePagesReceived Integer Total number of fax pages received on this server since the All-Time Counter starting date (rfSvrAllTimeCounterStart). rfSvrAllTimeFaxesSent Integer Total number of faxes sent from this server since the AllTime Counter starting date (rfSvrAllTimeCounterStart). rfSvrBoardSvrAvailIndex Integer Availability of the server’s fax boards). This is a notification type variable and cannot be queried or edited. OpenText RightFax 10.Chapter 20: Using SNMP Alerting Querying RightFax status variables Variable Type Definition Variable Type Definition rfSvrCriticalTrap Notif. rfSvrInformationalTrap Notif.6 Feature Pack 2 176 Administrator Guide . rfSvrErrorTrap Notif. rfServer Variables in the rfServer MIB Object Variable Type Definition rfSvrQueueUsage Integer Percentage of the fax server’s internal Event Queue currently in use. rfSvrCurrentFaxesQueued Integer Current number of outgoing faxes waiting to be sent. This is a notification type variable and cannot be queried or edited. rfSvrDiskAvailForfaxDB Integer Percentage of space available for storing fax database information. rfSvrCurrentPagesQueued Integer Current number of outgoing fax pages waiting to be sent. rfSvrEventsProcessed Integer Total number of events processed by the fax server since the Server module was started. This is a notification type variable and cannot be queried or edited. Text of error alert reported by the RightFax server. rfChannelInfoTable. 177 Definition Administrator Guide . rfBoardSvrVersionNumber String BoardServer module version number.rfChannelInfoTable.6 Feature Pack 2 Length of time the BoardServer has been running. Variables in the rfBoards. rfSvrModuleTimeRunning Length of time the Fax Server service has been running.rfChannelInfoEntry MIB Object rfSvrModuleServiceStatus Integer Current Server module service state.rfBoardInfoEntry MIB Object rfServerModule Variables in the rfServerModule MIB Object Variable Type Definition rfSvrModuleServiceName String RightFax Server module service name. rfBoardSvrModuleStatus Integer Current BoardServer service state.rfChannel InfoEntry RightFax Server module version number. Integer rfBoardSvrModuleTimeRunning String Total number of pending fax send statuses in the queue used by the fax servers to update status information. rfBoardServerModule Variable Type rfChannelIndex Integer Channel table index (lists each installed fax channel). Variables in the rfBoardServerModule MIB Object Variable Type rfBoardSvrModuleServiceName String OpenText RightFax 10. rfBoards. rfChannelOperation String Current operational status of all channels. rfBoardName String Definition Each installed fax board type. rfSvrAllFaxesScheduled rfSvrAllTransmission Statuses Integer Total number of faxes that need to be sent in the global queue.rfBoardInfoEntry Variables in the rfBoards.Chapter 20: Using SNMP Alerting Querying RightFax status variables Variable Type Definition Variable Type Definition rfSvrAllTimeCounterStart Integer Starting date from which the “All-Time” statistics are calculated. rfBoards.rfBoardInfoTable. This queue is used by all DocTransports. rfChannelChannel String Channel numbers and [S] or [R] flag indicating send or receive functionality. Definition BoardServer service name.rfBoardInfoTable. rfSvrModuleVersionNumber String String Variable Type rfBoardIndex Integer Fax board index. rfDatabaseSvrModuleStatus Integer Current Database module service state. rfChannelPagesInCall Integer Number of fax pages being transmitted during this call.6 Feature Pack 2 Queue handler service name. Variables in the rfRPCServerModule MIB Object rfChannelPhoneNumber String Destination phone number of outgoing faxes. Variable rfRPCSvrModuleServiceName String RPC module service name. Integer Current Queue handler service state. rfRPCSvrModuleStatus rfChannelRemoteID String Remote ID of machines sending incoming faxes. rfDatabaseSvrModuleTimeRunning String OpenText RightFax 10. Length of time the RPC service has been running. rfRPCSvrVersionNumber String rfChannelState String Channel state. rfChannelCompression String Data compression method.Chapter 20: Using SNMP Alerting Querying RightFax status variables Variable Type Definition rfRPCServerModule rfChannelRoutingCode String Inbound routing code for all incoming faxes. Integer Current RPC module service state. rfRPCSvrModuleTimeRunning String rfChannelRate String Current rate of transmission. rfQueueHandlerModuleTimeRunning String Definition Definition Length of time the queue handler has been running. Type rfPagingSvrModuleServiceName String 178 Definition Paging module service name. Administrator Guide . rfDatabaseSvrVersionNumber String Database module version number. RPC module version number. rfQueueHandler Variables in the rfQueueHandler MIB Object rfChannelMinutesRemain Integer Estimated number of minutes remaining in the transmission. rfPagingServer Variables in the rfPagingServer MIB Object Variable Length of time the Database service has been running. Type Definition rfChannelUserID String Destination User ID for incoming faxes. Variable Type rfQueueHandlerModuleServiceName String rfDatabaseModule rfQueueHandlerModuleStatus Variables in the rfDatabaseModule MIB Object Variable Type rfDatabaseSvrModuleServiceName String Database module service name. rfWorkServers.6 Feature Pack 2 Type rfWorkSvrFunctionIndex Integer WorkServer function table index (lists all WorkServers).rfWorkSvrModuleEntr y MIB Object Variable Type rfWorkSvrModuleIndex Integer WorkServer module table index (lists all WorkServers). rfWorkSvrFunctionEntry Variables in the rfWorkServers.rfWorkSvrModuleTable. String Variable Length of time each WorkServer has been running. Integer Is Overlay service processed? (Yes/No) rfWorkSvrFunctionPCL5 Integer Is PCL5 service processed? (Yes/No) rfWorkSvrFunctionPrint Integer Is Print service processed? (Yes/No) Integer Each WorkServer module service state.rfWorkSvrFunctionTable. 179 Administrator Guide . Integer Is FileRoute service processed? (Yes/No) rfWorkSvrFunctionOverlay Each WorkServer module version number. rfWorkSvrModuleServiceName String rfWorkSvrModuleVersionNumber String rfWorkSvrModuleStatus rfWorkSvrModuleTimeRunning OpenText RightFax 10. rfWorkSvrModuleEntry Variables in the rfWorkServers.Chapter 20: Using SNMP Alerting Querying RightFax status variables Variable Type Definition rfPagingSvrVersionNumber String Paging module version number. rfPagingSvrModuleTimeRunning String rfWorkServers.rfWorkSvrModuleTable.rfWorkSvrModuleTable. rfPagingSvrModuleStatus Integer Current Paging module service state.rfWorkSvrModuleEntr y MIB Object Length of time the Paging module has been running. rfWorkSvrFunctionArchive Integer Is Archive service processed? (Yes/No) rfWorkSvrFunctionCoverSheet Integer Is Cover sheet service processed? (Yes/No) rfWorkSvrFunctionCVL Integer Is CVL service processed? (Yes/No) Definition Definition rfWorkSvrFunctionFileRoute Each WorkServer module service name. rfSvrTrapSeverity Integer Severity of the alert.rfGatewayModuleTable. rfGatewayModuleServiceName String OpenText RightFax 10. rfGatewayModuleStatus Integer Current state of each gateway service. Variables in the rfServerTraps MIB Object Variables in the rfWorkServers. Each gateway service name.rfWorkSvrModuleEntr y MIB Object Type Definition rfServerTraps rfEMailGateway. Network messaging is no longer functional in any of the supported Windows operating systems. This variable is used only for trap notifications and cannot be queried or edited. This variable is used only for trap notifications and cannot be queried or edited.Chapter 20: Using SNMP Alerting Variable Querying RightFax status variables Type Definition Variable rfWorkSvrFunctionNetMessaging Integer Is Network Messaging service processed? Set to No. 180 Administrator Guide .6 Feature Pack 2 Each gateway module version number. rfGatewayModuleEntry Variable Type Definition Variable Type Definition rfSvrTrapComputer String Computer that generated the alert. rfGatewayModuleTimeRunning String Length of time each gateway has been running. rfWorkSvrFunctionDelImageFile rfGatewayModuleVersionNumber String Integer Is Delete Image File service processed? (Yes/No) rfWorkSvrFunctionOCR Integer Is OCR service processed? (Yes/No) rfWorkSvrFunctionInterConnect Integer Is InterConnect service processed? (Yes/No) rfWorkSvrFunctionPostscript Integer Is PostScript service processed? (Yes/No) rfGatewayModuleIndex Integer Gateway module table entry index (lists each email gateway).rfWorkSvrModuleTable. This variable is used only for trap notifications and cannot be queried or edited. rfSvrTrapSource String Source of the alert. rfSvrEnableInformationalTraps Integer Informational alerts enabled/disabled. Each RightFax service object in the MIB contains a status variable.6 Feature Pack 2 The troubleshooting information in this section points to the most common causes and solutions for each of the nine SNMP RightFax alerts. contact your RightFax administrator and/or network administrator. rfSvrEnableCriticalTraps Integer Critical alerts enabled/disabled. Each variable can be set to either “statSERVICE_STOPPED” or “statSERVICE_RUNNING. these variables list the current state of the service on the RightFax service (such as stopped. Because network related problems can trigger RightFax alerts. Troubleshooting the RightFax alerts Controlling RightFax services from your network monitor SNMP alerts call attention to events or conditions on the RightFax server that may effect your server’s ability to send and receive faxes. or paused). In most cases. each contained in a separate MIB object: The actual causes of these events and conditions are not reported as part of the SNMP alerts. l rfWorkSvrModuleStatus l rfGatewayModuleStatus When queried. the rfDatabaseModule object contains the variable rfDatabaseSvrModuleStatus. l rfSvrModuleServiceStatus l rfBoardSvrModuleStatus l rfDatabaseSvrModuleStatus l rfRPCSvrModuleStatus l rfQueueHandlerModuleStatus l rfPagingSvrModuleStatus OpenText RightFax 10. RightFax relies on the network for much of its functionality. This variable is used only for trap notifications and cannot be queried or edited. reviewing the Event Log on the server which is reporting the alert provides details as to the cause of the alert. For example. 181 Administrator Guide . There are a total of eight service status variables. However. Please refer to your network monitoring application’s documentation for information on editing variables in the MIB. If RightFax alerts persist after following these steps.” Changing any of these variables automatically instructs the RightFax server to start or stop the appropriate service. the steps included here may not always resolve the cause of the alert.Chapter 20: Using SNMP Alerting Controlling RightFax services from your network monitor Variable Type Definition rfSvrTrapMessage String Alert notification message. rfSvrEnableErrorTraps Integer Error alerts enabled/disabled. You can also edit these variables to manually start or stop the services on the RightFax server. rfSvrEnableWarningTraps Integer Warning alerts enabled/disabled. started. as a client-server application. the failure may be due to problems with network connectivity between the remote machine and the RightFax server.6 Feature Pack 2 Run Enterprise Fax Manager and check the status of the RightFax services.Chapter 20: Using SNMP Alerting Controlling RightFax services from your network monitor All BoardServers down l This alert indicates that all primary and remote DocTransport services have failed. Another option is to move the RightFax\Image folder to a new drive. check the RightFax log in the Windows Event Viewer for details. Create a RightFax\Image folder on a new drive with sufficient free storage space. attempt to run the DocTransport in a window. RightFax automatically stops processing additional fax traffic as both the drive that RightFax is installed on and the drive that Windows is installed on have more than 50 MB available. 2. The reason for the failure is the last line of the debug text. Edit the Windows Registry value Image to point to the new directory. This deletes faxes from the server database based on the age of the fax. stop it. If the RightFax Server module has not already stopped. l l Run Enterprise Fax Manager or the Windows Services application and attempt to restart the DocTransports). If this does not alleviate the storage problem. Critically low disk space 3. On the RightFax server and any machines running remote DocTransports. 182 Administrator Guide . If it is exceptionally large. If the DocTransport(s) fail to start. l If the RightFax log does not provide adequate information to resolve the problem. See Image on page 355. OpenText RightFax 10. Additional SNMP alerts may be generated as a result of this action. Stop the RightFax Server module and move all of the images from the old RightFax\Image folder to the new one. check the RightFax\Image folder. To move the image folder If a RightFax DocTransport module on a remote machine starts and appears to be running normally but the alert persists. change to the RFBoard folder and enter: l doctransport. 1. Restart the RightFax Server module. consider adjusting the fax aging (see The Aging and Archiving tab on page 127) or running the Faxage utility (see the RightFax Administrative Utilities Guide).exe -d -1 This runs the module as a session in a window in debug mode. As the board initializes. (There may be additional lines of information associated with the DocTransport module shutting down again after the failure. This alert indicates that one or more drives on the RightFax server have fallen below 50 MB of available space.) l l Uninstall any unnecessary applications from the RightFax server using the Add/Remove Software program in Control Panel. 4. debug information appears. Attempt to restart the connector on the Exchange server through Windows Services. Run the DocTransport configuration program and deactivate the channel that is generating the alerts. Verify that all phone lines are correctly and securely OpenText RightFax 10. This alert indicates that the RightFax server is unable to communicate with the Exchange server. This alert is only generated when the DocTransport returns certain errors in sequence over a given period of time. confirm that the green light on the fax board that indicates the T1 line is active is lit. If the connector still appears to be running. Monitor services and the Event Viewer for Administrator Guide . It is the direct result of phone line problems and not a failure on the RightFax server. For T1 installations. If this alert appears frequently. If using a PBX. Disconnect the phone lines from the server and attach a standard phone to verify that the line is still active. If your fax traffic exceeds the capability of all of your fax channels. see the troubleshooting steps for Critically low disk space on page 182. This condition warns you that resources are getting low. 4. l 2. Send queue too deep 2. To solve this issue 1. This is probably due to a failure of the RightFax connector for Exchange which is the service responsible for all communications between the two systems. To prevent additional alerts while you diagnosis the problem 1. Server improperly shut down This alert indicates that a fax server was shut down unexpectedly. verify that the line is still active through the PBX.6 Feature Pack 2 Verify that there are no other problems being reported with the server or phone lines that might prevent all of your outbound fax channels from being used. shut down and restart the connector. consider increasing your total number of channels. This indicates a sudden and unexpected loss of power. This alert indicates that there are more than a predefined number of faxes or fax pages in the fax queue waiting to send. To resolve this alert. 5. too few fax channels may be dedicated to outbound faxing. Low disk space l This alert indicates that one or more drives on the RightFax server have less than 150 MB free. Run the DocTransport configuration program and reevaluate each channel’s send/receive capability. The RightFax services should restart automatically. l Probable line failure l This alert indicates that one or more of the fax channels have gone down due to line failure. 183 Verify that the server has recovered properly and is stable.Chapter 20: Using SNMP Alerting Controlling RightFax services from your network monitor attached to the fax board(s). Exchange server is not responding 3. Chapter 20: Using SNMP Alerting Controlling RightFax services from your network monitor any problems. l l The most common result of an unexpected shutdown is database corruption, which, if severe, can prevent the RightFax Server module from starting. For information on diagnosing and resolving RightFax database problems, see Error and status messages on page 324. Faxes that were in progress during the shutdown may need to be released or resent by the creator of the fax. To release a fax, click the fax in FaxUtil, and then in the Fax menu, select Status, and then click Release. One BoardServer down A DocTransport attached to this server has gone down, but at least one other DocTransport is still running. This alert is generally not produced as the result of a DocTransport going down, but rather the loss of network connectivity between the RightFax server and a remote machine. You can verify this by running the Windows Services application on each remote machine to confirm that they are all operating correctly. If this is the case, contact your network administrator. If one or more DocTransport services are down, see All BoardServers down on page 182. OpenText RightFax 10.6 Feature Pack 2 184 Administrator Guide Chapter 21: Creating dialing rules and Least-Cost Routing plans Creating, deleting, and copying dialing rules Chapter 21: Creating dialing rules and Least-Cost Routing plans When you use dialing rules you can precisely control outbound faxing by specifying rules and restrictions about how faxes are sent according to their destination fax numbers. l If one fax number matches multiple dialing rule patterns, the fax server weighs each rule according to how closely it matches the fax number, and then sends the fax according to the rule with the greatest weight. Example A dialing rule might specify that all faxes to a certain area code are sent via wide-area network (WAN) to another RightFax server, saving long-distance charges. Another dialing rule might specify that all international faxes can only be sent at times of day when rates are lowest. Dialing rules are server-specific, allowing different rules for servers in different locations or serving groups with varying needs. If you have multiple RightFax servers, you can copy rules from one server to another. RightFax Least-Cost Routing (LCR) routes outbound faxes between RightFax Enterprise servers or RightFax Branch Office servers on a WAN to minimize long distance and other telephone charges. Least-Cost Routing includes dialing rules, load balancing, destination tables, InterConnect, and testing tools. To open dialing rules 1. On the RightFax server, start RightFax Enterprise Fax Manager. For more information, see Starting Enterprise Fax Manager on page 18. Creating, deleting, and copying dialing rules 2. In the left pane, expand the RightFax server and Dialing Plan, and then click Dialing Rules. The list of dialing rules appear in the right pane of the window. Each dialing rule consists of the following parts: l Rules and restrictions that will be applied if the destination fax number matches the pattern or number. To add a new dialing rule A number pattern of wildcard characters or a specific fax number. Outgoing faxes are checked if their destination fax numbers match this pattern or number. 1. On the Edit menu, click New. The Rule Edit window opens. 2. Complete the options in this dialog box, see Editing OpenText RightFax 10.6 Feature Pack 2 185 Administrator Guide Chapter 21: Creating dialing rules and Least-Cost Routing plans Editing dialing rules dialing rules on page 186. The Matching tab 3. On the File menu, click Save Dialing Plan. Note Changes to dialing rules are not automatically saved when you quit Enterprise Fax Manager. If you have unsaved dialing rules, an asterisk appears next to the Dialing Plan icon in the server tree. To delete a dialing rule l Click the rule to delete, and on the Edit menu, click Delete. To copy dialing rules from one RightFax server to another 1. Select the rule or rules you want to copy. 2. Drag the selection to another server. Your EFM preferences determine how much of the information is copied. For more information, see Setting preferences on page 20. Note If you copy dialing rules from a new RightFax server version to an older one, any configuration data not supported by the older version will be lost. Pattern The destination fax number pattern or number that the dialing rule applies to. RightFax ignores any hyphens, parentheses, or spaces in the pattern string. The pattern can include the digits 0–9, as well as the pound [#] and asterisk [*] keys. Editing dialing rules To edit the properties of an existing dialing rule You can use wildcard characters to define variables in the number pattern and thereby specify a range of numbers that the rule will apply to. The following table lists each wildcard character that can be used in the Pattern box and its definition. 1. Open dialing rules in Enterprise Fax Manager. 2. In the right pane, double-click the dialing rule you want to edit. The Rule Edit window opens. OpenText RightFax 10.6 Feature Pack 2 186 Administrator Guide Chapter 21: Creating dialing rules and Least-Cost Routing plans Editing dialing rules Wildcard Definition Examples Weight Wildcard + Matches zero or more digits; must always appear at the end of number string. + matches any fax number entered. 0 points Matches zero or one digit; can be placed anywhere in the number string. ~415+ matches any 4 points number beginning with 415 or [digit]415 including 415555-7000, 415-3222, 1-415555-7000, and 2415. % Matches digits [tableID,#] defined in a destination table to the number of digits specified (see Creating, deleting, and copying destination tables on page 196). ~ 415+ matches any number that begins with 415, including 415-555-7000, 415-4455, and 4151. Examples Weight 415-%[EAST,3]+ matches all numbers that begin with 415 and have a three-digit prefix defined in the destination table “EAST.” Exact matches on the digits 0-9 have a weight of 10 points. Use of wildcard characters decreases the weight of a pattern match because wildcard character matching is always less specific than an exact match. ~~415+ matches 1-415555-7000, 9-1-415-5557000, and 415-555-7000. ? Definition Example The fax number 520-555-7000 matches the patterns “520-555-700?” and “520+”, but is always matched with the first rule because it is more specific. Matches exactly 415-555-7??? matches 5 points one digit. any number that starts with 415-555 and has its final four digits between 7000 and 7999. To add other symbols to the list of supported characters, such as a comma or period, edit the Windows registry to change the ValidPatternChars value. See ValidPatternChars on page 349. 415-???-???? matches any number within the area code 415. Priorities Select the check boxes next to the priorities you want to match for this rule. Only faxes with the priority levels selected here will be considered for this rule. Matching based on priority can be useful when doing fax broadcasts or other large volume faxing. It can also be useful for universal redirection of faxes (for example, to send all high priority faxes from Server2 instead of Server1). OpenText RightFax 10.6 Feature Pack 2 187 Administrator Guide Chapter 21: Creating dialing rules and Least-Cost Routing plans Editing dialing rules Fax Traffic Type Apply the dialing rule based on whether the fax or SMS was generated by the RightFax Integration module. You can restrict the rule to production traffic only, non-production traffic only, SMS messages only, or apply the rule to all faxes. Minimum Queue Depth Specify the number of fax pages that must be waiting in the server’s queue before this rule is considered. Use to define a dialing rule to offload outgoing fax traffic to another server when the load on the current server gets too high. Minimum Fax Size Specify the minimum number of pages a fax must be before this rule is considered. Use to define a dialing rule to offload very large faxes to another server, leaving the local server free to send only smaller faxes. The Restrictions tab All (Every) Each dialing rule can be restricted to specific servers, users, or groups in your organization. The rule will be applied regardless of the origin of the fax. Only These The rule will only be applied to the IDs you specify. Enter one or more names of servers, users, or groups to which the rule applies. Use commas to separate multiple entries. All But These The rule will be applied in all cases except the IDs you specify. Enter one or more names of servers, users, or groups that are exempt from the rule. Use commas to separate multiple entries. The Number Adjustments tab The Number Adjustments tab specifies how fax numbers that match the dialing rule can be modified to properly send from OpenText RightFax 10.6 Feature Pack 2 188 Administrator Guide Chapter 21: Creating dialing rules and Least-Cost Routing plans Editing dialing rules the specified destination. You can append or prepend any combination of dialable digits. You can also include special dialing characters that have special meaning to RightFax. Dialing characters supported by dialing rules The following table lists the dialable characters and their definitions. Characters are not case-sensitive. You can add or remove digits from the beginning or end of the destination fax number (for example, to automatically add a 1 to long distance calls or a 9 if necessary to get an outside line). It can also be used to add a user’s international billing code or to remove all but the last four digits of a number for internal routing. Note If your organization requires a dialing prefix for all outgoing calls (including all outgoing faxes), specify the prefix in the Global Board Settings (see Configuring the DocTransport modules on page 61). Do not specify the prefix in the dialing rules. OpenText RightFax 10.6 Feature Pack 2 189 Character Definition 0–9 Dialable phone digits. ! Hook-flash signal. # Pound button on phone. * Asterisk button on phone. , (comma) 1-second pause (you can combine several of these characters to increase the length of the pause). A Replaced in the dial string by the fax’s Billing Code 1 value. B Replaced in the dial string by the fax’s Billing Code 2 value. C Replaced in the dial string by the fax’s ToContactNum value (the recipient’s voice number). D Replaced in the dial string by the fax’s ToName value (the recipient’s name). Any undialable characters in this field are discarded. E Replaced in the dial string by the fax’s ToCompany value (the recipient’s company name). Any undialable characters in this field are discarded. F Replaced in the dial string by the user’s domestic long distance Auto Billing Code (see Configuring Automated Billing Codes on page 82). Administrator Guide Chapter 21: Creating dialing rules and Least-Cost Routing plans Character Definition G Replaced in the dial string by the user’s international long distance Auto Billing Code (see Configuring Automated Billing Codes on page 82). I 5-second pause (you can combine several of these characters to increase the length of the pause). P Pulse dialing mode. T Tone dialing mode (default). W Wait up to 15 seconds for a dial tone. { Do not prepend the dialing prefix. } Do not append the dialing postfix. @ Required for SR140 and T.37 FoIP numbers. Appends the IP address of the FoIP router. & Editing dialing rules Example For international calls, a dialing rule 001+wGii (001=Pattern;wGii=Append) specifies that if the first three digits of an outgoing call are the international dialing prefix ( pattern of 001+), RightFax will wait for a dial tone (w), look up the user’s international billing code to dial (G), and wait 10 seconds before dialing it (ii). Example For post-dialing for in-band FoIP calls using an SR140, a dialing rule including @172.17.9.225&5555 appended, specifies that if the gateway’s IP address is @172.17.9.225, the SR140 will post-dial the digits 5555 as soon as one of the following has been received from the gateway: a SIP 183, SIP 200, or H.323 message. The Time and Day tab The settings on the Time and Day tab determine the time periods for each day of the week that the rule is applied. Customize the settings to take advantage of special off peak phone rates or to balance fax loads between servers at the times when your fax traffic is the highest. Indicates that a sequence of DTMF digits will follow. This applies to post-dialing for in-band FoIP calls using an SR140, The post-dial string can include PSTN Telephony characters such as 0-9, #, *, and a comma, but not p, t, w, and !. The digits will be dialed as soon as the SR140 receives a SIP 183 or SIP 200 response code or a H323 message from the gateway. Note To use DTMF post dialing, the post_dialing_ enable parameter must be enabled on the SR140. OpenText RightFax 10.6 Feature Pack 2 190 Administrator Guide To specify multiple time ranges.. Peak Times applies 00-18 to Monday through Friday and removes all weekend settings. Verify that the time ranges for each day are correct. To change the hours that a rule is applied. OpenText RightFax 10. Weekdays applies 00-23 to Monday through Friday and removes all weekend settings. do one of the following: l All Times applies 00-23 from 00:00:00 to 23:59:59 every day.19-23 in each day of the week box.hh-hh. hh is the time in 24-hour format. Example To have a rule apply nights only between 7 P. Weekend applies 00-23 to Saturday and Sunday and removes all weekday settings . delete any entries and leave the box blank. The Destination tab The Destination tab specifies where in your organization faxes matching the dialing rule pattern are routed prior to dialing the destination fax number.M. enter 00-02. enter hh-hh to specify the time range when the rule applies. Do not specify minutes. enter the time ranges separated by comma in the format hh-hh. l To not apply a rule during a given day. Quick Sets Use these buttons to quickly apply common time restriction settings: l l l l Days (listed separately) l For each day. the system divides the time between the current and the next day.M. Never removes all settings. and 2 A. This is the default.Chapter 21: Creating dialing rules and Least-Cost Routing plans Editing dialing rules Note If you enter a range that straddles two days.6 Feature Pack 2 191 Administrator Guide . adding the time range for the next day to any existing time ranges. 37compatible device. The new server then transmits or forwards the fax according to its own rules. Send via Transport Note Entries in the Name boxes are limited to 47 characters. Receive into Fax Server Select this option to route faxes matching the dialing rule pattern to a RightFax Enterprise or RightFax Branch Office server (including the local server) on the network and deliver them as inbound faxes.37-compatible device. To select a transport method in this box. see Configuring the DocTransport modules on page 61. You can use this option to define “intra-office” routing rules that let RightFax users in your organization send faxes to each other across different fax servers on the network. including periods and backslashes. l To specify the email address of the destination T. the transport must have been added in the DocTransport module. enter the destination server name to use for routing. OpenText RightFax 10. If this occurs. rather than a specific RightFax server.Chapter 21: Creating dialing rules and Least-Cost Routing plans Editing dialing rules Note Take care not to create dialing rules on two or more servers that will cause a fax to loop between them. in the Name box. You can select from the following transport methods: Send via Fax Server Select this option to route faxes matching the dialing rule pattern to any RightFax Enterprise or RightFax Branch Office server (including the local server) on your network before transmission. 192 Administrator Guide . After you select this option.6 Feature Pack 2 FOIP. If the fax number does not match a routing code on the receiving RightFax server. RightFax sends the fax after ten loops. click the Number Adjustments tab. The destination fax number is reevaluated against the dialing rules on the new server. the fax is routed to the Default user ID on that server. Select this option to select one of the transport methods that you added and configured in the RightFax DocTransport module as the fax destination. If the domain name is longer. This means that you can enter fully qualified domain names that have 47 or fewer characters. The fax will be transmitted packaged as an email message with a TIFF attachment via your SMTP server to a T. enter the destination server name to use for routing. in the Name box. After you select this option. For more information. use the IP address instead. and then prepend the desired SMS number. strip all of the digits from the destination fax number. Send on Specific Range of Channels Select this option to send the fax only on the channels you specify. The fax will be routed to RightFax Connect. For information about making changes on the Number Adjustments tab. or OpenText RightFax 10. and then prepend the destination email address. l l The Other tab RFCONNECT. No Special Action Select this option to process the fax without delay on any available channel. The channel range specified here overrides any channel restriction placed on a specific fax using the <CHANNEL> embedded code. This parameter is not transferred with the fax if it is routed to another fax server for sending. To specify the destination SMS number. you may need to make changes to the the Number Adjustments tab. Applies Only when Local Channels are Disabled Select this check box to apply the rule only when the fax server detects that all fax channels are disabled. When a fax is sent to an SMS device. see see The Number Adjustments tab on page 188. Depending on your incoming digits. Disallow Sending Select this option to prevent faxes from sending based on attributes such as the number pattern. The fax will be routed to an SMS number. time of day. RightFax Connect requires a ten-digit phone number. click the Number Adjustments tab.Chapter 21: Creating dialing rules and Least-Cost Routing plans Editing dialing rules strip all of the digits from the destination fax number. only the cover page notes are transmitted. SMS.6 Feature Pack 2 193 Administrator Guide . 1. time of day. If the specified time is earlier than the time the fax is received. The user gets the message “Fax blocked from dialing phone number. RightFax weighs each rule OpenText RightFax 10. based on the settings on the Time and Day tab. For information about setting notifications for disallowed faxes. normal priority = 2.6 Feature Pack 2 194 Administrator Guide . Enter 0 to not change the priority. (Optional) Enter a descriptive comment for the dialing rule. or 2 to add or subtract priority points for all faxes that match the dialing rule pattern.” This is sometimes referred to as the Do Not Dial or DnD feature. the fax sends at that time on the next day. l digit match (0–9) = 10 points l + (plus) = 0 points l ? (question mark) = 5 points l ~ (tilde) = 4 points Rule Disabled Select this check box to remove the dialing rule from consideration by the fax server. the fax is not sent until 1 P. When a fax number matches two or more dialing rules. retries faxing at the same time each subsequent day until the fax is either sent or blocked altogether. Delay Fax Comment Select this option to prevent the fax from sending before a specified time of day. Extra Rule Weight Add additional weight to the dialing rule.M. To enable the dialing rule. Note Least-Cost Routing rules are evaluated one time. If transmission is delayed by the Delay Fax setting. on Monday. when dialing rules no longer restrict sending. or sender and then. other settings for the rule are not evaluated. see The DnD Notifications tab on page 195. This setting adds extra weight to the rule so it can be selected over another rule that has a better pattern match. according to how closely it matches the dialed number and uses the rule with the highest weight. Example If a user tries to send a fax at 1 P. high priority >= 3. -1.Chapter 21: Creating dialing rules and Least-Cost Routing plans Editing dialing rules sender. Priority Delta Enter -2.M. clear the check box. Specify the Delay Until time using 24-hour notation (0000–2359). Priority is rated on a three-point scale: low priority <= 1. on Saturday and has weekend time restrictions in effect. Dialing rule pattern characters are weighted as follows: Reschedule After Disallow Sending Select this option to prevent faxes from sending based on attributes such as the number pattern. ]. OpenText RightFax 10.. If this option is not selected. To configure this message. To select user IDs from a list of all user IDs on the local server. Use commas to separate multiple user IDs. For more information. routing faxes to the DocTransport with the most available fax channels.. When someone in New York sends a fax to a co-worker in Seattle at 206-820-5065. Load balancing Outbound faxes are sent to the DocTransport with the most assigned fax channels before processing the dialing rules that determine load balancing.Chapter 21: Creating dialing rules and Least-Cost Routing plans Load balancing The DnD Notifications tab Examples of dialing rules in use Example A company with RightFax servers in New York and Seattle adds the following dialing rules on the New York server: l l 206-???-???? Remove first three digits and send via Seattle server 206-820-50?? Remove first six digits and receive into Seattle server When someone in New York sends a fax to 206-820-7000 (a customer in Seattle) the server routes the fax to the Seattle server which sends it via a local call. see The Other tab on page 193. Load balancing divides your outgoing fax traffic across multiple RightFax DocTransports. see Configuring custom messages on page 36. the sender will get the “Fax number blocked” custom message. Users to Notify Enter the RightFax user IDs to which notifications will be sent. the server considers the fax a received fax and routes it to the appropriate internal fax mailbox (5065). The load balancing feature is only available in RightFax Enterprise servers. click [.6 Feature Pack 2 195 Administrator Guide . Important Include all load balancing dialing rules on all fax servers and remote DocTransport computers so your load balancing rules operate even if one or more DocTransport computers fail. Notify sender that the document was blocked Select this check box if you want the sender to be notified after attempting to send a fax to a number that is blocked by the Disallow Sending (Do Not Dial) feature. expand Dialing Plan. Example A destination table can be created that contains all of the area codes in a major metropolitan area. then and click Destination Table. If none of the servers have outbound fax channels available. or by specifying an external data source. and copying destination tables To use load balancing rules To add or edit destination tables 1. and asterisk [*]. 5. 2. Because the number patterns are the same. enter or edit the name of the destination table. each routing faxes to a different DocTransport computer. such as an SQL database. pound [#].Chapter 21: Creating dialing rules and Least-Cost Routing plans Creating. faxes are directed to the DocTransport that has a channel available the soonest. Note The entries in a destination table must all be the same length and may only include the digits 0–9. Example A destination table can use an SQL database containing all numbers on your do-not-call list. OpenText RightFax 10. When multiple rules match a fax number with equal weight. each rule is assigned the same weight. and copying destination tables You can store and organize groups of numbers such as dialing prefixes and area codes in destination tables. 2. RightFax directs the fax to the DocTransport with the most available fax channels. In the Destination Table Name box. On the Edit menu. You can then create a single dialing rule that addresses all of these area codes. double-click the dialing rule you want to edit. In the left pane. by entering a number range. 3. Open dialing rules in Enterprise Fax Manager. deleting. The Rule Edit window opens. Do one of the following. You can add numbers to a destination table by typing one number at a time. 1. 6. click New to create a table. 4. deleting. In the right pane. Use these tables to create dialing rules to represent a range of numbers instead of creating a separate rule for each number pattern. Create multiple dialing rules with the same number pattern. or Edit to edit an existing table. Equal distribution is not guaranteed.6 Feature Pack 2 196 Administrator Guide . Creating. 6 Feature Pack 2 197 Administrator Guide . The numbers you entered appear in the Entries box. see Importing destination table entries from an external source on page 197. Refer to the documentation for your server’s operating system for information on configuring a new ODBC data source. To specify an external data source. and then click [. any configuration data not supported by the older version will be lost. deleting. and then click … to specify an SQL database. 2. All numbers in the range appear in the Entries list. and on the Edit menu. click the number in the Entries box. Drag the selection to another server. when creating a new destination table. The Configure External Data Source window opens. Specify the column you want to import.]. To copy destination tables from one RightFax server to another 1. To add a range of numbers. set up Do Not Dial rules. under Insert Range. and click Delete Selection.. 7. enter the starting and ending numbers respectively. In the right pane. OpenText RightFax 10.. type one number per line. select the table to delete. Note If you copy destination tables from a new RightFax server version to an older one. For more information. Click Insert Text. After you have set up the ODBC data source for the database containing the numbers to block. In Enterprise Fax Manager. check box. and copying destination tables To add numbers by typing them. Before you can set up a Do Not Dial list. in the Insert Text box. To remove an entry (and allow faxes to be sent to the number). To import destination table entries from an external source To delete a destination table l 1. Importing destination table entries from an external source If your organization maintains a database containing lists of phone numbers not to be dialed.Chapter 21: Creating dialing rules and Least-Cost Routing plans l l l Creating. you can link the destination table to this database and then set up a dialing rule that prevents these numbers from receiving fax transmissions. you must configure the database containing the numbers to block as an ODBC data source. click Delete. Select the table or tables you want to copy. 8. select the Use External Data Source check box. and then click Insert Range. Click OK. in the Start and End boxes. select the Use External Data Source. Enter the Server name. Click OK. The SQL Connection window opens.Chapter 21: Creating dialing rules and Least-Cost Routing plans Testing dialing rules and fax routes in the database. expand the name of the RightFax server. enter any SQL script that you might want to use to limit the range of phone numbers OpenText RightFax 10. select the Authentication type. In the Primary Key Column Name box. you could enter a query for a field called “Block Number” set to true. All numbers from the database appear in the Entries list in the Destination Table Edit window. see Starting Enterprise Fax Manager on page 18. In the left pane. and then click OK. 8. 3. enter the name of the table column specific to the phone numbers. Next to SQL Connection. In the Destination Column Name box. For more information. On the RightFax server.. This would limit the range of blocked phone numbers to only those for whom a separate field in the table called “Block Number” is set to true. Testing dialing rules and fax routes You can test and confirm your dialing rules and fax routing scheme without sending a fax. The testing The Configure External Data Source window opens showing the connection information in the SQL Connection box 4. select the Database you created for the numbers or look it up. In the Table Name box. 2..6 Feature Pack 2 198 Administrator Guide . For example. enter the name of the table that contains the phone numbers. 5. click [. start RightFax Enterprise Fax Manager. enter the name of the primary key column for the table you specified in the Table Name field. 2. To start testing 1. 6. 7. In the Condition box. and then click Dialing Plan. The entries in the box will be automatically updated as you make changes to the database.]. As the fax number passes one or more servers. l To test communications with the selected RightFax server l l The time it takes to route between servers. Click Route Trace. Fax Priority. This does not include the time to transfer image data. and density of the fax. click Reset Downed. enter a fax telephone number. In the Phone Number box. The time for call value shows in how many seconds 2. the greater the server availability. You can also enter a specific User ID. In the right pane. If the dialing rule applies to production faxes. and copying destination tables options appear in the right pane. Group ID. Fax Priority. select the Integration Fax check box. select the SMS Message check box. information packets make a round trip between machines. Production faxing is implemented with the optional Integration module. The server availability index value shows the availability of the server. l The number of hops or jumps from server to server. l To refresh the list of downed servers. and Fax Size to test how each affects the fax routing. Production faxing is OpenText RightFax 10. 3. The higher the value. You can also enter a specific User ID. To verify dialing rule execution 1. the results box shows the following: To view downed servers The Downed Servers list in the right pane shows any rules that are disabled due to downed RightFax servers and the error that caused the rule to be disabled. That additional time depends on the size. and Fax Size to test how each affects the route and execution of the rule. enter a fax telephone number. select the Integration Fax check box. click Ping. deleting.6 Feature Pack 2 199 Administrator Guide . l How the fax number is manipulated along the way.Chapter 21: Creating dialing rules and Least-Cost Routing plans Creating. 2. The following information appears in the Pinging serverservername box: l l Which rules are being used. If the dialing rule applies to production faxes. Group ID. resolution. If the dialing rule applies to SMS messaging. 4. In the Phone Number box. To verify the route of a fax 1. To approve or disapprove a fax blocked by a dialing rule 1. Blocking calls and handling spam To automatically route unwanted faxes to one or more dedicated user accounts You can block unwanted faxes using dialing rules in combination with a destination table and as needed route these faxes to a dedicated user account. On the Other tab of the dialing rule select Disallow Sending.911. 4. Click Test. on the List menu. the results box shows the following: l l 1. Create one or more RightFax user account. Create a Windows registry sub-key ANI that contains the Entries for each blocked number and the user account to which it will be routed. Create a dialing rule that uses that table for the matching string. All non-numeric characters are ignored by DocTransport. Information about the match weights and server availability. click Needing Approval. Disapproved faxes are assigned a status of “Fax was disapproved” in the original sender’s FaxUtil mailbox. such as SpamAccount..Chapter 21: Creating dialing rules and Least-Cost Routing plans Blocking calls and handling spam implemented with the optional Integration module. Approved faxes are immediately scheduled to send. matches 911. To add or change blocked numbers 3. disapprove or delete them. As the fax is routed. 3. 1. Create a destination table for the numbers you want to block. Right-click the fax. 3. You can add a note (up to 450 characters) to be stored in the fax history together with the date and your user ID Note You can also use the Windows registry keys BlockedNumbers and BlockingFlags to prevent faxes from being sent to specific numbers or to turn off the 911 blocking feature. DocTransport ignores the two preceding commas. Each dialing rule against which the fax number is compared. and then blocks the number. The DocTransport module by default blocks all outgoing calls to numbers beginning with 911 (the standard emergency number throughout the United States). click Administrative Mode Example If a user sends a fax to . On the shortcut menu. point to Status. 2. 2. OpenText RightFax 10. Save the rule. Sign on to FaxUtil as an administrator and on the List menu. and then click Approve Fax or Disapprove Fax. to which to route unwanted faxes and assign each user account a routing code Full RightFax administrators can approve faxes that were blocked by dialing rules. To view only faxes needing approval. 2. See Entries (in ANI Key) on page 348.6 Feature Pack 2 200 Administrator Guide . New York just added a prefix for the Tri-State area of 520 (requiring a 1 to be dialed first from the PDQ office.6 Feature Pack 2 201 Administrator Guide . Strip 3 digits from beginning. Prepend 1. Least-Cost Routing examples This section describes several Least-Cost Routing examples. PDQ could add rules to TSNSERVER that prepend all numbers that have a certain prefix. with 1 and as needed strip the 520 area code before prepending the 1: These two rules intercept 520 calls that would otherwise match the 520+ rule in Scenario #2.Chapter 21: Creating dialing rules and Least-Cost Routing plans Least-Cost Routing examples 520-%[SOUTHAZ. Because the PDQ New York long distance carrier does not require it. Prepend 1. The PDQ system administrator for NYSERVER has also noticed that recent transfers from the Tucson site out of habit still dial a 1 at the beginning of ten digit long distance numbers.3]+ Send via local fax server. Strip 3 digits from beginning. To avoid having to create individual rules for each prefix. It adds this rule to NYSERVER: 520+ Send via fax server TSNSERVER. To correct this situation. Prepend 1. Scenario 2: Using dialing destination tables 520? Send via local fax server. And it creates the following two rules on TSNSERVER referencing the SOUTHAZ destination table: 1-???-???-???? Send via local fax server. Prepend 1. Scenario 4: Stripping unnecessary digits 520-458+ Send via local fax server. The PDQ system administrator for NYSERVER notices that faxes bound for internal four-digit PBX numbers in New York that begin with 520 are being inadvertently routed to Tucson. Strip 1 beginning digit. Scenario 3: Distinguishing ‘+’ wildcard rules from other local numbers Scenario 1: Using LCR (a simple example) PDQ Company has a RightFax server in New York City (NYSERVER) and one in Tucson (TSNSERVER). PDQ Company wants to make sure that TSNSERVER will correctly dial Southern Arizona numbers outside of Tucson by prepending a 1. %[SOUTHAZ. PDQ creates a destination table named SOUTHAZ that includes all necessary prefixes. the administrator adds these two rules to NYSERVER: PDQ determines that it would be cheaper to send New York faxes bound for Tucson and Southern Arizona numbers via TSNSERVER. OpenText RightFax 10.) Those calls too are going to Tucson. These rules would match the local destination numbers more specifically and therefore be weighted more heavily. 458+ Send via local fax server. Prepend 1.3]+ Send via local fax server. 520-???? Send via local fax server. the administrator adds a rule to NYSERVER to strip the 1 from these numbers: But PDQ determines that area code 520 includes several prefixes for which similar rules would need to be created. In addition. such as 458. Scenario 7: International routing PDQ Company expands into the international market. LASERVER would have a matching set of rules referencing NYACODE and NYPREFIX and routing to NYSERVER. 1%[LAPREFIX. Priority Delta +1.Y.. This means PDQ can save money by routing all LA faxes to the LASERVER and all NY faxes to the NYSERVER. LAACODE and NYACODE each contain a list of area codes that match the low-rate phone numbers in their respective regional areas. Send via fax server LASERVER. Their first overseas site is London which has a RightFax server installed (UKSERVER).6]+ Time of day set to peak times.3]+ Time of day set to peak times. PDQ Company opens a sales office in Los Angeles with a new RightFax server (LASERVER).CFO and to Group: TOPDOGS.A. a copy of each of the four destination tables and each of the dialing rules would be entered on TSNSERVER. + Restricted only to Users: SALESMGR. 011-44+ Send via fax server UKSERVER. Strip 3 digits.Y. A similar deal was worked out for the New York metro area. have worked out a special low rate for all calls in the local Los Angeles/Orange County area. via direct long distance dialing. Rules would need to be placed on UKSERVER to normalize the phone numbers for England (such as stripping area codes or adding digits if necessary). Scenario 6: Boosting priority On NYSERVER an LA area code table (LAACODE) and an LA area code+destination table (LAPREFIX). and N. Because of charges related to the TCP/IP connection between L. PDQ adds this rule on NYSERVER and a similar rule on LASERVER: PDQ would first set up the following destination tables: PDQ Company is expanding and the load on the RightFax servers is increasing. To enable Least-Cost Routing for TSNSERVER to NY and LA. Send via fax server LASERVER. This rule is added to LASERVER: l l 212+ Send via local fax server. All faxes from LA. it is still cheaper to send faxes during off-peak periods to L.A. and N. LAPREFIX and NYPREFIX match numbers with low rates in area codes where only certain prefixes in area code are included in the special low rate.Chapter 21: Creating dialing rules and Least-Cost Routing plans Least-Cost Routing examples Scenario 5: Using LCR (an advanced example) evening and at night via long distance. and Tucson bound for England need to be routed to UKSERVER. PDQ decides to boost the priority of faxes from certain high priority Groups and Users on LASERVER to verify that their faxes are sent quickly. PDQ and the local phone companies in L. This rule is added to each of these servers: PDQ would define the following two rules on NYSERVER: %[LAACODE.A. NY. Peak times are specified because it is still cheaper to send in the OpenText RightFax 10.6 Feature Pack 2 202 Administrator Guide . A local rule stripping off the unnecessary area code is required on both the NYSERVER and LASERVER. On LASERVER a NY area code table (NYACODE) and a NY area code+destination table (NYPREFIX). PDQ finds that the users of NYSERVER are sending many more faxes than the users on NYSERVER2. Because each rule is weighted the same. servers fail for any reason. This leads to a guaranteed path of Least-Cost Routing should one or the other of the New York servers fail for any reason. This leads to a guaranteed path of Least-Cost Routing if one or the other of the N. Scenario 9: Backup servers PDQ Company’s system administrator for LASERVER hears about the new NYSERVER2 in New York and decides to make use of the additional server by replicating all the dialing rules on LASERVER for NYSERVER but this time referring them to NYSERVER2. Upon analysis.Y. OpenText RightFax 10. + Send via fax server NYSERVER2 (or NYSERVER).6 Feature Pack 2 203 Administrator Guide . faxes on NYSERVER are taking on average several minutes longer to be sent than those on NYSERVER2. new outgoing faxes on each server are routed to the one with the least load: + Send via local fax server.Usage data indicates that during peak times. RightFax load balances between the two servers. Upon hearing about the new NYSERVER2 in New York. By entering these two rules on each server. PDQ Company’s system administrator for LASERVER replicates all the dialing rules on LASERVER for NYSERVER but this time referring them to NYSERVER2.Chapter 21: Creating dialing rules and Least-Cost Routing plans Least-Cost Routing examples Scenario 8: Load balancing PDQ adds another RightFax server to its expanding NY site (NYSERVER2). import the files into RightFax. When creating an HTML cover sheet template. They can include any text and graphics that are supported by these file types. You can create HTML and HTM cover sheet templates using an HTML editor or a text editor. Administrator Guide . such as a cover sheet for each department or separate cover sheets for different types of fax documents. Any cover sheet information appearing on subsequent pages will be ignored. See Creating an HTML cover sheet template on page 204. The fax cover sheet templates determine the information included on the cover sheet for each outgoing fax. OpenText RightFax 10. Earlier versions of RightFax FaxUtil and Enterprise Fax Manager only display cover sheets that have the standard 8. address. See Creating a PCL cover sheet template on page 205. l l l Microsoft Word. Use cover sheet codes to specify information such as sender and destination data.6 Feature Pack 2 l 204 Use absolute paths to reference other files.6 server. They usually include information about your organization—such as logo. PCL. After you create the cover sheets you need.Chapter 22: Creating fax cover sheet templates Creating an HTML cover sheet template Chapter 22: Creating fax cover sheet templates The RightFax server includes a folder with cover sheet template files that you can modify or use as examples when creating your own templates.html. follow these guidelines: You can create the following types of cover sheets: l l HTML. and phone number—and codes that represent specific sender and destination information. Creating an HTML cover sheet template The information on a RightFax cover sheet must fit on one page. cover sheets can have long file names. such as graphics. For instructions. You can create multiple cover sheet files. Cover sheets with longer names do not appear.3 file name length. See Managing cover sheet template files on page 209.htm or . See Creating a Microsoft Word (. Save the file with a file name extension of . The template files are located in: RightFax\FCS\Imported. see Cover sheet codes on page 206. see Inserting cover sheet codes on page 205 for a list of valid codes.doc) cover sheet template on page 205. Note On a RightFax 10. select a printer driver that supports PCL 5 or later and select the “Print to file” option in your application’s Print dialog box. see Inserting cover sheet codes on page 205 for a list of valid codes. see Cover sheet codes on page 206. l When creating a Word cover sheet template.doc) cover sheet template source file (such as a . Save the file with the file name extension . see Cover sheet codes on page 206. For a list of codes.pcl.pcl.doc). Creating a Microsoft Word (. See Character Set Mode on page 35 for more information. Using Microsoft Word. See Configuring Office application conversion on page 89 and Configuring server-side application conversion on page 87. Store both the source file and the PCL output on the RightFax server This is recommended because the PCL file cannot be edited. verify that ANSI mode is enabled on the code page of the server. type {coversheetcode}. including Hebrew. For instructions.txt file) and then output this file to PCL. such as French accents. To save your source as a PCL file. follow these guidelines: l Note Native Word cover sheets can take slightly longer to convert to fax format than PCL files. follow these guidelines: l l l l Cover sheets stored in the native Word format support all language character sets supported by Word and Windows. you can create and use cover sheets in the native Word document format (. To show special characters. Save the cover sheet file with the file name extension . Use cover sheet codes to specify information such as sender and destination data. see Cover sheet codes on page 206. see Inserting cover sheet codes on page 205 for a list of valid codes.Chapter 22: Creating fax cover sheet templates Creating a Microsoft Word (. When creating a PCL 5 compatible cover sheet template. To insert a code in an htm and html cover sheet template l Creating a PCL cover sheet template In the desired location of the html cover sheet.6 Feature Pack 2 205 Administrator Guide . Inserting cover sheet codes Use cover sheet codes to specify information such as sender and destination data.doc) cover sheet template If Microsoft Word is installed and configured on your RightFax server for server-side application conversion. open the FCS.doc (not docx). You can edit these source files. Word cover sheet codes can also use any TrueType font.doc file in the RightFax\FCS\PCL_Source folder. it replaces the cover sheet codes in the template with the data they represent. and then print the cover sheet to a file in the RightFax\FCS folder with the file name extension . For instructions. First create a OpenText RightFax 10. This is exaggerated if the server running Word has insufficient RAM. Use an application that can print to PCL5 to create a PCL (Printer Control Language) template file. RightFax is shipped with sample cover sheet files and the source documents they were created from.doc or . When the RightFax server generates a cover sheet for an outgoing fax. make any desired changes. Not all cover sheet codes are supported in all formats. Apply a TrueType or native printer font to {DOCVARIABLE “coversheetcode”\*MERGEFORMAT} Cover sheet codes Example For the recipient’s company name. only text formatted with native printer fonts is stored in text format. Maximum Description characters BILLINFO1 + 15 Billing code 1 (if any). double-byte characters inserted into DocVariable fields do not.Chapter 22: Creating fax cover sheet templates Creating a PCL cover sheet template Example For the recipient’s company name. in the source file. you would type {FROMPHONENUM}. Note If you place a cover sheet code in a Word text box. 4. The inserted variable becomes visible. 3. To insert a code in a PCL cover sheet template l In the desired location of the PCL cover sheet. While double-byte characters added to the text of a Microsoft Word cover sheet convert correctly. Click OK. Example For the recipient’s company name. To insert a code in a Microsoft Word cover sheet template 1. Refer to the following table for a list of available cover sheet codes. you would insert DOCVARIABLE ”FROMPHONENUM”. All other font types are converted to graphic images. and then click Toggle Field Codes. right-click in the location of the inserted DocVariable. In the Field codes box. insert the Document Automation field DocVariable. and then click Field Codes. Any cover sheet code not formatted in a native font will appear on the cover sheet instead of being replaced by its associated data. To view the added code. Note Do not use double-byte characters into the DocVariable field. CALL_BACK 31 The callback information (if any). type <coversheetcode> and apply a native printer font to both the angle brackets and the code. BILLINFO2 + 15 Billing code 2 (if any).6 Feature Pack 2 Cover sheet code 206 Note Not for Microsoft Word cover sheets. CALLBACK2 2. make sure the box is large enough to fit all of the text that replaces the codes. Administrator Guide . Note The remaining text can use any font. In the desired location of the Word cover sheet. OpenText RightFax 10. you would type and apply a native printer font to <FROMPHONENUM>. When the cover sheet template is printed to PCL format. type “coversheetcode” so that the text in the box appears as DOCVARIABLE “coversheetcode”. Include one {CCTEXT} code on each line that contains recipients.FaxNum. The sender’s email address from the RightFax user properties (See Creating a user profile on page 108). Note Not for HTML or PCL cover sheets. All the listed recipients of a fax (including CC and BCC recipients) in this format: Name. FROMCOMPANY 59 The sender’s company name. CUSTOM1 Variable Note Not for Microsoft Word cover sheets. available for all three types of cover sheets.Chapter 22: Creating fax cover sheet templates Creating a PCL cover sheet template Cover sheet code Maximum Description characters Cover sheet code Maximum Description characters CCTEXT 69 EMAILADDRESS Variable The sender’s email address from the RightFax user properties.Name. Note Not for Microsoft Word cover sheets. The date format is determined by the default date format on the RightFax server. FAXSENDDATE Variable The date that the fax was sent.) FAXDATE Variable The date that the fax is created. FROM_NAME 59 The sender’s name.. FROM_ PHONENUM 31 The sender’s phone number.. The sender’s phone number. FAXDIDNUM 31 The sender’s fax number.Faxnum. The cover sheet only lists the number of recipients for which space is provided. (See Creating a user profile on page 108. OpenText RightFax 10.6 Feature Pack 2 207 Administrator Guide . Note Not for Microsoft Word cover sheets. each code representing one line of recipients up to 69 characters long. You can include up to 21 {CCTEXT} codes on a cover sheet. FROMPHONENUM 31 Note Not for Microsoft Word cover sheets. EMAIL_ADDRESS Variable Note Not for Microsoft Word cover sheets. FROMCITYSTATE 59 The sender’s city and state.. DATEONLY Variable The date that the fax cover sheet was generated. FROMNAME 59 The sender’s name. Note Not for HTML or PCL cover sheets. the remaining lines will be filled with blanks. Note Not for HTML or PCL cover sheets. NOTETEXT The notes added to the fax when it was addressed. TO_CITYSTATE The recipient’s city and state.6 Feature Pack 2 59 TOCONTACTNUM 208 31 The recipient’s phone number. (See The Inbound Routing tab on page 112). To include the cover sheet in the page count. Note Not for Microsoft Word cover sheets. TOCITYSTATE 59 The recipient’s city and state. The number of pages in the fax body. The cover sheet only includes as much note text as there is space allotted for.Chapter 22: Creating fax cover sheet templates Creating a PCL cover sheet template Cover sheet code Maximum Description characters Cover sheet code Maximum Description characters FROMPHONE 31 OPERATORNUM 31 The general phone number for the sender’s organization. OpenText RightFax 10. Include one <NOTETEXT> code on each line that you want notes to be listed on. TO_COMPANY 59 The recipient’s organization name. You can include up to 21 <NOTETEXT> codes on a cover sheet. GENERALFAXNUM 31 The general fax number for the sender’s organization. NUMPAGES NUMPAGESC 69 Variable Variable Note Not for Microsoft Word cover sheets. TOCOMPANY 59 TO_CONTACTNUM 31 The recipient’s organization name. Note Not for Microsoft Word cover sheets. The recipient’s phone number. use the <NUMPAGES> code. The time format is determined by the default time format on the RightFax server. Administrator Guide . use the <NUMPAGESC> code. each code representing one line of notes up to 69 characters long. Note Not for Microsoft Word cover sheets. The sender’s phone number. ROUTEINFO Variable The routing information entered in the user profile of the user creating the fax. To exclude the cover sheet in the page count. not including the cover sheet. If the notes for a fax are shorter than the space provided by <NOTETEXT> codes. TIMEONLY Variable The time that the fax cover sheet was generated. The number of pages in the fax including the cover sheet. In the list of cover sheets. TO_NAME 59 The recipient’s name. The default cover sheet is indicated by a green check mark. TONAME 59 The recipient’s name. edit information about existing files. right-click an existing file. You can import additional cover sheet files. Note Not for Microsoft Word cover sheets. Note Not for HTML or PCL cover sheets. especially if you are using the RightFax Delay Send feature. and then click New. start Enterprise Fax Manager. and delete files no longer needed. The list of currently available cover sheets appears in the right pane. USERID 59 The RightFax User ID. 2. UNIQUEID 16 The unique ID assigned to the outgoing fax. In the left pane. The time the fax was processed by the fax server can be very different from the time it is actually sent as recorded on the TTI line. To open the list of cover sheets Note Not for HTML or PCL cover sheets. On the RightFax server.6 Feature Pack 2 209 Administrator Guide . especially if you are using the RightFax Delay Send feature. The RightFax User Name. Enter the following information: Note Not for HTML or Microsoft Word cover sheets. and then click Cover Sheets. expand the name of the RightFax server. see Starting Enterprise Fax Manager on page 18. 2. TOFAXNUM 31 The recipient’s fax number. To add a cover sheet to the list 1. USERNAME 59 1. The date and time the document was generated by the fax server. Note Not for Microsoft Word cover sheets. WHEN_FAXED Variable The date and time the document was generated by the fax server.Chapter 22: Creating fax cover sheet templates Managing cover sheet template files Cover sheet code Maximum Description characters Cover sheet code Maximum Description characters TO_FAXNUM 31 WHENFAXED Variable The recipient’s fax number. For more information. The time the fax was processed by the fax server can differ largely from the time it is actually sent as recorded on the TTI line. Managing cover sheet template files The list of cover sheets includes all cover sheet templates currently available in RightFax. OpenText RightFax 10. The text string that appears in the cover sheet list. 3. users with the appropriate permission can select which cover sheet to use for any fax they send. You can change any of the following information: l l l Select the cover sheets you want to copy. and drag the selection to another server. ID. description or file name 1. right-click the selection. click Import and browse to the location of the new file. click View. seeRightFax embedded codes on page 310. In the left pane. The text string that will appear in the cover sheet list. To delete a cover sheet from the list l Select the cover sheet or sheets. and then click Open. The text string that appears when a user is selecting a cover sheet. click Delete. and then confirm the deletion. Description. Click OK. Select the file.6 Feature Pack 2 210 Administrator Guide . start Enterprise Fax Manager. Description. Select the file and click Open. files. To copy one or more cover sheets from one RightFax server to another l 3. and then click Edit. Users can also include the <FCSFILE> code in documents to specify a cover sheet file for that document. 3. You cannot preview PCL 2. Word files open in Microsoft Word in read-only mode and html files in your browser. 2. To set the user permission change cover sheets 1. The name of the file that has been copied to the SQL database. If your organization has several fax cover sheets for different types of faxes. On the RightFax server. expand the name of the RightFax server. The cover sheet is copied to RightFax and appears in the list of cover sheets. any configuration data not supported by the older version will be lost. 4. Click Import and browse to the location of the new file. Right-click the cover sheet. double-click the OpenText RightFax 10. Granting user permission to select a cover sheet To edit a cover sheet ID. To preview the displayed Word or html file. For more information. Click OK. For more information. Copying cover sheets from one server to another File Name. Note If you copy cover sheets from a new RightFax server version to an older one. To choose a new file for the ID. The name of the file that will be copied to the SQL database. and then click Users. File Name.Chapter 22: Creating fax cover sheet templates l l l Granting user permission to select a cover sheet ID. see Starting Enterprise Fax Manager on page 18. In the list of users in the right pane. The text string that will appear when a user is selecting a cover sheet. 3. 1. 4.6 Feature Pack 2 As the administrator. see Starting Enterprise Fax Manager on page 18. 3. and then click Cover Sheets. 2. In the Default Cover Sheet list. For more information. and then click OK. On the Permissions tab. start Enterprise Fax Manager. and in the Cover Sheet Model box. and then click Groups. user ID. On the RightFax server. On the RightFax server. and then click Set as System Default. On the RightFax server. In the left pane. The indicated file will be used if the user does not select a cover sheet and does not have a default user cover sheet. For example. start Enterprise Fax Manager. In the left pane. expand the name of the RightFax server. you can specify the cover sheet information that users must enter when sending a fax or after they have received a fax. To assign a default cover sheet to a group of RightFax users Setting default cover sheets 1. To change the system cover sheet 1. select the Can Change Cover Sheets check box. A default cover sheet for the entire system. see Starting Enterprise Fax Manager on page 18. Right-click the cover sheet to set as the new system default. A default cover sheet for a group of users. To assign a default cover sheet to a RightFax user 2. you can require that 211 Administrator Guide . The indicated file will be used if the user does not select a cover sheet when sending a fax. The indicated file will be used when the user does not select a cover sheet and has neither a default user or group cover sheet defined. For more information. click Select. OpenText RightFax 10. start Enterprise Fax Manager. 5. and then click Default Outbound Settings. select the cover sheet file. Setting required cover sheet information 3. select a cover sheet. Double-click the group ID. The cover sheet template selected as the system default appears with a green check mark in the list of cover sheets. You can define the following defaults settings: l l l 2. When a user sends a fax. A default cover sheet for each user. expand the name of the RightFax server. expand the name of the RightFax server. under Cover Sheets. and then click Users. see Starting Enterprise Fax Manager on page 18. The list of the existing cover sheets appears in the right pane. 4. Under Cover Sheet Defaults. On the Basic Information tab. click Send Cover Sheets.Chapter 22: Creating fax cover sheet templates Setting default cover sheets 4. RightFax creates the cover sheet using a default template. For more information. In the left pane. Double-click the user ID. If a user tries to send a fax without filling in all required fields. see Starting Enterprise Fax Manager on page 18. To require cover sheet information 1. select the check boxes next to those fields you want to be mandatory to send a fax. 4. On the Utility menu. select the check boxes next to the fields you want to be mandatory for received faxes. click Customize Cover Sheet Fields. On the Receive Required Fields tab. If a fax arrives that does not include all required fields.Chapter 22: Creating fax cover sheet templates Setting default cover sheets the fax recipient include billing codes or other fields for billing records. OpenText RightFax 10. On the RightFax server. On the Sending Required Fields tab. the fax remains in the user’s FaxUtil mailbox with the status Info Not Complete. 3. start Enterprise Fax Manager.6 Feature Pack 2 212 Administrator Guide . the recipient will not be able to delete the fax until the required fields have been completed. For more information. The To Fax Number option is always required. 2. On a RightFax Enterprise server or higher. Users choose whether to convert individual faxes or automatically convert all received faxes to text. To configure OCR routing The first occurrence of a bar code on a received fax into its equivalent text or number string. OpenText RightFax 10. In the WorkServer Configuration window. Code 93. edited. 1. You can enable OCR processing on as many WorkServers as you want. double-click RightFax WorkServer. See Using OCR to route received faxes on page 216. EAN-8. See Creating and managing OCR text files on page 218 Use the Optical Character Recognition (OCR) service to convert: l l Images of text in received faxes into standard text files. 1. 3. UPC-A.Chapter 23: Using Optical Character Recognition Enabling OCR processing on the WorkServers Chapter 23: Using Optical Character Recognition 4. OCR routing requires that OCR processing is enabled. Configure the Conversion Engine for OCR. To configure OCR conversions To enable OCR processing. or used to route faxes to their intended recipients. and UPC-E are supported symbologies. See Enabling OCR processing on the WorkServers on page 213. In Windows Control Panel of the RightFax server. Code 128. Enabling OCR processing on the WorkServers The resulting text can be viewed. set up a central mailbox and create a routing table. Note Codabar. To enable OCR processing 2. in the component tree in the left pane. Give OCR permission to each user who is authorized to use the feature and enable OCR and the output file defaults for each user.6 Feature Pack 2 2. select the WorkServer 213 Administrator Guide . See Configuring the Conversion Engine for OCR on page 214. Code 39 (3of9). Enable OCR on the WorkServers. See Configuring RightFax users for OCR conversion on page 214. I2of5. EAN-13. the OCR service must be enabled on at least one WorkServer. as well as some country and region codes that incorporate multiple languages with similar character sets (such as Western_Europe). In the Services list. Local testing ultimately determines the optimal setting for your environment. and then click OK. and double-click the user name to open the User Edit dialog box. The Conversion Engine Configuration dialog box opens. Documents that fail conversion are marked as Problem Converting Fax Body or Coversheet. The maximum number of conversion attempts per document is controlled by the Maximum number of retries setting.The list of services appears at the lowerright pane of the window. This list contains all supported languages. l Configuring the Conversion Engine for OCR Maximum Conversion Time. and then RightFax Enterprise Fax Manager. then Open Text. Select an option from the list. Configuring RightFax users for OCR conversion To configure RecoStar 1. In the Service Name list. Maximum number of retries. double-click RightFax OpenText RightFax 10. Give OCR permission to all RightFax users that must be able to receive OCR versions of fax images. RightFax uses RecoStar to perform OCR conversion. on the Start menu. 4. On the RightFax server. limit the number of users with this permission. click OCR. 2. click the name of the RightFax server to configure in the tree in the left pane. and then click OK: l l 3. Conversion Engine.Chapter 23: Using Optical Character Recognition Configuring the Conversion Engine for OCR that you want to perform OCR processing. Run Enterprise Fax Manager. click All Programs. complete the following fields. 3.6 Feature Pack 2 214 Administrator Guide . The default value of 1 minute is usually adequate for all but the largest documents. Adjust this setting based on the size of the largest document (page and word count) sent for this conversion. Country. As OCR conversions are processor-intensive. In the Enterprise Fax Manager application. To give a RightFax user OCR permission 1. Click the RecoStar tab. RTF. 5. Click the Default Receive Settings tab. select the text format used to interpret your fax pages: 4. TXT.6 Feature Pack 2 215 Administrator Guide . Click the Permissions tab and select Can OCR Faxes. or DOC. 3. type a default threeletter file extension for the output file. Click OK. select the Enabled? check box to automatically convert all received faxes using OCR. Valid options are l l ASCII produces a plain text file. OpenText RightFax 10. Under Automatic OCR Options. RTF (rich text format) preserves fonts and formatting but is only available to Windows users. In the Extension box. In the Format list.Chapter 23: Using Optical Character Recognition Configuring the Conversion Engine for OCR 2. 6. and UPC-E bar codes are converted. Do not set the routing type of individual RightFax user mailboxes to OCR. For more information. you can use a separate routing table for each mailbox. the faxes must arrive in one or more central mailboxes. the fax cover sheet text is checked against a routing table that contains the RightFax user IDs and other identifying text. Code 128. see Routing inbound faxes on page 220. Code 93. On the Identification tab. EAN-8. To use OCR routing 1. set the Routing Code to a unique code and the Routing Type to OCR. Using OCR to route received faxes RightFax recommends that you use OCR routing as a secondary routing method only. Otherwise each user’s mailbox will attempt to reroute all received faxes. EAN-13. set the User ID to OCR and the Group ID to Everyone. Do not use a cover page if the bar code to be used for routing is contained in an attachment. route faxes using other. When a fax arrives in a central mailbox configured for OCR routing. Especially in large organizations. To create a central mailbox for OCR routing 1. Configure a central mailbox to receive the faxes to be routed and configure it for OCR routing. I2of5. UPC-A. more reliable methods. Create a custom routing table containing RightFax user IDs and their associated text. b. If a match is found between the identifying text and the fax cover sheet text. Important Only the central mailbox should have its Routing Type set to OCR. potentially creating endless routing loops. Creating and configuring the OCR central mailbox To use OCR to route faxes to their intended recipients.6 Feature Pack 2 l 216 On the Basic Information tab. set the Administrator to OCR. and then click OK. the fax is routed. create a new user with the following properties: Note the following about bar codes contained in received faxes: l l l a. the fax remains in the central mailbox. If no match is found. 2. On the Inbound Routing tab. This mailbox is configured to reroute all incoming faxes using OCR routing. and then click OK.Chapter 23: Using Optical Character Recognition Using OCR to route received faxes 3. See Creating the OCR routing table on page 217 OpenText RightFax 10. Edit the properties of the Everyone group as follows: 2. Administrator Guide . See Creating alternate routing tables on page 218. See Creating and configuring the OCR central mailbox on page 216. Code 39 (3of9). In Enterprise Fax Manager. If you have set up multiple central mailboxes for OCR routing. Use OCR routing only for faxes whose intended recipients could not be determined by these methods. Only the first encountered bar code is converted to its equivalent text string and used to determine a match. Only Codabar. The folder includes a sample Route. a fax simply addressed to “Marketing” or “VP Marketing” would not be routed. routing the fax to the first match it finds. On the RightFax server. even if there are other Janes later in the routing table. JDoe Jane Doe JDoe Director of Marketing JDoe 555-1212 To create the OCR routing table JSmith John Smith 1. in the RightFax\WorkSrv folder. Example Using the following routing table. The order in which you list user IDs in the table is very important." but not “John. Similarly. JDoe Jane JDoe Doe If you want routing by text to take precedence over routing by bar code. JSmith 555-1000 Example Using the following routing table. matches for numbers would be routed first. If the cover sheet includes "Smith. keep in mind that RightFax scans the routing table from top to bottom. l l l Remove any blank spaces at the end of an entry to ensure that trailing spaces are not used for matching. the fax is routed to the RightFax user ID associated with the matching text. and then titles or departments. JDoe 5205551212 Note the following: JSmith 520555100 TLogan 520555198 JDoe Jane Doe OpenText RightFax 10.” the fax is not routed. This means: l UserID and MatchingText must be separated by a single space.6 Feature Pack 2 217 Administrator Guide . then names.Chapter 23: Using Optical Character Recognition Using OCR to route received faxes l Creating the OCR routing table The OCR routing table is a text file that determines to which user to route a fax based on matching text or bar codes found on the fax cover sheet. enter the routing information in the format UserID MatchingText. even if it is addressed to Jane Smith. Only the exact title “Director of Marketing” would cause the fax to be routed to user JDoe. When creating the OCR routing table. place bar codes at the top of the routing table strings. create a text file named Route. place bar codes at the bottom of the routing table. l If the text in the fax cover sheet is an exact match for an entry in the routing table. If you want routing by bar code to take precedence over routing by text.txt file for reference. 2. The matching text must be an exact match of the text from the cover sheet. Using one line per RightFax user.txt. any fax received with the word “Jane” is routed to JDoe. Place your highest priority user IDs at the top of the list so they are sure to receive their faxes even if matching text conflicts with other users in your organization. The new routing table file must be located in the same RightFax\WorkSrv folder and use the same format as the Route. enter the following line in the Routing Info box of the Sales central mailbox: To convert all received faxes 1. 1. users can either convert individual faxes to OCR text or they can configure RightFax to automatically convert all received faxes to text. on the Tools menu.TXT. Click the OCR icon or right-click and choose OCR from the menu.Chapter 23: Using Optical Character Recognition Creating and managing OCR text files JSmith John Smith Creating and managing OCR text files TLogan Ted Logan After the workserver has been configured and permissions granted.JDoe OpenText RightFax 10. select the Automatically OCR SALES. each user can set the OCR Options defaults. JDoe Director of Marketing JSmith Sales TLogan Development Creating alternate routing tables Converting individual faxes to OCR text files If you have set up multiple central mailboxes for OCR routing. you can specify a routing table called Sales. Configuring automated OCR conversion 3. On the Inbound Routing tab. You can also specify a RightFax user ID to which unmatched faxes automatically route for each central mailbox: In the Routing Info box. you can use a separate routing table for each mailbox. type a comma followed by a RightFax user ID. 2. 2.txt. After a fax has been converted to text. in the Routing Info box. Run Enterprise Fax manager and edit the user ID for the mailbox.txt OCR routing file. To configure RightFax to automatically convert all received faxes to text with OCR. To convert each fax 1. After the automated conversion has been enabled. To do this. On the Receiving tab. enter the file name for the routing table. an icon appears in the OCR column for the fax and the text file is stored as a fax attachment. After the OCR processing is complete. Example If you have set up an OCR central mailbox for the Sales department.6 Feature Pack 2 218 Administrator Guide . RightFax stores the text file along with the original fax image. after the file name. Users can override any of these settings for each individual fax. To specify a file name for the routing table other than Route. Click the fax to select it. To convert a fax image to text. In FaxUtil. click Options.txt and have all unmatched faxes automatically route to Jane Doe (RightFax user ID JDoe). 2. you see a list of received faxes with either FaxUtil or RightFax Web Access. the OCR module must be enabled and the current user must have OCR permission. and then click Set OCR Options. OpenText RightFax 10.6 Feature Pack 2 219 Administrator Guide . select TXT. 3. or RTF. 4.Chapter 23: Using Optical Character Recognition Using OCR to route received faxes Received Faxes check box. In the Output Type list. select RFT or ASCII. In the Format list. DOC. phone company forwards any or all of these dialed numbers to your system along with the call. or CSID routing) is determined primarily by the type of telephone service you use. DID lines support inbound phone service only. Assign routing codes to users in accordance with the number of DID/DNIS digits for which your services are configured. Configuring DID/DNIS routing 2. ANI. Often these numbers are sequential and all contain the same prefix. Example If you have a set of DID/DNIS numbers of 555-1001 through 555-1020. Configure the RightFax server and fax board(s) for DID/DNIS routing by running the RightFax DocTransport configuration program.Chapter 24: Routing inbound faxes Configuring DID/DNIS routing Chapter 24: Routing inbound faxes The RightFax server provides several methods for routing received faxes to their intended recipients in your organization. Your OpenText RightFax 10. To configure the DID/DNIS settings 1. DTMF. The routing method (DID/DNIS. a single DID/DNIS line may have 20 numbers associated with it ranging from 555-1001 to 555-1020. or attached to an email message. For example. each user must be assigned a unique routing code. Each fax board must be configured for DID/DNIS routing separately. See Brooktrout Fax Board configuration on page 63 for more detail. channel.6 Feature Pack 2 220 Administrator Guide . RightFax attempts to determine the intended recipient based on information associated with the received fax and then routes the fax to that recipient. you would assign the routing codes 1001 through 1020 to your users. RightFax uses these included numbers to route faxes to the proper recipients. To route faxes to users. such as whether the fax is sent to the user’s FaxUtil mailbox. the fax is placed in the corresponding user’s fax mailbox. The user’s account settings determine the delivery method of the fax. When a fax is received. While DNIS supports bidirectional faxing. Each RightFax user is assigned a personal fax mailbox that is assigned a DID/DNIS number (routing code). DID ( Direct Inward Dial) and DNIS (Dialed Number Identification Service) are considered the most accurate methods for routing faxes. When a call comes in with a valid DID/DNIS number. and your phone service is configured to forward the last four digits of the dialed number. a network directory. If you have three digit A DID/DNIS interface assigns multiple telephone numbers to a single pair of wires (a telephone trunk). service. or each fax can be routed to the intended recipient. In Enterprise Fax Manager. set the Channel Extension to a number between 1 and 99. You can also set two or more channels to the same Routing Extension if you want a single mailbox to receive faxes from multiple channels. The person sending the fax dials this number and the call connects normally. Note This number must have the exact number of digits that you specified in the Number of Digits for Routing box when configuring the fax boards. the fax board prompts the caller with a tone or voice prompt to enter a routing code for the fax they are sending. For more information. all faxes to that number are delivered to a single fax mailbox. the fax is placed in the mailbox that corresponds to the Channel Extension setting for the channel it arrived on (or to the administrator of the Everyone group if no channel extension match is found). For example. the faxes can be directed to a printer located in the department. If the caller enters a valid routing code (one that is assigned to a RightFax user) the fax is placed in that user's mailbox. To configure the RightFax server and fax boards for channel routing. if each of your departments use a unique fax number. Configuring RightFax for channel routing Each fax channel must be configured for channel routing separately. enter the user’s DID/DNIS phone extension code. 2.Chapter 24: Routing inbound faxes Configuring DTMF routing Brooktrout Fax Board configuration on page 63. or if the code does not correspond to a valid RightFax mailbox. From the Enterprise Fax Manager. To configure DTMF routing 1. Configuring DTMF routing Unlike DID/DNIS routing. in the Routing Code (DID/DNIS number) box. Click each channel number under the fax board names. Before the fax transmission starts. For each channel. click Users and double-click a user name to open the User Edit dialog box. 4. see OpenText RightFax 10. Configuring channel routing With channel routing. 3. Each of the members of the department can check the department mailbox for faxes. Each fax channel must be configured for DTMF routing separately. DTMF uses Plain Old Telephone Service (POTS) with a single phone number assigned to each phone line. This setting corresponds to the Routing Code of the mailbox that is to receive all faxes coming in on this channel. and then double-click a user name to open the User Edit dialog box. and then enter the user’s DTMF code in the Routing Code box. run the RightFax DocTransport configuration program. The digits entered here correspond to the digits entered by the caller when prompted. Click Inbound Routing. click Users. On the Inbound Routing tab.6 Feature Pack 2 221 Administrator Guide . faxes are routed based on the phone line on which they are received. If the caller does not enter a code before a certain amount of time has elapsed. you would assign the routing codes 001 through 020 to your users. Configure the RightFax server and fax board(s) for DTMF routing by running the RightFax DocTransport configuration program. 3. 5. This file is the ANI routing table. Click ANI in the Routing Type box. On the RightFax server. edit the user properties. enter “0” (zero) in the Routing Code box. 3. all faxes from a certain phone number can be routed to a specific recipient. On the Inbound Routing tab. For the new user ANI. RightFax can use ANI information to route inbound faxes to a user mailbox based on the phone number that the fax originated from. individual user mailboxes will attempt to reroute all received faxes. If you have not already done so. Do not set individual RightFax user mailboxes to this routing type. one central mailbox performing ANI routing is sufficient. ANI (Automatic Number Identification) is a service provided by telephone service providers. Each line must contain a separate entry using this format: Configuring RightFax for ANI routing To route faxes with ANI routing. Similarly. This configures the mailbox to perform ANI routing on each received fax. See DoDigitalChanRoute on page 348. edit the user profile for each recipient mailbox in Enterprise Fax Manager. This mailbox is configured to reroute all incoming faxes using ANI routing. See Configuring Brooktrout global transport settings on page 64. OpenText RightFax 10. enter the ANI pattern matching string in the DocTransport module. Using ANI routing. 4.tbl in the RightFax\Bin folder.Chapter 24: Routing inbound faxes Configuring ANI routing In most cases. ANI routing is not available with analog fax boards. potentially creating endless routing loops. To create a central mailbox for ANI routing Configuring ANI routing 1. each mailbox must have a routing code that corresponds to a channel extension configured in the DocTransport. Configuring recipient mailboxes To assign channel extensions to mailboxes. Run Enterprise Fax Manager and add a new RightFax user called “ANI”. This causes all incoming faxes whose owners cannot be determined to automatically route to this mailbox. Channel routing with digital fax boards To implement channel routing with digital fax boards. the faxes must arrive in one “central” mailbox.6 Feature Pack 2 RoutingCode ANIString 222 Administrator Guide . This routing method can be useful to sales departments for routing faxes according to sales territories. Caution Only the central mailbox should have a routing type of ANI. If set to ANI routing. create an ASCII file called Ani. set the Windows registry value DoDigitalChanRoute to 1. 2. If the needs of your organization require you to create multiple central mailboxes. Click the Inbound Routing tab and enter the Channel Extension setting of the channel that you want to receive faxes from in the Routing Code box. It precedes each incoming phone call with a series of digits that includes (among other things) the phone number dialing in. all faxes originating from a specific area code or telephone number prefix can be routed to a specific recipient. Click the General tab and select Enable CSID Routing. Example of a short ANI routing table: 1001 1002 1003 1004 15205551212 15205552345 15205550982 15205551000 Configuring RightFax for CSID routing Creating alternate routing tables To configure RightFax for CSID routing You can set up multiple central mailboxes for ANI routing. Example of a short CSID routing table: This method relies on data from the sending device. 1. faxes sent from a specific fax number can be routed to a specific recipient. and CSID is the CSID information (either text or a phone number) that. routes to that user. 3. The routing code and CSID must be separated by a single space. edit the user profile for the mailbox in Enterprise Fax Manager. which may or may not include a fax phone number. If an ID for the sending device is not transmitted or cannot be determined. and type the file name in the Routing Info box. 1003 RIGHTFAX 223 Administrator Guide . RoutingCode CSID Where RoutingCode is the routing code setting of the user to route to. and specify a routing table called Sales. The custom routing table files must be located in the RightFax\Bin folder. On the RightFax server. CSID routing can be an unreliable method of routing. Run the RightFax Server configuration program. However. routing types that occur after arriving in a fax mailbox (like OCR routing) can still be used. For this reason. The CSID. Using CSID routing.tbl in the RightFax\Bin folder. click the Inbound Routing tab. the fax is placed in the mailbox that corresponds to the Channel Extension setting for the channel it arrived on (or to the administrator of the Everyone group if no channel extension match is found).6 Feature Pack 2 1001 520* 1002 Acme. The CSID text can contain spaces and other special characters. The ANI string and routing code must be separated by a single space. you could set up a mailbox that receives and routes faxes to the Sales department. Configuring CSID routing CSID (caller subscriber identification) routing routes inbound faxes to a specific mailbox based on the ID of the sending device. The CSID may be the company name or other data and it may be impossible OpenText RightFax 10. For example.tbl. create an ASCII file called CSID. Inc. Each line must contain a separate entry using this format: To specify the routing table for the mailbox. CSID routing precludes some other routing types like DTMF and channel routing. when sent. 2. Create a central mailbox for Sales. to match with data in RightFax.Chapter 24: Routing inbound faxes Configuring CSID routing Where RoutingCode is the routing code setting of the user to route to and ANIString is the ANI data represented by ‘X’ characters in the ANI pattern match.tbl file is the CSID routing table. To assign a delivery method to a user 1.Chapter 24: Routing inbound faxes Configuring delivery methods for users The asterisk (*) wildcard character can be used to represent any unspecified characters at the end of the CSID string. The following table lists the available folder macros. or billing code). The delivery method is configured individually for each RightFax user. and all characters preceding the wildcard must match the incoming CSID exactly for routing to be successful. The User Edit dialog box opens. the image can be found at C:\PROGRA~2\RIGHTFAX\WORKSRV\ XXX\ZZZ \. assuming it has the necessary network access privileges. Double-click a user to edit the user’s profile. For information on routing faxes to an email mailbox. incoming faxes are forwarded to the user as an email message. The list of users appears in the right pane of the window. Note If you you enter an incomplete path. or refer to the documentation included with the RightFax email gateway module. all incoming faxes with CSIDs that indicate they originated from area code 520 are routed to the RightFax user with the routing code 1001. Delivery options include: The destination path can also specify one or more folder macros that cause unique or descriptive folders to be created dynamically. 3. Click Inbound Routing and select the delivery method in the Routing Type box. Run Enterprise Fax Manager (see Starting Enterprise Fax Manager on page 18). Email When you select this routing type. incoming faxes are sent to a network folder that you specify. incoming faxes are routed to the user’s FaxUtil mailbox. see Configuring users to receive faxes via email on page 266. and click Users under the RightFax server in the Fax Server Tree. If you select this option. Example The following entry in the Routing Info box routes faxes to the RightFax\Faxin folder on the \SYS volume of the FILESERV file server: 2. RightFax creates any specified folders.6 Feature Pack 2 224 Macro Definition ~1 Date (YYYYMMDD) Administrator Guide . day.tbl file. the path you entered will be created relative to the worksrv. Network directory When you select this routing type. \\fileserv\sys\rightfax\faxin In this example. if you enter XXX\ZZZ. In the preceding example. This wildcard can only be used at the end of the CSID string in the CSID. the RightFax fax server would have to be attached to FILESERV with sufficient privileges to write to the Faxin folder. you have several options for the delivery method to the user. option. you must also provide the necessary routing information in the Routing Info box so that RightFax can find the correct email mailbox. Fax mailbox When you select this routing type. you must type the path to the folder in the Routing Info box and/or choose from several macros as to how you would like the faxes stored (such as by month.exe working directory. Configuring delivery methods for users After you configure a routing method for your organization. For example. If you select this OpenText RightFax 10. ~B Remote ID (right to left. the user group that shares the faxes is assigned a Routing Code. The total length of the path. truncated to 11 characters) Telephony server RightFax can route incoming faxes to a telephony server mailbox.txt. the fax appears in the recipient’s fax mailbox. Faxes that are routed to the group ID are distributed among the group members (using each individual’s configured routing method) either round-robin or according to each user’s ability to process the faxes. compared to a table of OpenText RightFax 10. (NP: or TCP:) server/source/sourcepassword/destination The file name stored in this folder is a unique name assigned by the RightFax server and cannot be changed. enter the telephony server routing information using this format: Example Entering \\FILESERV\SYS\RIGHTFAX\~1 causes the fax server to create a folder \\FILESERV\SYS\RIGHTFAX\20020101 when storing a fax received on January 1. cannot exceed 72 characters. enter the destination RightFax server name. Macro Definition ~2 Day of the week (SUN–SAT) ~3 Month (JAN–DEC) ~4 Year (YYYY) ~5 Day of the month (DD) For more information about OCR routing. If a sent fax is forwarded or routed from one RightFax user to another RightFax user with a network routing destination specified. Smart Fax Distribution is a method of distributing received faxes between all the members of a user group. but does not appear in the specified network folder. In the Routing Info box. No additional routing information is necessary if you use the default OCR routing table Route. In the Routing Info box. Where NP: or TCP: represents the network protocol. and the RightFax user account (user ID) of the fax recipient must exist on both RightFax servers. 2002. and when a match is found. With Smart Fax Distribution. ~6 Month as decimal (01–12) RightFaxInterConnect ~7 User ID (truncated to 11 characters) ~8 Week of year as decimal (00–51) ~9 Billing Code 1 (truncated to 11 characters) ~0 Billing Code 2 (truncated to 11 characters) ~A Remote ID (left to right. incoming faxes are OCRed for recognizable character strings. see Using OCR to route received faxes on page 216. OCR When you select this routing type. Distributing faxes to a group of users Note Only received faxes are routed to a network folder using this method. routed to the appropriate user. incoming faxes are redirected from one RightFax server to another.6 Feature Pack 2 225 Administrator Guide . The InterConnect service must be enabled on at least one of the receiving RightFax server’s WorkServers. truncated to 11 characters) When you select this routing type. either named pipes or TCP/IP. after macro replacement.Chapter 24: Routing inbound faxes Distributing faxes to a group of users RightFax user IDs and matching strings. 4. Specify the users whose faxes should be routed to the OpenText RightFax 10. 11. This unique ID number is printed on the fax page in the receipt terminal information (RTI) line. select FileRoute. In the Routing Type box. Under Services. In the User Edit dialog box. and page count. 8. date. RightFax generates and assigns unique ID numbers to each fax it receives. Repeat steps 3. select Network Directory. 4. see The Smart Fax Distribution tab on page 128. Select the check box Stamp Pages of Received Faxes with Audit Stamp. 9. 6. and click to clear Archive. select TIFF (G3-1D) or TIFF (G4). edit each user whose received faxes should be routed.Assigning unique ID numbers to fax file names and routing to a network folder Chapter 24: Routing inbound faxes To configure Smart Fax Distribution for user groups. 10. See UseReceiveStampUnique on page 353. folder. and the ID numbers can be used as the file names. In Enterprise Fax Manager. In the Routing Info box. Assigning unique ID numbers to fax file names and routing to a network folder Faxes stored in a network folder can be assigned unique ID numbers. 2. The WorkServer Configuration dialog box opens. click Permissions. and 5 for each WorkServer that you want to handle file routing. 3. 7. you can specify an ID that consists of the server name. Set the Windows registry value for UseReceiveStampUnique to 1 on the FaxServer and on each WorkServer. double-click RightFax WorkServer# Module. To assign unique IDs 1. Under Archive Settings. click Separate File Per Page Output check box. By default. select the server. In the Service Name list. You can specify an alternative ID number scheme if you want to store faxes on a network folder. 5.6 Feature Pack 2 226 Administrator Guide . type the name of the folder where the faxes will be saved. Click Inbound Routing. For example. In Enterprise Fax Manager. In the File Format box. Chapter 25: Responding to inbound faxes with AutoReply Requirements Chapter 25: Responding to inbound faxes with AutoReply The AutoReply service monitors one or more RightFax mailboxes for inbound faxes and replies with a fax to the sender if the inbound fax includes a valid CSID number. your organization's logo or other graphic images. It is recommended that you define a user ID dedicated to this feature. To change this setting. Setup prompts you to install it. Setup requires Microsoft . The RightFax Product Suite Setup wizard opens. If it is set to delete.NET Framework l Microsoft C++ runtime components l l 2. The faxed replies are fully customizable for each monitored user. auto-reply will fail. 4. Log on to the computer with a Windows account that is a member of the domain users and local administrators group. To install AutoReply 1. Setup can check for RightFax updates and other latebreaking information: 227 Administrator Guide . see Creating a user profile on page 108. run the AutoReply Wizard to add the AutoReply service to the RightFax server. relevant fax addressing information.exe.Click OK. If this software is not installed on your system. Installing AutoReply You can install AutoReply on any computer with network access to the RightFax server. verify that inbound routing is not set to delete after routing. Review the welcome screen and click Next. 5. To create a user ID. Requirements l Microsoft . see Creating a user profile on page 108. A reply can include personalized messages. Carefully read and accept the license agreement and click Next. After installing AutoReply. and a copy of the cover page from the received fax being replied to. Run RightFax Setup. For users that will be monitored for automatic replies.NET Framework. All auto-reply faxes are sent from one RightFax user account. see Configuring AutoReply on page 228. OpenText RightFax 10. You can route the inbound faxes to different RightFax mailboxes based on whether the auto-reply was successful and you can print those for which auto-reply failed to a RightFax printer.6 Feature Pack 2 6. 3. For more information. 6 Feature Pack 2 Adding the AutoReply service to the RightFax server. select the RightFax user ID from which to send the reply faxes. and then click Next. A template file must be selected for all monitored mailboxes (<Default>) and as needed for individual mailboxes. Click Connect. verify you have an active HTTP connection and then click Check for Updates. enter the password. 11. The settings must be defined for all monitored mailboxes (<Default>) and as needed for individual mailboxes. Click Custom. click Apply. If updates are found. click Next. Use it to create customized format. For more information. and then click Next. do the following: a. It Configuring AutoReply involves: OpenText RightFax 10. In the Log on as user box. When finished.ini files. Select your installation folder. and then click Next. 228 Administrator Guide . On the Start menu. click Next. and then click Next. then Open Text. and then RightFax Autoreply Wizard. The Preview Requirements list shows third-party software required by your chosen features and the status of setup operations. Click Set up and configure a new RightFax server. l 7. click All Programs. type the name of the server that AutoReply will monitor. l l To continue with Setup without checking for updates. Defining to route and print inbound faxes based on the success of their auto-reply. see Customizing the reply fax on page 230. 12. enter the RightFax user ID and in the Password box. Required software that will be installed automatically appears with a status of Must Install. On the Choose an AutoReply User page. Selecting a format.Chapter 25: Responding to inbound faxes with AutoReply l l Configuring AutoReply To check for updates. Select the RightFax AutoReply Setup component. This may take several minutes. 8. click Apply. Configuring AutoReply 3. To apply your settings and install required third-party software.ini file to apply to the reply faxes. 2. 4. click Next. in the Select the AutoReply user ID list. c. and then click Close. In a shared services environment. and then click Next. When you are logged in. Click Next. click Apply. This may take several minutes. 9. b. select the Do not check for updates check box.ini file is available at RightFax\AutoReply\Samples. 13. To configure AutoReply 1. To apply your settings and complete Setup. follow the instructions in the Result section. you must configure AutoReply on each node. A sample format. On the Choose Server page. To begin installing RightFax software. d. 10. In the RightFax Server box. When finished. select to route or print inbound faxes based on the success of their autoreply was successful. select a specific user ID. On the Monitored User Configuration tab. select a specific user ID. in the Select the printer where the fax should print if an autoreply is not sent box. and then RightFax Autoreply Configuration. On the AutoReply User ID tab. as needed. click Next. On the Start menu. Click Browse. On the Connection tab. in the Available users list. Repeat above steps for individual monitored mailboxes. 7. select <Default> to define the default methods for all monitored mailboxes. in the Select a user to route the fax to if an autoreply is not sent box. as needed. as needed. 6. is recommended that you define a user ID dedicated to this feature. then Open Text. select one or more users to monitor. otherwise. Click Finish. and then click Next. When you have selected all users to monitor. To route an inbound fax to another mailbox when the auto-reply fails. and then click Open. change for which inbound faxes will be routed and printed based on the success of the auto-reply. On the Format File tab.ini file to apply to the reply faxes. and then click Next. c. select the user ID.ini file for all monitored mailboxes. OpenText RightFax 10. b. 8. On the Monitored Users tab. To print an inbound fax on a RightFax printer when the auto-reply fails. The printer must be defined in Enterprise Fax Manager. as needed. click <Default> to select the format.ini files will be applied. 5.ini file. and then click Add. In the Select the monitored user ID list. change which format. select the printer ID. specify any of the following: l l l To make changes to your AutoReply configuration To route an inbound fax to another mailbox when the auto-reply is successful. 2. On the Select Monitored Users page. 1. b. On the Enter File Names page. Click Next. select the format.Chapter 25: Responding to inbound faxes with AutoReply Configuring AutoReply c. In the Select the monitored user ID list. 3. 6.6 Feature Pack 2 5. a. The users appear in the Monitored users list. select the user ID. change the RightFax user ID from which to send the reply faxes. click All Programs. a. otherwise. 4. change which RightFax mailboxes will be monitored for AutoReply. and then click Connect. select the *. 229 Administrator Guide . enter the user ID and password. in the Select a user to route the fax to after a successful autoreply box. Repeat the above steps for individual monitored mailboxes. As needed . On the Edit Monitored Users page. 5. You can use the same appearance for all reply faxes or define separate text files for different monitored users. A4. The General section options apply to the entire fax page. General. Legal The size of the page for the fax.5.ini is available in the RightFax\AutoReply\Samples folder.5. l Border Width The width (in pixels) of the frame border. click OK. When you have made the configuration changes. 1. Bottom: Measured from the top edge of the page. Size The font that will be used if a font is not specified for a frame. and those in the Libdocs sections specify libdocs to attach. The options for the Frame section include: Frame# When you configure AutoReply you must select a text file that controls the appearance of reply faxes. omit or set to zero. Right: Measured from the left edge of the page.6 Feature Pack 2 230 Administrator Guide .8. and Libdocs sections.10. You can place an unlimited number of frames on a page. Each Frame section defines the location of a frame on the fax page and its content. A sample text file called Format. l Customizing the reply fax Frame#. Frame#. enter: 4. Copy the format.ini file Top. Option Value Definition Area Left. those in a Frame# section to the given frame. Top. renaming as necessary. Bottom frame.Chapter 25: Responding to inbound faxes with AutoReply Customizing the reply fax 7. To customize a format. save it to a folder accessible by the server. For no border. It includes layout settings for a reply fax page. 2.ini file found in the RightFax\AutoReply\Samples folder.25. OutputSize Letter. The boundaries of the Right. The options for the General section include: General Option Value Definition Font Name. Example To define a frame that fills the lower-right quarter of a letter-size page. OpenText RightFax 10. To customize the appearance. Left. modify the values in the General. Font Name. or both). Graphic. For graphic files. Size. scaled to fit the frame. Italic. Graphic displays the graphic file specified in the File option. This can be either a text file (set Type option to Text) or graphic file (set Type option to Graphic). To include a longer text message. the point size. To add variables to the text. To add variables to the text in a text file. this option supplies the text that appears. Administrator Guide . Using variables in text on page 232. Specify the name of the font.6 Feature Pack 2 231 Name of Unicode file Use instead of File if the file is a Unicode file. UFile OpenText RightFax 10. see Using variables in text on page 232. use the File option. or Right The horizontal alignment of the text or graphic within the frame. scaled to fill the frame. or FaxPage Each frame must be one of these types: Text displays literal text from the Text option or text from a text file specified in the File option. Text Text If you set the Type option to Text. Type Text. Center. and the style (Bold.Chapter 25: Responding to inbound faxes with AutoReply Customizing the reply fax Frame# Frame# Option Value Definition Option Value Definition File File name The name of the file to include in the frame. Note This option supports a single line of text only. FaxPage displays the first page of the fax that is being replied to. monochrome bitmap files are recommended for best image rendering. Style The font that is used for all text in this frame. HorizontalAlignment Left. Troubleshooting the AutoReply Service To troubleshoot the service. This section is used for attaching libdocs to the end of reply faxes. Use the Wrap value to wrap unformatted text to fit within the boundaries of the frame.(. In Enterprise Fax Manager.ID. DocumentIDs ID. The date and time appears as Date Time [Timezone].. or Wrap The vertical alignment of the text or graphic within the frame.. stop the AutoReply service.6 Feature Pack 2 232 Administrator Guide . Type AutoReply -d -1. OpenText RightFax 10. the IDs of the lib docs to be attached. where Date and Time are formatted according to the Regional settings in Control Panel. Open a command prompt and change to the RightFax\AutoReply folder. The options for the Libdocs section include: Option Variable To view in debug Definition 1. 3. Separated by commas. Using variables in text Text in the format files and text included from external files can contain the following variables. Bottom. you can run AutoReply in a command window to view debug information. and then press ENTER. VerticalAlignment Top. Libdocs Value Definition Example The text TO: Fax Sender at ~1 expands in a reply fax to TO: Fax Sender at 520-555-0100. Variable Definition ~1 Destination fax phone number.Chapter 25: Responding to inbound faxes with AutoReply Troubleshooting the AutoReply Service Frame# l Option Value Definition UText Unicode text Use instead of Text if the text is Unicode text.ID. Libdocs. ~5 Unique ID of the fax (assigned by the RightFax server). ~2 Number of pages in the received fax.) ~3 Date and time the fax was received (the start of receipt). Center. 2. or Excel spreadsheets One or more library documents that are stored on the RightFax server 2. see Using RightFax email gateways on page 262. Choose the fax method depending on the type of information you want to send. (See Choosing the fax method on page 234. For information on faxing from your email client application. can attach files. You can create a fax from within RightFax FaxUtil. sending. OpenText RightFax 10. See Specifying addressing information on page 236. sending. you can include a variety of elements in each outgoing fax: l l l Creating and sending a fax To send a fax from the RightFax server 1. the fax remains in your FaxUtil mailbox with the status “Info Not Complete” as the required boxes are completed. library documents. A cover sheet One or more files such as Word documents.) RightFax opens the Fax Information dialog box. You can also create faxes from existing files. and your own notes. enter fax addressing information (such as the destination fax number). If you send a fax before completing all the required boxes. You must also specify addressing information that may or may not go on the cover sheet. and specify when and how the document is sent. and managing faxes There are several ways you can begin to create a fax. To send a new fax. The RightFax administrator can determine the required entries for users in Enterprise Fax Note If you have installed one or more RightFax email gateway modules. PDF files. on the Main tab. In most cases.6 Feature Pack 2 233 Administrator Guide . only To Name and Fax Number are required. depending on your cover sheet configuration. Whichever method you use.Chapter 26: Creating. you can create a fax as an email message and fax it directly from your email mailbox. or refer to the RightFax Gateway for Microsoft Exchange Guide or RightFax Gateway for Lotus Notes Guide. or from external programs such as Microsoft Word. and managing faxes Creating and sending a fax Chapter 26: Creating. Note Boxes that appear in bold are required. where you enter fax addressing information. you can add files to the fax. see Setting required cover sheet information on page 211. print to fax by selecting the RightFax Fax Printer. On the Attachments tab. spreadsheet. choose one of the following fax methods: l l l l Use the RightFax FaxUtil program. add notes you want to include on the cover sheet. For more information. See Attaching files on page 239. and managing faxes Manager. See Adding cover sheet notes on page 238. If you chose either the Send To or print-tofax methods. l 6. sending. OpenText RightFax 10. To use RightFax overlay forms. On the Cover Sheet Notes tab. Click Send. The application used must be able to print to a network printer. To create a new fax without launching any other programs. Depending on which components you want included in your fax. The user account also needs Full Control permissions on the %tmp% folder. use Quick Fax.exe) needs List folder / read data. there are already files attached to the fax. see Entering additional processing options on page 240. All of these methods bring up the same fax information dialog box and show the same faxing options.exe) needs Full Control on the 'spool' folder in %windir%\system32 and Full Control of the %allusersprofile% folder. Faxing from the RightFax FaxUtil program Open RightFax FaxUtil from your program menu or FaxUtil icon. To send a document that is already stored on your system without opening the application that created it. you can fax a document by printing it to the RightFax Fax Printer. Delete. click New Fax in the upper left corner. and Delete Subfolders and Files permissions for the 'RightFax' folder in %allusersprofile% folder. Faxing from an external application 4.Chapter 26: Creating. l Choosing the fax method RightFax provides users several convenient ways to create a new fax. 3. l To fax from an external application such as a word processor.6 Feature Pack 2 234 Administrator Guide . or enter more recipient information. To enable this feature: l 5. modify cover sheets. or other business application. To begin creating a fax. The RightFax Print Driver component must have been selected during the RightFax client installation (described in the RightFax Installation Guide). set fax priority. or remove files from the fax. From within an application like a word processor or spreadsheet. The service account running the Print Spooler (spoolsv. Note The RightFax folder may be in a subdirectory (either Application Data or Roaming). The local system account which runs the Print Spooler service by default has the necessary permissions by default. use the Send To feature. The user account running the RightFax system tray icon (FaxCtrl. exe) needs List folder / read data. (See the RightFax Installation Guide). In the system tray.6 Feature Pack 2 User ID 235 Administrator Guide . From the folder that contains the file you want to fax. The RightFax Print Driver component must have been selected during the RightFax client installation (described in the RightFax Installation Guide). Proxy Server If the protocol is HTTP. or HTTP. and on the shortcut menu. The user account also needs Full Control permissions on the %tmp% folder. Delete. and their own notes from one dialog box. Protocol When faxing from the system tray is enabled. and managing faxes RightFax client installation (See the RightFax Installation Guide). Faxing from the system tray l The user account running the RightFax system tray icon (FaxCtrl. Use Network Login ID. To enable faxing from the system tray l List folder / read data. sending. TCP/IP. Right-click RightFax system tray and select Configuration to view or change the defaults that were set at installation. and Delete Subfolders and Files permissions for the 'RightFax' folder in %allusersprofile% folder. and then click Fax Destination via RightFax. or Use Specified Login ID. and Delete Subfolders and Files permissions for the 'RightFax' folder in %allusersprofile% folder. The stored file must be in a format that RightFax can convert to fax format (see File formats that convert to fax format on page 322). To enable this feature: l l l l l The user account running the RightFax system tray icon (FaxCtrl. Secure TCP/IP. l The user account also must have Full Control permissions for the %tmp% folder. Delete. Note The RightFax folder may be in a subdirectory (either Application Data or Roaming). Faxing stored files using SendTo You can fax a stored file without opening the application that created it. install the Windows RPC over HTTP Proxy component. OpenText RightFax 10. click Send To. this is the proxy server configured in the RPC over HTTP component. right-click the file to open a shortcut menu. addressing information. library documents. The RightFax folder maybe in a subdirectory (either Application Data or Roaming). right-click the RightFax tray icon. select Quick Fax/Broadcast. Install the RightFax Print Driver component during the User ID when using the Use Specified Login ID Login Method.Chapter 26: Creating.exe) must have Login Method To use the HTTP protocol for print-to-fax. The login options are: Use NT Authentication. users can create a fax by combining files. The Configure Client window includes the following options: Fax Server Name The fax server name. l Under To. click Add Entry. w. Click the arrow button below the Name field and choose one of the following options: l Select Fax Number to enter a fax number. but not p.Chapter 26: Creating.6 Feature Pack 2 236 Select E-Mail Address to enter an email address. listing the individual and group entries in your RightFax phonebooks. see The Permissions tab on page 110. parentheses. Tray Icon Double-click Determines whether double-clicking the tray icon opens FaxUtil or Quick Fax/Broadcast. and managing faxes Phonebook dialog box opens. Select SMS to store the fax and send a text message to the recipient. click Phonebook. Administrator Guide . The email address can be up to 254 characters long and must include one (and only one) “@” symbol. enter an ampersand (&) followed by a sequence of DTMF digits. and other addressing information for the intended fax recipient as you want it to appear on the fax cover sheet. Your user profile determines if this option is available. enter the name. and a comma. t. For more information. For more information. For post-dialing. The digits will be dialed as soon as the SR140 receives a SIP 183 or SIP 200 response code or a H323 message from the gateway. phone number. see Using the RightFax phonebook on page 251. Sending to an email address allows several additional options including sending via certified delivery. The OpenText RightFax 10. and spaces can be included. sending images in portable document format (PDF). The post-dial string can include PSTN Telephony characters such as 0-9. #. sending. Fax Name l Enter the name of the recipient. To select a fax destination from your RightFax phonebook. and !. *. Boxes in bold (such as Fax Number) must be completed before the fax can be sent. but are not required. Language The default language is English. To add the fax addressing information entered under To as a new entry in your RightFax phonebook. Special characters such as hyphens. Double-click a phonebook entry to add it to the Current Recipients list. Specifying addressing information Fax Number You can specify the recipient addressing information in different ways. and sending file attachments that cannot be rendered as images (such as WAV files). You can add as many fax recipients to this list as you want. To create PDF files. click the fax in FaxUtil and select Release in the Fax menu. Note To use email or SMS addressing.Chapter 26: Creating. 237 Administrator Guide . For information on creating PDFs and setting PDF options. The Cheap Rates time can be specified by selecting Options in the FaxUtil Tools menu. Use cover sheet Adds a cover sheet to the beginning of the fax. see the SecureDocs Guide. Accounting You can also specify up to two codes under Accounting. normally all 50 pages have to be resent. the fax administrator must configure the RightFax server appropriately (see Adding and configuring email gateways on page 271 or Configuring SMS via the Push-Proxy Gateway on page 79). Select this check box to create the fax using 200×200 dots per inch (DPI) resolution. if the connection is broken after 40 pages of a 50-page fax. the Send button remains unavailable. and then clicking the Other Options tab. To send PDF files as faxes. Use smart resume Allows the fax server to resend only the portion of a fax that failed to send. see Working with PDF files on page 248. you can select the cover sheet to use (see Entering additional processing options on page 240). By enabling Smart-Resume. If you have permission to change cover sheets in your RightFax user profile (see The Permissions tab on page 110). Hold for preview You can examine the final version of the outgoing fax before you send it. Click Lookup to view and select from a list of available codes. sending. If you do not enter a destination. RightFax uses the cover sheet file specified by the RightFax administrator as your user or group default. see Creating billing codes on page 144. or if the entered information is invalid for that address type. OpenText RightFax 10. The fax is held in your FaxUtil mailbox with the status “Held for Preview” and can be viewed there. These codes can be used by the RightFax administrator to track who the fax was sent to or who sent the fax. you can click the […] button to open a list of PDF password protection options (if the administrator has enabled them). check this option to send each attachment as a PDF file instead of a TIFF file (the standard image format used for faxes). For example. Create PDF image When sending your document to an email address. The names of the codes are customizable. they may be called BillingCode 1 and BillingCode 2 or they may be called Account and Department. For example. and managing faxes You must enter at least one destination for the fax. you must purchase and enable the SecureDocs module. Fine mode If you are sending the fax by email.6 Feature Pack 2 Use cheap rates Tells RightFax to send the fax at a specified time (typically in the late evening when long distance rates are lower). To send the fax after you have previewed it. you must purchase and enable the PDF module. Using this resolution takes longer to generate and send the fax but produces a clearer fax image. For more information on using billing codes. For more information. the server only resends the last 10 pages. depending on the needs of your organization. no record of the fax is stored on the RightFax server. you must also specify a date and time to queue the fax for transmission. Comments for your Records This is a comment for your own use only. Use this option to take advantage of offpeak phone rates or to ensure that the fax recipient is available. Click the Cover Sheet Notes tab to add cover sheet notes or comments.Chapter 26: Creating. you can record such a fax transmission on the RightFax Server server for tracking purposes. It may also contain a field for notes. and Pages options in this dialog box let you specify information about the fax. Received. These options are available in FaxUtil on the Fax menu when you select Record Manual Fax. the computer beeps and an error message appears in this box. If you exceed 21 lines. sending. If you specify a time and date that has already passed. Notes to be Placed on the Cover Sheet Type the notes that you want to appear on your fax cover sheet. This text is not sent to the fax recipient. Text you enter in this box appears in your FaxUtil mailbox in the Comments column. only 21 are shown on the cover sheet. up to 69 characters each. In FaxUtil.6 Feature Pack 2 238 Administrator Guide . and managing faxes Delay send Tells RightFax to postpone the transmission of your fax to a later day or time. the fax is sent as soon as possible. Text Limit This shows the current number of lines in your note and the number of lines remaining. You can enter up to 21 lines of text. OpenText RightFax 10. The Sent. Recording Manual Fax Information When you send or receive a fax from a fax machine that is not connected to the network or to the RightFax server (such as a thermal fax machine). If you select this check box. Although it is possible to enter more than 21 lines of text. Adding cover sheet notes A cover sheet contains fields that are populated with recipient and sender data when the fax is generated. OpenText RightFax 10. Each of your attachments are added to the fax in the order it is listed here. Choose from the library. You can attach any of the file types supported by the RightFax document conversion engine (described in File formats that convert to fax format on page 322). select the attachment and click the arrow keys. This box lists the library documents and native document files you attached to the fax. Library documents are frequently faxed documents that your fax administrator has stored on the fax server. Native documents are electronic document files that you have saved on your local computer or on a server (such as Microsoft Word DOC files). To work with attachments. sending. and managing faxes Attaching files You can fax two types of documents as attachments: library documents and documents in their native file format. To remove an attachment. Click Library Documents. Click Scanned Documents. select it and click Delete[X]. choose one of the following: l l l Click File Attachments (paperclip). and you can attach as many files to a fax as you want. Specify a scanner and click Start Scan.6 Feature Pack 2 239 Administrator Guide . To preview an attachment. To move an attachment up or down. select the attachment and click the View Fax (magnifying glass) button. If you began the fax process with a stored document or by printing a document within an external application. Choose a file to attach. that document is automatically attached to the fax and appears in the list of attachments.Chapter 26: Creating. The new attachment appears in the list. click Attachments on the Fax Information box. To add more attachments to the fax. it is ignored. and managing faxes If you are sending to an email address and you attached a native document file. click the arrow to open a list all available forms. Priority Specify the priority that is assigned to the fax. Select low. Asterisks represent zero or more characters or digits. Entering additional processing options Cover Sheet File If your user profile includes permission to change fax cover sheets. see Creating overlay forms on page 135. Check this option to send the file in its native document format as a file attachment to the email message.Chapter 26: Creating. normal. the fax is not sent unless the remote ID matches the ID specified. Using this option. Many email client applications also support HTML and rich text format (RTF). PDF Attachment Type Specify whether the PDF file consists of Text or of Photos and Images. To specify the form file to use. rather than rendering the document into a fax image. For more information on forms. Automatic Deletion Specify when sent faxes should be automatically deleted from your FaxUtil mailbox. Recipient Fax ID Specify the exact remote fax ID of the intended recipient’s fax machine or server. these files can almost always be used as email body text. Note Because most email client applications support plain ASCII text files.6 Feature Pack 2 240 Administrator Guide . In addition. You can use the asterisk (*) and question mark (?) wildcards if you are not sure of the exact ID. If the original is light in color. Question marks represent exactly one digit or character each. form overlays cannot be applied to attachments when the Native option is selected. the “High Priority” option does not appear here. If the file type you specify is not supported by your recipient’s email client application. This feature is supported for Brooktrout fax boards only. including file types that cannot be rendered as images (such as WAV files). If you do not have the Can Use High Priority permission checked in your RightFax user profile (see The Permissions tab on page 110). When this feature is enabled. OpenText RightFax 10. the check box in the Native column is available. you can attach files of any type. specify Light. Recipient Notify Address Enter an SMS address to receive an SMS/pager notification of a new fax. you can select a cover sheet in this list. Use Form Select this check box to add an overlay form to the fax. or high priority from the list. sending. All other fonts are converted to graphic images. Note In very large documents that use embedded codes. Example <TOFAXNUM:555-1212> The embedded code TOFAXNUM instructs the RightFax server to send the fax to the destination fax number 555-1212. and parameters) in your document must be formatted using a native printer font. and managing faxes Using embedded codes From About adding embedded codes to documents Enter your name.Chapter 26: Creating. the pre-scanning process can cause the FaxServer to appear unresponsive. This information appears on the fax cover sheet. Using embedded codes Note the following to ensure that embedded codes in your documents are interpreted correctly by the RightFax server: Note Do not use the codes described in this section on fax cover sheets. see RightFax embedded codes on page 310. or code strings in a font that is not a native printer font. and other contact information. For a complete list of embedded code keywords. Examples include mistyped codes.6 Feature Pack 2 Format the code and any parameters according to the requirements for the specific code: 241 Administrator Guide . fax number.parameter> multiple parameters Every embedded code string (angle brackets. OpenText RightFax 10. l Example <TOFAXNUM:{MERGEFIELD FaxNumber}> Together with mail merge from Microsoft Word. code. You can place embedded codes anywhere in a document that accepts text characters and they can be written using upper or lower case characters. For information about codes you can use on cover sheets. l Embedded codes are special faxing instructions that you insert into documents created in other applications. descriptions. sending. such as instructions to include fax cover sheet or billing information or attach library documents. You can specify the maximum length of time for embedded code processing by editing the Windows registry PrescanTimeoutSeconds value. l <code:parameter. the embedded code TOFAXNUM instructs the RightFax server to send the fax to the numbers included in the FaxNumber field of a data source. Embedded codes cannot line wrap and any embedded code statement that is so long that it wraps to a second line is ignored. Incorrectly typed or formatted codes are ignored and will appear in the fax as text. Incorrectly typed or formatted codes are ignored and will appear in the fax as text. it uses the instructions contained in the embedded codes and then strips the codes from the document. l <code> no parameter l <code:parameter> one parameter l l When the RightFax server converts the document to fax form.parameter. Only native printer fonts are stored in their original text format in the PCL file from which the fax is generated. and their correct syntax. missing angle brackets. see Creating fax cover sheet templates on page 204. phone number. From the list of faxes. Enter a name for the folder. The first level of the list shows Group names. Click + next to Other Users in the folder tree to expand the list. Task flags The first few columns before the Date/Time column contain symbols that indicate the tasks that have been performed on each fax. sending. There is also a series of status flags that indicate which actions have been performed on each fax. downarrow = fax has been received. 1.6 Feature Pack 2 242 Sent/Received Up-arrow = fax has been sent. and delegates can view the mailboxes of other RightFax users. If you can view other mailboxes. and status of transmission. l 2. All Shows all faxes Main Shows all faxes except for those manually moved to other folders 4. FaxUtil list of faxes The right side of the FaxUtil window shows information about the sent and received faxes. 3. and managing faxes Viewing received faxes that group. In addition. each user can create custom folders for storage of faxes by category. group administrator. Viewing other users RightFax administrators.Chapter 26: Creating. an Other Users entry is included in your FaxUtil folder tree. 3. The right side of the window shows a list of the fax documents. Newly received faxes that have not yet been viewed appear in a bolder font than viewed faxes. number of pages. Click the folder where you want to store the fax. Click any group name to show the names of users in OpenText RightFax 10. Faxes must be moved to the custom folders manually. Other Users (optional) this folder appears only when the user is a RightFax administrator. or forward) for each selected fax. Working with folders To create a new folder and move faxes to it FaxUtil folder tree 1. print. Viewing received faxes FaxUtil shows information about the sent and received faxes for each user. group administrators. including date and time of transmission. A series of icons across the top of the window shows actions you can take (such as view. 4. Curved arrow = fax has Administrator Guide . Right-click any of the folder names and choose New. right-click any fax name and choose Move to Folder. Users not assigned to a group appear in the default group Everyone. or delegate. Click any user name to show the faxes for that user. then click OK. The left side of the FaxUtil window includes the following folders: l l l 2. Continue to expand the tree the user mailboxes that you want. delete. The left side of the FaxUtil window shows a folder tree that sorts the faxes. The RightFax Viewer shows the first page of the fax. l Printed Printer icon = fax has been printed from FaxUtil. sending. Sorting the list of faxes By default. l Viewed Magnifying glass icon = fax has been viewed. or forward or route the displayed fax to other RightFax users. To change the order in which faxes are listed 1. print. only the original image is sent.6 Feature Pack 2 The PDF tab appears only when viewing sent documents for which you created Portable Document Format (PDF) output. A globe icon = fax has been delivered by certified delivery. Click any column header in the document list to sort the documents in that column in ascending order. For more information on secure mail. To view PDF images in FaxUtil. Additional icons at the top of the Viewer let you save. Additional views of each fax may be available by clicking the tabs across the top of the image as follows: Converted to PDF Rectangular icon = fax has been converted from image to Portable Document Format (PDF).Chapter 26: Creating. 2. Enhanced Image When enabled for a user. both the original image and the OCR text are sent. see the RightFax SecureDocs Guide. Secure. by clicking the Go to Next Page or Go to Previous Page icons at the top of the Viewer. or Email Envelope icon = fax has been delivered by email or secure email. OCR The OCR tab only appears if you have the Optical Character Recognition (OCR) feature enabled and performed OCR on this fax. OpenText RightFax 10. open the RightFax Viewer by double-clicking any fax in your list. l l l The RightFax Viewer To view a fax. 243 Administrator Guide . Converted with OCR Document icon = fax has been converted from image to text using Optical Character Recognition (OCR). the list of faxes appears in order by date with the most recent fax on top of the list. or delete the displayed image. Right-click any column header to open a list of filter options. Click the same column header again to sort the documents in that column in descending order. PDF 3. Certified. If you route or forward to a RightFax user. The resulting PDF file shows in a separate tab on the RightFax Viewer. If you forward to a destination outside of your RightFax system. if any. display the next or previous fax in the list. only the original image is sent. both the enhanced image and the original received image are available in the RightFax Viewer. and managing faxes Viewing received faxes been forwarded. If you forward to a destination outside of your RightFax system. You can scroll through additional pages. both the original image and the enhanced image is sent. The resulting text shows in a separate tab on the RightFax Viewer. If you route or forward to a RightFax user. you must have installed Adobe Acrobat Reader. You can add notes or graphics on top of any original image or enhanced image. These annotations are stored with that document. l When you forward a document from your FaxUtil mailbox. Select the document from your received fax list and click the appropriate icon on the tool bar: 2. enhanced image. Each of the new faxes has a status of “Information Incomplete. Splitting faxes You can split any fax in your FaxUtil mailbox into multiple faxes. It shows information about the fax transmission as well as information about tasks performed on the fax such as viewing. the original document is sent to the recipient and is removed from your mailbox. 4. Open a fax in the RightFax Viewer. Annotations Note If you route or forward to a RightFax user. complete the addressing boxes in the Fax Information dialog box. a text box. sending. When your annotation is complete. l Forward to New Number l Forward to User l Route to User 2. the original image. and OCR file (if any) are sent. a copy of the document is sent to the recipient and the original document remains in your mailbox. a straight line. a solid rectangle. If sending to other RightFax users. Click any of the annotation tools. 3. If forwarding to a new number. Click the tab for the image that you want to annotate. 1. To annotate a document To forward and route documents 1. If you forward to a destination outside of your RightFax system. and managing faxes Viewing received faxes History l This tab is available for all faxes. only the original fax pages are sent. forwarding. and adding an image from a file. then click and drag the mouse on your image to create the annotations. or annotations.” Specify addressing information for forwarding or routing. 5. a hollow circle. To open the annotation tools. When you route a document. double-click each user who should receive the document. a solid circle. Forwarding and routing documents Ways to send a received fax to someone else: OpenText RightFax 10. 3.6 Feature Pack 2 244 Administrator Guide . Note If the image you want to annotate is displayed when you turn on the Annotation Toolbar.Chapter 26: Creating. Click OK to send. from the RightFaxViewer Tools menu. and then select the Annotation Toolbar checkbox. choose Save from the File menu. you’ll need to select another tab (such as History) and then reselect the image tab before the annotation tools will appear. choose Options. Choices include a hollow rectangle. This section describes managing faxes. and managing faxes Managing faxes in the list. and click OK to send the new fax. Clear the check box to remove the original fax after the split. see Retry settings on page 33. move it up or down in the list. For example. For a complete list and description of RightFax error messages. if you have a 5 page fax. If the fax has not been successfully sent after the specified number of attempts. you can select any fax OpenText RightFax 10. and received information from the target fax machine indicating that the fax information was received. If a transmission attempt is not successful. As a fax is being retried. remove it from the list. 5 Managing faxes 3. 6. Click OK to create the new faxes you specified and return to the FaxUtil mailbox. it is retried. Select two or more faxes from your FaxUtil list and click Combine Fax on the tool bar. To split a fax 1. sending. The Fax Information window appears.6 Feature Pack 2 245 Administrator Guide . (optional) You can click View Fax (magnifying glass) to view a selected fax. To combine several faxes into one fax For information about specifying retry counts and intervals. transmitted the information across the line. A transmission is successful if the RightFax server made a connection. (optional) You can click the View Fax button to view the original fax. 4. it appears with a yellow status icon in the sender’s FaxUtil mailbox. 1-3. The selected faxes appear in a list in the Combine Fax window in the order in which they are placed in the new fax. Select the Keep Original Fax check box to store both the new split faxes and the original fax.Chapter 26: Creating. Select a multi-page document from your FaxUtil list and click the Split Fax icon on the tool bar. You can specify a single page or a range of pages for each fax. 1. Complete the addressing information. or specify specific pages that you want included. Separate the output faxes with commas. Click Combine to create the new fax with each of the original faxes as attachments. 5. Combining faxes You can combine faxes in your FaxUtil mailbox into a single fax. 2. see Error and status messages on page 324. it is abandoned and saved in the sender’s FaxUtil mailbox with a red status icon. Monitoring transmission success and failure Use FaxUtil to monitor the transmission of your faxes. You can route or forward the new faxes with the standard Fax Information dialog box. 3. 5. 2. Specify the pages of the original fax that you want included in each of the new faxes. and want to create one fax with the first 3 pages and another fax with just the last page. you might enter: 4. From the Combine Fax window. click Administrative Mode. 2. To approve or disapprove a fax. it is assigned a status of “Fax was disapproved” in the original sender’s FaxUtil mailbox. click Needing Approval to show faxes waiting for approval. You can add a note (up to 450 characters) that is stored with the date and your user ID in the fax history. Run FaxUtil. Route. If the fax is not approved. To require fax approval for a user To approve a fax blocked by a dialing rule 1. set the Forward. right-click the fax and select Status > Approve Fax or Disapprove Fax.Chapter 26: Creating. You can add a note (up to 450 characters) that are stored with the date and your user ID in the fax history. select the Must Have Faxes Approved check box. Logon to FaxUtil as an administrator. If the fax is not approved. it is immediately scheduled to send. On the Permissions tab. On the List menu. 1. click Needing Approval to show faxes waiting for approval. point to Status. If the fax is approved. 4. sending. On the List menu. OpenText RightFax 10. On the List menu. Group administrators and alternate group administrators cannot approve faxes. and group alternate administrators can view and approve these faxes. 2. To approve or disapprove a fax. see Creating a user profile on page 108 1. To view a list of all faxes waiting for approval 4. Edit the user profile in Enterprise Fax Manager. 246 Administrator Guide . group administrators. If the fax is approved. and then click Approve or Disapprove. click Administrative Mode to view the contents of all fax mailboxes for which you are an administrator. You can also delete the fax rather than approve or disapprove it. For more information. Delete option for External Document Connector in server configuration to Disabled. and managing faxes Viewing received faxes Fax Approval Approving faxes blocked by dialing rules RightFax can be configured to hold outbound faxes for approval by an administrator before sending. 3. Faxes that are blocked by dialing rules can be approved for transmission by RightFax administrators. it is immediately scheduled to send. You can also delete the fax rather than approve or disapprove it.6 Feature Pack 2 Note To use this option when also using the XML Generator module. 2. it is assigned a status of “Fax was disapproved” in the original sender’s FaxUtil mailbox. RightFax will retain the image files of faxes that have been deleted from FaxUtil until all corresponding database records have been removed. Controlling deleted faxes By default. 3. On the List menu. Only RightFax administrators. to view the contents of all fax mailboxes for which you are an administrator. right-click the fax. 4. OpenText RightFax 10. 5. Create a new REG_DWORD entry of DeleteImagesOnPurge. and managing faxes Viewing received faxes To configure RightFax to immediately delete fax images 1. Restart the RightFax services. 2. 3. Open the Windows Registry on the RightFax server. Browse to the subkey of HKLM\Software\RightFax\FaxServer.6 Feature Pack 2 247 Administrator Guide .Chapter 26: Creating. sending. Edit this entry to contain a value of 0. When viewing the sent fax in FaxUtil. l l l or Network Directory). Select PDF to deliver faxes as PDF files to the user’s email. also called encrypted delivery. See the SecureDocs Guide for more information. from the User Edit Inbound Routing tab. You can specify PDF as the inbound routing delivery format for each user. In Enterprise Fax Manager. the optional RightFax Searchable PDF module license is required to convert received faxes to searchable PDF.. Select PDF (Searchable) to deliver a searchable PDF to the user’s email (requires the RightFax Searchable PDF module license). select any of the routing types for which PDF is available (such as Microsoft Exchange OpenText RightFax 10. click the PDF options (. To convert attachments to PDF Converting received faxes to PDF Select the Create PDF checkbox on the Fax Information dialog box. Depending on your licensed options. 1. 2. you can use RightFax to create PDF files for email delivery in the following ways. the attachments appear in their own PDF tab. Select a PDF option: l l When sending faxes by email. Password protection. For more information. Creating and sending a PDF by email RightFax can convert PDF documents into TIFF image files for faxing.Chapter 27: Working with PDF files Converting received faxes to PDF Chapter 27: Working with PDF files RightFax works with portable document format (PDF) files. see Using the PDF module to convert PDF files for faxing on page 249. requires the optional RightFax SecureDocs module (see the SecureDocs Guide). To add a password to the PDF To convert received faxes to PDF Select the Create PDF checkbox. Users can specify that they want incoming faxes delivered to their email boxes as PDF files. The default RightFax configuration can convert received faxes to standard PDF before routing. RightFax can create PDF files in either standard or password-protected formats.) button to specify the password and the functions to be protected. users can attach existing PDFs to their emails. If the attachments are not yet in PDF.6 Feature Pack 2 248 Administrator Guide .. The optional RightFax PDF module is required to convert PostScript or PDF files to TIFF format. Important The RightFax PDF conversion engine does not support conversion of PDF files that contain embedded TrueType (CID) fonts that use “Identity-H” encoding. double-click RightFax WorkServer. Activating the PDF module on the RightFax server The files required by the RightFax PDF module are installed on all RightFax servers during the server installation. Using the PDF module to convert PDF files for faxing 1. After the PDF module is activated. select the WorkServer that you want to perform PostScript processing. refer to the RightFax Installation Guide. RightFax users can print native PostScript and PDF documents directly to the RightFax printer. In the WorkServer Configuration window. in the component tree in the left pane. To create and store the PDF on a web site for certified delivery After the RightFax PDF module has been activated on the RightFax server. Select the Use Certified Delivery check box. you have the option to use a PostScript print driver to create the RightFax printer on each RightFax client computer. activating new components on the RightFax server. Enabling PostScript processing on a WorkServer This option is available if you licensed the RightFax SecureDocs module. To activate the PDF module.Chapter 27: Working with PDF files Using the PDF module to convert PDF files for faxing This option is available if you licensed the RightFax SecureDocs module. For information on OpenText RightFax 10. or purchased and licensed this module separately. you must enable PostScript processing on at least one RightFax WorkServer module (described in the next section) and copy the PostScript fonts you want to support onto the RightFax server.6 Feature Pack 2 249 Administrator Guide . in Windows Control Panel of the RightFax server. The recipient will receive an email containing a link to the PDF and instructions for opening it. 2. The PDF module must be licensed and activated before its functionality is enabled. and also send rich PDF files (files that include full color and editable data) to email addresses. You can enable PostScript processing on as many WorkServers as you want. you must have licensed a RightFax server type that includes this module. When this module is activated. Click PostScript in the Services list to enable PostScript processing.6 Feature Pack 2 250 Administrator Guide . the RightFax PDF module supports 35 basic PostScript fonts including Times. and Symbol. copy the PostScript fonts you want to support into the RightFax\Shared Files\PDF\PSFonts\Font folder on the RightFax server. Adding a margin before conversion When PDF files have images that go to the edge of the page. See ShrinkToView on page 359 for more information. set the Windows registry ShrinkToView value on each machine running the conversion WorkServer. When it is activated. OpenText RightFax 10.Chapter 27: Working with PDF files Using the PDF module to convert PDF files for faxing 3. Courier. part of the image can be cut off and replaced with a margin during conversion. To add additional font conversion support. Be sure to include both the . Helvetica.pfb components of the PostScript fonts. Adding PostScript fonts To correctly convert Type 1 PostScript fonts in PostScript and PDF files. the fonts must be copied into the RightFax\Shared Files\PDF\PSFonts\Font folder.pfm and . To reduce the size of the page slightly before conversion so that the margin does not cut off any content. Because each user’s phonebook is unique. Run RightFax FaxUtil.Chapter 28: Creating phonebooks and broadcasting faxes Using the RightFax phonebook Chapter 28: Creating phonebooks and broadcasting faxes RightFax phonebooks store fax addressing information (such as name. 2. see Specifying addressing information on page 236. LDAP. Fax broadcasting sends a single fax to multiple recipients without addressing each fax individually. or MAPI contact lists. all phonebook functions are managed from within the FaxUtil client application. and phone number) in a single location so you can easily apply all fax destination information when addressing an outgoing fax. To open your RightFax phonebook 1. OpenText RightFax 10. On the Tools menu. unpublished entries from your phonebook will be accessible to other users. click Phonebook. You can also create group phonebook entries that contain fax addressing information for multiple fax recipients. For information on using phonebook entries to address outgoing faxes. Using the RightFax phonebook The RightFax phonebook is a fax recipient database customized for each RightFax user.6 Feature Pack 2 251 Administrator Guide . fax number. If it is not. You can create individual entries (for one person at a time) or group entries (to fax to multiple individuals and groups at the You can use phonebooks or other databases containing contact information to send fax broadcasts. Caution You can limit access to your phonebook entries only if your RightFax account is password-protected. RightFax users can choose to use the phonebook built in to the RightFax FaxUtil client or can link to existing ODBC. click Phonebook. Select any of the following check boxes to specify who can view and edit this group phonebook entry. type a name for the phonebook entry. select any of the following check boxes to specify who can view and edit this phonebook entry. Click OK. this phonebook item is available to applications other than RightFax software. and the recipient's fax id. l l l Published. 2. If selected. and then click New Entry. only the owner can modify this phonebook item. 1. other RightFax users can view the item. In the ID field. Read Only. On the FaxUtil toolbar. To create a group phonebook entry A group phonebook entry can consist of both individual and group entries To create an individual phonebook entry 1. Under Address. voice numbers. enter billing codes and notes you want to assign to all faxes sent to this recipient. 3. same time). In the ID and Type name or select from list fields. Read Only. click Phonebook. the item is available to applications other than RightFax software. The new entry appears as an individual entry in your phonebook list. In the box on the left. enter addressing information for this recipient. enter an ID and a description for the group. If selected.Chapter 28: Creating phonebooks and broadcasting faxes the item. On the FaxUtil toolbar. only the owner can modify OpenText RightFax 10. If selected. a name and a fax number. select all individual and group 252 Administrator Guide . If selected. other RightFax users can view this phonebook item. If selected. l l 5. Hidden on cover sheet CC list. Externally available. 3. 4. enter optional contact information. 6. 7. the item does not appear in the CC list on the cover sheet. Under Other. at a minimum.6 Feature Pack 2 Published. 4. Under Options. and then click New Group. Under Billing Information. l l Externally available. such as a secondary fax number. If selected. If selected. 2. and then click the right arrow to move them to the Group Members box. tab-. match the order of the field data to the order of the field names. l Use comma-. On subsequent lines. quotation marks. When exporting from an existing source. Voice1 31 The recipient’s primary voice number as it will appear on the fax cover sheet. Fax2 31 On the first line of the file.) Creating a file to import Follow these guidelines when creating an import file or exporting contacts from an external source: l Create an ASCII text file. l 5. Name 59 The recipient’s name as it will appear on the fax cover sheet. they must be used for all fields in the file. Voice2 31 The recipient’s alternate voice number as it will appear on the fax cover sheet. The import file can be: l l l Generated by an external source such as a contact database manager Exported from another RightFax phonebook Generated by the RightFax PhnPrint administrative utility (See the Administrative Utilities Guide for more information. Address 59 The recipient’s address as it will appear on the fax cover sheet. Click OK. or space-delimited format. CityState 59 The recipient’s city and state as they will appear on the fax cover sheet. This is used when dialing the fax destination and may appear on the fax cover sheet. Field name Maximum length Description ID 17 A unique ID used only to reference the phonebook entry. This is used when dialing the fax destination and may appear on the fax cover sheet. Company 59 The recipient’s company name as it will appear on the fax cover sheet. The recipient’s alternate fax number. map each field name to the corresponding RightFax name. Fax1 31 The recipient’s primary fax number. specify the field names using the table below. The group appears in your phonebook list.Chapter 28: Creating phonebooks and broadcasting faxes Importing entries into the RightFax phonebook items you want to add to the group. It never appears on the fax. you can import entries into your personal phonebook from a specially formatted text file. If you have user permission to create and edit phonebooks. Indicate blank fields with a single space surrounded by OpenText RightFax 10. Importing entries into the RightFax phonebook The following table lists each of the valid phonebook entry fields. l Separate each phonebook entry with a line break.6 Feature Pack 2 253 Administrator Guide . l l l If quotation marks are used to surround any field. After you create the import file. BillCode2 17 An additional code associated with the recipient used for billing or tracking purposes. to separate the fields in each phonebook entry. select OEM. Notes 128 Publish Imported Entries Select this check box to make each new imported entry published. If quotes are used. quotes.”Company”.”Acme”.”Name”. Replace After Confirmation replaces existing entries only if you agree to a confirmation message.”Jane Doe”. unpublished entries can be accessed only by you and the RightFax administrator.Chapter 28: Creating phonebooks and broadcasting faxes Importing entries into the RightFax phonebook Field name Maximum length Description Quotes Around Fields BillCode1 17 A code associated with the recipient used for billing or tracking purposes. Duplicate ID Handling To import phonebook entries You have the following options for handling imported entries that contain IDs that already exist in your phonebook: 1. l 2. re-import the file and select ANSI. import the entries using FaxUtil. Published entries can be accessed by other RightFax users. Text Format Select the text mode of the file to import. It never appears on the fax. Run FaxUtil.”555-1212”.”CityState” “Bob”.”Tucson AZ” “Jane”. In the Phonebook Import window. Administrator Guide .6 Feature Pack 2 l 254 Replace Existing Entry replaces any existing entry in the phonebook with the imported entry containing the duplicate ID.”Fax1”. Fields in the import file can be surrounded by. Any additional information about the recipient. but do not require. complete each box according to the format of the file you are importing. If your text application doesn’t specify whether it’s using OEM or ANSI text. Select this check box if your data fields are surrounded by quotes. and select Phonebook Import from the Tools menu. Click Browse to search for and select the file.”Bob Jones”. Some unpopulated data fields are illustrated in the last entry. or a space. a tab. Generate Unique IDs adds a number to the end of duplicated IDs to make the new ID unique. If accented or other special characters do not import properly. Example The following is a short example of a file that can be can be imported into your RightFax phonebook.” ”. This will not appear on the fax and is for your information only. “ID”. l Import File Enter the path and file name of the text file to import.” ” Field Delimiter Using FaxUtil to import phonebook entries Specify whether the import file uses a comma. they must be used on every field in the file. It never appears on the fax.”444-3333”. OpenText RightFax 10. This option is only available if you have user permission to create and edit phonebooks. In the Choose Profile window. domain. The Phonebook dialog box opens. When you have all the contacts you want. 3. In the MAPI contact list. enter your network user name. Select a user or group of users. 3. To select a recipient from a MAPI source 1. MAPI address books and contact list profiles are created by Exchange. and other MAPI-compliant applications. and then click OK. each client workstation must have MAPI installed. In the Phonebook dialog box. Choose a location to save your file. click Phonebook. 5. click Import to import the entries. and on the Tools menu. 2. click MAPI.6 Feature Pack 2 255 Administrator Guide . Using MAPI phonebooks Saving phonebook entries to a commaseparated value (CSV) file RightFax also integrates with MAPI-compliant contact lists such as Microsoft Exchange address lists and Outlook contact lists. and password. 2. 4. you do not need to configure the MAPI-to-RightFax connection. After selecting users to save. Outlook. OpenText RightFax 10. In the Enter Password window. select the MAPI profile name. To save phonebook entries to a CSV file 1. Run FaxUtil. double-click each contact entry to add it to the Fax Destinations list. 3. When all boxes are complete. in the Profile Name box. The Select Export File window opens.Chapter 28: Creating phonebooks and broadcasting faxes l Saving phonebook entries to a comma-separated value (CSV) file Skip ignores any entry in the import file with a duplicate ID. enter a file name and click Save. right-click the filter bar and choose Save Contents As. and then click OK. Because these profiles conform to a universal standard. Click the Close button when finished. 4. click OK. To access MAPI contact lists. this document cannot provide specific instructions for configuring the ODBC drivers on your workstations. This is especially useful for sending fax broadcasts to large numbers of recipients. In the FaxUtil Phonebook dialog box. You will use this ID and password in the RightFax ODBC configuration. Using ODBC phonebooks RightFax can connect to an existing ODBC database to use your organization’s existing contact database information for addressing faxes. Display the list of ODBC phonebooks in either of the following ways: There are two parts to configuring ODBC connectivity: general ODBC configuration and RightFax-specific ODBC configuration. Configuring RightFax for ODBC connectivity After the workstation has had ODBC drivers correctly installed. click Configure Phonebooks and choose ODBC Configuration. 2. After you configure the drivers on your workstation. Note the following guidelines: l l l Verify that you have the 32-bit version of ODBC installed on your system by opening Windows Control Panel and running the ODBC program to open the ODBC Data Source Administrator. create a data source under a User DSN or System DSN in the ODBC Data Source Administrator. OpenText RightFax 10. Each workstation must be configured individually for both types of ODBC information. Click the RightFax tray icon in the taskbar and select ODBC Configuration. Click Add next to ODBC Phonebooks to create a new ODBC source or select an existing phonebook and click Configuring ODBC drivers on the client workstation Because every database is different. To configure ODBC in RightFax 1. you must map the ODBC fax contact information to the corresponding fields in RightFax.6 Feature Pack 2 256 Administrator Guide . Note the user ID and password that is used to log on to the database or database server.Chapter 28: Creating phonebooks and broadcasting faxes Using ODBC phonebooks The MAPI contacts appears in the Phonebook dialog box in the Current Recipients list. l l This option is only available if you have user permission to create and edit phonebooks. This is useful. use simple SQL queries to relate ODBC database fields to each of the listed RightFax phonebook fields. enter the SQL information specified by the query results. To presort the data. middle. Enter two single-quotes (‘’) in any OpenText RightFax 10. limit the number of records loaded at one time in the Records to Load at Once box. 9. 4. enter the name under which this database appears in the User DSN tab of the ODBC program in Control Panel. use a tool such as Microsoft Query to generate the SQL code. you can create this information quickly and enter it in the Select boxes. In the From and Where boxes. and then cut and paste the codes into the Select boxes. 3.Chapter 28: Creating phonebooks and broadcasting faxes Using ODBC phonebooks Edit. 7. you can access these contact records as phonebook entries when addressing 257 Administrator Guide . If you have a large database. Under Select. enter the necessary SQL data in the Order box. (This should not be necessary because RightFax can sort phonebook entries by column after it retrieves the data. In the Phonebook Name box. If the ID and password match those used to log in to FaxUtil. If you are familiar with SQL code. If you are not familiar with SQL code. field you want to leave blank. if your database contains separate fields for first. and last names. Using ODBC phonebooks to send faxes 5. enter a descriptive name for this contact database. each of these source fields should be combined into the single RightFax field. for example. Note With SQL queries you can combine multiple ODBC source fields in a single RightFax field. 6. you can select those check boxes instead. Because RightFax has only one Name field.) 8. In the ODBC Source box.6 Feature Pack 2 After you configure your ODBC information. Specify the ODBC User ID and ODBC User Password required to access the database information. l Click the RightFax tray icon in the taskbar and select LDAP Configuration. Display the list of LDAP phonebooks in either of the following ways: To send faxes using ODBC phonebooks 1. 3. The new fax is sent to each of the specified recipients.6 Feature Pack 2 258 Administrator Guide . This option is only available if you have user permission to create and edit phonebooks. LDAP phonebooks are only accessible from Windows Vista. 2. click the arrows on the far right side of the table. Windows 8. 2. enter a descriptive name for this contact database. To view the previous or next increment of records. Click Add to create a new LDAP source or select and existing phonebook and click Edit. In the Phonebook Name box. you see only that number of records. click Configure Phonebooks and choose LDAP Configuration. enter the name of the LDAP OpenText RightFax 10. 4. Configuring RightFax for LDAP connectivity For RightFax to work with your LDAP database. Click Phonebook and select the ODBC Phonebook tab. and then click OK to address the fax. Click one or more records. In the LDAP Server box. Windows 7.Chapter 28: Creating phonebooks and broadcasting faxes LDAP phonebooks faxes via the Fax Information dialog box (see Specifying addressing information on page 236). A list of contacts opens. LDAP phonebooks RightFax users can connect to an existing LDAP database to use your organization’s existing contact database information for addressing faxes. To configure LDAP in RightFax 1. In the FaxUtil Phonebook dialog box. l If you limited the number of records displayed at one time.1 workstations. Note The LDAP User ID field is limited to 47 characters. This is especially useful for sending fax broadcasts to large numbers of recipients. The Configure LDAP Phonebook dialog box opens. you must map the LDAP fax contact information to the corresponding fields in RightFax. and Windows 8. click Phonebook to open your RightFax. This is called sending a fax broadcast or fax broadcasting. or MAPI phonebook (as described earlier in this section). 6. l Fax broadcasting from a database. you can access these contact records as phonebook entries when addressing faxes via the Fax Information dialog box (see Specifying addressing information on page 236). You can send one fax to large numbers of recipients. To view the previous or next increment of records click the arrows on the far right side of the table. If you have a large database. Using LDAP phonebooks to send faxes After you configure your LDAP information. The method you choose for your fax broadcast is determined by the nature of the fax broadcast as well as the source of the fax contact information. l Fax broadcasting from a mail merge. After a phonebook is created. Specify the server’s IP port in the IP Port box. and. Click one or more records. A list of contacts opens. The RightFax server provides these methods for sending a fax broadcast: OpenText RightFax 10. Note When broadcasting the same document to a large number of people. Under Attribute Mappings. the WorkServers will have to perform 500 separate PCL-to-TIFF G3 conversions. map the LDAP fields that correspond to the listed RightFax fields. in the Fax Information dialog box. LDAP. These phonebooks are typically used only for private contact management and exist separately from your organization’s primary contact data source. the fax is already stored in TIFF G3 format and does not need to be converted again for faxing. limit the number of records loaded at one time in the Records to Load at Once box. The easiest way to send a fax broadcast is to select Quick Fax/Broadcast from the RightFax tray icon. you see only that number of records. If a fax is not saved as a library document and is broadcast to 500 recipients. 5. Fax broadcasting from phonebooks.Chapter 28: Creating phonebooks and broadcasting faxes Fax broadcasting server. In addition. To send faxes using LDAP phonebooks Fax broadcasting from phonebooks 1. If you limited the number of records displayed at one time. and then click OK to address the fax. ODBC. it is generally better to store the fax as a library document. faxing to one or more contacts in the phonebook is as easy as clicking the desired contacts in the list. 2. Fax broadcasting Fax broadcasting from your RightFax or MAPI phonebook is most useful for small fax broadcasts to your personal contacts. The new fax is sent to each of the specified recipients.6 Feature Pack 2 l 259 Administrator Guide . you can filter the number and type of entries returned to RightFax. As a library document. From each of these phonebooks you can specify multiple recipients for your fax. The biggest advantage of using phonebooks for fax broadcasts is convenience. Click Phonebook and select the LDAP database. 1. To create the RightFax printer Using your phonebooks for fax broadcasts has some disadvantages. refer to the documentation for the application. Fax broadcasting from a mail merge 4. To prepare for fax broadcasting with mail merge 1. all recipients receive the same fax body pages. 3. such as Normal. 2. the body of the fax cannot be not customized to each recipient. For guidelines on adding embedded codes to documents. and then select Create PCL Fax Driver. see Using embedded codes on page 241. <TONAME:{mergefield Name}> <TOFAXNUM:{mergefield FaxNumber}> <TOCOMPANY:{mergefield Company}> 2. Perform the mail merge. Word creates a single document with as many sections as there are recipients 260 Administrator Guide . Click Create Fax Driver. see the documentation for Microsoft Word. mail merge. Right-click the RightFax system tray icon. Create a RightFax printer that is a PCL5 printer and does not open the Fax Information window.docm) based on the template in which you created the macro to print the merged document by section. such as Microsoft Word or Microsoft Access. create a macro-enabled document (*. Set this printer as the default printer before performing the OpenText RightFax 10. Make sure you have an updated data source. You can send a fax broadcast using mail merge from applications that support it. that instructs Word to send each mail merge section as a separate print job to the RightFax print queue.Chapter 28: Creating phonebooks and broadcasting faxes Fax broadcasting Fax broadcasting from your ODBC or LDAP phonebook is better geared towards large fax broadcasts because these phonebooks can be dynamically linked to your organization’s primary contact data source. add a macro to a macro-enabled template (*dotm). Although each cover page has the correct contact information.dotm. For information about mail merge fields. Each application and each version of an application require different steps for performing a fax broadcast with mail merge. select Windows. In Microsoft Word. and then select Configuration. the fax broadcast must be specifically initiated by someone and the contacts to fax to specified manually. In the Type column. 3. In Microsoft Word. Example The following shows RightFax embedded codes used in combination with merge fields. First. For instructions on setting up mail merge. Example In the document. include the fax addressing information and any instructions using RightFax embedded codes together with mail merge fields.6 Feature Pack 2 2. such as a list of fax recipients in Excel. Enter a name for the printer and fax server receiving jobs. Also. To create the document and perform the fax broadcast 1. rather than sending all sections as a single print job. The following outlines the general steps for using this broadcast method with Microsoft Word. Open FaxUtil to verify that the faxes have been sent. Each section of the document is sent as a separate print job to the RightFax printer queue. such as a library document. There are many possible variations on this method. OpenText RightFax 10.Chapter 28: Creating phonebooks and broadcasting faxes Fax broadcasting in the data source. Fax broadcasting from a database Fax broadcasting from a database uses the scripting power of your contact database with the faxing capabilities of RightFax. run the macro you created when preparing for the mail merge. 3. In the mail merged document. to all recipients or customizing each document for each recipient. The drawback is that this method can be highly complex and may require substantial programming in your database’s scripting language. The method has the added flexibility of sending the same document. 4.6 Feature Pack 2 261 Administrator Guide . Set the RightFax printer you defined for the mail merge as the default printer. 5. The benefit of this method is that the fax broadcast can be partially or completely automated depending on the database you use. the email gateway will send a fax that does not have a recipient name even if RightFax is configured to require the To Name field be completed before sending a fax. Configuring SMTP/POP3 gateway installations For SMTP/POP3 installations. Email clients must be configured for UTF-8 (unicode) encoding so that special characters. Email messages addressed to the RightFax email gateway are picked up by the RightFax server. SMTP/POP3 server(s) must be accessible by the computer running the RightFax email gateway(s). Using the RightFax email gateway. Advanced gateways for Microsoft Exchange and Lotus Notes are available as separate. the goal is always to route outgoing fax-bound email messages to the mailbox on the SMTP server specified in the POP3 Mailbox Name box in the E-mail Configuration dialog box (see Adding and configuring email gateways on page 271). you must add and configure the email gateway on the RightFax server (described on Adding and configuring email gateways on page 271). appear correctly in RightFax documents created in email clients. After the mail server has been configured. Incoming faxes can be routed to an email mailbox by specifying each RightFax user’s mailbox information in Enterprise Fax Manager. optional modules. The mail server still requires some configuration to work with the gateway software. 262 Administrator Guide . The gateway can also provide notification of fax events via email. OpenText RightFax 10. converted into faxes. Installing the E-mail Gateway software The SMTP/POP3 email gateway is installed when you run the RightFax server installation. Each RightFax email gateway acts as a communication link between the RightFax server and your email server(s).Chapter 29: Using RightFax email gateways Installing the E-mail Gateway software Chapter 29: Using RightFax email gateways The RightFax server includes an email gateway for SMTP/POP3. Refer to the documentation for your email client for information on enabling UTF-8 encoding. The gateway periodically checks this mailbox for fax-bound email messages to forward to the fax server. Several common configurations for routing fax-bound email messages to this mailbox are outlined in the following sections. such as the Euro symbol. and transmitted.6 Feature Pack 2 Although the configurations vary. you can use your email client software as a fax client system. For example. Note that when using email gateways: l l You must create a new POP3 mailbox specifically for use by the gateway. Required information for outbound faxes does not apply to faxes sent via the email gateways. they are routed to the RightFax server for transmission.” When destination fax information is not found as part of the address. /fax=555-1212/name=Jane Doe@faxgate. The information in quotes is not interpreted as part of the address. If your SMTP server requires that you use this addressing method. using the same method used to provide descriptive names for standard email addresses.company. the RightFax addressing scheme is used. In this example. In these cases. For example. It is treated as descriptive information only. the name of the mailbox specified in the POP3 Mailbox Name box in the E-mail Configuration dialog box (where the gateway checks for outgoing faxes) is “faxgate. “/name=Jane/fax=5551212/” <faxgate@company. Many mail servers allow messages with addresses that match a specific pattern to route to a particular mailbox. intuitive as the dedicated domain method (Dedicated domain for fax-bound email messages on page 263). An address matching this pattern might look like this: Dedicated domain for fax-bound email messages This is typically the easiest configuration for email users to understand and for SMTP/POP3 mail client software to access. For example: Note This configuration is not compatible with the IETF addressing scheme.g. The email message is routed to the “faxgate” mailbox on the SMTP mail server.com Simple mailbox with description-area fax information In this configuration. Mailbox pattern-matching routing This addressing scheme has the advantage of not requiring a new mail domain. email users may not find it as OpenText RightFax 10. however. email users send all fax-bound mail messages to a specific domain (e. Fax destination information is specified in the description-area of the address string.6 Feature Pack 2 263 Administrator Guide .com> A new MX (mail exchanger) entry in the DNS server may be required to tell other computers what mail server handles messages for the new domain. fax-bound email messages can be addressed to the email gateway’s POP3 mailbox. If the messages contain valid fax addresses. the RightFax email gateway scans the descriptive information.Chapter 29: Using RightFax email gateways The RightFax email gateway for SMTP/POP3 can be set to recognize one of three addressing schemes for specifying outgoing fax information like the fax number and recipient name (see Using the RightFax addressing scheme on page 265). the pattern “fax=*” (meaning any mailbox that starts with text “fax=”) can be defined to route matching addresses to the email gateway’s POP3 mailbox on the SMTP server. you must use the RightFax addressing scheme (Using the RightFax addressing scheme on page 265). Important The SMTP gateway requires an SMTP server with open relay enabled. faxgate.com) and specify the pertinent fax information as the mailbox portion of the mail address (left of the @ symbol). All mail messages received at this domain must be placed in the POP3 mailbox specified in the POP3 Mailbox Name box in the Email Configuration dialog box. The RightFax email gateway periodically checks this mailbox for outgoing messages. /fax=555-1212/name=Jane
[email protected] Some SMTP mail servers allow very few configuration and routing options. For example: Create a domain on your SMTP/POP3 mail server that is dedicated to receiving fax-bound mail messages. In the following configuration examples. com> - 555-1212@<domain. Important For the SMTP gateway to correctly display characters such as the Euro symbol in the subject line and body text of the received email message. The SMTP/POP3 gateway supports three addressing formats: Simple SMTP Fax Addressing. Attached files are converted to fax images and appended to the fax.com The following table lists the characters supported by Simple SMTP Fax Addressing. RightFax-specific format. often misinterpreting it as part of the mail destination address. Space and tabs are removed.com> . and IETF. Which addressing scheme the gateway recognizes is specified in the SMTP/POP3 E-mail Configuration dialog box (see Adding and configuring email gateways on page 271). to send a fax-bound SMTP message to the fax number 555-1212 with a domain of RightFax.com> + +15551212@<domain. 5551212@RightFax. The RightFax email gateway looks for fax-bound email messages in a dedicated POP3 mailbox on the SMTP mail server. except the message must be specially addressed.com> A-Z ABCDEFG@<domain. the address format is: Note Attachments sent from Microsoft Outlook use a proprietary format that is not supported by the SMTP gateway. Using the Simple SMTP Fax Addressing scheme The Simple SMTP Fax Addressing scheme allows fax-bound email messages to be addressed using a format that is similar to standard SMTP addressing . Text entered in the body of the email appears as the body of the fax. OpenText RightFax 10. Sending a fax via SMTP/POP3 Sending a SMTP/POP3 message to a fax number is similar to sending email.Chapter 29: Using RightFax email gateways Sending a fax via SMTP/POP3 Although this method requires little configuration at the mail server.com.) Unsupported file attachments cannot be converted and will be ignored.6 Feature Pack 2 264 Character Example 0-9 0123456789@<domain. UTF-8 encoding must be configured as a system setting on each client computer that uses the SMTP gateway. many email client programs make it difficult to add descriptive information to an email address. Name. Text entered in the Subject box appears in the “Notes” section of the fax cover sheet. the client application must send data to the RightFax server using UTF-8 encoding.com> * 123*456@<domain. (For a list of supported file types.<fax number>@domain. If you need to send attachments from Outlook.com> & 5551212&1111@<domain. use the Microsoft Exchange module (available separately). Fax destination information must be included somewhere in the address of each message.Org@<domain.com For example. see File formats that convert to fax format on page 322.com> Administrator Guide .com> # #123456@<domain. the message will be discarded. Only the fax number and name elements are required. so a OpenText RightFax 10.com The last element of fax information must be terminated by either a forward-slash (/).6 Feature Pack 2 Using the IETF addressing scheme The IETF addressing scheme requires faxes be addressed in such a way that they are forwarded to a mailbox that is 265 Administrator Guide . In all cases. Use these rules to address fax messages using the RightFax addressing scheme: l l l l l l The following table lists all fax destination elements supported by the RightFax addressing scheme. Inc. AZ Each element of fax information (such as name and fax number) is separated by a forward-slash. the name and fax number for the recipient must be included as part of the address. or the end of the line. which is written as 20 in hexadecimal.comfaxgate@company. If a special character is required as part of a fax information element. /bi2= Billing code 2 /bi2=2222 /city= Recipient city. Except for the fax number. including spaces.com/fax=5551212/name=Jane/ com=Acme@faxgate. Element Definition Example /bi1= Billing code 1 /bi1=1111 The first forward-slash (/) encountered in the address indicates the beginning of the fax destination information. an ‘@’ symbol. If either element is not found.Chapter 29: Using RightFax email gateways Sending a fax via SMTP/POP3 space can be represented as %20. all of these addressing elements are used only for display on the fax cover sheet.company. How fax-bound messages are routed to this mailbox depends on how you configured the SMTP server (see Configuring SMTP/POP3 gateway installations on page 262). Example A fax recipient name and destination fax number are required.acme. it can be specified by using a percent symbol (%) followed by the ASCII value of the character expressed in hexadecimal. For example. the space character has the ASCII value of 32. /name=Jane/fax=5551212@faxgate. This encoding is only required if the special characters needed cause problems for your mail system. /com= Recipient company name /com=Acme. /fax= Destination fax number /fax=555-1212 /fax=555-1212&1111 /name= Recipient name /name=Jane Doe /voice= Recipient voice number /voice=555-4567 Addressing elements can appear in any order (the fax number can come either before or after the name). In addition. faxes must be addressed in such a way that they are forwarded to a mailbox that is dedicated to RightFax. Using the RightFax addressing scheme The RightFax addressing scheme allows a great deal of flexibility in how fax-bound email messages are addressed.com/na me=Jane/fax=5551212/name=Jane%20Doe/fax=5551212/faxgate@compan y. Addressing elements cannot be separated by the RightFax mailbox address itself. state /city=Tucson. This allows any character to be part of a fax information element. How fax-bound messages are routed to this mailbox depends on how you configured the SMTP server see Configuring SMTP/POP3 gateway installations on page 262.M. With the RightFax email gateways. In addition.bi2= Billing code 2 /dd. In Enterprise Fax Manager.Doe /s= Recipient last name (surname) /s=Doe Any invalid keywords included in the address will be ignored. The fax number can be followed by one or more optional keywords that provide additional fax information. RightFax users can receive faxes as email message attachments instead of (or in addition to) receiving them in their FaxUtil mailboxes. middle. /pn= Recipient name (separate first. and then click the The following table lists supported keywords for the IETF addressing scheme.company. and last name with a period) /pn=Jane /pn=Jane. Element Definition Example /dd.Chapter 29: Using RightFax email gateways Configuring users to receive faxes via email dedicated to RightFax. the name and fax number for the recipient must be included as part of the address.com/fax=5551212/pn=Jane. Example OpenText RightFax 10. The address must begin with the fax destination number. Inc.comfax=5551212 /g=Jane/s=Doe/
[email protected] Feature Pack 2 266 Administrator Guide . Use these rules to address fax messages using the IETF addressing scheme: l l l
[email protected]@faxgate. double-click the user to open the User Edit dialog box.Doe /pn=Jane.com Configuring users to receive faxes via email Only the portion of the address to the left of the domain name (everything to the left of the ‘@’ sign) is significant to the fax destination. To configure a user to receive faxes in email 1.bi1= Billing code 1 /dd.acme.bi1=1111 /dd.company.bi2=2222 /fax= Recipient fax number /fax=555-1212 /g= Recipient first (given) name /g=Jane /i= Recipient middle initial /g=M /o= Recipient company name /o=Acme. the notification goes to both the sender’s User ID and the SMTP gateway default User ID. To configure a user to receive fax notification in email 4. If the fax is held for preview or approval. In the File Format box. When sending faxes from the SMTP gateway. For information on each fax image format. The installed gateway is not required to be configured to send and receive faxes. click your email gateway type. It can still notify users. In the Routing Type box. 3. The notification method can be configured for a user group by editing the group ID properties in Enterprise Fax Manager and setting the group Notification Type to the option that corresponds to your email gateway type. Select the Delete After Routing check box only if you want to delete the fax from the user’s FaxUtil mailbox after it is routed to email.6 Feature Pack 2 267 Administrator Guide .g. In Enterprise Fax Manager. see File Format on page 113. If the fax fails for any reason.com).com. the notification goes only to the sender’s User ID. Email notification of faxes The RightFax email gateways can be used to notify users of fax status.. click the file format RightFax uses for the fax attachment.Chapter 29: Using RightFax email gateways Email notification of faxes Inbound Routing tab. it leaves the fax OpenText RightFax 10. For example: jdoe@acme. If the fax is sent successfully. 1. user@company. double-click the user to open the User Edit dialog box. and click the 5. In the Routing Info box enter the user’s SMTP email address (e. the notification goes only to the default User ID. The SMTP gateway requires that you set up a default user. If RightFax cannot route a fax to the destination email mailbox. notifications may be sent to either the default User ID or the actual sending User ID as follows: l l l 2. in the user’s FaxUtil mailbox regardless of how this option is set. Chapter 29: Using RightFax email gateways Embedded codes in mail messages Notification tab. it is ignored by RightFax and is included in your fax.6 Feature Pack 2 268 l ATDATE l ATTIME Administrator Guide . For example. Note Select Use PCL converter for text files if you are using embedded codes in your faxes. an embedded code that tells RightFax to send a library document called “PriceSheet” is written as: <LIBDOC:PRICESHEET> RightFax removes all embedded codes from the mail message when it converts it to fax form so they do not appear in your final fax.com. Embedded codes can be written in either upper or lower case. and more. click your email gateway type.com. between angle brackets. Click OK when you are done. attach library documents. In the Notification Address/Info setting enter the user’s SMTP email address in the format user@company. From the Notifcations about outbound faxes and Notifications about received faxes lists. choose the events that trigger notifications. type the code you want. along with any required parameters. Embedded codes in mail messages Embedded codes are special faxing instructions that you insert into fax-bound documents such as email messages. In the Notification Method box. If you type an embedded code incorrectly. add billing information. Embedded codes can be placed anywhere in the body of the mail message (they do not work in the Address or Subject boxes). OpenText RightFax 10. Embedded codes cannot line wrap and any embedded code statement that is so long that it wraps to a second line will be ignored. 2. For example: jdoe@acme. You can use embedded codes to include fax cover sheet information. 4. 3. To add an embedded code to an email message. The RightFax email gateways support the following embedded codes: 5. This number is zero-based. Switch to the \RightFax\Gateway folder and enter the following command: l IGNORE l LIBDOC (Same as LIBDOC2 in email gateways) l LIBDOC2 l NOCOVER l NORMAL l PREVIEW l PRIORITY l SAVE 1. Or.” the third email gateway is “gateway2. ” enter: Running the email gateway remotely By default. For descriptions and examples of each embedded code. and n is the number of the email gateway. You might not. l DELETEALL To run the gateway remotely l FCSFILE l FINE l FROMFAXNUM l FROMGENFAXNUM 2. Map a drive to the \RightFax folder on the fax server. each email gateway installs and runs on the RightFax server. so the first email gateway is “gateway. l FROMPHONE 4. smtpgateway-lpath-fdatabase-sgatewayn Where path is the directory path to the RightFax files.Chapter 29: Using RightFax email gateways Running the email gateway remotely l CHANNEL l COVER l DELETE increase the workload on your fax server. you may anticipate a very high volume of gateway traffic and do not want the added workload to interfere with the routine operation of your fax server. l FROMGENPHONE 3. open the Windows registry and check the Gateway keys under HKEY_ LOCAL_MACHINE\Software\RightFax\Gateway (64-bit: HKEY_LOCAL_MACHINE\Software\Wow6432Node\ RightFax\Gateway).” and so on.6 Feature Pack 2 smtpgateway -lr: -frfaxserv -sgateway 269 Administrator Guide . to start the Remote Gateway service process from drive R: (which is mapped to the RightFax folder on the fax server) using the RightFax Database module on the server “rfaxserv. want to OpenText RightFax 10. database is the name of the server containing the fax database. There are some situations where it is beneficial to run the email gateway on a different computer on your network. The E-mail Configuration dialog box opens. for example. To confirm the gateway number. Select the RightFax E-mail Gateway configuration in Enterprise Fax Manager.” the second email gateway is “gateway1. Select the Remote Email Gateway Service check box to enable remote operation. see RightFax embedded codes on page 310 For example. under the Source column “RightFax Email Gateway Module” for more details. open the Windows registry and check the Gateway keys under HKEY_LOCAL_MACHINE\Software\ RightFax\Gateway (64-bit: HKEY_LOCAL_ MACHINE\Software\ Wow6432Node\RightFax\Gateway). click the MS-DOS icon in the top left of the command window. Double-click the entry for a description of the error. This number is zero-based. Email gateway-related problems will appear on the log in the Source column as “RightFax Email Gateway Module. Example If you are running the SMTP gateway and it is your only email gateway. and then set Screen Buffer Size height to “2000. On the Start menu. it may be that the account being used to start the Email Gateway Module service does not have access rights to that folder.” and so on. click All Programs. The amount and type of information saved to the event log is determined by the LogLevel setting in the RightFax E-mail Gateway configuration in Enterprise Fax Manager. In the Event Viewer. Click Properties to open the Command Prompt Properties dialog box.Chapter 29: Using RightFax email gateways Troubleshooting the email gateways “gateway. To check for errors in the RightFax log 1. To run the gateway. Troubleshooting the email gateways If you experience problems with your RightFax Email Gateway module service.” your second email gateway is referred to as “gateway1.” 3. Click the Layout tab. smtpgateway-d-1 -sgatewayn Where n is the number of the email gateway. To set the command window to sufficient size. you must set the window properties to allow you to scroll back many lines.) Open a command prompt window and change to the RightFax\Gateway folder. Error 2140 Starting Service Error 2140 is a generic Windows NT based error stating that the service did not start. Running the gateway in a command prompt window also gives a very detailed report of gateway events. first check for errors in the RightFax log of the Windows Event Viewer. so your first email gateway is referred to as OpenText RightFax 10. To confirm the gateway number. With the log level set to terse. enter: smtpgateway -d -1 -sgateway 2. If the specified path is correct and valid.” When running the email gateway in a command window. To run the gateway in a command window. first make sure that the RightFax Email Gateway Module service is stopped (for information on stopping the RightFax services. then Administrative Tools. only critical errors are recorded. enter the following command: Error 53 This is a Windows NT based networking error which indicates that the UNC name that was specified for the Location of Mail Files in the gateway configuration is an invalid network path.”your third email gateway is referred to as “gateway2. and then Event Viewer. see Starting and stopping services on page 25. Log levels normal and verbose record more information which may help track down problems.6 Feature Pack 2 270 Administrator Guide . select RightFax from the Applications and Services Logs menu to open the RightFax log. Check the Event Viewer RightFax log. FROM message Specify a text string that appears in the FROM: field of messages placed into your system by the email gateway. Click each gateway in the list to view its configuration options. Error 85 The local device is already in use This is a Windows NT based networking error stating that the drive to which RightFax is trying to connect the UNC name that was specified for the Location of Mail Files. or API Files is already assigned. click Add Gateway to add a new gateway. be sure to select View 32-bit Control Panel Items in Control Panel.6 Feature Pack 2 271 Administrator Guide . Valid options are: OpenText RightFax 10.Chapter 29: Using RightFax email gateways Adding and configuring email gateways service in Enterprise Fax Manager. Adding and configuring email gateways To add or configure an email gateway 1. Note To view the RightFax control panel icons on x64 systems. l If no email gateway was configured during the RightFax server installation. You can install multiple email gateways with RightFax. If you already have one or more email gateways configured. Open the email Gateway configuration program. in Windows Control Panel. you can open the configuration program by double-clicking the RightFax E-mail Gateway General settings Click the General tab to begin configuration for all gateways. In the E-mail Configuration window. E-mail delivery direction Specify the type of messages the gateway processes. l 2. and each installed gateway is listed in the tree on the left. double-click RightFax E-mail Gateway. and then select the type of gateway to add. You can select the following options: l None. l Terse. l Normal.Chapter 29: Using RightFax email gateways Adding and configuring email gateways l Both. l Outbound without Notifications. SMTP settings Verbose.” l l Select TIF or PDF format. (for both inbound and outbound messages) Use FaxUtil user information l Inbound Only. No information is saved. Select this check box to use the information from the user’s RightFax account in place of the SMTP friendly name. Remote e-mail gateway service Select this check box if you are running the E-mail Gateway service on a computer other than the fax server. the Event Log can become full. Click the SMTP tab to enter information about the SMTP server. Caution If you leave this value set to “Verbose” for long periods of time. Records all significant events and is most useful for tracking and resolving problems. Depending on the information found in the user’s profile. Frequency Include fax with notifications Specify (in seconds) how often the gateway will check the mail system and the fax server for incoming or outgoing faxes to process.6 Feature Pack 2 272 Administrator Guide . Records critical errors only. a user name. or a friendly name appears in the From User Name field on cover sheets using the <from name> embedded code. Records errors and major events only. This option applies to notifications of successfully sent faxes and faxes that failed to send. set the Frequency at 30 seconds or higher. l Outbound with Notifications. See Running the email gateway remotely on page 269. OpenText RightFax 10. To avoid overloading system resources. Select the check box to include a viewable copy of the fax with these types of notifications and specify the format of the copy: Event LogLevel Specify the level of information logged in the Application Event Log under the service name “RightFax E-Mail Gateway Module. l Server Timeouts Specify how long the client will wait for a response from the email server by moving the slider to the right to increase the time or to the left to decrease it. Select First Page to include a copy of the first page only or All Pages to include a copy of all pages. an email address. which may prevent new events from being logged. click OK. Note To enable encryption. Port POP3 settings Defaults to 25. Use Default Click this button to return to the default settings of the Port 25 and Encryption Type of None. When the confirmation box appears. you must have first configured your email server for secure communication. The content of this tab is unavailable if the email direction is set to Inbound only. Enter the port number for your configuration. The server requires authentication Click this to activate the following authentication fields: OpenText RightFax 10. the standard for nonencrypted SMTP messaging. Email Subject You can customize the subject line of messages sent through the SMTP email gateway. Use the following variables: l ~1 = Remote ID l ~2 = Send channel l ~3 = Unique ID of fax l ~4 = ANI l ~5 = Fax status SMTP Server Name or IP address of the SMTP server. Encryption type Specifies whether the server is using encryption (TLS/SSL). Defaults to None. Log on using Select to enter SMTP Account name and Password. POP3 servers can be specified separately for each email gateway.Chapter 29: Using RightFax email gateways Adding and configuring email gateways l l Log on using the same settings as the incoming server Select to use the account name and password from the POP3 tab.6 Feature Pack 2 273 Administrator Guide . The standard port for encrypted messaging is 465. When the confirmation box appears. POP3 Server Name or IP address of the POP3 server. Encrypted only. Send APOP passwords as Choices are Auto. you must have first configured your email server for secure communication. click OK. Account name POP3 login name. Use PCL converter for text files Select this option to use the fax server's PCL conversion engine when converting email messages to fax format. Clear text only. Click this button to return to the default settings of the Port 110 and Encryption Type of None. This option is required to properly convert embedded codes in mail messages. You must use the IETF format when using the RightFax SMTP Gateway with Outlook 2010. Port Remove e-mail headers Defaults to 110. Maximum number of messages to retrieve Specify the maximum number of messages that can be processed at one time by the email gateway. the standard for non-encrypted POP3 messaging. Select this option to remove email headers before converting to fax format.Chapter 29: Using RightFax email gateways Adding and configuring email gateways Password password for the account above. Send through this user when e-mail sender is unknown Use Default If the sender does not have a RightFax account. Defaults to None.6 Feature Pack 2 274 Administrator Guide . OpenText RightFax 10. Specifies whether the server is using encryption (TLS/SSL). this option specifies a valid RightFax User ID that is used to send the fax. Enter the port number for your configuration. The standard port for encrypted messaging is 995. Use IETF fax addressing Encryption type Select this option to allow the fax server to recognize the Internet Engineering Task Force (IETF) fax addressing standard for encoding fax destination information as part of the SMTP email address. This conversion also usually produces more accurate fax images of ASCII text than the fax server's native document conversion engine. This option is not available if you have selected encryption (TLS/SSL). Note To enable encryption. The cover sheet will include the sender’s email address. you must make sure the Service Account also exists as an account within Novell. Gateway1. Sent/Received time ~1 = Date (in Windows locale format) and time (HH:MM) To customize the text of header messages To customize the subject line of the inbound message Click the Custom Messages tab.Chapter 29: Using RightFax email gateways Adding and configuring email gateways Custom messages Notification message Variable options When a fax is received as an email attachment or when an email fax status notification is received. Notification message Variable options Elapsed time ~1 = The total time that the fax spent being processed by the fax board displayed (MM:SS) ~2 = The fax channel used to send or receive the fax Inbound user ~1 = The RightFax user ID of the fax recipient ~2 = The fax recipient's routing code None sent N/A Page record ~1 = The range of page numbers successfully sent or received 2. a header is included in the mail message that provides details about the fax.). Edit FaxSubject to contain the information you want to appear in the subject line of inbound messages. The Select Service Account dialog box opens. ~1 = The result code and any accompanying text as reported by the fax board (These codes and messages may differ depending on your fax board type. Select service account Note If you are storing or accessing files on a NetWare volume. This dialog box lists all the 275 Administrator Guide . If you have more than one gateway..6 Feature Pack 2 1. Click Select Service Account.) To change the email gateway service account ~1 = The destination fax number ~2 = The destination remote ID OpenText RightFax 10. The options on this tab are the same for all email gateways. Received remote ~1 = Remote ID ID Result Sent remote ID All RightFax email gateways log on to the network as a service using a Windows NT based user account that you specify. Gateway2. Log on to the RightFax server using a Windows account that is a member of the local administrators group. Edit the Windows registry: 1. 3. Each message combines text with one or more variables and each has its own available variable options. 4.g. 5. Create a new REG_SZ entry called FaxSubject. each is represented by its own subkey (e. described in the following table. Close the Windows registry. etc. Open the Windows registry editor and browse to HKLM\software\RightFax\Gateway\Gateway. Click Load Users. To see the full list. see Gateway Registry Entries on page 354. If the email gateway is running on the same computer as the fax server. SMTP/POP3 gateway registry settings Some additional functions can be set by editing the Windows registry settings for the gateway. Enter the password for the selected user account in both the Password and Confirm Password boxes. 4. a new service called the RightFax Email Gateway Module is created. if the email gateway is running on a remote computer (see Running the email gateway remotely on page 269). Starting and stopping the gateway service After installing the gateway. 3. Click a user account in the list to automatically fill in the Domain or Workgroup and User Account boxes. However. This lists each user account in all domains on the network. Do not stop the RightFax Email Gateway module service manually. 5. Click OK to apply the new service account. you must start and stop the gateway service manually.6 Feature Pack 2 276 Administrator Guide . OpenText RightFax 10. the service is set to “Manual” and is automatically started and stopped by the RightFax Server service. 2.Chapter 29: Using RightFax email gateways Adding and configuring email gateways user accounts in a specified domain and selects the user account that the email gateway uses to log in to the server. After processing. Verify that fax tone detection has been activated on each UM Server that will receive fax calls.6 is a partner fax solution for Microsoft Exchange 2010 or later Unified Messaging (UM). Fax tone detection is deactivated by default in Exchange UM. Requirements l l l l Microsoft Exchange Server 2010 or later with the Unified Messaging role installed and configured. In the MSExchangeUM.6 Feature Pack 2 277 Administrator Guide .Chapter 30: Inbound faxing with Microsoft Exchange Unified Messaging (UM) Overview Chapter 30: Inbound faxing with Microsoft Exchange Unified Messaging (UM) Overview Configuring Exchange UM for faxing RightFax10. An IP Gateway installed and configured to communicate with the Exchange Server. Refer to your Microsoft Exchange documentation for information about creating the following items in UM: As Exchange UM detects fax calls. This section assumes that the Microsoft Exchange UM role is already installed and configured in your organization. change the EnableInbandFaxDetection setting from False to True.6. each fax is handed off to the Exchange UM server for delivery to the user. Brooktrout SR140 Transport installed and licensed on the RightFax server. l UM Dial Plans l UM Mailbox Policies l UM IP Gateway l UM IP Hunt Groups l UM-enabled Mailboxes This section describes the additional requirements to enable inbound faxing with Unified Messaging.config file located in the X:\Program Files\Microsoft\ExchangeServer\V14\Bin directory. OpenText RightFax 10. Fax tone detection RightFax 10. The email with attached fax TIFF image is placed into the Inbox as well as a new Search Folder called "Fax" in the recipient's Outlook mailbox. the calls are referred back to the IP Gateway from where they are routed to the RightFax server for processing. 2.6 Feature Pack 2 Configuring RightFax for Exchange UM 1. the connector will route a copy of a received fax to the user’s Outlook inbox in addition to any faxes delivered by UM based on the specified fax routing. If you prevent the dial plan from receiving faxes.19:5060. duplicate faxes may appear in the user’s mailbox. To facilitate authentication.<transport>" You can enable Exchange UM for doctransports such as Brooktrout FoIP boards. select the Enable Exchange 278 Administrator Guide . create a new partner receive connector on the Hub Transport server to which the RightFax server submits SMTP fax messages. the ability to receive faxes is activated. no users in the dial plan can receive faxes. For more information.18. see the RightFax Connector for Microsoft Exchange Administrator Guide. The connector adds inbound and outbound faxing through Microsoft Exchange. The Mailbox Policy configuration includes the RightFax server URI in the following format (include the quotation marks): Configuring RightFax for Exchange UM sip:<FQDN or IP of RightFax server>:<port>.microsoft. If the user is configured for routing inbound faxes to Exchange. Dedicated receive connector To enable and configure Exchange UM Fax messages sent to Exchange UM from the RightFax server must be authenticated.aspx UM mailbox policy Configure each UM mailbox policy to allow users with that policy to receive faxes. Port = The port on which the fax server listens (Default is 5060) Note If you are using the optional RightFax Connector for Microsoft Exchange.140). under Brooktrout and Advanced Settings. Configure the receive connector with the following values: OpenText RightFax 10. Partners l RemoteIPRanges: {RightFax server IP address} l requireTLS: False l EnableAuthGSSAPI: False Note For more information about creating receive connectors. In the left pane. click Exchange Unified Messaging. Dial plans Verify that each UM dial plan is enabled to receive faxes.Chapter 30: Inbound faxing with Microsoft Exchange Unified Messaging (UM) Note Restart the Exchange server for the changes to take effect.com/en-us/library/bb125159 (EXCHG. l Intended use: Partner l AuthMechanism: ExternalAuthoritative l PermissionGroups: ExchangeServers. Transport = The transport protocol (Default is UDP) Example "sip:172. In the right pane. see the Microsoft documentation at http://technet. The Dial Plan setting takes precedence over individual UM-enabled user settings. and OEM FoIP. SR140. By default.Transport=UDP" User mailboxes The ability to receive faxes can be enabled on an individual UM mailbox basis.17. Ensure that each Exchange mailbox is UMenabled and is enabled to receive faxes. click one of the following routing methods: OpenText RightFax 10. Domain The domain of the Exchange Server. Under Exchange UM Fax Routing. Route to RightFax User Only The fax will be placed into the recipient's fax mailbox on the RightFax server. User Account. Route to Both The fax will be returned to Exchange for delivery as an email and place a copy in the recipient's fax mailbox on the RightFax server. Under SMTP Authentication to Exchange Unified Messaging Server enter the Exchange server and authentication information: l l l Exchange Server Name or IP The address of the Exchange Server that has been configured for UM and inbound faxing.Chapter 30: Inbound faxing with Microsoft Exchange Unified Messaging (UM) Unified Messaging check box.6 Feature Pack 2 279 Administrator Guide . The fax will not appear in the user’s FAX search folder in Outlook. or accounting purposes. l l l Route to SMTP Email Only The fax will be returned as an email to Exchange for delivery to the FAX search folder in the recipient's email inbox. click User Account. The fax will not be stored on the RightFax server for tracking. To select a user from Active Directory. Password The user account and password hat will be used to authenticate all traffic from the RightFax server to the Exchange server. billing. 4. 3. users can click the Statistics link after logging on to the Web Client. configuration settings and security rights are stored until the user logs off or the connection idle time limit is exceeded. click the Configuration tab. OpenText RightFax 10. double-click RightFax Web Client. Software for the RightFax Web Client is installed on a Microsoft IIS server which may or may not be running on the same computer as the RightFax server. The RightFax Web Client keeps track of all the users logged on to the system by storing each user’s profile in a connection table. see the RightFax Installation Guide. Configuration settings Configuring the RightFax Web Client l To open the RightFax Web Client window l In the RightFax Web Client window. User-specific data such as fax and phonebook lists. For information about installing Web applications.Chapter 31: Configuring the Web Client Configuring the RightFax Web Client Chapter 31: Configuring the Web Client RightFax users can manage their fax mailboxes from a web browser using the RightFax Web Client. On the IIS server on which the Web Client is installed. in Windows Control Panel.6 Feature Pack 2 280 Administrator Guide . The Web Client converts HTTP-formatted requests into RightFax-formatted queries and replies. To see the information currently stored in the Web Client’s connection table. Additional fax servers Enter the names of additional fax servers separated by commas. l Normal Errors and major events only. Default fax server protocol Timeout (minutes) Specify the network protocol that the IIS server running the Web Client will use to communicate with fax servers. l Terse Critical errors only.6 Feature Pack 2 Specify the number of minutes that a Web Client session can remain idle before the connection is dropped. Caution Leaving the verbose log level for long periods of time can fill up the Event Log and may prevent new events from being logged." Note For logging to occur.Consider that even inactive sessions consume some of the Web server’s available memory and that many simultaneous users may slow down page load times for each user. OpenText RightFax 10. Web Client users will be able to select a fax server other than the default server when logging on to the Web Client. l None No information.Chapter 31: Configuring the Web Client Logging level Select at which level to log information in the Application Event Log under the service name “RightFax Web Client Module. either enable NT notification or ensure that the IIS user has permission to write to the event log. stop and restart the Web Server service. Use temporarily to track and resolve problems. l Verbose All significant events. 281 Administrator Guide . Server settings Connection settings Default fax server Maximum available connections Enter the name of the fax server that the Web Client will scan for authenticated user accounts. Note For changes to take effect. Specify the maximum number of concurrent Web Client sessions that will be allowed. Only users with an email address in their user account can reset their password. Lists that exceed this number will be split onto multiple pages. and billing code lists requested by users.6 Feature Pack 2 282 Administrator Guide . the user must provide their RightFax user ID or it’s associated email address. Select this check box to automatically empty the trash folder when users exit the Web Client. library document. Select this check box to give all users.Chapter 31: Configuring the Web Client Maximum list size Users can reset forgotten passwords Specify the maximum number of entries that will be displayed for fax. the option to reset forgotten RightFax passwords that prevent them from signing in to the web client. click the Clients tab. Empty trash folder each session By default faxes remain in the trash folder until it is manually emptied or until the aging limit is reached. Clients settings l In the RightFax Web Client window. except NT authenticated users. An email will be sent to the user ID’s email address containing a link to a page where the user can save a new password. To reset their password. phonebook. Reset the IIS server for the change to effect. OpenText RightFax 10. and then RightFax OpenText RightFax 10. Under BrookTrout in the left pane. Users dial in to the RightFax server to use RightFax’s automatic forwarding. click All Programs. and notification features to manage faxes. then Open Text. users can access their fax mailboxes via a touch-tone telephone. In Enterprise Fax Manager.6 Feature Pack 2 283 Administrator Guide . TeleConnect does not require a separate or additional installation to your fax server. 2. The TeleConnect menu of options includes: l Retrieve new faxes l Retrieve a catalog of faxes l Retrieve specific faxes from the catalog l Hear fax statistics l Change fax mailbox options Enterprise Fax Manager. 3. you must have a RightFax server installed and operational. click the name of the RightFax server to configure in the tree in the left pane. select Advanced Settings and TeleConnect. The DocTransport Configuration dialog box opens. Configuring TeleConnect To configure TeleConnect 1. you must also have a Brooktrout fax board with voice capability installed.The list of services appears at the lower-right pane of the window. On the RightFax server. 4. To run TeleConnect. double-click RightFax DocTransport Module. Because it uses digital voice prompts. printing. In the Service Name list.Chapter 32: Using TeleConnect to access faxes by phone Configuring TeleConnect Chapter 32: Using TeleConnect to access faxes by phone With the RightFax TeleConnect feature. on the Start menu. Do not include the channel in a hunt group unless all channels in that hunt group are dedicated to OpenText RightFax 10. (The Password setting cannot be blank. l Enable TeleConnect l Enables the TeleConnect module. they will connect to the TeleConnect system. and click the channel you want to dedicate under Global Board Settings in the left pane and enter the same four-digit value in the Channel Extension box. When users dial this number they will hear a tone or voice prompt to enter an extension. Routing Code/Channel Ext Specifies the routing code (such as DTMF extension or DID number) that will be assigned to TeleConnect. enter a unique four-digit number in this box. TeleConnect uses the same connection to send faxes back to the caller without having to initiate a second call. Causes TeleConnect to request the recipient’s fax number and initiates a separate call to send faxes. Teleconnect incurs no phone charges. To use TeleConnect to access RightFax via touch-tone phone.or two-call session. dialing the number may cause users to hear a fax tone instead of accessing the TeleConnect system. In this way. 284 Administrator Guide . Enter a unique four-digit extension in this box. Asks each user to specify a one. Requires the user to call from a fax machine. Call Type Specifies how TeleConnect will connect to the caller when faxes are requested. Users must be able to dial into this channel. rather than being received as an incoming fax. You can also turn on DTMF routing for a particular analog channel. To do this. Two Call. If you tell your users to enter this number when they hear the prompt. the channel will provide a fax tone and attempt to receive a fax. l One Call. Otherwise. When calls arrive on this extension they enter the TeleConnect system automatically.) TeleConnect uses these settings to identify the user when calling in to the system. If this number is not entered after a few seconds (depending on the DTMF timeout value). RightFax user setup If you have a bank of numbers dedicated to your fax server.6 Feature Pack 2 Prompt.Chapter 32: Using TeleConnect to access faxes by phone TeleConnect. you must assign one of the numbers to TeleConnect by entering the extension here. each caller must have a RightFax user account with unique numeric Voice Mail Subscriber ID setting and a Password. If you have only analog channels you must dedicate one of your fax channels to TeleConnect. It will play message 010. press 3. Toll-number prompt The default message file 010 says “For an English language menu. you can record your own language message files and save them to their own folders. any key will be accepted.” OpenText RightFax 10. or using the message recorder built into the Fax-on-Demand component of the Docs-onDemand module (if it is licensed and installed. add the TeleConnect registry keywords 900Enable(1) and 900Agree(#). refer to the RightFax Docs-on-Demand Guide. if the file exists. where # is a number 0 through 9 that the caller must press to respond affirmatively and continue with the call. add the TeleConnect registry keyword Multilingual(1). TeleConnect will play a message asking them to select the language they want. To enable toll-number support. Because selecting a language option is interpreted as an agreement by the 285 Administrator Guide . press 2. voicepath1 is the path to the local folder where the language files are stored. If TeleConnect cannot find the file it wants in the first folder. If the caller does not immediately agree to the charges.Chapter 32: Using TeleConnect to access faxes by phone Recording multilingual messages Multilingual support The TeleConnect module supports messaging in up to nine languages in addition to the English language default. The system will automatically hang up on anyone who has not pressed the agree button within the first 28 seconds of the call. TeleConnect will automatically cycle through every defined VoicePath entry. this file might say in Spanish “For a Spanish language menu. Toll-number support Your TeleConnect system can be set up on 1-900 and 1-976 toll-lines. You can record custom multilingual messages for TeleConnect using a third-party sound editor that supports the Dialogic OKI32 file format. and voicepath2 is an optional secondary folder path.” In VoicePath2.voicepath2). where # is a number 2 through 9 that the user presses to access alternate language files (English is automatically set to “1”). If this parameter is left blank. FCC requirements for toll-numbers state that callers may not be charged until a full minute has gone by. press 1. callers must be told how much they will be charged and they must agree to the charges. it will look in the second folder. During the first 30 seconds of the call.VOX from each VoicePath folder. Create a TeleConnect registry keyword for each additional language you want to support using the format VoicePath# (voicepath1. For information on creating TeleConnect registry entries see TeleConnect registry configuration on page 289. Fax-on-Demand plays the VoicePath prompts before the toll-number prompt. When multilingual support is enabled. When callers first dial into the system.) For information on using Docs-on-Demand to record prompts. To enable multilingual support. starting with VoicePath1 and ending with VoicePath0.6 Feature Pack 2 Note If you have both toll-number and multilingual support enabled. the line must be disconnected. Multilingual selection prompts After multilingual support is enabled.” In VoicePath3. it might say in German “For a German language menu. For information on creating TeleConnect registry entries see TeleConnect registry configuration on page 289. TeleConnect plays message file 306. If the caller doesn’t press a key or presses a key other than one specified by the 900Agree registry keyword. the line is disconnected.vox “You may begin recording after the beep. If the caller presses the key specified by the 900Agree keyword (or any key if the 900Agree value is blank). To ask the caller to enter an alphanumeric sequence (such as a name).” count.” Administrator Guide .a...” allque..” b. Press pound when finished.c. Requests for fax routing information are skipped if the caller requests that the fax(es) be sent back to the fax machine he is calling from using the same connection (the One-call option). message file 306 is followed OpenText RightFax 10. add the TeleConnect registry keyword AskAlphaNumeric(1). If you enabled AskAlphaNumeric only..” c. Requesting fax routing information If a fax is sent to a number that delivers faxes to several people (such as a public or hotel fax machine).d.vox “.b.vox “The mailbox and password combination you entered is not valid...vox “Invalid entry..vox “.. This prompt must be less than the 28 second limit to press the required agreement key.” catalog.VOX plays one time...6 Feature Pack 2 File name 286 badlogin.. All files in the RFBoard\Mainapp\Voices folder are listed in the following table along with their voice text.catalog. This message should explain how much the caller is charged.. Message file 306 is followed by message file 307.vox “. Voice prompt a. We will not send documents to that fax number. that he must be 18 years or older.. by message file 312. the system proceeds to the Main menu. make sure that toll-call information is included in your foreign language prompts.vox “... there may be a problem determining the fax recipient.” badfaxnum.Chapter 32: Using TeleConnect to access faxes by phone caller to accept the charges.. message file 306 is followed by message file 311.vox “.” catalogs.vox “... Voice prompt files are saved as Dialogic®OKI32 files (. Voice prompt files The TeleConnect module uses voice prompt files located in the RFBoard\Mainapp\Voices folder on the RightFax server. After toll-number support is enabled. Please try again... TeleConnect can be configured to ask the caller to enter a name or phone number to assist in routing. If either of these options is enabled.. If you enabled both AskVoiceNumber and AskAlphaNumeric.” To ask the caller to enter a phone number to assist with routing.vox “All of your queued faxes will be sent..vox files).catalogs. and ask him to press a key to agree to the charges.” beginrec.. These files can be customized in Fax-on-Demand (described in the RightFax Docs-on-Demand Guide) or using a third-party sound editor that supports the Dialogic OKI32 file format.vox ”..faxes with a total of.” d.. add the TeleConnect registry keyword AskVoiceNumber(1). message 020. If you enabled AskVoiceNumber only. For a complete list of TeleConnect’s message files refer to the next section.... press 3.ninety-nine.. If you change this.is not available.” faxtype...” fwdfax. press 2.vox n99.hundred.” “You may not enable fax forwarding to a network user because a destination user has not been specified. To disable fax forwarding.vox ”No entries detected.vox “Please enter your security code.” greeting. press the Star key. To hear fax mailbox statistics. We are unable to process your call..” nofwd.vox ”.. press the Star key.... To cancel changes. press 1.” million.vox “...vox “.vox “Your faxes are currently being forwarded to a network user.” docs. To reenter.vox “Invalid entry.vox “If this is correct..one. press 1.” ifcorrec.” n01.vox “Please enter the fax number to forward your faxes to.. press 2.vox fwduser.vox “You have no new faxes.” login1..” OpenText RightFax 10..” mainmenu.. press 1.Chapter 32: Using TeleConnect to access faxes by phone File name Voice prompt File name Voice prompt deliverif.vox faxnum. If not.million...” nonewfxs..vox “Your fax forwarding option is currently set to a network user..zero.” goodbye. To retrieve a list of all faxes.vox “Your faxes may not be automatically printed because a destination printer has not been selected.” login2.” fwdmenu.vox “.6 Feature Pack 2 287 Administrator Guide ..” notones.” invalid. press 3.vox ”. press 2..” .” faxes.“. press 2..vox “We are unable to queue your faxes for transmission. press 2. If you wish the fax delivered to a fax number.” noprinter. press 4.vox “.vox “To automatically forward your faxes to a fax machine..” fwdnous.” doc.vox “Please enter your mailbox number.vox ”..documents..” nonque. To quit. press 2.vox “.. Please try again.vox “Your faxes are not currently being forwarded.” fwdwarn. press 1.document..vox “To retrieve faxes.vox “Welcome to RightFax.... the leading enterprise fax server. If you still want to change this option....fax...vox “Your faxes are currently being forwarded to.. there will be no way to restore this setting over the telephone interface.vox “Enter your fax number and then press the pound key.” n00.vox “The fax server is not available." fax..” notavail..new. If not.” fwdfaxnm. press 1.” new.vox “. To change mailbox options.” hundred.vox “If you are calling from your fax machine..” isnotavail. Please try again.vox “Goodbye..vox ”Are you sure you want to delete this message? Press 1. To forward your faxes to a network user. page.are in process. To retrieve faxes by their ID number. press the Star key. For alternate notification options... press 3. press 2.25 second silence page.” ”To play back.” sil_250. press 1...vox “..vox 0.” ntfwarn.pages.outbound..vox “That..1 second silence sil_1000.vox “You have entered the maximum allowable fax IDs..” “... press 3.” rtvid2.. To return to the main menu. press the Star key.vox 0.vox “To enable alternate notification press 1...vox “You may retrieve up to..” rtvid1...” statmenu.received.” recmenu...” sntstat1..vox ntfenab.. For automatic printing options.. To disable alternate notification. For statistics on inbound faxes.” sntstat2.” ntfmenu.vox “Alternate notification to another network user is enabled. To save this message.” prnenabl..” rcvstat1. press 2.vox “. To record.” rtvmen.vox 1 second silence outbound...vox “Your faxes are not being automatically printed.vox ”. To cancel changes.6 Feature Pack 2 288 Administrator Guide .” someque...vox “To retrieve all new faxes.vox OpenText RightFax 10. To disable automatic printing.” prndisab. To return to the Main menu.. To cancel changes...vox “Enter the fax ID number and press Pound.vox “Your faxes are currently being automatically printed.vox “For automatic forwarding options. press 2.. To return to the Main menu. press the Star key. press 1.” sntstat3.star..” sntstat4.have been sent successfully.vox “Not all of your queued faxes will be sent due to an error... To retrieve a list of all faxes.vox “.. press 5.vox “You entered an invalid fax ID number. press Star.vox “. press the Star key.. press 1.” sil_100..vox “.this session. press 4.are abandoned.vox “..” rtvmax..vox “Alternate notification to another network user is disabled..vox “To automatically print your faxes.5 second silence pages.outbound faxes totalling.. and..received faxes totalling.” rcvstat2.vox “.vox “. To cancel changes.Chapter 32: Using TeleConnect to access faxes by phone File name Voice prompt File name Voice prompt ntfdisab. press 2.....pound.vox “You may not enable alternate notification because a network user to notify has not been selected.” pound..vox “Shared call beginning.” rtverr1. press 1. press 1.vox 0..vox “For statistics on outbound faxes.” prnmenu. To delete this message. press 3. press 2. press 2.vox “.” optmenu..” that.” thissess.” received.” star.” sil_500..vox ”.” onecall.vox “.of your received faxes have not been viewed or printed.. vox “You may request. keyword is one of the configuration setting keywords from the following table. limits the caller to 32 faxes per call. if you want to set up TeleConnect for DID extension 2000 so that it asks the caller to enter a return-fax number.. ` is the “grave” character located on the same key as the tilde (~).” If you want extension 2001 to have a limit of 25 faxes.” totaling..vox “You have. AskVoiceNumber True Ask caller for voice number.. The multi-string registry entries for TeleConnect use this format: Keyword Default Description 900Agree N/A 900 caller agreement sequence.... 900Enable False 900 telephone processing.6 Feature Pack 2 AskAlphaNumeric False Ask caller for alpha-numeric sequence.....totalling..vox “To proceed. the entry would be: 2000`CallType(0)`MaxErrors(3)`MaxFaxes(32)` The following table lists all available TeleConnect keywords.. The TeleConnect configuration registry entry is located at HKEY_ LOCAL_MACHINE\Software \RightFax\DocTransport\Transports\Brooktrout\TUI\Extensio ns (64-bit: HKEY_LOCAL_MACHINE\Software\Wow6432Node\ RightFax\DocTransport\Transports\Brooktrout\TUI\Extension s).vox “.vox “Please wait while the system retrieves your faxes. always send the faxes back to the originating number.” waitgen. Each channel dedicated to TeleConnect has its own configuration registry entry. and disconnect after only 2 errors. CallType Default call type: 0 0 = Prompt 1 = One-call 2 = Two-call 289 Administrator Guide . The phone number extension or DID channel assigned to TeleConnect is always the first entry..thousand.” waitcnt. AppType 0 Application type: extension`keyword(value)`keyword(value)`.vox “You selected.vox “.” youmay.. and includes the default settings (if any) and descriptions... 0 = TeleConnect 2 = One-Doc Poll Where extension is the phone number extension or DID channel assigned to TeleConnect.vox “. The extension and all keywords must be separated by a grave (`) character.vox “Please standby while we are processing your request. OpenText RightFax 10...” 2001`CallType(1)`MaxErrors(2)`MaxFaxes(25)` For example. TeleConnect registry configuration TeleConnect is configured primarily via multi-string (Reg_ Multi_SZ) registry entries..” toprocee..up to.Chapter 32: Using TeleConnect to access faxes by phone and value is an optional value setting for the keyword. the entry would be: youselec. and disconnects after 3 errors... File name Voice prompt thousand.” upto.” youhave. TeleConnect transmits this sequence just before hanging up.. The system searches sne or more voices folders to play a voice file. it is relative to the RFBoard folder. the caller is disconnected. the system attempts to use the billing codes from the source fax. TransferSequence N/A PBX transfer sequence. or you can retrieve a specific fax by specifying its TeleConnect ID number. If no billing codes are present in the source fax. DefaultBI2 N/A Default billing code #2 for two-call. MaxErrors 3 Maximum number of errors allowed (timeouts. voices. Dial the phone number that you specified in the Routing Code/Channel Ext. 290 Administrator Guide . VoicePath0 N/A Language #0 voice folder(s). MaxFaxes 32 The maximum number of faxes sent out in one call by TeleConnect. are used.Chapter 32: Using TeleConnect to access faxes by phone Retrieving faxes via TeleConnect Keyword Default Description Keyword Default CSID N/A CSID to use during a one-call transaction. MainApp\ The path(s) for voice prompt files. A TeleConnect ID is assigned to every outgoing and incoming fax processed by RightFax. the value specified here. A relative folder specification is relative to the DocTransport folder. TUILOG OpenText RightFax 10. It is a standard Brooktrout® sequence (TP!F. To access your RightFax mailbox with TeleConnect 1. Multilingual False Multilingual support enabled/disabled. If a fax is being forwarded from a user’s mailbox. etc. and that of DefaultBI2. box of the TeleConnect configuration (see Configuring TeleConnect on page 283). invalid doc numbers. After a fax is assigned a TeleConnect ID. Any recorded message is recorded to the first folder listed. the TeleConnect Main menu gives you the option of retrieving a list of all faxes in your RightFax mailbox along with their TeleConnect IDs. it uses the channel default. VoicePath DefaultBI1 N/A Default billing code #1 for a two-call fax TeleConnect. If blank. VoicePath2 – VoicePath9 N/A Language #2 voice folder(s) – Language #9 voice folder(s). If not blank. Folders are separated with a semicolon.6 Feature Pack 2 Description Retrieving faxes via TeleConnect When retrieving your faxes via TeleConnect you can choose to have all new faxes that have not yet been viewed or printed sent to a specified fax machine.) If this number is exceeded. If you don’t know the TeleConnect ID of the specific fax you want. Each fax’s TeleConnect ID appears when you receive notification of the fax’s arrival.WU%1234567890ABCD). TUIReportPath The path for TeleConnect reports. If a relative path-spec. it keeps that ID. 39 characters max. When the system prompts you. enter your RightFax password and press the pound key (#). To enter a space. A = 21 I = 43 Q = 01 Y = 93 2 = 20 B = 22 J = 51 R = 72 Z = 03 3 = 30 The TeleConnect main menu C = 23 K = 52 S = 73 Space = 02 4 = 40 The following table lists the options available from the TeleConnect main menu. you are placed in the main menu (described in the next section).6 Feature Pack 2 291 Administrator Guide .’ the caller would enter ‘72779673’. Entering alphanumeric data via touch-tone phone To enter an alphanumeric string (such as a recipient name for a cover sheet). you can enter alphanumeric characters by pressing the keys on the telephone keypad that the characters are on. You have 40 seconds to enter up to 60 digits. N. For example. enter your RightFax voice mail subscriber ID and press the pound key (#). enter each character by pressing the button for the character. for the word ‘PASSWORD. After TeleConnect validates your voice mail subscriber ID and password. press “02”. which decodes to a maximum of 30 characters. and O. For example. 5. When the system prompts you. 4. Any digit will work for the letters Q and Z. and alternate notification via TeleConnect. printing. To enter a number instead of a letter.= 12 6 = 60 F = 33 N = 62 V = 83 . The exceptions to this method are the letters Q (“01”) and Z (“03). OpenText RightFax 10. 3. then the position of the character on the button. D = 31 L = 53 T = 81 + = 11 5 = 50 E = 32 M = 61 U = 82 . = 13 7 = 70 G = 41 O = 63 W = 91 0 = 00 8 = 80 H = 42 P = 71 X = 92 1 = 10 9 = 90 [1] Retrieve Faxes [1] Retrieve all new faxes [2] Retrieve a list of all inbound and outbound faxes [3] Retrieve faxes by their TeleConnect ID The decoded sequence is used in the To: field on the fax cover sheet. If your RightFax password does not consist of numeric digits only. use position zero. automatic printing. you would press the “62” to indicate the second character on the number 6 button. To enter the letter “N”. [2] Retrieve a List of All Faxes Retrieve a list of all inbound and outbound faxes [3] Fax Mailbox Statistics Although you can enable automatic forwarding.Chapter 32: Using TeleConnect to access faxes by phone 2. and notification destinations in your FaxUtil mailbox. the telephone button “6” has the letters M. The following table lists all characters available via this encoding method. There may be additional prompts and messages depending on your system’s configuration. you must first configure the forwarding. Firefox 12 or later. Any Windows user can access the URL and view the status of the servers configured to appear on the Dashboard. WorkServers. If no servers have been added to the dashboard. Opera 12 or later. the Configuration page opens. To add a server.Chapter 33: RightFax Dashboard Configuring the RightFax Dashboard Chapter 33: RightFax Dashboard The RightFax Dashboard provides a view of RightFax server status in your Web browser. Configuring the RightFax Dashboard 4. To add or remove RightFax servers from the configuration 1. and DocTransports. For each server that should be viewable in the Dashboard. click Save. and then enter the Server OpenText RightFax 10. Browse to the Dashboard URL at http://RightFax server/dashboard or https://RightFax server/dashboard. the Password. Viewing the RightFax Dashboard The RightFax Dashboard is a web application that can be opened from any remote system using Internet Explorer 9 or later. Errors generated by Dashboard are logged in the Application Event Log. When the correct servers appear in the list. and Chrome 18 or later.6 Feature Pack 2 292 Administrator Guide . click +. The information is display-only and cannot be modified. click Edit server list to open it. To remove a server from the Dashboard. If it does not. Address (server name or IP address) and User ID. The Dashboard URL uses Windows authentication. and if used. Configuring the RightFax dashboard includes adding each RightFax server for which information should appear on the Dashboard. including detailed status information of services. click x to the left of the server address. you need to know its server name or IP address and the RightFax credentials. 2. 3. see Configuring the RightFax Dashboard on page 292. l Orange. WorkServers. • Orange. • Red. Note For nodes in a shared services environment the word (Node) appears after the server name or IP address. Server Shows the percentage of HD (hard drive) used and the percentage of CPU used. To add or remove a server from the list. click the server address link. The Server Details page opens. OpenText RightFax 10. 2. More than 90% of HD or CPU used. At least two items are not running.Chapter 33: RightFax Dashboard To view the Dashboard 1. Administrator Guide . Service is starting up or stopping. Services Shows the status of each service. l Red. l Orange. l Red. 80% to 89% of HD or CPU used. Less than 80% of HD or CPU used. The System Overview page of the Dashboard opens. All items are running. Service is running. The color coding is as follows: • Green. showing status information for all individual Services. WorkServers. One item is not running. 3. and DocTransports are running: l Green. Browse to the Dashboard URL at http://RightFax server/dashboard. Service is not running. and DocTransports. showing for each server whether the items under Services.6 Feature Pack 2 293 l Green. To view detailed information about a server. receiving. and disabled channels.Chapter 33: RightFax Dashboard WorkServers Pages Queued for Sending Shows the status of each WorkServer. Shows the total number of pages queued for sending. Channels Shows the total number of channels on the server. WorkServer is starting up or stopping. Receiving l Gray. l Dark blue. Disabled To view a chart of fax volume and channel usage history 1. DocTransport is not running. WorkServer requests. click Usage History. WorkServer is not running. The Usage History page opens showing a bar chart for fax volume for the previous 30 days and one for channel usage for the previous 24 hours. Idle l Red. The Shared Services Overview page opens showing the details for each node. OpenText RightFax 10. WorkServer is running. To view all nodes in a shared services environment DocTransports l Green. DocTransport is starting up or stopping. On the Server Details page. l Orange. A graph shows the WorkServer and Gateways work requests. select the server you want to view. To switch to a different server In the Change server list. The channels and work requests are sums of all nodes taken together. l Orange. with the actual numbers for each appearing below the graph. with the actual numbers for each appearing below the graph. Gateway requests. On the Server Details page. In the Refresh Interval (minutes) box. DocTransport is running. idle. l Green. l Red. l Red. The following color-coding is used: l Light blue. Work Requests Shows the total number of work requests. Sending l Purple.6 Feature Pack 2 294 Administrator Guide . To change the interval at which the dashboard is refreshed Shows the status of each DocTransport. A graph shows the sending. enter a number for the number of minutes. The following color-coding is used: l Green. click Overview of all nodes. OpenText RightFax 10.Chapter 33: RightFax Dashboard 2. hover over the bar. To return to the Server Details page. To view the value of a bar. A tooltip opens showing the actual value. click Server Details.6 Feature Pack 2 295 Administrator Guide . The receiving server registers its destination fax numbers with a cloudbased registry.6 Feature Pack 2 296 Administrator Guide . 3. Configuring the RightFax Internet Connector Transport 5. Click Next. Open a web browser and browse to http://www. This is not the SUID used to activate the RightFax10.rightfaxic. Creating a RightFax Internet Connector account 2. enter the email address that is the primary login for accessing the registered account.Chapter 34: RightFax Internet Connector Creating a RightFax Internet Connector account Chapter 34: RightFax Internet Connector The RightFax Internet Connector (RIC) is an optional module with which you can send faxes between trusted RightFax servers as secure peer-to-peer transmissions over the Internet. saving time and telephony expense. If you have not already installed Silverlight. complete the company name and address information fields. Registering the Fax System 5. If for any reason the transmission cannot be completed successfully over the Internet. the name you want displayed for the Administrator.6 system. The RightFax Internet Connector site uses Microsoft Silverlight v4. and if the number matches. 3. On the Administrator Details page. The receiving RightFax server reassembles the file and delivers the fax to the recipient associated with the destination fax number. Configuring the RightFax Internet Connector includes: 1.com/. The fax is broken into secure packets for transmission. The sending server checks the destination fax number against the registry. Configuring the connector in the RightFax Sync module 4. Configuring the RightFax Internet Connector Receiver 6. and at least one phone number. 4. Click Finish to send the entered information to OpenText RightFax 10. the transmission bypasses the telephone system and is sent over the Internet. On the RightFax Internet Connector . the fax is sent over the telephone system.Account Registration page. you are prompted to install Silverlight before continuing. Enabling the RightFax Internet Connector Dialing Rule 6. including the SUID (System Unique ID or System ID) you received from OpenText Fulfillment for the RightFax Internet Connector when you purchased the RIC option. Click Create an Account. 2. Creating a RightFax Internet Connector account To create a RightFax Internet Connector account: 1. In the Type list. select the check box. 3." 4.) Note The Sync module cannot be configured from a remote computer. 7. 3. Select a Schedule option and specify any required parameters.Chapter 34: RightFax Internet Connector Configuring RightFax Internet Connector in the RightFax Sync Module name for the source. To disable RIC synchronization. Click OK to close the Sync Mapping dialog box. Click Browse. specify the RIC Source and Destination: l Configuring the RIC source To specify the source. Click OK . enter a unique name for the destination. The synchronized fax numbers are stored as encrypted strings. The RIC Source is the cloud-based OpenText RightFax Internet Connector Registrar of verified fax numbers. and then click OK. (This file is in Rightfax\CapaSync\config. Click the link in the email and follow the instructions that appear to specify the Administrator password and complete the registration process. Click the General tab. In the Sync Sources and Destinations window. 6. In the Sync Mapping dialog box. 5. Select RICS<YourName> in the Source list. select Never. Navigate to the Default RIC Source to RightFax XSLT file and click Open. In the Type list. Select RICD-<YourName> in the Destination list. To add the RIC source and destination 1.6 Feature Pack 2 To specify the destination. double-click RightFax Sync Module. To synchronize immediately after the Sync Module Configuration window is closed. click the New button. OpenText. the destination name will appear preceded by "RICD-. 2. 1. click New. in the list of Service Names. 2. on the General tab. and then click OK. 8. 297 Administrator Guide . 7. enter a unique OpenText RightFax 10. select RIC Fax Delivery (Source). In the Mappings section. click New. l 4. In Enterprise Fax Manager. Creating the RIC source and destination The source name you enter here will appear on the tab in the Sync Module Configuration window preceded by “RICS-”. Configuring RightFax Internet Connector in the RightFax Sync Module Configuring the Sync mapping and schedule To configure the Synch mapping and schedule The RightFax Internet Connector uses the RightFax Sync module to maintain a local list of registered destination fax numbers. OpenText sends a verification email to the specified email address. click Sources & Destinations. In the Sync Module Configuration window. select RIC Fax Delivery (Destination). com/. 4. you must have configured the Sync module and generated a Registration Code. Enter your local Area Code. Click the Add New Fax System link on the right side of the Fax System Summary group. 3. please contact OpenText at FaxNumberVerification@OpenText. 7. 6. Click OK to save changes to the RightFax Sync Module Configuration. 5. 1. The Registrar URL is provided. Log into your RightFax Internet Connector account. Dedicated Receiver: The public access point is Administrator Guide . To register or update your fax server on the RightFax Internet Connector Web site. To force a synchroinization of all fax registered fax numbers. By default. click the Enable Receiver check box and indicate how the public access point of the receiver is configured. l l OpenText RightFax 10. When first entered. Click the RICS-<YourName> tab. The Sync module service restarts automatically. OpenText staff will retain these numbers in inactive status for future use. Select your Country Code from the list. To generate your registration code. Specify a Fax System Name and enter the Registration Code in the Activation Code field.Chapter 34: RightFax Internet Connector Registering the fax system To configure your system to synchronize with the registrar Note If your organization has purchased phone numbers for faxing but these numbers are not yet in use. 3. 1.6 Feature Pack 2 298 Shared Receiver: The public access point is created using the OpenText Microsoft Azure Subscription. Registering the fax system Before you begin the registration process. see Registering the fax system on page 298.com. the status will change to Verified and Active. select the Force synchronization of all numbers with the registrar check box. After OpenText verifies and approves the fax numbers. only recently added or modified fax numbers are synced. and Registration Code is initially blank. click Register Fax System. If this Fax System is also receiving faxes.rightfaxic. 2. For information about registering your fax system. To register the fax system 4. click Apply. each fax number appears as Non Verified and Inactive. 5. Open a web browser and browse to http://www. 2. See Configuring the Sync mapping and schedule on page 297. 2. and enter the lowest numeric fax number in the first text entry box and the highest numeric fax number in the second text entry box. expand RightFax Internet Connector in the list. click Save.6 Feature Pack 2 After installing the RightFax Internet Connector. For more information about dialing rules. 6. choose a country code from the box. a dialing rule is installed that. The fax ID is transmitted to remote fax machines to identify the sender. The CSV file must contain the fax numbers in the first column. l Intranet Receiver: Faxes are received through a selected TCP port on the RightFax Server. see Creating dialing rules and Least-Cost Routing plans on page 185 299 Administrator Guide . 4. The two entered numbers and all numbers between them are added to the system. The RightFax Internet Connector includes the destination fax number with each transmission. click Add Transport. choose a country code from the box. and click Peer to Peer Channels. Usually. this is set to your company name or general fax number. Configuring the RightFax Internet Connector transport 6. In Enterprise Fax Manager. and enter one fax number in the first text entry box. Click Add to show the number in the System Summary window. Click Close to save the modifications and return to the Account Summary screen. After specifying the Fax System properties. Click Range. OpenText RightFax 10.Chapter 34: RightFax Internet Connector Configuring the RightFax Internet Connector transport 8. Under RightFax Internet Connector. Add one or more fax numbers to the system in one of the following ways: l l l Click Single. created using your own Microsoft Azure Subscription. when enabled. and click Select. 3. Enter the Fax ID. Click Add to show the range of numbers in the System Summary window. In the Number of Digits for Routing box. 7. click Peer to Peer Device. Enabling the dialing rule Click Import and browse to a CSV file that contains the fax numbers you want to add. double-click RightFax DocTransport in the list of Service Names. To configure the RightFax Internet Connector transport in the RightFax DocTransport module 1. enter the number of digits from the end of the destination fax number that are used for routing received faxes. 5. routes outbound faxes to the RightFax Internet Connector Transport. On the DocTransport Configuration dialog box. On the DocTransport Configuration dialog box. To support numbers of other lengths. The Rule Edit window opens. in the Prepend this box. enter ^ [P2P. 4. click Save Dialing Plan. Right-click the P2P Dialing Rule and select Duplicate. The type of OpenText RightFax 10. 4. On the Number Adjustments tab. you must configure a receiver. Click the OK button to close the dialing rule. 6. On the File menu. 5. To create additional dialing rules 1.Chapter 34: RightFax Internet Connector Configuring the RightFax Internet Connector receiver To enable the dialing rule 1. you must create additional dialing rules. 2. Creating additional dialing rules The installed dialing rule only works with 12-digit fax numbers. On the File menu. Open the RightFax Enterprise Fax Manager and click Dialing Rules in the left pane. enter the appropriate country code (for example 01 for United States). Double click the dialing rule with +P2P in the Routing column to edit it. Click the Other tab and deselect the Rule Disabled check box. Open RightFax Enterprise Fax Manager and click Dialing Rules. Click OK. 2. in the Pattern box. Configuring the RightFax Internet Connector receiver To enable the RightFax Internet Connector to receive incoming faxes.10]+ (for a 10-digit number) or ^[P2P. click Save Dialing Plan. On the Matching tab. 3. 3.6 Feature Pack 2 300 Administrator Guide .7]+ (for a 7-digit number). To create new dialing rules for the RightFax Internet Connector. copy the existing dialing rule and make changes as needed. 5. l To configure the receiver For a dedicated cloud receiver. Click Configure. 5. 2. OpenText RightFax 10. 4.6 Feature Pack 2 301 Administrator Guide . 3. 1. Click OK . Enter the appropriate information for your receiver type: l l For an intranet receiver. The the RightFax Internet Connector Configuration window appears with the selected receiver type displayed. Enter the Service port number. no additional information is required.Chapter 34: RightFax Internet Connector Registering the fax system receiver was set when the Fax System was registered (see Registering the fax system on page 298). For a shared cloud receiver. no additional information is required. enter the information for your Windows Azure account. double-click RightFax Internet Connector in the list of Service Names. In Enterprise Fax Manager. and dialing rules in a SQL database (although fax images are stored separately as graphic files in the RightFax\Image folder). However.6 Feature Pack 2 302 Administrator Guide . you must change the connection string in one of three places: You can enable SSL encryption of the data sent between RightFax and Microsoft SQL Server. click the Advanced tab. at any time you need to make changes to your existing SQL installation. For more information. To edit the SQL connection. including information on faxes. double-click RightFax Server. this version of SQL does not include all of the tools and administrative capabilities as the full version. In the Server Configuration window.Chapter 35: Backing up and maintaining RightFax Changing the connection to the SQL server Chapter 35: Backing up and maintaining RightFax RightFax stores all of its data. see the Microsoft SQL Server documentation. or can be installed on an existing SQL server. The SQL connection string appears in It is strongly recommended that you do not make any changes directly to the RightFax SQL database. l RightFax Server configuration l DocTransport configuration l RightFax Remoting service To view your current SQL connection information The SQL Express server that is provided with RightFax includes all of the SQL functionality required by the RightFax software. In Windows Control Panel. 1. The SQL database connection can be modified if OpenText RightFax 10. You select where the SQL database is to be installed when you install the RightFax server software. 2. A complete schema of the RightFax database can be viewed using SQL Administrator. Changing the connection to the SQL server RightFax creates and links to a SQL database during installation. users. This database may be installed directly on the RightFax server. Open each application and locate the SQL connection string in the SQL Connection box. Click [. In the General SQL Connection String Editor window.6 Feature Pack 2 303 Administrator Guide . In the RightFax Server Database Connection String Editor window. choose the Authentication method. the SQL Connection box.] to the right of this box. Make sure that you set the same SQL connection properties in all of these applications before making the registry change described in the next section. 4.Chapter 35: Backing up and maintaining RightFax 2. Changing the SQL connection The steps for changing the SQL connection are the same in all three applications . enter the Server name. OpenText RightFax 10.. 3. click Modify.. To change the SQL connection 1. and specify a databse type. One server instance serves the database to clients (the principal server). you may also need to enter a User Name and Password. 6. 2. It also contains runtime support for applications using native-code APIs to connect to Microsoft SQL Server 2000. Requirements l l l You must be running RightFax 10. you can no longer use the RightFax interface to make changes to your SQL Server connection string. Stop the RightFax services and verify that SQL Server mirroring is working properly before proceeding to the next steps. or 2008. The other instance acts as a hot or warm standby server (the mirror server).0 or later. After you have enable mirroring. Enter the appropriate connection strings for your configuration as described in the following sections. repeat steps 1 through 5 . To enter connection string information for a redundant SQL connection. Note OpenText Customer Support cannot provide assistance with setting up SQL Server Database Mirroring. 5. Database mirroring maintains two copies of a single database that must reside on different server instances of a SQL Server Database Engine. Install the Microsoft SQL Server 2012 Native Client. Earlier versions of RightFax do not support this functionality. The Microsoft SQL Server Native Client (SNAC) must be installed on the RightFax server. To configure SQL Server database mirroring for RightFax: Enabling RightFax to use SQL Server database mirroring 1. you must stop the RightFax services and validate that the SQL Server database mirroring is working before you change any RightFax settings. Click OK.6 Feature Pack 2 HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\ RightFax\ADO SqlConnection 304 Administrator Guide . OpenText RightFax 10. You can enable RightFax 10. Connection string for 64-bit Windows using ADO Connections using the SNAC must be made to an instance of SQL Server that does not run on the same computer as RightFax. You can download the version of the Microsoft SQL Server 2012 Native Client that is appropriate for your version of Windows at the Microsoft Download Center. Database mirroring is primarily a software solution for increasing database availability. The new string appears in the SQL box. It is a single dynamic-link library (DLL) containing both the SQL Server OLE DB provider and SQL Server ODBC driver.0 and later to use SQL Server database mirroring. 2005. Enter each string as a single line with no carriage returns.Confirm that the SQL Server mirroring is working before modifying a RightFax setting. Modify your connection strings to use the SQL Native Client and to specify the SQL Server mirror (failover) instance. 3. however. depending on the configuration and state of the mirroring session.Chapter 35: Backing up and maintaining RightFax Enabling RightFax to use SQL Server database mirroring Depending on the type of authentication you choose. Important In the following procedure. Server=myServerAddress.Failover_ Partner=Bisbee. Driver={SQL Server Native Client 10.Initial Catalog=RightFax.Integrated Security=True.Initial Catalog=RightFax. You should be familiar with your organization's software backup tools and protocols before scheduling regular backups.Integrated Security=True Example Connection string for 32-bit Windows running ODBC Data Source=SEDONA. Connection string for 32-bit Windows using ADO Entry HKEY_LOCAL_MACHINE\SOFTWARE\RightFax\ADO SqlConnection Value Data Source=myServerAddress. This section provides instructions for backing up and restoring the RightFax server software and SQL database using Microsoft's OSQL command-line utility.Server=myServerAddress.0}.0}.Server=Sedona.Database=RightFax.Failover_ Partner=myMirrorServerAddress. Data Source=SEDONA.0}. Example OpenText RightFax 10.Integrated Security=True. OpenText does not provide support for third-party backup tools. HKEY_LOCAL_ MACHINE\SOFTWARE\Wow6432Node\RightFax\ODBC SqlConnection Example Value Driver={SQL Server Native Client 10.Database=RightFax.Failover_ Partner=Bisbee.0}.Initial Catalog=myDataBase.Failover Partner=myMirrorServerAddress. Trusted_Connection=yes.Database=myDataBa se.Initial Catalog=myDataBase.Database=myDataBa se. Trusted_ Connection=yes.6 Feature Pack 2 305 Administrator Guide . Trusted_Connection=yes.Server=Sedona.Failover Partner=Bisbee.Chapter 35: Backing up and maintaining RightFax Backing up and restoringthe RightFax server and database Value Data Source=myServerAddress.Failover_ Partner=myMirrorServerAddress.Failover Partner=Bisbee.Integrated Security=True HKEY_LOCAL_MACHINE\SOFTWARE\RightFax\ODBC SqlConnection Connection string for 64-bit Windows using ODBC Value Driver={SQL Server Native Client 10. The OSQL utility is automatically installed on your SQL server when you install either the full version of SQL or the SQL Express database provided with the RightFax server software. Example Backing up and restoring the RightFax server and database Driver={SQL Server Native Client 10.Failover Partner=myMirrorServerAddress. Backing up the server requires a separate backup storage device or software utility. Trusted_ Connection=yes. When SQL is installed. you should also back up the following registry keys: l l l Important If you upgraded from MSDE to SQL Server 2005 Express. you may see error messages when attempting to run OSQL backup and restore procedures. Password is the password for the specified user. For more information.So that your backup software does not cause any disruption or slowdown of the RightFax server. RightFax stores most of its data in a SQL database which is stored and maintained separately from the core server software. and for information on restoring from the backup. back up the \RightFax folder and all of its subfolders. Depending on how the RightFax server software was installed. Open a command prompt on the SQL server or on the RightFax server if you are using SQL Express. As a result. you should schedule backups only at night or during off-peak hours.6 Feature Pack 2 Where UserID is a SQL user ID with administrative access. this database may be on a separate SQL server on your network. the default user ID is “sa” and the default 306 Administrator Guide . To back up the RightFax server software. OpenText RightFax 10. Refer to the documentation for your backup software and/or Microsoft Windows for information on scheduling and executing periodic backups of your software and the registry. Navigate to C:\Program Files\Microsoft SQL Server\ MSSQL\Binn 3. HKEY_CLASSES_ROOT\RightFax HKEY_LOCAL_MACHINE\Software\RightFax (64-bit: HKEY_LOCAL_MACHINE\Software\Wow6432Node\ RightFax) HKEY_LOCAL_MACHINE\Software\RightFax Client (64-bit: HKEY_LOCAL_MACHINE\Software\Wow6432Node\ RightFax Client) To back up the RightFax database using OSQL 1. you must call OpenText Customer Support for assistance if you restore the RightFax server to a machine other than the one on which it was originally installed. and you must have a user ID and password with administrative access to the database. These errors are cosmetic and do not cause any loss in functionality. see Microsoft Knowledge base article 907284. A complete backup of the server can be performed at any time without shutting down the server or stopping the RightFax services. or a SQL Express database installed on the RightFax server computer. Because several RightFax configuration settings are stored in the Windows Registry. 2. To perform a backup of the RightFax database.Chapter 35: Backing up and maintaining RightFax Enabling RightFax to use SQL Server database mirroring Backing up and restoring the RightFax server Backing up the RightFax database All of the RightFax server files can be backed up using any standard disk or tape backup system. Enter the command: osql -UUserID-PPassword-HServerName Caution Because licensed RightFax features are tied to the name of the computer on which the software is installed. the MSDB database has not been upgraded. and ServerName is the machine name of the server where the database is located. you must know where this database is installed. The commands and parameters are case-sensitive.) To create a batch file for automating the database backup To automate the database backup at a scheduled time. The restore process may take several minutes.Chapter 35: Backing up and maintaining RightFax Enabling RightFax to use SQL Server database mirroring password is blank.6 Feature Pack 2 307 Administrator Guide . The backup process may take several minutes. default user ID is “sa” and the default password is blank. the OpenText RightFax 10. depending on the size of the database. and add the batch file to your Scheduled Tasks list in Windows Control Panel.bak’ [Enter] go [Enter] exit [Enter] 1. ServerName is the machine name of the server where the database is located. The commands and parameters are case-sensitive. (When SQL is installed. and ServerName is the machine name of the server where the database is located. enter the following command set: Restoring the RightFax Database To restore the RightFax database from a backup BACKUP DATABASE rightfax TO DISK = ‘C:\Backup\rightfax. 3. enter this command set: RESTORE DATABASE rightfax FROM DISK = ‘C:\Backup\rightfax. 2. (When SQL is installed. 4. osql -UUserID-PPassword-HServerName-Q“BACKUP DATABASE rightfax TO DISK = 'C:\Backup\rightfax.) The commands and parameters are case-sensitive.bak’” Where UserID is a SQL user ID with administrative access. the default user ID is “sa” and the default password is blank. On the command lines that follow. 4. you can create a batch file which executes the OSQL backup command. Password is the password for the specified user. Password is the password for the specified user. The batch file should contain only the following command: Where C:\Backup is the name of the folder where the backup file was stored. Enter the command: osql -UUserID-PPassword-HServerName Where UserID is a SQL user ID with administrative access.bak’ [Enter] go [Enter] exit [Enter] Caution This batch file overwrites any existing backup file in the target folder without prompting for confirmation. Navigate to C:\Program Files\Microsoft SQL Server\ MSSQL\Binn Where C:\Backup is the name of the folder where you want the backup file to be stored. On the command line that follows. and C:\Backup is the name of the folder where you want the backup file to be stored. This can be a local folder or a folder on any mapped drive on the network. Open a command prompt on the SQL server or on the RightFax server if you are using SQL Express. depending on the size of the database. exe. This is how the fax server is able to run reports on fax activity even when the fax images have been deleted. The length of time fax records of deleted faxes are saved before being purged can be customized for each RightFax group. 4. print jobs. Upon completion you can view a transaction log by clicking the Log tab. 1. When a user deletes a fax the fax record is saved and marked as belonging to a deleted fax. retries) from the database SQL Table Orphans Deletes orphaned records from the SQL table. To change the length of time RightFax keeps deleted fax records 3. Click the Basic Information tab. Using DBPurge To use DBPurge 1.6 Feature Pack 2 7. Log in to the fax server as an administrator. Billing Codes Deletes Billing Code entries from the database Work Requests Deletes queued Work Requests (notifications. l l Removing deleted fax records from the database is called “purging. On the left side of the DBPurge dialog. In the Days to Keep Deleted Fax Records box. 3. Conversion jobs. enter the number of days to keep deleted fax records.Chapter 35: Backing up and maintaining RightFax Purging deleted fax records from the database database Purging deleted fax records from the database l RightFax stores records of all faxes. 2.” To keep the fax database to a manageable size. The options are listed and explained below. Select the group ID to modify. Select the Preview button to view the total number of records to be purged. enter the records you wish to purge. 2. On the Open Server dialog. 6. Open the \RightFax\SharedFiles folder and doubleclick DbPurge. Purging fax records using DBPurge 5. Click the Purge button to begin purging fax records. RightFax purges deleted fax records after a set length of time. Run Enterprise Fax Manager and click Groups. l Faxes Deletes records of all faxes in the system l Deleted Faxes Deletes records of deleted faxes from the OpenText RightFax 10. DBPurge is database utility purges fax records from the RightFax database. 4. enter the RightFax server name followed by your account name and password. Click OK. 308 Administrator Guide . You may also choose the box to ‘Use NT Authentication’ if your RightFax account is linked to the account you are logged into your network with. even if users have deleted the faxes from their fax mailboxes. This account must have administrative access. exe searches the RightFax server for fax image files that do not have any references in the RightFax database. This can prevent older fax images from occupying too much hard drive space on your server. Syntax Note You cannot change the collation after RightFax has been installed. This feature is configured separately for each group (see The Aging and Archiving tab on page 127). Requires the -f and -u options.6 Feature Pack 2 309 Administrator Guide . Using Orphan. or their records can be restored in the RightFax database. You must include the double-quotes around the path if the path includes a space character. Option Function -a Restore all orphan image files to a specified RightFax user. Removing orphaned faxes Orphan. OpenText RightFax 10. orphan image files can be deleted from the server. Case sensitivity and Kana sensitivity collations are not supported and may prevent RightFax services from starting. The image files are called “orphans” because RightFax has no record of their existence and cannot access them.exe Command Line Options.Chapter 35: Backing up and maintaining RightFax Purging faxes from users’ fax mailboxes Purging faxes from users’ fax mailboxes RightFax includes a feature called automatic fax aging that you can use to delete fax images from users’ fax mailboxes after a certain length of time. orphan -fcomputer-i=path-uuserID [-a] [-n] [-z] The following table shows the Orphan. Example orphan -fjanescomputer i=c:\progra~1\rightfax\image -ujanedoe -a Supported database collations The RightFax database supports SQL Language and Accent sensitivity collations. -n Skip all prompts. -z Erase orphan file images from the disk. The Database and RPC services must be running when executing this utility. -i=path Specify the full path to the RightFax\Image folder. -u userID Specify the RightFax user ID that is assigned the recovered fax images. Orphan.exe is located in the RightFax\Database folder on the RightFax server. Automatic fax aging is only available if you have a RightFax Enterprise or Satellite server. Individual users can be excluded from automatic fax aging by checking the Excluded from Group Fax Aging permission in their RightFax user profiles (The Permissions tab on page 110). -fcomputer Specify the name of the RightFax computer that contains the user ID that is assigned the recovered fax images.exe. type the code you want. Note If the attachment is located on a client machine. and verify that RightFax has access privileges. <TOFAXNUM:555-1212> The fax server removes all embedded codes from a document when it converts the document to fax form. it will not behave as expected and the embedded code text itself will appear in your fax. see File formats that convert to fax format on page 322. extension. This additional file can be in one of over 45 of the most popular IBM and Macintosh native application file formats. Note If you send faxes via an SMTP gateway and use embedded codes. you must select the Use PCL converter for text files option in your email configuration. include fax cover sheet information. For a complete list of supported formats. you can also attach PostScript and PDF files. an embedded code that tells RightFax the destination fax number is written as: Adds a file to the end of the fax. attach library documents. Embedded codes that are followed by this envelope icon (+) are compatible with RightFax email gateways. and can be used in any document that accepts text characters. If you have licensed the RightFax PDF module. along with any required parameters. and directory. You should use the UNC to specify the file location (instead of a drive letter). OpenText RightFax 10. Embedded codes can be placed anywhere in the document that you are faxing. because the mapping or drive links may be different on the fax server and the computer where the fax originated. drive. add billing information. verify that the client directory allows sharing so that the server can access the remote file and copy it to the fax. including file name. insert your signature. so they don’t appear in your final fax. between angle brackets.Chapter 36: RightFax embedded codes Chapter 36: RightFax embedded codes Embedded codes are special faxing instructions that you insert into fax-bound documents. Specify the complete file path. and more. Embedded codes cannot line wrap and any embedded code statement that is so long that it wraps to a second line will be ignored. You can use embedded codes to address faxes. Embedded codes can be written in either upper or lower case.6 Feature Pack 2 310 Administrator Guide . ADDDOC Format <ADDDOC:file> To add an embedded code to a document. The specified file is not deleted after conversion. If you type an embedded code incorrectly. For example. you can also attach PostScript and PDF files. Maximum field length: N/A. and directory. Replaces the document containing this code with the specified file. You should use the UNC to specify the file location (instead of a drive letter). For a complete list of supported formats. The original specified file is deleted after it is faxed. This file can be in one of over 45 of the most popular IBM and Macintosh native application file formats. see File formats that convert to fax format on page 322. Note If the attachment is located on a client machine. ADDDOC3 Format <ADDDOC3:file> Maximum field length: N/A. Example <adddoc:x:\bin\xyz. Adds another file to the end of the fax. Each file will be appended in the sequence that the embedded code appears in the document. including file name. extension. because the mapping or drive links may be different on the fax server and the computer where the fax originated.tif> OpenText RightFax 10. Specify the complete file path. ensure that the client directory allows sharing so that the server can access the remote file and copy it to the fax. Example <adddoc3:x:\bin\xyz. If you have licensed the RightFax PDF module. The original specified file will be deleted after conversion. Example <adddoc2:x:\bin\123. Format <ADDDOC4:file> Replaces the document containing this code with the specified file. You should use the UNC to specify the file location (instead of a drive letter). This additional file can be in one of over 45 of the most popular IBM and Macintosh native application file formats. you can also attach PostScript and PDF files. and directory. If you have licensed the RightFax PDF module. Maximum field length: N/A.Chapter 36: RightFax embedded codes ADDDOC2 More than one ADDDOC code can appear in a document. verify that the client directory allows sharing so that the server can access the remote file and copy it to the fax. drive.tif> ADDDOC2 Format <ADDDOC2:file> Specify the complete file path. extension. you can also attach PostScript and PDF files. If you have licensed the RightFax PDF module. because the mapping or drive links may be different on the fax server and the computer where the fax originated.6 Feature Pack 2 311 Administrator Guide . This file can be in one of over 45 of the most popular IBM and Macintosh native application file formats. For a complete list of supported formats.tif> ADDDOC4 Note If the attachment is located on a client machine. including file name.tif> Example <adddoc3:\\server8\sys\bin\xyz. see File formats that convert to fax format on page 322. For a complete list of supported formats.tif> Example <adddoc:\\server8\sys\bin\xyz.tif> Example <adddoc2:\\server8\sys\bin\123. see File formats that convert to fax format on page 322. drive. such as “+7” representing one week from today. A colon separating hours and minutes is optional. if a fax is sent to the queue at 3:30 p. ensure that the client directory allows sharing so that the server can access the remote file and copy it to the fax.m. For example.6 Feature Pack 2 312 Administrator Guide . Valid fractions of an hour are 0. You must enter at least one digit before and after the decimal point. drive. You can enter fractions of an hour in six-minute increments.5 and 0.M. “+2” is two hours from now. The time can be relative or absolute: Note If the attachment is located on a client machine.3 are valid. Absolute dates specify the exact date to send the fax. Relative time is the number of hours or minutes from the current time. and 1. 1. Absolute dates must be written in one of these formats: MM/DD/YY. or P. For example. Rather. Example <ATTIME:10:00p> Example <ATTIME:+2> BILLINFO1 + Maximum field length: 10 characters Format <BILLINFO1:code> Example <ATDATE:9-15-99> OpenText RightFax 10. You should use the UNC to specify the file location (instead of a drive letter). Example <ATDATE:+2> ATTIME + Format <ATTIME:time> Maximum field length: N/A. tomorrow. l Example <adddoc4:x:\bin\xyz. because the mapping or drive links may be different on the fax server and the computer where the fax originated. Specifying a time between the current time and midnight will schedule the fax to send today.m. Maximum field length: 9 characters If no send time is specified with the ATTIME code. For example. and it contains only an <ATDATE:+1> code.9. MM-DD-YY. the send time defaults to “now” (the current time of processing). Specifying a time earlier than the current time will schedule the fax tomorrow. Schedules the fax to send at a specific time.tif> Example <adddoc4:\\server8\sys\bin\xyz. or MM-DD-YYYY. it will be scheduled to send at 3:30 p.50 and . and directory.Chapter 36: RightFax embedded codes ATDATE Specify the complete file path.1 through 0.3 are not valid. the fax becomes eligible for scheduling within 15 minutes of the specified time. and an “a” or “p” can be used to indicate A. The fax server does not send the fax at exactly the minute specified. including file name.M. Absolute time can be entered in 12-hour or 24-hour format.tif> ATDATE + l Format <ATDATE:date> Schedules the fax to send on a specific date. Dates can be expressed as relative or absolute: l l Relative dates give the number of days from today’s date. extension. leaving the other channels free for priority faxing. However. You would need to include both BILLINFO1 and BILLINFO2 to send the fax.6 Feature Pack 2 313 Administrator Guide . For example. embedded billing codes must comply with the billing code verification rules as set on the RightFax server (see Requiring billing codes on page 146). the server will still automatically print failed faxes. Maximum field length: N/A. and you want the fax to go out right away. You can also use this code to limit fax broadcasts to one channel only. if “Verify Billing Codes” is enabled and requires both billing codes. the server will not process requests for notification or automatic printing of sent faxes. In addition. if “Verify Billing Codes” is enabled and requires both billing codes. Although your server’s first fax channel is listed as number 0 (zero) in the RightFax DocTransport module. The DocTransport’s channel 4 is actually the fifth channel because channels begin numbering at zero. Using the <BROADCAST> code increases the interval at which the server polls for and returns status information. Fine-tunes the server for sending fax broadcasts to multiple recipients. Include this embedded code in the fax to eliminate unnecessary server processes and increase the speed at which a broadcast is sent. If the RightFax administrator has set up the system to require billing codes. a value of 0 in this embedded code indicates that the server should use any available channel. any channel you specify in this embedded code must be numbered one higher than the channel as it is listed in the DocTransport (i. You would need to include both BILLINFO1 and BILLINFO2 to send the fax.. For example.) Maximum field length: 15 characters Example <BILLINFO2:5555> Maximum field length: N/A BROADCAST Example <CHANNEL:3> Format <BROADCAST> OpenText RightFax 10. specify <CHANNEL:5> to use channel 4 as shown in the RightFax DocTransport.e. Note In order for a fax to be sent. a document sent that embeds only BILLINFO2 would not be sent.Chapter 36: RightFax embedded codes BILLINFO2 + Assigns a billing code to the fax. you must enter a valid billing code or the fax will not be sent. This code is useful if your organization uses one channel for priority faxing. if that option is selected. embedded billing codes must comply with the billing code verification rules as set on the RightFax server (see Requiring billing codes on page 146). Maximum field length: 15 characters CHANNEL Example <BILLINFO1:4444> + BILLINFO2 + Format <CHANNEL:channel#> Sends the fax only on the specified channel of the fax board. a document that embeds only BILLINFO1 would not be sent. If the RightFax administrator has set up the system to require billing codes. Format <BILLINFO2:code> Assigns a second billing code to the fax. For this reason. you must enter a valid billing code or the fax will not be sent. Note In order for a fax to be sent. This code overrides the default RightFax auto-delete setting. Maximum field length: N/A. but not send that page to the recipient. COVER Maximum field length: N/A + DELETEFIRSTPAGE Format <COVER> Format <DELETEFIRSTPAGE> Generates a RightFax cover sheet for the fax containing the code. Note If you’re using this code with mulitple fax recipients. The new events are useful when writing code to send the status of the fax to a user. to a database. Unless a cover sheet file name is specified using the <FCSFILE> embedded code. or to a host application. only one cover sheet will be generated. This code is typically used when it is easier to add a page to the end of a document than to insert production embedded codes into the print stream coming from the host. Use this code when you want to put all production embedded codes on the last page of a document. This code overrides the default RightFax auto-delete setting. Maximum field length: N/A DELETELASTPAGE DELETE Format <DELETELASTPAGE> + Removes the last page of the fax.Chapter 36: RightFax embedded codes COMPLETEEVENT Maximum field length: N/A COMPLETEEVENT DELETEALL Format <COMPLETEEVENT> + Enables complete events that can be serviced via the RightFax API. but not send that page to the recipient. the <DELETE> code must precede the <NEWDEST> code for each recipient. this code will use the default cover sheet file. OpenText RightFax 10. 314 Administrator Guide .6 Feature Pack 2 Maximum field length: N/A. Format <DELETEALL> Deletes the fax from the user's FaxUtil mailbox after it has been sent or sending has been attempted. Format <DELETE> Deletes the fax from the user’s FaxUtil mailbox after it has been successfully sent. Maximum field length: N/A. Removes the first page of the fax. This code is typically used when it is easier to add a page to the front of a document than to insert production embedded codes into the print stream coming from the host. Use this code when you want to put all production embedded codes on the first page of a document. If the user sending the fax containing this code is configured to automatically generate a cover sheet. If no cover sheet is generated by RightFax. If no cover sheet is generated by RightFax. Format <FINE> Converts the body of the fax using “fine” resolution (200 × 200 DPI). Maximum field length: 31 characters Example <FROMGENFAXNUM:(520)555-2345> FROMGENPHONE Maximum field length: N/A + FORMTYPE Format <FROMGENPHONE:phonenumber> Format <FORMTYPE:formID> Specifies the company’s general phone number to be placed on the RightFax-generated fax cover sheet.pcl. Format <FCSFILE:filename> Maximum field length: 31 characters Uses the specified file as the RightFax-generated cover sheet. this code will be ignored. Overlays the fax onto the specified RightFax form. Do not specify a directory path.PCL> Specifies the company’s general fax number to be placed on the RightFax-generated fax cover sheet. The cover sheet file must exist in the RightFax\FCS folder on the RightFax server and must end with the extension . this code will be ignored. Maximum field length: 15 characters Note The PCL Cover sheet code for this embedded code is <OPERATORNUM>. This is recommended only for faxes with detailed graphics or faxes that will be OCRed. If no cover sheet is generated by RightFax. This code overrides the default fax resolution set in the user’s FaxUtil mailbox. this code will be ignored. FCSFILE FROMGENFAXNUM + FINE + Note The PCL Cover sheet code for this embedded code is <GENERALFAXNUM>.6 Feature Pack 2 315 Administrator Guide . Example <FORMTYPE:LETTERHEAD> FROMFAXNUM Maximum field length: 31 characters + Example <FROMGENPHONE:(520)555-3456> Format <FROMFAXNUM:faxnumber> OpenText RightFax 10. Example <FROMFAXNUM:(520)555-1234> Maximum field length: 12 characters Format <FROMGENFAXNUM:faxnumber> Example <FCSFILE:MYCOVER1.Chapter 36: RightFax embedded codes FCSFILE + Specifies the sender’s fax number on the RightFax-generated fax cover sheet. Maximum field length: N/A LIBDOC l TONAME + l TOFAXNUM Format <LIBDOC:documentID> l TOCONTACTNUM Sends the specified RightFax library document instead of sending the document containing the code. Maximum field length: 21 characters Maximum field length: 31 characters Example <LIBDOC2:INFOPACK1> Example <FROMPHONE:(520)555-4567> NEWDEST IGNORE Format <NEWDEST> + Tells RightFax that you want to send this fax document to multiple recipients. this embedded code functions exactly the same as LIBDOC2. this code will be ignored. If no cover sheet is generated by RightFax. Specifies the sender’s name to be placed on the RightFaxgenerated fax cover sheet. each as a separate LIBDOC2 code. including the last one. this code will be ignored. Multiple library documents can be specified. each as a separate LIBDOC code. If no cover sheet is generated by RightFax. The <NEWDEST> code must appear after each and every destination. The <NEWDEST> code allows the following codes to be repeated in a document: Format <IGNORE> Causes all subsequent embedded codes to be ignored. Maximum field length: 21 characters Maximum field length: 59 characters Example <LIBDOC:INFOPACK1> Example <FROMNAME:Jane Doe> LIBDOC2 FROMPHONE + + Format <LIBDOC2:documentID> Format <FROMPHONE:phonenumber> Sends the specified RightFax library document in addition to sending the document containing the code.6 Feature Pack 2 316 Administrator Guide . Multiple library l TOCOMPANY OpenText RightFax 10. FROMNAME Format <FROMNAME:name> Important When used with email gateways. Specifies the sender’s phone number to be placed on the RightFax-generated fax cover sheet.Chapter 36: RightFax embedded codes FROMNAME documents can be specified. If the specified document ID already exists.6 Feature Pack 2 Maximum field length: N/A 317 Administrator Guide . but rather faxes one entire document to multiple recipients.LFWC> NEWLIB NOBODY Format <NEWLIB:libdocID. The ones sent to John and Mary uses their default save or delete preferences. L = LAN F = Fax on Demand W = Web C = Catalog Maximum field length: N/A. and not include a fax body document. Example <NEWLIBW:novpricesheet.description. Maximum field length: N/A. that library document is replaced. NEWLIB2 This code is not used to break one document into multiple faxes. Specify a new or existing library document ID and description.november_prices.LFWC> Automatically creates or updates a library document from the document containing the code. In addition. Example <NEWLIB:novpricesheet. a new library document is created. you can assign accessibility attributes for each document.Chapter 36: RightFax embedded codes l TOCITYSTATE l BILLINFO1 l BILLINFO2 NEWLIB document is created. OpenText RightFax 10. The one sent to 555-3006 overrides the preferences and saves the documents after being sent. The library document is automatically assigned accessibility rights based on the following flags: Note If you’re using this code with either the <SAVE> or <DELETE> embedded codes. See DELETE or SAVE. If no matching document ID exists. If no matching document ID exists. only the last occurrence of any of these embedded codes takes effect. that code must precede the <NEWDEST> code for each recipient. If the specified document ID already exists. a new library Tells RightFax to send only the cover sheet.november_prices> If <NEWDEST> is not used. The newly created library document is automatically assigned LAN accessibility only. Specify a new or existing library document ID and description. Format <NEWLIBW:libdocID. Maximum field length: N/A Example <TONAME:JOHN><TOFAXNUM:555-1234><NEWDEST> <TONAME:MARY><TOFAXNUM:230-5000><NEWDEST> <TOFAXNUM:555-3006><SAVE><NEWDEST> l l l l The above example sends the same fax to three different fax numbers. Any embedded codes in the document that are not used for the production of the cover sheet are ignored.description> Format <NOBODY> Automatically creates or updates a library document from the document containing the code. that library document is replaced. You can use as many as 21 <NOTE> codes in a single document if you want to enter multi-line comments.> Format <NOCOVER> Turns off automatic RightFax cover sheet generation for the document containing this code. Adds comments to your cover sheet. For more information. see COMPLETEEVENT on page 314. NOTIFY_ERROR Maximum field length: N/A Format <NOTIFY_ERROR> NORMAL + Notifies the sender when the fax is abandoned due to transmission errors using the Notification Info setting in the user’s RightFax user account. Format <NORMAL> Maximum field length: N/A Converts the body of the fax using “normal” resolution (200×100 DPI). The comments are not reformatted or line wrapped by RightFax. each code having up to 69 characters. NOCOVER Maximum field length: Up to 21 <NOTE> codes per document. Normal resolution faxes can be transmitted much faster than fine resolution faxes.6 Feature Pack 2 318 Administrator Guide . Format <NOTIFY_RETRY> Maximum field length: N/A OpenText RightFax 10. NOTIFY_OK Format <NOTIFY_OK> Notifies the sender upon successful transmission of the fax using the Notification Info setting in the user’s RightFax user account. Maximum field length: N/A NOSMARTRESUME Maximum field length: N/A Format <NOSMARTRESUME> NOTIFY_RETRY Disables the Smart-resume feature. saving time and phone charges. Maximum field length: N/A. + Example <NOTE:THE QUICK BROWN FOX JUMPS OVER THE><NOTE:LAZY DOG. This code overrides the default fax resolution set in the user’s FaxUtil mailbox.Chapter 36: RightFax embedded codes NOCOMPLETEEVENT NOCOMPLETEEVENT NOTE Format <NOCOMPLETEEVENT> Format <NOTE:text> Disables complete events. Specifies the length of time in minutes between retry attempts when transmission errors (such as a busy signal or human answered line) are encountered. This uses the Notification Info setting in the user’s RightFax user account. and High (H). Maximum field length: N/A Maximum field length: 2 numeric digits PRIORITY Example <RETRYINTERVAL:2> + SAVE Format <PRIORITY:priority> + Sets the priority of the outgoing fax. Specifies the number of times the fax will be retried after encountering transmission errors (such as a busy signal or OpenText RightFax 10. Allowed settings are: Low (L). This overrides any default auto-delete setting.Chapter 36: RightFax embedded codes PREVIEW Notifies the sender when a transmission error is encountered and the fax is being resent. the <SAVE> code must precede the <NEWDEST> code for each recipient. See . A value of 0 (zero) tells the fax server to use the system defaults.6 Feature Pack 2 Format <SIGNATURE:signatureID> 319 Administrator Guide . Example <PRIORITY:HIGH><PRIORITY:N><PRIORITY:LOW> Maximum field length: N/A RETRYCOUNT SIGNATURE + Format <RETRYCOUNT:#> Note Signature files are currently not supported in outbound PDF documents. Maximum field length: N/A Note If you’re using this code with mulitple fax recipients. If a user specifies high priority and does not have the “Can use high priority” permission. You must view the fax in FaxUtil and select Release from the File menu before it will send. Maximum field length: 2 numeric digits Maximum field length: N/A Example <RETRYCOUNT:3> PREVIEW RETRYINTERVAL + + Format <PREVIEW> Format <RETRYINTERVAL:#> Holds the fax for preview in your FaxUtil mailbox. Normal (N). the fax will be sent with “normal” priority. human answered line). Format <SAVE> Instructs RightFax to not delete the fax image from the user’s FaxUtil mailbox after being sent. see Creating signatures on page 132. TOALTFAXNUM Maximum field length: 31 characters Format <TOALTFAXNUM:faxnumber> Example <TOCONTACTNUM:520-555-1212> Specifies an alternate fax number that is tried if the server is unable to send the document to the primary fax number. See TOFAXNUM on page 320. but the full street address as well. Maximum field length: 21 characters Specifies the fax recipient’s company name for display on the cover sheet. the fax is failed by the fax server.Chapter 36: RightFax embedded codes SMARTRESUME Specifies a signature image to place in the document. it is only used if the primary fax number fails. Example <TOALTFAXNUM:520-555-1212> Maximum field length: 31 characters TOCITYSTATE Example <TOFAXNUM:520-555-1212> Format <TOCITYSTATE:city. INC. TOFAXNUM Format <TOFAXNUM:faxnumber> Maximum field length: 31 characters Specifies the fax recipient’s fax number for dialing and also for display on the cover sheet. Format <TOCONTACTNUM:phonenumber> Maximum field length: N/A Specifies the fax recipient’s voice number for display on the cover sheet. The signature is inserted into the document at the exact location of the <SIGNATURE> embedded code. This code can include not only the Format <TONAME:name> OpenText RightFax 10.> + Format <SMARTRESUME> TOCONTACTNUM Enables the Smart-resume feature. state> TONAME Specifies the fax recipient’s city and state information for display on the cover sheet. Maximum field length: 59 characters Example <TOCITYSTATE:TUCSON. city and state of the recipient.6 Feature Pack 2 320 Administrator Guide . This number does not appear on the fax anywhere. If you are not listed as an authorized user of the signature file. You can include an unlimited number of <SIGNATURE> codes in each document. AZ> TOCOMPANY Format <TOCOMPANY:company> Example <SIGNATURE:BOB> Maximum field length: 59 characters SMARTRESUME Example <TOCOMPANY:ACME. For information on creating and using signature files. 6 Feature Pack 2 321 Administrator Guide .Chapter 36: RightFax embedded codes UNIQUEID Specifies the fax recipient’s name for display on the cover sheet. To use an entry from another user’s RightFax phonebook. use the syntax: UserID!Entry Only published entries of other RightFax users can be referenced this way. Maximum field length: 59 characters Example <TONAME:JANE DOE> UNIQUEID Format <UNIQUEID:faxID> Specifies a unique ID for the fax instead of having one automatically generated by RightFax. Custom unique IDs can be used for external document tracking systems. Maximum field length: 15 characters Example <UNIQUEID:XYZ120396> OpenText RightFax 10. RightFax uses the corresponding fax addressing information to send the fax. If the name matches one of your individual or group RightFax phonebook entries. EXIF 322 Lotus 1-2-3 All versions .TXT ASCII text (7 & 8 bit) All versions . or turn it into a comment by preceding the file type with a comma in the whitelist.XLS .123 Lotus Wordpro All versions . this file contains all supported file types.JPEG Important For information about the software required to perform server-side application conversions (SSA).txt file (in the RightFax/bin directory) to determine whether attachments should be converted to fax format.G3 . By default.Chapter 37: File formats that convert to fax format Chapter 37: File formats that convert to fax format Before conversion.EPS The following table lists the supported software applications and document file formats that can be converted to faxes by the built-in conversion engine on the RightFax server.TXT Bitmap Windows versions .BG3 Common Extension Ami Pro All versions .HTM JPEG All versions .GIF HTML Versions through 4.JPG .DCX EPS If TIFF image is embedded . Application or file format .LWP Microsoft Excel Versions 2000 through 2010 .HTML Important Conversion of PDF attachments and Postscript requires the RightFax PDF module. These file types can be converted from their native format by sending as file attachments to a fax message or by using the Send To function in Windows G3 All versions .6 Feature Pack 2 All versions . Application or file format Supported versions Common Extension ANSI text (7 & 8 bit) All versions .txt file.0 . Conversions handled through PCL will always be processed.BMP Multi-page PCX Microsoft Fax .XLSX Administrator Guide . see About the RightFax Conversion Engine on page 88. To prevent a file type from converting. you can either delete the file type from whitelist. RightFax checks the whitelist. regardless of the white list contents.txt. Supported versions GIF .SAM OpenText RightFax 10. RTF XML All versions .PNG Post Script All versions .FRM .PPTX Visio All versions .EPS Text-based configuration files Varies by product .WPC TIFF CCITT Group 3 & 4 All versions .DOC Microsoft WordPad All versions .PPT vCard All versions .PS .VSD Microsoft Rich Text Format All versions .PCX Portable Document Format All versions (see note below) .DOCX .PDF Portable Network Graphic All versions . UTF-8E .WPC Microsoft Works Versions through 8.XML Microsoft Visio 2000 through 2010 .XPS MIME All versions .VCF .6 Feature Pack 2 323 Administrator Guide .TIFF Unicode Text UNI.0 .WPS Microsoft XML Paper specification All versions .TXT OpenText RightFax 10.VSD Microsoft Word (see note below) 2000 through 2010 .TXT .Chapter 37: File formats that convert to fax format Application or file format Supported versions Common Extension Application or file format Supported versions Common Extension Microsoft PowerPoint Versions 2000 through 2010 .TXT UUEncode No specific version . UTF-8.MHTML PCX bitmap All versions .FTP . You have received a new fax. RightFax could not connect with the remote (receiving) fax machine due to communication errors between it and RightFax. If you do not view or print the fax. Bad signature code The signature code is not recognized as a valid signature identifier because it is corrupt or does not exist. your group’s administrator is notified. You continue to be notified for one hour (or other period specified by your administrator). If the primary administrator does not print or view the fax. An outgoing fax is ready for previewing The fax you requested be held for preview has been processed by RightFax and is waiting in your FaxUtil mailbox. the group’s alternate administrators are notified. You continue to be notified for one hour (or other period specified by your administrator). A new fax has arrived from remote ID: (remote ID) Answer tone detected You have received a new fax. You must select Release from the File menu to start the sending process. OpenText RightFax 10. Call answered before one full ring RightFax did not receive a normal length ring-back signal from the phone company’s central office. If the primary administrator does not print or view the fax. 324 Administrator Guide . If you do not view or print the fax.Chapter 38: Error and status messages Chapter 38: Error and status messages This section describes error and status messages.6 Feature Pack 2 Can’t access scans RightFax can’t access the documents you scanned with the scanner. Bad phone number A new fax has arrived from remote ID: (remote ID) You entered an incorrect or nonexistent fax phone number. your group’s administrator is notified. Bad FCS information Incorrect information was entered on the cover sheet using the Fax Information screen or embedded codes. You specified a form that does not exist or is corrupt in the Fax Information screen or through embedded codes. the group’s alternate administrators are notified. A new fax has arrived for (user ID) which hasn’t been viewed or printed Bad formtype A member of the group for which you are the RightFax administrator or an alternate administrator has received a fax and has not viewed or printed it within the time configured for reminder notifications. You have attempted to send a fax to a Group II machine. Fax discarded Command timeout RightFax has tried to send your fax the required number of times (default=5 times) and each time the phone number was busy. possibly when the fax card waits for or sends a command (T30 protocol handshaking commands) and doesn’t get a response within a required period of time. possibly when the fax card waits for or sends a command (T30 protocol handshaking commands) and doesn’t get a response within a given period of time. (See the error listed for more information. or attempt to add invalid file types to the white list. The remote (receiving) fax machine’s phone line is busy. It has been forwarded to you by another user. This error typically occurs when you try to attach executable or password-protected files. Contact your administrator.) Conversion Error Record Attachment type PARTTYPE_BINARY is not allowed. RightFax deleted your fax job. possibly when the fax card waits for or sends a command (T30 protocol handshaking commands) and doesn’t get a response within a given period of time. Fax blocked from dialing phone number One or more dialing rules disallow sending faxes to the specified phone number.6 Feature Pack 2 325 Administrator Guide . Communications line failure The fax card was unable to make a valid connection with the remote machine. Fax number busy This is a timing related error. Fax to (name). FCS create failed The cover sheet of your fax could not be created due to a corrupt or incompatible cover sheet format.Chapter 38: Error and status messages Carrier not detected Duplicate RightFax did not detect a dial tone when it tried to dial out. Command time exceeded Equipment busy tone detected This is a timing related error. rather than a Group III machine. (error ) Your outgoing fax encountered the error listed. Command time too short This is a timing related error. An operation was attempted that is not currently supported by your fax card software. Fax to (name) abandoned. The default value is five tries. too many retries RightFax tries to successfully send your fax a specified number of times (determined by the administrator) stop trying. Conversion failed Function not implemented RightFax was unable to convert your document to Group III format. Dial failure or no dial tone G2 fax machine RightFax cannot detect a dial tone because there is a problem with the phone line or the fax card is configured incorrectly. OpenText RightFax 10. The fax is a duplicate. The signature and/or billing codes in your fax are being validated against the RightFax database. Invalid billing code You entered a billing code that is incorrect or does not exist. You have attempted to send a fax on a fax channel that does not exist. Loop current detected When RightFax attempts to go off-hook to send a fax. The unknown sound could be a human voice. Imaging error encountered. Illegal option in call Invalid embedded code This error occurs if an invalid parameter is given for one of several different commands. but did not detect a valid value for Loop Current. Human answered RightFax detected an unknown sound after it dialed the fax number.6 Feature Pack 2 The fax card looded for Loop Current before it attempted to dial the fax number. SEND. The fax card did detect current on the line. including: LOG. OpenText RightFax 10. XFER. DEBUG. This error occurs if an invalid parameter is given for one of several different commands. Info not complete You have not completed all the required fields (in the Fax Information screen or through embedded codes) for RightFax to send the fax. Illegal sig. It might also be a fax card configuration error. it finds that the phone is already off-hook. or line noise.Chapter 38: Error and status messages Held for preview In validation You specified in the Fax Information screen or through embedded codes that you want to preview this fax before sending it. You must select Release from the File menu in FaxUtil to start the sending process. DEBUG. including: LOG. use You included a signature in your fax that you are not authorized to use. Initial processing Illegal line number RightFax is checking your document for embedded codes and counting the number of pages in your fax. XFER. recording. SEND. Line in use Illegal parameter value RightFax was not able to send your fax because there were no outgoing phone lines available. but didn’t find any. 326 Administrator Guide . In conversion Loop current not detected RightFax is converting your document to fax format for transmission. This can occur when two devices are sharing a phone line and attempt to use it at the same time. You included a misspelled or nonexistent embedded code in your fax. fax abandoned Loop current failed RightFax was unable to convert your document to Group III format for transmission. OCR error An error occurred as a document was being sent to or was at the Optical Character Recognition module of RightFax. P2 was not detected at the end of training No answer at fax # Phone line problems The fax machine at the receiving end didn’t answer or a wrong number was dialed. In general. This is a training error indicating a performance problem with the fax server and the number of fax cards that it contains. The fax may have been sent. Protocol reject message This is a generic protocol error code that can have several meanings. but it may be difficult to read. Non-G3 modem detected Printing error RightFax has detected a non-Group III fax modem on the remote (receiving) fax machine. An error occurred during printing. No answer tone detected There was too much line noise for the fax to be transmitted correctly. 327 Administrator Guide . Network high and dry (no ring) The fax card does not detect any type of telephone interface available. This is especially prevalent in international calling when it can take up to a minute to connect to the remote station. OpenText RightFax 10. or an invalid fax number may have been dialed. This is a very serious error. and cannot communicate with it. This is a generic protocol error code that can have several meanings. your fax card is having difficulty talking to the remote fax machine because it is not getting the signals it expected in the appropriate time frame. In general. but the fax machine is not answering within the specified time.6 Feature Pack 2 Queued for OCR The fax has been queued and is waiting for the OCR module to convert it. There is a problem with the phone lines at the fax server.Chapter 38: Error and status messages Network congestion detected One of your outgoing faxes needs attention The network may be running inefficiently and causing traffic. Printing Your fax is printing. OCR in process Protocol timeout Your fax has been queued and is being processed by the OCR module. Contact your RightFax administrator immediately. OK RightFax successfully sent your fax over the phone lines. You did not complete all the required fields in the Fax Information screen or through embedded codes for the fax to be sent. Poor quality The phone is ringing at the destination. This does not guarantee successful receipt of the fax at its destination. your fax card is having difficulty talking to the remote fax machine because it is not getting the signals it expected. Training algorithm detected FSK Ringback.Chapter 38: Error and status messages Queued for printing Thermal record The fax has been queued and is waiting to be printed. Tx/Rx error Unknown error code Scheduling failed An error condition reported to RightFax from another device is not supported or not recognized. This might be because the receiving fax machine is off-line or unable to receive faxes. then busy condition The fax number dialed went off-hook and then went on-hook very quickly. recording. The sound could be a human voice. but it couldn’t be correctly queued to be sent. Ringback. If you specified a date and time to send the fax. Sig needs authorization Waiting for conversion You must be authorized to use the signature you included in your fax. Unknown status code An unknown status code has been returned to RightFax from your fax card. You recorded a fax that was sent or received on a conventional fax machine for database purposes only. Voice response to call Sending fax to (name) at (faxnumber ) RightFax detected a sound that it didn’t expect after it dialed the fax number. 328 Administrator Guide . Ringback signal detected A ring-back signal was detected in error.6 Feature Pack 2 RightFax is busy with another process and has queued your fax to be converted. but it was never answered. Your fax was converted correctly. RightFax waits to send it. Scheduled for send Unknown error Your fax was successfully converted to the RightFax Group III format and is now being sent to the fax card to await sending. generating a fast busy signal. This may be due to interrupting a call in process on a shared line or noise on a T1 phone line. This training error indicates a performance problem with the fax server and the number of fax cards it contains. OpenText RightFax 10. This transmission/reception error indicates that the receiving fax machine was experiencing difficulties or excessive line noise. Sending RightFax is transmitting your fax. Your fax is being sent to the name and fax number specified. This training error indicates a performance problem with the fax server and the number of fax cards it contains. An error condition reported to RightFax from another device is not supported or not recognized. or line noise. but no answer tone Training algorithm found on PN The phone rang at the destination. Chapter 38: Error and status messages Waiting to be sent The fax has not yet been scheduled for faxing. OpenText RightFax 10.6 Feature Pack 2 329 Administrator Guide . This does not guarantee successful receipt of the fax at its destination. or entered one that does not exist. Your outgoing fax contains an invalid billing code You have either not entered a required billing code. Your fax has been successfully sent to (name) at (faxnumber ) Your fax was successfully sent over the phone lines. Maximum events in queue The current maximum size of the internal event queue. their definition and if alerts can be generated for them: l Fax Server Statistics on page 330 l Database Statistics on page 331 l Workserver Statistics on page 333 l Gateway Statistics on page 334 l Local BoardServer Statistics on page 335 l All BoardServers Statistics on page 339 l RPC Server Statistics on page 340 l Paging Server Statistics on page 340 l Local Document Transport Server Statistics on page 341 Fax Server Statistics For information editing the properties of an alert. See the following for information about the statistics in the different categories. No Administrator Guide . Information version Version of the shared No memory map used by the fax server. (See The RightFax queues on page 16). OpenText RightFax 10. Time running The length of time since the No Fax Server service was last started. No Events in queue The number of events waiting to be processed by the fax server. For information about using Alerting and Monitoring. Activities can be viewed using FaxStat. see Editing Alert Properties on page 168.6 Feature Pack 2 330 Statistic Description Can trigger alert Newest activity index The total number of activities No since the RightFax Server module was last started. see Using the Alerting and Monitoring service on page 165. The statistics are divided into several categories with different statistics available for each.Chapter 39: Alerting and Monitoring Statistics Fax Server Statistics Chapter 39: Alerting and Monitoring Statistics You use the RightFax Alerting and Monitoring service to monitor and receive alerts about statistics relating to your RightFax server.exe. Administrator Guide . this is the current frequency measured as a percentage of the normal frequency. No OpenText RightFax 10. Specify the type of timed event in the Event Timer box. measured in ticks.Chapter 39: Alerting and Monitoring Statistics Database Statistics Statistic Description Can trigger alert Events processed The total number of events No processed by the fax server since the Fax Server module was started. No Database Statistics 331 Statistic Description Can trigger alert Information version Version of the shared No memory map used by the fax server to communicate with the RightFax database. No Total timed events by type Total number of timed events in the Fax Server event queue (described on 46). Number of activity records The total number of activity No records currently stored by the RightFax Server module. Activities can be viewed using FaxStat. Specify the type of timed event in the Event Timer box. Percentage of disk space The percentage of free drive Yes available on database space on the drive used for drive storing the RightFax database. Current frequency relative to original as percentage For events whose timing is dynamically scalable depending on fax server activity. Specify the type of timed event in the Event Timer box.6 Feature Pack 2 Statistic Description Can trigger alert Ticks remaining by type Time remaining before the Fax Server module fires a specified timed event. Specify the type of timed event in the Event Timer box. Activity The time and description of the specified activity number. Percentage of disk space The percentage of free drive Yes available on image drive space on the drive used for storing fax images.exe. No Frequency of timed events by type The frequency with which a No timed event is fired. Total Database commands processed Total number of API No commands performed by the database since the Database module was last started. OpenText RightFax 10. User ID of last Database The NT user account used command for the last database command. No Current Database operation The current database activity No by thread. Statistic Number of Database write failures The total number of errors Yes that have occurred during the read process since the Database module was last started. No File I/O thread info This statistic is reserved for future use.6 Feature Pack 2 Can trigger alert Client Database I/O type This statistic is reserved for future use. No Database server thread info This statistic is reserved for future use. Number of file I/O threads Total number of threads that No the Database module has managing files. No Current File I/O operation The current file activity by thread.Chapter 39: Alerting and Monitoring Statistics Statistic Description Can trigger alert Number of database threads Total number of threads that No the Database module has managing database queries and changes. Number of Database read failures Description 332 No Total Database bytes read The total number of bytes No read from the database since the Database module was last started. Total Database bytes written The total number of bytes No written to the database since the Database module was last started. Time last Database command took The length of time for the last Yes database command to be processed. No Number of File I/O open failures The total number of failed file Yes open commands by thread since the database module was started Administrator Guide . The total number of errors Yes that have occurred during the write process since the Database module was last started. Time running The length of time since the Database service was last started. No Last File I/O command The last file I/O API command performed on the database by thread. Last Database command Last RightFax API command No performed on the database by thread. Time last File I/O command took Statistic Delete requests processed The total number of deleted No faxes since the WorkServer module was started. OpenText RightFax 10. No CVL conversion requests The total number of CVL No processed things since the WorkServer module was started. File route requests processed The total number of faxes No routed to network directories since the WorkServer module was started. Archival requests processed The total number of fax archive functions since the WorkServer module was started. Total File I/O commands The total number of API No processed commands performed for file I/O since the Database module was last started.6 Feature Pack 2 Description Can trigger alert Newest activity index The total number of activities No since the RightFax WorkServer module was last started.Chapter 39: Alerting and Monitoring Statistics Workserver Statistics Statistic Description Can trigger alert Number of File I/O read failures The total number of failed file Yes read commands by thread since the database module was started Number of File I/O write failures The total number of failed file Yes write commands by thread since the database module was started Client File I/O type This statistic is reserved for future use.exe. No Administrator Guide . OCR requests processed The total number of faxes No that have been converted to text since the WorkServer module was started. No Conversion requests processed The total number of fax conversions since the WorkServer module was started. Workserver Statistics Statistic Description Information version Version of the shared No memory map used by the fax server to communicate with the WorkServer. Activities can be viewed using FaxStat. Can trigger alert Overlay requests processed 333 The total number of overlay forms generated since the WorkServer module was started. No Total File I/O bytes read The total number of bytes read from files by thread No Total File I/O bytes written The total number of bytes written to files by thread No The length of time for the last Yes file I/O command to be processed. The total number of network No messaging events using Postscript since the WorkServer module was started. No Activity The time and description of the specified WorkServer activity number.exe.6 Feature Pack 2 Gateway Statistics No 334 Statistic Description Can trigger alert Information version Version of the shared No memory map used by the fax server to communicate with the email gateway. Gateway type The type of email system that the gateway supports. Last request The last work request processed by the WorkServer No Postscript conversion requests processed Time for last command The length of time required to Yes complete the last command Queues being serviced The services that are being managed by the selected WorkServer. Activities can be viewed using FaxStat. Network Broadcasts is no longer functional with any of the currently supported Windows operating systems. No Time spent on current command The length of time that the WorkServer has spent processing the current command Yes Network broadcast requests processed InterConnect requests processed Description Gateway Statistics Can trigger alert The total number of fax No conversion using Postscript since the WorkServer module was started.Chapter 39: Alerting and Monitoring Statistics Statistic Statistic Description Can trigger alert Print requests processed The total number of printed No faxes since the WorkServer module was started. No Time running The length of time since the No WorkServer service was last started. OpenText RightFax 10. No Administrator Guide . The total number of faxes routed to other RightFax servers on the network via InterConnect since the WorkServer module was started. Activity records The total number of activity records currently stored by the RightFax WorkServer module. exe. The higher the number. Send queue depth Total number of faxes currently waiting to be transmitted. Activity records The total number of activity records currently stored by the RightFax Gateway module. No Activity The time and description of the specified activity number. Activities can be viewed using FaxStat. In such a case. No Num channels Total number of fax channels No supported by the local BoardServer.exe.Chapter 39: Alerting and Monitoring Statistics Local BoardServer Statistics Statistic Description Newest activity index The total number of activities No since the RightFax Gateway module was last started. RightFax sends the fax via the server with the highest availability index. Yes Availability index The relative availability of Yes the server’s fax boards. the more available the server for sending faxes. No Time running The length of time since the No Email Gateway service was last started. Can trigger alert Statistic Description Can trigger alert Time running The length of time since the local BoardServer service was last started. Yes Send pages depth Total number of fax pages currently waiting to be transmitted. Activities can be viewed using FaxStat. RightFax uses this value when an outgoing fax number has two equally weighted dialing rules that send it to two different servers. Channel type Shows whether the specified No channel uses a loop-start or DID line. No Local BoardServer Statistics Statistic Description Information version Version of the shared No memory map used by the fax server to communicate with the local BoardServer. Events processed The total number of events processed by the fax server since the Gateway module was started.6 Feature Pack 2 Can trigger alert 335 Administrator Guide . OpenText RightFax 10. or both. Routing code The routing code of the fax currently being received on the specified channel. OpenText RightFax 10. No Is currently sending Indicates whether the specified fax channel is currently sending a fax. No The total number of fax pages received by the specified channel since the BoardServer was last started. No Administrator Guide . No Current page The page number of the fax currently being sent or received on the specified channel.6 Feature Pack 2 336 Statistic Description Can trigger alert Total calls placed The total number of outgoing No calls placed by the specified channel since the BoardServer was last started. No The total number of fax pages sent on the specified channel since the BoardServer was last started. receive faxes. Current remote ID The remote ID of the currently sending or receiving phone line. No Is currently doing Docs on Demand Indicates whether the specified fax channel is currently doing Docs-onDemand.Chapter 39: Alerting and Monitoring Statistics Local BoardServer Statistics Statistic Description Capabilities Shows whether the specified No channel is set to send faxes. Is currently receiving Indicates whether the specified fax channel is currently receiving a fax. No Total pages sent Total pages received Total calls answered Can trigger alert The total number of incoming No calls picked up by the specified channel since the BoardServer was last started. ROM ID The ROM ID of the fax board No used by the specified fax channel. No State The current sending or receiving state of the specified channel. No Is currently doing TeleConnect Indicates whether the No specified fax channel is currently doing TeleConnect. Total hang ups The total number of incoming No calls on the specified channel that received a transmission error due to hang up since the BoardServer was last started. No Send info pages in fax Group faxes The current number of faxes No that are grouped for sending but have not yet reached the required number of pages.Chapter 39: Alerting and Monitoring Statistics Local BoardServer Statistics Statistic Description Can trigger alert Statistic Description Group threshold left The number of fax pages remaining before a fax grouping is sent. Send info bill code 1 The first billing code value No associated with the outbound fax currently being sent by the specified channel. Send info pages done The number of pages that have already been transmitted for the fax currently being sent by the specified channel. The number of pages in the No outbound fax currently being sent by the specified channel. Current compression Specifies the data No compression type being used for the currently sent or received fax. Send info to name The intended recipient’s No name associated with the outbound fax currently being sent by the specified channel. No No The sending phone number No associated with the outbound fax currently being sent by the specified channel. The RightFax user ID No associated with the outbound fax currently being sent by the specified channel. Estimated minutes left Send info phone number Send info user ID The estimated number of minutes remaining for the specified channel to send the current fax. Send info to company The intended recipient’s company name associated with the outbound fax currently being sent by the specified channel. OpenText RightFax 10.6 Feature Pack 2 337 Can trigger alert No No Administrator Guide . Pages in call Specifies the total number of No fax pages queued to be sent during the current call. Send info bill code 2 The second billing code No value associated with the outbound fax currently being sent by the specified channel. Current rate Specifies the transmission baud rate of the current call. Current operation The operation currently being No performed by the specified channel.Chapter 39: Alerting and Monitoring Statistics Local BoardServer Statistics Statistic Description Send info secure CSID The required CSID of the No receiving phone line associated with the outbound fax currently being sent by the specified channel. Activity counters start date The start date that was set for the “all-time” statistics.6 Feature Pack 2 Statistic Description Can trigger alert All time faxes received The total number of faxes that have been received since the activity counter start date. No No 338 Administrator Guide . All time pages received remotely The total number of fax pages that have been received from remote fax servers since the activity counter start date. All time pages received The total number of fax pages that have been received since the activity counter start date. OpenText RightFax 10. No All time pages sent The total number of fax pages that have been sent since the activity counter start date. Number of queued transmission checks The number of Doc Plus No faxes that need to have their status queried. Send info unique ID Can trigger alert The unique RightFax ID No associated with the outbound fax currently being sent by the specified channel. All time faxes received remotely The total number of faxes No that have been received from remote fax servers since the activity counter start date. No All time send attempts The total number of fax No transmission attempts since the activity counter start date. All time send attempts remotely The total number of fax No transmission attempts via remote fax servers since the activity counter start date. No All time pages sent remotely The total number of fax No pages that have been sent via remote fax servers since the activity counter start date. In such a case. No Board server name The computer name of the specified BoardServer. No Specifies whether the specified BoardServer is local or remote. Unique ID The unique RightFax ID for the specified BoardServer. RightFax uses this value when an outgoing fax number has two equally weighted dialing rules that send it to two different servers. the more available the server for sending faxes.Chapter 39: Alerting and Monitoring Statistics All BoardServers Statistics Statistic Description Can trigger alert Is server down Indicates whether the specified BoardServer service stopped. All BoardServers Statistics Statistic Description Can trigger alert Information version Version of the shared No memory map used by the fax server to communicate with the BoardServers. Yes Down time The time at which the specified BoardServer service was stopped. The higher the number. Image directory The directory used for storing No fax images by the specified BoardServer. No Availability index The relative availability of the Yes specified BoardServer’s fax boards. No Is server local No Pipe name The pipe used to communicate with the specified Boardserver. Yes Send pages depth Total number of fax pages currently waiting to be transmitted. Yes Number of channels The total number of hardware No channels on the specified BoardServer. Yes Number of board servers The total number of No BoardServer modules (local and remote) being accessed by the server. Send queue depth Total number of faxes currently waiting to be transmitted. OpenText RightFax 10. Down error The error code that was generated when the specified BoardServer went down. RightFax sends the fax via the server with the highest availability index.6 Feature Pack 2 339 Administrator Guide . No Commands processed The total number of API No commands performed since the RPC server was started. Yes Statistic Description Information version Version of the shared No memory map used by the fax server to communicate with the Paging server.6 Feature Pack 2 No Paging Server Statistics Can trigger alert No Open failures Bytes read Can trigger alert 340 No Administrator Guide . RPC Server Statistics Statistic Description Information version Version of the shared No memory map used by the fax server to communicate with the RPC server. Can trigger alert The total number of file open Yes failures since the RPC server was started. Time running The length of time since the RPC Server service was last started. No Send queue depth Total number of pages waiting to be transmitted. Read failures The total number of file read failures since the RPC server was started. OpenText RightFax 10. Bytes written The total number of bytes read since the RPC server was started. Last command The last file I/O API command performed on the RPC server. Pages sent via SMTP Total pages sent via SMTP since the Paging service was started.Chapter 39: Alerting and Monitoring Statistics RPC Server Statistics Statistic Description Can trigger alert Statistic Description Availability index time stamp The time at which the Availability index was last reported. No The total number of bytes No written since the RPC server was started. Yes Pages sent via modem Total pages sent via modem No since the Paging service was started. Write failures The total number of file write Yes failures since the RPC server was started. Time running The length of time since the Paging service was last started. Time for last command The length of time required to Yes complete the last command. Can trigger alert Yes Yes The computer name or IP No address of the current SMTP server. No Administrator Guide . Channel type Shows whether the specified No channel uses a loop-start or DID line. Time running The length of time since the local DocTransport service was last started. No Last modem fail code Current SMTP server The error code that was generated for the last failed modem transmission.Chapter 39: Alerting and Monitoring Statistics Statistic Description SMTP failures Local Document Transport Server Statistics Statistic Description Can trigger alert Total number of failed SMTP Yes connections since the Paging service was started. Last SMS fail code The error code that was generated for the last failed SMS connection. No Total number of failed SMS connections since the Paging service was started. Current SMS server No Modem page failures Total number of failed Yes modem transmissions since the Paging service was started. No Last SMTP error description The error message that was generated for the last failed SMTP connection. No Pages sent via SMS Total pages sent via SMS since the Paging service was started. The computer name or IP address of the current SMS (Push Proxy Gateway) server.6 Feature Pack 2 341 Statistic Description Can trigger alert Information version Version of the shared No memory map used by the fax server to communicate with the DocTransport. Last SMS error description The error message that was generated for the last failed SMS connection. Yes SMS failures Local Document Transport Server Statistics OpenText RightFax 10. Num channels Total number of fax channels No supported by the local DocTransport. Yes Last SMTP fail code The error code that was generated for the last failed SMTP connection. Last modem error description The error message that was generated for the last failed modem transmission. ROM ID The ROM ID of the fax board No used by the specified fax channel.Chapter 39: Alerting and Monitoring Statistics RPC Server Statistics Statistic Description Capabilities Shows whether the specified No channel is set to send faxes. Routing code The routing code of the fax currently being received on the specified channel. No Is currently doing Docs on Demand Indicates whether the specified fax channel is currently doing Docs-onDemand. No The total number of fax pages received by the specified channel since the DocTransport was last started. OpenText RightFax 10. Current remote ID The remote ID of the currently sending or receiving phone line. No Current page The page number of the fax currently being sent or received on the specified channel. or both. No Total pages sent Total pages received Total calls answered Can trigger alert The total number of incoming No calls picked up by the specified channel since the DocTransport was last started. No Is currently doing TeleConnect Indicates whether the No specified fax channel is currently doing TeleConnect. No The total number of fax pages sent on the specified channel since the DocTransport was last started. No State The current sending or receiving state of the specified channel. Is currently receiving Indicates whether the specified fax channel is currently receiving a fax. No Administrator Guide . Total hang ups The total number of incoming No calls on the specified channel that received a transmission error due to hang up since the DocTransport was last started. receive faxes.6 Feature Pack 2 342 Statistic Description Can trigger alert Total calls placed The total number of outgoing No calls placed by the specified channel since the DocTransport was last started. No Is currently sending Indicates whether the specified fax channel is currently sending a fax. Chapter 39: Alerting and Monitoring Statistics RPC Server Statistics Statistic Description Can trigger alert Statistic Description Group threshold left The number of fax pages remaining before a fax grouping is sent. Send info bill code 1 The first billing code value No associated with the outbound fax currently being sent by the specified channel. Current compression Specifies the data No compression type being used for the currently sent or received fax. Send info bill code 2 The second billing code No value associated with the outbound fax currently being sent by the specified channel. OpenText RightFax 10. Current rate Specifies the transmission baud rate of the current call. Estimated minutes left Send info phone number Send info user ID The estimated number of minutes remaining for the specified channel to send the current fax. Send info pages done The number of pages that have already been transmitted for the fax currently being sent by the specified channel. The RightFax user ID No associated with the outbound fax currently being sent by the specified channel.6 Feature Pack 2 343 Can trigger alert No No Administrator Guide . The number of pages in the No outbound fax currently being sent by the specified channel. Send info to name The intended recipient’s No name associated with the outbound fax currently being sent by the specified channel. Send info to company The intended recipient’s company name associated with the outbound fax currently being sent by the specified channel. No No The sending phone number No associated with the outbound fax currently being sent by the specified channel. Pages in call Specifies the total number of No fax pages queued to be sent during the current call. No Send info pages in fax Group faxes The current number of faxes No that are grouped for sending but have not yet reached the required number of pages. In such a case. RightFax sends the fax via the server with the highest availability index. Send info unique ID The unique RightFax ID No associated with the outbound fax currently being sent by the specified channel. No 344 Administrator Guide . Transport name Name of the current transport. Docs sent via transport Number of faxes sent by the No currently-selected transport Docs received via transport Number of faxes received by No the currently-selected transport Queue name Name of the queue. RightFax uses this value when an outgoing fax number has two equally weighted dialing rules that send it to two different servers. No Queue depth Total number of faxes currently waiting to be transmitted.Chapter 39: Alerting and Monitoring Statistics RPC Server Statistics Statistic Description Send info secure CSID The required CSID of the No receiving phone line associated with the outbound fax currently being sent by the specified channel. Current operation The operation currently being No performed by the specified channel. the more available the server for sending faxes. Yes OpenText RightFax 10.6 Feature Pack 2 Can trigger alert Statistic Description Can trigger alert Queue availability index The relative availability of Yes the server’s fax boards. The higher the number. 6 Feature Pack 2 DeleteImagesOnPurge on page 350 GatewayEnforceRequiredCoversheetFields on page 350 Notify_Freq on page 350 PageSrv_LogLevel on page 350 Porthand_LogLevel on page 351 PrescanTimeoutSeconds on page 351 QueueSize on page 351 ReceiveStampFontSize on page 352 ReceiveStampFormat on page 352 ReceiveStampLocation on page 353 StampReceivedPages on page 353 UseCompanyforCSID on page 353 UseReceiveStampUnique on page 353 WebDeliveryURLOverride AllowSubjectAsOwnAttachment on page 354 DoNotStripPlusSign on page 354 ExcludeHeaders on page 354 ExtraHeaders on page 354 IncludeHeaders on page 354 SkipEmptyAttachments on page 355 The section RightFax RightFaxRegistry Entries on page 355 describes the following values: 345 Administrator Guide . To make changes to the registry. you’ll need to use a tool such as regedit.Chapter 40: Registry keys and values Chapter 40: Registry keys and values Some RightFax functionality is defined using the Windows Registry. l l l l The section DocTransport Registry Entries on page 346 describes the following values: l l l l l l l l l l l l l l l l ANIStripCount on page 346 BlockedNumbers on page 346 BlockingFlags on page 346 Change (in SFC Key) on page 347 CheckDNISforNortelRouteCode on page 347 DIDWhitelistFilename on page 347 DisableDialingRuleOnTimeout on page 348 DoDigitalChanRoute on page 348 Entries (in ANI Key) on page 348 Extensions (in SFC Key) on page 349 HAF_CancelIfNoResponse on page 349 TTI_IncludeToNumber on page 349 ValidPatternChars on page 349 l l l l l l l The section Gateway Registry Entries on page 354 describes the following values: l l l The section FaxServer Registry Entries on page 350 describes the following values: l l l l l AllowMultipleGatewayNotifications on page 350 DBRecovery_Post_CheckLookEvent on page 350 OpenText RightFax 10.exe to manually find the registry key and add or modify the values in it. To block additional numbers. you can enable or disable the blocking function by setting BlockingFlags as follows: or. or partial number of each phone you want to block.6 Feature Pack 2 346 Administrator Guide . the information at the end of long ANI data strings may be truncated. HKEY_LOCAL_MACHINE\Software\RightFax\ DocTransport\Transports\Brooktrout BlockingFlags If you create a manual list using the BlockedNumbers registry entry. DocTransports blocks outgoing faxes to any number that begins with 911 (the standard emergency number throughout the United States). This function can also be performed through the RightFax interface with Dialing Rules as described in Editing dialing rules on page 186.Chapter 40: Registry keys and values l l l DocTransport Registry Entries Image on page 355 rpc_loglevel on page 355 TeleConnect Registry Configuration on page 355 ANIStripCount By default. edit the BlockedNumbers value to enter the prefix. Separate multiple entries with carriage returns. In some cases. The section WorkServer Registry Entries on page 357 describes the following values: l l l l l l l l l l l l l l l l l ControlPCLFileName on page 357 FileRouteRetryDelay on page 357 FileRouteRetryDuration on page 357 GhostDownScaleFactor on page 357 GSPostScriptCode on page 358 InterconnectSetTZ on page 358 KillServiceTimeout on page 358 PCL6_DeviceName on page 358 PCL6_DownscaleFactor on page 358 PCL6_FineMode_RParam on page 358 PCL6_GetResolutionFromPCL on page 358 PCL6_Normal_Mode_RParam on page 359 PCL6_TwoPass on page 359 PCL6AdditionalParams on page 359 PrintTimeReverse on page 359 ShrinkToView on page 359 UseReceiveStampUnique on page 359 Type: REG_DWORD Default: 0 (does not strip leading characters) BlockedNumbers By default. full number. for 64-bit: HKEY_LOCAL_MACHINE\Software\ Wow6432Node\RightFax\DocTransport\Transports\Brooktrou t OpenText RightFax 10. Type: REG_MULTI_SZ Default: blank (no numbers are blocked) DocTransport Registry Entries See also BlockingFlags to turn the blocking feature on or off. Use this value to specify a number of digits you want to remove from the beginning of the string (allowing the end of the string to be stored). 31 characters of ANI data are stored in the database. or Connecting a stand-alone fax machine to the RightFax server on page 142 for more information. set this entry to 1. To enable this feature. reset the Change value to “1” hex. The user dials into this extension from the fax machine (exactly how this is accomplished depends on your phone system) to access the RightFax server. set the Change value to “1” hex . Anything after a semicolon is considered a comment. stand-alone fax is not changed) Allow transmission to the 1 BlockedNumberslist and allow transmission to numbers starting with 911 Allow transmission to the BlockedNumbers on page 346 list and allow transmission to numbers starting with 911 See the value for Extensions (in SFC Key) on page 349to specify the extensions that match the Routing Codes for each stand-alone fax connector. or changed any of the stand-alone fax extensions). a RightFax user ID is created to host the Standalone Fax Connector and is assigned a unique Routing Code value (called the “Extension”). Create a text file with one routing code per line. When you OpenText RightFax 10. you may need to create it. You are responsible for manually maintaining this list of allowed DID. set the DIDWhitelistFilename to the UNC path and filename of a text file containing allowed numbers. the DocTransport returns the Change value to “0” hex. In each case. the fax is routed to the administrator. and prevents transmission to all numbers listed in the BlockedNumbers list Type: REG_DWORD Default: 0 (does not read extensions. for 64-bit. 2 Type: REG_MULTI_SZ CheckDNISforNortelRouteCode Default: 0 (blocks 911 and numbers on the BlockedNumbers list) To parse DNIS digits from Nortel CS1000 SIP invites. A cache of the file is maintained in case the file becomes inaccessible. or DTMF routing codes.Chapter 40: Registry keys and values Data DocTransport Registry Entries want RightFax to read the values again (if you added. or. DNIS. The Change value is part of the Registry subkey SFC located at HKEY_LOCAL_MACHINE\Software\RightFax\DocTransport\ Transports\Brooktrout\SFC. if a call is received for an unknown routing code. If a call is received that is not on the list.After it is read. Change (in SFC Key) Type: REG_DWORD Default: 0 (Nortel route codes are not parsed) There are several ways to connect a stand-alone fax machine to your RightFax server.6 Feature Pack 2 347 Administrator Guide . Ordinarily. removed. If this subkey does not yet exist. DIDWhitelistFilename You can restrict incoming fax calls to a specific list of fax numbers. that call will not be answered. Value Prevent transmission to anything starting 0 with 911. HKEY_LOCAL_ MACHINE\Software\ Wow6432Node\RightFax\ DocTransport\Transports\Brooktrout\SFC). If the time To force the DocTransport to read the Extensions value. Save this file in a location accessible to the DocTransport service account. To enable a digital fax board for use with channel routing.1111 to route all calls from numbers starting with 520 to the RightFax user account with the routing code 1111. Default: 60 (the number of minutes the P2P rules are disabled) l DoDigitalChanRoute l By default. Example An organization with 4-digit routing codes makes the following entries in the ANI subkey: Type: REG_DWORD l 5551212 to block all calls from 5551212.9999 to route all calls from 5553333 to the RightFax user account with the routing code 9999. You can use a complete number or enter a partial number followed by an asterisk (*) to block or route all calls from numbers that start with the specified numbers: Type: String Default: blank (does not restrict calls) DisableDialingRuleOnTimeout l This value enables Fax Over IP Failover in a multi-router environment. the server will automatically reload the new version. There is no limit to the entries you can make. HKEY_LOCAL_MACHINE\Software\ Type: REG_DWORD Default: 0 (does not route faxes based on channel) OpenText RightFax 10. To change the length of time to wait before enabling P2P rules again. To enable FoIP. To block calls. enter one of the following: ANI partial ANI* Type: REG_DWORD To route calls. enter one of the following where the ANI number is followed by a comma and then the routing code of the RightFax user account to which to route the faxes: Default: 0 (the Failover is not enabled) ANI.6 Feature Pack 2 5553333. set this value to the desired number of minutes. channel routing (where incoming faxes are routed by the channel on which they arrive into the RightFax system) does not work with digital fax boards.routing code l If a fax cannot be sent through the RightFax Internet Connector. for 64bit. l 520* to block all calls from numbers starting with 520. you must also set the dialing rules as described in Configuring Fax over IP failover on page 78. set this value to 1. 520*. the P2P rules are disabled for 60 minutes. Entries (in ANI Key) You can block or route faxes based on ANI (or DNIS) number.Chapter 40: Registry keys and values DocTransport Registry Entries and date on the file changes. Faxes are sent over the telephone lines. The Entries value is part of the Registry subkey ANI located at HKEY_LOCAL_ MACHINE\Software\RightFax\DocTransport\ANI or. 348 Administrator Guide . To configure FoIP.routing code DisableP2Prules partial ANI*. set the DisableDialingRuleOnTimeout value to 1. you may need to create it.Chapter 40: Registry keys and values DocTransport Registry Entries Wow6432Node\RightFax\DocTransport\ANI). The Extensions value is part of the Registry subkey SFC located at HKEY_LOCAL_ MACHINE\Software\RightFax\DocTransport\ Transports\Brooktrout\SFC. enter one value for each Extension. See Creating dialing rules and Least-Cost Routing plans on page 185 for more information on Dialing Rules. or Connecting a stand-alone fax machine to the RightFax server on page 142 for more information. a RightFax user ID is created to host the Standalone Fax Connector and is assigned a unique Routing Code value (called the “Extension”). stand-alone fax is not enabled. To add additional symbols such as a comma or period to the list of supported characters. If this subkey does not yet exist. tilde [~] and slash [\] keys. Within the SFC key. parentheses. or spaces in the pattern string. If this subkey does not yet exist. for 64-bit. Data Type: REG_MULTI_SZ Default: blank. The values must match the Routing Code value set in each dedicated RightFax user ID. set the HAF_CancelIfNoResponse value to 1. possible in FoIP configurations. see Blocking calls and handling spam on page 200 and Routing inbound faxes on page 220 Type: DWORD Extensions (in SFC Key) Default: 0 (does not cancel the fax) There are several ways to connect a stand-alone fax machine to your RightFax server. By default. and the wildcard characters plus [+]. TTI_IncludeToNumber To include the "To" address on the TTI line without using quickheaders. HAF_CancelIfNoResponse To cancel a fax transmission if a human voice is detected. RightFax ignores any hyphens. as well as the pound [#] and asterisk [*] keys. everything after and including the "@" is truncated. or. OpenText RightFax 10. HKEY_LOCAL_ MACHINE\Software\ Wow6432Node\RightFax\ DocTransport\Transports\Brooktrout\SFC). Type: REG_DWORD Default: 0 (does not change the TTI line) ValidPatternChars Dialing rules are entered as a string of characters and wild cards. you may need to create it. In each case. separating multiple entries with a carriage return. The user then dials into this extension from the fax machine (exactly how this is accomplished depends on your phone system) to access the RightFax server. The headerID and the word "PAGE" are removed. the pattern can include the digits 0–9. "TO:" and the fax number appears (up to 32 characters).6 Feature Pack 2 Type: REG_DWORD Default: 0123456789*#+~\ 349 Administrator Guide . see Configuring the Human Answered Fax feature on page 73. For more information. set this value to 1. add the characters to the end of the ValidPatternChars value. Type: REG_MULTI_SZ Default: blank (faxes are not routed anywhere) For more information. See the value for Change (in SFC Key) on page 347to specify when RightFax should read in new extensions. If the To address includes an "@" symbol. A value of “1” generates notifications for each document. l Terse Critical errors only. FaxServer Registry Entries FaxServer keywords are HKEY_LOCAL_MACHINE\Software\RightFax\FaxServer Type: REG_DWORD or for 64-bit: Default: 0 (if the DWORD is in the key. To configure RightFax to immediately delete fax images. Delete option for External Document Connector in server configuration to Disabled. PageSrv_LogLevel DeleteImagesOnPurge Specify the event log level for the Page Server module: By default. Type: REG_DWORD Type: REG_DWORD Default: 5 (notifications sent every 5 minutes) Default: 1 (notifications are sent). To send a second notification to the email address configured on the notficiations tab of the default user. required coversheet information does not apply to outbound faxes that originate from email gateways. AllowMultipleGatewayNotifications Each user can customize notifications about failed faxes. By default.6 Feature Pack 2 350 l None No information. A value of “0” does not send notifications. set this entry to 1. RightFax will retain the image files of faxes that have been deleted from FaxUtil until all corresponding database records have been removed. To enforce coversheet field requirements when sending from an email gateway. Administrator Guide . Type: REG_DWORD Type: REG_DWORD Default: 0 (disabled. OpenText RightFax 10. set this value to 0. only the sending user gets this type of notification. Set this value to “0” to prevent large databases with many documents from taking a long time to complete the DBRecovery cycle. GatewayEnforceRequiredCoversheetFields By default.Chapter 40: Registry keys and values FaxServer Registry Entries Note To use this option when also using the XML Generator module.) Default: 0 (does not send duplicate failed notifications) Notify_Freq DBRecovery_Post_CheckLookEvent By default. See Reminder notifications settings on page 33. Required cover sheet information is not enforced for faxes that originate from an email gateway.) HKEY_LOCAL_MACHINE\Software\Wow6432Node\RightFax \FaxServer) After adding the registry values. If the DWORD is not in the key. the RightFax server sends periodic notifications to users every five minutes. set the Forward. set this value to 1. Route. The Notify_Freq value specifies the number of minutes between notifications. stop and start the RightFax server for the settings to take effect. the default system behavior is to retain the images. the default is to delete images. 2 Normal. the RightFax internal event queue has a limit of 2000 events. Records errors and major events only. 351 Administrator Guide . No information is saved. OpenText RightFax 10. 3 Verbose. Records all significant events and is most useful for tracking and resolving problems. Records all significant events and is most useful for tracking and resolving problems. 1 Terse. Records critical errors only. Type: REG_DWORD Default: 0 (no time out. l Terse Critical errors only.Chapter 40: Registry keys and values l l FaxServer Registry Entries Normal Errors and major events only. Action PrescanTimeoutSeconds Porthand_LogLevel l Value By default. Type: REG_DWORD Default: 0 = None Type: REG_DWORD Default: 0 = None Value Action 0 None . 3 Verbose. Caution Leaving the verbose log level for long periods of time can fill up the Event Log and may prevent new events from being logged. No information is saved. Caution Leaving the verbose log level for long periods of time can fill up the Event Log and may prevent new events from being logged. Records errors and major events only.6 Feature Pack 2 0 Prescanning very large Print-to-Fax files for embedded codes can cause the RightFax server to appear unresponsive. l Normal Errors and major events only. 2 Normal. Records critical errors only. Verbose All significant events. Use this entry to set the number of seconds after which the RightFax server stops processing embedded codes. Use temporarily to track and resolve problems. l None . processing continues as long as necessary) QueueSize Verbose All significant events. 1 Terse. Specify the event log level for the Queue Handler: None No information. the server generates an alert and stops running. Use temporarily to track and resolve problems. If too many events require attention of the RightFax Server module. Type: REG_DWORD ~5 The number of the fax channel that received the fax. Variable Definition ~1 The current page number. ~8 Duration of the fax transmission in minutes and seconds. This variable is case-sensitive.6 Feature Pack 2 Example The following ReceiveStampFormat entry: Page ~1 of ~2 received on ~3 on server ~4. “00001” means January 1. ~9 The fax recipient’s RightFax user ID (if applicable). prints as: 352 Administrator Guide . Default: 14 (RTI appears as 14-point type) See Also: l StampReceivedPages to turn the RTI on or off l ReceiveStampFormat to specify which data appears l ReceiveStampLocation to specify where the RTI appears ~B The current date formatted as a two-digit year followed by three digits for the absolute day of the year. The number is reset each day at midnight and increments by one for each received fax page. change the QueueSize value to 3000. A modest increase to the event queue size does not have any adverse effects on the RightFax server itself. Set ReceiveStampFontSize to any decimal number. ReceiveStampFormat ~C The total page count on the fax server. Default: 2000 (limit of 2000 events may be in the queue) ReceiveStampFontSize This value specifies the font size (in points) for the text that appears on the optional RTI line.Chapter 40: Registry keys and values FaxServer Registry Entries To increase the event queue size. ~7 The fax sender’s caller subscriber ID (CSID). ~2 The total number of fax pages received. ~6 The fax recipient’s DID number. For example. This variable is case-sensitive. Variable Definition ~4 The name of the fax server that received the fax (up to 30 characters). Using ~A in this case changes the unique ID of the fax to reflect the RTI line value. This variable is case-sensitive. ~3 The date and time that the fax was received (as reported by the fax server). use the ReceiveStampFormat value to specify which data appears. The following table lists the variables that can be included in your RTI line text. 2000. This value specifies which information to show in the optional RTI line. OpenText RightFax 10. ~A The unique ID assigned to the fax by the fax server. Use the StampReceivedPages value to turn the RTI on or off. Type: REG_DWORD Caution Do not use this variable if you assign unique ID numbers to fax file names. ~0 The fax recipient’s RightFax user name (if applicable). Open FaxUtil. page number. in the Company field. To enable the RTI line. You can replace the CSID with the sender’s company name by setting the UseCompanyforCSID value to 1. usually containing the date. or RIGHT. time. set this value to 1. You must set the value in the registry for each WorkServer and for the FaxServer. Valid options are TOP. TYPE: REG_SZ Default: BOTTOM (prints the RTI across the bottom of each page) Type: REG_DWORD Default: 0 (does not change the TTI) See Also: l StampReceivedPages to turn the RTI on or off l ReceiveStampFormat to specify which data appears l ReceiveStampFontSize to specify how large the RTI is To add the Company Name for each user 1. click Options and the User Options dialog box opens. BOTTOM. The RTI line includes information about the fax that supplements the TTI line such as the total number of pages received. On the User Information tab. 2. StampReceivedPages The RTI (Receipt Terminal Information) line is a line of text that can be printed on each received fax page. UseReceiveStampUnique To instruct RightFax to use the unique ID as the file name for the fax.6 Feature Pack 2 353 Administrator Guide . the name of the fax server that received the fax. and fax ID (or CSID). and the sender’s caller ID. l ReceiveStampLocation to specify where to show the RTI l ReceiveStampFormat to specify which data appears l ReceiveStampFontSize to specify how large the RTI is WebDeliveryURLOverride TYPE: REG_SZ Default: None OpenText RightFax 10.Chapter 40: Registry keys and values FaxServer Registry Entries Page 2 of 4 received on 02-01-01 12:11:59 [US Mountain Standard Time] on server RIGHTFAX UseCompanyforCSID The TTI (Transmission Terminal Information) is a line of text that is printed across the top of each sent fax page. enter the company name. 3. set StampRecievedPages to 1. LEFT. total pages. ReceiveStampLocation Specify where on the fax page to print the optional RTI line. On the Tools menu. Type: REG_DWORD Type: REG_DWORD Default: 1 (the RTI line is enabled) Default: 0 (unique ID is not used as the fax file name) See Also: See Assigning unique ID numbers to fax file names and routing to a network folder on page 226 for additional setup requirements when using this registry value. 1=enabled. The URL can include the following macros that are replaced at runtime: HKEY_LOCAL_MACHINE\Software\RightFax\Gateway \Gateway# or for 64-bit: Macro Description WebUtil Web Client HKEY_LOCAL_MACHINE\Software \Wow6432Node\RightFax\Gateway\Gateway# {WebServer} Name of the IIS server hosting the web application Yes Yes AllowSubjectAsOwnAttachment {RFServer} Name of the RightFax server Yes Yes {handle} Handle of the fax Yes Yes Set this to 0 to prevent Unicode email subject lines from appearing as a separate fax page. {UniqueID} Fax unique ID Yes No Type: REG_DWORD Default: 0 (keeps Unicode email subject lines on same page. RightFax creates one overall key for the Gateways: Type: REG_MULTI_SZ HKEY_LOCAL_MACHINE\Software\RightFax\Gateway Text entered here is added to the headers of all mail-bound faxes going to the SMTP server. indicated by the gateway number (such as Gateway1 or Gateway2) as follows: OpenText RightFax 10.dll/?X=LNKFX&SERVER={RFServer}&HFAX={handle} &FAXUID={UniqueID} DoNotStripPlusSign Prevents the “+” character from being stripped from the dialing string.aspx?Action=ShowDocument({handle})&Server= {RFServer} http://{WebServer}/WebClient/ fuwww.6 Feature Pack 2 Only the headers listed here are added to the fax cover sheet Notes area. Example The following shows a WebUtil URL and a Web Client URL: http://{WebServer}/WebUtil/ default. 0=disabled. Values in this entry are not case-sensitive. 354 Administrator Guide . The following registry keys can be added to further configure your SMTP/POP3 gateway. Values in this field are not case-sensitive. ExtraHeaders or for 64-bit: Type: REG_MULTI_SZ HKEY_LOCAL_MACHINE\Software\Wow6432Node\RightFax\ Gateway) IncludeHeaders There is also a subkey for each additional gateway.Chapter 40: Registry keys and values Gateway Registry Entries You can override the web delivery URL set on the Advanced tab in Server Configuration. Leaving this blank allows all headers to be included. Type: REG_DWORD ExcludeHeaders Gateway Registry Entries Any headers listed here are removed from the fax cover sheet Notes area. l None No information. l Type: REG_DWORD Verbose All significant events. TeleConnect Registry Configuration TeleConnect is configured primarily via multi-string (Reg_ Multi_SZ) registry entries. Each channel dedicated to TeleConnect has its own configuration registry entry. See Critically low disk space on page 182 for more information. stop and start the RightFax server for the settings to take effect. 0=disabled. This registry key prevents blank fax pages from being sent. l Normal Errors and major events only. Default: 0 (disabled) RightFaxRegistry Entries RightFax keywords are Type: REG_DWORD HKEY_LOCAL_MACHINE\Software\RightFax Default: 0 = None or for 64-bit: Value Action HKEY_LOCAL_MACHINE\Software\Wow6432Node\RightFax 0 None After adding the registry values. 1 Terse 2 Normal Image 3 Verbose By default. The multi-string registry entries for TeleConnect use this format: Type: REG_SZ Default: C:\Program Files\RightFax\Image rpc_loglevel Specify the event log level for the RPC module: OpenText RightFax 10. 1=enabled. Use temporarily to track and resolve problems. Caution Leaving the verbose log level for long periods of time can fill up the Event Log and may prevent new events from being logged. The TeleConnect configuration registry entry is located at HKEY_ LOCAL_MACHINE\Software \RightFax\Doctransport\Transports\Brooktrout\TUI\Extensio ns (64-bit: HKEY_LOCAL_MACHINE\Software\Wow6432Node\ RightFax\Doctransport\Transports\Brooktrout\TUI\Extension s). RightFax stores fax images in the RightFax\Image folder on the server.Chapter 40: Registry keys and values RightFaxRegistry Entries Type: REG_MULTI_SZ SkipEmptyAttachments The gateway scans the bodies of fax-bound mail attachments and discard empty ones.6 Feature Pack 2 355 Administrator Guide . You can change the location of image storage by entering a valid path name for the Images value. l Terse Critical errors only. TeleConnect transmits this sequence just before hanging up. The extension and all keywords must be separated by an accent grave (`) character. If no billing codes are present in the source fax. invalid doc numbers. DefaultBI1 N/A Default billing code #1 for a two-call fax TeleConnect. MaxErrors 3 Maximum number of errors allowed (timeouts. MaxFaxes 32 The maximum number of faxes sent out in one call by TeleConnect. and includes the default settings (if any) and descriptions. etc. Keyword Default Description Where extension is the phone number extension or DID channel assigned to TeleConnect.WU%1234567890ABCD). is used. the system attempts to use the billing codes from the source fax. Multilingual False Multilingual support enabled/disabled. CallType Default call type: 0 0 = Prompt 1 = One-call 2 = Two-call CSID N/A TransferSequence N/A PBX transfer sequence.) If this number is exceeded. it is relative to the RFBoard folder. ` is the “grave” character located on the same key as the tilde (~). The phone number extension or DID channel assigned to TeleConnect is always the first entry..Chapter 40: Registry keys and values RightFaxRegistry Entries extension`keyword(value)`keyword(value)`. 900Enable False 900 telephone processing. AskVoiceNumber True Ask caller for voice number. DefaultBI2 N/A Default billing code #2 for two-call. If a fax is being forwarded from a user’s mailbox. It is a standard Brooktrout® sequence (TP!F. If a relative path-spec. AppType 0 Application type: 0 = TeleConnect 2 = One-Doc Poll AskAlphaNumeric False Ask caller for alpha-numeric sequence. keyword is one of the configuration setting keywords from the following table.6 Feature Pack 2 356 Administrator Guide . If blank. and that of DefaultBI2.. Keyword Default Description 900Agree N/A 900 caller agreement sequence. TUIReportPath The path for TeleConnect reports. and value is an optional value setting for the keyword. The following table lists all available TeleConnect keywords.. the caller is disconnected. the value specified here. 39 characters max. it uses the channel default. If not blank. OpenText RightFax 10. TUILOG CSID to use during a one-call transaction. faxes that fail to route are retried every 10 seconds for 10 minutes. The output device "tiffscaled" will be used instead of the default device or that specified in PCL6_DeviceName. RightFax creates one overall key for the workservers: FileRouteRetryDuration HKEY_LOCAL_MACHINE\Software\RightFax\Workserver By default. To change the retry parameters. The page will be downscaled by the given factor on both axes before error diffusion takes place. A relative folder specification is relative to the RFBoard folder. Type: REG_SZ Default:none FileRouteRetryDelay VoicePath0 N/A Language #0 voice folder(s). Type: REG_DWORD WorkServer Registry Entries Default:10. or for 64-bit: HKEY_LOCAL_MACHINE\Software \Wow6432Node\RightFax\Workserver\Worksrv# OpenText RightFax 10. By default. There can also be a subkey for each additional workserver. or for 64-bit: HKEY_LOCAL_MACHINE\Software\Wow6432Node\RightFax\ Workserver) To change the retry parameters. HKEY_LOCAL_MACHINE\Software\RightFax\Workserver \Worksrv# GhostDownScaleFactor Downscale factor for PostScript and PDF conversions. set this value to the number of milliseconds to continue between each retry attempt.000 (10 minutes). The system searches one or more voices folders to play a voice file.Chapter 40: Registry keys and values Keyword Default VoicePath MainApp\ The path(s) for voice prompt files.6 Feature Pack 2 357 Administrator Guide . Folders are separated with a semicolon. WorkServer Registry Entries Description ControlPCLFileName Specifies a file containing PCL commands that may be necessary for the proper conversion of PCL print jobs. The same output device is used when the "Photos and Images" PDF attachment type is selected in FaxUtil. voices. Any recorded message is recorded to the first folder listed. indicated by the workserver number (such as Worksrv1 or Worksrv3) as follows: Type: REG_DWORD Default: 600. faxes that fail to route are retried every 10 seconds for 10 minutes.000 (10 seconds). VoicePath2 – VoicePath9 N/A Language #2 voice folder(s) – Language #9 voice folder(s). set this value to the number of milliseconds to continue between each retry attempt. RightFax continues to attempting to convert the fax indefinitely. Default: 0 This must be set for each workserver. stop the PCL6_GetResolutionFromPCL OpenText RightFax 10. To change this so that faxes have the time and date of the receiving server. PCL6_DeviceName You can specify to use a specific PCL device. See Configuring RightFax for CSID routing on page 223 for more information about this type of routing. In case server-side application conversion fails. To correct this. For example. see www. Type: REG_DWORD KillServiceTimeout Default:200.90 gt {1}{0} ifelse} settransfer} >>setpagedevice If GhostDownScaleFactor is used. Type: REG_DWORD PCL6_FineMode_RParam Default: 0 (faxes keep the time and date stamp of the originating server) Resolution adjustment for Fine mode fax conversion. GSPostScriptCode Type: REG_DWORD Example Rendering with -r600 and then specifying GhostDownScaleFactor=3 will produce a 200dpi image.com/doc/current/Devices.6 Feature Pack 2 Get resolution from the PCL file header. faxes routed from one RightFax server to another RightFax server in a different time zone has the time and date stamp from the originating server. 358 Administrator Guide . PCL6_DownscaleFactor Downscale factor adjustment. and set the fax status to “conversion failed. Type: REG_SZ conversion.htm. Default: no time out. Maximum value is 4.ghostscript. For a list of devices. you can include the following PostScript string in the GSPostScriptCode registry value on each Workserver that performs conversions.Chapter 40: Registry keys and values WorkServer Registry Entries The value must be greater than 1 and less than or equal to 4. Type: REG_SZ Default: blank (does not improve PDF conversion quality) Type: REG_SZ InterconnectSetTZ Default: tiffg3 By default.” Set the data value of KillServiceTimeout to the length of time in milliseconds that you want to attempt conversion before timing out. "tiffscaled" is used instead of the device specified here. in lines per inch. <</Install {{0. Certain PDF files may not convert legibly. you can configure RightFax to automatically time out. Type: REG_DWORD Default:0. set the InterconnectSetTZ value to ‘1’. set the data value to 600000 for 10 minutes. PCL6_Normal_Mode_RParam Resolution adjustment for Normal mode fax conversion. a time strip is printed on the first page of each fax as black text. UseReceiveStampUnique Default: 0 (faxes go through conversion just one time) To instruct RightFax to use the unique ID as the file name for the fax. Though this improves the quality of the output image. If the incoming fax images go to the edge of the page. PCL6AdditionalParams Type: REG_DWORD You can add open-ended PCL parameters to pass options that RightFax does not offer access to. You must set the value in the registry for each WorkServer and for the FaxServer. you can set this value to 1 to pass faxes through conversion twice. part of the image may be cut off by this margin. Type: REG_DWORD Type: REG_DWORD Default: 0 (the time strip prints in black text) Default:100. Use under the direction of Customer Support for diagnostics or to try new options that might exist in newer versions.Chapter 40: Registry keys and values WorkServer Registry Entries Type: REG_DWORD PrintTimeReverse Default:0 (disabled) By default. PDF conversion adds a small margin around the edge of each page. Set the PrintTimeReverse value to ‘1’ to cause the time strip to print in white text on a black background. Default: 0 (unique ID is not used as the fax file name) Type: REG_DWORD See Assigning unique ID numbers to fax file names and routing to a network folder on page 226 for additional setup requirements when using this registry value. Type: REG_DWORD Default: 0 (does not shrink PDF pages) Caution If you set this value to 1 and did not license and enable the PDF module. ShrinkToView PCL6_TwoPass By default. First PCL files are converted to PostScript and then to TIFF fax images.6 Feature Pack 2 359 Administrator Guide . The value will be passed to the PCL6 engine without interpretation. Type: REG_SZ Default:none OpenText RightFax 10. it also takes longer than a single-pass conversion. set this value to 1. With a licensed and enabled PDF module. Set this value to 1 on each Workserver to reduce the size of the page slightly before conversion so that the margin does not cut off any content. in lines per inch. conversion will fail. exe http://localhost/RFMOSS/servicename?wsdl l RightFax User Name l Password This generates a configuration file and a code file that contains the client class. Add the two files to your client application and use the generated client class to call the Service. Example In C#. you can point to the services at: 2. If you are using a tool like Visual Studio. Enable the SharePoint Web Services module. you must start the three services. 4.Chapter 41: Web Services API Starting the Web Services Chapter 41: Web Services API With the Web Services API. Enable a Submit button on the webpage that sends the web service commands to the server. You do not need to have SharePoint to use the Web Services API. you can send and receive simple faxes from a webpage and inquire about their status. You can do this using the svcutil. To use the Web Services API: Starting the Web Services 1. the code might be: class Test { static void Main() OpenText RightFax 10. Create a webpage that calls the program and accepts user input. In your program. Write a program that starts the required services.exe tool from the command line with the following syntax: l Server Name svcutil. The services are stored at: l /RFMOSS/SendingService l /RFMOSS/SendingService l /RFMOSS/RightFaxAPIService l /RFMOSS/RightFaxAPIService l /RFMOSS/ImportService l /RFMOSS/ImportService To test each service 3.6 Feature Pack 2 360 Administrator Guide . Users must enter at least the following information: Create a client and use it to call the service. FullFax properties client. You can use the following fax objects to track the sending of faxes: l FullFax.6 Feature Pack 2 361 Administrator Guide . Example In Visual Basic. Data type: Integer Read-only Returns the number of times that the fax has been forwarded using the AutoForward feature. This number is tracked for OpenText RightFax 10.Close().Chapter 41: Web Services API Inquiring about fax status { Fax methods RightFaxApiServiceClient client = new RightFaxApiServiceClient(). Shared Sub Main() GetUsersFaxes Returns a list of Brief Faxes for the specified user. } GetFullFax } Returns a Full Fax for the specified fax handle. you can use the following methods to get track faxes using the Web Services API: // Use the 'client' variable to call operations on the service. In addition to the methods available in Sharepoint for sending and receiving simple faxes. ' Always close the client. Use to obtain basic information about a fax. AutoForwardCount l BriefFax. End Sub Attachments End Class Data type: Attachments Collection Inquiring about fax status Read-only Returns the Attachments collection associated with the current fax object. Use to obtain detailed information about a fax. GetFax client. Dim client As RightFaxApiServiceClient = New RightFaxApiServiceClient() GetUsersFullFaxes ' Use the 'client' variable to call operations on the service. the code might be: GetUsersFaxHandles Class Test This method returns all fax handles for the specified user.Close() The following properties are available for FullFax. // Always close the client. Returns a Brief Fax for the specified fax handle. Returns a list of Full Faxes for the specified user. See Attachment object or Attachments collection for more information. Binary file transfers have been replaced by the fax image attachment. if any. See the BillingCode object for more information. specify the password as a string. By default the maximum number of allowed AutoForward events is 5. Data type: Long CoverSheetNotes Read-only Data type: String Returns the size of the binary file transfer information file if one exists. but this property remains available for backwards compatibility. Each line of notes is a string and can include up to 69 characters. Read/Write BillingCode2 Data type: String Specifies the date and time that the fax should be sent in Visual Basic variant format. Data type: String Read/Write OpenText RightFax 10. CertifiedDeliveryPassword BFTFilename Read/Write Data type: String If a password is desired when creating document for Certified Delivery. BillingCode Read-only Data type: String DelayFaxSendDateTime Read/Write Data type: Date Returns the Billing Code 1 field as a string. each identified by an index number starting with 1 (cannot exceed 24). The cover sheet can include up to 24 note lines. ChannelToSendOn Data type: Integer Read/Write BFTFileSize Specifies the channel for sending the current fax.6 Feature Pack 2 362 Administrator Guide . Binary file transfers have been replaced by the fax image attachment. but this property remains available for backwards compatibility. See also the CoverSheet object. Read/Write EmailSubject Returns the Billing Code 2 field as a string. This property is only used when creating a new email message.Chapter 41: Web Services API Inquiring about fax status each fax to prevent infinite forwarding loops. Read/Write Data type: BillingCode Specifies a specific note line for the cover sheet. Read-only CoverSheetSizeInBytes Returns the BillingCode object associated with the fax. Data type: String Read-only Returns the file name of the binary file transfer information file if one exists. Data type: Long BillingCode1 Returns the size of the fax cover sheet in bytes. A zero indicates that there was no error. This property is only used when creating a new email message. it contained errors 4 fecNoAnswer The destination number did not answer the phone 5 fecBadFCS Bad File Cover Sheet OpenText RightFax 10. Error occurred creating Fax Cover Sheet 8 fecCantSchedule Fax was not sent because fax transmission schedule full FaxErrorCode 9 fecUnknown Unknown error report by fax board Read-only 10 fecHuman Returns the FaxErrorCodeType. This property has been replaced by information in the FaxStatus property.6 Feature Pack 2 363 Canceled by user Administrator Guide . The FaxErrorCodeType is one of the following enumerated values. Numeric Name equivalent Notes FaxDisposition 6 fecBadConvert The fax was not converted to an image file Read-only 7 fecMakeFCS Returns an integer that indicates the disposition of the fax. but remains available for backwards compatibility. A human answered the phone 11 fecGroup2 Reached a Group2 machine 12 fecLocalInUse The destination fax number is unable to receive 13 fecLineProblem Communications line between the two fax numbers not working correctly 14 fecBadPaper Invalid FormType specified 15 fecBadSignature Invalid signature file specified 16 fecNoSignatureAuthorization The fax required but did not receive signature authorization 18 fecDiscarded Data type: Integer Data type: FaxErrorCodeType enumerated value Numeric Name equivalent Notes 0 fecNone No error 1 fecBusy Fax number was busy 2 fecTransmissionError Fax was not sent/received 3 fecPoorQuality The fax board returned a message indicating that although the fax was received.Chapter 41: Web Services API Inquiring about fax status Specifies the Subject line of a new email message. This property returns the file name. 23 fecBadOCR OCR operation failed FaxRecordDateTime 24 fecBadPrint Print operation failed Data type: Date 25 fecNoLibraryDocument Authorization Unauthorized user attempting to create a new library document 26 fecViewStar1 ViewStar imaging system import error FaxStatus 27 fecDisapproved The fax was disapproved for transmission Read-only 28 fecEmailDeliveryError The fax document was not sent to the specified email address Read-only Returns the date and time that the fax was created in Visual Basic variant format. FaxID Data type: Integer Read-only OpenText RightFax 10.Chapter 41: Web Services API Inquiring about fax status Numeric Name equivalent Notes Returns the ID assigned to the fax by the fax hardware when the fax is schedule to be sent.6 Feature Pack 2 364 Administrator Guide . Numeric equivalent Name Notes FaxFilename 0 fsUnborn Not yet created Data type: String 1 fsNeedsFCS Needs fax cover sheet 2 fsNeedsConversion Needs conversion to an image file 3 fsNeedsToBeSent None 4 fsInConversion In the process of being converted to an image file 5 fsInSend usPagesInFront indicates how many pages sent so far Read-only Returns the name of the image file associated with an incoming fax. not the image object. Data type: FaxStatusType enumerated value Returns the status of the fax as a FaxStatusType. 19 Invalid characters in fax number FaxPagesInFront fecBadPhone Data type: Integer 21 fecInvalidCode Invalid BillingCode Read-only 22 fecBadCode Error in an embedded code Returns the number of fax pages in the queue preceding the current fax. The image file is stored in the image folder on the fax server. This is one of the valid FaxStatusType enumerated values. Specifies the sender’s general voice telephone number. ForwardToNewFaxNumber Data type: Fax Read/Write FaxTerminationStatus Specifies the sender’s general fax number. 15 fsInOCR None FromFaxNumber 16 fsInPrint None Data type: String 17 fsQueuedForPrinting None Read/Write 18 fsQueuedForOCR None Specifies the sender’s personal fax number. Numeric equivalent Name Notes 6 fsDoneOK Successfully sent or received 7 fsManualFCS Uses a manual fax cover sheet 8 fsInSchedule Awaiting scheduled send time 9 fsDoneError Too many errors. 19 fsInValidation None FromGeneralFaxNumber 20 fsInApproval None Data type: String Folder Data type: Folder Read/Write Specifies the Folder object for this fax.6 Feature Pack 2 365 Administrator Guide . See also the OriginalFCSFilename property. Data type: Integer FromGeneralVoiceNumber Read-only Data type: String Returns an integer indicating the termination status of the fax. The information available through this property has been moved to the FaxHistory object but this property remains available for backwards compatibility.Chapter 41: Web Services API Inquiring about fax status Specifies the name of the fax cover sheet image in the server’s image folder. See the Histories collection or the FaxStatus property. is not retried 10 fsDuplicate None 11 fsError None 12 fsNeedsAttention None Read-only 13 fsNeedsAttachment None 14 fsHeldForPreview None Returns a new fax that has all of the same properties as the previous fax except the FaxID. Read/Write FCSFilename Read/Write Data type: String Specifies the sender’s name. FromName Data type: String Read/Write OpenText RightFax 10. Indicates whether the fax has a rich PDF document associated with it. or a group can be required to use a cover sheet based on the MustHaveCoversheet property. Histories Data type: FaxHistories Collection HasCoversheet Read-only Data type: Boolean Returns the FaxHistories collection associated with the fax. (The original fax cannot be deleted from the fax database by the recipient. but this property remains available for backwards compatibility. Data type: String Read/Write Specifies the sender’s personal voice telephone number. Handle HasPDF Data type: Long Data type: Boolean Read-only Read-only The handle is used internally by the RightFax system to identify each unique object. Binary file transfers have been replaced by the fax image attachment. The property returns True or 1 if the fax has BFT. The collection contains one or more history objects. It is only valid for outgoing faxes.6 Feature Pack 2 366 Administrator Guide . False or 0 indicates there is no cover sheet. Data type: Boolean Read/Write Indicates whether the fax has a hotlink. Read/Write ImageSizeInBytes Data type: Long OpenText RightFax 10.Chapter 41: Web Services API Inquiring about fax status FromVoiceNumber Indicates whether the fax has a cover sheet. it returns False or 0 if it does not. GenerateCompletionEvent Data type: Boolean Read/Write HasHotlink Specifies whether to generate a completion event after the fax has been sent. HideFromWeb Data type: Boolean HasBFT Read-only Data type: Boolean Hides the fax from the certified delivery Web interface when the recipient deletes it. True or 1 indicates there is a cover sheet. Each user can specify a default cover page setting with the IsCoverPageDefaultedOn property. so it is hidden instead. If you specify a value without specifying a property name. Set this property to True or 1 to generate the CompletionEvent. Set it to False or 0 if you don’t want to generate a CompletionEvent. The cover sheet is stored as a file on the server and can be specified using the FCSFilename property.) Read-only Indicates whether the fax uses binary file transfer. the system assigns that value as the object Handle. See also the IsFineMode property. IsCoversheetFine Data type: Boolean Read-only Specifies whether the cover sheet is in Fine mode. False or 0 indicates that it is in normal mode (100×100 dots per inch resolution).Chapter 41: Web Services API Inquiring about fax status Read-only Read-only Returns the size of the fax body in bytes. and the status is updated when the entire job is complete (saving machine overhead). IsCertifyDelivered Data type: Boolean IsApproved Read/Write Data type: Boolean Indicates whether the fax was sent via certified delivery. False or 0 indicates that it is not required. This property has been replaced by functionality in the Attachment object. True or 1 indicates the BillingCodes have been checked and are valid. False or 0 indicates that no such request has been made. IsBillingCodesVerified Data type: Boolean Read-only Indicates whether the BillingCode attachment has been checked against the list of valid billing codes. This property only applies to sent faxes. IsDeleted Data type: Boolean Read-only IsCallbackRequested Data type: Boolean OpenText RightFax 10. Indicates whether the sender requests a call from the recipient. False or 0 indicates that they are not valid billing codes. True or 1 indicates that a callback is requested. Data type: Boolean Read/Write Specifies whether the cover sheet for the fax needs to be converted to a TIFF format image file. True or 1 indicates that conversion is required. True or 1 indicates that the cover sheet is in Fine mode (200×200 dots per inch resolution). Read-only IsCoversheetConversionNeeded Indicates whether the fax has been approved. True or 1 indicates that the fax is a broadcast fax. InputFilename Data type: String Read-only Returns the name of the file that appears in the outgoing folder. False or 0 indicates it has not been approved.6 Feature Pack 2 367 Administrator Guide . True or 1 indicates it has been approved. The default setting for callback request is set with the IsCallbackRequested property in the User object. See also Attachments Collection. IsBroadcastFax Data type: Boolean Read/Write Specifies whether the fax is a broadcast fax. Specifies whether the fax is deleted from the server after the Send event. True or 1 indicates that the fax is in Fine mode (200×200 dots per inch resolution). Data type: Boolean Read/Write Specifies whether the fax is deleted from the server after a successful Send event. Read-only Specifies whether the fax was automatically forwarded. False or 0 indicates that the cover sheet is not complete. Use the ForwardToUsers method to specify manual forwarding. IsFineMode Data type: Boolean Read/Write IsDeletedAfterSuccessfulSend Specifies whether the body of the fax is in Fine mode. See also the IsDeletedAfterSuccessfulSend property. regardless of whether the fax is sent successfully. See also the IsDeletedAfterAnySend property. Set it to False or 0 to show the fax is not deleted. See also the IsCoversheetFine property. object. IsForwarded Data type: Boolean IsFaxAutoForwarded Read-only Data type: Boolean Specifies whether the fax was manually forwarded. The AutoForward feature is set and type of forwarding defined in the User object. IsGatewayGenerated Data type: Boolean Read-only IsFaxBodyAutomaticallyPrinted Specifies whether the fax was generated by the RightFax email gateway. True or 1 indicates that the fax has been deleted from the server. False or 0 indicates that this fax was not forwarded. Set this to True or 1 to show the fax is deleted. False or 0 indicates that it was not.6 Feature Pack 2 IsGenericFlag1On 368 Administrator Guide . Set this to True or 1 to show the fax is deleted. False or 0 indicates that the fax was not forwarded. See also the IsForwarded property. False or 0 indicates that it has not been deleted. True or 1 indicates that the fax was generated by an email gateway. IsDeletedAfterAnySend Data type: Boolean Data type: Boolean Read-only IsFCSCompleted Read/Write Specifies whether the fax cover sheet has been completed. Data type: Boolean Read-only Specifies whether the fax was automatically printed. False or 0 indicates that it is in normal mode (100×100 dots per inch resolution).Chapter 41: Web Services API Inquiring about fax status Specifies whether the fax has been deleted. True or 1 indicates that the fax was forwarded. True or 1 indicates that the fax was automatically forwarded. Set it to False or 0 to show that it is not deleted. True or 1 indicates that this fax was automatically printed. The Autoprint feature is set and the printer defined in the User OpenText RightFax 10. True or 1 indicates that the cover sheet is complete. False or 0 indicates that the fax was not forwarded. 6 Feature Pack 2 369 Administrator Guide . True or 1 indicates that the fax is awaiting approval. See also the PrintFax method. True or 1 indicates that the fax is awaiting the specified time. IsNeedingApproval IsHeld Data type: Boolean Data type: Boolean Read-only Read/Write Specifies whether the fax is being held for preview before being sent by the user. Specifies whether the fax is being held until it is approved. IsInitialized Data type: Boolean Data type: Boolean Read/Write Read-only Specifies whether the fax was generated by the RightFax Production module. Use the Approve method to send the fax. Read/Write Specifies whether the user customizable API flag Generic2 is on. True or 1 indicates that the fax is held for preview. True or 1 indicates that the fax was printed. True or 1 indicates that the fax was initialized. False or 0 indicates that it is not. IsReceived Data type: Boolean IsINLJob Read-only Data type: Boolean OpenText RightFax 10. False or 0 indicates that it is not. Specifies whether the user customizable API flag Generic1 is on. False or 0 indicates that the fax was not delayed. Specifies whether the fax was successfully printed. True or 1 indicates that the fax was delayed.Chapter 41: Web Services API Inquiring about fax status Data type: Boolean Read/Write Read/Write Specifies whether the fax is an INL job. IsInDelaySend IsPrinted Data type: Boolean Data type: Boolean Read/Write Read-only Specifies whether the fax is being held until the date and time specified by the DelayFaxSendDateTime property. False or 0 indicates that it is not. IsProductionFax Specifies whether the fax was initialized. False or 0 indicates that the fax was not initialized. False or 0 indicates that the fax was not printed. IsLCRTimeDelayed IsGenericFlag2On Read-only Data type: Boolean Data type: Boolean Specifies whether the fax was delayed because of a leastcost routing rule. See also the Histories collection. OwnerID Data type: String NeedsPDFConversion Read/Write Data type: Boolean OpenText RightFax 10. Returns the name of the binary file transfer file before it was renamed by the fax server. the system stops after the first failed attempt. Data type: String Read/Write Returns the name of the original file that was converted to use as the fax cover sheet. this property is automatically set to False or 0. LastHistoryChangeDateTime Data type: Date Read-only OriginalFCSFilename Returns the date and time that the most recent history element was added to this fax. but this property remains available for backwards compatibility. Use the TryInterval property to specify the length of time between retries. IsViewed NeedsPrescan Data type: Boolean Data type: Boolean Read/Write Read/Write Specifies whether the fax was viewed. It is updated every time an element is added to any of the fax history objects. Data type: User Read/Write Returns the User object for the owner of the fax. Read/Write Indicates whether the fax needs to be scanned for embedded codes before conversion. This is the name as it appears in the server folder. IsWasDNDBlockedOn OriginalBFTFilename Data type: Boolean Data type: String Read/Write Read-only Specifies whether the fax was blocked by Do Not Dial.Chapter 41: Web Services API Inquiring about fax status Specifies whether the fax is an incoming or outgoing fax. True or 1 indicates that the fax was received (incoming). False or 0 indicates that the fax was not viewed. If this is set to 1. Set this to zero (0) to use the default setting on the RightFax server. Indicates whether the fax requires PDF conversion. The converted file name is accessible through the FCSFilename property. False or 0 indicates that the fax was sent (outgoing). Binary file transfers have been replaced by the fax image attachment. MaximumRetries Data type: Integer Read/Write Owner Specifies the maximum number of times the system will attempt to deliver the fax if the phone number is not responding. True or 1 indicates that the fax was viewed. When PDF conversion is complete.6 Feature Pack 2 370 Administrator Guide . For the user to send a fax with High priority.Chapter 41: Web Services API Inquiring about fax status Returns the UserID for the owner of the fax. ToCompany Data type: String RemoteID Read/Write Data type: String Specifies the recipient’s company name. For a numeric code indicating the status. See also the DefaultToCityState property in the User object. Data type: String Read/Write OpenText RightFax 10. Returns the secure caller subscriber identification of the sender’s fax machine. Specify that group as recipients.6 Feature Pack 2 371 Administrator Guide . Read-only Returns the ID of the sender’s fax machine. See also the PhoneItemGroup object. This applies only to received faxes. This is available for all received faxes. set the IsAbleToUseHighPriority property to True or 1 and the HighestAvailablePriority property to fpHigh in the User object. if any. see the FaxStatus property. Numeric equivalent Name 0 fpNormal 1 fpLow 2 fpHigh Read-only Returns the total length of transmission time it took to send or receive the fax. It is only available for sent faxes after successful completion. Read/Write Specifies multiple users receiving faxes. Define the users in a PhoneItemGroup. Priority Data type: FaxPriorityType enumerated value SendTime Read/Write Data type: Long Sets the priority for the fax using one of the valid FaxPriorityType enumerated values from the following table. ToCityState Data type: String Recipients Read/Write Data type: PhoneItemGroup Collection Specifies the city and state of the recipient. See also the DefaultToCompany property in the User object. StatusDescription Data type: String Read-only Returns the current status of the fax in text format. This applies only to received faxes. ToEmailAddress SecureCSID Read/Write Data type: String Specifies an email address for the fax destination. UniqueID ToVoiceNumber Data type: String Data type: String Read/Write Read/Write Specifies the unique ID for this specific print job. Set the MaximumRetries property to greater than 0 for this to have any effect. Specifies the recipient’s name. TypeOfPrintJob ToName Data type: PrintJobType enumerated value Data type: String Read/Write Read/Write Specifies the type of data in the print job. Specifies the telephone number of the recipient. the system creates a link to a single instance of the image. UserComments TryInterval OpenText RightFax 10. Specifies the telephone number of the recipient’s fax machine.Chapter 41: Web Services API Inquiring about fax status ToFaxNumber Data type: Integer Data type: String Read/Write Read/Write Specifies how long to wait. Rather than duplicate the image file of the fax for each user. between attempts to send the fax. in seconds. Numeric equivalent Name 1 pjPCL 2 pjPostScript 3 pjPCL2 4 pjPostScript2 5 pjCVL TotalPages UnicodeCoverSheetNotes Data type: Integer Data type: String Read-only Read/Write Returns the total number of pages in the fax. TotalLinkCount Data type: Integer Read-only Returns the total number of links associated with this fax. Links are generated when a RightFax user sends or forwards a fax to another RightFax user.6 Feature Pack 2 Data type: String 372 Administrator Guide . This can be defined by either the system or the user. The fax must be converted for this to be valid. See also the DefaultToFaxNumber property in the User object. The cover sheet notes as a unicode text block. Use one of the following PrintJobType enumerated values. See also the DefaultToName property in the User object. See also the DefaultToVoiceNumber property in the User object. False or 0 indicates it does not. each identified by an index number starting with 1 (cannot exceed 24).Send Data type: Date EndIf EmailSubject Read/Write Specifies the date and time that the fax should be sent in Visual Basic variant format.6 Feature Pack 2 373 Administrator Guide .Toname = tofaxname oFax. See also the CoverSheet object.ToFaxNumber = tofaxnum Specifies a specific note line for the cover sheet. The cover sheet can include up to 24 note lines. This property is only used when creating a new email message. Data type: Boolean ChannelToSendOn Read/Write Data type: Integer Indicates whether the fax uses the Smart Resume feature of the RightFax system. Read-only BillingCode2 OpenText RightFax 10.Text oFax.Attachment. Read/Write UseSmartResume Returns the Billing Code 2 field as a string. Data type: String FaxDisposition Read/Write Data type: Integer Returns the Billing Code 1 field as a string. True or 1 indicates the fax uses Smart Resume.CreateOjbect(coFax) oFax. BillingCode1 Specifies the Subject line of a new email message.Owner = oUser oFax.Chapter 41: Web Services API Inquiring about fax status Read/Write Data type: String Comment text added to the fax by the fax sender. Each line of notes is a string and can include up to 69 characters. CoverSheetNotes Example The following example sends a fax with an attached library document.Text = ““ Then oFax. If 1stLibDocs. Data type: String BriefFax properties Read/Write The following properties are available for BriefFax.Add MyFaxServer.Send DelayFaxSendDateTime Else libdoc=1stLibDocs.LibraryDocuments(libdoc) oFax. Read/Write Specifies the channel for sending the current fax. Data type: String Read/Write Set oFax = MyFaxServer. 6 Feature Pack 2 374 Administrator Guide . The FaxErrorCodeType is one of the following enumerated values. This property has been replaced by information in the FaxStatus property. Numeric Name equivalent Notes 9 fecUnknown Unknown error report by fax board 10 fecHuman A human answered the phone 11 fecGroup2 Reached a Group2 machine 12 fecLocalInUse The destination fax number is unable to receive 13 fecLineProblem Communications line between the two fax numbers not working correctly 14 fecBadPaper Invalid FormType specified 15 fecBadSignature Invalid signature file specified 16 The destination number did not answer the phone fecNoSignatureAuthorization The fax required but did not receive signature authorization 18 fecDiscarded Canceled by user FaxErrorCode Data type: FaxErrorCodeType enumerated value Read-only Returns the FaxErrorCodeType.Chapter 41: Web Services API Inquiring about fax status Returns an integer that indicates the disposition of the fax. it contained errors 4 fecNoAnswer 5 fecBadFCS Bad File Cover Sheet 19 fecBadPhone 6 fecBadConvert The fax was not converted to an image file Invalid characters in fax number 21 fecInvalidCode Invalid BillingCode 7 fecMakeFCS Error occurred creating Fax Cover Sheet 22 fecBadCode Error in an embedded code 8 fecCantSchedule Fax was not sent because fax transmission schedule full 23 fecBadOCR OCR operation failed 24 fecBadPrint Print operation failed OpenText RightFax 10. but remains available for backwards compatibility. A zero indicates that there was no error. Numeric Name equivalent Notes 0 fecNone No error 1 fecBusy Fax number was busy 2 fecTransmissionError Fax was not sent/received 3 fecPoorQuality The fax board returned a message indicating that although the fax was received. Chapter 41: Web Services API Inquiring about fax status FaxStatus Numeric Name equivalent Notes 25 fecNoLibraryDocument Authorization Unauthorized user attempting to create a new library document 26 fecViewStar1 ViewStar imaging system import error Numeric equivalent Name Notes 27 fecDisapproved The fax was disapproved for transmission 0 fsUnborn Not yet created 28 fecEmailDeliveryError The fax document was not sent to the specified email address 1 fsNeedsFCS Needs fax cover sheet 2 fsNeedsConversion Needs conversion to an image file 3 fsNeedsToBeSent None 4 fsInConversion In the process of being converted to an image file Read-only 5 fsInSend Returns the name of the image file associated with an incoming fax.6 Feature Pack 2 375 Administrator Guide . is not retried Read-only 10 fsDuplicate None Returns the ID assigned to the fax by the fax hardware when the fax is schedule to be sent. This is one of the valid FaxStatusType enumerated values. usPagesInFront indicates how many pages sent so far 6 fsDoneOK Successfully sent or received 7 fsManualFCS Uses a manual fax cover sheet 8 fsInSchedule Awaiting scheduled send time 9 fsDoneError Too many errors. 11 fsError None 12 fsNeedsAttention None FaxRecordDateTime 13 fsNeedsAttachment None Data type: Date 14 fsHeldForPreview None Read-only 15 fsInOCR None Returns the date and time that the fax was created in Visual Basic variant format. FaxFilename Data type: String FaxID Data type: Integer OpenText RightFax 10. 16 fsInPrint None Data type: FaxStatusType enumerated value Read-only Returns the status of the fax as a FaxStatusType. This property returns the file name. not the image object. The image file is stored in the image folder on the fax server. See the Histories collection or the FaxStatus property. False or 0 indicates that the fax was sent (outgoing). See also the OriginalFCSFilename property. OpenText RightFax 10. Data type: Integer FromVoiceNumber Read-only Data type: String Returns an integer indicating the termination status of the fax. Handle Data type: Long Read/Write Specifies the name of the fax cover sheet image in the server’s image folder. FromGeneralFaxNumber IsViewed Data type: String Data type: Boolean Read/Write Read/Write Read/Write Specifies the sender’s general fax number. The information available through this property has been moved to the FaxHistory object but this property remains available for backwards compatibility. Specifies the sender’s personal voice telephone number. Read/Write FCSFilename Read-only Data type: String The handle is used internally by the RightFax system to identify each unique object. Specifies whether the fax is an incoming or outgoing fax. the system assigns that value as the object Handle. FromName Data type: String Read/Write FaxTerminationStatus Specifies the sender’s name.6 Feature Pack 2 376 Administrator Guide . If you specify a value without specifying a property name. True or 1 indicates that the fax was received (incoming). IsReceived Data type: Boolean FromFaxNumber Read-only Data type: String Specifies the sender’s personal fax number.Chapter 41: Web Services API Inquiring about fax status Numeric equivalent Name Notes 17 fsQueuedForPrinting None 18 fsQueuedForOCR None 19 fsInValidation None 20 fsInApproval None FromGeneralVoiceNumber Data type: String Read/Write Specifies the sender’s general voice telephone number. ToName Data type: String StatusDescription Read/Write Data type: String Specifies the recipient’s name.6 Feature Pack 2 377 Administrator Guide . if any. True or 1 indicates that the fax was viewed. Read-only Returns the total length of transmission time it took to send or receive the fax. OwnerID ToCityState Data type: String Data type: String Read/Write Read/Write Returns the UserID for the owner of the fax. RemoteID ToCompany Data type: String Data type: String Read-only Read/Write Returns the ID of the sender’s fax machine. Specifies the recipient’s company name. This applies only to received faxes.Chapter 41: Web Services API Inquiring about fax status Specifies whether the fax was viewed. This applies only to received faxes. See also the DefaultToName property in the User object. SecureCSID ToEmailAddress Data type: String Data type: String Read/Write Read/Write Returns the secure caller subscriber identification of the sender’s fax machine. See also the DefaultToCompany property in the User object. See also the DefaultToFaxNumber property in the User object. It is only available for sent faxes after successful completion. ToFaxNumber Data type: String SendTime Read/Write Data type: Long Specifies the telephone number of the recipient’s fax machine. Read-only TotalPages OpenText RightFax 10. This is available for all received faxes. Specifies an email address for the fax destination. see the FaxStatus property. See also the DefaultToCityState property in the User object. For a numeric code indicating the status. False or 0 indicates that the fax was not viewed. Specifies the city and state of the recipient. Returns the current status of the fax in text format. \SQLEXPRESS. Sample Web.config Data type: Integer <connectionStrings> <add name="ApplicationServices" connectionString="data source=.mdf.Integrated Security=SSPI.0"/> <authentication mode="Forms"> <forms loginUrl="~/Account/Login.aspx" timeout="2880"/> </authentication> UniqueID Data type: String Read/Write Specifies the unique ID for this specific print job. <?xml version="1.microsoft.AttachDBFilename=|DataDirectory|\aspne tdb. please visit http://go. <compilation debug="true" targetFramework="4.NET application. See also the DefaultToVoiceNumber property in the User object.Web. The fax must be converted for this to be valid.0"?> <!-For more information on how to configure your ASP.Security. ToVoiceNumber Data type: String Read/Write <system.config The following sample was created using Visual Studio. This can be defined by either the system or the user.6 Feature Pack 2 378 Administrator Guide .Data.com/fwlink/?LinkId=169433 <profile> <providers> <clear/> <add name="AspNetSqlProfileProvider" --> <configuration> OpenText RightFax 10.User Instance=true" providerName="System.SqlMembershipProvider" connectionStringName="ApplicationServices" enablePasswordRetrieval="false" enablePasswordReset="true" requiresQuestionAndAnswer="false" requiresUniqueEmail="false" maxInvalidPasswordAttempts="5" minRequiredPasswordLength="6" minRequiredNonalphanumericCharacters="0" passwordAttemptWindow="10" applicationName="/"/> </providers> </membership> UserComments Data type: String Read/Write Comment text added to the fax by the fax sender.SqlClient"/> </connectionStrings> Read-only Returns the total number of pages in the fax. <membership> <providers> <clear/> <add name="AspNetSqlMembershipProvider" type="System.web> Specifies the telephone number of the recipient.Chapter 41: Web Services API Sample Web. Chapter 41: Web Services API Sample Web.config type="System.WindowsTokenRoleProvider" applicationName="/"/> </providers> </roleManager> <security mode="None"> <transport clientCredentialType="None" proxyCredentialType="None" realm="" /> <message clientCredentialType="UserName" algorithmSuite="Default" /> </security> </binding> <binding name="Http1" closeTimeout="00:01:00" openTimeout="00:01:00" receiveTimeout="00:10:00" sendTimeout="00:01:00" allowCookies="false" bypassProxyOnLocal="false" hostNameComparisonMode="StrongWildcard" maxBufferSize="65536" maxBufferPoolSize="524288" maxReceivedMessageSize="65536" messageEncoding="Text" textEncoding="utf-8" transferMode="Buffered" useDefaultWebProxy="true"> </system.webServer> <system.Profile.Web.Web.SqlProfileProvider" connectionStringName="ApplicationServices" applicationName="/"/> </providers> </profile> messageEncoding="Text" textEncoding="utf-8" transferMode="Buffered" useDefaultWebProxy="true"> <readerQuotas maxDepth="32" maxStringContentLength="8192" maxArrayLength="2147483647" maxBytesPerRead="4096" maxNameTableCharCount="16384" /> <roleManager enabled="false"> <providers> <clear/> <add name="AspNetSqlRoleProvider" type="System.web> <system.6 Feature Pack 2 <security mode="None"> <transport clientCredentialType="None" proxyCredentialType="None" realm="" /> 379 Administrator Guide .Web.Security.SqlRoleProvider" connectionStringName="ApplicationServices" applicationName="/"/> <add name="AspNetWindowsTokenRoleProvider" type="System.serviceModel> <bindings> <readerQuotas maxDepth="32" maxStringContentLength="8192" maxArrayLength="2147483647" maxBytesPerRead="4096" maxNameTableCharCount="16384" /> <basicHttpBinding> <binding name="Http" closeTimeout="00:01:00" openTimeout="00:01:00" receiveTimeout="00:10:00" sendTimeout="00:01:00" allowCookies="false" bypassProxyOnLocal="false" hostNameComparison Mode="StrongWildcard" maxBufferSize="65536" maxBufferPoolSize="524288" maxReceivedMessageSize="65536" OpenText RightFax 10.webServer> <modules runAllManagedModulesForAllRequests="true"/> </system.Security. 6 Feature Pack 2 380 Administrator Guide .Chapter 41: Web Services API Sample Web.config <message clientCredentialType="UserName" algorithmSuite="Default" /> hostNameComparisonMode="StrongWildcard" listenBacklog="10" maxBufferPoolSize="524288" maxBufferSize="65536" maxConnections="10" maxReceivedMessageSize="65536"> </security> </binding> <readerQuotas maxDepth="32" maxStringContentLength="8192" maxArrayLength="2147483647" maxBytesPerRead="4096" maxNameTableCharCount="16384" /> <binding name="Http2" closeTimeout="00:01:00" openTimeout="00:01:00" receiveTimeout="00:10:00" sendTimeout="00:01:00" allowCookies="false" bypassProxyOnLocal="false" hostNameComparisonMode="StrongWildcard" maxBufferSize="65536" maxBufferPoolSize="524288" maxReceivedMessageSize="65536" messageEncoding="Text" textEncoding="utf-8" transferMode="Buffered" useDefaultWebProxy="true"> <reliableSession ordered="true" inactivityTimeout="00:10:00" enabled="false" /> <security mode="Transport"> <transport clientCredentialType="Windows" protectionLevel="EncryptAndSign" /> <readerQuotas maxDepth="32" maxStringContentLength="8192" maxArrayLength="2147483647" maxBytesPerRead="4096" maxNameTableCharCount="16384" /> <message clientCredentialType="Windows" /> </security> </binding> <security mode="None"> <binding name="NetTcpBinding_IImportService" closeTimeout="00:01:00" openTimeout="00:01:00" receiveTimeout="00:10:00" sendTimeout="00:01:00" transactionFlow="false" transferMode="Buffered" transactionProtocol="OleTransactions" hostNameComparisonMode="StrongWildcard" listenBacklog="10" maxBufferPoolSize="524288" maxBufferSize="65536" maxConnections="10" maxReceivedMessageSize="65536"> <transport clientCredentialType="None" proxyCredentialType="None" realm="" /> <message clientCredentialType="UserName" algorithmSuite="Default" /> </security> </binding> </basicHttpBinding> <netTcpBinding> <readerQuotas maxDepth="32" maxStringContentLength="8192" maxArrayLength="2147483647" maxBytesPerRead="4096" maxNameTableCharCount="16384" /> <binding name="NetTcpBinding_ISendingService" closeTimeout="00:01:00" openTimeout="00:01:00" receiveTimeout="00:10:00" sendTimeout="00:01:00" transactionFlow="false" transferMode="Buffered" transactionProtocol="OleTransactions" OpenText RightFax 10. Chapter 41: Web Services API Sample Default.cs" Inherits="_Default" %> <endpoint address="net.IImportService" name="Http" /> <message clientCredentialType="Windows" /> </security> </binding> <endpoint address="http://RFax1/RFMOSS/RightFaxApiService" binding="basicHttpBinding" bindingConfiguration="Http" contract="RightFaxApiService.IImportService" name="NetTcpBinding_IImportService"> <identity> OpenText RightFax 10.aspx <%@ Page Title="Home Page" Language="C#" MasterPageFile="~/Site.serviceModel> </configuration> <endpoint address="http://RFax1/RFMOSS/SendingService" binding="basicHttpBinding" bindingConfiguration="Http" contract="SendingServiceTester.tcp://rightfax1:9000/RFMOSS/ SendingService" binding="netTcpBinding" bindingConfiguration="NetTcpBinding_ISendingService” contract="SendingServiceTester.IRightFaxApiService" name="Http" /> </netTcpBinding> </bindings> <client> <endpoint address="net.ISendingService" name="Http" /> Sample Default.ISendingService" name="NetTcpBinding_ISendingService"> <identity> <userPrincipalName value="
[email protected]://righfax1:9000/RFMOSS/ ImportService" binding="netTcpBinding" bindingConfiguration="NetTcpBinding_IImportService" contract="ImportService.com" /> </identity> </endpoint> <!--<endpoint address= "http://localhost/RFMOSS/RightFaxApiService" binding="basicHttpBinding" bindingConfiguration="Http2" contract="RightFaxApiService.aspx <reliableSession ordered="true" inactivityTimeout="00:10:00" enabled="false" /> <userPrincipalName value="
[email protected]" /> </identity> </endpoint> <security mode="Transport"> <transport clientCredentialType="Windows" protectionLevel="EncryptAndSign" /> <endpoint address="http://RFax1/RFMOSS/ImportService" binding="basicHttpBinding" bindingConfiguration="Http" contract="ImportService.6 Feature Pack 2 <asp:Content ID="HeaderContent" runat="server" ContentPlaceHolderID="HeadContent"> </asp:Content> <asp:Content ID="BodyContent" runat="server" ContentPlaceHolderID="MainContent"> 381 Administrator Guide .IRightFaxApiService" name="Http1" />--> </client> </system.master" AutoEventWireup="true" CodeFile="Default. 6 Feature Pack 2 382 Administrator Guide . height: 300px.Chapter 41: Web Services API Sample Web. overflow: auto"> <asp:GridView CssClass="MyClass" ID="GridView1" runat="server" BorderStyle="Solid"> </asp:GridView> </div> <p> <asp:Label ID="FaxAttachmentlabel" runat="server" Text="Attachment:"></asp:Label> </asp:Content> <asp:FileUpload ID="FaxAttachment" runat="server" Height="32px" Width="367px" /> </p> OpenText RightFax 10.config <h2> Rightfax Server Information</h2> <p> <asp:Button ID="SendFaxButton" runat="server" onclick="SendFaxButton_Click" Text="Send a Fax" /> </p> <p> <asp:Label ID="Label1" runat="server" Text="RightFax Server:"></asp:Label> <asp:Label ID="StatusLabel" runat="server" ForeColor="Red"></asp:Label> <asp:TextBox ID="RightFaxServerBox" runat="server"></asp:TextBox> <p></p> <asp:Label ID="Label2" runat="server" Text="RightFax User:"></asp:Label> <h2>Check Fax Status</h2> <p> <asp:TextBox ID="RightFaxUserBox" runat="server"></asp:TextBox> Fax Handle: '<asp:Label ID="lblFaxHandle" runat="server"></asp:Label>' <asp:Label ID="Label3" runat="server" Text="Password:"></asp:Label> Fax Record Date and Time is: <asp:TextBox ID="PasswordBox" runat="server"></asp:TextBox> '<asp:Label ID="lblFaxRecordDateTime" runat="server"></asp:Label>' </p> </p> <h2>Send a Fax </h2> <h2> Get a User's Faxes</h2> <p> Name:<asp:TextBox ID="NameBox" runat="server"></asp:TextBox> <p> <asp:Button ID="GetUserFaxesButton" runat="server" onclick="GetUserFaxesButton_Click" Text="Get User's Faxes" /> </p> Number:<asp:TextBox ID="NumberBox" runat="server"></asp:TextBox> Comment: <asp:TextBox ID="CommentBox" runat="server" Width="295px"></asp:TextBox> </p> <div style="width: 750px.