Bria 3 Configuration Guide Retail Deployments 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 © May 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 About Configuration .....................................................................................................................2 Configuration Settings by Topic...................................................................................................3 Account Credentials................................................................................................................3 Account Setup......................................................................................
CounterPath Corporation 2 Confidential – Do not Distribute
Bria 3 Configuration Guide – Retail Deployments About this Manual This manual is intended for: • • System administrators who are deploying Bria in their enterprise by remotely configuring the client through remote provisioning. (For more information on the options for configuring, see the “Bria 3.0 Administrator Guide” ). VoIP service providers who have purchased the retail version of Bria and want to remotely configure Bria for their customers.
CounterPath Corporation 1 About Configuration Bria Settings Configuration of Bria is achieved largly 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.
Bria 3 Configuration Guide – Retail Deployments 2 Configuration Settings by Topic 2.1 Account Credentials For information on these settings, see “Provisioning Bria Retail Edition”. 2.2 Account Setup These settings define the user’s account or accounts. There is one section for each account: proxy0, proxy1, and so on. Each account is either a SIP or an XMPP account, as specified by the proxies:proxyn:protocol setting. For each account type, a different subset of the proxies settings is applicable.
CounterPath Corporation 2.3 Audio Quality These settings provide controls for audio quality. 2.4 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 documentation for details. You can restrict codec usage by enabling or disabling a codec and by setting the license count (even on non-royalty-bearing codecs). Enabling Codecs To enable a codec, set its codecs::enabled setting to true.
Bria 3 Configuration Guide – Retail Deployments The codecs are prioritized within that list, with preferred codecs appearing first, based on the number each codec is assigned in codecs::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.
CounterPath Corporation 2.5 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: • • • To prevent unresolvable 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.
Bria 3 Configuration Guide – Retail Deployments • • When a match is found between the input and the pattern, the account that this pattern belongs to is selected and the transformation for this pattern is performed. If no match is found, the default account is selected and no transformation is performed. (The default account is the enabled account that appears first in the list in the Account Settings window.) For details on matching see “How the Input Is Processed” on page 9.
CounterPath Corporation 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. For this reason, there are some special cases, included in the table below. The following table describes the most common elements. As mentioned, all regular expression elements are supported. Some elements use the back slash \ character.
Bria 3 Configuration Guide – Retail Deployments • • T timer is set in proxies:common:digit_map_timer_critical. The default value is 4000 milliseconds (4 seconds). The long timer is set in proxies:common:digit_map_timer_partial. The default value is 20000 milliseconds (20 seconds). 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.
CounterPath Corporation Results of the Comparison How Call Placed Type of Match User is typing Partial match Dragged or selected Result If User Presses Enter or Call Result if User Stops typing The characters typed so far follow the pattern but there are not yet enough characters for a pending or complete match. The default account is used. No transformation is performed. If the user stops typing for the long timer length (usually 20 seconds), then the default account is selected.
Bria 3 Configuration Guide – Retail Deployments 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 SIP address, and to how 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 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 prefix, you may want to include this pattern to handle such a scenario. • Distinguishing between a local seven-digit call in which 9 is not dialed (to access an outside line) and one in which 9 is dialed to access an outside line. 2.
Bria 3 Configuration Guide – Retail Deployments 2.7 DTMF This group of settings configures Bria to handle DTMF. DTMF will be sent using either: • • • Out-of-band using 2833 DTMF packets Out-of-band using 2833 DTMF, with a fallback to in-band. In-band, by encoding the DTMF signal in the audio stream. The preferred method is out-of-band. In-band is used only to deal with specific network situations, as described in the reference section for these settings. 2.
CounterPath Corporation 2.9 Feature Enabling at the Account Level The setting proxies:proxyn:enabled_features enables or disables the following features on each account: • Audio call • Video call • IM • Presence • File transfer • Workgroup (BLF) This setting is a bitmask with a default value that enables every feature. Minimum Configuration Bria has rules relating to features on accounts. Because you are configuring accounts through provisioning, you are responsible for ensuring these rules are followed.
Bria 3 Configuration Guide – Retail Deployments 2.10 Feature Enabling: Enabling Other Features Other features are enabled and configured through other settings. See: • • • • • • “File Transfer” on page 15 “Directory” on page 12 “MWI Notification” on page 16 “Presence” on page 18 “Voicemail: “Send to Voicemail”” on page 20. “User Experience” on page 19. 2.11 File Transfer File transfer lets users send and receive files. .
CounterPath Corporation 2.13 MWI Notification This group of settings let you configure Bria to subscribe to your voicemail server to receive notification that messages are waiting for the user. To use MWI, you must have a voicemail server that supports MWI. MWI is set up in each account, that is, in the proxies:proxyn settings. Receiving MWI Information MWI subscription can be performed using SIP subscriptions or via MWI NOTIFY (implicit subscription).
Bria 3 Configuration Guide – Retail Deployments 2.14 Network This group covers settings in several subtopics, all relating to SIP accounts (not XMPP accounts). Make sure you set them for each of your SIP accounts. For your XMPP accounts, the settings are simply ignored. Firewall Traversal You must configure the firewall traversal solution for each account.
CounterPath Corporation 2.15 Presence This group of settings lets you configure how presence is supported when presence is handled using SIMPLE on SIP accounts. For presence on XMPP accounts, no special configuration is required: presence subscriptions are always created for XMPP buddies. If you are not supporting presence through SIP, make sure you disable presence on every SIP account.
Bria 3 Configuration Guide – Retail Deployments 2.16 QoS This group of settings lets you configure the quality of service you offer, if applicable. 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 2.20 Voicemail: “Send to Voicemail” You can configure Bria to automatically send unanswered phone calls to voicemail. (Other call handling features are described in “MWI Notification” on page 16). There are two ways to send to voicemail, using a 486 SIP response or using a 302 SIP response.
Bria 3 Configuration Guide – Retail Deployments 2.22 Zero-Touch Configuration These settings control whether zero-touch configuration is enabled. When this configuration is enabled, Bria automatically detects the audio and video devices connected to the Bria computer, automatically detects the type of connection, and displays device configuration messages.
CounterPath Corporation A Comparison to Bria 2.5 A.1 Summary Following is a summary of major differences in settings between Bria 2.5 and Bria 3.0. New Settings • • • • • • Feature enabling per account. The setting proxies:proxyn:enabled_features let you enable features on a specific account, in order to match your internal business rules or network setup. Workgroup.
Bria 3 Configuration Guide – Retail Deployments Features not Configurable The following features cannot be enabled or disabled through provisioning. These features are permanently enabled; if you need to disable any of these features, you may want to consider obtaining a custom brand; contact CounterPath. • • • • • • • • Call recording Conference call Hiding panels in the Preferences window. IM Archive Importing sounds Letter-to-digits mode Menus: Hiding an individual menu item.
CounterPath Corporation A.2 Details Status Domain Section Setting Topic Revised proxies proxyn domain Account credentials Description for XMPP changed. Revised proxies proxyn username Account credentials Description for XMPP changed. Deleted feature advertise url ment_mo dule Advertisement Custom builds only. URL must be set at build time Deleted proxies proxyn anonymous_calli Anonymous Calling ng_method SIP is always used.
Bria 3 Configuration Guide – Retail Deployments Status Domain Section Setting Deleted feature call enable_recording Feature Enabling Phone Calls Deleted feature contact assign_ringtone Ringtones Feature is not supported. Deleted feature audio allow_import_sou Feature Enabling nds Deleted feature file_trans enable fer_conte nt_indirec tion File Transfer Content Feature is not supported.
CounterPath Corporation Status Domain Section Setting Topic Subtopic Comment Deleted proxies proxyn ice_enabled Network SIP Firewall Traversal ICE Deleted proxies proxyn send_internal_ip_ Network SIP address Firewall Traversal STUN Deleted proxies proxyn stun_server Network SIP Firewall Traversal STUN Deleted system stun total_retransmit_ Network SIP packets Firewall Traversal STUN Revised rtp inactivity rtcp_timer_in_ms Network SIP RTP Session Revised rtp inactivity rtp_ti
Bria 3 Configuration Guide – Retail Deployments Status Domain Section Setting Topic Deleted system screen_ca reg_exp lls Screen Calls Deleted feature call response_code_d SIP Handling nd Deleted feature call response_code_n SIP Handling o_resource Deleted feature call response_reason_ SIP Handling blocked Deleted feature call response_reason_ SIP Handling dnd Deleted feature call response_reason_ SIP Handling no_resources Deleted feature call sip_response_cod SIP Handling e_b
CounterPath Corporation Status Domain Section Setting Deleted ui im message_new_wi User Experience ndow IM IM tabs are not supported Revised ui Im popup_on_new_s User Experience ession IM This setting is now exposed in a different way on the GUI; it is included in the events list on the Alerts tab, as "For IM".
Bria 3 Configuration Guide – Retail Deployments Status Domain Section Setting Topic New video performa restricted_mode_ Video nce enabled Revised proxies proxyn Deleted feature browser_ urln modules Web Browser Deleted feature browser_ use_postn modules Web Browser Deleted feature embedde additional_header Web Browser d_browse r Deleted feature workgrou enable p New proxies proxyn allow_dialog_sub Workgroups (Busy scriptions Lamp Field) New system network connection_type for
CounterPath Corporation 30
