Zebra Workforce Connect: Voice Client Workforce Connect Voice Client 8.2.x Administrator Guide for Cisco CME
WORKFORCE CONNECT
Voice Client 8.2.x
Administrator Guide
for Cisco CME
MN-001212-08EN
Copyright
ZEBRA and the stylized Zebra head are trademarks of Zebra Technologies Corporation, registered in many
jurisdictions worldwide. All other trademarks are the property of their respective owners. ©2019 Zebra
Technologies Corporation and/or its affiliates. All rights reserved.
COPYRIGHTS & TRADEMARKS: For complete copyright and trademark information, go to www.zebra.com/
copyright.
WARRANTY: For complete warranty information, go to www.zebra.com/warranty.
END USER LICENSE AGREEMENT: For complete EULA information, go to www.zebra.com/eula.
Terms of Use
• Proprietary Statement
This manual contains proprietary information of Zebra Technologies Corporation and its subsidiaries
(“Zebra Technologies”). It is intended solely for the information and use of parties operating and
maintaining the equipment described herein. Such proprietary information may not be used, reproduced,
or disclosed to any other parties for any other purpose without the express, written permission of Zebra
Technologies.
• Product Improvements
Continuous improvement of products is a policy of Zebra Technologies. All specifications and designs are
subject to change without notice.
• Liability Disclaimer
Zebra Technologies takes steps to ensure that its published Engineering specifications and manuals are
correct; however, errors do occur. Zebra Technologies reserves the right to correct any such errors and
disclaims liability resulting therefrom.
• Limitation of Liability
In no event shall Zebra Technologies or anyone else involved in the creation, production, or delivery of the
accompanying product (including hardware and software) be liable for any damages whatsoever
(including, without limitation, consequential damages including loss of business profits, business
interruption, or loss of business information) arising out of the use of, the results of use of, or inability to
use such product, even if Zebra Technologies has been advised of the possibility of such damages. Some
jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so the above
limitation or exclusion may not apply to you.
Revision History
Changes to the original guide are listed below:
Change Date Description
-01 Rev A 2/2017 Initial release.
-02 Rev A 6/2017 Update features supported in Basic CME and Premium CME.
-03 Rev A 9/2017 Update licensing information.
-04 Rev A 12/2017 Add information on configuring multiple PBXs, WiFi Preferred, importing contacts.
2
Change Date Description
-05 Rev A 3/2018 Add information on Hunt Group feature.
Add information on TCP/UDP port usage.
-06 Rev A 5/2019 Updating features for most recent release of the client.
-07 Rev A 7/2019 Updates to custom ringtone and audio prompt file formats. Update to Home Screen
Dashboard section.
-08 Rev A 5/2020 Ringtone option added to main menu. Sign out and reload are now separate options
in main menu. When selecting ringtone from SD card, option should read Custom
Ringtones.
3
Table of Contents
Copyright ........................................................................................................................................... 2
Terms of Use .................................................................................................................................... 2
Revision History ................................................................................................................................ 2
About This Guide
Introduction ..................................................................................................................................... 11
Chapter Descriptions ...................................................................................................................... 11
PBX Integration Statement ............................................................................................................. 12
Notational Conventions ................................................................................................................... 12
Related Documents and Software .................................................................................................. 12
Service Information ......................................................................................................................... 12
Configuring the PBX
Introduction ..................................................................................................................................... 14
Collect Necessary Information .................................................................................................. 14
Open the Cisco CME Command Line Interface ........................................................................ 14
Add Directory Numbers ............................................................................................................. 15
Add New Phone ........................................................................................................................ 15
Add New Phone for Basic CME .......................................................................................... 16
Add New Phone for Premium CME ..................................................................................... 16
Commit Changes ...................................................................................................................... 16
Assign Multiple Lines per Device .............................................................................................. 17
Customizing Line Labels and Caller ID ..................................................................................... 17
Customize the WFCVC Status Bar Message ............................................................................ 18
Option A: The Status Bar Reflects the Pool Description ..................................................... 18
Option B: The Status Bar Reflects the Line Label ............................................................... 19
Option C: The Status Bar Reflects the Line Number .......................................................... 19
Pushing Buttons from CME ....................................................................................................... 20
Configuring the Client
Introduction ..................................................................................................................................... 21
Determine Deployment Readiness ................................................................................................. 21
Connect Android Wireless Device to Network ................................................................................ 21
Install Workforce Connect Voice Client ........................................................................................... 22
Download and Install Board Support Package (BSP) Operating System ................................. 22
4
Table of Contents
Download and Install Android Application Packager (APK) Client ............................................ 22
Installing the APK Manually ................................................................................................ 22
Installing the APK Using ADB Commands .......................................................................... 22
Create a Shortcut for the Workforce Connect Voice Client ....................................................... 22
Open Workforce Connect Voice Client ........................................................................................... 23
Activate Workforce Connect Voice Client ....................................................................................... 24
Activate Using an Activation Key .............................................................................................. 24
Activate Using an MDM ............................................................................................................. 26
MDM Deployment ............................................................................................................... 26
Activate Using a USB Tether .................................................................................................... 26
Update License ......................................................................................................................... 26
Configure Workforce Connect Voice Client .................................................................................... 26
Configure Using the WFC Voice Client GUI .............................................................................. 27
Configure Using an MDM .......................................................................................................... 29
MDM Deployment ............................................................................................................... 29
Configure Using a USB Tether .................................................................................................. 29
Dynamic Configuration
Introduction ..................................................................................................................................... 30
Overview ................................................................................................................................... 30
General Device Use Cases ............................................................................................................. 30
Device Start-Up ............................................................................................................................... 31
Device Identification ........................................................................................................................ 31
Profile Configuration ....................................................................................................................... 32
Connection Attributes ................................................................................................................ 32
Dynamic Configuration .................................................................................................................... 33
Enabling Dynamic Configuration ............................................................................................... 33
Wcfvariable.xml File ................................................................................................................. 33
XML File Location ..................................................................................................................... 34
DHCP Option 150 ..................................................................................................................... 35
Configuration Resynchronization .................................................................................................... 35
Dynamic Configuration Start-Up - Server Side ............................................................................... 36
Dynamic Configuration Start-Up - Client Side ................................................................................. 37
XML File Examples ......................................................................................................................... 38
Testing Remote Dynamic Configuration ......................................................................................... 39
Settings
Intr
oduction ..................................................................................................................................... 41
Exiting WFC Voice Client: ......................................................................................................... 41
Reloading WFC Voice Client: .................................................................................................... 41
Profile Settings ................................................................................................................................ 42
Create Profile ............................................................................................................................ 42
Change Profile Name ................................................................................................................ 42
Shared Profiles URI .................................................................................................................. 42
Load New Profile ....................................................................................................................... 43
Loading a New Profile Using the GUI ................................................................................. 43
Loading a New Profile Using XML ...................................................................................... 43
Installing the APK Using ADB Commands .......................................................................... 43
Save Current Profile .................................................................................................................. 43
5
Table of Contents
Edit a Profile Using XML ........................................................................................................... 44
Connection Parameters .................................................................................................................. 45
Configuring Multiple PBX Types ............................................................................................... 46
Audio Settings ................................................................................................................................. 47
Audio Codecs Priorities ............................................................................................................. 49
Jitter Buffer ................................................................................................................................ 50
Jitter Initial Delay ................................................................................................................. 50
Jitter Buffer Max Buffer Size ............................................................................................... 50
RTP Parameters ....................................................................................................................... 51
Real-Time Transport Protocol (RTP) Parameters - Payload Size ....................................... 51
First Real-Time Transport Protocol (RTP) Port ................................................................... 51
Last Real-Time Transport Protocol (RTP) Port ................................................................... 51
Audio Enhancements ................................................................................................................ 52
Configuring Audio Enhancements ....................................................................................... 52
Input / Output Audio ............................................................................................................ 52
Audio Debugging Tools ....................................................................................................... 52
UI Settings ...................................................................................................................................... 54
Configuration File Sections ....................................................................................................... 54
Profile Section ..................................................................................................................... 54
Footer Section ..................................................................................................................... 54
Dashboard Section .............................................................................................................. 55
Call Buttons Section ............................................................................................................ 55
Headless Mode ......................................................................................................................... 55
Background Logo ...................................................................................................................... 56
Icon Library ......................................................................................................................... 56
Custom Background Configuration ..................................................................................... 56
Custom Background Configuration ..................................................................................... 56
Buttons Padding ........................................................................................................................ 56
Dialer Padding ........................................................................................................................... 57
Graphical User Interface Design Tool ....................................................................................... 57
Using the UI Settings GUI Design Tool ............................................................................... 58
Home Screen Dashboard .......................................................................................................... 60
In-Call Dashboard ..................................................................................................................... 60
Button Configuration ................................................................................................................. 61
Call ...................................................................................................................................... 61
Dial ......................................................................
Start App ............................................................................................................................. 64
Log Marker .......................................................................................................................... 65
Speed Dial 0-9 .................................................................................................................... 66
Redial .................................................................................................................................. 67
Suspend Mode .................................................................................................................... 68
History ................................................................................................................................. 69
Contacts .............................................................................................................................. 70
Favorites ............................................................................................................................. 71
Voicemail ............................................................................................................................. 72
Do Not Disturb ..................................................................................................................... 73
Directory .............................................................................................................................. 73
Add Call ............................................................................................................................... 75
Home ................................................................................................................................... 76
Hold ..................................................................................................................................... 77
Resume ............................................................................................................................... 78
................................................................ 63
6
Table of Contents
Transfer ............................................................................................................................... 79
Conference .......................................................................................................................... 80
Complete ............................................................................................................................. 81
End Call ............................................................................................................................... 82
List ....................................................................................................................................... 83
Blank ................................................................................................................................... 86
Reload ................................................................................................................................. 87
Sign Out .............................................................................................................................. 88
Ringtone .............................................................................................................................. 89
Icons .......................................................................................................................................... 90
Icon Library ......................................................................................................................... 90
Custom Icon Configuration .................................................................................................. 90
Icon Scale Type .................................................................................................................. 91
Button Color .............................................................................................................................. 93
Button Background Color .................................................................................................... 93
Button Text Color ................................................................................................................ 94
Global Button Color Settings ..................................................................................................... 95
Global Button Background Color ......................................................................................... 95
Global Button Text Color ..................................................................................................... 96
Reset Colors to Default ............................................................................................................. 97
Restore Buttons ........................................................................................................................ 97
Call Settings .................................................................................................................................... 98
Call Waiting Volume .................................................................................................................. 99
Call Waiting Interval ................................................................................................................ 100
Ringer OFF In Charger ........................................................................................................... 100
Disable Speaker mode ............................................................................................................ 100
Speaker on table ..................................................................................................................... 101
Call Accept Style ..................................................................................................................... 102
Configure the Glow Pad Buttons ....................................................................................... 103
Auto Answer Mode .................................................................................................................. 104
Incoming Call Voice Announcer .............................................................................................. 104
No Audio Cutoff ....................................................................................................................... 104
Audio Prompt File .................................................................................................................... 104
MOH Enabled .......................................................................................................................... 105
MOH File .................................................................................................................................
Ringtones ...................................................................................................................................... 106
Line Ringtones ........................................................................................................................ 106
Miscellaneous Settings ................................................................................................................. 107
Sign OUT in Charger ............................................................................................................... 107
Setting Sign OUT in Charger ............................................................................................ 107
Flexible TLS ............................................................................................................................ 107
Setting Flexible TLS .......................................................................................................... 107
WiFi Preferred ......................................................................................................................... 107
Setting WiFi Preferred ....................................................................................................... 108
Help URL ................................................................................................................................. 108
Setting Help URL .............................................................................................................. 108
Settings Password .................................................................................................................. 108
Additional Profile URI .............................................................................................................. 109
Setting Additional Profile URI ............................................................................................ 109
Contacts URL .......................................................................................................................... 109
Setting Contacts URL ........................................................................................................ 109
105
7
Table of Contents
Sync Contacts ......................................................................................................................... 109
Creating a Contacts List .................................................................................................... 109
Syncing Contacts .............................................................................................................. 110
Logging
Introduction ................................................................................................................................... 111
Logging Level ................................................................................................................................ 111
Setting Logging Level ........................................................................................................ 111
Logging Types .............................................................................................................................. 112
Logging to Console ................................................................................................................. 112
Logging to File ......................................................................................................................... 112
Logging to HTTP Post URL ..................................................................................................... 112
Log Files ....................................................................................................................................... 113
Workforce Connect Logs ......................................................................................................... 113
Fusion Logs ............................................................................................................................. 113
Collecting LogCat with RxLogger .................................................................................................. 113
Enabling RXLogger ................................................................................................................. 113
Log Marker .................................................................................................................................... 115
Adding a Log Marker ............................................................................................................... 115
Configuring Log Marker ........................................................................................................... 115
Fusion Logs .................................................................................................................................. 115
Enabling Fusion Settings In Android 6 or 7 ............................................................................. 116
Enabling Fusion Settings In Android 8 or Later ....................................................................... 116
Capturing the Logs ........................................................................................................................ 116
Headless Mode and WFCVoice Service
Introduction ................................................................................................................................... 117
Integrating WFCVoice Service Plug-in .......................................................................................... 118
Enabling Headless Mode .............................................................................................................. 118
Initiating a Call .............................................................................................................................. 118
Reporting App State ...................................................................................................................... 119
WFCDemo Android Project ........................................................................................................... 120
Using the Client
Introduction ................................................................................................................................... 123
Home Screen Dashboard ............................................................................................................. 125
In-Call Dashboard ......................................................................................................................... 125
Signal Quality ................................................................................................................................ 126
Calling ........................................................................................................................................... 126
Making a Call ..........................................................................................................................
Receiving a Call ...................................................................................................................... 128
Accept-Reject Buttons ....................................................................................................... 128
Sliding Tab ........................................................................................................................ 128
Glow Pad ........................................................................................................................... 128
Popup Window .................................................................................................................. 128
End Call ................................................................................................................................... 129
Add Call ................................................................................................................................... 129
Call Hold and Resume ............................................................................................................ 132
126
8
Table of Contents
Call Park and Unpark .............................................................................................................. 132
Call Park ............................................................................................................................ 133
Call Unpark ....................................................................................................................... 133
Call Park Using Feature Access Code .................................................................................... 135
Call Park Feature Access Code Retrieval ......................................................................... 136
Dashboard of Parked Calls ..................................................................................................... 137
Voicemail ...................................................................................................................................... 138
Message Waiting ..................................................................................................................... 138
Message Retrieval .................................................................................................................. 138
Contacts ........................................................................................................................................ 139
Favorites ....................................................................................................................................... 140
Call Log / Call History ................................................................................................................... 141
View Recent Calls ................................................................................................................... 141
Dial from Call History .............................................................................................................. 141
Delete Call History .................................................................................................................. 141
View Call History ..................................................................................................................... 141
Advanced Calling Features ........................................................................................................... 143
Multiple Lines .......................................................................................................................... 143
Multiple Line Appearances ................................................................................................ 143
Busy Indicator ................................................................................................................... 144
Transfer (attended, semi-attended) ......................................................................................... 145
Ad hoc Conference ................................................................................................................. 146
Call Forward ............................................................................................................................ 148
Miscellaneous Features ................................................................................................................ 152
Ringtone .................................................................................................................................. 152
Reload ..................................................................................................................................... 152
Sign Out .................................................................................................................................. 152
Speed Dial Numbers ............................................................................................................... 152
Do Not Disturb ......................................................................................................................... 152
Suspend Mode ........................................................................................................................ 154
Directory .................................................................................................................................. 154
List ........................................................................................................................................... 155
Home ....................................................................................................................................... 155
Call Pickup .............................................................................................................................. 156
Using Call Pickup .............................................................................................................. 156
Using Pickup
Adjusting the Ring Volume ...................................................................................................... 157
Unique Ringtone per Line Appearance ................................................................................... 157
Unique Ringtone per Contact .................................................................................................. 158
Distinctive Ringing ................................................................................................................... 158
Vibrate/Ring Tone ................................................................................................................... 158
Start Application ...................................................................................................................... 158
Log Marker .............................................................................................................................. 158
Adding a Log Marker ......................................................................................................... 158
Caller ID .................................................................................................................................. 158
Hold Recall .............................................................................................................................. 158
On-hook Dialing ...................................................................................................................... 159
.................................................................................................................... 156
9
Table of Contents
Button Actions
XML Tags
XML Example - Profile
XML Example - Footer
XML Example - Dashboard
XML Example - Call Buttons
Directory Button Configuration
Configuring the Directory Button ................................................................................................... 189
Using the Directory Button ............................................................................................................ 189
Configuring a Proxy Server
Configuring a Proxy Server ........................................................................................................... 190
Network Ports and Protocols
Network Ports and Protocols ........................................................................................................ 191
Hunt Groups
Introduction ................................................................................................................................... 192
Configuring the PBX ..................................................................................................................... 192
Configuring the Workforce Connect Voice Client .......................................................................... 194
Using Hunt Groups ....................................................................................................................... 195
Join Group ............................................................................................................................... 195
Unjoin Group ........................................................................................................................... 197
10
About This Guide
Introduction
This manual describes how to install, configure and use Workforce Connect Voice Client on an Cisco CME
network.
NOTE: Screens and windows pictured in this guide are samples and can differ from actual screens.
Chapter Descriptions
Topics covered in this guide are as follows:
• Configuring the Client, describes the steps you need to take prior to beginning to configure the device.
• Configuring the PBX, describes the steps you need to take to configure Cisco CME.
• Dynamic Configuration, describes the procedures to dynamically configure the WFC client using an XML
variable file.
• Settings, provides detailed information on configuring settings.
• Logging, describes the process used to capture and collect WFC Voice Client log files and Fusion log files.
• Headless Mode and WFCVoice Service, describes the procedures to configure WFC Voice client as a
background service.
• Using the Client, explains how to use the functions and features of the WFC client.
• Button Actions, includes a table listing the XML tags used to define a button action.
• XML Tags, includes a table listing all XML tags used in the Workforce Connect Voice Client configuration
file and where they are valid.
• XML Example - Profile, provides an XML example for the Profile section.
• XML Example - Footer, provides an XML example for the Footer section.
• XML Example - Dashboard, provides an XML example for the Dashboard section.
• XML Example - Call Buttons, provides an XML example for the In-Call Buttons section.
• Directory Button Configuration, describes the process used to configure the Directory button.
• Configuring a Proxy Server, explains how to configure a proxy server.
• Network Ports and Protocols, provides an overview of the ports and protocols the WFC Voice Client uses
on supported Zebra devices.
• Hunt Groups, describes how to configure the Hunt Groups feature.
11
PBX Integration Statement
Cisco CME configuration references contained within this document is based on Cisco CME version 9.1. Generally
Cisco configuration elements are maintained in subsequent releases, however cannot be guaranteed. Reader is
advised to consult Cisco CME configuration guide for releases above 9.1 and use in conjunction with this
documentation.
NOTE: Workforce Connect Voice Client requires a minimum Cisco CME version of 9.1.
Notational Conventions
The following conventions are used in this document:
• Bold text is used to highlight the following:
• Dialog box, window and screen names
• Drop-down list and list box names
• Check box and radio button names
• Icons on a screen
• Key names on a keypad
About This Guide
• Button names on a screen.
• Bullets (•) indicate:
• Action items
• Lists of alternatives
• Lists of required steps that are not necessarily sequential.
• Sequential lists (e.g., those that describe step-by-step procedures) appear as numbered lists.
Related Documents and Software
The following documents provide more information about the Workforce Connect Voice Client.
• Best Practices Guide: Deploying VoWLAN Over Aruba Wireless Networks, p/n MN002151A01
• Best Practices Guide: Deploying VoWLAN Over Cisco Wireless Networks, p/n MN001146A02
• Best Practices Guide: Deploying VoWLAN Over WiNG5 Wireless Networks, p/n MN001150A02
For the latest version of this guide and all guides, go to: www.zebra.com/support
Service Information
.
If you have a problem with your equipment, contact Zebra Global Customer Support for your region. Contact
information is available at: www.zebra.com/support
When contacting support, please have the following information available:
• Serial number of the unit
.
12
About This Guide
• Model number or product name
• Software type and version number.
Zebra responds to calls by email, telephone or fax within the time limits set forth in support agreements.
If your problem cannot be solved by Zebra Customer Support, you may need to return your equipment for servicing
and will be given specific directions. Zebra is not responsible for any damages incurred during shipment if the
approved shipping container is not used. Shipping the units improperly can possibly void the warranty.
If you purchased your Zebra business product from a Zebra business partner, contact that business partner for
support.
13
Configuring the PBX
Introduction
This chapter describes the steps you need to take to configure Cisco CME.
You will perform the following steps to configure Cisco CME:
• Verify that the CME PBX software is at version of 9.1 or above.
• Collect necessary information
• Login using your credentials
• Add new phone
• Select phone button templates
• Define customer-specific phone button template (PBT)
• Configured and label lines (up to six)
• Check the configuration of the mobile device
• Set Directory/extension number
• Set Caller ID.
Collect Necessary Information
Assemble the following information before you begin to configure the Cisco CME PBX and the mobile device:
• The type of phone that is being emulated by each mobile device.
• The radio MAC address of each mobile device.
• The extension number that is assigned to each mobile device.
Open the Cisco CME Command Line Interface
1. Open the Cisco CME command line interface by establishing one of the following connections:
• Telnet
• SSH
• Console session.
2. Login using your credentials. (You must have Admin rights to perform this action.)
3. Enter Enable Mode and issue the "config t" command.
14
Configuring the PBX
IMPORTANT: If you do not have Administrative rights, contact the Support help Desk at: 1.800.653.5350.
Add Directory Numbers
To add Directory Numbers on the CME:
Figure 1 Add Directory Number - CLI
Issue the following commands on the CLI:
config t
Enter configuration commands, one per line. End with CNTL/Z.
voice register dn 25
number 1111
Add New Phone
Figure 2 Add New Phone - CLI
15
Configuring the PBX
Add New Phone for Basic CME
Issue the following commands on the CLI:
config t
Enter configuration commands, one per line. End with CNTL/Z.
voice register pool 25
id mac AAA1.BBB1.CCC1
number 1 dn 25
username XXXX password XXXX
NOTE: Basic CME does not include advanced WFC Voice Client features. For information on features available
in Basic CME and Premium CME, see Using the Client on page 123.
Add New Phone for Premium CME
Issue the following commands on the CLI:
config t
Enter configuration commands, one per line. End with CNTL/Z.
voice register pool 25
id mac AAA1.BBB1.CCC1
type 8865
number 1 dn 25
username XXXX password XXXX
Commit Changes
To commit any DN and Pool changes on the CME:
Figure 3 Commit Changes - CLI
Issue the following commands on the CLI:
config t
Enter configuration commands, one per line. End with CNTL/Z.
(config)#voice register global
(config-register-global)#no create profile (not mandatory but recommended)
(config-register-global)#create profile
16
Configuring the PBX
Assign Multiple Lines per Device
Many features can be configured on the WFCVC by configuring them on the CME.
Assign various lines per device (up to 6 lines per device by referring to the DNs in the pool configuration using the
number X dn X command.
Figure 4 Assign Multiple Lines
Customizing Line Labels and Caller ID
Many features can be configured on the WFCVC by configuring them on the CME.
Modifying the Label and the Name in the DN configurations modifies the message next to the Line Number and the
Name that is presented to the call target when the device initiates a call from a specific line.
17
Figure 5 Line Label and Caller ID
Device A Home
Screen
Device B Incoming Call screen
when device A initiates a call from
line 1113
Configuring the PBX
Customize the WFCVC Status Bar Message
Option A: The Status Bar Reflects the Pool Description
The Status Bar message will vary according to the configuration of the Pool Description and the Line's Label.
Figure 6 Status Bar Reflects the Pool Description
18
Configuring the PBX
Option B: The Status Bar Reflects the Line Label
The Status Bar message will vary according to the configuration of the Pool Description and the Line's Label.
Figure 7 Status Bar Reflects the Line Label
Option C: The Status Bar Reflects the Line Number
The Status Bar message will vary according to the configuration of the Pool Description and the Line's Label.
Figure 8 Status Bar Reflects the Line Number
19
Configuring the PBX
Pushing Buttons from CME
In order to push buttons to the WFCVC, create a template with the desired buttons, and apply the template to the
device configuration.
Figure 9 Pushing Buttons from CME
The DHCP server provides network configuration parameters directly to DHCP clients. DHCP relay passes DHCP
requests received on one interface to an external DHCP server located behind a different interface.
Cisco IP Phones download their configuration from a TFTP server. When a Cisco IP Phone starts, if it does not
have both the IP address and TFTP server IP address preconfigured, it sends a request with option 150 to the
DHCP server to obtain this information. A maximum of two TFTP servers can be identified using option 150.
For more information on configuring the CME, review the Cisco Best Practices Guide. If you need assistance,
contact Zebra Support at: www.zebra.com/support
.
20
Configuring the Client
Introduction
This chapter describes how to install, activate and configure the Workforce Connect Voice Client (WFC Voice
Client).
Determine Deployment Readiness
Assess the suitability of your Wireless Local Area Network (WLAN) for voice traffic, using the Best Practices Guide:
Deploying VoWLAN Over Aruba Wireless Networks, Deploying VoWLAN Over Cisco Wireless Networks or
Deploying VoWLAN Over WiNG5 Wireless Networks.
.
WARNING: If your WLAN is not suitable for voice traffic, WFC Voice Client will perform on a best effort basis.
Contact the Zebra Software Support Desk for more information: www.zebra.com/support.
Connect Android Wireless Device to Network
Zebra WFC Voice Client for Android includes support for the following device types:
• Enterprise Mobile devices
• Consumer Smartphone devices (evaluation only).
Connect the Android wireless device to the network. See device instructions for more information. If you need
assistance, contact the Zebra Support at: www.zebra.com/support
.
21
Configuring the Client
Install Workforce Connect Voice Client
There are two ways to install the WFC Voice Client:
• USB tether or web server - This section describes using a USB tether or web server to install the WFC
Voice Client APK manually or using ADB commands.
• Mobile Device Manager (MDM) - For information on installing the WFC Voice Client APK using an MDM,
refer to the Workforce Connect Voice Client Configuration Guide for Mobile Device Managers.
Download and Install Board Support Package (BSP) Operating System
For instructions please refer to www.zebra.com/support and login using your partner login for latest BSP and
integration instructions. If you need assistance, contact Zebra Support at: www.zebra.com/support
Download and Install Android Application Packager (APK) Client
1. From a web browser, go to the Zebra Licensing End User Portal.
To access the Zebra Licensing End User Portal, follow the instructions in the Software Entitlement email from
Zebra. Portal access requires registration at Zebra.com and authorization as a portal user by Zebra Support.
2. From the Zebra Licensing End User Portal, download the latest WFC Voice APK file.
.
Installing the APK Manually
To install the APK manually:
1. Save the APK file to the root directory of the target device using one of the following methods:
• USB tether
• Web server download (if your network supports this option).
2. On the Android device, go to the Apps list and open the file browser.
3. Navigate to the APK file.
4. Run and install the APK file.
5. Check that the WFC Voice Client is available in the Apps Screen.
The WF Connect icon should be visible in the list of available applications.
Installing the APK Using ADB Commands
To install the APK using an Android Debug Bridge (ADB) connection, open a command prompt and send the
following ADB commands to the device:
adb install –g <apk_file_name>
adb shell dumpsys deviceidle whitelist +com.symbol.wfc.voice
adb shell appops set com.symbol.wfc.voice SYSTEM_ALERT_WINDOW allow
Where
<apk_file_name> is the name of the WFC Voice APK file.
Create a Shortcut for the Workforce Connect Voice Client
To create a shortcut:
1. In the Apps Screen, press and hold on the WF Connect icon.
22
Configuring the Client
Press and hold WF Connect icon
Drag icon to the Home screen
Figure 10 Apps Screen
2. Drag the WF Connect Icon to the Home screen.
Figure 11 Home Screen
3. Drop icon on Home screen.
Open Workforce Connect Voice Client
To open the WFC Voice Client, use one of the following methods:
• Touch the WF Connect icon on the Home screen.
23
Configuring the Client
Touch on the WF Connect icon on
the Android Home Screen.
Touch on the WF Connect icon on
the Android Apps Screen.
Figure 12 Home Screen
• Touch on the WF Connect icon on the Apps screen.
Figure 13 App Screen
The App Activation screen displays.
Activate Workforce Connect Voice Client
When the WFC Voice Client starts for the first time, the App Activation screen appears. A valid license is required
for each PBX. The WFC Voice Client is activated by using an activation key, Mobile Device Manager (MDM), or
USB tether.
NOTE: When activating a device that does not have direct access to the license source, use a proxy server. See
Configuring a Proxy Server on page 190.
Activate Using an Activation Key
To activate the WFC Voice Client:
24
Configuring the Client
Toggle Button
Clear All Fields
1. Open the WFC Voice Client.
Figure 14 App Activation Screen
2. Use one of the following activation methods:
• Keys or features - Acquires licenses from the default licensing source.
In the keys or features field, enter your activation code(s) separated by commas.
NOTE: The WFC Voice Client version 8.2.729 requires a license source URL when activating using an activation
key. Refer to the Workforce Connect Voice Client 8.2.x Administration Guide for Licensing.
3. To enter a device alias, touch the toggle button and, in the device alias field, enter a name to identify the
device on the license source.
4. Touch Register App.
The About screen appears, displaying currently licensed keys and features.
Figure 15 About Screen
5. Touch OK.
25
Configuring the Client
Activate Using an MDM
Configuring the WFC Voice Client using an MDM requires a deployment package and the WFC Voice Client
configuration file. The configuration file
including licensing information, as key and value pairs. For detailed information on the XML configuration file, see
Settings on page 41.
Define the licensing information using the following XML tags:
• license_key - Contains one or more WFC Voice Client activation keys separated by commas.
Example:
<license_key>abcd‐1234‐ab12‐cd34‐5678‐efgh‐ef56‐gh78</license_key>
• license_source - The URL of a license source.
• WFC Voice Client version 8.2.729 - Enter the following URL:
https://zebra-licensing.flexnetoperations.com/flexnet/deviceservices.
• WFC Voice Client version 8.2.730 or later - Leave this field blank.
• license_alias - Identifies the device on the license source. (Optional)
MDM Deployment
During runtime, WFC Voice Client listens for wfc.voice.ACTION_UPDATE_CONFIG intent. When the WFC Voice
Client receives the intent from an MDM, the configuration file uses
configuration parameters. Use a single intent to update multiple configuration parameters by including multiple
element and value pairs.
WFConnect.xmlstores all WFC Voice client configuration parameters,
WFConnect.xml to update the WFC Voice Client
For detailed information on MDM deployment, refer to the Workforce Connect Voice Client 8.x Configuration Guide
for Mobile Device Managers.
Activate Using a USB Tether
Send theWFConnect.xmlconfiguration file to the device using a USB tether, use an Android Debug Bridge (ADB)
connection.
NOTE: It is not recommended to install the WFConnect.xml file using a USB tether because it can cause
permission issues on the device.
1. Install the WFC Voice Client APK. See Download and Install Android Application Packager (APK) Client on
page 22.
2. Copy the WFConnect.xml file in the /sdcard/WFConnect directory.
3. Open a command prompt and send the following adb command to the device:
adb shell am start -a "wfc.voice.ACTION_NEW_CONFIG" --es "profile_uri"
"/WFConnect/WFConnect.xml"
Update License
To update all WFC Voice Client licenses, refer to the Workforce Connect Voice Client 8.2.x Administration Guide
for Licensing.
Configure Workforce Connect Voice Client
The WFC Voice Client is configured using the Graphical User Interface (GUI), an MDM, or a USB Tether.
26
Configuring the Client
Enter Settings password.
NOTE: It is not recommended to install the WFConnect.xml file using a USB tether because it can cause
permission issues on the device.
Configure Using the WFC Voice Client GUI
To configure the WFC Voice Client:
1. Touch the menu button.
Figure 16 WFC Voice Client Menu
2. Touch Settings.
Figure 17 Enter Password Screen
3. Enter the settings password. The default password is: zamboni.
4. Touch Connection Parameters.
Figure 18 Connection Parameters
27
Configuring the Client
MAC Address
Server Address
PBX Type
SIP ID
5. Select a PBX configuration. The default configuration is: PBX#1 Configuration.
For information on configuring additional PBX types, see Configuring Multiple PBX Types on page 46.
6. Touch the PBX Type field and select Basic CME or Premium CME.
7. Enter SIP ID (Basic CME only).
8. Enter the MAC Address. See Device Identification on page 31 for more information on MAC addresses.
9. Enter the Address of the PBX server.
Figure 19 Enter Parameters
NOTE: For information on optional configuration settings, see XML Tags on page 163.
10. Touch the back button three times to return to the WFC Voice Client home screen.
Figure 20 Confirmation Message
A confirmation that the Configuration has been saved to WFConnect.xml displays.
28
Configuring the Client
Configure Using an MDM
Configuring the WFC Voice Client using an MDM requires a deployment package and the WFC Voice Client
configuration file. The configuration file
including licensing information, as key and value pairs. For detailed information on the XML configuration file, see
Settings on page 41.
Define the licensing information using the following XML tags:
• license_key - Contains one or more WFC Voice Client activation keys separated by commas.
Example:
<license_key>abcd‐1234‐ab12‐cd34‐5678‐efgh‐ef56‐gh78</license_key>
• license_source - The URL of a license source.
• WFC Voice Client version 8.2.729 - Enter the following URL:
https://zebra-licensing.flexnetoperations.com/flexnet/deviceservices.
• WFC Voice Client version 8.2.730 or later - Leave this field blank.
• license_alias - Identifies the device on the license source. (Optional)
MDM Deployment
During runtime, WFC Voice Client listens for wfc.voice.ACTION_UPDATE_CONFIG intent. When the WFC Voice
Client receives the intent from an MDM, the configuration file uses
configuration parameters. Use a single intent to update multiple configuration parameters by including multiple
element and value pairs.
WFConnect.xmlstores all WFC Voice client configuration parameters,
WFConnect.xml to update the WFC Voice Client
For detailed information on MDM deployment, refer to the Workforce Connect Voice Client 8.x Configuration Guide
for Mobile Device Managers.
Configure Using a USB Tether
To send theWFConnect.xmlconfiguration file to the device using a USB tether, use an Android Debug Bridge
(ADB) connection.
NOTE: It is not recommended to install the WFConnect.xml file using a USB tether because it can cause
permission issues on the device.
1. Install the WFC Voice Client APK. See Download and Install Android Application Packager (APK) Client on
page 22.
2. Copy the WFConnect.xml file to the WFConnect directory.
3. Open a command prompt and send the following ADB command to the device:
adb shell am start -a "wfc.voice.ACTION_NEW_CONFIG" --es "profile_uri"
"/WFConnect/WFConnect.xml"
To update a specific parameter in the
send an ADB command to the device in the following format:
$ adb shell am start -a wfc.voice.ACTION_UPDATE_CONFIG --es element value
For a list of possible elements and values, see XML Tags.
WFConnect.xml configuration file using ADB, open a command prompt and
29
Dynamic Configuration
Introduction
The WFC Voice Client configuration file defines the operational environment of the SIP client running on Zebra
mobile android devices. It has various elements that define the network location of the PBX and, for each device,
unique defining operational aspects affecting the user experience. Creating this file manually and distributing this
file for each device on an enterprise-wide scale introduces significant administrative overhead.
Dynamic configuration:
• Reduces the administrative effort preparing the WFC Voice Client for enterprise operation
• Provides a flexible delivery environment for the customized configuration
• Provides a method for shared device use without manually reloading the configuration
• Provides backward compatibility for existing customers.
Rather than manually creating a unique configuration for each device, this approach dynamically configures the
WFC Voice Client using an XML variable file. File delivery can be manual, by an MDM, or automatic through
existing network services.
Overview
The chapter includes:
• Providing a new XML tag that triggers dynamic configuration
• Building a multi-user variable file to build user specific configurations for the WFC Voice Client
• Re-synchronizing the WFC Voice Client with the variable file on a regular basis
• Using DHCP resources to provide auto installation for the file.
Properly configuring these elements allows the WFC Voice Client to register to the PBX.
General Device Use Cases
• A unique user is typically a supervisor or manager with a device with a more advanced feature set that is
not shared with any other user. This extension may be shared with that person’s desk phone.
• A shared device is typically for line workers or department staff that use a phone representing a functional
area, as opposed to a specific person. The device has a basic feature and may also be uniform, sharing
common elements (e.g.; button configurations) across all shared devices.
30
Loading...