1. Workcloud Communication Voice Client 9.x Administrator Guide for Cisco CUCM
  2. XML Tags
  • Workcloud Communication Voice Client 9.x
XML Tags
View content for :
Platform:

XML Tags

This section lists the XML tags allowed in the
WFConnect.xml
 file.
WFConnect Tags
Element
Description
Call Buttons
Defines the buttons available in the in-call area.
Dashboard
Dashboard section.
Profile
Profile section.
Profile Tags
Element
Description
Value
audio_gain_in
Input Audio Volume (Optional).
An integer between 1 and 8.
Default: 1
audio_gain_out
Output Audio Volume (Optional).
An integer between 1 and 8
Default: 1
background_logo
Set a background image for the Zebra Voice home screen dashboard (Optional).
Default: None (Disabled)
callwaiting_interval
An interval of call waiting tone.
500ms to 8000ms
Default: 2000ms
callwaiting_volume
Call waiting volume.
Percentage between 10% and 100%
Default: 80%
clearRecentCall
Clears the call history on sign-out.
True: clear the recent call history on sign-out.
False: retain the recent call history on sign-out.
Default: False
codec_alaw_priority
Assigns preference priority for G.711 A-Law Voice codec negotiations between PBX and Zebra Voice.
An integer between 1 and 8
Negative numbers disable the codec.
Default: 3
show_call_quality_feedback
Enables or disables the call feedback analytics feature.
True: Enable Call Rating feedback screen.
False: Disable Call Rating feedback screen.
Default: False
enableGA
Enables data collection.
0: Disable data collection.
1: Enable data collection.
Default:1
codec_g722_priority
Assigns preference priority for G.722 Voice codec negotiations between PBX and Zebra Voice.
An integer between 1 and 8
Negative numbers disable the codec.
Default: 4
codec_g729_priority
Assigns preference priority for G.729 Voice codec negotiations between PBX and Zebra Voice.
An integer between 1 and 8
Negative numbers disable the codec.
Default: 5
codec_gsm_priority
Assigns preference priority for GSM Voice codec negotiations between PBX and Zebra Voice.
An integer between 1 and 8
Negative numbers disable the codec.
Default: 6
codec_ulaw_priority
Assigns preference priority for G.711 u-LAW Voice codec negotiations between PBX and Zebra Voice.
An integer between 1 and 8
Negative numbers disable the codec.
Default: 2
contacts_url
The URL of the contacts list is located on a remote or local server (Optional).
File type: CSV.
Protocols: file, http, https, tftp.
Default: none
edit_voice_contact
Enables to edit the Voice Contact list.
True: Enable the Voice Contact Editing feature.
False: Disable the Voice Contact Editing feature.
Default: False
codec_opus_priority
Assigns preference priority for OPUS Voice codec negotiations between PBX and Zebra Voice.
An integer between 1 and 8
Negative numbers disable the codec.
Default:1
codec_l16_priority
Assigns preference priority for L16 codec negotiations between PBX and Zebra Voice.
An integer between 1 and 8
Negative numbers disable the codec.
Default: 7
codec_l16_32_priority
Assigns preference priority for L16_32 codec negotiations between PBX and Zebra Voice.
An integer between 1 and 8
Negative numbers disable the codec.
Default: 8
codec_l16_32_priority
if administrator provides 0 for any codec type, a random priority is assigned to that codec.
change_button_behave_as_reload
The RELOAD/CHANGE button functions as the Reload button that is present under the Hamburger menu.
True: Functions as a Reload button present in the Humberger menu.
False: Functions as Reload/Change button as earlier.
Default: False
default_screen
Change the default landing screen of the Zebra Voice Client,
Fragment Value:
0: Dashboard (default value)
1: Dialpad
2: Recent
3:Contact
disable_menu_sign _out
Disable the sign-out option in the three-line menu (Optional).
True: Disable the sign-out option.
False: Enable the sign-out option.
Default: False
disable_speaker
Do not answer incoming calls in speaker mode when the device is placed on a horizontal surface (Optional).
True: Disable speaker mode.
False: Enable speaker mode.
Default: False
gbg_color
Background color used on all buttons, if not customized in the button element <bg_color> (Optional).
The color is one of the following: red, blue, green, black, white, gray, cyan, magenta, yellow, lightgray, darkgray, grey, lightgrey, darkgrey, aqua, fuchsia, lime, maroon, navy, olive, purple, silver, teal, or, it is an RGB value in one of the following formats expressed as a decimal, or a hexadecimal, number:
  • #RRGGBB
  • #AARRGGBB
