Bria Cloud 1.6 Administrator Guide

Transcription

1 Bria Cloud 1.6 Administrator Guide

2 CounterPath Corporation CounterPath Corporation Suite 300, One Bentall Centre 505 Burrard Street, Box 95 Vancouver, BC V7X 1M3 Tel: March 2014 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. The content of this publication is intended to demonstrate typical uses and capabilities of the CounterPath CCS (CCS). 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 document, including but not limited to implied warranties of fitness for any particular purpose. In no case will CounterPath or persons involved in the production of this documented material be liable for any incidental, indirect or otherwise consequential damage or loss that may result after the use of this publication. CounterPath and the logo are trademarks of CounterPath Corporation. iphone, ipod Touch, ipad, itunes, Mac, Mac OS, QuickTime and isight are registered trademarks of Apple Inc. Android is a trademark of Google Inc. Windows, Windows Vista, Active Directory, Excel and Outlook are registered trademarks of Microsoft Corporation in the United States and other countries. The Bluetooth word mark, figure mark, and combination marks are all trademarks that are owned by the Bluetooth SIG. Firefox is a registered trademark of the Mozilla Foundation. Chrome is a trademark of Google Inc. Safari is a registered trademark of Apple Inc., registered in the U.S. and other countries. Opera is a trademark of Opera Software ASA. Internet Explorer is a registered trademark of Microsoft Corporation in the United States and other countries. This manual corresponds to version 1.6 of the CCS. R1 2

3 Contents 1 Overview The Softphone Clients The Attributes Lists The CCS How Provisioning Works What Happens on the CCS Remote Refresh Recommended Procedures Initial Setup Set up for Bria Mobile Only Set up for Bria Desktop Only Set up for Bria Mobile and Bria Desktop Setting up More Users Maintenance Supporting Upgrades of Bria for CCS Creating More Profiles Tracking Device Usage Viewing Device Debug Logs Viewing Event Logs Viewing User Traces Viewing CCS Reports Downloading Reports Reports in the Device Counts Section Reports in the Codec Usage Section Reports in the User Activity Section Reports in the API Activity Section Data Entry Rules Working with the CCS Web Interface Logging on Working with Groups Viewing Group Information Retrieving Event Logs from the Group Screen Retrieving Device Logs from the Group Screen Working with Profiles Creating a Profile from Scratch Creating a Profile by Copying Managing Profiles Working with Users and User-Attributes The Users Toolbar Manually Creating Users Creating Users by Uploading a File Managing Users Sending Notifications to Users Managing Device Usage (Max Devices)

4 CounterPath Corporation 4 CCS Tools Testing your Provisioning Setup Retrieving Event Logs and User Traces Retrieving Device Logs Retrieving Reports A Login Error Messages

5 About this Manual This manual describes how to use CounterPath s CCS web client to configure the Bria for CCS softphones in order to automate deployment of these softphones to end users. This manual is intended for IT administrators who have purchased a subscription to the Bria Cloud service from the CounterPath Store and are deploying the Bria for CCS line of softphones to their employees. This manual applies to provisioning of the Bria Desktop softphone and any of the Bria Edition softphones (known collectively as Bria Mobile ), specifically: Bria for CCS Desktop edition (for Windows or for Mac) Bria for CCS iphone Edition Bria for CCS ipad Edition Bria for CCS Android Edition Bria for CCS Android Tablet Edition Bria BlackBerry Edition for CCS Usage of the CCS web client and specific softphone clients is governed by the terms of service you agreed to when signing up for the Bria Cloud service. Related Manuals To obtain the following documentation, go to counterpath.com > Store > Bria Cloud Solutions; look in the Resources tab. Attributes lists: CCS Attributes for Bria Desktop Version x.x Softphone and CCS Attributes for Bria Mobile Version x.x Softphones. The documents that describe the contents of the device debug logs (page 33): Bria Mobile Debug Logs - Sample for Failed Call and Bria Desktop Debug Logs - Sample for Failed Call. Supported Browsers Most browsers that are newer than two years older will support all the features of the CCS web interface. Supported browsers include Firefox, Chrome, Safari, Opera. Internet Explorer will support most features but will not show values in the profile or user that are inherited. For examples, see page

6 CounterPath Corporation 6

7 1 Overview Provisioning the softphone clients involves three components: The softphone clients themselves. The Attributes lists, which provides detailed information on all the softphone client attributes that can be configured. There is one list for Bria Desktop and another list for Bria Mobile. The CCS, which is a server hosted by CounterPath. You will work with the CCS via the CCS web interface, which runs in a web browser. 1.1 The Softphone Clients Obtaining the Mobile Clients The Bria for CCS softphone clients for are free for downloading from the relevant store: Bria for ios devices: on an ipad, iphone or ipod device, go to the App Store and search for counterpath bria. Bria for Android devices: on an Android smartphone or tablet, go to the Play Store and search for counterpath bria. Make sure you download the client with the words for CCS in the title. The logo for this app is red (not gold). Obtaining the Desktop Client When you sign up for the Bria Cloud service, you will be sent an that holds the links to the clients (Windows and Mac). Click the link to automatically download the client, then install it in the normal way. System Requirements For information on the latest system requirements for the softphones, see the Requirements tab on the following pages:

8 CounterPath Corporation 1.2 The Attributes Lists Obtain the Attributes lists. There is one list for Desktop and one list for Mobile. These lists provide detailed information on all the attributes (settings) that you can configure in the clients. Following is a summary of these attributes: Attribute Name Description Comment account.notification.<name> account1sip.credentials.<na me>: account2xmpp.credentials.< name> Relates to the notification feature of CCS, described on page 160. Attributes for the SIP account credentials. Typically these attributes are different for each user (except for the attribute for the domain). Attributes for the XMPP account credentials. Typically these attributes are different for each user (except for the attribute for the domain). Required Required only if you create XMPP accounts. desk.<name> Attributes for Bria Desktop. Applicable only if you are deploying Bria Desktop desk.account2xmpp.<name> XMPP network settings. Applicable only if you create an XMPP account and are deploying Bria Desktop. The defaults are probably acceptable. desk.codecs.<name> Attributes to enable codecs on Bria Desktop The defaults are probably acceptable. desk.feature.<name> Attributes to enable and set up various features. Check the defaults to make sure the features are set up as desired. desk.network.<name>. Attributes to configure Bria Desktop to work in Verify these attributes carefully to ensure the your network. Included in this section are the allimportant firewall traversla attributes. softphone client works as desired in your network. mob.<name> Attributes for Bria Mobile. Applicable only if you are deploying Bria Mobile. mob.account2xmpp.<name> XMPP network settings. mob.codecs.<name> mob.dialplan.<name> Attributes to enable codecs on Bria Mobile. There are four separate sets of codecs: audio WiFi, audio mobile network, and video WiFi, and video mobile network. Attributes to create a dialplan. There are two sets of attributes, to create two dialplans. Applicable only if you create an XMPP account and are deploying Bria Mobile. The defaults are probably acceptable. The defaults are probably acceptable. Ignore if you do not want to set up client-side dial plans. mob.feature.<name> Attributes to enable and set up various features. Check the defaults to make sure the features are set up as desired. mob.network.<name>. Attributes to configure Bria Mobile to work in Verify these attributes carefully to ensure the your network. Included in this section are the allimportant firewall traversla attributes. softphone client works as desired in your network. 8

9 Bria Cloud Administrator Guide 1.3 The CCS You will work with the CCS via the CCS web interface, which runs in a web browser. There are two main screens on the CCS web interface: the Users screen and the Profiles screen. When you signed up for Bria Cloud, CounterPath provided you with: The URL of the CCS web interface. Your administrator name and password. The name of your group. For example, acphone.com. Your CCS Setup You will be set up with a group on the CCS that lets you provision for the desired platform and accounts. The choices are: Platform: Desktop only, Mobile only, or both. Desktop includes both Bria for Windows and Bria for Mac. Mobile includes Bria for all mobile platforms: iphone, ipad, Android smartphone and Android Tablet. Accounts: SIP only, or SIP and XMPP. So the full list of choices is: Desktop only, SIP and XMPP Desktop only, SIP only Mobile only, SIP and XMPP Mobile only, SIP only Desktop and Mobile, SIP and XMPP Desktop and Mobile, SIP only. Users Screen Initially this screen will be empty. You will add, delete, and manage users from this screen. Specifically, you will set up each user with login credentials (which they will enter on their client login screens) and with SIP and XMPP account credentials. 9

