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.config
378
Sample Default.aspx
381
Administrator Guide
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. With an email gateway, the user’s customary email client software can serve as the fax client. RightFax includes an email gateway for SMTP/POP3. Advanced gateways for Microsoft Exchange and Lotus Notes are available as separate modules.
About the RightFax System The RightFax system is a comprehensive network fax solution for creating, sending, receiving, and managing faxes from a user’s desktop computer. RightFax features and intuitive design make faxing as easy as printing to a network printer.
RightFax Server options
A user can enhance the fax by adding a cover page, overlaying a form, attaching documents, and inserting graphics.
RightFax offers the following fax server software options:
FaxUtil is the RightFax mailbox where users create, view, print, and manage faxes. With FaxUtil, users can forward, route, and delete faxes. The RightFax server manages network print queues assigned to faxing, converts outgoing faxes, schedules outgoing faxes, and routes incoming faxes. Routing can be optimized with Intelligent Least-cost Routing™ rules. The server consists of several services that run on one server computer or several networked computers to distribute heavy workloads.
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. It includes one fax channel, but is expandable to up to 30 fax channels.
RightFax Enterprise Server and Enterprise Suite
Similarly, 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.
OpenText RightFax 10.6 Feature Pack 2
l
The RightFax Enterprise Server supports unlimited user accounts. It includes three WorkServers and one fax channel, expandable to support unlimited fax channels. This server includes the RightFax Web Client™ and the OCR Router™,
10
Administrator Guide
Chapter 1: Introduction
OCR Converter™, Docs-on-Demand™, and TeleConnect™ modules. The Enterprise server is also available as a product suite that includes the RightFax Enterprise server, plus the Gateway for Microsoft® Exchange, the Gateway for Lotus Notes®, the Document Management Connector™, the SNMP Alerting™, and the PDF modules.
RightFax Server with the Integration Module The RightFax server and the RightFax Integration module enable applications for information exchange. The Integration module integrates RightFax with applications on mainframe, mid-range, and local area network host systems. l
l
The RightFax Small Business Integration module can be installed on the RightFax Business and Enterprise servers. The RightFax Enterprise Integration module can be installed on the Enterprise server.
RightFax Branch Office Server This RightFax Branch Office server supports up to 100 user accounts. It includes three WorkServers and two fax channels, and can be updated for a total of four fax channels.
OpenText RightFax 10.6 Feature Pack 2
11
Administrator Guide
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. This guide assumes you have knowledge of the Windows operating systems as well as knowledge of networking systems and your own organization’s network.
Getting help online The OpenText Knowledge Center at http://knowledge.opentext.com has the latest product information, 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, configuring and maintaining Fax Servers. Regularly scheduled courses are delivered virtually. On-site and custom training are also available.
To look up OpenText Customer Support contact information l
In FaxUtil, on the Help menu, select Contact Information. The information appears in English.
OpenText RightFax 10.6 Feature Pack 2
Open the text file Contact.txt located in the \RightFax\Bin folder on the RightFax server. You can enter 24 lines of text and up to 59 characters per line.
12
Administrator Guide
Chapter 2: User assistance
OpenText professional services
We can help you develop a customized training plan for your organization.
Customer support OpenText Customer Support maximizes the value of your RightFax server by providing access to a wide variety of resources and support tools. Through the OpenText Knowledge Center, customers have access to:
To get more information and register for RightFax training l
Visit our web site at: http://www.opentext.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
[email protected]
OpenText professional services Experienced OpenText implementation engineers can help you quickly and efficiently deploy RightFax in your production environment.
OpenText’s team of Technical Support Engineers and Product Specialists
To open the OpenText Knowledge Center Go to http://knowledge.opentext.com.
OpenText Professional Services engineers and consultants are experts in the implementation, deployment and integration of RightFax solutions. Services include basic installation and configuration, upgrades and migrations, configuration review, systems assessment and health check, and other advanced integration services. Services can be performed remotely, on-site, or a combination of both.
To view OpenText’s complete line of Customer Support offerings Go to http://www.opentext.com/support.
To view OpenText customer support contact information Go to www.opentext.com/2/global/services-home/servicessupport-contact.htm
OpenText Professional Services provides a cost effective alternative for organizations in need of getting their enterprise fax infrastructure up and running quickly, particularly with limited resources or expertise.
To contact professional services l
Send an email at
[email protected].
OpenText RightFax 10.6 Feature Pack 2
13
Administrator Guide
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
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.
Setting preferences
To open the Dialing Rule Copy Options settings l
Not copied: phonebook entries.
In the Preferences window, click the Dialing Rule Copy Options tab.
Copy with Phonebooks Only The user information and phonebook entries will be copied. Not copied: faxes.
Append Faxes and Phonebooks All faxes and phonebook entries for duplicate users 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. Not copied: user information.
Append Faxes Only All faxes for duplicate users 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.
Replace all rules on destination If selected, the dialing rules on the destination server will be deleted before the dialing rules from the source server are copied to the destination server.
Not copied: user information and phone book entries.
Copy ‘Receive into Local’ rules
Append Phonebooks Only
If selected, dialing rules set to receive into the local server will be included. Otherwise, these rules are ignored.
All phonebook entries for duplicate users will be copied. All phonebook entries from the source user account will be added to the destination user account.
Copy ‘Send Locally’ rules If selected, dialing rules set to send via the local server will be included. Otherwise, these rules are ignored.
Not copied: user information and faxes.
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. For information about dialing rules, see Creating dialing rules and Least-Cost Routing plans on page 185.
OpenText RightFax 10.6 Feature Pack 2
The General Preferences settings set general preferences for views and actions in Enterprise Fax Manager.
To open the General Preferences settings l
21
In the Preferences window, click the Preferences tab.
Administrator Guide
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. This changes the EFM server status icons to colors that can be read in this color mode.
Enable duplicate routing code warning If selected, a warning message appears when a user is created with a routing code already assigned to another user.
Enable service control warning If selected, a warning message appears when you make any changes to the state of any of the RightFax services.
Automatically re-open servers upon startup
Enable database locked warning
If selected, the servers that were open when you last quit EFM will be opened upon startup. Otherwise you have to open the servers each time.
If selected, a warning message appears when you attempt to access the database when it has been locked by certain database management tools.
Confirm object deletions
Viewing RightFax server information
If selected, the user must confirm the deletion before an object, such as a user or library document, is deleted.
To view the status of all open RightFax servers
Confirm object overwrites
l
If selected, the user must confirm overwriting an object, such as when an object with the same name is copied into the system.
In the left pane, at the top of the list, click Fax Servers. The right pane shows the following information about each open server. Column
Description
Automatically adjust status display column width If selected, the widths of the columns in the Server Status and Services pane will be adjusted to fit the column’s contents. This option does not affect the column widths in any other EFM view. You can still manually adjust the column widths, but the columns resize each time the screen image is refreshed. For information about the Server Status and Services pane, see Monitoring the status of RightFax servers and services on page 24
OpenText RightFax 10.6 Feature Pack 2
22
Administrator Guide
Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM)
Server name
The name of the open RightFax server and network protocol.
Working with objects
Fax board availability index
An icon to the left of the name indicates the status of the RightFax service. l
l
l
The higher the number, the more available the server is for sending faxes. RightFax uses this value when an outgoing fax number has two equally weighted dialing rules that send it to two different servers. RightFax sends the fax via the server with the highest availability index.
Green - All services are running normally. Yellow - One or more services are not running, Normal fax operations are available. Red - One or more services are not running. Normal fax operations are not available.
Version
The version of the RightFax server software.
Serial Number
The serial number entered when the RightFax server was installed. You must provide this number when you contact OpenText Customer Support.
Time running
The length of time that has elapsed since the RightFax Server service was last started. Display is in the format DDDD:HH:MM:SS.
Queue usage
The percentage of the fax server’s internal Event Queue that is currently in use. For more information on the RightFax Event Queue, see RightFax Internal Event Queue on page 16.
OpenText RightFax 10.6 Feature Pack 2
The relative availability of the server’s fax boards expressed as a number.
Character set mode
The OEM or ANSI code page being used by the server. The code page determines the language character sets that are supported for fax conversion.
Working with objects You can use standard Windows procedures to select objects, move columns, and to sort the objects in a list. Before adding objects, make sure you plan the structure and anticipate the needs of your network users. Consider groups within the organization, group or department cover sheets, and who will act as administrator or alternate administrator for the group. Determine a block of routing codes sufficient for the entire system and decide upon any custom notification types desired. Create new objects in RightFax only after you carefully consider these issues.
23
Administrator Guide
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.
EFM shows statistics and fax channel information and manages services on each RightFax server.
The following server statistics are available:
Note Remote DocTransports can be displayed in EFM but will not include data.
Server Statistic
Description
RightFax Event Queue Usage
The percentage of the fax server’s internal Event Queue currently in use. For more information, seeRightFax Internal Event Queue on page 16.
RightFax Events Processed
The total number of events processed by the fax server since the Server module was started.
Fax Availability Index
The relative availability of the fax boards on the server. The higher the number, the more available the server for sending faxes. 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, RightFax sends the fax via the server with the highest Availability Index.
To view and manage the status and services of each RightFax server l
Click the name of the server.
Current Faxes Queued for Sending The current number of outgoing faxes waiting to be sent.
If you are viewing EFM from the server, the top line of this window shows the most recent update time for the data display. If you logged on to EFM as administrator from a client machine, click Update Now to recompile and update the server statistics. This button is only active from the client software.
OpenText RightFax 10.6 Feature Pack 2
24
Current Pages Queued for Sending
The current number of outgoing fax pages waiting to be sent.
All-Time Send Attempts
The total number of faxes sent from this server since the AllTime Counter Starting Date.
Administrator Guide
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.
All-Time Pages Received
The total number of fax pages received on this server since the All-Time Counter Starting Date.
All-Time Counter Starting Date
Monitoring the status of RightFax servers and services
Operation
The current operational status of each channel.
Routing Code
The inbound routing code of this fax channel for incoming faxes.
User ID
The destination user ID of this fax channel for incoming faxes.
Monitoring services The lower-right pane of the window lists each RightFax service, its status (running or stopped), the length of time it has been running, and its startup method (manual or automatic).
The starting date from which the “All-Time” statistics are calculated. Note All of the All-Time statistics report an error message if you are running fax boards in simulation mode.
Note Monitoring services on remote servers requires network administrative access to the server as well as RightFax administrative access.
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. See your SQL documentation or the Microsoft site at http://technet.microsoft.com/enus/sqlserver/default.
l
Right-click the service, and then select Start Service or Stop Service from the shortcut menu.
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.
Monitoring queues
Fax channel information Description Channel
You can display a list of RightFax queues that show actions that are currently in process.
Each fax channel that is available on this RightFax server.
OpenText RightFax 10.6 Feature Pack 2
Right-click any service, and then select Start all Services or Stop all Services from the shortcut menu.
25
Administrator Guide
Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM)
To view the queues l
In the left pane, in the Fax Servers list, click the server, and then click Queues. The queues appear in the right pane.
For each queue, the number of items in the queue is shown, with the Value column showing the numeric and the Scale column showing the graphic format. The following queues appear: Displayed queue
Description
Pending conversion results
Number of results from WorkServer conversions not yet processed by a Server module.
Total server events
Total number of events currently scheduled on a Server module.
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, not yet sent)
Number of documents on DocTransport scheduled to be sent.
Documents sent by DocTransports(s) (send completed but not yet discovered by a FaxServ)
Number of documents sent by DocTransport, but not yet processed by a Server module.
Total documents
All documents in the system.
Deleted documents
All documents flagged in the database as deleted. Associated value fluctuates based on the days to keep deleted fax records setting of each user group.
OpenText RightFax 10.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.
Conversion events
Number of events in the queue that are preparing an outbound fax to be scheduled for transmission.
System messages in the database Messages from a Database module to a Server module that have deferred fax processing.
26
Quick kicks from Database module to Server module
Messages kicked by a Database module and passed to a Server module.
PCL5 conversion requests
Number of requests to convert PCL documents.
Postscript conversion requests
Number of requests to convert Postscript documents.
General purpose conversion requests
Number of requests to convert documents from any format, including compound requests for multiple types of conversion.
Coversheet creation requests
Number of requests to create cover sheets.
Gateway route requests
Number of requests from a Server module to gateways to pick up documents.
Administrator Guide
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. A configuration window opens.
In a shared services environment, you can create service configuration settings on one server, save them, and then copy them to the other nodes. The following table shows the services and settings that will be copied.
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, except service account and logging settings.
AutoReply
Responding to inbound faxes with AutoReply on page 1
Integration Module
All settings, except event log level settings,
Remoting Service
All settings, except logging settings.
Using RightFax email gateways on page 262 or respectively:
Server Module
All settings, except event log level, exclude this server, and service account settings.
Sync Module
All settings, except logging settings.
RightFax email gateway
l
l
RightFax Integration
The RightFax Connector for Microsoft Exchange Administrator Guide.
To copy the configuration settings of a service to other nodes
The RightFax Lotus Notes Module Administrator Guide .
1. On the RightFax server, start RightFax Enterprise Fax Manager.
The RightFax Integration Module Administrator Guide.
2. Click the name of the RightFax server that has the desired settings. 3. In the Service Name list, right-click the name of the service, and then click Copy Settings to Other Nodes.
While configuring a service, you can change the service accounts used for the different services. In a shared services environment, you can save time by creating the service configuration settings on one server, saving them, and then copying them to the other nodes.
OpenText RightFax 10.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.
27
Administrator Guide
Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM)
4. Clear the check boxes of those nodes to which the settings should not be copied, and then click OK.
Changing service accounts
predefined accounts.
Changing service accounts You can change the service accounts used for the services while configuring a service. One service account is initially selected during the RightFax installation. For each service, the service account used must have access to all the network resources required by that service. You can use a separate account for each service or a single account for multiple services. To change service accounts, for all services, first set the account for the Server Service and then copy the settings to the other services.
To view the service account settings l
On the Data Sharing tab in the Server Configuration window or the configuration window of another service, click Select Service Account. The Service Account Editor window opens, showing for each service the currently defined account. The default is to use one of the
To change service accounts 1. In the Service Account Editor window, next to the account you want to change, click Modify. To define account settings once and then copy them to all other services, first modify the Server Service Account.
OpenText RightFax 10.6 Feature Pack 2
28
Administrator Guide
Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM)
Synchronizing the RightFax server with external systems c. In the text box, enter a name or partial name, and then click Check Names. A list of account names appears from which to choose.
3. As needed enter the case-sensitive password for the selected user account in both the Password and Confirm Password boxes, and then click OK. 4. To copy the Server Service account information to the other services, click Copy to all. 5. Click OK.
2. Do one of the following: l Click Built-in Account, select one of the accounts from the list, and then click OK. l
Synchronizing the RightFax server with external systems
Click This Account, and then either type a new service account name or click Browse to find all user accounts on a specified network. After entering or selecting an account, click OK.
The RightFax WorkServer modules synchronize with external systems such as the Kofax NetScan user tables, library document catalogs, and import files for billing codes on a periodic, scheduled basis.
Caution If you manually type a name that is longer than 15 characters, you may encounter errors in services performed by the WorkServer. If the desired user account resides on a domain whose name is longer than 15 characters, select the user by clicking Browse.
You can force the server to synchronize immediately, without change of schedule.
To force the server to synchronize l
In the Select User window, make the following entries:
On the Utility menu, click Synchronize External Systems, and then click ASAP.
Running Enterprise Fax Manager Web Edition
a. To change the types of objects to search for, click Object Types, and then select Built-in security prinicipals, Users, or both.
You can remotely manage your RightFax servers using the Web-based version of Enterprise Fax Manager (EFM).
b. To change the location to search, click Location, and then select a location.
EFM Web Edition is included with all RightFax servers but must be installed separately on an IIS server on your
OpenText RightFax 10.6 Feature Pack 2
29
Administrator Guide
Chapter 4: Managing fax servers with RightFax Enterprise Fax Manager (EFM)
Changing service accounts
3. Enter the name of the RightFax server and a RightFax user ID and password that has administrative access to the RightFax server. Click Logon RightFax Server.
network. For more information, see the RightFax Installation Guide. Throughout this guide, references to EFM describe the Windows version of EFM. In almost all cases, the instructions also apply to the Web Edition.
4. The RightFax server opens in the frame in the left side of the page.
To open Enterprise Fax Manager Web Edition 1. Open a Web browser and point the URL to the /webefm folder on the IIS server. Example http://server.domain.com/webefm 2. Unless your IIS server is configured to allow anonymous access, a logon dialog box appears. Enter your logon information to log on to the IIS server, and then click OK. The browser prompts you for information to open a RightFax server.
5. Managing RightFax servers in EFM Web Edition is similar to managing RightFax servers in EFM for Windows.
To change the language of EFM Web Edition l
OpenText RightFax 10.6 Feature Pack 2
30
On the Language menu in the upper-right corner of the page, select the language.
Administrator Guide
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, controls the conversion of outgoing faxes, and works with the RightFax DocTransport module to schedule outgoing faxes and route inbound faxes. You can configure the RightFax Server module to customize global fax settings, inbound fax routing, and notifications about document processing and server status.
To configure the RightFax Server module 1. On the RightFax server, start RightFax Enterprise Fax Manager. For more information, see Starting Enterprise Fax Manager on page 18. 2. In the left pane, click the name of the RightFax server.The list of services appears at the lower-right pane of the window. 3. In the list of services, double-click RightFax Server Module. The Server Configuration window opens.
Enable CSID Routing Select this check box to enable automatic inbound routing using CSID (caller subscriber identification).
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. The CSID is different for each caller, and can be anything from a phone number to a company name.
In the Server Configuration window, click the General tab.
OpenText RightFax 10.6 Feature Pack 2
31
Administrator Guide
Chapter 5: Configuring the RightFax Server module
If you select to enable CSID routing, you must create a CSID routing table listing RightFax routing codes and the CSIDs to route to them. For more information on CSID routing and creating a CSID routing table see Configuring CSID routing on page 223.
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.
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.
Delay All Faxes Until Specify the time of day after which all faxes sent by users without RightFax administrative access will be sent. To send faxes without delay, select None Set.
The TTI line lists the date, time, page number, total pages, and fax ID at the top of each fax page.
Forced delays can also be set for groups of RightFax users. For more information on groups, see Creating groups of users on page 124.
If you select to enable quick headers, you can customize the text in the DocTransport module (see Configuring Brooktrout global transport settings on page 64).
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.
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. RightFax uses the user ID called "Default" as a template when creating new users.
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. The RightFax client application writes the list of currently active members to its local registry. Clear the check box if you are using a load balancing solution for your client connections.
Disable Routing of Faxes with Errors Select this check box to prevent routing of incomplete faxes through an email gateway or network directory. Faxes with errors will still be available through FaxUtil with the status "Incompletely Received."
Enable Notifications
Event Log Level
Select this check box to send notification messages to RightFax users based on the notification options specified in FaxUtil.
Select at which level to log information in the Application Event Log under the service name “RightFax Server Module.” l
None No information.
l
Terse Critical errors only.
l
Normal Errors and major events only.
OpenText RightFax 10.6 Feature Pack 2
Verbose All significant events. Use temporarily to track and resolve problems.
Note By default, the RightFax server sends periodic notifications to users every five minutes. To change this interval, modify the Notify_Freq keyword in the Windows Registry. See Notify_Freq on page 350.
32
Administrator Guide
Chapter 5: Configuring the RightFax Server module
When using notifications, specify how often to send reminders to users and administrators that a fax has not yet been viewed or printed. See Reminder notifications settings on page 33.
To not send reminders to this user type, select Never.
l
To send a reminder once, select Once.
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. You are asked to confirm the selection as this setting cannot be changed after it has been made.
To send multiple reminders, select Duration, and in the minutes box, enter in minutes for how long this user type will receive reminder notifications.
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, such as a busy signal.
Caution This check box cannot be cleared after you select it and confirm the selection. You can encrypt the image directory if you have a license to do so. By default, files in the image directory are stored in compressed graphic image (CCITT Group III) format and are not encrypted.
Note The count of attempts includes the first attempt.
Count Specify the number of times an outgoing fax transmission will be attempted.
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. Reminder notifications are escalated from user to group administrator and from group administrator to alternate group administrators.
Specify the minimum delay in minutes before a failed fax transmission is rescheduled to send.
SMS Count Specify the number of times an outgoing notification will be attempted.
Send reminders every
SMS Interval
In the minutes box, enter a number for the time interval at which to send reminders.
Specify the minimum delay in minutes before a failed notification is rescheduled to send.
Reminders will be sent in this sequence
While a fax is being retried, it appears with a yellow status icon in the sender’s FaxUtil mailbox. If the fax has not been successfully sent after the specified number of attempts, it will be abandoned and saved in the sender’s FaxUtil mailbox with a red status icon. The sender can force RightFax to
For each user type listed (User, Group Administrator, Alternate Group Administrator) specify if reminder notifications should be sent. After notifications have been sent or not sent according to the settings for one user type, the settings for the next user type come into effect.
OpenText RightFax 10.6 Feature Pack 2
l
33
Administrator Guide
Chapter 5: Configuring the RightFax Server module
Configuring the advanced settings
manually retry sending the fax by selecting the fax and pressing CTRL+K.
l
l
Configuring the advanced settings
Verbose All significant events. 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.
To open the advanced settings l
Normal Errors and major events only.
In the Server Configuration window, click the Advanced tab.
Maintenance cycle Scheduled Time Enter the time of day when the server will perform its daily maintenance (such as automatic file backup, fax aging, and purging). Choose a time with low server activity.
Exclude this server In a shared services environment, select this check box if maintenance should not be run on this server.
Purge audit data older than Select to specify when to purge audit data. In the days box, enter the number of days after which to purge the data.
Billing code settings Billing code settings can be changed without stopping and restarting the RightFax services.
Database settings
Validate from Email Gateways
Event LogLevel
Select this check box to validate all billing codes added to fax-bound email messages. If a billing code cannot be validated, the fax will not send and the user will receive notification that the fax did not send due to an invalid billing code. If this check box is cleared, billing codes can be added, 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.
l
Terse Critical errors only.
OpenText RightFax 10.6 Feature Pack 2
34
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. This gives the user the ability to validate faxes based on several different criteria, not just billing codes. This requires a program written using the RightFax API to perform the verification of billing codes. For information on downloading and using the RightFax API, visit the OpenText Knowledge Center at knowledge.opentext.com.
For information about the remaining external document connector settings, see the RightFax XML GeneratorAdministrator Guide or the RightFax Vault Administrator Guide.
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 [...]. For more information on changing and editing the connections to the RightFax database on the SQL server, see Changing the connection to the SQL server on page 302.
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.
Character Set Mode
Field 1 or Field 2 One of the billing code fields must contain a valid code, but not both.
ANSI Mode Select this check box to use the ANSI code page for the character sets used in faxed documents. Clear it to use the default OEM code page and character sets.
Field 1 Only The Billing Code 1 field must contain a valid code. Field 2 Only The Billing Code 2 field 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. Selecting the ANSI code page can resolve this.
The external document connector is used to:
MSMQ server
l
l
Integrate RightFax and third-party systems such as FileNet.
Enter the name of the server on which the Microsoft Message Queue service is installed. All servers on the RightFax system must point to the same MSMQ Server.
Save faxes with XML metadata to be used by an external archiving or document management system.
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.
Select the Enabled check box. In all other cases, clear the check box.
OpenText RightFax 10.6 Feature Pack 2
35
Administrator Guide
Chapter 5: Configuring the RightFax Server module
Configuring feature activation
2. Click the name of the RightFax server in the tree in the left pane of the Enterprise Fax Manager window.The list of services appears at the lower-right pane of the window.
IIS server Enter the IIS server where Web Access or Web Client is installed.
Use SSL
3. In the Service Name list, double-click RightFax Licensing Service (or right-click and choose Status from the menu). The Licensing Service Status dialog box opens.
Select to send the link as a secure ("https://) HTTP link.
Provide link to Specify the web application for web delivery of faxes: l
l
4. The status shows the enabled services with information about each license. Use the scroll bars to view additional services, if necessary.
Web Access. The link and URL provided in the email notification will open the fax in Web Access. Web Client. The link and URL provided in the email notification will open the fax in Web Access.
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).
Use the Product Licensing Utility (PLU) to change or add to your feature set. If you are unsure about the current licenses on a server, you can look them up in Enterprise Fax Manager.
To launch the Product Licensing Utility (PLU) 1. In the Server Configuration window, click the Feature Activation tab. 2. Click Product Licensing Utility. For more information on upgrading your server license, adding additional fax channels, and adding new RightFax components, refer to the RightFax Installation Guide.
To show the current licenses on a server 1. On the RightFax server, on the Start menu, point to Programs, then Open Text, and then click RightFax Enterprise Fax Manager.
OpenText RightFax 10.6 Feature Pack 2
36
Administrator Guide
Chapter 5: Configuring the RightFax Server module
Configuring feature activation
Notification messages can contain a combination of text and variable data. The maximum length of a notification message is 200 characters. If you include a URL, the maximum length is for both the URL and the message text. The maximum length of the URL is 80 characters. The variable options for each message are described in the following table. 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.
~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.
~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.
~3 = Unique ID of the fax The server cannot generate a fax image.
~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 Feature Pack 2
A bad form was specified.
37
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.
~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. 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.6 Feature Pack 2
38
Administrator Guide
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.
~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.
Fax needs approval
~1 = User ID ~2 = Recipient’s name
One of the sender’s outgoing faxes needs approval.
~3 = Recipient’s fax number ~4 = Unique ID of the fax ~5 = Subject line of original fax email
OpenText RightFax 10.6 Feature Pack 2
39
Administrator Guide
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. Fax numbers can be blocked using either dialing rules or the call blocking Windows Registry entry on the DocTransport.
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.)
~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.
~9 = Unique ID of the fax To return a notification message to the default setting, select the text, delete it, and then click OK. The next time you open the dialog box, the default message will be listed.
~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. 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.6 Feature Pack 2
40
Administrator Guide
Chapter 5: Configuring the RightFax Server module
Configuring feature activation
on configuring SMS and pager notifications, see Adding SMS and pager services on page 161.
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.
~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, enter the custom message text you want. Each message type has its own set of variables, described in the following table. 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.
OpenText RightFax 10.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 fax recipient notification address is entered by the RightFax client user when creating a new outbound fax.
To return a notification message to the default setting, select the text, delete it, and then click OK. The next time you open the dialog box, the default message will be listed.
41
Administrator Guide
Chapter 5: Configuring the RightFax Server module
Configuring admin messages
For each admin message type, enter the custom message text you want. Each message type has its own set of available variables, described in the following table.
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). For information about configuring SMS and pager notifications in RightFax, see Adding SMS and pager services on page 161.
Alert
Default message
BoardServer All DocTransports are failed, none down. Fax sending and running receiving is not currently operating.
Variables None
BoardServer The DocTransport on ~1 ~1 = DocTransport failed, one is no longer running. Fax machine running sending and receiving operations are functioning on other DocTransports.
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, alert types, and alert messages to send. For more information about the RightFax Alerting and Monitoring service, see Using the Alerting and Monitoring service on page 165.
Disk space critically low
One or more drives on the None fax server are critically low on disk space (
OpenText RightFax 10.6 Feature Pack 2
378
Administrator Guide
Chapter 41: Web Services API
Sample Web.config
type="System.Web.Profile.SqlProfileProvider" connectionStringName="ApplicationServices" applicationName="/"/>
messageEncoding="Text" textEncoding="utf-8" transferMode="Buffered" useDefaultWebProxy="true">
