Page 1 Dialogic® Brooktrout® Fax Products Windows End User Guide SDK 6.6 March 2013 931-140-14 www.dialogic.com...
Page 2 It is possible that the use or implementation of any one of the concepts, applications, or ideas described in this document, in marketing collateral produced by or on web pages maintained by Dialogic may infringe one or more patents or other intellectual property rights owned by third parties.
Page 3: Hardware Limited Warranty
Refer to the following Dialogic web site for information on hardware warranty information, which applies unless different terms have been agreed to in a signed agreement between yourself and Dialogic Corporation or its subsidiaries. The listed hardware warranty periods and terms are subject to change without notice. For purchases not made directly from Dialogic please contact your direct vendor in connection with the warranty period and terms that they offer.
Page 4: Table Of Contents
............18 Chapter 2 – Installing Dialogic® Brooktrout® TR1034 and TruFax®...
Page 5 Contents Chapter 3 – Activating Dialogic® Brooktrout® SR140 Software. . 26 Preparing for Activation ........... . 28 Using the License Manager .
Page 6 ........127 Chapter 5 – Testing Dialogic® Brooktrout® SR140 Software and TR1034/TruFax®...
Page 7: About This Publication
Dialogic® Brooktrout® SR140 Fax Software Dialogic® Brooktrout® TR1034 Series and Dialogic Brooktrout® TruFax® boards. Refer to the Dialogic® Brooktrout® Fax Products Linux End User Guide if you operate in a Linux environment. This document contains the following chapters: Chapter 1 explains how you get started installing and configuring Dialogic®...
Page 8: Manual Conventions
C++. Programming code appears in program examples. Bold indicates the data type of the prototype of a function, Dialogic® Brooktrout® Bfv API functions, dialog boxes, dialog box controls, windows, and menu items. Square brackets [ ] indicate that the information to be typed is optional.
Page 9: Sr140 Telephony Requirements
SR140 Telephony Requirements SR140 Telephony Requirements Physical Media Call Control Ethernet 10/100 T.38 v0 or v3 H.323 RTP V2 G.711 March 2013...
Page 10: Terminology
The current version of this document includes terminology that differs from previous versions. Please note the changes below: Former Terminology Replaced with... Host-based fax Dialogic® Brooktrout® SR140 Fax Software Virtual modules Brooktrout SR140 Fax Software Virtual boards Software modules SR140 Software...
Page 11: Dialogic® Brooktrout® Tr1034 Fax Board Terminology
Terminology Dialogic® Brooktrout® TR1034 Fax Board Terminology The Dialogic® Brooktrout® TR1034 Fax Board is also referred to herein by one or more of the following terms, or like terms including “TR1034”: Brooktrout TR1034 Fax Board Brooktrout TR1034 Board TR1034 Fax Board...
Page 12: Getting Technical Support
Getting Technical Support Getting Technical Support Dialogic provides technical services and support for customers who have purchased hardware or software products from Dialogic. If you purchased products from a reseller, please contact that reseller for technical support. To obtain technical support, please use the web site below: www.dialogic.com/support...
Page 13: Chapter 1 - Getting Started
This chapter provides an introduction and quick start installation instructions for installing the Dialogic® Brooktrout® software and hardware in a Windows environment. Refer to the Dialogic® Brooktrout® SR140 Fax Products Linux User Guide if you operate in a Linux environment. March 2013...
Page 14: Fax Board And Virtual Modules (Sr140)
Vendor) partner’s fax application with the capability to communicate from their application to the telephone or IP network. For software-only systems using IP only, Dialogic implemented the SR140 as a virtual module. Although it is software, the SR140 appears to the fax application just like a board. That helps simplify your fax application publisher to provide a single product that works for hardware and software.
Page 15: Sr140 Product Family
SR140 Product Family SR140 Product Family There are two major SR140 products, the original full SR140 and the SR140-L. Each product differs in the available functionality, with the full SR140 having the highest functionality. The tables below summarize the feature set available for the different SR140 products over the course of their release history.
Page 16: Feature Pack Licenses
SR140 Product Family Table 2. SR140-L Release History Release Date Example Model Name Feature Set April 2010 SR140-L-4-R1 Maximum eight channels per system T.38 V.17 Advanced Fax (Very High Res, MMR, JBIG/Color pass- through) Feature Pack Licenses Feature pack licenses are available to allow you to add features matching a later release.
Page 17: Upgrade Licenses
SR140 Product Family Upgrade Licenses Upgrade licenses allow you to add the feature set of the full SR140 to the SR140-L. The upgrade license is added to your existing license to bring you up to the latest set of available features. For example an SR140-L-2-R1 together with a SR140-L-UPGRADE- SR140-2-R3 will have the same features as an SR140-2-R3.
Page 18: Software Licenses
The SR140 Virtual Module is delivered together with your fax application. The SR140 license is the right to use the software products in an entitlement purchased from Dialogic. The license is represented by the contents of a License File that is used by the software to restrict use to that entitlement.
Page 19: Hardware
Product Activation Getting it Working Follow the steps below to get your Brooktrout fax hardware and/or software working. Hardware Installation Installing Dialogic® Brooktrout® TR1034 and TruFax® Hardware on page 20 Product Activation Activating Dialogic® Brooktrout® SR140 Software on page Configuration Configuring Dialogic®...
Page 20 TR1034 and TruFax® Hardware This chapter applies to users of the Dialogic® Brooktrout® TR1034 Series and Dialogic® Brooktrout® TruFax® boards. This chapter does not apply to users of the Dialogic® Brooktrout® SR140 Fax Software. For detailed hardware installation instructions, see the hardware installation card that came with your Brooktrout board.
Page 21: Installation Overview
This section describes how to install your fax board on a Windows Server 2003 system. If you already have the Dialogic® Brooktrout® Runtime Software installed and working on your system, do the following: Check your system to verify the minimum system requirements.
Page 22: Installing Your Board
Installing Your Board Installing Your Board Before installing your board, make sure you have assigned the board a unique module number. Follow these instructions to install your Brooktrout board into your computer: 1. Power off your PC and any peripheral equipment connected to it. 2.
Page 23: Verifying Brooktrout Board Installation
Installing Your Board Verifying Brooktrout Board Installation Verify that the Brooktrout board is successfully installed in your system: 1. Click either: Control Panel, Administrative Tools, Computer Management Control Panel, System, Hardware, Device Manager The following screens appear, respectively. 2. After installing your Brooktrout fax board, allow Windows Plug and Play to locate and accept the device driver for the Brooktrout board.
Page 24 Installing Your Board After installing the Plug and Play driver on a Windows 2012 Note: system, click the small flag in lower right hand corner to open Action Center. The following dialog box appears: Click Finish installing device software. March 2013...
Page 25: Viewing Brooktrout Board Properties
Installing Your Board Viewing Brooktrout Board Properties To view the board’s properties: 1. Double-click the board name in one of the screens, as shown in the above window. The Brooktrout TRxStream Board Properties dialog box appears. 2. Click the Device Details tab. 3.
Page 26: Chapter 3 - Activating Dialogic® Brooktrout® Sr140 Software
3 - Activating Dialogic® Brooktrout® SR140 Software This chapter describes how to activate a license for the Dialogic® Brooktrout® SR140 Fax Software. The SR140 Fax Software functionality is protected against piracy and abuse by licensing technology that uses product activation. A License Key is sold to the user who exchanges the key for a license file during or after installing the software.
Page 27 The Node ID of the license matches the Node ID of the computer (sometimes referred to as the “Node Lock” of the computer). The system clock is not set back. Please contact Dialogic Technical Services and Support if you are unable to use the license. See Getting Technical Support on page This document has the following sections: Preparing for Activation on page 28.
Page 28: Preparing For Activation
Preparing for Activation To use the License Manager to activate your Brooktrout product, perform the activation process from the system where the Dialogic® Brooktrout® SR140 Fax Software is installed. Once the license is activated, install the license file on that system (unless you activate automatically which does not require installation).
Page 29: Using The License Manager
Using the License Manager Using the License Manager The License Manager application is usually installed with your fax application. To start the License Manager, use one of the following methods: Start the License Manager from the Configuration Tool Select Start → Program Files → Brooktrout → Brooktrout License Manager If you accepted the standard location to install your software, double-click the brktlicmgr.exe file at the following location:...
Page 30: Displaying And Copying Node Ids
Using the License Manager Displaying and Copying Node IDs There may be more than one MAC address on the system. If so, you can choose the MAC address in which to lock. The License Manager allows you to view the Node ID representation of the first 20 Ethernet Adapter MAC addresses available on the system.
Page 31: Displaying And Copying Node Id
Using the License Manager Displaying and Copying Node ID Follow the steps below to display and copy a Node ID (referred to as Node Lock in the screen below). 1. From the Utilities menu, select Display Node Lock. A screen like the following appears: 2.
Page 32: Starting The License Activation Wizard
Starting the License Activation Wizard Starting the License Activation Wizard Start up the License Activation Wizard by selecting Activate License from the License menu. 1. Select License -> Activate license... If a Demonstration License Key file (.dlk) file is located, then the License Activation Wizard Welcome dialog below appears.
Page 33 Starting the License Activation Wizard Welcome Dialog (no .dlk file) 3. Click Next. The Activation Method dialog box appears: 4. Select an Activation Method. Automatically (this computer is connected to the Internet) Activates licenses automatically to the machine performing the activation. This is the easiest method if your computer is connected to the Internet.
Page 34 After successfully processing activation information, you can choose to download the file immediately or have the license emailed to you. Within a couple of minutes Dialogic sends an email containing a license file, if you select to have the license emailed to you. To complete the activation process, use the License Manager interface to install the license file(s) on the machine specified.
Page 35: Activating A License Automatically
Activating a License Automatically Activating a License Automatically To activate a Brooktrout license using the automatic activation method, follow the steps below: 1. Select the automatic activation option above. If you chose the option Use license key provided with my application on the Welcome dialog then skip to step 5 below.
Page 36 Activating a License Automatically 3. The Please enter License Key dialog box appears: 4. Enter the License Key and Click OK. 5. The Product Registration window appears: For your convenience, Product Registration follows activation in the same session using the License Activation Wizard. 6.
Page 37 Activating a License Automatically 7. Verify that your computer is connected to the Internet. 8. Click Next to begin processing your license request. The License Manager sends the license request to the Dialogic License Activation Center, where your license request is processed.
Page 38 License Activation Center computer is temporarily unavailable or you are experiencing temporary Internet problems. Attempt to correct the problem and retry the request. When using the access numbers, if failures persist, contact Dialogic Technical Services and Support. See Getting Technical Support on page Request Failed.
Page 39: Overriding The Default Mac Address Used For Node Locking
Activating a License Automatically Overriding the Default MAC Address Used for Node Locking Note: The follow procedure applies only to automated license activation. In some cases, when you have multiple MAC addresses in your system, you may want to use a different MAC address other than the default MAC address used for node locking.
Page 40: Activating A License Using The Web
Activating a License Using the Web Activating a License Using the Web You can also activate your SR140 Fax Software license on the web using a computer that has web access. This can be a different computer than the server on which you are installing the SR140 virtual module.
Page 41 Node Lock under the Utilities menu in the License Manager window. 4. On a computer that has Internet Access, enter the web address www.dialogic.com/activation, which directs you to a secure server. The following screen appears. 5. Enter your original License Key (this can be found on your License certificate) and click Submit.
Page 42 Activating a License Using the Web 6. Click Generate Licenses. The following screen appears. March 2013...
Page 43 Activating a License Using the Web 7. Select the Product you are activating. Select the Node ID Type and enter the Node ID. If you are using License Manager version 2.0 or greater, select Node ID type VID. If you are using an earlier version than 2.0, select Node ID type COMPOSITE.
Page 44 Activating a License Using the Web 9. Verify that the information on this screen is correct and click Confirm. The following screen appears. 10. Click Save to File to save the license file to your computer or click Email to have the License file emailed to you. The following screen appears.
Page 45 Activating a License Using the Web 11. Follow the instructions Installing Licenses on page 48 to install the license file. March 2013...
Page 46: Activating A License Using Email Or Fax
Internet connections) you can activate your license by sending the information to Dialogic using email or fax. Note: If you activate your license by email or fax, Dialogic will send you the license file in about one business day.
Page 47 Product Registration dialog boxes to a text file. 7. Email the saved file to activation@dialogic.com as an attachment, or fax this information to +1 781-433-2350 at the Dialogic License Activation Center for processing. When you receive the license file from Dialogic, go to...
Page 48: Installing Licenses
Installing Licenses Installing Licenses When you receive a license file from the Dialogic License Activation Center (via email or saved from the site) use the License Manager application to install the attached license. If you receive the license file via email, the licensing information is sent to you in the body of the e-mail.
Page 49 Installing Licenses 4. Select Install previously activated license… from the License menu. The following screen appears: 5. Browse to the location of the license file. 6. Highlight the filename, then click Open to activate your product. Note: When the application is installed, an environment variable is created called: BRKTD_LICENSE_FILE, which refers to a file directory used by the License Manager to store license files.
Page 50: Logging Information
The application logs all messages preceding the error condition as well as messages following the error event. This log is helpful to Dialogic Technical Services and Support when solving problems. In addition, you can execute the License Manager with the /d or -- debug option.
Page 51: Managing License Files
Managing License Files Managing License Files The section contains the following instructions to manage the license files: Naming License Files on page 52 Backing Up Licenses on page 52 Removing Licenses on page 52 Re-Installing Your Product on page 54 Restoring License Files on page 55 Re-Hosting License Files on page 57 You can find license files (*.lic) in the path specified by the following...
Page 52: Naming License Files
Managing License Files Naming License Files All license files end with the .lic extension. One file can contain one or more licenses. The license filename is usually in either form: dd-mmm-yyyy.lic dd-mmm-yyyy-x.lic (next available number) However, the license filename can be any filename with a .lic extension.
Page 53: Re-Installing A License
Managing License Files 7. A popup will appear indicating the license key and file name of the file which was removed. 8. The selected file will be renamed from licensefile.lic to licensefile.lic.removed. This file is located in the directory which the environment variable BRKTD_LICENSE_FILE (typically C:\Program Files\Common Files\Brooktrout\) refers to.
Page 54: Re-Installing Your Product
Managing License Files Re-Installing Your Product If you want to simply re-install your product on the same computer system after upgrading or replacing your hard disk or any other upgrade that maintains your network card’s MAC address, you can use the same license file without having to re-activate your product. March 2013...
Page 55: Restoring License Files
If anything ever happens to your computer that leads to corruption of your software and the License File, retrieving another copy is a simple procedure. To retrieve another copy of your License File, 1. Visit the Dialogic activation website at: www.dialogic.com/activation The following screen appears.
Page 56 Managing License Files 3. Click View Licenses. The following screen appears. 4. In the Select Product window, select your product and then select the appropriate Node ID. Click View. The following screen appears. 5. Click Save to File or click Email to have the License file emailed to you.
Page 57: Re-Hosting License Files
Re-Hosting License Files To allow you to upgrade your computer to a new system or recover from a network card failure, Dialogic allows you to “re-host” your licensed software from one computer system to another. This process involves returning your current license and receiving another one.
Page 58 Managing License Files 3. Click Re-host Licenses. The following screen appears. 4. Select your product and click Return to return the license to Dialogic. The following screen appears. March 2013...
Page 59 Managing License Files 5. Verify that the information on this screen is correct and click Confirm. The following screen appears. March 2013...
Page 60 Managing License Files 6. In the Select Product box click the product for which you are re- hosting. Select the Node ID Type and enter the Node ID. The Node ID Type must be VID (Vendor Defined Node ID) if you are using License Manager Version 2.0 or later.
Page 61 Managing License Files 7. Click Generate License. The following screen appears. 8. Click Confirm. The following license appears. March 2013...
Page 62 Managing License Files 9. Click Save to File to save the license file to your computer or click Email to have the License file emailed to you. The following screen appears. 10. Follow the instructions Installing Licenses on page 48 to use the License Manager application to install the license file on the appropriate computer.
Page 63: Chapter 4 - Configuring Dialogic® Brooktrout® Sr140 Software And Tr1034/Trufax® Boards
SR140 Software and TR1034/TruFax® Boards This chapter describes how to configure the following products: Dialogic® Brooktrout® SR140 Fax Software Dialogic® Brooktrout® TR1034 Series and Dialogic® Brooktrout® TruFax® boards Dialogic provides the following configuration methods: Configuring in Wizard Mode on page 66...
Page 64: Running The Dialogic® Brooktrout® Configuration Tool For The First Time
Running the Dialogic® Brooktrout® Configuration Tool for the First Time Running the Dialogic® Brooktrout® Configuration Tool for the First Time When you start the Configuration Tool for the first time, you may get box pop up. Only change the locations for the...
Page 65 Running the Dialogic® Brooktrout® Configuration Tool for the First Time H.323 - H.323 stack installed Both (SIP and H.323) - Both SIP and H.323 stacks installed. March 2013...
Page 66: Configuring In Wizard Mode
Configuring in Wizard Mode This section describes how to use the Wizard Mode to configure Dialogic® Brooktrout® Fax Software. You can use Wizard Mode to get most typical systems up and running with minimal effort. In Wizard Mode, after you answer the basic questions, the Configuration Tool does the following.
Page 67 Configuring in Wizard Mode 2. The Welcome window appears. 3. When the Welcome window appears, you can choose to click the Advanced Mode button or the Next button. Advanced Mode If you select Advanced Mode, the Configuration Tool exits Wizard Mode and starts in Advanced Mode (see Configuring in Advanced Mode on page 92).
Page 68 Configuring in Wizard Mode 4. The System Report appears on the right-hand panel, then click Next. This example shows the information for a T1 board. 5. Click Next and the following screen appears if the system detects a board that supports both IP and PSTN. 6.
Page 69: Configuring Ip Call Control
Configuring in Wizard Mode If you want to configure PSTN call control, select Public Switched Telephone Network (PSTN) and refer to Configuring PSTN on page 88 Configuring IP Call Control Follow the steps below to configure IP Call Control: 1. The following screen appears either after you select Internet Protocol (IP) Network or if your system supports only IP Call Control.
Page 70 The following screen appears if the systems supports IPv4 and IPv6. IPv6 is only supported on the Dialogic® Brooktrout® SR140. If a Dialogic® Brooktrout® TR1034 is present in the system or using H.323, the dialog will not be available. March 2013...
Page 71 Configuring in Wizard Mode 4. Select the appropriate Internet Protocol supported by your provider. Click Next. The following screen appears if there are multiple IP Interfaces detected in the system. 5. The IPv4 and IPv6 options are available based on what the system supports and the selected Internet Protocol preference.
Page 72: Configuring Sip Call Control Protocol
Configuring in Wizard Mode Configuring SIP Call Control Protocol The section contains the following procedures. Configuring Direct Routing by the Application on page 72 Configuring SIP Call Control with Gateway or IP-PBX on page 73 Configuring SIP Call Control with a Proxy Server on page 74 Configuring Direct Routing by the Application If you chose to configure the SIP Call Control protocol the following screen appears:...
Page 73 Configuring in Wizard Mode Configuring SIP Call Control with Gateway or IP-PBX If you chose to configure the SIP Call Control, the following screen appears. Follow the steps below to configure SIP Call Control with a Gateway or IP-PBX. 1. Select Automatic routing to a Gateway or IP-PBX. Click Next and the following screen appears.
Page 74 Configuring in Wizard Mode 2. Enter the Primary Gateway. Click Next and refer to Configuring the SIP Registrar on page Configuring SIP Call Control with a Proxy Server If you chose to configure the SIP Call Control the following screen appears.
Page 75 Configuring in Wizard Mode Follow the steps below to configure SIP Call Control with a SIP Proxy Server 1. Select Dynamic routing by a Proxy Server. Click Next and the following screen appears. March 2013...
Page 76 Configuring in Wizard Mode 2. Enter the IP address of the Primary Proxy Server and select Yes if there are additional proxy servers to configure. Click Next and the following screen appears. 3. Enter the IP address of any additional proxy servers. Click Next and continue to the next step Configuring the SIP Registrar on page...
Page 77 Configuring in Wizard Mode Configuring the SIP Registrar When the screen below appears, you can configure a SIP Registrar. 1. From the screen above, select Yes to set up a SIP registrar. Click Next and the following screen appears. March 2013...
Page 78 Configuring in Wizard Mode 2. Complete the information on this screen and click Next. The following screen appears. 3. Select Yes to configure additional registrar servers. The following screen appears. 4. Enter the IP addresses of the additional registrar servers. Click Next and the following screen appears.
Page 79 Configuring in Wizard Mode Configuring SIP Fax Setup When the screen below appears, you can configure Fax. 1. Configure the fax transmission and the configuration is complete. Click Next and refer to Applying Changes after the Configuration is Complete on page March 2013...
Page 80: Configuring H.323 Call Control
Configuring in Wizard Mode Configuring H.323 Call Control You can configure H.323 Call Control three ways: Configuring H.323 Direct Routing by the Application on page 80 Configuring H323 Call Control with a Gateway on page 81 Configuring H.323 Call Control with a Gatekeeper on page 82 Configuring H.323 Direct Routing by the Application If you chose to configure the H.323 Call Control, protocol the following screen appears.
Page 81 Configuring in Wizard Mode Configuring H323 Call Control with a Gateway If you chose to configure the H.323 Call Control protocol the following screen appears. Follow the steps below to configure H.323 Call Control with a Gateway or IP-PBX. 1. Select Automatic Routing to a Gateway or IP-PBX. Click Next and the following screen appears.
Page 82 Configuring in Wizard Mode 2. Enter the Primary Gateway IP address. Click Next and refer to Configuring H.323 Fax Setup on page Configuring H.323 Call Control with a Gatekeeper If you chose to configure the H.323 Call Control protocol the following screen appears.
Page 83 Configuring in Wizard Mode Follow the steps below to configure H.323 Call Control with a Gatekeeper: 1. Select Dynamic Routing by a Gatekeeper. Click Next and the following screen appears. 2. Enter the IP Address of the Primary Gatekeeper. Click Next and the following screen appears.
Page 84 Configuring in Wizard Mode 3. Select Yes to specify additional gatekeepers. Click Next and the following screen appears. 4. Enter the IP addresses of the additional gatekeepers. Click Next and refer to Configuring H.323 Fax Setup on page Configuring H.323 Fax Setup When the screen below appears, you can configure Fax.
Page 85 Configuring in Wizard Mode 1. Configure the fax transmission and the configuration is complete. Click Next and refer to Applying Changes after the Configuration is Complete on page March 2013...
Page 86: Applying Changes After The Configuration Is Complete
Configuring in Wizard Mode Applying Changes after the Configuration is Complete Follow the steps below to save apply the changes. 1. Click either Save and Exit, Help, Back, Apply, or Cancel. Save and Exit Save the configuration and Exit without initializing the modules.
Page 87 Configuring in Wizard Mode 2. Click Apply and the board is initialized and configured. The following screen appears. March 2013...
Page 88: Configuring Pstn
Configuring in Wizard Mode Configuring PSTN Dialogic recommends that you accept the defaults that are based on Protocol Options the modules the Configuration Tool identified in your system. In this example, the module uses the T1 ISDN protocol. Note: In Wizard Mode all the ports of all the modules will be configured with the same port setting.
Page 89 Configuring in Wizard Mode See the Configuration Files in Volume 6 of the Dialogic® Brooktrout® Bfv API Reference Manual for more information about the protocol parameters. Note: In wizard mode all the ports of all the modules will be configured with the same port setting.
Page 90 Configuring in Wizard Mode The following screen appears. 3. Click either Save and Exit, Help, Back, Apply, or Cancel. Save and Exit Save the configuration and Exits without initializing the modules. Help Displays help for the Configuration Tool. Back Displays previous page. Apply Saves the configuration and initializes the modules.
Page 91 Configuring in Wizard Mode 5. Click Finish to complete the configuration. March 2013...
Page 92: Configuring In Advanced Mode
Configuring in Advanced Mode Configuring in Advanced Mode If you have different types of Dialogic® Brooktrout® modules in your system or you want to configure your identical modules differently, you must use Advanced Mode: When the Dialogic® Brooktrout® Configuration Tool detects that you have different modules, it starts in Advanced Mode.
Page 93 Select Driver Parameters to display the Driver Parameters dialog box. For sample values, see Getting Help From the Dialogic® Brooktrout® Configuration Tool on page Select BTCall Parameters to display the BTCall Parameters dialog box. For sample values, see...
Page 94 Configuring in Advanced Mode When a parameter panel (for example: Driver Parameters, BTCall Show Advanced Button Parameters, Call Control Parameters) has advanced settings, the Show Advanced >> button appears on the bottom right of the right panel. When you click Show Advanced, the Advanced Settings portion of the Hide Advanced Button panel appears, and the Hide Advanced <<...
Page 95 Note: Most users never need to alter the Advanced Settings parameter values. If you know these settings are incorrect, please contact Dialogic Technical Services and Support for more information. See Getting Technical Support on page March 2013...
Page 96: Getting Help From The Dialogic® Brooktrout® Configuration Tool
Configuring in Advanced Mode Getting Help From the Dialogic® Brooktrout® Configuration Tool The Dialogic® Brooktrout® Configuration Tool provides context sensitive online help for parameters. The Help displays the purpose and description of the parameter including the default value and range, if applicable.
Page 97 Configuring in Advanced Mode Right-click the parameter drop-down box to get a more complete definition for Configuration Tool parameters. The What’s This? popup menu appears: Left-click the What’s This? popup menu for a definition like the following. You can resize this text box, if necessary. March 2013...
Page 98 Configuring in Advanced Mode Select About from the Help menu to display the version and copyright information for the Brooktrout Configuration Tool. March 2013...
Page 99: Configuration Tool Menu
Configuring in Advanced Mode Configuration Tool Menu Advanced Mode Menus The following menu items are available in the Advanced Mode window: The File menu allows you to exit from the configuration tool. The View menu allows you to choose the previous or next window.
Page 100: Driver Parameters (All Boards)
Configuring in Advanced Mode Installs the Boston Host Service if the service is not installed. Stops the Boston Host Service if the service is not running. Starts the Boston Host Service. License button launches the License Manager (bkrtlicmgr.exe). Help button displays help for the Configuration Tool in any mode.
Page 101: Btcall Parameters (All Boards)
Configuring in Advanced Mode Right-click on Driver Parameters (All Boards) in the left panel to Reconfigure Drivers reconfigure the driver. This option dynamically updates the driver parameters by calling reconfig on a PnP system. BTCall Parameters (All boards) Click on BTCall Parameters (All Boards) in the left panel to display the BTCall Parameters in the right panel.
Page 102: Debugging Options
Configuring in Advanced Mode Debugging Options When debugging is disabled all the BTCall Parameters Debugging Disabled debugging-related parameters are grayed out. March 2013...
Page 103 Configuring in Advanced Mode The Bfv API Debug file is the main Brooktrout log, capturing debug Debugging Enabled information about faxing. When you enable Bfv API Debugging, you need to specify a file name to write the Brooktrout debug information to. You can even specify a second file name, and set the size of the first file so that a second file is created when the first file has reached the specified size.
Page 104: Call Control Parameters
Configuring in Advanced Mode Call Control Parameters Click Call Control Parameters in the left panel to display the Report tab in the right panel. The Report tab displays the Call Control Parameters port Report Panel configuration information. March 2013...
Page 105 ECC-trace, which captures all call related debug information, similar to call setup and call tear down of the SIP or H.323 call. Do not change any of these parameters until you have consulted with Dialogic Technical Services and Support. See Getting Technical Support on page...
Page 106: Module Settings
SR140 module. So, licenses get added up to look like a single module. Note: A special demonstration license is available in either a single- or two-channel configuration that will run for a 30 day period. Contact your Dialogic sales representative to obtain this license. Products with demonstration licenses run with limited functionality.
Page 107 Configuring in Advanced Mode The Apply button on the toolbar starts the Boston Host Service to initialize the module. See Advanced Mode Buttons on page The License button on the toolbar launches the License Manager (bkrtlicmgr.exe). Use this tab to query the SR140 Fax Software licensing. The General Information Tab following window shows a permanent license: for SR140...
Page 108 Configuring in Advanced Mode An SR140 module displays in the General Information tab even when Virtual Module - Not there is no valid license installed. Available To invoke the License Manager utility (brktlicmgr.exe), press the icon Use License Manager utility to install the license. The Parameters tab displays the call control module type, Media IP Parameters Tab for Interface and IP port number information.
Page 109 IP address to this Ethernet port since DHCP- dynamic host configuration protocol is currently not supported by Dialogic. If DHCP is used on the interface it can work, but only when the IP address does not change while the SR140 virtual module is running.
Page 110 Configuring in Advanced Mode Note: Currently, the Bfv API only supports the GUID information on Windows operating systems. Value Type:character string (up to 256 characters) Default:<blank> (the virtual module uses the first interface in the PC for sending IP messages) Lowest IP Port Number Specify the lowest IP port number that the module can use.
Page 111: Ip Call Control Modules
Configuring in Advanced Mode IP Call Control Modules Click IP Call Control Modules on the left panel to display information about any IP-enabled modules: Both SIP and H.323 are supported for the call control over IP. IP Call Control Modules Details The General Information tab contains information about the library General Information Tab...
Page 112 Configuring in Advanced Mode When you select an H.323 stack to configure, the General Information General Information Tab tab displays, as shown in the following example: for H.323 Stack The SIP IP Parameters tab allows you to set values for the following IP Parameters Tab for parameters.
Page 113 Configuring in Advanced Mode Contact Name Set this parameter to the IP address of the network interface (NIC) in the machine that you want to use for the SIP messages. Here, you typically want to set the same IP address as the one selected under the Media IP Interface parameter in the IP Parameters tab under the SR140 module.
Page 114 Configuring in Advanced Mode (port number specified) 10.128.22.6:5060 (no port number specified) 10.128.22.6 Note: For the SIP protocol, the port defaults to 5060 if not specified. Range:0 – 255 for each dotted decimal position of the IP address. 1 – 65535 for the port number Value Type:dotted decimal Default: 0.0.0.0:0 (no default gateway defined) The Bfv API does not use this parameter if the configuration file...
Page 115 Configuring in Advanced Mode Maximum SIP sessions Indicates the maximum number of concurrent session initiation protocol (SIP) call control sessions. Set this value to a number that at least doubles the number of channels in the system because the system can be tearing down a call while processing the next call.
Page 116 Configuring in Advanced Mode Primary Registrar Server Additional Registrar Server #3 Additional Registrar Server #4 Additional Registrar Server #4 Indicates the address of the specified SIP registration server. The user can define a maximum of 4 registration servers. Valid values are: Domain nameIndicates the name or IP address of the registration server (up to 256 characters).
Page 117 Configuring in Advanced Mode Username Indicates the name inserted into the o= line in the SIP session description protocol (SDP). The o= line defines the owner or creator of the session and the session identifier. This value must not contain spaces. Valid values are: - (dash) = A dash or hyphen character indicates the absence of an owner name or session ID.
Page 118 Configuring in Advanced Mode When you select an H.323 stack to configure, the IP Parameters tab IP Parameters Tab for allows you to set values for the following parameters (see example on H.323 Stack page 123). Most of these parameters only need to be configured when you have a gatekeeper in your local network.
Page 119 Configuring in Advanced Mode E.164 Aliases Specifies the E.164 alias of the H.323 terminal. This alias is used during gatekeeper registration and call establishment. It identifies the phone number of the H.323 terminal. You can specify multiple aliases, each starting on a new line using the same parameter name.
Page 120 Configuring in Advanced Mode Primary Gatekeeper Fallback Gatekeeper #2 Fallback Gatekeeper #3 Fallback Gatekeeper #4 Fallback Gatekeeper #5 Fallback Gatekeeper #6 Specifies the IP address of up to six H.323 gatekeepers that will receive the registration request from the H.323 terminal. If you leave this parameter blank, the H.323 terminal will perform a multicast gatekeeper discovery routine to find the gatekeeper using port number 1719.
Page 121 Configuring in Advanced Mode Local H.323 Terminal ID Specifies the H.323 ID of the H.323 terminal. This alias is used during gatekeeper registration and call establishment. It identifies the name of the H.323 terminal. You can specify multiple aliases, each starting on a new line using the same parameter name.
Page 122 Range:0 – 255 Value Type:decimal Default:48 Note: 48 is the H.323 manufacturer code for Dialogic Corporation. Maximum H323 Sessions Indicates the maximum number of concurrent H.323 calls that the host module can support at one time. Set this value to a...
Page 123 Configuring in Advanced Mode Support Alternate Gatekeepers Specifies whether to support alternate gatekeepers. The gatekeeper receiving the registration request from the H.323 terminal must also support alternate gatekeepers. When the H.323 terminal sends a registration request to its primary gatekeeper, the primary gatekeeper will send the H.323 terminal a list of alternate gatekeepers that it knows about.
Page 124 Configuring in Advanced Mode T.35 Country Code Modifier This parameter specifies a modifier for the country code of the vendor’s H.323 terminal making the call. If the T.35 country code is defined as hexadecimal FF, this extension value defines a two- byte manufacturer country code.
Page 125 Configuring in Advanced Mode The T.38 Parameters tab for a SIP stack allows you to set values for T.38 Parameters Tab for the following parameters. These parameters should work without SIP Stack being modified. The T.38 Parameters tab for an H.323 stack allows you to set values T.38 Parameters for H.323 for the following parameters.
Page 126 Configuring in Advanced Mode RTP Parameters for SIP Stack RTP Parameters for H.323 Stack March 2013...
Page 127: Returning To The Default Configuration
Returning to the Default Configuration Returning to the Default Configuration To return to the default configuration, follow the instructions below: 1. While in the Advanced Mode, click on Options->Preferences. Note the location of the following files: The btcall.cfg in the BTCall Configuration field. The callcnt.cfg in the Call Control Configuration field.
Page 128: Chapter 5 - Testing Dialogic® Brooktrout® Sr140 Software And Tr1034/Trufax® Boards
Activating Dialogic® Brooktrout® SR140 Software on page If you ISV’s application does not contain the FDTool, you can download a copy from the Dialogic Technical Services and Support website. See and download the Getting Technical Support on page 12 FDTool that supports your Brooktrout software version.
Page 129 If you have already installed your LAN Fax application, you might want to first use the LAN Fax application to test your boards. If your application functions properly, then you do not need to use this FDTool. March 2013...
Page 130 This chapter covers the following major topics: Installing the FDTool on page 131 Menus and Submenus on page 132 Generating Logs for Troubleshooting on page 139 Refer to Dialogic® Brooktrout® SR140 Software and TR1034/TruFax® Specifications on page 141. March 2013...
Page 131: Installing The Fdtool
Dialogic Brooktrout Fax Diagnostic Tool for Windows. 3. Locate the FDTool for your version of the software. See Getting Help From the Dialogic® Brooktrout® Configuration Tool on page 96 to get the version of your Brooktrout software. Below FDTool for SDK of your version, select Download.
Page 132: Menus And Submenus
Menus and Submenus Menus and Submenus The following table lists the menus and submenus of the FDTool. Table 3. FDTool Menus and Submenus Menus Submenus File Configure - Launch the Configuration Tool to configure your telephony Initialize - Initialize FDTool with the selected module Exit - Exit FDTool March 2013...
Page 133 Menus and Submenus Table 3. FDTool Menus and Submenus Menus Submenus Debug - Enables/Disable the Brooktrout Tool API logging. VTTY Tracer - Launch the VTTY Tracer utility for logging PSTN. Reset Alarm Counters - Resets the counters maintained by FDTool. Reset Configuration - Clears out the configuration files created with the Configuration Tool.
Page 134: Running The Fdtool
Running the FDTool Running the FDTool Follow the steps below to run the FDTool. 1. From the FDTool screen click the Configure button to launch the Configuration Tool. 2. Refer to the Returning to the Default Configuration on page 127 for instructions for using the Configuration Tool.
Page 135 Running the FDTool 4. Click Initialize. The following screen appears. 5. If there are more than eight SR140 channels, the information bubble above appears. If not, the following screen appears. March 2013...
Page 136 Running the FDTool 6. The following screen indicates that you have entered a dial string. 7. Select a channel configured with a Dialstring to enable the Dial button. Click Dial to start the outgoing fax. March 2013...
Page 137 Running the FDTool 8. The following screen indicates that the fax is being sent between two channels. 9. The following screen displays the history information for the first channel. March 2013...
Page 138 Running the FDTool 10. Click on the second channel to display the history information for that channel. 11. To enable logging, click Debug from the Tools menu. 12. Click Help, About fdtool and the following screen appears: March 2013...
Page 139: Generating Logs For Troubleshooting
FDTool for each channel. Additional logging can be enabled from FDTool's Tools menu: Debug VTTY Tracer Additional logging can be enabled under the direction of Dialogic Technical Services and Support. Enabling logging with Tools | Debug will cause the Dialogic® Debug Brooktrout®...
Page 140 Generating Logs for Troubleshooting Click OK, then follow the direction displayed in the dialog box. If enabled successfully, the output may appear as follows. There are three other options under the Tools menu: Other Tools Options Reset Configuration - clears out the configuration files created with the Configuration tool.
Page 141: Tr1034/Trufax® Specifications
6 - Dialogic® Brooktrout® SR140 Software and TR1034/TruFax® Specifications ITU T.30; ITU T.38; IETF RTP; Group 3 ASN.1 (2002) V.17, V.29, V.27ter, V.21, V.34 modulation Up to 33.6 Kbps with auto fallback Normal and fine resolution: 1200x1200 MH, MR, MMR compression...
Page 142: Rtp
G.711 20ms and 30ms Packets Voice Prompt Playback Prompt Record Playback Gain Control Inbound and Outbound Silence Suppression Dynamic Range Control High Frequency Preemphasis Signal Generation/Detection G.711 Single Frequency Tone Generation G.711 DTMF Tone Generation G.711 DTMF Tone Detection Adaptive Call Progress Analysis March 2013...
Page 143: System Requirements
Minimum System SR140 channels is a Pentium P4 2.66 GHz with 512MB RAM. Refer Requirements to the System Configurations section of the Dialogic® Brooktrout® Release Notes for a table describing the CPU utilization for this and other system types. Supported and Tested Devices for Interoperability For the latest listing of Dialogic®...
Page 144: Installation And Configuration
Windows Server 2003, Server Edition, 64-bit version Windows Server 2003, Enterprise Edition, 32-bit version Windows XP Professional Installation and Configuration Windows Graphical Configuration Tool Application Programming Interface Dialogic® Brooktrout® Fax and Voice (BFV) March 2013...
Page 145: Dial String Formats
Dial String Formats Dial strings (phone numbers) may be up to a maximum of 255 characters. PSTN Telephony The dial string field supports the following digits and control characters. Invalid characters are ignored; upper and lower case letters are equivalent. Some protocols ignore control characters and only accept DTMF characters.
Page 146 IP Telephony For IP outbound calls using the H.323 protocol: Phone#@IP Address:Port# If the receiving side does not require a phone number, a value for Phone# is optional. Also, :Port# is optional — the Bfv API uses 1720 as the default port value. TA:IP Address:Port#,Phone# :Port# is optional —...
Page 147 Examples (IPv6 Addresses) 4082345555@[2000::2ef3:1dff:ea3]:175 4082345555@[fe80::1f4:189c:74da:69f7] Note: IPv6 addresses must be enclosed in brackets. In addition, if a link-local IPv6 address is specified, the Scope ID should be omitted from the address. DTMF Post Dialing For all types of IP calls, the character '&' (ampersand) may be included to initiate post-dialing.

This manual is also suitable for:

Brooktrout sr140

Dialogic Brooktrout TruFax TR1034 User Manual

About this Publication

Chapter 1 - Getting Started

Chapter 2 - Installing Dialogic® Brooktrout® TR1034 and Trufax®

Chapter 3 - Activating Dialogic® Brooktrout® SR140 Software

Chapter 4 - Configuring Dialogic® Brooktrout® SR140 Software and Tr1034/Trufax® Boards

Chapter 5 - Testing Dialogic® Brooktrout® SR140 Software and Tr1034/Trufax® Boards

Chapter 6 - Dialogic® Brooktrout® SR140 Software and

Quick Links

Need help?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Dialogic Brooktrout TruFax TR1034

Summary of Contents for Dialogic Brooktrout TruFax TR1034

This manual is also suitable for:

Table of Contents