10 CounterPath Corporation Profiles Screen Initially, the profiles screen shows the profile or profiles that you are automatically set up with. Click on the name to show the profile contents on the right. The contents show all the attributes that are applicable to your deployment. The list of attributes that appear varies depending on whether you are deploying Bria Desktop and/or Bria Mobile, and SIP accounts only or both SIP and XMPP accounts: A SIP account is required to support phone calls. You can also optionally set up the SIP account to support IM (instant messaging). An XMPP account is required if you want your users to be able to use an XMPP messaging service such as Facebook chat, Google Chat, or a service you run from your own XMPP server. You will review these attributes and change some values, in order to configure the softphone clients for your network. 10

11 Bria Cloud Administrator Guide 1.4 How Provisioning Works 1. You must set up each user: On your call server or IP-PBX, you set up the user with SIP credentials. On the CCS, you enter data (in the Profiles screen) that configures the softphone clients for your network, particularly for your firewall traversal strategy. On the CCS, you set up each user (in the Users screen) with CCS login credentials (so they can log into the softphone) and also enter their SIP credentials (so the phone can register with the call server or PBX in order to make calls). 2. When the Bria softphone starts, a login screen appears and the user enters their CCS login credentials. 3. The Bria softphone sends an HTTPS request to the CCS. The CCS reads the HTTPS request and verifies the login credentials. 4. If the login credentials are known to the CCS, then the CCS creates a provisioning response and sends it down to the Bria softphone. (If the login credentials are not known or if the user is not set up correctly on the CCS, then the CCS sends down a failure response with an error message. Login failed plus the error message will appear on the user s softphone.) For more information on how the CCS verifies the login, prepares the response, and handles failure responses, see the next page. 5. The Bria softphone applies the data in the response and the softphone starts up with the configured behavior. Bria CCS Call Server Set up the CCS Add user, including login credentials and SIP credentials Set up user, including SIP credentials User enters login credentials on Login dialog Login credentials Success and SIP credentials CCS authenticates user Register using SIP credentials 11

12 CounterPath Corporation What Happens on the CCS Step 1: Find the User When the user logs into their Bria Desktop or Bria Mobile client, their login username and password (in other words, their username and password on the CCS) are sent to the CCS in a POST request. The CCS finds the username in your group and verifies that the password matches the user s password in the CCS. If the user cannot be found or if the password check fails, the login request fails and a failure response is sent down and displayed on the user s softphone. Step 2: Find the Profile The CCS then looks in the user information for the profile associated with this user. The CCS reads the POST again to obtain the device the user connected from (for example, desktop or iphone). The profile includes a mapping that matches that device to the template to use for that device. For example, the profile baseprofile maps the iphone to template mobile. If any of these steps fails, then the login request fails and a failure response is sent down and displayed on the user s softphone. Example Assume user fchan@acphone.com is set up in the group acphone.com. Frank logged in from his Bria Desktop softphone. The group acphone.com The user fchan@acphone.com The profile mapped to this user The mapped profile The device the user logged on from (in this example, desktop ) The template mapped to this device 12

13 Bria Cloud Administrator Guide Step 3: Create the Provisioning File The CCS goes through the profile and collects the attributes that have a value assigned. It then goes through the information for the specific user and collects the attributes that have a value assigned. If an attribute has a value in both the profile and the user, the value in the user takes precedence. The CCS then creates a provisioning file that uses this data and is in the format (template) that can be read by a Mobile softphone client. The completed provisioning file is then sent down to the softphone. If any of these steps fail, the login request fails and a failure response is sent down and displayed on the user s softphone Remote Refresh Every 24 hours, the logged on Bria softphone silently connects to the CCS to fetch the latest values you have assigned to the attributes on the CCS. The new values are immediately applied to the softphone. This feature is particularly important for Bria Mobile softphones because users usually do not log in every day: this feature forces down any changes thta you have made to the CCS attributes. This remote update proceeds silently: the Bria user will probably not notice that it is happening. If remote update fails (for example, because there is a network problem), the softphone will continue operation as normal and reschedule the provisioning refresh operation. The user will not experience any interruption. Refresh will continue to fail silently until the server becomes available. 13

14 CounterPath Corporation 14

15 2 Recommended Procedures 2.1 Initial Setup What You Need to Decide You must decide: Whether you want to deploy for Bria Desktop, Bria Mobile, or both. Whether you plan to support IM and presence over the XMPP protocol; in other words, whether you will be provisioning an XMPP account. If you do support XMPP, specify whether you will set up all your users with an XMPP account or only some of them. That is, whether your users will be divided into SIP only and SIP and XMPP. For Bria Desktop, whether you will be provisioning special features: ADSI or LDAP directories; an Outlook account; contact list storage via a WebDAV or XCAP server. You can decide to initially deploy with one configuration, and then later add more features. For example, you can initially deploy to support only Bria Mobile and then add Bria Desktop at a later date. Or you can initially deploy only a SIP account and add an XMPP account later. What You Need The that CounterPath sent you when your organization signed up for Bria Cloud. This includes: The URL to the CCS web interface. Your CCS administrator name and password. A link to the free Desktop version of the Windows and Mac versions of the softphone clients, The two Bria for CCS Attributes lists: one for Desktop and one for Mobile (page 8). 15

16 CounterPath Corporation Set up for Bria Mobile Only Follow these steps if you support any or all of the four Bria Mobile Editions, but not Bria Desktop. Test your Ability to Log in 1. Log into the CCS using the administrator name and password provided by CounterPath. The Users screen appears. It shows the group that has been set up for your organization, for example, acphone.com. Your group name 2. On the Users screen, set yourself up on the CCS (as a regular Bria user) by specifying your CCS username and password; these are the login credentials you will enter on your softphone. Do not worry about the other fields for now. See page 150 for more information on using the Users screen. Username: enter the user portion; the group portion (your domain) will be automatically appended. Password: For improved security, each user s CCS password should be different from their account passwords (account1sip.credentials.password and account2xmpp.credentials.password). 3. Obtain the softphone client: For ios devices, go to the App Store and search for counterpath bria. For Android devices, go to the Play Store and search for counterpath bria. 4. Download and install the free app. Make sure you download the app with the words CCS enabled in the title. The logo for this app is red (not gold). 16

17 Bria Cloud Administrator Guide 5. Start Bria. The login screen appears. For example, here is the login screen for Bria ipad Edition: 6. Log in using the CCS username and password you created. The softphone will start and will show a Phone Not Ready message. You now know that Bria can successfully log on! Now, you need to set up more configuration attributes on the CCS and log in again. Set up Bria 7. Consult your copy of the Attributes list for Bria Mobile. Read through the list and identify attributes whose values you need to set or change. You must at least do the following: Create SIP account credentials: domain, username, password and so on. If you support XMPP, create XMPP account credentials. Make sure the firewall attributes are set up correctly for your network. 8. For every attribute, determine whether it needs to be set at: The profile level. If the same value applies to all attributes, set or change the value in the Profile. (If you need one value for half your users and another value for the other half, you need to create more profiles; see page 31.) The user level. If each user must have their own value, set the value in each User. 9. Go back to the CCS and display the Profiles screen. This screen shows all the attributes that apply to your deployment. The values assigned on this screen apply globally (to all users). 17