Default: 0xFF001425
gfg_color
The text color used on all buttons, if not customized in the button element <fg_color> (Optional).
The color is one of the following: red, blue, green, black, white, gray, cyan, magenta, yellow, lightgray, darkgray, grey, lightgrey, darkgrey, aqua, fuchsia, lime, maroon, navy, olive, purple, silver, teal, or, it is an RGB value in one of the following formats expressed as a decimal, or a hexadecimal, number:
  • #RRGGBB
  • #AARRGGBB
  • Default: 0xFFFFFFFF
headless_mode
Headless mode (Optional).
True: Headless mode enabled.
False: Headless mode disabled.
Default: False
help_url
The URL of the entry point for the on-device online help (Optional).
Default:
file:///WFConnect/help.html
incall_widget
Call accept style on the incoming call screen (Optional).
Select one of the following:
  • incall_buttons: Simple buttons.
  • incall_gb: Slider.
  • incall_jb: Glow pad.
  • Default: incall_gb
inCallFooterOrder
Arrange the position of In-Call buttons: Bluetooth, Dialpad, Mute, and Speaker.
The following icons are assigned a specific value, and the value can be arranged  in any order:
  • 0: Dialpad
  • 1: Bluetooth
  • 2: Speaker
  • 3: Mic
jitter_max
Maximum jitter buffer in milliseconds.
250 msec to 1500 msec
Default: 250 msec
jitter_min
Initial jitter delay in milliseconds.
30 msec to 100 msec
Default: 60 msec
layout_location
The URL of the buttons layout file (Optional).
Protocols: file, http, https, tftp.
Default: none
license_alias
Identify the device on the license source. (Optional)
Device alias.
license_key
One or more Zebra Voice activation keys. When using the license_source element, license_key can be used to list one or more PBX types.
Comma-separated list of:
  • Activation keys
  • PBX types.
license_source
The URL of a licensed source running on the cloud or a local network. Use the license_key element to define PBX types. If the license_key value is not set, the client requests the PBX type set in the Zebra Voice profile.
Default: Flexera server
log_file
Enables logging for Zebra Voice (Optional).Log files are saved to the WFConnect folder on the device.
True: Logging enabled.
False: Logging disabled.
Default: False
log_level
The log level for all log messages produced by Workcloud Communication (Optional).
Select one of the following:
  • Error
  • Warning
  • Info
  • Debug
  • Verbose
For debugging, use Verbose. Default: Error
log_sipclf
Enable SIP message logging. Logs are stored on the device as a CLF file in SIP Common Log Format (Optional).
True: Log in to a file on the device.
False: Do not log in to the file.
Default: False
moh_enabled
Enable music on hold to play a WAV audio file when a user is placed on hold (optional).
Default: False
moh_file
Select a custom WAV audio file to play when a user is placed on hold (optional).
WAV file stored in the WFConnect folder
Default: None
no_audio_cutoff
Disconnect a call when no audio is detected for a set interval.
Select one of the following:
  • 0
  • 30
  • 60
  • 120
  • 300
  • Default: 30
process_cell_call
Ignore all call requests from the Android dialer. Required on the device with call service.
True: Process Android calls
False: Do not process Android calls
Default: False
profile_type
Primary PBX type.
Contents: Text
Default: None
profile2_type
Second PBX type (Optional).
Contents: Text
Default: None
profile3_type
Third PBX type (Optional).
Contents: Text
Default: None
profile4_type
Fourth PBX type (Optional).
Contents: Text
Default: None
profname
Profile name (Optional).For information only.
Contents: Text
Default: None
prompt_file
Name of the audio prompt file. (Optional).
WAV file stored in the WFConnect folder
Default: None
ringer_off_in_charger
Disable the ringer while the device is charging.
true: Disable the ringer while charging
False: Enable ringer while charging
Default: False
ringtone_callback
Call back ringtone (Optional).
One of the following:
  • The name of Android Ringtone.
  • The name of an audio file stored in the WFConnect folder.
