Bria Professional Administrator Guide www.counterpath.
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 © August 2009 CounterPath Corporation. All rights reserved. Windows and Windows Vista are registered trademarks of Microsoft Corporation in the United States and other countries.
Contents Overview.......................................................................................................................................1 Deploying through Manual Configuration: Recommended Procedure ..................................1 Deploying through Remote Provisioning: Recommended Procedure....................................3 Deploying Bria Professional .........................................................................................................4 Getting Ready .............
CounterPath Corporation 2
Bria Professional Administrator Guide 1 Overview This manual is intended for: • • System administrators who have purchased Bria Professional from the CounterPath website and are deploying Bria Professional for use by the staff in an enterprise. The administrator should be familiar with PBX solutions, telephony and VoIP telephony. Service providers who have purchased Bria Professional from CounterPath Sales, without further customization or engineering changes.
CounterPath Corporation • “default_user” (in lower case with the underscore) as the user name. • No password. The login will fail because Bria Professional cannot detect a login server. The “skip login or enter server” version of the Login dialog will appear (see below). 2. The user should click Skip. Bria Professional will start and the user can configure the softphone. Figure 1: Initial Login Screen (left) and “Skip Login or Enter Server” Login Screen (right) 3.
Bria Professional Administrator Guide 1.2 Deploying through Remote Provisioning: Recommended Procedure If you are deploying through remote provisioning: 1. Read this manual in order to configure on a test computer. 2. When you are happy with your configuration, see the Bria Provisioning Guide for information on setting up your users for remote login and remote provisioning.
CounterPath Corporation 2 Deploying Bria Professional 2.1 Getting Ready System Requirements Processor Minimum: Intel Pentium III 1.3 GHz or equivalent Optimal: Pentium 4® 2.4 GHz or equivalent Memory 512 MB RAM Hard Disk Space 50 MB Operating System Windows® Vista® Windows 2000 Windows XP Connection IP network connection (broadband, LAN, wireless) Sound Card Full-duplex, 16-bit Web browser Microsoft Internet Explorer® 6.
Bria Professional Administrator Guide Video Cameras Calls made with Bria Professional will work without a video camera, but one is necessary to allow users to see each others’ images. Bria Professional will work with most USB video cameras. 2.2 Managing Licenses When you obtain Bria Professional, you purchase a license with a specified number of seats. Each time a user enters the license key, the license count is drawn down on the CounterPath license database.
CounterPath Corporation • If you will be implementing provisioning: If possible, enter the user name and password that you will eventually use to log into the provisioning server. If you do not yet know what these credentials will be, enter “default_user” and omit the password. 2. Click Sign in. Bria Professional will attempt to detect a login server and will fail. The “skip login or enter server” version of the Login window will appear. 3. Click the Skip button. Bria Professional starts. 4.
Bria Professional Administrator Guide 2.4 Configuring Bria Professional You configure Bria Professional by completing the fields on the Account Settings window and the Preferences window. The following table lists configurable features in alphabetical order and specifies the window where the feature is configured.
CounterPath Corporation Setting up Accounts You must set up SIP accounts to allow your users to make phone calls. If the VoIP service provider offers instant messaging using SIMPLE, users will also use this account for instant messaging. You must set up an XMPP account if you are using an XMPP service for instant messaging and presence.
Bria Professional Administrator Guide For more information, see “XMPP Account” on page 13. 4. If you have more than one SIP account, decide which is the default and move it to be the first SIP account in the list. Similarly, if you have more than one XMPP account, decide which is the default and move it to be the first XMPP account. For information on the role that the default account plays, see “How Bria Professional Selects an Account” on page 10. 5. Enable the desired accounts.
CounterPath Corporation 2.5 How Bria Professional Selects an Account Bria Professional determines which account to use for the various activities: phone calls, instant messages, presence subscriptions, and file transfers. If you have set up more than one SIP account and/or more than one XMPP account, read this section to make sure you set the default account to obtain the desired behavior. Incoming Phone Calls The account that an incoming phone call comes in on is controlled by the other party.
Bria Professional Administrator Guide 2.6 Creating a Contact List Typically, users will want to create contacts in order to easily make phone calls, send IMs and transfer files. You can provide a file (for example, the company contact list) that your users can import into their individual softphones. This file can be: • • • A comma-separated file. Use this method to import from a Microsoft® Excel® file. You will first have to set up the file; see below.
CounterPath Corporation 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.) 3.1 Accounts Settings Window Choose File > Account Settings from the menu. The Account Settings window appears, showing all the accounts set up. You can: • • • • 12 Add or remove an account. Enable one or more accounts.
Bria Professional Administrator Guide 3.2 XMPP Account A red dot appears here to alert you when the Jabber ID field is blank or when the Jabber ID is incomplete. The alert disappears after you type “@” in the Jabber ID. A red dot appears here to alert you when the Password field is blank. The alert disappears after you enter a password. Table 1: XMPP Account Properties – Account Field Account name Protocol Description If desired, change the account name to something that is meaningful to you.
CounterPath Corporation Table 1: XMPP Account Properties – Account Field Outbound proxy Resource Priority 14 Description The value in Jabber ID and in this setting may be used by Bria Professional to compose a valid jid: • If Jabber ID=bob@ABC.com and Outbound proxy is empty, jid=Jabber ID: bob@ABC.com • If Jabber ID=bob@ABC.com/home and Outbound proxy is empty, jid=Jabber ID: bob@ABC.com • If Jabber ID=bob@ABC.com and Outbound proxy=XYZ.com, ignore the Outbound proxy; Jabber ID=bob@ABC.
Bria Professional Administrator Guide 3.3 SIP Account Properties – Account A red dot appears here to alert you when the User ID field is blank or when the User ID is incomplete. The alert disappears after you type “@” in the User ID. Table 2: 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.
CounterPath Corporation Table 2: SIP Account Properties – Account Field Send outbound via Dial Plan Description • Domain: If your VoIP service provider requires that traffic be directed to proxies that are discovered via the domain. • Proxy Address: If your VoIP service provider has an outbound proxy address and requires that you provide the address to Bria Professional. For the address enter a domain name (for example, domain.com) or an IP address (for example, 123.456.789.012).
Bria Professional Administrator Guide 3.4 SIP Account Properties – Voicemail These settings let you configure client-side voicemail features. Your IP PBX 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 writing to the server; they are configuring a second, separate handler.
CounterPath Corporation Table 3: SIP Account Properties – Voicemail Field Description Always forward to: To always forward phone calls received on this account. When on the phone, forward to: Enter the address to forward to, but leave the checkbox cleared (the individual user will click it when desired). Phone calls received on other accounts (if you have them) are not affected by enabling this field for this particular account. To forward only when you are on another phone call.
Bria Professional Administrator Guide 3.5 SIP Account Properties – Topology Table 4: SIP Account Properties – Topology Field Description Firewall Traversal IP Address This setting controls how your IP address is presented. • Discover global address: Let Bria Professional determine your public IP address. • Use local IP address: use the IP address of the Bria Professional computer. STUN Server The recommended setting is Discover global address. This setting specifies the STUN server to use.
CounterPath Corporation Table 4: SIP Account Properties – Topology Field Description Range of Ports on Local Computer Range of ports used on local computer The appropriate setting depends on your computer setup: • Checked: If your computer is behind a restrictive firewall that only allows specific port ranges to be used. Enter the range of ports to use for your SIP account. (You must also open those ports on your firewall; refer to applicable firewall documentation for information.
Bria Professional Administrator Guide 3.6 SIP Account Properties – Presence This tab lets you set up to share presence information with contacts who have addresses associated with this SIP account. (For information on account association, see “How Bria Professional Selects an Account” on page 10). Note that you do not have to set up to share presence information on an XMPP account.
CounterPath Corporation How Presence Subscriptions Work The following chart illustrates how the sharing of presence status occurs. This chart illustrates a peer-to-peer subscription, but the same principle applies when a presence agent is used.
Bria Professional Administrator Guide 3.7 SIP Account Properties – Storage These settings let you set up a remote storage system for the buddy list for this SIP account. (Note that the buddy list for an XMPP account is always stored on the XMPP server; no configuration is required). Table 6: SIP Account Properties – Storage Field Storage method Description The storage method to be used for the buddy list and presence rules. The file can be stored locally or both locally and on a remote computer.
CounterPath Corporation 3.8 SIP Account Properties – Security Table 7: SIP Account Properties – Security Field Signaling Transport Media Encryption Description • Automatic: Bria Professional sets up the transport based on the capabilities of the network and the Bria Professional 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.
Bria Professional Administrator Guide in the chain. Therefore, if the other party is outside your domain, you cannot be completely sure that the call is secured at the signaling level, which means that you cannot be sure that it is secured at the media level. When a call with both signaling and media encryption is established, Bria Professional displays the encryption icon ( ).
CounterPath Corporation 3.9 SIP Account Properties – Advanced s Table 9: SIP Account Properties – Advanced Field Description Register Settings Reregister every The time interval between Bria Professional’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.
Bria Professional Administrator Guide Table 9: SIP Account Properties – Advanced Field Description Timers Enable session timers Default session time Session timer preference A session timer is a mechanism to detect whether a call session is still active from the signaling point of view. When the timer expires, a refresh is sent from one party to the other. The timer is then reset. • Turn on to enable session timer. Enter a value in Default session time. The factory setting is 60.
CounterPath Corporation 4 Preferences Reference Choose File > Preferences. The Preferences window appears. The Preferences panels let users control the way that they work with Bria Professional. It also contains fields to configure features that apply globally, rather than on a per-account basis. 4.1 Preferences – Privacy On this panel, you should complete only the Corporate tab.
Bria Professional Administrator Guide 4.2 Preferences – Network On this panel, complete the network connection speed section and Preserve bandwidth field to suit your environment. Leave the Video Image Size for the user to complete. 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.
CounterPath Corporation 4.3 Preferences – Audio Codecs This panel shows all the codecs that are included in the retail version of Bria Professional. 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 Professional 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.
Bria Professional Administrator Guide Supported Codecs Bria Professional supports a wide range of codecs. See the table. Codec Narrowband Wideband Included in Retail Bria Professional Royalty-bearing AMR Wideband (G.722.2) 3 Broadvoice-32 3 3 Broadvoice-32 FEC 3 3 DVI4 3 3 3 3 DVI4 Wideband 3 EVRC 3 3 G.711aLaw * 3 3 G.711uLaw * 3 3 G.722 3 3 G.723 3 3 3 G.726 3 G.
CounterPath Corporation 4.4 Preferences – Video Codecs Video codecs describe the format by which video streams are compressed for transmission over networks. Some codecs require less bandwidth than others, but may result in lower video quality. You can enable or disable codecs as desired. With only one codec enabled, all calls made will use that particular compression format.
Bria Professional Administrator Guide 4.5 Preferences – Quality of Service The Quality of Service panel lets you request a specific transport service for audio, video and signaling traffic. There are two types of services. The service to use depends on what your VoIP service provider supports: • • GQoS, which is available for audio and video. DSCP (also known as ToS), which is available for audio, video and signaling.
CounterPath Corporation 4.6 Preferences – LDAP If you have access to an LDAP directory, you can configure Bria Professional to automatically download the directory and display it in the Directory tab in the Address Book. Field Description LDAP Enable LDAP Click to enable. Assuming that the other fields in this section have valid information, the directory data will be retrieved and displayed in the Directory tab in the Address Book. The data will be updated as specified in the query polltime.
Bria Professional Administrator Guide 4.7 Preferences – Contact Storage These settings let you set up a remote storage system for user contact lists via WebDAV or XCAP. (The contact list is always stored locally, even when you set up for remote storage.
CounterPath Corporation 4.8 Preferences – Diagnostics This panel lets the user 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 Professional will be logged to.csv files in the specified folder.
Bria Professional Administrator Guide 4.9 Preferences – Advanced Field Reduce echoes from speakers Description Turning this feature on improves sound quality. This feature is typically on. Use slower but more compatible video format Turning this field on may improve performance when running Bria Professional on older hardware.
CounterPath Corporation If You Are Deploying through Provisioning If you are reading this manual as the first step to deploying a provisioning server, then leave the default values: • • • Choose “Automatically detect the login server through DHCP”. Check “Number of times a user can skip”. Enter -1 in the field.
Bria Professional Administrator Guide A Configuration Form Dialog Field Main Page Default Account Account 1 Account 2 Account Type Account > Account Tab Account Name User ID Password Display name Authorization name Register with domain Send outbound via Dial plan Account > Voicemail Tab Check for Voicemail Number to dial for checking voicemail Number for sending calls to voicemail Send calls to voicemail if unanswered seconds Always forward to When on phone, forward to Account > Topology Tab IP
CounterPath Corporation Dialog Field Storage Tab Storage method Credentials (radio button) Username Password Root URL WebDAV poll time Account > Security Tab Signaling Transport Media Encryption (for TLS) Account > Advanced Tab Reregister every Min. time Max.
Bria Professional Administrator Guide Dialog Field Preferences > LDAP Enable Account 1 Account 2 Server Authentication method Username Credential Root DN Search expression Query timeout Maximum records Query polltime Display name First name Last name Home number Work number Mobile number E-mail Softphone Jabber Preferences > Contact Storage Storage method Username Password Root URL WebDAV Poll time Preferences > Advanced Login Server Number of times (checkbox) Number of times (field) 41
CounterPath Corporation B 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. Each dial plan contains one or more patterns; if the input matches a particular pattern, then the input is modified according to the rules for that pattern, and then the call is placed using the account that the dial plan belongs to.
Bria Professional Administrator Guide B.1 How Dial Plans Are Used When you make a call, Bria Professional 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 Professional 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.
CounterPath Corporation 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.
Bria Professional Administrator Guide 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 45. 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.
CounterPath Corporation Results of the Comparison Bria Professional 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.
Bria Professional Administrator Guide B.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.
CounterPath Corporation 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.
Bria Professional Administrator Guide C Contact List Headings Following is a list of all the headings that are used in the Bria Professional contact list. This list can be useful when formatting a contact list in order to import it into Bria Professional. For details, see “Creating a Contact List” on page 11.
CounterPath Corporation D Glossary AEC AGC AVI Broadband Codec Dial plan DTMF IM IP IP address Media MWI Narrowband Presence Proxy PSTN RFC RTP Signaling 50 Acoustic echo cancellation. Processing of the audio or video signal to reduce the echo effect that can arise with a speakerphone or that can arise if the sound from the speakerphone or headphone leaks into the microphone. Automatic gain control.
Bria Professional Administrator Guide SIMPLE protocol SIP SIP account softphone address SRTP TCP TLS UDP URI URL USB device VAD vCard VoIP VoIP service provider WAV Session Initiation Protocol for Instant Messaging and Presence Leveraging Extensions. The instant messaging (IM) protocol followed by Bria Professional. It encapsulate the rules for exchanging instant messages. Session Initiation Protocol. The signaling protocol followed by Bria Professional for handling phone calls.
CounterPath Corporation 52