18 CounterPath Corporation 10. Click Edit and enter the appropriate values for the attributes you identified. See page 140 for details on using the Profiles screen. For information on this column, see page 54 Complete the attributes according to your earlier decision Skip these for now Skip these credentials attributes for now Skip for now Skip these credentials attributes for now 11. Display the Users screen, select your name, and click Edit. Notice how the values that you set up on the Profiles screen are shown in this form as defaults. 12. Enter the appropriate values for the attributes you identified earlier. See page 150 for details on using the Users screen. Complete these attributes and account2xmpp.credentials (if applicable) Also complete account1sip.voic number (if required). 18

19 Bria Cloud Administrator Guide Test the Setup 13. Go back to the Bria Mobile client. Click the Settings icon in the corner, then click Preferences. Click Logout at the bottom of the screen. After a few seconds the Login screen reappears. 14. Log in again. You have set up an account for yourself, so this time the softphone will be enabled. 15. Perform the following tests: From within your Wi-Fi zone, try making a phone call, for example to a person s extension. If that succeeds, make an outside call. Exit your Wi-Fi zone. You may need to turn off Wi-Fi from the device Settings screen. Make a call over the mobile network. If that call succeeds, turn Wi-Fi back on. If any call does not succeed, there is probably a problem with your firewall traversal setup. Review the network attributes and keep trying until you can successfully place all types of calls. 16. If possible, obtain another device. For example, if you performed these steps on an iphone, obtain an Android smartphone or Android tablet. 17. Download and install Bria from the appropriate store. 18. Log in using the same credentials. 19. Perform the same tests as in step

20 CounterPath Corporation Set up for Bria Desktop Only Follow these steps if you support only Bria Desktop: Test your Ability to Log in 1. Log into the CCS using the administrator name and password provided by CounterPath. The Users screen appears. It shows the group that has been set up for your organization, for example, acphone.com. Your group name 2. On the Users screen, set yourself up on the CCS (as a regular Bria user) by specifying your CCS username and password; these are the login credentials you will enter on your softphone. Do not worry about the other fields for now. See page 150 for more information on using the Users screen. Username: enter the user portion; the group portion (your domain) will be automatically appended. Password: For improved security, each user s CCS password should be different from their account passwords (account1sip.credentials.password and account2xmpp.credentials.password). 3. Obtain the softphone client: On the that CounterPath sent you, click one of the links to the free Desktop version of Bria for CCS: either the Windows or the Mac link, 4. Download and install Bria on your computer as you would any other program. Then start Bria. The login screen appears. 5. Log in using the CCS username and password you created. The softphone will start and will show an Account not enabled message. 20

21 Bria Cloud Administrator Guide You now know that Bria can successfully log on! Now, you need to set up more configuration attributes on the CCS and log in again. Set up Bria 6. Consult your copy of the Attributes list for Bria Desktop. Read through the list and identify attributes whose values you need to set or change. You must at least do the following: Create SIP account credentials: domain, username, password and so on. If you support XMPP, create XMPP account credentials. Make sure the firewall attributes in the Network SIP topic are set up correctly for your network. 7. For every attribute, determine whether it needs to be set at: The profile level. If the same value applies to all attributes, set or change the value in the Profile. (If you need one value for half your users and another value for the other half, you need to create more profiles; see page 31.) The user level. If each user must have their own value, set the value in each User. 8. Go back to the CCS and display the Profiles screen. This screen shows all the attributes that apply to your deployment. The values assigned on this screen apply globally (to all users). 9. Click Edit and enter the appropriate values for the attributes you identified. See page 140 for details on using the Profiles screen. For information on this column, see page 54 Complete the attributes according to your earlier decision Skip these for now Skip these credentials attributes for now Skip for now Skip these credentials attributes for now 10. Display the Users screen, select your name, and click Edit. Notice how the values that you set up on the Profiles screen are shown in this form as defaults. 11. Enter the appropriate values for the attributes you identified earlier. See page 150 for details on using the Users screen. 21

22 CounterPath Corporation Complete these attributes and account2xmpp.credentials (if applicable) Also complete account1sip.voic number (if required). Test the Setup 12. Go back to the Bria Desktop client and choose Softphone > Logout. After a few seconds the Login screen reappears. 13. Log in again. You have set up an account for yourself, so this time the softphone will be enabled. 14. Try making a phone call, for example to a person s extension. If that succeeds, make an outside call. If the call does not succeed, there is probably a problem with your firewall traversal setup. Review the network attributes and keep trying until you can successfully place both types of calls. 22

23 2.1.3 Set up for Bria Mobile and Bria Desktop Bria Cloud Administrator Guide Follow these steps if you support both Bria Mobile (any or all of the four Editions) and Bria Desktop. Test your Ability to Log in 1. Log into the CCS using the administrator name and password provided by CounterPath. The Users screen appears. It shows the group that has been set up for your organization, for example, acphone.com. Your group name 2. On the Users screen, set yourself up on the CCS (as a regular Bria user) by specifying your CCS username and password; these are the login credentials you will enter on your softphone. Do not worry about the other fields for now. See page 150 for more information on using the Users screen. Username: enter the user portion; the group portion (your domain) will be automatically appended. Password: For improved security, each user s CCS password should be different from their account passwords (account1sip.credentials.password and account2xmpp.credentials.password). 3. Obtain the Mobile softphone client: For ios devices, go to the App Store and search for counterpath bria. For Android devices, go to the Play Store and search for counterpath bria. 4. Download and install the free app. Make sure you download the app with the words CCS enabled in the title. The logo for this app is red (not gold). 23

24 CounterPath Corporation 5. Start Bria. The login screen appears. For example, here is the login screen for Bria ipad Edition: 6. Log in using the CCS username and password you created. The softphone will start and will show a Phone Not Ready message. You now know that Bria can successfully log on! Now, you need to set up more configuration attributes on the CCS and log in again. Set up Bria Mobile 7. Consult your copy of the Attributes list for Bria Mobile. Read through the list and identify attributes whose values you need to set or change. You must at least do the following: Create SIP account credentials: domain, username, password and so on. If you support XMPP, create XMPP account credentials. Make sure the firewall attributes are set up correctly for your network. 8. For every attribute, determine whether it needs to be set at: The profile level. If the same value applies to all attributes, set or change the value here. (If you need one value for half your users and another value for the other half, you need to create more profiles; see page 31.) The user level. If each user must have their own value, set the value here. 9. Go back to the CCS and display the Profiles screen. This screen shows all the attributes that apply to your deployment. Attributes that apply to Bria Desktop start with desk. Attributes that apply to Bria Mobile start with mob. The values assigned on this screen apply globally (to all users). 24

25 Bria Cloud Administrator Guide 10. Click Edit and enter the appropriate values for the attributes you identified. See page 140 for details on using the Profiles screen. For information on this column, see page 54 Complete the attributes according to your earlier decision Skip these for now Skip these credentials attributes for now Skip for now Skip these credentials attributes for now Complete all other attributes according to your earlier decision. Complete only mobile.xx attributes; you will complete the desk.xx attributes in a later step. 11. Display the Users screen, select your name, and click Edit. Notice how the values that you set up on the Profiles screen are shown in this form as defaults. 12. Enter the appropriate values for the attributes you identified earlier. See page 150 for details on using the Users screen. 25

26 CounterPath Corporation Complete these attributes and account2xmpp.credentials (if applicable) Also complete account1sip.voic number (if required). Test the Bria Mobile Setup 13. Go back to the Bria Mobile client. Click the Settings icon in the top right corner, then click Preferences. Click Logout at the bottom of the screen. After a few seconds the Login screen reappears. 14. Log in again. You have set up an account for yourself, so this time the softphone will be enabled. 15. Perform the following tests: From within your Wi-Fi zone, try making a phone call, for example to a person s extension. If that succeeds, make an outside call. Exit your Wi-Fi zone. You may need to turn off Wi-Fi from the device Settings screen. Make a call over the mobile network. If that call succeeds, turn Wi-Fi back on. If any call does not succeed, there is probably a problem with your firewall traversal setup. Review the network attributes and keep trying until you can successfully place all types of calls. 16. If possible, obtain another device. For example, if you performed these steps on an iphone, obtain an Android smartphone or Android tablet. 17. Download and install Bria from the appropriate store. 18. Log in using the same credentials. 19. Perform the same tests as in step 15. Set up Bria Desktop 20. Consult your copy of the Attributes list for Bria Desktop. Read through the list and identify attributes whose values you need to set or change. Notice that the attributes for SIP and XMPP account credentials for Desktop and Mobile are identical. You have already set these up for Mobile, and those values will work with Desktop. Make sure the firewall attributes in the Network SIP topic are set up correctly for your network. Notice that the firewall attributes for Desktop and Mobile are different. 26

