Bria for Windows 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. Windows, Windows Vista, Active Directory, and Outlook are registered trademarks of Microsoft Corporation in the United States and other countries.
Contents Overview.......................................................................................................................................1 System Requirements .............................................................................................................2 Multimedia Device Requirements ..........................................................................................3 Deploying through Manual Configuration: Recommended Procedure ..................................
CounterPath Corporation 2
1 Overview This manual is intended for: • • System administrators who have purchased Bria from the CounterPath website and are deploying Bria 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 from CounterPath Sales, without further customization or engineering changes. You can deploy Bria either by manually configuring via the softphone GUI or by using a provisioning server.
CounterPath Corporation 1.1 System Requirements Requirements for Bria for Windows Processor Minimum: Pentium 4® 2.4 GHz or equivalent Optimal: Intel Core 2 Duo or equivalent; Video Card with DirectX 9.0c support Recommended to support HD video: Intel Core 2 Duo or equivalent with minimum 3.0 GHz, or a tripleor quad-core processor; Video Card with DirectX 9.0c support. Memory Minimum: 1 GB RAM Optimal: 2 GB RAM.
Bria for Windows Administrator Guide 1.2 Multimedia Device Requirements Requirements for Bria for Windows Bria requires both speakers and a microphone to make calls. Any of the following are acceptable: • • • • • • External speakers and microphone Built-in speakers and microphone Dual-jack multimedia headset Bluetooth® multimedia headset USB multimedia headset USB phone. HID-compliant devices can be configured to work with Bria.
CounterPath Corporation 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. It is assumed that you, the administrator, will be exploring deployment strategies using Bria for Window.
Bria for Windows Administrator Guide 5
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 for Windows Administrator Guide Using the “No Login” Profile If you, the system administrator, 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. Choose “No login required”. 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 8
2 Configuring Bria 2.1 Summary of Features You configure Bria by completing the fields on the Account Settings window and the Preferences window. The following table specifies the window where each feature is configured.
CounterPath Corporation Topic Window Reference Network (SIP accounts) Accounts > Account (SIP) page 23 Accounts > Topology page 27 Accounts > Advanced page 33 Network (XMPP accounts) Accounts > Account (XMPP) page 21 Network connection speed Preferences > Network page 37 Presence (online status) Accounts > Presence page 28 Presence, set the IM/Presence account Accounts list page 13 Privacy, setting up a corporate (enterprise) rule Preferences > Privacy page 35 Quality of Service (W
Bria for Windows Administrator Guide Procedure 1. From the Bria menu, choose Softphone > Account Settings. The SIP Account window appears. 2. Enter the User Details and then change or complete all other fields. See “Account Configuration Reference” on page 19 for details. 3. When done with the SIP account, click OK; the account is created and registered. 4. If you are setting up an XMPP account, choose Softphone > Account Settings again.
CounterPath Corporation Setting up Multiple Accounts You can set up Bria so that phone calls can be made from more than one account. 1. Decide how you want Bria to choose the account to use for any given phone call. There are two options: • • Dial plan decides: The dial plans must be designed so that they select the appropriate account, based on the phone number being dialed.
Bria for Windows Administrator Guide Setting the IM/Presence Account The account is the “preferred account”. The account can be used for phone calls by selecting it on the dashboard (page 13) The account cannot be used for phone calls. Presence subscriptions (for online status sharing) and instant messages can be handled through only one account.
CounterPath Corporation Verifying your Setup View the contact list: some or all your contacts should have a presence icon besides their name. In order for a contact to include a presence icon, it must be “presence-ready” and you must be subscribing to the contact. (“Presence-ready” means that the contact has an address that allows for presence data to be shared.
See “Preferences Reference” on page 35. For information on the panels that are not discussed in this guide, see “Bria 3 for Windows User Guide – Enterprise Deployments”. One of the differences between Bria for Windows and Bria for Mac is in the organization of configuration information: • • In Bria for Windows, account information is in the Accounts window, which is accessed by choosing Softphone > Accounts. Preferences are in the Preferences window, which is accessed by choosing Softphone > Preferences.
CounterPath Corporation 2.3 Setting up Contacts Typically, users will want to create contacts in order to easily make phone calls. In addition, in order to send IMs, shared online information and transfer files, contacts are required. Contact Storage Method You can set up Bria so that contacts are stored in one of these ways: • • • • Locally on each user’s computer. Remotely on a WebDAV or XCAP server In the user’s Microsoft® Outlook® address book.
Bria for Windows Administrator Guide • uri. Bria recognizes a value in this column as a softphone address and considers the address as one that can be phoned and as an address that can be used for IM/presence (if SIP is being used for IM/ presence). • jid: Bria recognizes a value in this field as a Jabber (XMPP) address and will map this field to the Jabber contact method for the contact. Bria considers a Jabber address as one that can be used for IM/ presence (if XMPP is being used for IM/presence).
CounterPath Corporation 18
Bria for Windows Administrator Guide 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 Softphone > Account Settings from the menu. The first time you (or the user) choose Softphone > Account Settings, the SIP Account window appears to allow setup of a SIP account.
CounterPath Corporation Account Settings Window with Multiple SIP Accounts If you have more than one SIP account, the window appears as shown below.
Bria for Windows Administrator Guide 3.2 XMPP Account Fields with a red asterisk are required Table 1: XMPP 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 XMPP. User Details User ID Domain Password Display name Typically the account number for the softphone account. For example, kperera. For example, domainXMPP.com. This name is displayed in the Bria display.
CounterPath Corporation Table 1: XMPP Account Properties – Account Field Resource Priority 22 Description Optional resource, as specified in RFC 3920. For example "/home". If this setting is blank and the User ID includes a resource, the value from that ID is used. If both are specified, the value from this Resource field is used. If no resource is specified, the XMPP server will assign a temporary resource. The priority, as per RFC 3921. The default is 0.
Bria for Windows Administrator Guide 3.3 SIP Account Properties – Account Fields with a red asterisk are required Table 2: SIP Account Properties – Account Field Account name Protocol Use for Call Use for IM/Presence Description If desired, change the account name to something that is meaningful to you. Read-only. Always specifies SIP. If checked, this account is eligible to be used for phone calls. If unchecked, this account will never be used for placing phone calls.
CounterPath Corporation Table 2: SIP Account Properties – Account Field Description Domain Proxy Register with domain and receive Typically, this field is checked. calls A situation in which this field is unchecked is, for example, if your level of service does not include the ability to receive incoming calls. In this case, turning this field on may cause registration to fail (when you close the Account Properties window), meaning that your Bria cannot register.
Bria for Windows 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 written to the server; they are configuring a second, separate handler.
CounterPath Corporation Table 3: 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 for Windows Administrator Guide 3.5 SIP Account Properties – Topology Table 4: SIP Account Properties – Topology Field Firewall traversal mode Description • Auto detect using 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.6 SIP Account Properties – Presence This tab lets you set up presence and workgroups (Bria for Windows only). If you are using SIP SIMPLE for online status sharing (presence), you must configure one SIP account to handle subscriptions. You can only set up one account for presence; see “Setting the IM/Presence Account” on page 13 for details. Note that you do not have to set up to share presence information on an XMPP account.
Bria for Windows Administrator Guide How Presence Subscriptions Work The following chart illustrates how the sharing of online status occurs. This chart illustrates a peer-to-peer subscription, but the same principle applies when a presence agent is used.
CounterPath Corporation 3.7 SIP Account Properties – Storage These settings let you set up a remote storage system for the buddy list and privacy list for this SIP account. Note that the buddy list and privacy list for an XMPP account are always stored on the XMPP server; no configuration is required. If you plan to instruct users to set contact list storage to their Outlook or Mac Address book (page 46), your buddy list must be stored locally.
3.8 SIP Account Properties – Transport Table 7: 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 8: Media Encryption Options Option Make and accept only encrypted calls Do not allow encrypted calls 32 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 for Windows Administrator Guide 3.9 SIP Account Properties – Advanced s Table 9: 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 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.
Bria for Windows Administrator Guide 4 Preferences Reference Choose Softphone > 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. 4.
CounterPath Corporation 4.2 Preferences – Devices On this panel, you should complete only the Deskphone information on the Other Devices tab, and only if you support deskphone use. Leave the other tabs for each user to complete to match their individual hardware. If your enterprise uses SIP deskphones, you can configure Bria to use them. Users will be able to initiate calls from Bria then switch over to the deskphone for the rest of the call. The deskphone must be a SIP phone that supports dialog events.
Bria for Windows Administrator Guide 4.3 Preferences – Network On this panel, complete the network connection speed section and Preserve bandwidth field to suit your environment. Typically, you will leave the Video Image Size (Bria for Windows only) 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.
CounterPath Corporation 4.4 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.
Bria for Windows Administrator Guide Supported Codecs Bria supports a wide range of codecs. See the table. Codec Narrowband Wideband Royalty-bearing Included in Retail Included in Retail Bria for Windows Bria for Mac AMR Wideband (G.722.2) 3 Broadvoice-32 3 3 Broadvoice-32 FEC 3 3 DVI4 3 3 3 DVI4 Wideband 3 3 3 3 EVRC 3 3 G.711aLaw * 3 3 3 G.711uLaw * 3 3 3 3 3 3 3 3 G.722 G.723 3 3 G.726 3 3 G.
CounterPath Corporation 4.5 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 for Windows Administrator Guide 4.6 Preferences – Quality of Service Quality of Service is supported only in Bria for Windows. 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.
CounterPath Corporation 4.7 Preferences – Directory If your organization has an LDAP or Active Directory 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). If your users use both Bria for Windows and Bria for Mac, you can deploy a directory using LDAP. If your users use only Bria for Windows, you can deploy a directory using LDAP or Active Directory.
Bria for Windows Administrator Guide LDAP Settings Field Description Search Options Type • Search on demand: The Directory tab on the softphone will have a Search button. The Directory tab is empty until the user performs a search. Each time the user clicks Search, a new retrieve is performed. This option is recommended for directories with more than 500 entries. • Type to filter list: The Directory tab on the softphone will not have a Search button.
CounterPath Corporation Active Directory ADSI (Active Directory) Settings Field Description Server Settings Subtree DN The Active Directory subdirectory to restrict the search to. Search Options Type • Search on demand: The Directory tab on the softphone will have a Search button. The Directory tab is empty until the user performs a search. Each time the user clicks Search, a new retrieve is performed. This option is recommended for directories with more than 500 entries.
ADSI (Active Directory) Settings Field Description Attribute Mapping All fields In this section, map the names of the attributes that are in your directory to the corresponding fields in Bria. The field label is the Bria field. The field box specifies the attribute name. Be careful with this mapping because when users create a contact from a directory entry, the phone number is mapped into the different contact methods in the contact.
CounterPath Corporation 4.8 Preferences – Contact Storage These settings let you set up a remote storage system for your contact list. The contact list holds general information for contacts and is automatically loaded at startup, even if no accounts are enabled. These settings let you set up a remote storage system for your contact list via WebDAV, XCAP or the Outlook address book (Bria for Windows) or Mac Address book (Bria for Mac).
Bria for Windows Administrator Guide Table 10: SIP Account Properties – Storage Field WebDAV poll time Description The time that elapses between polling for new contact data from the remote server. The factory setting is 600. XCAP Settings Username and password Root URL The user name and password to log into the storage server. URL of an appropriate root folder on the remote server. The factory setting is https:// xcap.
CounterPath Corporation 4.9 Preferences – Advanced Table 11: 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.
Bria for Windows Administrator Guide Table 11: Preferences – Advanced Field Web Page Tabs Description You can set up a web page as a new tab in the Resources panel; it will appear alongside Contacts, History and so on. Enter the web address and a name (this name will be appear in the tab). Enter a checkbox to create the tab. At any time, the user can clear the checkbox to remove the tab from the Resources panel.
A Configuration Form This form provides space for configuration information for one SIP account. Fields that are typically completed by the user to suit their preference are not included.
Dialog Field Account 1 Account 2 Account > Storage Storage method Tab (for buddies) Root URL WebDAV poll time Credentials (radio button) Username Password Account > Security Tab Signaling Transport Account > Advanced Tab Reregister every Media Encryption over TLS Minimum time Maximum time Enable session timers Session timer preference Default session time Hold method (old or new standard) Send SIP keep-alives Use rport Send outgoing request directly to target Preferences > Privacy Allowed domains
CounterPath Corporation Dialog Field Preferences > Directory Directory type LDAP Server Authentication method Username Credential Root DN ADSI Subtree DN Search Options (Both Types) Type of search Search timeout Max results Update interval Attribute Mapping (Both Types) Display name First name Last name Job title Department Location Work number Mobile number Softphone Office phone E-mail Jabber 52 Account 1 Account 2
Bria for Windows Administrator Guide Dialog Field Preferences > Contact Storage Storage method Account 1 Account 2 WebDAV Username Password Root URL WebDAV Poll time XCAP Username Password Root URL Outlook Personal Contacts Profile Password Field to use Preferences > Advanced DTMF method RTP - enable inactivity timer RTP - time Recording folder File transfer folder Web page tabs – web address 53
CounterPath Corporation XMPP Account Field Account Name User ID Domain Password Display name Port selection Connect port Outbound proxy Resource Priority 54 Account 1
Bria for Windows Administrator Guide 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.
CounterPath Corporation B.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.
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. Where there is an overlap between the digit map and regular expression rules, the digit map rules apply.
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 58. 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 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.
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 62
Bria for Windows Administrator Guide C 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 Windows. For details, see “Setting up Contacts” on page 16.
CounterPath Corporation 64
Bria for Windows Administrator Guide D Glossary AEC AGC AVI Broadband Codec Dial plan DTMF IM IP IP address Media MOV MWI Narrowband Presence Proxy PSTN RFC RTP Signaling 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.
CounterPath Corporation SIMPLE protocol SIP SIP account softphone address SRTP TCP TLS UDP URI URL USB device VAD vCard VoIP VoIP service provider WAV 66 controlling the connection, and managing the network. The non-signaling portion of the call is the Media. Session Initiation Protocol for Instant Messaging and Presence Leveraging Extensions. The instant messaging (IM) protocol followed by Bria. It encapsulate the rules for exchanging instant messages. Session Initiation Protocol.