Default: UK_Phone
ringtone_external
Ringtone for external calls (Optional).
One of the following:
  • The name of Android Ringtone.
  • The name of an audio file stored in the WFConnect folder.
  • Default: HI_UK_Phone
ringtone_intercom
Ringtone for intercom calls (Optional).
One of the following:
  • The name of Android Ringtone.
  • The name of an audio file stored in the WFConnect folder.
Default: French_Phone
ringtone_line1
The ringtone for line #1 (Optional).
One of the following:
  • The name of Android Ringtone.
  • The name of an audio file stored in the WFConnect folder.
Default: Empty (The default Android ringtone is used.)
ringtone_line2
The ringtone for line #2 (Optional).
One of the following:
  • The name of Android Ringtone.
  • The name of an audio file stored in the WFConnect folder.
Default: Empty (The default Android ringtone is used.)
ringtone_line3
The ringtone for line #3 (Optional).
One of the following:
  • The name of Android Ringtone.
  • The name of an audio file stored in the WFConnect folder.
Default: Empty (The default Android ringtone is used.)
ringtone_line4
The ringtone for line #4 (Optional).
One of the following:
  • The name of Android Ringtone.
  • The name of an audio file stored in the WFConnect folder.
Default: Empty (The default Android ringtone is used.)
ringtone_line5
The ringtone for line #5 (Optional).
One of the following:
  • The name of Android Ringtone.
  • The name of an audio file stored in the WFConnect folder.
Default: Empty (The default Android ringtone is used.)
ringtone_line6
The ringtone for line #6 (Optional).
One of the following:
  • The name of Android Ringtone.
  • The name of an audio file stored in the WFConnect folder.
Default: Empty (The default Android ringtone is used.)
ringtone_park
The ringtone for the parking (Optional).
One of the following:
  • The name of Android Ringtone.
  • The name of an audio file is stored in the WFConnect folder.
Default: Empty (The default Android ringtone is used.)
rtp_stats
Show Real-Time Transport Protocol (RTP) Statistics on the in-call screen (Optional).
True: RTP statistics are shown.
False: RTP statistics are not shown.
Default: False
sample_rate
Audio sample rate. Selecting an audio codec overrides this setting (Optional).
Select one of the following:
  • 8000
  • 16000
  • 32000
  • 48000
Default: 8000
show_department_name
Display the department name associated with an extension (Optional).
True: Department names are shown.
False: Department names are not shown.
Default: False
show_extension_name
Display extensions using both the extension number and the description set in the PBX (Optional). Requires Profile Manager.
True: Extension names are shown.
False: Extension names are not shown.
Default: False
show_jitter_stats
Show jitter statistics (Optional).
True: Jitter statistics are shown in audio debugging files.
False: Jitter statistics are not shown in audio debugging files.
Default: False
show_update_license_button
Display the Update License button on the About page.
True: The Update License button is shown.
False: The Update License button is hidden.
sign_out_in_charger
Automatically sign out of Zebra Voice when the device begins charging (Optional).
True: Sign out when charging begins.
False: Stay signed in while charged.
Default: False
keep_sign_in_after_reboot
Keep Zebra Voice signed In after reboot.
True: Keep signed in after the device reboots.
False: Keep signed out after the device reboots.
Default: False
sip_auto_answer
Auto answer mode (Optional).
True: Zebra Voice auto-answers all incoming calls.
False: The user must use Workcloud Communication to answer the call.
Default: False
sip_confnum
SIP default conference number. Use with primary PBX type (Optional).
Default: None
sip_device_type
The Cisco device type. Use with primary PBX type (Optional).
Default: 8865
sip_http_remhost
HTTP server address (Optional).
Server address
Default: None
sip_localport
The primary local listening port for SIP connections. Use with primary PBX type (Optional).
Default: 5060
sip_parknum
SIP default call park extension. Use with primary PBX type (Optional).
Default: None
sip_pbx_logo
Identify the PBX type on the Zebra Voice home screen dashboard. Enter text or set a logo (Optional).
Default: Displays the default text for the PBX type.
sip_mac
Primary radio MAC address of this mobile device. Use with primary PBX type (Optional).
MAC address
Default: None
sip_realm
SIP domain. Use with primary PBX type (Optional).
Default: None
sip_remhost
Primary TFTP server address #1. Use with primary PBX type (Optional).
Server address
Default: The server address is provided by option 150 in the DHCP.
sip_remhost2
TFTP server address #2. This is a secondary address used if the primary address is not reachable. Use with primary PBX type (Optional).
Server address
Default: None
sip_remhost3
TFTP server address #3. This is a secondary address used if the primary address is not reachable. Use with primary PBX type (Optional).
Server address
Default: None
sip_remport
TFTP server remote port. Use with primary PBX type (Optional).
Default: 5060
sip_rtp_port1
First RTP port.
Default: 51000
sip_rtp_port2
Last RTP port.
Default: 51025
sip_rtp_ptime
RTP payload size in milliseconds.
Select one of the following:
  • 20
  • 30
  • 40
  • 50
  • 60
  • 70
  • 80
