CounterPath Bria 3.1 User Manual
Bria 3 Configuration Guide
Retail Deployments
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 reserv ed.
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.
CounterPath and the logo are trademarks of CounterPath Corporation.
The content of this publication is intended to demonstrate typical uses and capabilities of the Bria softphone
application from CounterPath Corporation. Users of this material must determine for themselves whether the
information contained herein applies to a particular IP-based networking system.
CounterPath makes no warranty regarding the content of this docu ment, including—but not limit ed to—implied
warranties of fitness for any particular purpose.
In no case will CounterPath or persons invo lved in th e pr oduct ion of th is do cumente d ma teria l be lia ble for any
incidental, indirect or otherwise consequential damage or loss that may result after the use of this publication.
Windows, W indows V ista, Active Directory, and Outlook are registered trademarks of Microsoft Corporation in
the United States and other countries.
This manual corresponds to Bria version 3.1.
2
R2
Content s
About Configuration.....................................................................................................................2
Configuration Settings by Topic...................................................................................................3
Account Credentials................................................................................................................3
Account Setup.........................................................................................................................3
Audio Quality .........................................................................................................................4
Call Security (Encryption)......................................................................................................4
Codec Usage ...........................................................................................................................5
Deskphone Control .................................................................................................................6
Dial Plan .................................................................................................................................7
Directory.................................................................................................................................13
DTMF .....................................................................................................................................14
Feature Enabling at the Account Level...................................................................................14
Feature Enabling: Enabling Other Features............................................................................15
File Transfer............................................................................................................................15
License Provisioning...............................................................................................................15
Network Connection...............................................................................................................15
Network – SIP.........................................................................................................................16
Network – XMPP....................................................................................................................17
Presence ..................................................................................................................................17
QoS .........................................................................................................................................18
Resources................................................................................................................................18
Shortcut Keys..........................................................................................................................18
User Experience......................................................................................................................18
Video.......................................................................................................................................19
Voicemail – MWI Notification...............................................................................................19
Voicemail – Send to Voicemail..............................................................................................20
Web Browser Configuration...................................................................................................20
Workgroup..............................................................................................................................21
Zero-Touch Device Configuration..........................................................................................21
A Comparison to Bria 2.5.............................................................................................................22
B Comparison to Bria 3.0 .............................................................................................................30
1
CounterPath Corporation
2
Bria 3 Configuration Guide – Retail Deployments
About this Manual
This manual applies to all platforms of Bria: Bria for Windows, Bria for Mac and Bria for Linux.
This manual is intended for:
• System administrators who are deploying Bria in their enterpri se by remotely configuring the client thro ugh
remote provisioning. (For more information on the options for configuring, see the “Bria for Windows
Administrator Guide”).
• VoIP service providers who have purchased the retail version of Bria and want to remotely configure Bria
for their customers.
It gives an overview of the types of features t hat can be config ured, and provid es context for al l the settings that
you can provision.
This manual is intended to be read in conjunction with:
• “Bria 3 Provisioning Guide - Retail Deployments”, which describes the mechanism for configuring the
features.
• The Bria Settings reference documentation (a Microsoft® Excel® document). The Bria Settings reference
documentation provides detailed information on settings that may only be mentioned by name in this
configuration manual.
1
CounterPath Corporation
1 About Configuration
Bria Settings
Configuration of Bria is achieved largely through assigning appropriate values to settings. Settings let you:
• Configure Bria for the environment (network and so on) in which it will work.
• Configure Bria for server-side functions you support, such as WebDAV storage.
• Configure how some Bria features work, and configure whether a feature is enabled or disabled.
• How features work: For example, entering the phone numbers to use for voicemail.
• Enable or disable features: The features that can be set in this way are those that have already been
included in your brand before compiling. You can disable features for specific installs. For example ,
you could enable QoS for some users and disable it for others.
Bria and Multiple Accounts
Bria supports up to ten accounts. However, in discussions in this manual, it is usually assumed that you will
have only one SIP account and, optionally, one XMPP account. (XMPP is not supported in Bria for Linux.)
Using this Manual
In the following pages, the settings are broken down into topics. Topics are organized alphabetically. Within
each topic, general information is provided on how the settings in the topic work. Some topics do not apply to
specific platforms.
You can read a topic then consult the Bria Settings reference documentation (available separately) for detailed
information on each individual setting. Within that reference documentation, you can sort the table by the Topic
column in order to group related settings together.
See “Comparison to Bria 2.5” on page 22 and “Comparison to Bria 3.0” on page 30.
2
Bria 3 Configuration Guide – Retail Deployments
2 Configuration Settings by Topic
2.1 Account Credentials
Account credentials for each account consist of the user name and password. Do not confuse these credentials
with the login credential s. For complete information on these settings, see “Bria 3 Provisioning Guide - Retail
Deployments”.
2.2 Account Setup
These settings define the user’s account or accounts. There is one section for ea ch account: proxy0, proxy1, and
so on.
Each account is either a SIP or an XMPP acc ount, as spec ified by the p roxies:proxyn :protocol set ting. Note th at
XMPP is not supported in Bria for Linux.
For each account type, a different subset of the proxies settings is applicable. For example, proxies:
proxyn:register applies only to a SIP account, while proxies:proxyn:xmpp_resource applies only to an XMPP
account. A few settings (such as proxies:proxyn:account_name) apply to both types.
Make sure you configure the appropriate settings for each account type. If a setting in a given section (proxyn)
does not apply to that account type, Bria simply ignores it.
3
CounterPath Corporation
2.3 Audio Quality
These settings provide controls for audio quality.
2.4 Call Security (Encryption)
About Signaling and Media Encryption
Bria can be configured to support signaling and media encryption (security) for phone calls.
• Signaling encryption is only possible u s ing TLS as the transport; UDP and TCP do not support signaling
encryption.
• Media encryption, which is performed using SRTP, can only be supported if signaling encryption is in
place, in other words, if TLS is used for the transport.
Setting up for Security outside of Bria
When using TLS, the user must have the root certifica te that signs the proxy’s chain of certificates. In most
cases, the root certificate will already be installed. Procedures for exchange of certificates are outside the scope
of this documentation. The certificates must be stored on the Bria computer, in the root certificate store.
Setting up the root certificate on the Bria user’ s computer ensures that the co nnection to the proxy is TLS sec ure
(the first hop). Any proxy in the chain (between the user and the other party) that does not supp ort TLS may
cause an insecure link 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 displays the encryption icon. This
icon indicates that the call is secure between each call er and their proxy (the first and last hops); th e call may or
may not be secure for other hops.
Encryption Options Supported by Bria
You must set up each account to enable or disable call encryption.
Option How Outgoing Calls are Handled How Incoming Calls Are Handled
Make and accept
only encrypted
calls
Do not allow
encrypted call
Bria will place all calls with TLS. The call
invite will specify SRTP media encryption.
If the correct certificates are not in place or if
the other party does not accept encrypted calls,
the call will fail.
Bria will place only unencrypted calls.
If the other party does not accept unencrypted
calls, the call will fail.
Bria will only accept INVITEs that are for encrypted calls.
If Bria receives a call INVITE that is not encrypted, the call
will be rejected.
Bria will only accept INVITEs that are for unencrypted calls.
If Bria receives a call invite that is encrypted, the call will be
rejected.
Configuring for these Encryption Options
• To support encrypted calls, set proxies:proxyn:transport to TLS and set
proxies:proxyn:security_outgoing_ srtp to true.
• To support only unencrypted calls, set proxies:proxyn:transport to Auto, UDP or TCP and set
proxies:proxyn:security_outgoing_s rtp to false.
4
Bria 3 Configuration Guide – Retail Deployments
2.5 Codec Usage
Your brand includes a specific set of built-in codecs. A codec may be royalty-bearing or non-royalty-bearing:
see the Bria Settings reference docume nt ation for deta ils. You can restric t code c usage by enabl ing or di sablin g
a codec and by setting the license count (even on non-royalty-bearing codecs).
Enabling Codecs
To enable a codec, set its codecs:<codec name>:enabled setting to true. When a codec is enabled, it appears in
the enabled list in the Preferences > Audio Codecs or Preferences > Video Codecs tab.
Note that whether a codec is enabled is only one of the factors in whether it will be used for a call. The other
factors are:
• The license count for codecs. If you included royalty-bearing codecs in your brand, you would have
specified the license count, which establishes the number of simultaneous calls or number of legs (in the
case of a conference call) that can use the codec. Once the limit is reached, that codec will not be used for
new calls.
• Whether the codec is also enabled by the other party
• Whether it is in under the bandwidth limit of the local Bria computer.
• Its ranking in the SDP list (see below).
• How the codec is chosen (see below).
Presenting Local Media Capabilities in SDP
For the incoming audio or video (the audio or video th e other party se nds), Bria adv ertises a list of codecs in the
INVITE or 200 OK SDP.
• For the invite (the offer), this list is made up of the codecs that are enabled and that are under the bandwidth
limit of the local Bria computer.
• For the 200 OK (the counter-offer), this list is cont rolled by the
media:sdp:specify_all_codecs_in_offer_answer setting. False (the default) means the list is made up of the
codecs in the invite that are in the bandwidth limit of the local Bria computer. True means the list is made
up of all codecs that are enabled in the local Bria computer (not just those in the inv ite ) and that are in the
bandwidth limit of the local Bria computer.
The codecs are prioritized within that list, with preferred codecs appearing first, based on the number each
codec is assigned in codecs:<codec name>:priority.
Handling the Media Capabilities of the Other Party
For outgoing audio or video (the audio or video you send the other party), there are two ways to configure Bria:
• Let Bria determine the codecs to use for each call. This is the default.
From the list of codecs that advertised by the other party in their SDP, that are enabled on the local Bria
computer and that are under the bandwidth limit of the local Bria, Bria chooses the codec with the best
sound, based on the network conditions.
To set up for this scenario, set system:network:honor_first_codec to false.
• Use the other party’s preferred codec.
5
CounterPath Corporation
From the list of codecs that advertised by the other party in their SDP, that are enabled on the local Bria
computer and that are under the bandwidth limit of the local Bria, Bria chooses the codec that is listed first.
To set up for this scenario, set system:network:honor_first_codec to true.
2.6 Deskphone Control
Deskphone control is not supported in Bria for Linux.
If you are deploying to an enterprise that uses SIP deskphones, you can configure Bria to use them. Users will
be able to initiate calls from Bria (for example, in order to make use of the history or contact list) then switch
over to the deskphone for the rest of the call.
The deskphone must be a SIP phone that supports dialog events.
Each user must be configured separately for deskphone, so in order to provision workgroup data, you must
provision individual data for each user. The other option is to let the users specify the deskphone URI
themselves, on the Preferences > Devices tab.
To set up for deskphone:
• Make sure the deskphone has already been set up in the network and on the PBX, and that it can make
phone calls.
• Set feature:deskphone:subscribe_path to the URI of the deskphone. For example, 3210@myEnterprise.com
• To test the deskphone setup, on the Bria dashboard menu, choose Cal l U sing D esk ph one. Then place a call.
6
Bria 3 Configuration Guide – Retail Deployments
2.7 Dial Plan
The dial plan defines patterns that a user-dialed phone number are matched to. A dial plan is used for any
combination of these reasons:
• T o prevent unresolvabl e calls being placed. For example, to prevent using network bandwidth on a call that
will certainly fail. You define patterns that you know will work, and only place a call if it matches one of
these patterns.
• To modify the input if that is required to ensure that the call gets established. For example, to add the “9”
required to obtain an outside line from a PBX.
• To select the account to use to place a call, if users can have more than one account. For example, if you
want calls that match one pattern to go through one account and calls that match another pattern to go
through another account.
Quick Reference to the Dial Plan Settings
For information on the individual Bria settings that relate to the dial plan:
• digit_map. See “Dial Plan Syntax”, below.
• digit_map_timer_critical. See “Timers” on page 9.
• digit_map_timer_partial. See “Timers” on page 9.
The Default Dial Plan
The default dial plan is:
#n\a\a.T;match=1;prestrip=2;
where #n is the account prefix (#1 for the first account in the list (proxy0), #2 for the second account (proxy1),
and so on).
If the input is the account prefix and the number, then the Account for this dial plan is selected. The account
prefixed is stripped from the number before the call is placed.
If all Accounts use this dial plan, then the behavior is as follows: if the input includes the account, then that
account is used. In other words, you can force selection of a specific account by inclu ding the acco unt prefix. If
the input does not include #n, then the default account is used.
How Dial Plans Are Used
The input (what the user types, selects or drags onto the display) is processed as follows:
Cleanup
This step is not part of the dial plan: it is always performed even when there is no dial plan.
Input is cleaned up by removing spaces and 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. Each account has one
dial plan, and each dial plan has one or more patterns.
7
Loading...