Stretto admin guide

82 Pages·2015·1.5 MB·English

Cloud Solutions Administrator Guide
- eStore
CounterPath Corporation
CounterPath Corporation
Suite 300, One Bentall Centre
505 Burrard Street, Box 95
Vancouver, BC V7X 1M3
Tel: [phone]
[email protected] www.counterpath.com
© March 2015 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 Stretto (Stretto). 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, the logo, and Bria are trademarks of CounterPath Corporation.
Stretto Platform and Stretto are trademarks of CounterPath Corporation.
All other products and services are the registered trademarks of their respective holders.
This manual corresponds to version 1.6.3 of Stretto Platform.
R2
2
Contents
1 Overview.................................................................................................................................7
1.1 The Softphone Clients...................................................................................................7
1.2 The Attributes Lists.......................................................................................................8
1.3 The Stretto Platform.......................................................................................................9
1.4 How Provisioning Works...............................................................................................11
1.4.1 What Happens on Stretto......................................................................................12
1.4.2 Remote Refresh.....................................................................................................13
2 Recommended Procedures......................................................................................................15
2.1 Initial Setup....................................................................................................................15
2.1.1 Set up for Bria Mobile Only.................................................................................16
2.1.2 Set up for Bria Desktop Only...............................................................................20
2.1.3 Set up for Bria Mobile and Bria Desktop.............................................................23
2.2 Setting up More Users...................................................................................................28
2.3 Maintenance...................................................................................................................31
2.3.1 Supporting Upgrades of Bria Stretto Clients........................................................31
2.3.2 Creating More Profiles..........................................................................................31
2.4 Tracking Device Usage..................................................................................................32
2.5 Viewing Device Logs....................................................................................................33
2.6 Viewing Event Logs......................................................................................................34
2.7 Viewing User Traces .....................................................................................................37
2.8 Viewing Stretto Reports.................................................................................................40
2.8.1 Downloading Reports...........................................................................................40
2.8.2 Reports in the Device Counts Section..................................................................40
2.8.3 Reports in the Codec Usage Section.....................................................................43
2.8.4 Reports in the User Activity Section....................................................................44
2.8.5 Reports in the API Activity Section.....................................................................46
2.9 Data Entry Rules............................................................................................................47
3 Working with the Stretto Admin Web Interface.....................................................................48
3.1 Logging on.....................................................................................................................48
3.2 Working with Groups....................................................................................................49
3.2.1 Viewing Group Information.................................................................................49
3.2.2 Retrieving Event Logs from the Group Screen....................................................51
3.2.3 Retrieving Device Logs from the Group Screen..................................................52
3.3 Working with Profiles....................................................................................................54
3.3.1 Creating a Profile from Scratch............................................................................54
3.3.2 Creating a Profile by Copying..............................................................................58
3.3.3 Managing Profiles.................................................................................................59
3.4 Working with Users and User-Attributes......................................................................60
3.4.1 The Users Toolbar................................................................................................60
3.4.2 Manually Creating Users......................................................................................60
3.4.3 Creating Users by Uploading a File......................................................................62
3.4.4 Managing Users....................................................................................................64
3.4.5 Sending Email Notifications to Users...................................................................67
3.4.6 Managing Device Usage (Max Devices)..............................................................69
3.5 Stretto Tools...................................................................................................................70
3.5.1 Testing your Provisioning Setup...........................................................................70
3
CounterPath Corporation
3.5.2 Retrieving Event Logs and User Traces...............................................................75
3.5.3 Retrieving Device Logs........................................................................................77
3.5.4 Retrieving Provisioning Reports...........................................................................79
A Login Error Messages............................................................................................................81
4
About this Manual
This manual describes how to use CounterPath’s Stretto Admin web interface to configure the “Bria Stretto”
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 Cloud Solutions service
from the CounterPath Store and are deploying the Bria Stretto line of softphones to their employees.
This manual applies to provisioning of the Bria Stretto line of softphones, specifically:
• Bria Stretto Desktop (for Windows or for Mac)
• Bria Stretto for iPhone
• Bria Stretto for iPad
• Bria Stretto for Android
• Bria Stretto for Tablet
• Bria Stretto for BlackBerry
• Bria Virtualized Edition
Usage of the Stretto Admin web interface and specific softphone clients is governed by the terms of service you
agreed to when signing up for the Cloud Solutions service.
Related Manuals
To obtain the following documentation, go to counterpath.com and log into Customer Subscription Portal; go to
Cloud Subscription Summary > Help Resources.
• Attributes lists: “Attributes for Bria Desktop” and “Attributes for Bria Mobile”.
• Device logs sample: the documents that describe the contents of the device logs (page33).
Supported Browsers
• Most browsers that are newer than two years old will support all the features of the Stretto Admin web
interface. Supported browsers include Firefox®, Chrome™, Safari™, Opera™.
• Internet Explorer® 11 or newer is supported. The older versions of Internet Explorer support most features
but will not show values in the profile or user that are “inherited”.
5
CounterPath Corporation
6
1 Overview
Provisioning the softphone clients involves three components:
• The softphone clients themselves.
• The Attributes lists, which provide 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 Stretto Platform, which is a server hosted by CounterPath. You will work with Stretto via the Stretto
Admin web interface, which runs in a web browser.
1.1 The Softphone Clients
Obtaining the Clients
The softphone clients can be downloaded from Customer Subscription Portal. Go to Cloud Subscription
Summary > Client Downloads.
System Requirements
For information on the latest system requirements for the softphones, see the Requirements tab on the following
pages:
• http://www.counterpath.com/bria.html
• http://www.counterpath.com/bria-virtualized-edition/
• http://www.counterpath.com/bria-iphone-edition.html
• http://www.counterpath.com/bria-android-edition.html
• http://www.counterpath.com/bria-blackberry-edition/
• http://www.counterpath.com/bria-ipad-edition.html
• http://www.counterpath.com/bria-android-tablet-edition.html
7
CounterPath Corporation
1.2 The Attributes Lists
Obtain the Attributes lists from Customer Subscription Portal. 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> Relates to the email notification feature of
Stretto, described on page160.
account1Sip.credentials.<na Attributes for the SIP account credentials. Required
me>: Typically these attributes are different for each
user (except for the attribute for the domain).
account2Xmpp.credentials.< Attributes for the XMPP account credentials. Required only if you create XMPP accounts.
name> Typically these attributes are different for each
user (except for the attribute for the domain).
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 all- softphone client works as desired in your
important firewall traversal attributes. network.
mob.<name> Attributes for Bria Mobile. Applicable only if you are deploying Bria
Mobile.
mob.account2Xmpp.<name> XMPP network settings. Applicable only if you create an XMPP account
and are deploying Bria Mobile.
The defaults are probably acceptable.
mob.codecs.<name> Attributes to enable codecs on Bria Mobile. The defaults are probably acceptable.
There are four separate sets of codecs: audio Wi-
Fi, audio mobile network, and video Wi-Fi, and
video mobile network.
mob.dialplan.<name> Attributes to create a dial plan. There are two Ignore if you do not want to set up client-side
sets of attributes, to create two dial plans. 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 all- softphone client works as desired in your
important firewall traversal attributes. network.
8
Cloud Solutions Administrator Guide - eStore
1.3 The Stretto Platform
You will work with Stretto via the Stretto Admin web interface, which runs in a web browser. There are two
main screens on the Stretto Admin web interface: the Users screen and the Profiles screen.
To access Stretto, go to Customer Subscription Portal, and click Cloud Subscription Summary > Manage Users.
Your Stretto Setup
You will be set up with a group on Stretto 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, Android Tablet, and
BlackBerry.
• 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
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.
You will review these attributes and change some values, in order to configure the softphone clients for your
network.
10