XML Tags
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).
Number between 1 and 8
Default: 1
audio_gain_out
Output Audio Volume (Optional).
Number between 1 and 8
Default: 1
background_logo
Set a background image for the WFC Voice home screen dashboard (Optional).
Default: None (Disabled)
callwaiting_interval
Interval of call waiting tone.
500ms to 8000ms
Default: 2000ms
callwaiting_volume
Call waiting volume.
Percentage between 10% and 100%
Default: 80%
codec_alaw_priority
Assigns preference priority for G.711 A-Law Voice codec negotiations between PBX and WFC Voice.
between -5 and 5
Negative numbers disable the codec.
Default: 2
codec_g722_priority
Assigns preference priority for G.722 Voice codec negotiations between PBX and WFC Voice.
between -5 and 5
Negative numbers disable the codec.
Default: 4
codec_g729_priority
Assigns preference priority for G.729 Voice codec negotiations between PBX and WFC Voice.
between -5 and 5
Negative numbers disable the codec.
Default: 3
codec_gsm_priority
Assigns preference priority for GSM Voice codec negotiations between PBX and WFC Voice.
between -5 and 5
Negative numbers disable the codec.
Default: 2
codec_ulaw_priority
Assigns preference priority for G.711 u-LAW Voice codec negotiations between PBX and WFC Voice.
between -5 and 5
Negative numbers disable the codec.
Default: 1
contacts_url
The URL of the contacts list is located on a remote or local server (Optional).
File type: CVS.
Protocols: file, http, https, tftp.
Default: none
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
flex_tls
Set security for SIP connections (Optional).
true: Trust all remote hosts.
false: Use Android certificates for TLS/SSL connections.
Default: true
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
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_mod
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
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 WFC 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 WFC Voice profile.
Default: Flexera server
log_file
Enable logging for WFC 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 Workforce Connect (Optional).
Select one of the following:
  • Error
  • Warning
  • Info
  • Debug
  • Verbose
For debugging use Verbose.Default: Error
log_sipclf
Enable logging of SIP messages. Logs are stored as a CLF file on the device in SIP Common Log Format (Optional).
true: Log to a file on the device.
false: Do not log to 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 ringer while the device is charging.
true: Disable 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: None (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: None (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: None (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: None (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: None (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: None (The default Android ringtone is used.)
ringtone_park
The ringtone for park (Optional).
One of the following:
  • The name of Android Ringtone.
  • The name of an audio file stored in the WFConnect folder.
Default: None (The default Android ringtone is used.)
ringtone_priority
Priority call ringtone (Optional).
One of the following:
  • The name of Android Ringtone.
  • The name of an audio file stored in the WFConnect folder.
Default: None (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
save_incoming_ voice_to_file
Save incoming voice to a file in the WFConnect folder. The file name is a time-stamp plus PCM extension (Optional).
true: File is saved.
false: File is not saved.
Default: false
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
sign_out_in_charger
Automatically sign out of WFC 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 WFC 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: WFC Voice auto-answers all incoming calls.
false: The user must use Workforce Connect to answer the call.
Default: false
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 WFC 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 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
sdp_dtmf_type
DTMF payload size in milliseconds.
Select one of the following:
  • From 96 to 127
Defaut: 101
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_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 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_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 with the fourth PBX type (Optional).
Default: None
sip4_localport
The local listening port for SIP connections. Use with 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
sms_enabled
Short Message Service (SMS) (Optional).
true: Enable SMS
false: Disable SMS
Default: false
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_android_dialer
Use the native Android dialer to place calls.
true: Use the Android dialer
false: Use Workforce Connect dialer
use_accelerometer
Use the native Android accelerometer (Optional).
true: Accelerometer is used.
false: Accelerometer is not used.
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_native_sample_rate
Use the native sample rate set by Android (Optional).
true: Android native sample rate is used
false: Sample rate is 8000
Default: false
use_noise
Noise Reduction (Optional).
true: Noise reduction is used.
false: Noise reduction is not used.
Use the native sample rate set by Android.
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 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 WiFi network. This setting only applies after the network state changes or when the client is restarted.
true: Connect to an available WiFi network.
false: Only connect to the device’s default network.
Default: true
Dashboard Tags
Element
Description
Columns
The number of columns on the dashboard area.
Button
The definition of an on-screen button. See Table 5 for details.
Call Buttons Tags
Element
Description
Button
The definition of an on-screen button. See Table 5 for details.
Button Tags
Element
Description
Value
action
The button action.
This must be one of the action types listed in Button Actions. If this string is not a valid action type the button is not created.
bg_color
Button background color (optional).If no color is defined then the profile element <gfg_color> is used.
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
  • It appears as a comment for each LIST sub button, identifying which action is performed by the button.
For all other buttons, the description is optional.
enabled
Defines whether the button is available on the WFC Voice screen (optional).
true: Button is visible and active.
false: Button is not visible.
Default: true.
fg_color
Button text color (Optional).If no color is defined then the profile element <gfg_color> is used.
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 2 lines; otherwise, all the text displays on one line. The font size adjusts depending on 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 Actions.
Button
The definition of an on-screen button.
N/A