27 Bria Cloud Administrator Guide Make a note of the attributes for any other features you want to support. 21. Go back to the CCS and display the Profiles screen again. 22. Click Edit and enter the appropriate values for the desk.xx attributes you just identified. Test the Bria Desktop Setup 23. Obtain the Desktop softphone client: On the that CounterPath sent you, click one of the links to the free Desktop version of Bria for CCS: either the Windows or the Mac link, 24. Download and install Bria on your computer as you would any other program. Then start Bria. The login screen appears. 25. Log in using the CCS username and password you created. The softphone will start. 26. Try making a phone call, for example to a person s extension. If that succeeds, make an outside call. If the call does not succeed, there is probably a problem with your firewall traversal setup for Bria Desktop. Review the network attributes and keep trying until you can successfully place both types of calls. 27

28 CounterPath Corporation 2.2 Setting up More Users Once you have determined that you can successfully make a call using Bria, you can add more users. Step A: Setting up for Notification You will have to notify your users that they are set up to use Bria for CCS. The easiest way to do this is using the CCS notification feature. Display the Profiles screen and click Edit. Skip this attribute for now. Your name, for example Emily Wilding or Bria Administrator If you support Desktop on Mac, enter the link from the you received from CounterPath. If you support Desktop on Windows, enter the link from the . When done, click Save Step B: Adding Users Option 1: Adding Users One by One \ Enter the login credentials the user will enter on their softphone. Completing these fields actually creates these credentials. Username: enter the user portion; the group portion (your domain) will be automatically appended. Password: For improved security, each user s CCS password should be different from their account passwords (account1sip.credentials.password and account2xmpp.credentials.password). The user s address, for notifications The user s credentials on your Call server. The number for this user to access voic The user s credentials on your XMPP server, if you support IM and Presence via the XMPP protocol. When done, click Save. 28

29 Bria Cloud Administrator Guide Option 2: Adding Users by Uploading a File You can upload a file containing data for each of the users you want to create; see.page 60. Step C: Notifying New Users Select the users you want to notify and click Notify. Complete the fields and click Next Click template and select the template Enter your address Note that the To is already populated with the attribute that holds the users addresses. See below for the full text of the . Click Send 29

30 CounterPath Corporation Here is the full text of the . Text in {{ }} represent CCS attributes; you already set values for these attributes in the profile. When the s are sent, the attributes will be replaced with real values. Hello You have been set up on the new Bria for CCS softphone client. You can download Bria for CCS for your mobile phone or tablet from the Google Play store or Apple App store. Search for "bria counterpath" and download the app that has the red icon. You can download Bria for CCS for your computer by following this link {{account.notification.linkfordesktopwindows}}(windows version) or {{account.notification.linkfordesktopmac}}(mac version). After installing the softphone client, start the client; the login prompt will appear. Your login information is: Username: {{ccs:username}} Password:: {{ccs:password}} Thanks, {{account.notification.administratorname}} 30

31 Bria Cloud Administrator Guide 2.3 Maintenance Supporting Upgrades of Bria for CCS Bria Desktop Whenever a new version of Bria for CCS Desktop edition is available, CounterPath puts the new version of an upgrade server. CounterPath also notifies you, the administrator. Your group is automatically set up to send down data to the softphones that instructs the softphones to regularly contact this upgrade server to find out if an upgrade is available. If an upgrade is available, a prompt appears for the user to download the new version. If the user chooses not to upgrade immediately, the user will be prompted at regular intervals to download the new version. The only decision you have to make in the upgrade process is whether you want to force your end users to upgrade: If you do want them to upgrade, change the attribute std:upgrade:mandatory to true in the profiles. In this case, when an upgrade is available, Bria Desktop shuts down. If you do not want to force them to upgrade, do nothing (the default for the attribute is false ). Bria Mobile Whenever a new version of Bria Mobile is available, CounterPath puts the new version of the relevant App Stores. CounterPath also notifies you, the administrator. You may want to notify your users that they can obtain an upgrade from the appropriate App Store Creating More Profiles You will already be set up with one or two profiles. Typically, you will not need to create more profiles. You only need to create another profile if you have one attribute for which one value applies to one group of your users and another value applies to another group. For example, you may have a network setup where users in Asia use one STUN server and users in North America use another STUN server. It would probably be a good idea to create two profiles and assign each user to the correct profile. Another way of handling multiple values is to have one profile and assign the usual value in the profile and the exception value at the user value. For example, if most of your users are in Asia, set the STUN server to the Asia server in the profile. Then for the two or three users in North America, specify the North American STUN server in the individual users. You can use the paint feature to make this change quickly; see page 157. To create a profile, see page 140. When Not to Create More Profiles Do not create different profiles for SIP users versus XMPP users. Doing so does not give you any benefit. Do not create different profiles for Desktop users versus Mobile users. Doing so does not give you any benefit. 31

32 CounterPath Corporation 2.4 Tracking Device Usage You can control the number of devices (platforms) that each user can log in from. For example, you can set the maximum to 3. In this case, each user can log into the same account from three different devices. The first time the user may log into their account from their Bria Desktop (in other words from a specific computer), the second time from their iphone (from Bria iphone Edition) and the third time from their ipad (from Bria ipad Edition). At this point, the user will have reached their maximum devices limit. If the user now tries to log in from a different (fourth) device, the login attempt will fail. Device Age. If you implement this max devices feature, you can optionally change the std:deviceagedays attribute. This attribute works as follows: if the device list is full, then the next time the user logs on, old devices (devices that have not been used in the specified number of days) will be removed from the list and the login request will succeed. Keep in mind that the device is only removed if the removal is required in order to register another device The default is 730 days. If you have users who upgrade their devices more frequently than every two years, then you may want to lower this number, otherwise the user might not be able to log in because the list is filled up with old, unused devices. In the profile, set a value in the std:maxdevices attribute. Optionally, lower the std:deviceagedays value. Do not set to 0 To set no limit for a user, enter a large number. (0 in std:maxdevices does not mean no limit it means no devices.) See page 165 for information on managing users once you have set up for device tracking. 32

33 Bria Cloud Administrator Guide 2.5 Viewing Device Debug Logs You can use the CCS to view debug logs created by the softphone clients. The user can send debug logs, which record information about activity on the Bria softphone, from their softphone client. The logs are sent to the CCS, where you can view them. You can view the log files on the Device Logs screen. See page 74. For information on the device logs, see Bria Mobile Debug Logs - Sample for Failed Call and Bria Desktop Debug Logs - Sample for Failed Call. 33

34 CounterPath Corporation 2.6 Viewing Event Logs Downloading Event Logs See page 166. Step A: Event Log Contents Each.txt file contains one or more records. Each record contains the following data: Item Example Description timestamp Date and time of the HTTP response. Format is YYMMDDHHMMSS[+-]HHMM, the +HHMM or -HHMM is the time to add/subtract to get to GMT/UTC username Username of the user sending the request url /login Path portion of the URL sent by the client. If you use different URLs for login and upgrade, this information helps identify the type of request. clienttype mob Type of softphone client: mob for Mobile desk for Desktop device iphone3%2c1 For Mobile, identifies the device model (iphone or Android) For Desktop, identifies the platform (win or mac). useragent Bria iphone User agent information built into the softphone client. address IP address of the user connecting to the CCS uuid 54ada729dbe9c6d60c e5c The UUID of the requestor s softphone. d5ede108df5 method POST HTTP method of the request: POST or GET. httpcode 200 Response code for the HTTP request itself (not for the implied provisioning request). For example, 200 httpstatus OK Response status for the HTTP request itself (not for the implied provisioning request). For example, OK. clienterror Identifies the code for a CCS internal error. tag Not currently used. template T_mobile The template that was selected by the CCS for this provisioning request traceevents Skipping password check for test See below for a complete list of event messages. access by dleblanc@acphone.com groupname acphone.com The group the user belongs to. For example: ,babbott@acphone.com,/login,mob,iPhone2%2C1,iPhone Services iphone 0.1, ,54ada729dbe9c6d60c e5cd5ede108df5,POST,200,OK,,,T_mobile,Skipping password check for test access by dleblanc@acphone.com, acphone.com 34

