Zebra Workforce Connect: Voice Client Workforce Connect Voice Client 8.2.x Administrator Guide for Asterisk
WORKFORCE CONNECT
Voice Client 8.2.x
Administrator Guide
for Asterisk
MN-002697-07EN
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 1/2017 Initial release.
-02 Rev A 7/2017 Update to Voice Client 8.2.x.
-03 Rev A 9/2017 Update licensing information.
Add information on configuring multiple PBXs, WiFi Preferred, importing contacts.
2
Change Date Description
-04 Rev A 3/2018 Add information on TCP/UDP port usage.
-05 Rev A 5/2019 Updating features for most recent release of the client.
-06 Rev A 7/2019 Updates to custom ringtone and audio prompt file formats. Update to Home Screen
Dashboard section.
-07 Rev A 6/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
Notational Conventions ................................................................................................................... 12
Related Documents and Software .................................................................................................. 12
Service Information ......................................................................................................................... 12
Configuring the Client
Introduction ..................................................................................................................................... 13
Determine Deployment Readiness ................................................................................................. 13
Connect Android Wireless Device to Network ................................................................................ 13
Install Workforce Connect Voice Client ........................................................................................... 14
Download and Install Board Support Package (BSP) Operating System ................................. 14
Download and Install Android Application Packager (APK) Client ............................................ 14
Installing the APK Manually ................................................................................................ 14
Installing the APK Using ADB Commands .......................................................................... 14
Create a Shortcut for the Workforce Connect Voice Client ....................................................... 14
Open Workforce Connect Voice Client ........................................................................................... 15
Activate Workforce Connect Voice Client ....................................................................................... 16
Activate Using an Activation Key .............................................................................................. 16
Activate Using an MDM ............................................................................................................. 18
MDM Deployment ............................................................................................................... 18
Activate Using a USB Tether .................................................................................................... 18
Update License ......................................................................................................................... 18
Configure Workforce Connect Voice Client .................................................................................... 18
Configure Using the WFC Voice Client GUI .............................................................................. 19
Configure Using an MDM .......................................................................................................... 21
MDM Deployment ............................................................................................................... 21
Configure Using a USB Tether .................................................................................................. 21
4
Table of Contents
Configuring the PBX
Introduction ..................................................................................................................................... 22
Enable Supported Audio Codecs .............................................................................................. 22
Enable TCP As Signaling Transport Protocol ........................................................................... 23
Adding an Extension ................................................................................................................. 23
Check Device Settings .................................................................................................................... 26
Dynamic Configuration
Introduction ..................................................................................................................................... 27
Overview ................................................................................................................................... 27
General Device Use Cases ............................................................................................................. 27
Device Start-Up ............................................................................................................................... 28
Device Identification ........................................................................................................................ 28
Profile Configuration ....................................................................................................................... 29
Connection Attributes ................................................................................................................ 29
Dynamic Configuration .................................................................................................................... 30
Enabling Dynamic Configuration ............................................................................................... 30
Wcfvariable.xml File ................................................................................................................. 30
XML File Location ..................................................................................................................... 31
DHCP Option 150 ..................................................................................................................... 32
Configuration Resynchronization .................................................................................................... 32
Dynamic Configuration Start-Up - Server Side ............................................................................... 33
Dynamic Configuration Start-Up - Client Side ................................................................................. 34
XML File Examples ......................................................................................................................... 35
Testing Remote Dynamic Configuration ......................................................................................... 36
Settings
Introduction ..................................................................................................................................... 38
Exiting WFC Voice Client: ......................................................................................................... 38
Reloading WFC Voice Client: .................................................................................................... 38
Profile Settings ................................................................................................................................ 39
Create Profile ............................................................................................................................ 39
Change Profile Name ................................................................................................................ 39
Shared Profiles URI .................................................................................................................. 39
Load New Profile ....................................................................................................................... 40
Loading a New Profile Using the GUI ................................................................................. 40
Loading a New Profile Using XML ...................................................................................... 40
Installing the APK Using ADB Commands .........................
Save Current Profile .................................................................................................................. 40
Edit a Profile Using XML ........................................................................................................... 41
Connection Parameters .................................................................................................................. 42
Configuring Multiple PBX Types ............................................................................................... 43
Audio Settings ................................................................................................................................. 44
Audio Codecs Priorities ............................................................................................................. 46
Jitter Buffer ................................................................................................................................ 47
Jitter Initial Delay ................................................................................................................. 47
Jitter Buffer Max Buffer Size ............................................................................................... 47
RTP Parameters ....................................................................................................................... 48
Real-Time Transport Protocol (RTP) Parameters - Payload Size ....................................... 48
................................................. 40
5
Table of Contents
First Real-Time Transport Protocol (RTP) Port ................................................................... 48
Last Real-Time Transport Protocol (RTP) Port ................................................................... 48
Audio Enhancements ................................................................................................................ 49
Configuring Audio Enhancements ....................................................................................... 49
Input / Output Audio ............................................................................................................ 49
Audio Debugging Tools ....................................................................................................... 49
UI Settings ...................................................................................................................................... 51
Configuration File Sections ....................................................................................................... 51
Profile Section ..................................................................................................................... 51
Footer Section ..................................................................................................................... 51
Dashboard Section .............................................................................................................. 52
Call Buttons Section ............................................................................................................ 52
Headless Mode ......................................................................................................................... 52
Background Logo ...................................................................................................................... 53
Icon Library ......................................................................................................................... 53
Custom Background Configuration ..................................................................................... 53
Custom Background Configuration ..................................................................................... 53
Buttons Padding ........................................................................................................................ 53
Dialer Padding ........................................................................................................................... 54
Graphical User Interface Design Tool ....................................................................................... 54
Using the UI Settings GUI Design Tool ............................................................................... 55
Home Screen Dashboard .......................................................................................................... 57
In-Call Dashboard ..................................................................................................................... 57
Button Configuration ................................................................................................................. 58
Call ...................................................................................................................................... 58
Dial ...................................................................................................................................... 60
Start App ............................................................................................................................. 61
Log Marker .......................................................................................................................... 62
Speed Dial 0-9 .................................................................................................................... 63
Redial .................................................................................................................................. 64
Suspend Mode .................................................................................................................... 65
History ................................................................................................................................. 66
Contacts .............................................................................................................................. 67
Favorites ............................................................................................................................. 68
Voicemail ............................................................................................................................. 69
Do Not Disturb ................................................
Add Call ............................................................................................................................... 71
Home ................................................................................................................................... 72
Hold ..................................................................................................................................... 73
Resume ............................................................................................................................... 74
Transfer ............................................................................................................................... 75
Complete ............................................................................................................................. 76
End Call ............................................................................................................................... 77
List ....................................................................................................................................... 78
Blank ................................................................................................................................... 81
Reload ................................................................................................................................. 82
Sign Out .............................................................................................................................. 83
Ringtone .............................................................................................................................. 84
Icons .......................................................................................................................................... 85
Icon Library ......................................................................................................................... 85
Custom Icon Configuration .................................................................................................. 85
..................................................................... 70
6
Table of Contents
Icon Scale Type .................................................................................................................. 86
Button Color .............................................................................................................................. 88
Button Background Color .................................................................................................... 88
Button Text Color ................................................................................................................ 89
Global Button Color Settings ..................................................................................................... 90
Global Button Background Color ......................................................................................... 90
Global Button Text Color ..................................................................................................... 91
Reset Colors to Default ............................................................................................................. 92
Restore Buttons ........................................................................................................................ 92
Call Settings .................................................................................................................................... 93
Call Waiting Volume .................................................................................................................. 94
Call Waiting Interval .................................................................................................................. 95
Ringer OFF In Charger ............................................................................................................. 95
Disable Speaker mode .............................................................................................................. 95
Speaker on table ....................................................................................................................... 96
Call Accept Style ....................................................................................................................... 97
Configure the Glow Pad Buttons ......................................................................................... 98
Auto Answer Mode .................................................................................................................... 99
Incoming Call Voice Announcer ................................................................................................ 99
No Audio Cutoff ......................................................................................................................... 99
Audio Prompt File ...................................................................................................................... 99
MOH Enabled .......................................................................................................................... 100
MOH File ................................................................................................................................. 100
Ringtones ...................................................................................................................................... 101
Line Ringtones ........................................................................................................................ 101
Miscellaneous Settings ................................................................................................................. 102
Sign OUT in Charger ............................................................................................................... 102
Setting Sign OUT in Charger ............................................................................................ 102
Flexible TLS ............................................................................................................................ 102
Setting Flexible TLS .......................................................................................................... 102
WiFi Preferred ......................................................................................................................... 102
Setting WiFi Preferred ....................................................................................................... 103
Help URL ................................................................................................................................. 103
Setting Help URL .............................................................................................................. 103
Settings Password ............................................................................................................
Additional Profile URI .............................................................................................................. 104
Setting Additional Profile URI ............................................................................................ 104
Contacts URL .......................................................................................................................... 104
Setting Contacts URL ........................................................................................................ 104
Sync Contacts ......................................................................................................................... 104
Creating a Contacts List .................................................................................................... 104
Syncing Contacts .............................................................................................................. 105
...... 103
Logging
Introduction ................................................................................................................................... 106
Logging Level ................................................................................................................................ 106
Setting Logging Level ........................................................................................................ 106
Logging Types .............................................................................................................................. 107
Logging to Console ................................................................................................................. 107
Logging to File ......................................................................................................................... 107
7
Table of Contents
Logging to HTTP Post URL ..................................................................................................... 107
Log Files ....................................................................................................................................... 108
Workforce Connect Logs ......................................................................................................... 108
Fusion Logs ............................................................................................................................. 108
Collecting LogCat with RxLogger .................................................................................................. 108
Enabling RXLogger ................................................................................................................. 108
Log Marker .................................................................................................................................... 110
Adding a Log Marker ............................................................................................................... 110
Configuring Log Marker ........................................................................................................... 110
Fusion Logs .................................................................................................................................. 110
Enabling Fusion Settings In Android 6 or 7 ............................................................................. 111
Enabling Fusion Settings In Android 8 or Later ....................................................................... 111
Capturing the Logs ........................................................................................................................ 111
Headless Mode and WFCVoice Service
Introduction ................................................................................................................................... 112
Integrating WFCVoice Service Plug-in .......................................................................................... 113
Enabling Headless Mode .............................................................................................................. 113
Initiating a Call .............................................................................................................................. 113
Reporting App State ...................................................................................................................... 114
WFCDemo Android Project ........................................................................................................... 115
Using the Client
Introduction ................................................................................................................................... 118
Home Screen Dashboard ............................................................................................................. 120
In-Call Dashboard ......................................................................................................................... 120
Signal Quality ................................................................................................................................ 121
Calling ........................................................................................................................................... 121
Making a Call .......................................................................................................................... 121
Receiving a Call ...................................................................................................................... 123
Accept-Reject Buttons ....................................................................................................... 123
Sliding Tab ........................................................................................................................ 123
Glow Pad ........................................................................................................................... 123
Popup Window .................................................................................................................. 123
End Call ................................................................................................................................... 124
Add Call ................................................................................................................................... 124
Call Hold and Resume ............................................................................................................ 127
.............................................................................................................................
................................................................................................................................................ 128
Voicemail ...................................................................................................................................... 129
Message Waiting ..................................................................................................................... 129
Message Retrieval .................................................................................................................. 129
Contacts ........................................................................................................................................ 130
Favorites ....................................................................................................................................... 131
Call Log / Call History ................................................................................................................... 132
View Recent Calls ................................................................................................................... 132
Dial from Call History .............................................................................................................. 132
Delete Call History .................................................................................................................. 132
View Call History ..................................................................................................................... 132
................... 127
8
Table of Contents
Advanced Calling Features ........................................................................................................... 134
Multiple Lines .......................................................................................................................... 134
Multiple Line Appearances ................................................................................................ 134
Busy Indicator ................................................................................................................... 134
Transfer (attended, semi-attended) ......................................................................................... 135
................................................................................................................................................ 136
Miscellaneous Features ................................................................................................................ 137
Ringtone .................................................................................................................................. 137
Reload ..................................................................................................................................... 137
Sign Out .................................................................................................................................. 137
Speed Dial Numbers ............................................................................................................... 137
Do Not Disturb ......................................................................................................................... 137
Suspend Mode ........................................................................................................................ 139
List ........................................................................................................................................... 139
Home ....................................................................................................................................... 140
Adjusting the Ring Volume ...................................................................................................... 140
Unique Ringtone per Line Appearance ................................................................................... 140
Unique Ringtone per Contact .................................................................................................. 140
Distinctive Ringing ................................................................................................................... 140
Vibrate/Ring Tone ................................................................................................................... 140
Start Application ...................................................................................................................... 141
Log Marker .............................................................................................................................. 141
Adding a Log Marker ......................................................................................................... 141
Caller ID .................................................................................................................................. 141
Hold Recall .............................................................................................................................. 141
On-hook Dialing ...................................................................................................................... 141
Button Actions
XML Tags
XML Example - Profile
XML Example - Footer
XML Example - Dashboard
XML Example - Call Buttons
Configuring a Proxy Server
Configuring a Proxy Server ........................................................................................................... 169
9
Table of Contents
Network Ports and Protocols
Network Ports and Protocols ........................................................................................................ 170
10
About This Guide
Introduction
This manual describes how to install, configure and use Workforce Connect Voice Client on an Asterisk 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 the PBX.
• 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.
• 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.
11
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
• 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.
About This Guide
Related Documents and Software
The following documents provide more information about the WFC Voice Client.
• Best Practices Guide: Deploying VoWLAN Over Aruba Wireless Networks, p/n MN002151Axx
• Best Practices Guide: Deploying VoWLAN Over Cisco Wireless Networks, p/n MN001146Axx
• Best Practices Guide: Deploying VoWLAN Over WiNG5 Wireless Networks, p/n MN001150Axx
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
• 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.
12
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
.
13
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.
14
Configuring the Client
Press and hold WF Connect icon
Drag icon to the Home screen
Figure 1 Apps Screen
2. Drag the WF Connect Icon to the Home screen.
Figure 2 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.
15
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 3 Home Screen
• Touch on the WF Connect icon on the Apps screen.
Figure 4 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 169.
Activate Using an Activation Key
To activate the WFC Voice Client:
16
Configuring the Client
Toggle Button
Clear All Fields
1. Open the WFC Voice Client.
Figure 5 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 6 About Screen
5. Touch OK.
17
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 38.
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 14.
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.
18
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 7 WFC Voice Client Menu
2. Touch Settings.
Figure 8 Enter Password Screen
3. Enter the settings password. The default password is: zamboni.
4. Touch Connection Parameters.
Figure 9 Connection Parameters
19
Configuring the Client
User ID
Password
Server Address
PBX Type
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 43.
6. Touch the PBX Type field and select Asterisk.
7. Enter the User ID.
8. Enter the Password.
9. Enter the Address of the PBX server.
Figure 10 Enter Parameters
NOTE: For information on optional configuration settings, see XML Tags on page 144.
10. Touch the back button three times to return to the WFC Voice Client home screen.
Figure 11 Confirmation Message
A confirmation that the Configuration has been saved to WFConnect.xml displays.
20
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 38.
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 14.
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
21
Configuring the PBX
Introduction
This chapter describes the steps you need to take to configure the PBX.
You will perform the following steps to configure the Asterisk:
• Enable Supported Audio Codecs
• Enable TCP As Signaling Transport Protocol
• Adding an Extension
• Check the configuration of the mobile device.
Enable Supported Audio Codecs
To enable supported Audio Codecs:
1. Login to Asterisk PBX as administrator.
2. Select Settings > Asterisk SIP Settings.
IMPORTANT: Client supported Audio Codecs are G.711 u-Law, G.711 A-Law, G.722, GSM, and G.729.
22
Figure 12 Audio Codecs Screen
3. Click Submit.
Configuring the PBX
Enable TCP As Signaling Transport Protocol
To enable TCP as signaling transport protocol:
1. Go to the Command Line Interface (CLI) and enter the following:
srv# cat /etc/asterisk/sip_custom.conf
tcpenable=yes
tcpbindaddr=0.0.0.0
srv# asterisk -x "sip reload"
1. Press Enter.
Adding an Extension
To add an extension:
1. Click Device drop-down menu, select the device.
Figure 13 Select Device
23
Configuring the PBX
2. Click Submit. The Add Extension screen will appear.
3. Enter the user extension, display name and password.
Figure 14 Add Extension Screen
4. Click Submit. Additional device options appear.
5. Enable TCP or UDP as transport protocol.
24
Figure 15 Device Options Screen
Configuring the PBX
In order to register WFC with Asterisk, the admin/user needs to configure the application with the UserID and
password that has been configured at the voice gateway. Also, unless the application receives the Asterisk’s IP
address during the DHCP DORA exchange, the admin/user needs to add the voice gateway as “server address” in
the WFC Voice Settings.
25
Check Device Settings
At the device there are only 3 fields the administrator must set:
• User ID
• Password
• Server Address.
Figure 16 Device Settings
Configuring the PBX
26
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.
27
Device Start-Up
There are three stages of device life-cycle in the customer environment that affect how the WFC Voice Client
obtains the suitable runtime configuration:
• Initialized out of the box configuration (no configuration)
• A rebooted device previously configured
• A device reassigned to a new extension / user
Device Identification
The system identifies each mobile device by a unique user ID and password. The user’s credentials are mapped to
a specific feature set in the PBX. This requires that the user credentials are loaded into the WFC Voice Client XML
and passed to the PBX at registration time.
Dynamic Configuration
28
Profile Configuration
For the WFC Voice Client to connect to a PBX, the Profile section of the WFConnect.xml file must contain XML
tags which the device uses to:
• Establish a link to the PBX
• Identify itself to the PBX
• Retrieve the correct privileges and settings.
NOTE: Any element in the WFC Voice Client configuration file can be replaced with a variable.
Connection Attributes
The sip_userid and sip_userpass provide access to the PBX as shown in the following example:
<Profile>
...
<profile_type>Asterisk</profile_type>
<display>true</display>
<profname>Asterisk</profname>
<prof_password></prof_password>
<sip_userid>2808</sip_userid>
<sip_userpass>123456</sip_userpass>
<prof_description>Test-2808</prof_description>
<sip_mac></sip_mac>
<sip_remhost>10.80.212.44</sip_remhost>
...
</Profile>
Dynamic Configuration
The profile section requires:
• An IP address in the sip_remhost field to target the appropriate PBX.
• A user ID (sip_userid) and password (sip_pass) to identify the client to the PBX.
29
Dynamic Configuration
Enabling Dynamic Configuration
The var_location tag enables dynamic configuration, and reduces the entire profile section of the
WFConnect.xml file to one line.
<WFConnect>
<Profile>
<var_location>file:///wfconnect/wfcvariable.xml</var_location>
</Profile>
NOTE: File location is for demonstration purposes. The actual file location may vary.
When the WFC Voice Client initializes and parses the XML file, this tag instructs the device to retrieve the
wfcvariable.xml file from the stated location. The location can be:
• A local file on the mobile device
• Provisioned by an MDM
• Side loaded manually
Dynamic Configuration
• A URL
Wcfvariable.xml File
This file collects and organizes XML tags to populate the run-time WFConnect.xml file. Tags that are not declared
use default values. The Users tag supports and organizes multiple users. The users section is displayed as a list
on WFC Voice Client sign-in screen. When the display tag for an entry is set to true, users can select a profile from
the list.
When the display tag is set to false, the profname and prof_password tags are used. These tags are used for
user authentication when selecting a hidden profile for a dedicated user. For a shared extension, these tags are
rarely used.
Users can each be a complete and unique configuration, or they can re-use components, such as the following
buttons example.
<!-- Asterisk Users -->
<Entry>
<profile_type>Asterisk</profile_type>
<display>true</display>
<profname>Asterisk-2797</profname>
<prof_password></prof_password>
<sip_userid>2797</sip_userid>
<sip_userpass>123456</sip_userpass>
<prof_description>MC40.1</prof_description>
<sip_mac></sip_mac>
<sip_remhost>10.80.212.44</sip_remhost>
</Entry>
30
Loading...