Webex For Broad Works Config Guide
Webex For Broad Works Config Guide
Configuration Guide
Release 43.8
Document Version 1
Table of Contents
This section describes the changes to this document for each release and document version.
▪ [Desktop only] Removed hardcoded value for the first line label name under
corresponding <line> section under <protocols><sip>.
<config>
<protocols><sip>
<lines multi-line-enabled="%ENABLE_MULTI_LINE_WXT%">
…
<line>
<label>%BWAPPEARANCE-LABEL-1%</label>
…
<config>
<protocols><sip>
<lines multi-line-enabled="%ENABLE_MULTI_LINE_WXT%">
<personal>
<line-port>%BWDISPLAYNAMELINEPORT%</line-port>
<primary-lineport>%BWLINEPORT-PRIMARY%</primary-lineport>
</personal>
<line>
<label>My Line</label>
<name>%BWNAME-1%</name>
<phone-number>%BWE164-1%</phone-number>
<extension>%BWEXTENSION-1%</extension>
<voice-mail-number>%BWVOICE-PORTAL-NUMBER-1%</voice-mail-number>
<conference-service-uri>sip:%BWNETWORK-CONFERENCE-SIPURI-
1%</conference-service-uri>
<credentials>
<username>%BWLINEPORT-1%</username>
<password>%BWAUTHPASSWORD-1%</password>
<auth>
<auth401>
<default>
<username>%BWAUTHUSER-1%</username>
<password>%BWAUTHPASSWORD-1%</password>
</default>
<realm id="%BWHOST-1%">
<username>%BWAUTHUSER-1%</username>
<password>%BWAUTHPASSWORD-1%</password>
</realm>
</auth401>
<auth407>
<default>
<username>%BWAUTHUSER-1%</username>
<password>%BWAUTHPASSWORD-1%</password>
</default>
<realm id="%BWHOST-1%">
<username>%BWAUTHUSER-1%</username>
<password>%BWAUTHPASSWORD-1%</password>
</realm>
</auth407>
</auth>
</credentials>
▪ Added "Email Vm Messages" to the list of Call Settings Web View services under
section <services><web-call-settings><service-settings>.
<config>
<services>
<web-call-settings>
<service-settings>
<service name="Email Vm Messages"
visible="%WEB_CALL_SETTINGS_EMAIL_VM_VISIBLE_WXT%"/>
The purpose of this document is to provide a description of the configuration of the Webex for
Cisco BroadWorks client.
The configuration file config-wxt.xml is provided in two versions – one for mobile (Android and
iOS) and one for desktop (Windows and MacOS).
The clients are configured using a configuration that is not visible to the end user. The config-
wxt.xml provides server-specific information, such as server addresses and ports and runtime
options for the client itself (for example, options visible in the Settings screen).
The configuration files are read by the client when it starts, after being retrieved from Device
Management. The information from the configuration files is stored encrypted, thus making it
invisible and inaccessible to the end user.
NOTE: The XML properties should not contain spaces (for example, <transfer-call
enabled="%ENABLE_TRANSFER_CALLS_WXT%"/> instead of <transfer-call enabled =
"%ENABLE_TRANSFER_CALLS_WXT%"/>).
The Webex for Cisco BroadWorks clients can be installed from the following:
https://www.webex.com/webexfromserviceproviders-downloads.html
NOTE 2: It is HIHGLY RECOMMENDED the templates to be kept up-to-date with the latest release of
the Webex app
%BWVOICE-PORTAL-NUMBER-x% This number is used for voicemail. The client dials this number
when retrieving voicemail.
%BWHOST-x% This is the domain portion of the provisioned line port for the
device assigned to the user. It is retrieved from the user’s
profile.
Typically used as the SIP domain.
%BWNAME-x% This is the subscriber’s first name and last name in the user’s
profile. The first and last names are concatenated together.
In case of multi-line configuration, if no line label configured
and if not empty, used as display name for the line in the line
selector.
%BWAPPEARANCE-LABEL-x% This is the line label configured. Used as line name, if it is not
empty.
%BWUSEREXTID-X% This is the external ID for given line (Webex Calling only)
This section describes the custom tags used in Webex for Cisco BroadWorks. It lists all the
custom tags used for both Desktop and Mobile/Tablet platforms.
Note, however, that some settings described in this section are supported only for the specific
release of the client. To determine if a setting does not apply to an older client version, see the
appropriate release-specific configuration guide.
Tag Used in Used Default Section
Desktop in Value
Mobile
/Tablet
%ENABLE_MULTI_ Y N false For more information, see section
LINE_WXT% 6.2.12 Shared-Line Appearance.
For more information about mapping the custom tags used in Webex for Cisco BroadWorks to the
ones used by UC-One, see section 8 Custom Tags Mapping between Webex for Cisco
BroadWorks and UC-One.
The following example and table provide information on the most typical DM tags used for SIP
configuration.
Tag Default if Supported Description
Omitted Values
%BWLINEPORT-1% empty string Typically SIP username.
For more information, see section 5.7 Cisco
BroadWorks Dynamic Built-in System Tags.
Example: johndoe
NOTE: It is strongly advisable for the SIP port to be different from 5060 (for example, 5075) due to
known issues with using the standard SIP port (5060) with mobile devices.
<config>
<protocols><rtp>
<secure enabled="%SRTP_ENABLED_WXT%" mode="%SRTP_MODE_WXT%" rekey-
always="%ENABLE_REKEYING_WXT%"/>
The Secure Real-Time Control Protocol (SRTCP) is also used if SRTP is enabled.
In some deployments, re-keying for SRTP is not supported. Therefore, there is a configuration
parameter for enabling/disabling SRTP re-keying. However, new keys are always taken into use
when received in an updated SDP according to rfc3264. Configurability only pertains to sending
new keys.
Tag Default if Supported Description
Omitted Values
%USE_TLS_WXT% false true, false When set to “false”, SIP TLS is deactivated.
When set to “true”, SIP TLS is activated.
Please note that if 6.1.6 Dynamic SIP Proxy
Discovery is used, this parameter is ignored.
%SRTP_ENABLED_ false true, false When set to “false”, SRTP is deactivated.
WXT% When set to “true”, SRTP is activated.
NOTE: If ICE support is enabled (see 6.1.18 ICE Support (Webex Calling only)), re-keying will always be
performed (%ENABLE_REKEYING_WXT% value from the configuration is ignored).
The same configuration node also has parameters for UDP, TCP and TLS keepalive, depicted in
the following example.
<config>
<protocols><sip>
<transports>
<udp>
<keepalive enabled="true">
<timeout>20</timeout>
<payload>crlf</payload>
</keepalive>
</udp>
<tcp>
<keepalive enabled=”false”>
<timeout>0</timeout>
<payload></payload>
</keepalive>
</tcp>
<tls>
<keepalive enabled="false">
<timeout>0</timeout>
<payload></payload>
</keepalive>
</tls>
</transports>
The keepalives can be used for NAT traversal purposes to keep NAT bindings open with little
extra traffic.
The server IP address and port for keepalives are determined using the normal procedures for
SIP proxy discovery. Note that SIP ports and selection of transport protocol obtained via SIP
dynamic proxy discovery override any static port or transport configuration. For more information
on dynamic proxy discovery, see section 6.1.6 Dynamic SIP Proxy Discovery.
The following tags control the socket connection timeout (in milliseconds).
It is possible to control which transport protocols entries from DNS SRV are used when many are
available following the procedures provided in this section.
Tag Default if Supported Description
Omitted Values
%USE_PROXY_DI false true, false Enables dynamic SIP proxy discovery for audio
SCOVERY_WXT% and video calls.
The recommended value is “true”.
%SBC_ADDRESS_ empty String This Cisco BroadWorks tag is typically used for
WXT% the record-name parameter. It should be a valid
URL – should not be an IP address.
For more information, see section 5.6 System
Default Tags.
Example: sbc.domain.com
%DOMAIN_OVER empty String This custom tag is used for the domain-override.
RIDE_WXT% For more information, see the following section.
Example: other.domain.com
%USE_TCP_FRO true true, false If this parameter value is “false”, then the DNS
M_DNS_WXT% SRV results for this transport protocol (TCP) are
discarded.
If “true”, then the results from DNS SRV for this
transport protocol (TCP) are used. Depending on
the SRV priorities, another transport may still be
elected.
%USE_UDP_FRO true true, false If this parameter value is “false”, then the DNS
M_DNS_WXT% SRV results for this transport protocol (UDP) are
discarded.
If “true”, then the results from DNS SRV for this
transport protocol (UDP) are used. Depending on
the SRV priorities, another transport may still be
elected.
DNS allows the client to get the IP address, port, and transport protocol for the SIP proxy as per
RFC 3263.
DNS SRV, Naming Authority Pointer (NAPTR) and A-record queries are supported. At login, the
3-step flow is as follows:
1. Perform a NAPTR query using the <record-name> field above to obtain the server URIs with
the transport protocols if they exist. The value for the <record-name> parameter should be
the full domain that DNS is to resolve and cannot be an IP address.
2. Resolve items found in the NAPTR query using an SRV-query to obtain the final server URI
and port. The domain part used in the SRV-query is taken from the result of the NAPTR
query to find the final server URI (and port). The port received from DNS SRV-query is used
when the DNS SRV entries are available. Note that the port, only from the configuration file,
applies to the static proxy in the configuration file, and not to the URIs resolved using SRV.
See the following examples for the usage of the various record names.
If no NAPTR is found, then the client tries an SRV-query with the record-name taken from
<domain> parameter unless there is <domain-override> parameter present in which case
<domain-override> is used and automatically tries to find separate entries for TCP, UDP, and TLS
(_sip_protocol [UDP, TCP, or TLS]). Note that the Stream Control Transmission Protocol (SCTP) is
not supported. If SRV queries do not yield any results, proxy discovery fails, and the end user is
presented with an error indicating that calls are not available. In this case, there is no SIP
registration. However, even if all SRV queries fail or if the servers received there do not work, as a
fallback, the client still checks if the configured static proxy works, only with A-queries to the URI
specified in <proxy address> in order to see if it yields an IP address that provides a working SIP
registration. Port and transport in this last resort case come from tcp-threshold and <secure>
parameters.
NOTE 1: If DNS proxy discovery results in transport protocol selection in the SRV step by receiving a
working SIP proxy URI for a transport protocol, it overrides the tcp-threshold parameter typically used to
select UDP or TCP in the configuration file. The same also applies to configuration of SIP/TLS. TCP or
UDP is used depending on the priority in DNS.
NOTE 2: Items received via SRV are prioritized over the static proxy in the configuration file. The NAPTR
order is not looked at; only SRV priority counts. When SRV results in several items with equal transport
protocol, priority, and weight, any one received is selected at random. NAPTR weights are not supported
in this release but SRV weights are supported. SRV priority is looked at first, and for items with equal
priority, weight is looked at to determine the likelihood in which a certain server is tried next.
NOTE 3: The optional domain-override parameter allows A-record name other than the one in the SIP
domain configuration parameter to be resolved with SRV when NAPTR results are omitted. See the
following examples for the usage of the domain-override parameter.
NOTE 4: The client uses operating system primitives for DNS operations and, typically, DNS responses
are cached to honor the TTL of the DNS response.
NOTE 5: The DNS type (service) for NAPTR records must follow RFC 3263 procedures, otherwise, DNS
resolution may fail. For example, it is required to use SIPS+D2T for SIP over TLS.
NOTE 6: The client supports only certain prefixes for NAPTR services. The following lists the supported
prefixes:
If the NAPTR response contains a record with prefix that does not match the service type, then this
record is ignored.
As a result, the SIP registration takes place over TCP using port 5061 (received in the SRV step)
and towards the IP address 1.2.3.4.
As a result, the SIP registration takes place over UDP using port 5061 (received in the SRV step)
and towards the IP address 4.3.2.1.
As a result, the SIP registration takes place over TCP using port 5061 (received in the SRV step)
and towards the IP address 1.2.3.4 that would support both UDP and TCP.
Example 4: Using DNS proxy discovery with NAPTR when service does not match service type
The following is an example of a configuration using SIP proxy discovery when SIP over TCP and
TLS is used and NAPTR query in step 1 returns results.
<config>
<protocols><sip>
<proxy address="domain.com" port="5060"/>
<proxy-discovery enabled="true" tcp="true" udp="false" tls="true">
<record-name>record-domain.com</record-name>
<domain-override>override-domain.com</domain-override>
</proxy-discovery>
<domain>sip-domain.com</domain>
2. For the first record we have service type "SIPS+D2T" and the prefix is
"sip._tls.". Since this prefix doesn’t match the service type (see Note 6 above)
it will be ignored.
As a result, the SIP registration takes place over TCP using port 5061 (received in the SRV step)
and towards the IP address 1.2.3.4.
%SIP_FAILBACK_USE_R false true, false Adds a random period [0-10]% of the SIP
ANDOM_FACTOR_WXT% failback.
With “dns” configuration, the IPv4 addresses are prioritized over the IPv6 ones, for given host. If there
are two hosts with both IPv4 and IPv6 addresses, the order will be IPv4(host1), IPv6(host1),
IPv4(host2), IPv6(host2).
In “prefer-ipv4” mode, the IPv4 addresses are ordered before the IPv6 addresses (the order within
IPv4 and IPv6 groups remains)
Example: IPv4(host1), IPv4(host2), IPv6(host1), IPv6(host2).
With “prefer-ipv6” mode, the order is the opposite - the IPv6 addresses are placed before the IPv4
addresses
Example: IPv6(host1), IPv6(host2), IPv4(host1), IPv4(host2).
NOTE: This is a desktop-only feature, since the mobile clients have SIP connection only while on a call.
<config>
<protocols><sip>
<refresh-on-ttl enabled="%SIP_REFRESH_ON_TTL_WXT%"
use-random-factor="%SIP_REFRESH_ON_TTL_USE_RANDOM_FACTOR_WXT%"/>
If the parameter is set to “true”, then the client takes its own identity from the last
P-Associated-URI header for all outgoing SIP requests (INVITE, SUBSCRIBE, CANCEL, INFO,
and REFER) from the 200 OK response in the REGISTER. In addition, these URIs are not shown
as contacts in the contact list.
<config>
<protocols><sip>
<use-rport enabled="%ENABLE_USE_RPORT_WXT%" use-local-
port="%RPORT_USE_LOCAL_PORT_WXT%"/>
%RPORT_USE_LOCAL_ false true, false Controls whether the local port of the
PORT_WXT% client’s socket is to be added in the SIP
Contact header.
NOTE: The SIP 180 Ringing may not be triggered in some environments, for some numbers, or in some
cross-server communication scenarios.
Example output:
maxConferenceParties = 6
conferenceURI =
Once the value for the maxConferenceParties is obtained, (which has a range of 4 through 15),
the %MAX_CONF_PARTIES_WXT% tag should be set accordingly.
<config>
<services><calls>
<conference enabled=”%ENABLE_CONFERENCE_CALLS_WXT%”>
<service-uri>sip:%BWNETWORK-CONFERENCE-SIPURI-1%</service-uri>
<subscribe-conference-info enabled=”%ENABLE_NWAY_PARTICIPANT_LIST_WXT%”/>
<max-nway-participants>%MAX_CONF_PARTIES_WXT%</max-nway-participants>
</conference>
NOTE: It is advisable to hide the settings that are already visible in the application like Call Center (see
section 6.1.31 Call Center / Call Queue Login/Logout) and BroadWorks Anywhere (see section 6.1.29.2
BroadWorks Anywhere). The Remote Office service is also advisable to be hidden because it has been
succeeded by the BroadWorks Anywhere service.
The following custom tag can be used to configure the URL for the settings (Self Care or CSWV)
portal. If the tag is empty, the link to the settings portal is not visible for the user in the application.
<config>
<services>
<web-call-settings target=”%WEB_CALL_SETTINGS_TARGET_WXT%”
<url>%WEB_CALL_SETTINGS_URL_WXT%</url>
<branding-enabled=”%WEB_CALL_SETTINGS_BRANDING_ENABLED_WXT%”>
<service-settings>
<service name=”Call Forwarding Always”
visible=”%WEB_CALL_SETTINGS_CFA_VISIBLE_WXT%”/>
NOTE 1: The Call Settings WebView URL should always have a trailing “/” configured. For example:
http(s)://<XSP-FQDN>/<CSW-Context-Path>/
NOTE 2: The Call Settings WebView application minimum version that is supported is 1.7.5.
For installation on Cisco BroadWorks Release 21.0, see the additional steps described in the Webex For
Cisco BroadWorks Solution Guide.
The client supports H.264 as video codec. Video resolution attribute can be used to set one of the
following available values: SUBQCIF, QCIF, CIF, 4CIF, VGA, and HD.
If the bit rate is not entered in the configuration, the default bit rate values are used. Default bit
rate values, per resolution and frame rate, are listed in the following table.
Resolution Video Size * FPS Default Bit Rate Values per
(Frames Per Second) Resolution and FPS
SUBQCIF 128 x 96 15 128000
QCIF 176 x 144 30 192000
CIF 352 x 288 15 384000
CIF 352 x 288 30 768000
VGA 640 x 460 15 2000000
4CIF 704 x 576 25 2000000
* Maximum advertised video resolution. The actual video resolution during a call between two
Webex for Cisco BroadWorks clients depends on the capabilities of both clients – it will be the
lower of the two and will be the same on both clients.
Video resolution for a video call is negotiated during session setup and is based on the
capabilities of the two endpoints. Video call resolution is the same on both endpoints. That is, if
the Webex for Cisco BroadWorks endpoints have different capabilities (and therefore support
different resolutions), then the lower resolution is negotiated for the call. Video resolution may
change during a call if the network conditions deteriorate. In this case, the two mobile endpoints
may be using different video resolutions.
The packetization mode can be configured to be SingleNAL (0) or Non-interleaved (1). The
template uses SingleNAL by default (<packet-mode>0</packet-mode>).
Multiple telephone event configuration is also supported. During codec negotiation, the client
sends all the configured codecs, including multiple telephone events. After the audio codec is
selected, it searches for telephone events in the offer. If the offer has the telephone event with the
sample rate of the negotiated audio codec, then this telephone event is selected. Otherwise, the
first telephone event in the list is used. If there are no telephone events in the offer at all, in-band
dual-tone multi-frequencies (DTMFs) are used.
Example configured codecs:
<codec name=”telephone-event” payload=”100” in-band=”false” />
<codec name=”telephone-event” payload=”101” clockrate=”48000” in-band=”false” />
If an audio codec with sample rate of 48kbps is negotiated, the telephone event with payload 101
is used.
Webex for Cisco BroadWorks officially supports the following codecs:
▪ Audio
- OPUS
- G.722
- G.729
- PCMU (G.711U)
- PCMA (G.711A)
- iLBC
▪ Video
- H.264
NOTE: This applies only if Locus calling is disabled. Only in this case will SIP URI dialing blocking work.
NOTE: Unified call history should be enabled at the same time on the client and server side in order to avoid
missing call history or duplicated records.
NOTE: If VOIP calling is disabled, the only meaningful value for emergency dial sequence
(%EMERGENCY_CALL_DIAL_SEQUENCE_WXT%) is cs-only.
%VIDEOCALLS_ANSWER_ Desktop - true, false Controls the default value of the “Accept
WITH_VIDEO_ON_DEFAULT true incoming calls with my video on” setting.
_WXT% Mobile /
Tablet -
false
%EMERGENCY_REDSKY_ -1 (user number [-1 - The times that the user is allowed to close
USER_MANDATORY_LOCAT can cancel 100] the location dialog before location becomes
ION_WXT% the dialog mandatory (that is, they cannot close the
always) location window).
Possible values:
▪ N = -1 (user can cancel the dialog
always)
▪ N = 0 (user is not allowed to cancel the
dialog - mandatory location always)
▪ N > 0 (user is allowed to cancel the
dialog N times before it becomes
mandatory)
NOTE: BWE911-*** tags are “Dynamic Built-in System Tags”. For more information, see section 5.7
Cisco BroadWorks Dynamic Built-in System Tags.
NOTE: Recent versions of the Microsoft Windows operating system do not allow applications to directly
set DSCP or UP on outgoing packets, instead requiring the deployment of Group Policy Objects (GPO) to
define DSCP marking policies based on UDP port ranges.
At login, the Webex application checks how many devices are available for the given type. If there
is just a single profile configured (user's line is not shared with another user), Phone services will
not check for the primary flag and will sign in using the single profile available. If there are
multiple profiles configured for the given platform (Desktop, Mobile or Tablet), the device that the
user owns will be used.
Same restriction applies to the devices user can pair with in the Desktop Webex app. User can
see and pair only with devices he is owning. This prevents pairing with devices of another user
that has shared or virtual line assigned. The value of the same configuration parameter applies to
this restriction too.
<config>
<services><calls>
<device-owner-restriction enabled="%ENABLE_DEVICE_OWNER_RESTRICTION_WXT%"/>
NOTE: It is recommended owner's restriction to be enabled. If disabled, the Phone services will use the
first profile found to sign in and some problems may occur if there are multiple profiles configured for the
user of the same type.
NOTE: This feature depends on the Cisco BroadWorks Call Block service being assigned to the user.
NOTE: Auto answer will not affect incoming calls while in DPC mode, so that the desk phone rings for
incoming calls.
<config>
<services><calls>
<deskphone-control auto-answer="%ENABLE_DESKPHONE_CONTROL_AUTO_ANSWER_WXT%"/>
<config>
<services>
<calls>
<busy-lamp-field enabled="%ENABLE_BUSY_LAMP_FIELD_WXT%">
<display-caller enabled="%ENABLE_BLF_DISPLAY_CALLER_WXT%"/>
<notification-delay time="%BLF_NOTIFICATION_DELAY_TIME_WXT%"/>
<config>
<protocols>
<sip>
<survivability-gateway enabled="%ENABLE_SURVIVABILITY_GATEWAY_WXT%" fallback-
time="%SURVIVABILITY_FALLBACK_TIME_WXT%">%BWSURVIVABILITYGATEWAY%</survivability-
gateway>
Administrator should set up the Shared Call Appearances for each shared line.
Webex client will detect line configuration update within 12h timeframe and will request the user
to restart the application. Re-login of the user will apply the line updates immediately.
NOTE 1: The feature Boss-Admin (Executive-Assistant) support is not available in combination with
Shared-Lines.
NOTE: If VOIP calling is disabled, the only meaningful value for emergency dial sequence
(%EMERGENCY_CALL_DIAL_SEQUENCE_WXT%) is cs-only.
6.3.2.1 MWI
With the MWI feature enabled, the Mobile Webex client subscribes for the MWI Push Notification to
receive updates with the voicemail of the user and notify him.
To reduce the number of notifications and to avoid unnecessary distraction, the MWI Push Notifications
are suppressed in some cases. For instance, when the user is listening to the Voicemail messages or
is marking them as read from within the Mobile Webex client (unread number is decreasing). There is
no configurable option to control this.
For more information about MWI, check section 6.1.27 Voicemail, Visual Voicemail, Message
Waiting Indicator.
%DIALING_MODE_ voip voip, native Specifies the default dialing mode selected when the
DEFAULT_WXT% dialing mode is enabled in Preferences.
%DIALING_NATIVE_ false true, false Controls whether the availability of the Native calling
ENABLE_BWKS_MO should depend on the BroadWorks Mobility service
BILITY_DEPENDEN assignment and Mobility Location being configured
CY_WXT% for the user.
NOTE 2: If just the native calling is enabled, in MNO deployments, it is recommended to disable the single-alerting
to prevent the client from disabling the BWM alerting.
NOTE 3: If both native and voip callings are enabled, in MNO deployments, it is recommended to enable the
single-alerting to prevent double alerting.
%DEPLOYMENT_DE “” string The device type name(s) that should be used in the
VICE_TYPE_1_WXT MNO_Access deployment type.
%,
%DEPLOYMENT_DE
VICE_TYPE_2_WXT
%,
%DEPLOYMENT_DE
VICE_TYPE_3_WXT
%
%ENABLE_XSI_HOL true true, false Controls if the Call Hold action should be available
D_CALLS_WXT% for the user for XSI mobile calls.
<config>
<services><calls>
<hold xsi-enabled="%ENABLE_XSI_HOLD_CALLS_WXT%" widget-
enabled="%ENABLE_WIDGET_HOLD_CALLS_WXT%"/>
<transfer-call enabled="%ENABLE_TRANSFER_CALLS_WXT%" xsi-
enabled="%ENABLE_XSI_TRANSFER_CALLS_WXT%" widget-
enabled="%ENABLE_WIDGET_TRANSFER_CALLS_WXT%" type="%TRANSFER_CALL_TYPE_WXT%"/>
<escalate-to-webex-meeting
enabled="%ENABLE_CALLS_ESCALATE_TO_WEBEX_MEETING_WXT%" widget-
enabled="%ENABLE_WIDGET_CALLS_ESCALATE_TO_WEBEX_MEETING_WXT%"/>
The following table lists the Webex for Cisco BroadWorks custom tags, matching their legacy custom
tags for UC-One.
Webex for Cisco BroadWorks Desktop Legacy Tag Mobile Legacy Tag
Tag
%ENABLE_REJECT_WITH_ %ENABLE_REJECT_WITH_48 %ENABLE_REJECT_WITH_48
486_WXT% 6_DESKTOP% 6_MOBILE%
%REJECT_WITH_XSI_MODE_ N/A %REJECT_WITH_XSI_MODE_
WXT% MOBILE%
%REJECT_WITH_XSI_DECLIN N/A %REJECT_WITH_XSI_DECLIN
E_REASON_WXT% E_REASON_MOBILE%
%ENABLE_TRANSFER_CALL %ENABLE_TRANSFER_CALL %ENABLE_TRANSFER_CALL
S_WXT% S% S_MOBILE%
%ENABLE_CONFERENCE_CA N/A %ENABLE_CONFERENCE_CA
LLS_WXT% LLS_MOBILE%
%ENABLE_NWAY_PARTICIPA %ENABLE_NWAY_PARTICIPA N/A
NT_LIST_WXT% NT_LIST_DESKTOP%
%MAX_CONF_PARTIES_WXT %MAX_CONF_PARTIES% N/A
%
%ENABLE_CALL_STATISTICS N/A N/A
_
WXT%
%ENABLE_CALL_PULL_WXT %ENABLE_CALL_PULL_DESK %ENABLE_CALL_PULL_MOBI
% TOP% LE%
%PN_FOR_CALLS_CONNECT N/A %PN_FOR_CALLS_CONNECT
_SIP_ON_ACCEPT_WXT% _SIP_ON_ACCEPT_MOBILE%
%ENABLE_MWI_WXT% %DESKTOP_MWI_ENABLE% %ENABLE_MWI_MOBILE%
%ENABLE_MWI_WXT% %DESKTOP_MWI_ENABLE% %ENABLE_MWI_MOBILE%
%MWI_MODE_WXT% %DESKTOP_MWI_MODE% %MWI_MODE_MOBILE%
%ENABLE_VOICE_MAIL_WXT N/A N/A
%
%ENABLE_VISUAL_VOICE_M %ENABLE_VISUAL_VOICE_M N/A
AIL_WXT% AIL%
%ENABLE_FORCED_LOGOUT %ENABLE_FORCED_LOGOUT N/A
_WXT% %
%FORCED_LOGOUT_APPID_ %FORCED_LOGOUT_APPID% N/A
WXT%
%ENABLE_CALL_FORWARDI N/A N/A
NG_ALWAYS_WXT%
%ENABLE_BROADWORKS_ N/A N/A
ANYWHERE_WXT%
NOTE: N/A indicates that there was no corresponding custom tag controlling the feature in UC-One. Having N/A
for both Desktop and Mobile Legacy tags indicates that the Webex for Cisco BroadWorks tag is new and controls
either new functionality or an existing feature, that was not controlled through a custom tag in UC-One.
The Webex for BroadWorks client uses CiscoSSL, which is based on OpenSSL with additional
security hardening.
The number of custom DM tags has increased with each release, as many customers prefer tags
for the new configuration parameters. To offer mechanisms for provisioning those custom DM
tags more easily, this section contains a script that can be run on the Application Server (AS) side
to assign values to the custom DM tags. This script is especially intended for new deployments
where most of the custom DM tags are intended to be used.
Note that this script is only valid for new deployments where custom DM tags are being created.
To modify existing custom DM tags, the command in the following script must be changed from
“add” to “set”.
Script template with only a few custom tags set (in a real deployment, you would need to populate
a bigger list of custom tags). Note that the following example is for mobile. For desktop, use the
BroadTouch_tags tag set instead of Connect_Tags. For tablet, use the ConnectTablet_Tags tag
set instead of Connect_Tags.
%% ********************************* Connect_Tags - read file *********************************
%%
%% Instructions:
%% -------------------
%% - This read file can be used to create, add and set Webex for BroadWorks
%% client custom tags
%% - Use %% to comment out any steps not required based on deployment specific
%% service requirements:
%% Step 1 -- for new deployments only, create initial tag set label
%% Step 2 -- add a new custom tag (an entry is required for each new tag)
%% Step 3 -- set value for an existing custom tag (entry required for each applicable tag)
%% Step 4 -- display and visually verify tag settings
%%
%% - Edit, modify file as needed respecting command syntax. Save file (e.g. WxT_Tags.txt)
%% - SFTP read file to AS under directory /tmp
%% - Login to AS, bwcli (login as admin)
%% - Execute the following command from bwcli: AS_CLI> r /tmp/ WxT_Tags.txt
%% - Verify results
%%
%% ----------------------------------------------------------------------------------------------------------------------------
%% Step 1: Create Connect tag set label - Connect_Tags
%% ----------------------------------------------------------------------------------------------------------------------------
quit all;System;DeviceTagSet
add Connect_Tags
%% ----------------------------------------------------------------------------------------------------------------------------
%% Step 2: Add WxT for BWKS custom tags
%% EXAMPLE – for all mobile tags see the list below------------------------------------------------------
quit all;System;DeviceTagSet;Tags
add tagSetName Connect_Tags %ENABLE_TRANSFER_CALLS_WXT% true
%% ----------------------------------------------------------------------------------------------------------------------------
%% Step 3: Set Connect custom tags (if tag already exists)
%% EXAMPLE – for all mobile tags see the list below
set tagSetName Connect_Tags %ENABLE_TRANSFER_CALLS_WXT% isOverridable true
tagvalue false
%% ----------------------------------------------------------------------------------------------------------------------------
%% Step 4: Verify custom tags have been correctly defined and set
%% ----------------------------------------------------------------------------------------------------------------------------
quit all;System;DeviceTagSet;Tags
get tagSetName Connect_Tags
quit all
10.1 Desktop
add tagSetName BroadTouch_tags %ENABLE_REJECT_WITH_486_WXT% true
add tagSetName BroadTouch_tags %ENABLE_TRANSFER_CALLS_WXT% false
add tagSetName BroadTouch_tags %ENABLE_XSI_TRANSFER_CALLS_WXT% false
add tagSetName BroadTouch_tags %ENABLE_XSI_CONFERENCE_CALLS_WXT% false
add tagSetName BroadTouch_tags %ENABLE_BUSY_LAMP_FIELD_WXT% false
add tagSetName BroadTouch_tags %ENABLE_BLF_DISPLAY_CALLER_WXT% true
add tagSetName BroadTouch_tags %BLF_NOTIFICATION_DELAY_TIME_WXT% 0
add tagSetName BroadTouch_tags %ENABLE_REMOTE_CONTROL_EVENTS_WXT% false
add tagSetName BroadTouch_tags %ENABLE_CALLS_SPAM_INDICATION_WXT% false
add tagSetName BroadTouch_tags %ENABLE_NOISE_REMOVAL_WXT% false
add tagSetName BroadTouch_tags %TRANSFER_CALL_TYPE_WXT% full
add tagSetName BroadTouch_tags %ENABLE_CONFERENCE_CALLS_WXT% false
add tagSetName BroadTouch_tags %ENABLE_NWAY_PARTICIPANT_LIST_WXT% false
add tagSetName BroadTouch_tags %MAX_CONF_PARTIES_WXT% 10
add tagSetName BroadTouch_tags %ENABLE_CALL_STATISTICS_WXT% false
add tagSetName BroadTouch_tags %ENABLE_CALL_PULL_WXT% false
add tagSetName BroadTouch_tags %ENABLE_MWI_WXT% false
add tagSetName BroadTouch_tags %ENABLE_VOICE_MAIL_WXT% false
add tagSetName BroadTouch_tags %ENABLE_VISUAL_VOICE_MAIL_WXT% false
add tagSetName BroadTouch_tags %ENABLE_CALL_FORWARDING_ALWAYS_WXT% false
add tagSetName BroadTouch_tags %ENABLE_BROADWORKS_ANYWHERE_WXT% true
add tagSetName BroadTouch_tags %ENABLE_BROADWORKS_ANYWHERE_DESCRIPTION_WXT% false
add tagSetName BroadTouch_tags %ENABLE_BROADWORKS_ANYWHERE_ALERT_ALL_LOCATIONS_WXT% false
add tagSetName BroadTouch_tags %BROADWORKS_ANYWHERE_ALERT_ALL_LOCATIONS_DEFAULT_WXT% false
add tagSetName BroadTouch_tags %ENABLE_BROADWORKS_ANYWHERE_CALL_CONTROL_WXT% false
add tagSetName BroadTouch_tags %BROADWORKS_ANYWHERE_CALL_CONTROL_DEFAULT_WXT% false
add tagSetName BroadTouch_tags %ENABLE_BROADWORKS_ANYWHERE_DIVERSION_INHIBITOR_WXT% false
add tagSetName BroadTouch_tags %BROADWORKS_ANYWHERE_DIVERSION_INHIBITOR_DEFAULT_WXT% false
add tagSetName BroadTouch_tags %ENABLE_BROADWORKS_ANYWHERE_ANSWER_CONFIRMATION_WXT%
false
add tagSetName BroadTouch_tags %BROADWORKS_ANYWHERE_ANSWER_CONFIRMATION_DEFAULT_WXT%
false
add tagSetName BroadTouch_tags %ENABLE_USE_RPORT_WXT% false
add tagSetName BroadTouch_tags %RPORT_USE_LOCAL_PORT_WXT% false
add tagSetName BroadTouch_tags %USE_TLS_WXT% false
add tagSetName BroadTouch_tags %SBC_PORT_WXT% 5075
add tagSetName BroadTouch_tags %USE_PROXY_DISCOVERY_WXT% false
add tagSetName BroadTouch_tags %USE_TCP_FROM_DNS_WXT% true
add tagSetName BroadTouch_tags %USE_UDP_FROM_DNS_WXT% true
add tagSetName BroadTouch_tags %USE_TLS_FROM_DNS_WXT% true
add tagSetName BroadTouch_tags %PROXY_DISCOVERY_ENABLE_BACKUP_SERVICE_WXT% true
add tagSetName BroadTouch_tags %PROXY_DISCOVERY_ENABLE_SRV_BACKUP_WXT% true
add tagSetName BroadTouch_tags %PROXY_DISCOVERY_BYPASS_OS_CACHE_WXT% false
add tagSetName BroadTouch_tags %SIP_TRANSPORTS_TCP_CONNECT_TIMEOUT_WXT% 5000
add tagSetName BroadTouch_tags %SIP_TRANSPORTS_TLS_CONNECT_TIMEOUT_WXT% 10000
add tagSetName BroadTouch_tags %SOURCE_PORT_WXT% 5060
add tagSetName BroadTouch_tags %USE_ALTERNATIVE_IDENTITIES_WXT% false
add tagSetName BroadTouch_tags %SIP_FAILBACK_ENABLED_WXT% true
add tagSetName BroadTouch_tags %SIP_FAILBACK_TIMEOUT_WXT% 900
add tagSetName BroadTouch_tags %SIP_FAILBACK_USE_RANDOM_FACTOR_WXT% false
add tagSetName BroadTouch_tags %SIP_TRANSPORTS_ENFORCE_IP_VERSION_WXT% dns
add tagSetName BroadTouch_tags %TCP_SIZE_THRESHOLD_WXT% 18000
add tagSetName BroadTouch_tags %SIP_REFRESH_ON_TTL_WXT% false
10.2 Mobile
add tagSetName Connect_Tags %ENABLE_REJECT_WITH_486_WXT% true
add tagSetName Connect_Tags %ENABLE_TRANSFER_CALLS_WXT% false
add tagSetName Connect_Tags %ENABLE_CALLS_SPAM_INDICATION_WXT% false
add tagSetName Connect_Tags %ENABLE_NOISE_REMOVAL_WXT% false
add tagSetName Connect_Tags %TRANSFER_CALL_TYPE_WXT% full
add tagSetName Connect_Tags %ENABLE_XSI_TRANSFER_CALLS_WXT% false
add tagSetName Connect_Tags %ENABLE_CONFERENCE_CALLS_WXT% false
add tagSetName Connect_Tags %ENABLE_NWAY_PARTICIPANT_LIST_WXT% false
add tagSetName Connect_Tags %MAX_CONF_PARTIES_WXT% 10
add tagSetName Connect_Tags %ENABLE_CALL_STATISTICS_WXT% false
add tagSetName Connect_Tags %ENABLE_CALL_PULL_WXT% false
add tagSetName Connect_Tags %ENABLE_MWI_WXT% false
add tagSetName Connect_Tags %ENABLE_VOICE_MAIL_WXT% false
add tagSetName Connect_Tags %ENABLE_VISUAL_VOICE_MAIL_WXT% false
add tagSetName Connect_Tags %ENABLE_CALL_FORWARDING_ALWAYS_WXT% false
add tagSetName Connect_Tags %ENABLE_BROADWORKS_ANYWHERE_WXT% true
add tagSetName Connect_Tags %ENABLE_BROADWORKS_ANYWHERE_DESCRIPTION_WXT% false
add tagSetName Connect_Tags %ENABLE_BROADWORKS_ANYWHERE_ALERT_ALL_LOCATIONS_WXT% false
add tagSetName Connect_Tags %BROADWORKS_ANYWHERE_ALERT_ALL_LOCATIONS_DEFAULT_WXT% false
add tagSetName Connect_Tags %ENABLE_BROADWORKS_ANYWHERE_CALL_CONTROL_WXT% false
add tagSetName Connect_Tags %BROADWORKS_ANYWHERE_CALL_CONTROL_DEFAULT_WXT% false
add tagSetName Connect_Tags %ENABLE_BROADWORKS_ANYWHERE_DIVERSION_INHIBITOR_WXT% false
add tagSetName Connect_Tags %BROADWORKS_ANYWHERE_DIVERSION_INHIBITOR_DEFAULT_WXT% false
add tagSetName Connect_Tags %ENABLE_BROADWORKS_ANYWHERE_ANSWER_CONFIRMATION_WXT% false
add tagSetName Connect_Tags %BROADWORKS_ANYWHERE_ANSWER_CONFIRMATION_DEFAULT_WXT% false
add tagSetName Connect_Tags %ENABLE_USE_RPORT_WXT% false
add tagSetName Connect_Tags %RPORT_USE_LOCAL_PORT_WXT% false
add tagSetName Connect_Tags %USE_TLS_WXT% false
This section lists the acronyms and abbreviations found in this document. The acronyms and
abbreviations are listed in alphabetical order along with their meanings.
ACB Automatic Callback
ACD Automatic Call Distribution
ACR Anonymous Call Rejection
AES Advanced Encryption Standard
ALG Application Layer Gateway
API Application Programming Interface
APK Application Package
APNS Apple Push Notification Service
ARS Automatic bit Rate Selection
AS Application Server (Cisco BroadWorks)
AVP Audio Visual Profile
BW BroadWorks
BWA BroadWorks Anywhere
BWKS BroadWorks
BWM BroadWorks Mobility
BYOD Bring Your Own Device
CC Call Center
CFB Call Forwarding Busy
CFNA Call Forwarding No Answer
CFNR Call Forwarding Not Reachable
CIF Common Intermediate Format
CLI Command Line Interface
CLID Calling Line Identity
CLIDB Calling Line ID Delivery Blocking
CRLF Carriage Return Line Feed
CS Circuit-Switched
CSWV Call Settings Web View
CW Call Waiting
DB Database
DM Device Management
DND Do Not Disturb
DNS Domain Name System