Default: 20
sip_transport
SIP transport type. Use with primary PBX type (Optional).
Select one of the following:
  • UDP
  • TCP
  • TLS
Default: TCP
sip_userid
SIP user or authentication ID. Use with primary PBX type (Optional).
Default: None
sip_userpass
SIP authentication password. Use with primary PBX type (Optional).
Default: None
sip_vmnum
SIP voice mail extension. Use with primary PBX type (Optional).
Default: None
sip2_confnum
SIP default conference number. Use with second PBX type (Optional).
Default: None
sip2_device_type
The Cisco device type. Use with second PBX type (Optional).
Default: 8865
sip2_localport
The local listening port for SIP connections. Use with second PBX type (Optional).
Default: 5060
sip2_mac
Radio MAC address of this mobile device. Use with second PBX type (Optional).
MAC address
Default: None
sip2_parknum
SIP default call park extension. Use with second PBX type (Optional).
Default: None
sip2_realm
SIP domain. Use with second PBX type (Optional).
Default: None
sip2_remhost
TFTP server address #1. Use with second PBX type (Optional).
Server address
Default: The server address is provided by option 150 in the DHCP.
sip2_remhost2
TFTP server address #2. This is a secondary address used if the primary address is not reachable. Use with second PBX type (Optional).
Server address
Default: None
sip2_remhost3
TFTP server address #3. This is a secondary address used if the primary address is not reachable. Use with second PBX type (Optional).
Server address
Default: None
sip2_remport
TFTP server remote port. Use with second PBX type (Optional).
Default: 5060
sip2_transport
SIP transport type. Use with second PBX type (Optional).
Select one of the following:
  • UDP
  • TCP
  • TLS
Default: TCP
sip2_userid
SIP user or authentication ID.Use with second PBX type (Optional).
Default: None
sip2_userpass
SIP authentication password. Use with second PBX type (Optional).
Default: None
sip2_vmnum
SIP voice mail extension. Use with second PBX type (Optional).
Default: None
sip3_confnum
SIP default conference number. Use with third PBX type (Optional).
Default: None
sip3_device_type
The Cisco device type. Use with third PBX type (Optional).
Default: 8865
sip3_localport
The local listening port for SIP connections. Use with third PBX type (Optional).
Default: 5060
sip3_mac
Radio MAC address of this mobile device. Use with third PBX type (Optional).
MAC address
Default: None
sip3_parknum
SIP default call park extension. Use with third PBX type (Optional).
Default: None
sip3_realm
SIP domain. Use with third PBX type (Optional).
Default: None
sip3_remhost
TFTP server address #1. Use with third PBX type (Optional).
Server address
Default: The server address is provided by option 150 in the DHCP.
sip3_remhost2
TFTP server address #2. This is a secondary address used if the primary address is not reachable. Use with third PBX type (Optional).
Server address
Default: None
sip3_remhost3
TFTP server address #3. This is a secondary address used if the primary address is not reachable. Use with third PBX type (Optional).
Server address
Default: None
sip3_remport
TFTP server remote port. Use with third PBX type (Optional).
Default: 5060
sip3_transport
SIP transport type. Use with third PBX type (Optional).
Select one of the following:
  • UDP
  • TCP
  • TLS
