Bria 3 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 2013 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 ii
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 Optimal: 2 GB RAM.
Bria 3 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 3 Administrator Guide Instructions for your Users Because you are not provisioning Bria, your users do not need to log on. Instruct your users to start Bria as follows: • • The first time the user starts Bria, the Login dialog appears. The Login dialog for Bria for Windows and Bria for Mac Login dialogs are shown below. The user should set the profile to “No login required” and click Continue. Bria will start and the user can configure the softphone.
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 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 (XMPP accounts) Accounts > Account (XMPP) page 20 Outlook address book, set up in Bria Accounts list page 11 Presence (online status) Accounts > Presence page 29 Quality of Service (Windows XP only) Preferences > Quality of Service page 45 Transport Accounts > Transport page 36 Voicemail Accounts > Voicemail page 26 Web pages Preferences > Files & Web Tabs page 49 Workgroups (BLF - Busy Lamp Field and BLA - Bridge Accounts > Pre
Bria 3 Administrator Guide 2.2 Configuring Accounts SIP Accounts Each user will need at least one SIP account, in order to make phone calls. The SIP account may also be used for presence (online status sharing) and instant messaging.
CounterPath Corporation Procedure Create SIP Account 1. When the softphone appears, click the Go to Account Settings link. 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. Create XMPP Account 4. If you are setting up an XMPP account, choose Softphone > Account Settings again.
Bria 3 Administrator Guide Setting up Multiple SIP 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.
CounterPath Corporation 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: • • • • • • Devices.If you want Bria to support SIP deskphones, set up the deskphone from this panel. Audio Codecs and Video Codecs. You should enable the codecs that are suitable to your environment. Quality of Service.
Bria 3 Administrator Guide 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. Populating the Contact List from an XMPP Roster If you support XMPP accounts, the XMPP roster is automatically pulled into Bria when the XMPP account is enabled. You could pre-populate each user’s roster with the corporate contact list.
CounterPath Corporation Importing the File 1. From the main menu choose Contacts > Import Contacts. The Import Contacts wizard starts. 2. As soon as you click Finish on the wizard, the Contacts tab in Bria is updated to show the imported entries. Populating Contact List from Outlook or Mac Address Book Bria for Windows is automatically set up with an Outlook account. Bria for Mac is automatically set up with a Mac Address Book account. Both these accounts are disabled by default.
Bria 3 Administrator Guide 2.4 Verifying your Presence Setup Once you have created a contact list, you can test your presence setup to make sure that contacts are being subscribed to. 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.
CounterPath Corporation 2.5 Setting up Workgroups A workgroup is a group of people who work together. Via the Bria Workgroup window, members of a workgroup can monitor each other’s calls and pick up on behalf of another member and join an established call. To set up workgroups for your users, see page 31. 2.6 Setting up Chat Rooms If you support XMPP accounts, you can set up persistent chat rooms on your XMPP server. Users with accounts on that XMPP server can then join any chat room (View > Chat Rooms).
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 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.
Bria 3 Administrator Guide Table 1: XMPP Account Properties – Account Field Resource Priority 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.
CounterPath Corporation 3.3 Outlook or MAB Account Bria automatically creates an Outlook account if it detects Outlook on the user’s computer. On a Mac computer, Bria always creates a Mac Address Book (MAB) account. The user can enable the Outlook or MAB account to provide Bria with access to the contacts in that address address book.
Bria 3 Administrator Guide Table 2: Outlook Account Properties – Account Field Field to use for IM address Description Bria can be set up to treat one of the contact fields as an XMPP address that can be subscribed to, assuming that you are have an XMPP account set up in Bria. For example, if you select “IM address” in this field, then when contacts are pulled into Bria, any IM Address fields that have a value will be copied to the Instant Message field in the Bria contact.
CounterPath Corporation 3.4 SIP Account Properties – Account Fields with a red asterisk are required Table 3: 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.
Bria 3 Administrator Guide Table 3: 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.
CounterPath Corporation 3.5 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.
Bria 3 Administrator Guide Table 4: SIP Account Properties – Voicemail Field Always forward to this address Description Typically, each user sets this field up individually, to suit their needs. This feature works even if the VoIP service does not include voicemail. 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).
CounterPath Corporation 3.6 SIP Account Properties – Topology Table 5: 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.
Bria 3 Administrator Guide 3.7 SIP Account Properties – Presence This tab lets you set up presence (for both Bria for Windows and Bria for Mac) and workgroups (Bria for Windows only). Setting up Presence If you are using SIP SIMPLE for online status sharing (presence), you can configure the SIP account to handle subscriptions through peer-to-peer subscriptions (the default) or through a presence agent. 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 online status occurs. This chart illustrates a peer-to-peer subscription, but the same principle applies when a presence agent is used.
Bria 3 Administrator Guide Configuring Workgroups A workgroup is a group of people who work together. Workgroups are also known as BLF (Busy lamp field) and BLA (Bridged line appearance). Via the Bria Workgroup window, members of a workgroup can monitor each others’ calls, pick up on behalf of another member, and join an established call. Workgroups can be set up as a server-side feature (below), or they can be set up in the Bria client, in peer-topeer mode (page 32).
CounterPath Corporation When the user chooses View >Workgroup, Bria immediately registers attempts to subscribe to the workgroup. If the subscription succeeds, the Workgroup window appears in Bria.
Bria 3 Administrator Guide When you display the Workgroup (View > Workgroup from the main menu), the members will appear. This person is shaded out. Either she has not yet added you to her workgroup list or she has added you but with “Allow this person to monitor my activity” turned off This person is in your group and you are in her group.
CounterPath Corporation Setting up as a Supervisor 1. Set the Mode to Peer-to-peer and select “I will choose who can monitor me”. 2. Click Edit Members. On the Workgroup Members window click Add. In the Add Workgroup member window, enter a person’s SIP address as shown. Repeat for all the members of the workgroup. The Workgroup Members window will look like this: 3. When done, close the Workgroup Members window.
Bria 3 Administrator Guide 3.8 SIP Account Properties – Storage Change this tab if you want to let users store their contact list on a WebDAV or XCap server that you have already set up. Table 7: SIP Account Properties – Storage Field Storage method Description Choose the appropriate storage. Server Settings (not used for “Local”) Use SIP credentials Use alternative server credentials Check this box to use the username and password from your SIP account in order to log into the storage server.
CounterPath Corporation 3.9 SIP Account Properties – Transport Table 8: SIP Account Properties – Security Field Signaling Transport Media Encryption over TLS Enable IPv6 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.
Bria 3 Administrator Guide Setting up for Security within Bria The options for media encryption are described in the following table. Table 9: Media Encryption Options Option Make and accept only encrypted calls Do not allow encrypted calls 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.
3.10 SIP Account Properties – Advanced s Table 10: 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.
Bria 3 Administrator Guide Table 10: 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 40
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 – 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 3 Administrator Guide Supported Codecs Codec Narrowband Wideband Broadvoice-32 3 Broadvoice-32 FEC 3 G.711aLaw * 3 G.711uLaw * 3 3 G.722 G.729 * 3 iLBC 3 3 3 OPUS SILK Narrowband Royalty-bearing 3 SILK Wideband 3 SILK Super-wideband 3 Speex 3 Speex FEC 3 Speex Wideband 3 Speex Wideband FEC 3 * Generally, at least one of these codecs must be enabled in order to place a PSTN (land line) call.
CounterPath Corporation 4.3 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.
4.4 Preferences – Quality of Service Quality of Service is supported only in Bria for Windows and only if the user is using a computer running Windows XP. QoS is not supported on later versions of Windows. This panel appears only if the computer is running Windows XP. 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).
CounterPath Corporation 4.5 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 3 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.
Bria 3 Administrator Guide 4.6 Preferences – Calls Field Description Auto Answer Let your users set these fields to suit. DTMF 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.
4.7 Preferences – Files & Web Tabs Field Description Recording folder The folder where files for recording of phone calls will be saved. File transfer folder The folder where received files will be saved. Web Page Tabs 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.
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.
CounterPath Corporation Dialog Field Account > Presence Tab Presence Mode Poll time Update interval Enable workgroup Workgroup mode If RLS mode: Workgroup address (Bria for Windows only) If RLS mode: Allow others to monitor If peer-to-peer mode: Edit members list (list of people in workgroup) Account > Storage Storage Method Account > Security Tab Signaling Transport Media Encryption over TLS Enable IPv6 Account > Advanced Tab Reregister every Minimum time Maximum time Enable session timers Session
Bria 3 Administrator Guide Dialog Field Preferences > Directory Directory type Account 1 Account 2 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 Preferences > Calls DTMF method RTP - enable inactivity timer RTP - time Preferenc
CounterPath Corporation XMPP Account Field Account Name User ID Domain Password Display name Port selection Connect port Outbound proxy Resource Priority 54 Value
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 15. The same headings are used for both Bria for Mac and Bria for Windows.
CounterPath Corporation 56
Bria 3 Administrator Guide C Glossary Broadband Codec Dial plan DTMF Firewall HID IM MWI Narrowband Presence PSTN SIP account softphone address USB device vCard VoIP XMPP account Broad or wide bandwidth. In data transmission, the wider the band, the more data it is possible to transmit in a given time span. A cable, DSL and ADSL connection to the network provide broadband for data transmission. A dialup or ISDN connection typically provide a narrow bandwidth for data transmission.
CounterPath Corporation 58
