Bria 3 for Linux Administrator Guide
CounterPath Corporation CounterPath Corporation Suite 300, One Bentall Centre 505 Burrard Street, Box 95 Vancouver, BC V7X 1M3 Tel: 604.320.3344 sales@counterpath.com www.counterpath.com © July 2010 CounterPath Corporation. All rights reserved. This document contains information proprietary to CounterPath Corporation, and shall not be used for engineering, design, procurement, or manufacture, in whole or in part, without the consent of CounterPath Corporation.
Contents Overview.......................................................................................................................................1 System Requirements .............................................................................................................1 Multimedia Device Requirements ..........................................................................................2 Deploying through Manual Configuration: Recommended Procedure ..................................
CounterPath Corporation 2
1 Overview This manual is intended for: • • “Retail” users. You are a retail user if you are working in a non-office environment and you are your own system administrator. System administrators who have purchased Bria 3 for Linux from the CounterPath website and are deploying it for use by the staff in an enterprise. The staff are considered “enterprise users”. The administrator should be familiar with PBX solutions, telephony and VoIP telephony.
CounterPath Corporation 1.2 Multimedia Device Requirements Bria requires both speakers and a microphone to make calls. Any of the following are acceptable: • • • • • 2 External speakers and microphone Built-in speakers and microphone Dual-jack multimedia headset USB multimedia headset USB phone.
Bria 3 for Linux Administrator Guide 1.3 Deploying through Manual Configuration: Recommended Procedure If you have chosen to manually configure Bria and will not implement remote provisioning, read this entire manual. If you are a service provider, you should be aware that if you deploy through manual configuration then users do not log in, which exposes your service to abuse and may compromise the user’s privacy. Configuring Bria: Administrator Steps The general procedure is: 1. Install and start Bria.
CounterPath Corporation 1.4 Deploying through Remote Provisioning: Recommended Procedure Configuring Bria: Administrator Steps If you are deploying through remote provisioning you will need to start Bria without provisioning in order to explore configuration options. 1. Install and start Bria. The Bria Login dialog appears with the Profile set to “Manually enter login server”. Set the profile to “No login required” and click Continue. The softphone GUI appears.
Bria 3 for Linux Administrator Guide Using the “No Login” Profile If you ever need to start Bria without logging in: 1. Go to the Preferences > Application page and check Enable Login screen. 2. Restart Bria. The Login dialog will appear. 3. Choose “No login required” and click OK. Bria will start, using the local version of the configuration data that is saved on your computer (from the first time you used Bria without logging in).
CounterPath Corporation 2 Configuring Bria 2.1 Configuring Accounts Each user will need at least one SIP account. Each account requires the following information: • • • • User name Password Authorization Name (if applicable; see page 10 for information) Domain Procedure 1. From the Bria menu, choose Softphone > Account Settings. The Account list appears. 2. Choose Add; the SIP Account window appears. 3. Enter the User Details and then change or complete all other fields.
Bria 3 for Linux Administrator Guide 2.2 Configuring Global Settings (Preferences) Use the Preferences window (Softphone > Preferences) to configure features that apply globally, rather than on a per-account basis. The panels that you, as the system administrator, should set are: • • • • • Network. You should complete these fields to suit your network. Audio Codecs. You should enable the codecs that are suitable to your environment. Quality of Service.
CounterPath Corporation 2. Insert a blank row as the first row. In this row, type the headings that Bria will use to interpret the meaning of each column. The columns can be in any order. Key headings are: • uri. Bria recognizes a value in this column as a softphone address and considers the address as one that can be phoned. • display-name, entry_id, given_name, surname • business number For a complete list of headings, see page 35. 3. Save the file as *.csv. 2.
3 Account Configuration Reference The Account Settings window lets you configure features that apply on a per-account basis. (The preferences window lets you configure features that apply across all accounts.) 1. Choose Softphone > Account Settings from the menu. The Accounts list appears. 2. Edit an existing account or create a new one. The Account Settings window appears.
CounterPath Corporation 3.1 SIP Account Properties – Account Fields with an asterisk are required Table 1: SIP Account Properties – Account Field Account name Protocol Description If desired, change the account name to something that is meaningful to you. Read-only. Always specifies SIP. User Details User ID Domain Password Display name The account number for the softphone account. For example, kpereira. For example, myVoipProvider.com.
Bria 3 for Linux Administrator Guide 3.2 SIP Account Properties – Voicemail These settings let you configure client-side voicemail features. Your IP PBX or VoIP service provider may also provide the ability to configure voicemail (server-side handling). An incoming phone call first goes through server-side handlers and then through the client-side handlers. Keep in mind that the fields on this Voicemail tab are not written to the server; they are configuring a second, separate handler.
CounterPath Corporation Table 2: SIP Account Properties – Voicemail Field Send calls to voicemail if unanswered Always forward to this address Description To send to voicemail after the specified number of seconds. Your IP PBX may also provide a similar feature that is set up outside of Bria. If so, make sure you do not enter competing information in Bria and in the IP PBX’s user interface. For example, if you turn off this field, make sure the same feature at your service provider is also turned off.
Bria 3 for Linux Administrator Guide 3.3 SIP Account Properties – Topology Table 3: SIP Account Properties – Topology Field Description Firewall traversal Mode • ICE: Automatically determine the contact address for signaling traffic. Advertise the local IP, public IP (discovered via STUN, if available), and media relay IP (discovered via TURN, if available), and use these to automatically determine the best route for media traffic during calls.
CounterPath Corporation 3.4 SIP Account Properties – Storage These settings let you set up a remote storage system for your contact list. The options are: • • Local: The contact list is stored only on the user’s computer. WebDAV or XCAP: The contact list is stored remotely via the specified method and is also stored locally, on the user’s computer. Table 4: SIP Account Properties – Storage Field Storage method Description The storage method to be used for the Contact list file.
3.5 SIP Account Properties – Security Table 5: SIP Account Properties – Security Field Signaling Transport Media Encryption over TLS Description • Automatic: Bria sets up the transport based on the capabilities of the network and the Bria computer. Choose this option if you do not care which transport is used. • TCP: This transport provides no signaling security. • UDP: This transport provides no signaling security.
CounterPath Corporation Setting up for Security within Bria The options for media encryption are described in the following table. Table 6: Media Encryption Options Option Make and accept only encrypted calls Do not allow encrypted calls 16 How Outgoing Calls are Handled How Incoming Calls Are Handled Bria will place all calls with TLS. The call INVITE Bria will only accept INVITEs that are for encrypted calls. will specify SRTP media encryption.
Bria 3 for Linux Administrator Guide 3.6 SIP Account Properties – Advanced s Table 7: SIP Account Properties – Advanced Field Description Register Settings Reregister every The time interval between Bria’s attempts to reregister in order to refresh the account registration. A value of zero means not to reregister after the initial registration. This value is placed in the “Expires” header field of the REGISTER message. Minimum time The factory setting is 3600.
CounterPath Corporation Table 7: SIP Account Properties – Advanced Field Session timer preference Description This field specifies your preference for which party should send the refresh. The preference is not a guarantee that the refresh will be performed by the specified party. The choices are: • • • • Send SIP keep-alives Use rport Send outgoing request directly to target None: No preference. Local refreshes: Your computer sends. Remote refreshes: The other party sends.
Bria 3 for Linux Administrator Guide 4 Preferences Reference Choose Bria > Preferences. The Preferences window appears. The Preferences panels let users control the way that they work with Bria. It also contains fields to configure features that apply globally, rather than on a per-account basis. The following sections discuss only the tabs and fields that you, the administrator, should complete. Other fields, which control user preferences, are not discussed.
CounterPath Corporation 4.1 Preferences – Network Table 8: Preferences – Network Field Network Connection Speed Description Select the type of network connection for your computer. The sliders move to show the bitrate that will be used for sending and receiving. These rates are typical rates for the selected configuration. If you know that your computer and network can handle a faster sending speed, click Custom and move the slider. It is recommended that you not change the receiving speed.
Bria 3 for Linux Administrator Guide 4.2 Preferences – Audio Codecs This panel shows all the codecs that are included in the retail version of Bria. You can enable or disable codecs as desired. With only one codec enabled, all calls made will use that codec. With more than one codec enabled, Bria automatically chooses the best codec based on the other party’s capability, the available bandwidth, and network conditions. You cannot change the properties of any codecs.
CounterPath Corporation Supported Codecs Bria supports a wide range of codecs. Codec DVI4 Narrowband Wideband 3 3 3 DVI4 Wideband Included in Retail Bria 3 for Linux 3 G.711aLaw * 3 3 G.711uLaw * 3 3 GSM 3 3 iLBC 3 3 3 L16 PCM Wideband 3 Speex 3 3 Speex FEC 3 3 Speex Wideband 3 3 Speex Wideband FEC 3 3 * Generally, at least one of these codecs must be enabled in order to place a PSTN (land line) call.
Bria 3 for Linux Administrator Guide 4.3 Preferences – Quality of Service The Quality of Service panel lets you request a specific transport service for audio, video and signaling traffic.This service is through DSCP (also known as ToS). In a network that has the default configuration, the recommended value for audio is 46, because “46” is the standard marking for audio. The Quality of Service panel lets you request a specific transport service for audio, video and signaling traffic.
CounterPath Corporation 4.4 Preferences – Directory If your organization has an LDAP server, you can configure Bria to connect to that server. The entries from the directory will appear in the Directory tab (alongside the Contacts and History tabs). In Directory Type, select LDAP; other fields appears; see below. Field Description Server Settings Server The hostname or IP address of the directory server. For example, ldap.example.com. Authentication method Anonymous or Simple.
Bria 3 for Linux Administrator Guide 4.5 Preferences – Advanced Table 9: Preferences – Advanced Field DTMF Description Choose the method for sending DTMF that is supported by your VoIP service provider. In-band means that Bria will encode the DTMF signals in the audio stream as regular sound. Typically, DTMF is not sent in-band; in-band is only used in specific situations.
CounterPath Corporation Logging (Diagnostics) Users can enable logging to files. Logging uses computer resources, so you should make sure your users only enable it when you or a customer support representative instruct them to do so. Configuring You should configure the folder where logging files will be saved. You should also make sure the logging is initially disabled. Activity on Bria will be logged to.csv files in the specified folder. A new set of files is started each time the user logs on.
Bria 3 for Linux Administrator Guide A Dial Plan When a call attempt is made, the call input (what you type, select or drag onto the Call display) is processed to select the SIP account to use and to modify the input if that is required to ensure that the call gets placed successfully.
CounterPath Corporation A.1 How Dial Plans Are Used When you make a call, Bria takes the phone number (the input) and performs the following: Cleanup Input is cleaned up by removing spaces, dashes, open brackets, and close brackets. Cleanup allows Bria to support calls placed using contacts from a contact list, including Microsoft® Outlook®. Matching The input is compared to the patterns defined by the dial plan for each enabled account.
Bria 3 for Linux Administrator Guide Example \a\a.T|xxxxxxxxxx;match=1;prestrip=2;match=2;pre=8; where: • • • • \a\a.T is the first pattern. xxxxxxxxxx; is the second pattern. match=1;prestrip=2; is the first match-transformation pair. match=2;pre=8; is the second match-transformation pair. Pattern Valid Content The content for a pattern follows the digit map rules of RFC 2705, supplemented by the rules for regular expressions.
CounterPath Corporation Timers There are two timers, the T timer and the long timer. These timers are used in input comparison, as described in “How the Input Is Processed” on page 30. Transformation Keywords Keyword Description prestrip Strip the first n characters from the input before placing the call. poststrip Remove n number of characters from the end of the input before placing the call. pre Add the specified account prefix to the input before placing the call.
Results of the Comparison Bria finds a match according to the following rules. These rules work on three elements: • • • The patterns specified in the dial plan. The T timer, if it is included in the pattern.This timer is a short (critical) timer. T timer is 4 seconds. The long timer, which is always effective (it does not have to be included in the pattern). The long timer is 20 seconds.
CounterPath Corporation A.4 Examples Example 1 \a\a.T|xxxxxxx.T;match=2;pre="9" This simple example shows how to differentiate between a PSTN number and a softphone address, and how to add a “9” dialing prefix only to the PSTN number. Example 2 3xxT|1xxxxxxxxxx|[2-9]xxxxxxxxx|+x.T;match=2;pre="9"; match=3;pre="91";match=4;prestrip=1;pre="9011" 3xxT The first pattern is any three-digit number beginning with 3. No transformation. The assumption is that this is an internal extension.
Bria 3 for Linux Administrator Guide However, the example does illustrate two ideas: • Handling of the account prefix (#1), if you are upgrading from eyeBeam and are accustomed to entering the account number. Use of # to identify the account is now deprecated. The dial plan should be capable of determining the account to use for this number. However, since users may still be in the habit of entering the account prefix, you may want to include this pattern to handle such a scenario.
CounterPath Corporation 34
Bria 3 for Linux Administrator Guide B Contact List Headings Following is a list of all the headings that are used in the Bria contact list. This list can be useful when formatting a contact list in order to import it into Bria. For details, see “Setting up Contacts” on page 7.
CounterPath Corporation 36
Bria 3 for Linux Administrator Guide C Glossary Codec Dial plan DTMF Enterprise user MWI Retail user SIP SIP account softphone address URI URL vCard The format by which audio or video streams are compressed for transmission over networks. The rules that Bria follows in order to interpret the softphone address or phone number that the user has entered and to modify the number or address, as required, to ensure that the call will be placed successfully. Dual-tone multi frequency.
CounterPath Corporation 38