Default: TCP
sip3_userid
SIP user or authentication ID.Use with third PBX type (Optional).
Default: None
sip3_userpass
SIP authentication password. Use with third PBX type (Optional).
Default: None
sip3_vmnum
SIP voice mail extension. Use with third PBX type (Optional).
Default: None
sip4_confnum
SIP default conference number. Use the fourth PBX type (Optional).
Default: None
sip4_device_type
The Cisco device type. Use the fourth PBX type (Optional).
Default: 8865
sip4_localport
The local listening port for SIP connections. Use the fourth PBX type (Optional).
Default: 5060
sip4_mac
Radio MAC address of this mobile device. Use with the fourth PBX type (Optional).
MAC address
Default: None
sip4_parknum
SIP default call park extension. Use with the fourth PBX type (Optional).
Default: None
sip4_realm
SIP domain. Use with the fourth PBX type (Optional).
Default: None
sip4_remhost
TFTP server address #1. Use with fourth PBX type (Optional).
Server address
Default: The server address is provided by option 150 in the DHCP.
sip4_remhost2
TFTP server address #2. This is a secondary address used if the primary address is not reachable. Use with the fourth PBX type (Optional).
Server address
Default: None
sip4_remhost3
TFTP server address #3. This is a secondary address used if the primary address is not reachable. Use with the fourth PBX type (Optional).
Server address
Default: None
sip4_remport
TFTP server remote port. Use with fourth PBX type (Optional).
Default: 5060
sip4_transport
SIP transport type. Use with the fourth PBX type (Optional).
Select one of the following:
  • UDP
  • TCP
  • TLS
Default: TCP
sip4_userid
SIP user or authentication ID. Use with the fourth PBX type (Optional).
Default: None
sip4_userpass
SIP authentication password. Use with the fourth PBX type (Optional).
Default: None
sip4_vmnum
SIP voice mail extension. Use with the fourth PBX type (Optional).
Default: None
speaker_on_horizontal
Answer calls in speaker mode when the device is placed on a horizontal surface
True: Enable speaker mode
False: Disable speaker mode
Default: False
use_aec
Echo Cancellation (Optional).
True: Echo cancellation is used.
False: Echo cancellation is not used.
Default: False
use_agc_ear
Automatic Gain Control (AGC) on earpiece (Optional).
True: AGC is used.
False: AGC is not used.
Default: False
use_agc_speaker
Automatic Gain Control (AGC) on speaker. (Optional).
True: AGC is used.
False: AGC is not used.
Default: False
use_noise
Noise Reduction (Optional).
True: Noise reduction is used.
False: Noise reduction is not used.
use_prox_wake_lock
Use the Android platform default proximity WAKE LOCK (Optional).
True: Uses the Android platform default proximity WAKE LOCK.
False: Uses a workaround solution.
Default: True
var_location
The URI of the shared profile is located on a remote or local server (Optional).
Protocols: file, http, https, tftp.
Default: none (Disabled)
vibrate_when_ringing
The device vibrates when a call is received (Optional).
True: The device vibrates when a call is received.
False: The device does not vibrate when a call is received.
Default: False
voice_announcer_check
Announces the number or user name of an incoming call (Optional).
True: Incoming calls are announced.
False: Incoming calls are not announced.
Default: False
wifi_preferred
Connect to an available Wi-Fi network. This setting only applies after the network state changes or when the client is restarted. It applies to Zebra Voice Client's earlier versions of 9.0.22409, 9.0.23101, and 9.0.23102.
True: Connect to an available Wi-Fi network.
False: Only connect to the device’s default network.
Default: True
encrypted_password
Allows the administrator to change the Settings password. Password is specified with MD5 encoding (Optional).
MD5 encoded Settings password string.
vpn_configuration
The device routes Zebra Voice traffic through VPN.
Specify one of the following values:
  • 0: VPN Preferred
  • 1: Use VPN Only