35 Bria Cloud Administrator Guide traceevents List Event Message Type Comment Assigned value <value> from attribute pool <attribute pool name> for user <username> Checking upgrade for user <username>, current version=<version>, desired version=<version> Info Info Could not add device <device> for user <username> Warning Login does not fail. Could not parse Mobile Login request: <Login Document> Could not replace device for user <username>, device <device> Could not search LDAP for basedn <base DN value>, filter <LDAP Filter>: <LDAP return code> - <LDAP error message> Could not update device last access for user <username>, device ID <ID> Device limit (<number>) exceeded for user <username> Info Warning Error Warning Error A random request (not from a Bria softphone client) has been received at the CCS. Login does not fail. You are set up for LDAP authentication. Login fails because the LDAP server refused the request. Login does not fail. Login fails Device not added for test access Info You are using the Test Provisioning feature, so the device is not added to the user's device list. Device not updated for test access Info You are using the Test Provisioning feature, so the device is not modified on the user's device list. Exception while matching <Discriminator> with <Discriminator pattern> Error Login fails. You may have specified a discriminator with bad formatting. Expired device not replaced for test access Info You are using the Test Provisioning feature, so the expired device (std:deviceagedays attribute) is not removed from the user's device list. Group <group name> is suspended Error Login fails Group <group name> was not found Error Login fails Group not specified in request from <username> Error Login fails IP Screening is on: User <username> not allowed from IP <IP address> LDAP authentication is on. Skipping authentication for <username> because LDAP servers are unreachable. LDAP data retrieval: Error processing user <username>: <HTTP Error Code> - <Error Message> LDAP data retrieval: Setting attribute '<attribute name>' from LDAP attribute '<attribute name>', value=<value> LDAP data retrieval: Skipping LDAP attribute <attribute name> for user <username> (too long - not a string?) Error Info Error Info Error Login fails or a remote update (refresh) causes the user to be logged off. You are set up for LDAP authentication. Login does not fail. You have set the std:ldap:ignoreerror attribute to true and all the servers are unreachable. Login does not fail. You are set up for LDAP authentication. LDAP authentication includes data retrieval but the data could not be retrieved. You are set up for LDAP authentication. Login does not fail. You are set up for LDAP authentication. LDAP authentication includes data retrieval but the data could not be retrieved. Maximum devices (<number>) is not valid Error Login fails. The max devices was probably set using the API or the CLI and a letter instead of a number was specified. No attribute pool entries for assigning value to user <username> for attribute <name> No attribute pool for assigning value to user <username> for attribute <name> Error Error Login fails Login fails 35

36 CounterPath Corporation Event Message Type Comment No LDAP response for basedn <base DN>, filter <LDAP Filter>: <LDAP return code> - <LDAP error message> Error You are set up for LDAP authentication. Login fails because the LDAP server refused the request. No unique ID for this device, rejecting Error Login fails; the login request did not include a device ID No unique ID pattern, skipping because tracking is not enabled for this device. Info Parent Group <parent group name> of <group name> is Error Login fails suspended Passwords don't match for user <username> Error Login fails Profile is not defined for user <username> Error Login fails If a desktop brand does not have tracking then the device ID is not included in the URL. The CCS detect this and assume "tracking is off". Profile templates not found for profile <profile name> Error Login fails Redirected to <URL> Info User login request has been redirected to another CCS. Replacing expired device <device> for user <username> with <device> Info The Device Age feature is being used (std:deviceagedays). A device has expired since the last login and now the user is logging in from a new device that will replace the expired device in the CCS list. Skipping LDAP service for test access by <username> Info You are set up for LDAP authentication. You are using the Test Provisioning feature, so LDAP is being skipped. Skipping password check for test access by <username> Info Template <template name> not found Error Login fails Template does not exist Error Login fails Template not found for <Profile> Error Login fails Template provisioning response could not be generated for <username> Upgrade required for <username>, version <version> User %s password could not be decrypted. Check encryption settings or contact support. Error Info Error You are using the Test Provisioning feature, so the password is not being verified. Login fails User <username> is suspended Error Login fails User <username> not found Error Login fails There is a problem with the encryption keys on your CCS. Contact CounterPath. 36

37 Bria Cloud Administrator Guide 2.7 Viewing User Traces User traces provide detailed information about a user s login attempt. The User Traces provide more detailed information than the Event Log. The traces are available from the Users screen. Downloading User Traces See page 72. User Trace Contents Each file contains information on one login or login attempt by one user. Trace files are created only for valid users, not for users in unknown groups or unknown users in known groups. For any valid user, the login attempt may be successful or it may be unsuccessful (for example, user is suspended, user enters incorrect password). The User Trace files contain more detailed information than the User Event logs. Files are accumulated for 7 days. Structure of the File Each file consists of five sections: User trace header. Shows the login ID of the user, and the date and time the user logged in or attempted to log in. Request. Shows the contents of the HTTP POST that was sent from the user's device to the CCS. This is the user's login request. Details. Shows: The user record in the CCS database. The attribute name/values for this user. The values could come from the group, the template for this user, or the user. The attributes shown include some internal data elements (ccs:xxx) that are not visible on the CCS web interface. These internal data elements may be: Set internally by the CCS. For example, ccs:username is the attribute that holds the Provisioning Username you created for the user the Edit User dialog. Or captured from the login request. For example, in the following example, ccs:clienttype shows the current login request is from Bria Desktop. Response. Shows the provisioning response sent down to this user. If the login attempt succeeded, the response is similar to the one below (which shows data for Bria Desktop). If the login attempt failed, the response is a few lines describing the reason for the failure. For a list of reasons, see page 173. Event log. The User Event Log that corresponds to this User Trace Log. See User > Logs > Event Log for this user. For more information, see page