Default Value:0
sip_srtp
sip2_srtp
sip3_srtp
sip4_srtp
Enables Secure RTP feature for standard clients.
True:  enable
False: disable
Default Value: False
showGroup
Displays the Zebra Voice Group when setting the value to true.
true: enable
false:  disable
Default Value: false
showDisclosure
Displays the Data Consent inside the Voice application.
true: enable
false:  disable
Default Value: true
check_phone_service_running
Enables polling to check whether the phone service is running.
true: enable
false:  disable
Default Value: false
check_phone_service_running_interval
Sets the polling mechanism parameters.
Between 60 seconds to 24 hours. The value must be entered in seconds.
emergency_numbers
Sets single or multiple emergency numbers.
Commas separate emergency numbers.
emergency_package_name
Sets the package name, which is associated with a Broadcast Intent.
A valid package name.
emergency_class_name
Sets the class name, which is associated with a Broadcast Intent.
A valid broadcast receiver class name.
dial_emergency_number
Either make a call and send or broadcast or only send a broadcast.
True: Initiates a call to the emergency number and activates a broadcast to the third-party service/application.
False: Initiates a broadcast to the third-party service/application.
Default: true
auto_reload_when_ip_changes
Reloads the Voice Client on the device.
true: enable reloading the Voice Client.
False:  Work as earlier version.
Default Value: false
Dashboard tags
Element
Description
Columns
The number of columns on the dashboard area.
Button
The definition of an on-screen button. See Button Tags for details.
Call Button Tags
Element
Description
Button
The definition of an on-screen button. See Button Tags for details.
Button Tags
Element
Description
Value
action
The button action.
This must be one of the action types listed in Button Tags. The button is not created if this string is not a valid action type.
bg_color
Button background color (optional). The profile element <gfg_color> is used if no color is defined.
The color is one of the following: red, blue, green, black, white, gray, cyan, magenta, yellow, lightgray, darkgray, grey, lightgrey, darkgrey, aqua, fuchsia, lime, maroon, navy, olive, purple, silver, teal, or, it is an RGB value in one of the following formats expressed as a decimal, or a hexadecimal, number:
  • #RRGGBB
  • #AARRGGBB
  • Default: #FF001425
confirm
After touching the button, the operator is asked to confirm the action before it is executed (optional).
True: Confirm the action
False: Do not confirm the action
Default: False
description
The LIST action type uses description.
On the LIST action type button:
  • It is used as the title on the popup dialog box.
  • It appears as a comment for each LIST sub-button, identifying which action the button performs.
For all other buttons, the description is optional.
enabled
Defines whether the button is available on the Zebra Voice screen (optional).
True: The button is visible and active.
False: The button is not visible.
Default: True.
fg_color
Button text color (Optional). The profile element <gfg_color> is used if no color is defined.
The color is one of the following: red, blue, green, black, white, gray, cyan, magenta, yellow, lightgray, darkgray, grey, lightgrey, darkgrey, aqua, fuchsia, lime, maroon, navy, olive, purple, silver, teal, or, it is an RGB value in one of the following formats expressed as a decimal, or a hexadecimal, number:
  • #RRGGBB
  • #AARRGGBB
  • Default: #FFFFFFFF
icon
The icon that appears on the button (Optional).
Select one of the following:
  • none: Only the title is displayed on the button.
  • Default: Displays the default icon for the associated action type.
  • <filename>: The filename of a PNG file containing the icon in the WFConnect folder. Include .png in the filename.
  • Default: Default
title
Button title (Optional). This text is displayed on the on-screen button. If the string contains spaces, the text displays on two lines; otherwise, all the text displays on one line. The font size adjusts depending on the text length.
Contents: Text
Default: New
value
Additional information required by the <action> element (Optional).
For details on the values associated with each action type, see Button Tags.
Button
The definition of an on-screen button.
N/A
Zebra collects Workcloud Communication usage and performance data to ensure the quality of the products delivered to our customers. From version 2.0.24102, data collection has been integrated and enabled by default with Voice Client. This can be disabled by setting enableGA = 0. For more information about disabling data collection, go to Data Collection.