38 CounterPath Corporation Sample -- User trace header -- Username: Date created: :12:14 -- Tue May 21 18:12:14 EDT Request ---- &Username=kperera%40acphone.com&Password=********&spid=acphone.com&uuid=1a9de6e89534a3b5ff6 d5eaeb8235fcd831845e9&build=70220&platform=windows&&username=kperera%40acphone.com&password = Details ---- CcsSsd { Method: POST Address: URL: /login Query: UserGroup: acphone.com UserName: kperera@acphone.com 38

39 Bria Cloud Administrator Guide Device: windows NextService : Template: P_Asia CcsUserRecord: CcsUserRecord { userid: username: kperera@acphone.com password: ******** suspended: false templateid: 802 metadata: } Attributes { ccs:address ccs:clienterror ccs:clienttype desk ccs:device windows ccs:groupname acphone.com ccs:httpcode 200 ccs:httpstatus OK ccs:lastprovision ccs:method POST ccs:password ******** ccs:remoteip ccs:req: ccs:req:build ccs:req:password ******** ccs:req:platform windows ccs:req:spid acphone.com ccs:req:username kperera@acphone.com ccs:req:uuid 1a9de6e89534a3b5ff6d5eaeb8235fcd831845e9 ccs:template T_desktop ccs:timestamp ccs:url /login ccs:useragent Bria 3 release RC12 stamp ccs:username kperera@acphone.com LicenseKey 1800W13DD3PD8Y8X9MP3N0226 logservername sipdomain acphone.com sippassword ******** sipusername 1331 std:logserver:enable true std:logserver:password ******** std:logserver:user emilywilding std:usertrace:enable true stunserver acphone.stun.com } } ---- Response ---- [DATA] LicenseKey=1800W13DD3PD8Y8X9MP3N0226 Success=1 [SETTINGS] proxies:proxy0:domain=acphone.com proxies:proxy0:password=******** proxies:proxy0:transport=udp proxies:proxy0:username=1331 [##MEMORY##] proxies:proxy0:enabled= ---- Event Log ,kperera@acphone.com,/login,desk,windows,Bria 3 release RC12 stamp 70220, ,POST,200,OK,,,T_desktop,acphone.com 39

40 CounterPath Corporation 2.8 Viewing CCS Reports The CCS provides various reports that show login statistics Downloading Reports See page Reports in the Device Counts Section Device Counts Provisioned Device Counts This report requires that you set up the CCS to track device usage (page 32). The columns will show - (dashes) if you have not set up to track device usage.. This report provides the following information about devices currently known to the CCS: Provisioned Group Devices: The total max devices for the group. For example, if max devices is set to 2 at the group level and there are 10 users set up on the CCS: 2 x 10 = 20 If max devices is set as above, but with user A set with an override of 3 and user B set with an override of 4: (2 x 8) + (3 x 1) + (4 x 1) = 23 A group will show zeros (0) if you have set up to track device usage but no users in the group have a number in their std:maxdevices attribute or no users exist in the group Actual Group Devices: The number of devices that have actually logged on. For example, if user A has logged on via 2 devices, B via 3 devices and C, D and E via 1 device each: = 8 A group will show zeros (0) if you have set up to track device usage but no users have logged on during the specified time period or no users exist in that group. 40

41 Bria Cloud Administrator Guide Device Counts New Activations To show this right-hand section, select your group. This report requires that you set up the CCS to track device usage (page 32). The columns will show - (dashes) if you have not set up to track device usage. This report shows the number of users who have done a first-time login during the specified time period. A group will show zeros (0) if you have set up to track device usage but no users have logged on during the specified time period or no users exist in that group. Device Counts Recent Logins This report requires that you set up the CCS to track device usage (page 32). The columns will show - (dashes) if you have not set up to track device usage. This report shows the number of users (new and existing) who have logged on during the specified time period. You can show a breakdown of information by selecting one group. A group will show zeros (0) if you have set up to track device usage but no users have logged on during the specified time period or no users exist in that group. 41

42 CounterPath Corporation Device Counts Known Devices This report requires that you set up the CCS to track device usage (page 32). The columns will show - (dashes) if you have not set up to track device usage. This report shows information about the devices that have logged in during the specified time period. A group will show zeros (0) if you have set up to track device usage but no users have logged on during the specified time period or no users exist in that group Reports in the Codec Usage Section Codec Usage Report To show this right-hand section, select your group. There are three codec usage reports available, one for each royalty-bearing codec: AMR-WB, G.729, and H.264. Each report shows information about initial activations of the codec in the specified time period. An activation is considered initial when it is the first activation for a given user/device/codec combination (in this way, repeat logins do not increase the codec count). 42

43 Bria Cloud Administrator Guide Reports in the User Activity Section User Activity User Counts This report provides information about the users currently set up in each group and subgroup. It provides information about max users, number of users, and allocated users. This report shows data only if you have created users. User Activity - Logins Shows login attempts from softphone clients, separated into HTTP and HTTPS. The attempts are a combination of local authentications (those that do not involve LDAP) and LDAP authentications. User Activity - Updates This report shows data only if you have implemented the Remote Upgrade feature (Bria Desktop only) and/or the Remote Update feature (Bria Desktop and Bria Mobile). Shows upgrade and update (setting refresh) requests, separated into HTTP and HTTPS. 43

44 CounterPath Corporation User Activity - Authentication Shows the results for local login attempts (those that do not involve LDAP). Local login attempts are processed in three steps: find the group, find the user, validate the password. Column Local authentication Local auth failures User not found Description Both successful and unsuccessful local logins. Local logins that failed because the password was incorrect. For some other reasons for failure, see the User Activity - Screened report. The user portion in the username entered by the user is wrong. For example, jsantos@acphone.com does not exist in the group acphone.com. These attempts did not get to the authentication step so they are not part of the Local authentication column. User Activity - LDAP This report shows data only if you have integrated the CCS with an LDAP server in order to have user logins authenticated by that server. Login attempts that involve LDAP are processed in as follows: send the HTTP or HTTPS request to the LDAP server (columns 1 and 2). If the LDAP server is not available and a failover server is set up, redirect the request to the alternate server (column 3). If an LDAP server is available, the password is validated and either succeeds or fails (column 4). If none of the alternates is available, the attempt is considered a failure (column 5). Successful requests may include retrieval of data from the LDAP, if the CCS has been set up for data retrieval (column 6). Each time column 3 increments, column 1 or 2 also increments. So if an HTTP request comes in and gets redirected to LDAP server B and then to LDAP server C, then column 1 shows 3 and column 3 shows 2. Column 5 increments only once for each login attempt. So if the request goes from LDAP server A to alternate B to alternate C and ultimately fails, column 5 increments only 1. Columns 4 to 6 combine HTTP and HTTPS requests. 44

45 Bria Cloud Administrator Guide Reports in the API Activity Section These reports are not available with Bria Cloud. 45

46 CounterPath Corporation 2.9 Data Entry Rules Case Sensitivity for CCS Entities The values of CCS entity names and CCS data (CCS administrator credentials and CCS user login credentials) are case sensitive. So, for example, a group named ACphone is different form one named acphone. Case Sensitivity for Provisioned Data The case of the data values within the settings is respected by the CounterPath softphone. The client that ultimately consumes the value may be case sensitive. For example, in Bria Desktop, the value of an LDAP username is provisioned down to the softphone. The Bria client does not change the case in any way but passes it on to the LDAP server. The LDAP server may or may not be sensitive to the case of the username. Naming Conventions You must specify CCS usernames (the login name) as <usernames>@<groupname> format. Usernames must not contain a colon (:). Masking of Data in the CCS Masking hides the value of data on the CCS web interface, providing some protection for sensitive data. When the attribute is set up, the administrator specifies whether an attribute is masked. In addition, the CCS web interface automatically masks the user s CCS password. Encryption Data values that are passwords for other systems are not interpreted by the CounterPath softphone, so the values can be encrypted, assuming that the consuming system knows how to decrypt it. For example, the LDAP user password and SIP password can be encrypted. The user s login password is initially entered by the user on the Bria softphone login screen and sent to the CCS in unencrypted form (but over HTTPS, which protects the data). The password is then encrypted and stored on the computer or device. Provisioned data is protected on the computer or device: In Bria Desktop, the data file (including the login credentials) is encrypted on the computer or device. In Bria Mobile, the operating system protects the data file and ensure it is accessible only to Bria Mobile. 46

47 3 Working with the CCS Web Interface 3.1 Logging on Getting Locked out If you enter your password incorrectly more than five times, you get locked out. You must ask your parent administrator to reset your password. Changing your Password You can change your own password so long as you know the current password. If you have forgotten your password, ask your parent administrator to change it. Indication of the strength of your new password. l 47

48 CounterPath Corporation 3.2 Working with Groups Viewing Group Information You can view information on the Group screens, but you cannot change anything. See page 50 The number of users you have created (page 150) Always empty. Always 0 because you do not have subgroups The state of your group: Active or Suspended Always checked. See below Click to display the Users screen or a Profile screen Always checked Always None The total number of devices that your users have so far used to log on. The attributes in the group. Out of the attributes in this list, only those that are Visible and Open appear on the Profile screen and Users screen, where you can set values. 48

49 Bria Cloud Administrator Guide Auto-manage Usernames When you create a user, you enter only the name portion. For example kperera. The domain will automatically be appended both in the display and database. 49

50 CounterPath Corporation Retrieving Event Logs from the Group Screen The Event Log shows attempts by users to log into the CCS. A new file is created every 15 minutes (although no file is created if there is no activity during a given 15-minute period). This section describes how to download the logs; for information on reading the contents, see page 68. These logs can also be downloaded from the Users screen; see page 72. Fetching Records Click On the deviice log, this is the log file reference; it is also displayed to the softphone user after they have sent the files, so it can be used to find a specific file on the CCS. On the event log, the filename starts with the CCS name. Complete the Show and Filter fields to specify the number of records to display on each page Scroll to another page Scroll through the current page Filter to restrict the records that are fetched. The filter is either a date or filename contains these characters Downloading Files to a Computer Click to download You will be prompted to save a zip file. Once the file is saved, unzip it to extract the individual files 50

51 Bria Cloud Administrator Guide Retrieving Device Logs from the Group Screen If you have set up for device log viewing (page 65), you can view device logs that your users send to you. On the Group screen, you can view the logs for all users. You can also view the logs for selected users on the Users screen; see page 67. Or you can view the logs by clicking the Device Logs button on the main toolbar. Fetching Records Click The Device Logs screen appears. See page

52 CounterPath Corporation 3.3 Working with Profiles Creating a Profile from Scratch Even if you do not need to separate your users into different profiles, you must create at least one CCS profile. When you start working withe the CCS, you are already set up with one or two baseprofiles. You may find that this one profile is all you need. Or you may decide you need more profiles. For information on making this decision, see page 31. If you do not need more profiles, skip this section and go to Managing Profiles on page 57. If you do decide you need to create more profiles, keep reading. You can create a profile from scratch. The profile will automatically contain all the attributes already in the group, but without any default values. In addition, the template mappings list will be empty. Given that creating a profile with all empty values gives you unnecessary work, we strongly recommend that you create a profile by copying the existing baseprofile instead; see page 56. Step A: Create the Profile On the Group screen, rightclick and choose New Profile Enter a name for the profile and press Enter The new profile is added to the list 52

53 Bria Cloud Administrator Guide Step B: Create Profile-Template Mappings You must create a mapping to identify the devices that the profile applies to. Every profile must contain a mapping that identifies the platforms (Desktop and Mobile) that the profile can be used with. Typically, profiles apply to both platforms, but it is possible that you have a use case for a profile that allows only one platform. Always make sure that the profile has at least one mapping, otherwise users who use this profile will never be able to log in! Click Edit Select the device Select the template to use with this device and profile Click to save 53

54 CounterPath Corporation Step C: Assign Values Can a Value Be Assigned at the Profile Level? There are visual cues that indicate whether you can assign or change a value at the profile level. Field Style Text Color Icon Meaning Value Can Be Changed in Profile? Outlined field Black The attribute is open and the displayed value was set (at some point) in this profile. Yes, just type in the field. Outlined field Outlined field No outline Empty (none) No value was set in the group. You should enter a value here or in each individual user. Gray (none) The displayed value was obtained from the group level (group-attribute) of the current group. Black The attribute value is inherited from a parent group or from the group level (groupattribute). Yes, just type in the field. Yes, just type in the field. No 54

55 Bria Cloud Administrator Guide How to Assign Values Click Edit Add or change any value Click to save 55

56 CounterPath Corporation Creating a Profile by Copying Select the source profile and click Copy Right click the group and choose Paste profile. Enter a new name The new profile appears 56

57 Bria Cloud Administrator Guide Managing Profiles Deleting a Profile Do not delete the original baseprofile profile! Select the profile and click Delete Modifying Profile-template Mappings You can modify the profile-template mapping of a template; see page 53. Modifying Attribute Values You can modify attribute values in the profile; page

58 CounterPath Corporation 3.4 Working with Users and User-Attributes The Users Toolbar See page 58 See page 62 See page 64 See page 72 See page 62 See page 60 See page 67 See page Manually Creating Users Step A: Create the User Click Complete the dialog Username: enter the user portion; the group portion (your domain) will be automatically appended Select the profile to associate with this user Indicates if the user is suspended See below for information on entering values and overriding existing values Click Save 58

59 Bria Cloud Administrator Guide Step B: Set Attribute Values Whether to assign an attribute value in the user depends on: Whether the value should be assigned at the user level (rather than at the group level or profile level). Whether a value can be assigned at the user level. When to Assign at the User Level Generally, values are assigned at the user level only when: The value is always different for each user (for example, the SIP user name). Or when a specific user must have a different value (from the profile or group) for a special reason. Can a Value Be Assigned at User Level? There are visual cues that indicate whether you can assign or change a value at the user level. Field Style Text Color Icon Meaning Value Can Be Changed in Profile? Outlined field Black The attribute is open and the displayed value was set (at some point) in this user or in the user s profile Yes, just type in the field. Outlined field Outlined field Empty (none) No value was inherited from the group. You should enter a value here or in each individual user. Gray (none) The displayed value was obtained from the group level (group-attribute) of the current group. Yes, just type in the field. Yes, just type in the field. No outline Black The attribute value is obtained from the group level (group-attribute) or inherited from a parent group. No Step C: Notify Users When you have finished adding users, you can optionally send an notification. See page

60 CounterPath Corporation Creating Users by Uploading a File Step A: Prepare the File Comma-separated-value (CSV) file. One heading row followed by one user record per row. Heading Row Defines the columns of the spreadsheet document, each column name separated by a comma. The first three entries must be username, password, and profile, in any order. These three entries are not case sensitive. The remaining entries must be the names of the attributes in the relevant group, in any order. Case sensitive: sipusername is not the same as sipusername. Attributes can be omitted if they are not included in the data being uploaded. For example: You may want to omit the LicenseKey if the CCS is automatically assigning this data from a pool. Omit attributes that are assigned values in the profile. Attributes that you want to assign values to from within the CCS. Extra attributes can be added. In other words, you can include an attribute that is not yet set up in the CCS; when you upload the file, you will be able to instruct the CCS to create an attribute from your new entry. Example: username,password,profile,_ address,sippassword,sipusername or "username","password","profile","_ address","sippassword","sipusername" User Record Format Comma-separated values corresponding to the columns in the heading row. You must put double quotes around values that contain a comma. It is a good idea to include double quotes around every value. Be careful with the case of entries. For example, the value in the profile entry is case sensitive. Other values (such as an address) may not be case sensitive. Example: "cgale","123$123","p_na","cgale@ provider.com","134ud98e!"," " User Record Content Any value except the username can be empty. For important information on handling pooled attributes, see the next page. 60

61 Bria Cloud Administrator Guide Step B: Upload the File Click Select the file Select the desired options. See below Click The uploaded users are displayed Auto-manage Usernames Checked: If the <domain> portion is missing from the user name in the file, it will automatically be added when the user is created. If the <domain> portion exists but is not correct for the group (for example, you uploading in order to move users to another group), it will be replaced with the correct domain. Unchecked: The users are loaded into the group as is. If the <domain> portion is missing from the user name in the file, it will be missing from the newly created user. The user s user name may be invalid. For more information on auto-manage, see page 101. Attribute Handling These options describe what Bria will do if an attribute is defined in the file but does not yet exist in the group: Fail if attribute not found in group: An error message will appear when you click Submit. This error indicates that you have entered an attribute that the CCS does not recognize: perhaps you mistyped an attribute name. Ignore attributes not found in group: The attribute will be skipped: it will not be created in the group. 61

62 CounterPath Corporation Managing Users Click to change the attribute values for the selected user or users; see below. Click to delete the selected user or users See page 64 To filter users, click the button and select the desired option, then enter a string in the field Click any column to sort by that column See page 66 Click to select a different attribute to display in this last column. You can only display one attribute here. All data for the currently selected user. Editing One User Select one user and click Edit; the Edit User dialog appears and you can change any information. If you clear any value defined at the user level, then either the user will obtain the value assigned to the attribute in the profile (if any) or the group (if any), or the user will not have a value for this attribute. You can suspend or unsuspend a user. You can also suspend an entire group; see page 102 See page 59 for information on entering values and overriding existing values 62

63 Bria Cloud Administrator Guide Editing Several Users by Painting You can select several users and make the same change to one or more attributes. Select several users Click Edit Check an attribute to change and enter a value Check to suspend the users; the users will not be able to log in If checked, the Notified column (for ) will be cleared for the selected users For other fields, if you check a field and then leave the field blank, you will remove the current value (if any) for each selected user When done, click Save Downloading Users to a File You can download the users in a group to a.csv file. All the users are downloaded, even if you currently have specific users selected and even if there are users not visible on the current page. Note the following in the downloaded file: Masked columns and the user s CCS password are obfuscated in the downloaded file; they will be deobfuscated when the file is uploaded back into the CCS web interface. You can manually overwrite obfuscated data. The data will appear as plain text in the file but will be masked if you upload the file back into the CCS web interface (so that the value is not readable). If you download these users again, the plain text (that you manually changed) will be obfuscated again. You cannot copy obfuscated data from one user to another user. Doing so will cause an error in the deobfuscation process. If a row contains obfuscated data, you cannot change the username. If you need to change the username, you must also overwrite the obfuscated data with plain text. 63

64 CounterPath Corporation Sending Notifications to Users Setting up for Notification Follow this step if you did not set up for notification during your initial setup (page 15). Display the Profiles screen and click Edit. Skip this attribute for now. Your name, for example Emily Wilding or CCS Administrator If you support Desktop on Mac, enter the link from the you received from CounterPath. If you support Desktop on Windows, enter the link from the . When done, click Save Sending an Select the users you want to notify and click Notify. Complete the fields and click Next Click template and select the template 64

65 Bria Cloud Administrator Guide Enter <your For example, Note that the To is already populated with the attribute that holds the users addresses. See below for the full text of the . Click Send Here is the full text of the . Text in {{ }} represents CCS attributes; you already set values for these attributes in the profile. When the s are sent, the attributes will be replaced with real values. Hello You have been set up on the new Bria for CCS softphone client. You can download Bria for CCS for your mobile phone or tablet from the Google Play store or Apple App store. Search for "bria counterpath" and download the app that has the red icon. You can download Bria for CCS for your computer by following this link {{account.notification.linkfordesktopwindows}}(windows version) or {{account.notification.linkfordesktopmac}}(mac version). After installing the softphone client, start the client; the login prompt will appear. Your login information is: Username: {{ccs:username}} Password:: {{ccs:password}} Thanks, {{account.notification.administratorname}} 65

66 CounterPath Corporation Managing Device Usage (Max Devices) Users are limited to logging in from no more than two devices. The devices can be of any kind, for example, one iphone and one computer (for Bria Desktop), or one Android smartphone and one Android tablet. If the user has reached their limit and then attempts to log in from a third device, the login attempt will fail. The user can ask you to reset their devices, for example, removing an old device that they no longer use. Resetting the Maximum Devices Open the Edit User screen for the user and click the Devices tab Click Delete. The device entry becomes grayed out Click Save. The device is removed 66

67 Bria Cloud Administrator Guide 4 CCS Tools 4.1 Testing your Provisioning Setup Once you have set up the profiles, and have created at least one user, you can validate and test the setup. The Validate tool lets you verify that your intended structure is good and everything is hooked up correctly: you don t have orphaned templates for example. The Test tool lets you verify that the individual entities used by one user (the attributes, profiles, and templates for that user) have been set up with good data. You can test your setup to determine whether the CCS generates a valid provisioning response (this is the response that is sent down to an end user in reponse to their login request). The CCS Test tool lets you verify that: The CCS is set up correctly: each profile maps to a template and the template can be used to generate a valid provisioning response. A successful provisioning response contains the information that you expect it to contain. A user can log in successfully from a given device, using the CCS password that you enter on the test dialog. Recommended Procedure 1. Create enough test users to test each platform (Desk or Mobile), profile and template at least once. Give each user a descriptive name such as test_desk_p_na or test_iphone_p_asia. 2. Run the test on each test user. 67

68 CounterPath Corporation On the Users screen, select one user and click Test Select the device type to test for Optional Typically, you leave the defaults in these fields Click to start the test 68

69 Bria Cloud Administrator Guide Sample Result: Provisioning Request Is Generated with All Data In these examples, a profile and template were successfully selected and a response was generated. Scan through the response to make sure every setting has a value. 69

70 CounterPath Corporation Sample Result: Provisioning Response Is Generated but Data Missing In these examples, a provisioning response is generated but, as you see, it is missing the username and password (the SIP username and password), meaning that this user has empty attribute values. It is possible for a setting to be missing for a specific user, for example, if the setting corresponds to a feature that is not offered to this user. Sample Result: Login Would Fail In these examples, the login attempt fails for the specified reason. Look up the error message on page 175. Also note whether the test results show that a profile and template were both selected. 70

71 Bria Cloud Administrator Guide 71

72 CounterPath Corporation 4.2 Retrieving Event Logs and User Traces There are three logs available from the Users screen: Device Logs: If you have set up for device log viewing (page 33), you can view device logs that your users send to you. Event Logs: A new file is created every 15 minutes (although no file is created if there is no activity during a given 15-minute period). User Traces: Provides information about login attempts by users. It provides more detailed information than the corresponding Event Log. This section describes how to download the logs; for information on reading the contents, see Chapter 2. Fetching Device Logs Select one or more users, then click. The Device Logs screen appears. See page 74. Fetching Event Logs and User Traces This log is viewable when no users are selected Select one or more users, then click The filename starts with the username or the CCS name. Specify the number of records to display on each page Filter to restrict the records that are fetched. The filter is either a date or filename contains these characters Scroll to another page 72

73 Bria Cloud Administrator Guide Downloading Files to a Computer Click to download You will be prompted to save a zip file. Once the file is saved, unzip it to extract the individual txt files 73

74 CounterPath Corporation 4.3 Retrieving Device Logs If you have set up for device log viewing (page 65), you can click the Device Logs button in the main toolbar to display the Device Logs screen and view device logs that your users send to you. These logs can also be retrieved from the Groups screen (page 114) or the Users screen (page 72). This section describes how to download the logs; for information on reading the contents, see page 68. To retrieve Event Logs or User Traces, see page 72. Populating the Screen Click Optionally enter some filters; see below. Click Search A list of applicable files appears Filters You can filter the list of files using any combination of several filters: Username: Enter a username to list only logs that contain this name in the file name. File name contains: Enter characters to list only logs that contain these characters in the file name. Keep in mind that the log reference (which your end user may provide to you) is part of the file name, so this is a way to find a specific log. Full text search: Enter characters to list only logs that contain these characters in the file contents. 74

75 Bria Cloud Administrator Guide Working with the List Click to save the file, if desired If you have filtered the list by Full text search, then click the "Relevance" column to sort so that files with the most instances of this string appear at the top of the list. Shows either: For an unzipped file: The content of the file. For a zipped file: The content of the first file. Click to view the entire file in a separate window: 75

76 CounterPath Corporation 4.4 Retrieving Reports This section describes how to retrieve the reports; for information on reading the contents, see page 75. Click Click to display the desired report. The report appears on the right. Working with Reports in the Device Counts and User Activity Sections Setting the Time Period With all the reports in these sections, you can specify the time period for which you want the statistics: Click Dates and choose the start date; the period will be from that date to today. Setting the Breakdown of Statistics With all the reports in these sections, you can display a breakdown of statistics by device. Click on a group; the breakdown appears on the right. Device Type: The Type of Bria softphone application. Phone, tablet, desktop. (So Bria Android Edition running on a tablet would be a phone ) Device Model: Mobile only. For example, iphone3, Galaxy Nexus, ADR6400L OS: ios/android/windows/mac/linux OS Version: The device OS version: 5.1.1/2.3.4/WIN7/LINUXUNKNOWN. Not supported on Desktop Mac. Load version: The Bria softphone release number. You can change the order of the breakdown columns (and thereby the Count) by clicking the Breakdown order button: 76

77 Bria Cloud Administrator Guide Click Click and select a category Click This example shows one breakdown for the acphone.com group: Reports You can set up to receive any report by . See page 95. Downloading You can download any report to a.csv file. Click the Download button and follow the prompts. 77