Device Management System

Introduction

The Device Management System (DMS) is an HTTP or HTTPS server that delivers xml files for the OpenScape Desk Phone CP devices. The format and content is described in this document.

The xml file containing configuration and file deployment instructions is requested via a generic GET request. The server address and path can be configured on the phone. The file names are hardcoded and cannot be changed. It is either <MAC-address-of-device>_config.xml or 000000000000_config.xml. The CP phone will first try to download the MAC address specific file and in case the server responds with an HTTP error code of 404 (Not found), the CP phone will try to download the generic config file with the name 000000000000_config.xml

The MAC address of the device is also send as header in the format: "macaddress: 0a1b2c3d4d5f". Additionally, the header contains the device type name and software version information.

The OpenScape Desk Phone CP devices support HTTP digest authentication and certificate based mutual TLS authentication.

The current software version available, which supports all of the described functionality below: V1 R7.8.0 (SIP)

Changes

This section contains information about updates to this wiki page

• 2020-06-23: new DMS page is live. Updated sections: Certificates for mTLS, File name of software binds, Introduction section (HTTP and generic config file)

Set DMS address via DHCP

When an IP phone is booting, it first obtains an IP address via DHCP. The DHCP server can provide the DMS address to the phone via Option 43 or Option 66. The DMS address is mutually exclusive with a possibly provided DLS address. A phone can either connect to a DLS or DMS server. The address must begin with either http:// or https://

Option 43

DHCP vendor specific option 43 can specify a voice VLAN ID and URL of a Broadsoft DMS server. IP phones will recognize vendor specific options only, if vendor string (here: "Siemens") matches correctly. All values are given in hexadecimal numbering format. Here is a detailed description of all DHCP option 43 bytes:

Tag Len Content (Example)
01  07  5369656d656e73
02  04  00000065
03  1d  68747470733a2f2f39332E3132322E3131342E39363a3434332f646d73
ff

There are three Tags, each with an explicit length value. List if tags is delimited by a ending ff

• Tag 01 specifies the vendor (here: Siemens)
  • Tag: 01; Length: 07; Value: Siemens
• Tag 02 specifies VLAN ID of Voice VLAN (here: 101)
  • Tag: 02; Length: 04; Value: 65 (Hex)
• Tag 03 specifies IP address of Broadsoft DMS (here: 93.122.114.96:443/dms)
  • Tag: 03; Length: 1d; Value: https://93.122.114.96:443/dms (Hex)
• End of record
  • End: ff (Hex)

Providing a VLAN ID is optional and only mentioned for completeness. You can find details for configuration of a VLAN ID here: http://wiki.unify.com/wiki/VLAN_ID_Discovery_over_DHCP

Option 66

The DHCP server needs to be configured to provide the DMS server URL via Option 66. Here is a detailed description of the Option 66 bytes

Option Len Content (Example)
42     1d  68747470733a2f2f39332e3132322e3131342e39363a3434332f646d73

Compared to Option 43, Option 66 does not have specific tags. It only has a length and content field. The above example provides the following URL in the content field

• DHCP option field: 42(Hex); Length: 1d; Content: https://93.122.114.96:443/dms (Hex)

Set DMS address via menu

You can also set the URL to your DMS via the local phone menu (in case it cannot be provided via DHCP). A DHCP configured address cannot be overwritten manually. The DMS address is mutually exclusive with a possibly configured DLS address. A phone can either connect to a DLS or DMS server. The DMS server must support https, http is not supported.

Web based management

Open the web based management in a web browser window and login to the admin area of your Desk Phone CP device. Go to Network -> Update Service and provide the required URL, username and password.

Local phone menu

Press the main menu key and select Settings -> Administrator settings. Provide the admin password and afterwards select Network -> Update Service -> DMS -> Show details. Configure the required URL, username and password.

In case the provided username and password are incorrect or missing, the phone will automatically prompt the user for a new username and password.

update check interval

The update check interval defines when the device will contact the DMS server to check for updates. It's value needs to be given in seconds. On every download of the XML file, the phone generates a hash of the file and compares the new hash value with the hash from previous XML file download. The new XML file will only be parsed and applied if the hash has changed (the file has changed)

manual triggered check

The OpenScape Desk Phone CP can be triggered by the SIP server to check the configuration file. This can be done via SIP NOTIFY with Event type "check-sync". See Event header below.

 Event: check-sync

With the same NOTIFY message, the CP devices can be triggered to perform a reboot. Please see the Event header below.

 Event: check-sync;reboot=yes

Please find a SIPp scenario file, which simulates the above behavior, here: File:DMS check-sync reboot.xml

Default certificate for mutual TLS

When trying to access the DMS server or HTTPS file transfer server, the OpenScape Desk Phone CP will use a default client certificate for certificate based client verification (Mutual TLS), when the following 2 criterias are met

• there is no customer specific certificate installed on the phone for DMS or HTTPS file transfer
• the server requests a client certificate during the TLS handshake

The OpenScape Desk Phone CP device will either have a MAC address based certificate or generic default certificate installed. The public parts of both signing certificates can be found here:

  signing ca 2022

Content of config.xml file

The content of the XML file provided by the DMS server has the following schema. It can have one Action=WriteItems and one Action=SoftwareDeployment. It can have multiple sections for Action=FileDeployment.

 <?xml version="1.0" encoding="utf-8"?>
 <Message>
   <Action>WriteItems</Action>
   <ItemList>
     <Item name="ITEMNAME">VALUE</Item>
   </ItemList>
   <Action>SoftwareDeployment</Action>
   <ItemList>
     <Item name="ITEMNAME">VALUE</Item>
   </ItemList>
   <Action>FileDeployment</Action>
   <ItemList>
     <Item name="ITEMNAME">VALUE</Item>
   </ItemList>
 </Message>

Please see the chapters below for details

Action: WriteItems

This chapter is about WriteItems. WriteItems is used to send configuration items to the phone.

Generic Items

This section describes the items that can be configured on a CP device via a config.xml file.

Password related Items

Item name	Type	Details
user-pwd	String	User password for web based management and local user access.
admin-pwd	String	Admin password for web based management and local admin access.

Network related Items

Item name	Type	Details	Related WBM config item
ip-protocol-mode	Enumeration	0=IPv4 only, 1=IPv6 only, 2=Dual stack mode IPv6_IPv4	Admin -> Network -> General IP configuration -> Protocol mode
lldp-enabled	Boolean	LLDP-Med enabled. true or false	Admin -> Network -> General IP configuration -> LLDP-MED enabled
dhcp	Boolean	DHCPv4 enabled. true or false	Admin -> Network -> General IP configuration -> DHCP enabled
ipv6-dhcp-enabled	Boolean	DHCPv6 enabled. true or false	Admin -> Network -> General IP configuration -> DHCPv6 enabled
vlan-method	Enumeration	Discover VLAN via: 2=LLDP-Med, 1=DHCP, 0=manual	Admin -> Network -> General IP configuration -> VLAN discovery
vlan-id	Integer	only valid if vlan-method is set to manual	Admin -> Network -> General IP configuration -> VLAN ID
dns-domain-name	String	DNS-domain name, if not provided by DHCP server	Admin -> Network -> General IP configuration -> DNS domain
dns-server-addr	String	Primary DNS server, if not provided by DHCP server	Admin -> Network -> General IP configuration -> Primary DNS
dns-server-addr2	String	Secondary DNS server, if not provided by DHCP server	Admin -> Network -> General IP configuration -> Secondary DNS
dhcp-reuse	Boolean	DHCPv4 reuse. true or false	Admin -> Network -> IPv4 configuration -> DHCP lease reuse
ipv6-dhcp-addr-reuse	Boolean	DHCPv6 reuse. true or false	Admin -> Network -> IPv6 configuration -> DHCPv6 lease reuse
reg-port	Integer	SIP server port	Admin -> Network -> Port configuration -> SIP server
registrar-port	Integer	SIP registrar port	Admin -> Network -> Port configuration -> SIP registrar
sgnl-gateway-port-user	Integer	SIP gateway port	Admin -> Network -> Port configuration -> SIP gateway
phone-port	Integer	SIP local phone port	Admin -> Network -> Port configuration -> SIP local
rtp-base-port	Integer	RTP base port	Admin -> Network -> Port configuration -> RTP base
port1	Enumeration	LAN port speed setting. 0=Auto, 1=10/Half, 2=10/Full, 3=100/Half, 4=100/Full, 5=1000/Full	Admin -> Network -> Port configuration -> LAN port speed
port2	Enumeration	PC port speed setting. 0=Auto, 1=10/Half, 2=10/Full, 3=100/Half, 4=100/Full, 5=1000/Full	Admin -> Network -> Port configuration -> PC port speed
port2-mode	Enumeration	PC port mode. 0=Disabled, 1=Enabled, 2=Mirror	Admin -> Network -> Port configuration -> PC port mode
port2-auto-mdix-enabled	Boolean	Enable Auto-MDIX on PC port. true or false	Admin -> Network -> Port configuration -> PC port autoMDIX
ip-ttl	Enumeration	Define TTL of outgoing packets. 64 or 128	Admin -> Network -> General IP configuration -> IP Time to live
dhcp-parse-option-66	Boolean	Enable or disable parsing of DHCP option 66. true or false	Admin -> Network -> General IP configuration -> Parse DHCP option 66
reuse-dns-lookups	Boolean	Keep and reuse DNS results for SIP connections on DNS failure. true or false	Admin -> System -> SIP interface -> Keep resolved DNS records

System related Items

Item name	Type	Details	Related WBM config item
e164	String	E164 number of device	Admin -> System -> System identity -> Terminal number
display-id-unicode	String	optional ID to display on main menu screen	Admin -> System -> System identity -> Display identity
use-display-id	Boolean	Enable Display identity. true or false	Admin -> System -> System identity -> Enable ID
hostname	String	Hostname of device (DDNS)	Admin -> System -> System identity -> Terminal number
automatic-hostname-type	Enumeration	Hostname construction. 0=None, 1=Configured hostname, 2=only E164, 3=Prefix E164 with configured hostname, 4=MAC	Admin -> System -> System identity -> DNS name construction
reg-addr	String	SIP server address	Admin -> System -> Registration -> SIP server address
registrar-addr	String	SIP registrar address	Admin -> System -> Registration -> SIP registrar address
sgnl-gateway-addr-user	String	SIP gateway address	Admin -> System -> Registration -> SIP gateway address
session-timer	Boolean	Enable SIP session timer. true or false	Admin -> System -> Registration -> Session timer enabled
session-duration	Integer	Session refresh after seconds. Depends on session timer	Admin -> System -> Registration -> Session duration (seconds)
reg-ttl	Integer	Registration timer (seconds)	Admin -> System -> Registration -> Registration timer (seconds)
refresh-guard-time	Integer	Seconds (earliest) for when a re-registration or re-subscription will occur.	Admin -> System -> Registration -> Refresh timer (seconds)
server-type	Enumeration	SIP server type. 0=Other, 1=OpenScape Voice, 2=Broadsoft	Admin -> System -> Registration -> Server type
realm	String	SIP realm for digest authentication	Admin -> System -> Registration -> Realm
sip-user-id	String	SIP username for digest authentication	Admin -> System -> Registration -> User ID
sip-pwd	String	SIP password for digest authentication	Admin -> System -> Registration -> Password
outbound-proxy-user	Boolean	Enable SIP gateway. true or false	Admin -> System -> SIP interface -> Outbound proxy
sip-transport-user	Enumeration	SIP transport type. 0=UDP, 1=TCP, 2=TLS	Admin -> System -> SIP interface -> SIP transport
failover-on	Enumeration	DNS-SRV failover on timeout only or timeout & error. 0=timeout only, 1=timeout & error	Admin -> System -> SIP interface -> Failover on
event-check-sync	Enumeration	Handle check-sync event messages. 0=disabled, 1=challenge, 2=no challenge	Admin -> System -> SIP interface -> Event check-sync
transaction-timer	Integer	Transaction timer for call related SIP messages (milliseconds)	Admin -> System -> SIP interface -> Call transaction response timer (ms)
transaction-timer-f	Integer	Transaction timer for non call related SIP messages (milliseconds)	Admin -> System -> SIP interface -> NonCall transaction response timer (ms)
registration-backoff-timer	Integer	Backoff timer for Registration issues (seconds)	Admin -> System -> SIP interface -> Reg. backoff (seconds)
voip-connectivity-check-interval	Integer	Connectivity check intervall (seconds )for TCP and TLS	Admin -> System -> SIP interface -> Connectivity check timer (seconds)
media-negotiation-mode	Enumeration	Media negotiation. 0=Single IP, 1=ANAT, 2=ICE	Admin -> System -> SIP interface -> Media negotiation
sip-media-IP-mode	Enumeration	SIP media IP mode. 0=IPv4, 1=IPv6, 2=IPv4_IPv6, 3=IPv6_IPv4	Admin -> System -> SIP interface -> Media IP mode
reuse-dns-lookups	Boolean	Reuse previously resolved DNS records on DNS failure. true or false	Admin -> System -> SIP interface -> Keep resolved DNS records
prefer-from-header-displayname	Boolean	Prefer FROM header over PAI header for display name. true or false	Admin -> System -> SIP interface -> Prefer FROM header for display name
dnssrv-fallback-on-re-registration	Boolean	Only try blacklisted servers when doing a re-registration. true or false	Admin -> System -> SIP interface -> DNS-SRV fallback on re-registration
indicate-support-100rel	Boolean	Indicate support for provisional responses (PRACK). true or false	Admin -> System -> SIP interface -> Support provisional response (PRACK)
all-codecs-in-sdp-answer	Boolean	Send all supported codecs in SDP answer. true or false	Admin -> System -> SIP interface -> Send all codecs in SDP answer
backup-registration	Boolean	Enable or Disable backup registration. true or false	Admin -> System -> Registration -> SIP survivability -> Backup registration allowed
backup-addr	String	SIP backup server address	Admin -> System -> Registration -> SIP survivability -> Backup proxy address
backup-port	Integer	Backup Server port	Admin -> Network -> Port number configuration -> Backup proxy
backup-reg-timer	Integer	Backup Server registration timer (seconds)	Admin -> System -> Registration -> SIP survivability -> Backup registration timer (seconds)
backup-transport	Enumeration	SIP Backup server transport type. 0=UDP, 1=TCP, 2=TLS	Admin -> System -> Registration -> SIP survivability -> Backup transport

Feature related Items

Item name	Type	Details	Related WBM config item
emergency-e164	String	Emergency E164 number	Admin -> System -> Features -> Configuration -> Emergency number
voice-mail-e164	String	Voicemail number	Admin -> System -> Features -> Configuration -> Voice mail number
uaCSTA-enabled	Boolean	Enable uaCSTA. true or false	Admin -> System -> Features -> Configuration -> Allow uaCSTA
server-based-features	Boolean	Enable server-based features. true or false	Admin -> System -> Features -> Configuration -> Server features
enable-bluetooth-interface	Boolean	Enable Bluetooth interface on CP600. true or false	Admin -> System -> Features -> Configuration -> Enable bluetooth interface
call-record-phone-number	String	Call recording number	Admin -> System -> Features -> Configuration -> Recorder address
call-record-auto-start	Boolean	Automatically start recording. true or falls	Admin -> System -> Features -> Configuration -> Recording mode
call-record-all-calls	Boolean	Record all calls. true or falls	Admin -> System -> Features -> Configuration -> Recording mode
call-record-audible-indication	Boolean	Audible indication of recording. true or false	Admin -> System -> Features -> Configuration -> Audible notification
call-record-audible-indication-continuous	Boolean	Repeat audible indication of recording. true or false	Admin -> System -> Features -> Configuration -> Audible notification
presence-CF-types	Enumeration	Show forwarding forwarding controls in the presence menu. 0=only unconditional,1=all forwarding types	User -> Phone -> Presence Screen -> Forwarding types
show-icon-for-all-forwarding-types	Boolean	Show forwarding icon and LED status for all forwarding types. true or false	Admin -> System -> Features -> Configuration -> Show icon for all forwarding types
line-rollover-type	Enumeration	Audible notification of rollover calls. 0="no ring", 1="alert ring", 2="standard ring", 3="alert beep"	Admin -> System -> Features -> Keyset operation-> Rollover ring
mwi-e164	String	Message waiting server URI	Admin -> System -> Features -> Addressing -> MW server URI
conference-factory-uri	String	Server based conference URI	Admin -> System -> Features -> Addressing -> Conference
used-translation-set	Enumeration	Use default or Telefonica specific translations. 0=default, 1=Telefonica specific	Admin -> Local Functions -> Call logging -> Translation set
fpk-limited-feature-set	Enumeration	Use default or Telefonica specific FPK programming feature options. 0="No limitation", 1="Only selected dialling"	Admin -> System -> Features -> Feature Access -> Services
originating-line-preference	Enumeration	Preference for automatic line selection. 0=idle (default), 1=primary, 2=last, 3=none	Admin -> System -> Features -> Keyset operation
fpk-long-press-timer	Enumeration	Enter program mode for FPKs on long press. 0=Off, 2=On	Admin -> System -> Features -> Configuration

QoS related items

Item name	Type	Details	Related WBM config item
qos-layer2	Boolean	Enable QoS layer 2 tagging of packets	Admin -> Network -> QoS
l2qos-default	Integer	Set the L2 tag for all packets except signalling and voice (values: 0-7)	Admin -> Network -> QoS
l2qos-signalling	Integer	Set the L2 tag for all SIP signalling packets (values: 0-7)	Admin -> Network -> QoS
l2qos-voice	Integer	Set the L2 tag for all RTP voice packets (values: 0-7)	Admin -> Network -> QoS
qos-layer3	Boolean	Enable QoS layer 3 tagging of packets	Admin -> Network -> QoS
l3qos-signalling	Enumeration	Set the L3 tag for all SIP signalling packets (values: see table below)	Admin -> Network -> QoS
l3qos-voice	Enumeration	Set the L3 tag for all RTP voice packets (values: see table below)	Admin -> Network -> QoS

Enumeration	L3 QoS value
0	BE
10	AF11
12	AF12
14	AF13
18	AF21
20	AF22
22	AF23
24	CS3
26	AF31
28	AF32
30	AF33
32	CS4
34	AF41
36	AF42
38	AF43
40	CS5
46	EF
56	CS7

Xtended Service Interface

The following section describes the settings for accessing the Broadsoft Xtended Service Interface (XSI)

 <Item name="bw-xsi-addr">https://xsp.iop1.broadworks.net</Item>
 <Item name="bw-xsi-sipauthentication">false</Item>
 <Item name="bw-xsi-username">username@broadworks.net</Item>
 <Item name="bw-xsi-password">123456</Item>
 <Item name="bw-ccl-enable">true</Item>
 <Item name="bw-cgdirectory-enable">true</Item>
 <Item name="bw-cgdirectory-name">Group Directory</Item>
 <Item name="bw-cedirectory-enable">true</Item>
 <Item name="bw-cedirectory-name">Enterprise Directory</Item>
 <Item name="bw-cgcdirectory-enable">true</Item>
 <Item name="bw-cgcdirectory-name">Group Common Directory</Item>
 <Item name="bw-cecdirectory-enable">true</Item>
 <Item name="bw-cecdirectory-name">Enterprise Common Directory</Item>
 <Item name="bw-cpdirectory-enable">true</Item>
 <Item name="bw-cpdirectory-name">Personal Directory</Item>

Item name	Type	Details	Related WBM config item
bw-xsi-addr	String	IP address or FQDN of XSI server	Admin -> Local functions -> XSI access
bw-xsi-sipauthentication	Boolean	Enable SIP credentials based authentication. true or false	Admin -> Local functions -> XSI access
bw-xsi-username	String	Username for XSI access	Admin -> Local functions -> XSI access
bw-xsi-password	String	Password for XSI access. Required if bw-xsi-sipauthentication is set to false	Admin -> Local functions -> XSI access
bw-ccl-enable	Boolean	Enable centralised call log. true or false	Admin -> Local functions -> Call logging
bw-cgdirectory-enable	Boolean	Enable Group Directory via XSI. true or false	Admin -> Local functions -> Network directories
bw-cgdirectory-name	String	Name for Group Directory to be used on the CP phone	Admin -> Local functions -> Network directories
bw-cedirectory-enable	Boolean	Enable Enterprise Directory via XSI. true or false	Admin -> Local functions -> Network directories
bw-cedirectory-name	String	Name for Enterprise Directory to be used on the CP phone	Admin -> Local functions -> Network directories
bw-cgcdirectory-enable	Boolean	Enable Group Common Directory via XSI. true or false	Admin -> Local functions -> Network directories
bw-cgcdirectory-name	String	Name for Group Common Directory to be used on the CP phone	Admin -> Local functions -> Network directories
bw-cecdirectory-enable	Boolean	Enable Enterprise Common Directory via XSI. true or false	Admin -> Local functions -> Network directories
bw-cecdirectory-name	String	Name for Enterprise Common Directory to be used on the CP phone	Admin -> Local functions -> Network directories
bw-cpdirectory-enable	Boolean	Enable Personal Directory via XSI. true or false	Admin -> Local functions -> Network directories
bw-cpdirectory-name	String	Name for Personal Directory to be used on the CP phone	Admin -> Local functions -> Network directories

RingCentral API sync

The following section describes the settings for accessing the RingCentral API for synching user related data

 <Item name="ringcentral-api-server-address">https://some-server.domain.tld:30443</Item>
 <Item name="ringcentral-api-sync-call-log">true</Item>
 <Item name="ringcentral-api-sync-phonebook">true</Item>
 <Item name="ringcentral-api-sync-interval">3600</Item>

Item name	Type	Details	Related WBM config item
ringcentral-api-server-address	String	IP address or FQDN of RingCentral API server	Admin -> Local functions -> RingCentral API
ringcentral-api-sync-call-log	Boolean	Enable call log synching. true or false	Admin -> Local functions -> RingCentral API
ringcentral-api-sync-phonebook	Boolean	Enable phonebook synching. true or false	Admin -> Local functions -> RingCentral API
ringcentral-api-sync-interval	Integer	Interval between 2 syncs if there is no event that requires to sync either phonebook or call log data. Default: 60s, Range: 30-3600s	Admin -> Local functions -> RingCentral API

Device Management System

The following section describes the settings for accessing the Device Management System (DMS)

 <Item name="bw-dms-addr">https://xsp.iop1.broadworks.net/DMS/</Item>
 <Item name="bw-dms-addr-runtime">https://xsp.iop1.broadworks.net/DMS/</Item>
 <Item name="bw-dms-username">username</Item>
 <Item name="bw-dms-password">password</Item>
 <Item name="bw-dms-contact-interval">300</Item>
 <Item name="bw-dms-sync-during-working-hours">true</Item>
 <Item name="memory-monitor-working-hour-start">6</Item>
 <Item name="memory-monitor-working-hour-end">22</Item>

Item name	Type	Details	Related WBM config item
bw-dms-addr	String	IP address or FQDN of DMS server	Admin -> Network -> Update Service
bw-dms-addr-runtime	String	IP address or FQDN of DMS server that should be used during runtime	N/A
bw-dms-username	String	Username for DMS access	Admin -> Network -> Update Service
bw-dms-password	String	Password for DMS access	Admin -> Network -> Update Service
bw-dms-contact-interval	Integer	Contact interval (seconds) for polling the DMS server	Admin -> Network -> Update Service
bw-dms-sync-during-working-hours	Boolean	Allow the device to poll the DMS server during defined working hours. (true/false)	Admin -> Network -> Update Service
memory-monitor-working-hour-start	Enumeration	Define begin of working hours. (1-24)	Admin -> Diagnostics -> Miscellaneous -> Memory Information
memory-monitor-working-hour-end	Enumeration	Define end of working hours. (1-24)	Admin -> Diagnostics -> Miscellaneous -> Memory Information

DMS mutual authentication

The following section describes the settings for establishing a mutual TLS connection with the Broadsoft DMS server

 <Item name="bw-dms-server-ca" index="0">-----BEGIN CERTIFICATE-----
 MIIGITCCBAmgAwIBAgIBATANBgkqhkiG9w0BAQsFADBoMQ4wDAYDVQQKEwVVbmlm
 eTESMBAGA1UECxMJUEggR1ZTIERFMRkwFwYDVQQDDBBHVlNfQ09MT0dORV9ST09U
 ...
 p5Sx/AWWcaTKmLbMcNYTwzVu5qHZ4kp/xfhIW/LgWQSVw1husA==
 -----END CERTIFICATE-----</Item>
 <Item name="bw-dms-server-ca" index="1">-----BEGIN CERTIFICATE-----
 MIIGITCCBAmgAwIBAgIBATANBgkqhkiG9w0BAQsFADBoMQ4wDAYDVQQKEwVVbmlm
 eTESMBAGA1UECxMJUEggR1ZTIERFMRkwFwYDVQQDDBBHVlNfQ09MT0dORV9ST09U
 ...
 p5Sx/AWWcaTKmLbMcNYTwzVu5qHZ4kp/xfhIW/LgWQSVw1husA==
 -----END CERTIFICATE-----</Item>
 <Item name="bw-dms-authentication-policy">2</Item>
 <Item name="bw-dms-client-certificate">MIIQngIBAzCCEGgGCSqGSIb3DQEHAaCCEFkEghBVMIIQU...</Item>

Item name	Index	Type	Details	Related WBM config item
bw-dms-server-ca	Index 0,1	text	BASE64 encoded root certificate	not a WBM config item
bw-dms-authentication-policy	---	Enumeration	Authentication policy for the DMS server connection. 0=none, 1=trusted, 2=full	Admin -> Security & Policy -> Authentication Policy
bw-dms-client-certificate	---	text	BASE64 encoded PKCS12 file. PKCS12 file must have a password of "cum-sek-ewa-bss"	not a WBM config item

In order to perform mutual authentication on the DMS connection, a root certificate must be installed as index=0 or index=1. The authentication-policy for DMS must be set to trusted or full. The client certificate (including the private key) must be provided in a PKCS12 container. The container password must be set to "cum-sek-ewa-bss". The PKCS12 container will be BASE64 encoded and added to the XML config file.

BLF resource list subscription

The following section describes the settings for Broadsoft BLF resource list subscription settings. Please keep in mind that for every resource in the resource list, a seperate BLF key is required.

 <Item name="blf-resource-uri">user-a1</Item>
 <Item name="blf-code">*97</Item>

Item name	Type	Details	Related WBM config item
blf-resource-uri	String	user part of the URI for subscribing to the resource list	Admin -> System -> Features -> Addressing
blf-code	String	BLF pickup code. Required to pickup calls alerting at BLF resources	Admin -> System -> Features -> Addressing

Date&Time Settings

The following section describes the settings for Date&Time on the phone

 <Item name="sntp-addr">0.pool.ntp.org</Item>
 <Item name="sntp-tz-offset">60</Item>
 <Item name="daylight-save">true</Item>
 <Item name="daylight-save-minutes">60</Item>
 <Item name="auto-daylight-save">true</Item>
 <Item name="daylight-save-zone-id">9</Item>

Item name	Type	Details	Related WBM config item
sntp-addr	String	IP address or FQDN of NTP server	Admin -> Date and Time -> SNTP primary
sntp-tz-offset	Integer	Offset in minutes of desired timezone	Admin -> Date and Time -> Timezone offset
daylight-save	Boolean	Enable daylight saving. true or false	Admin -> Date and Time -> Daylight saving
daylight-save-minutes	Integer	Offset in minutes when changing from/to daylight saving	Admin -> Date and Time -> Difference
auto-daylight-save	Boolean	Automatically change from/to daylight saving. true or false	Admin -> Date and Time -> Auto time change
daylight-save-zone-id	Enumeration	Daylight saving zone	Admin -> Date and Time -> DST zone

A list of possible values for Enumeration "daylight-save-zone-id"

• 0=Not set
• 1=Australia 2007 (ACT, South Australia, Tasmania, Victoria)
• 2=Australia 2007 (New South Wales)
• 3=Australia (Western Australia)
• 4=Australia 2008+ (ACT, New South Wales, South Australia, Tasmania, Victora)
• 5=Brazil
• 6=Canada
• 7=Canada (Newfoundland)
• 8=Europe (Portugal, United Kingdom)
• 9=Europe (Rest)
• 10=Europe (Finland)
• 11=Mexico
• 12=United States
• 13=New Zealand
• 14=New Zealand (Chatham)

Audio Codec Settings

Audio codecs require a special handling inside the config.xml file as they need to be send as a complete group. Example file below:

 <Item name="codec-type" index="1">0</Item>
 <Item name="codec-type" index="2">1</Item>
 <Item name="codec-type" index="3">2</Item>
 <Item name="codec-type" index="4">3</Item>
 <Item name="codec-allowed" index="1">true</Item>
 <Item name="codec-allowed" index="2">true</Item>
 <Item name="codec-allowed" index="3">true</Item>
 <Item name="codec-allowed" index="4">true</Item>
 <Item name="codec-packet-size" index="1">2</Item>
 <Item name="codec-packet-size" index="2">2</Item>
 <Item name="codec-packet-size" index="3">2</Item>
 <Item name="codec-packet-size" index="4">2</Item>
 <Item name="codec-rank" index="1">1</Item>
 <Item name="codec-rank" index="2">2</Item>
 <Item name="codec-rank" index="3">3</Item>
 <Item name="codec-rank" index="4">4</Item>
 <Item name="audio-silence-suppression">false</Item>
 <Item name="opus-max-bandwidth">0</Item>
 <Item name="opus-bitrate-type">0</Item>

Item name	Item index	Type	Details
codec-type	1,2,3 or 4	Enumeration	0=G.711, 1=G.722, 2=G.729, 3=OPUS
codec-allowed	1,2,3 or 4	Boolean	Enables codec referred to by index value. true or false
codec-packet-size	1,2,3 or 4	Enumeration	Packet size for codec referred to by index value. 0=10ms, 1=20ms, 2=Automatic, 3=30ms, 4=60ms, 5=40ms
codec-rank	1,2,3 or 4	Enumeration	Set codec rank in SDP negotiation. 1=1st preference, 2=2nd preference, 3=3rd preference
audio-silence-suppression	no index	Boolean	Enables silence supression. true or false
opus-max-bandwidth	no index	Enumeration	Set the max bandwidth for OPUS codec. 0=narrowband, 1=wideband
opus-bitrate-type	no index	Enumeration	Set the bitrate for OPUS codec. 0=VBR, 1=CBR

LDAP Settings

The below section describes the settings required to use the LDAP Server for searching of contacts

 <Item name="ldap-server-address">1.2.3.4</Item>
 <Item name="ldap-transport">1</Item> 
 <Item name="ldap-server-port">389</Item>
 <Item name="ldap-encrypted-port">636</Item>
 <Item name="ldap-authentication">1</Item> 
 <Item name="ldap-user">cn=read,dc=users,dc=company,dc=com</Item>
 <Item name="ldap-pwd">phonebook</Item>
 <Item name="ldap-avatar-server">1.2.3.4</Item>
 <Item name="ldap-manual-search-only">false</Item>
 <Item name="ldap-search-firstname-and-lastname">false</Item>
 <Item name="ldap-attrib" index="0">dc=users,dc=company,dc=com</Item>
 <Item name="ldap-attrib" index="1">sn</Item>
 <Item name="ldap-attrib" index="2">givenName</Item>
 <Item name="ldap-attrib" index="3">telephoneNumber</Item>
 <Item name="ldap-attrib" index="4">otherTelephone</Item>
 <Item name="ldap-attrib" index="5">mobile</Item>
 <Item name="ldap-attrib" index="6">homePhone</Item>
 <Item name="ldap-attrib" index="7">company</Item>
 <Item name="ldap-attrib" index="8">department</Item>
 <Item name="ldap-attrib" index="9">l</Item>
 <Item name="ldap-attrib" index="10">title</Item>
 <Item name="ldap-attrib" index="11">mail</Item>
 <Item name="ldap-attrib" index="12">sn</Item>
 <Item name="ldap-attrib" index="13">picture</Item>

Item name	Item index	Type	Details
ldap-server-address	---	String	The IP address or FQDN of the LDAP server.
ldap-transport	---	Enumeration	Transport type of LDAP server connection. 0=TCP, 1=TLS
ldap-server-port	---	Integer	The LDAP server port for TCP connections.
ldap-encrypted-port	---	Integer	The LDAP server port for TLS connections
ldap-authentication	---	Enumeration	The authentication type on connecting to the LDAP server. 0=Anonymous, 1=Simple
ldap-user	---	String	The username for simple authentication
ldap-pwd	---	String	The password for simple authentication
ldap-avatar-server	---	String	The IP address or FQDN of the avatar picture server.
ldap-manual-search-only	---	Boolean	Allow or disallow the automatic LDAP lookup and only allow manual search by the user.
ldap-search-firstname-and-lastname	---	Boolean	When using the quick search, use the search string to search for first- and lastname.
ldap-attrib	0	String	The search base for LDAP queries.
ldap-attrib	1	String	The matching attribute of internal phonebook item lastname
ldap-attrib	2	String	The matching attribute of internal phonebook item firstname
ldap-attrib	3	String	The matching attribute of internal phonebook item office 1 phone
ldap-attrib	4	String	The matching attribute of internal phonebook item office 2 phone
ldap-attrib	5	String	The matching attribute of internal phonebook item mobile phone
ldap-attrib	6	String	The matching attribute of internal phonebook item home phone
ldap-attrib	7	String	The matching attribute of internal phonebook item company name
ldap-attrib	8	String	The matching attribute of internal phonebook item address 1
ldap-attrib	9	String	The matching attribute of internal phonebook item address 2
ldap-attrib	10	String	The matching attribute of internal phonebook item role
ldap-attrib	11	String	The matching attribute of internal phonebook item E-mail
ldap-attrib	12	String	The attribute that shall be used for searching (nickname feature). Only CP400, CP600 and CP600E
ldap-attrib	13	String	The matching attribute of the contacts avatar picture (CP600, CP600E)

FPK programming

In order to program a free programmable key (FPK) via DMS, you need to take the phone type into account. The phone type defines the amount of keys you can program.

• 60 keys on CP700/CP700X (with 4 Key modules attached, 4 times 12 keys on the key modules, and the permanent favorites menu)
• 60 keys on CP600/CP600E (with 4 Key modules attached, 4 times 12 keys on the key modules, and the permanent favorites menu)
• 48 keys on CP400 (with 2 Key modules attached. 16 keys on the base device, 2 times 16 keys on the key modules)
• 4 keys on CP200/CP205 (all on the base device)
• 3 keys on CP100 (all on the base device)
  • CP100/CP200/CP205 have a special functionality to directly access the second level functionality on the free programmable keys.

First you need the key index where the functionality will be put on. The values below are valid for Desk Phone CP models running V1 R2 (or newer) software

Phone type	Permanent Favorites CP600	Permanent Favorites CP700		Index base device (normal/shift)		Index Key module 1 (normal/shift)		Index Key module 2 (normal/shift)		Index Key module 3 (normal/shift)		Index Key module 4 (normal/shift)		Fixed Key CP700/CP700X
CP700X	not available	1-12	1001-1012	1-12	1001-1012	301-312	1301-1312	401-412	1401-1412	701-712	1701-1712	801-812	1801-1812	4003
CP700	not available	1-12	1001-1012	1-12	1001-1012	301-312	1301-1312	401-412	1401-1412	not available				4003
CP600/CP600E	901-912	not available		1-12	1001-1012	1-12	1001-1012	301-312	1301-1312	401-412	1401-1412	701-712	1701-1712	not availale
CP400	not available	not available		1-16	1001-1016	301-316	1301-1316	401-416	1401-1416	not available
CP200/CP205	not available	not available		601-604	1601-1604	not available
CP100	not available	not available		601-603	1601-1603	not available

Remember the index number of the FPK, where you want to configure a function. We will use index "1" in the following examples.

Shared call appearance

 <Item name="function-key-def" index="1">31</Item>
 <Item name="key-label-unicode" index="1">Bob Smith</Item>
 <Item name="line-primary" index="1">true</Item>
 <Item name="line-shared-type" index="1">0</Item>
 <Item name="line-sip-uri" index="1">2405551111_1</Item>
 <Item name="line-sip-user-id" index="1">bobsmith</Item>
 <Item name="line-sip-pwd" index="1">bobs</Item>
 <Item name="line-sip-realm" index="1">realm</Item>
 <Item name="line-ring" index="1">true</Item>
 <Item name="line-ring-delay" index="1">0</Item>

Item name	Item index	Type	Details
function-key-def	1	Enumeration	31=shared call appearance
key-label-unicode	1	String	Key label visible on phone
line-primary	1	Boolean	This line is the primary line (only required for own line). true or false
line-shared-type	1	Enumeration	0=shared, 1=private
line-sip-uri	1	String	E164 number of this specific line
line-sip-user-id	1	String	SIP username for digest authentication
line-sip-pwd	1	String	SIP password for digest authentication
line-sip-realm	1	String	SIP realm for digest authentication
line-ring	1	Boolean	Enables ringing on this line. true or false
line-ring-delay	1	Integer	Make this line ring with delay of defined value in seconds

Multiple Call Arrangement

The configuration is similar to the Shared Call Appearance configuration. You need one line configured as primary line.

 <Item name="function-key-def" index="1">31</Item>
 <Item name="key-label-unicode" index="1">Line 1</Item>
 <Item name="line-primary" index="1">true</Item>
 <Item name="line-shared-type" index="1">0</Item>
 <Item name="line-sip-uri" index="1">2405551111</Item>
 <Item name="line-sip-user-id" index="1">bobsmith</Item>
 <Item name="line-sip-pwd" index="1">bobs</Item>
 <Item name="line-sip-realm" index="1">realm</Item>
 <Item name="line-ring" index="1">true</Item>
 <Item name="line-ring-delay" index="1">0</Item>

You can have up to 5 secondary lines with the same E164 number configured. Digest authentication is required on the primary line only.

 <Item name="function-key-def" index="2">31</Item>
 <Item name="key-label-unicode" index="2">Line 2</Item>
 <Item name="line-primary" index="2">false</Item>
 <Item name="line-sip-uri" index="2">2405551111</Item>
 <Item name="line-ring" index="2">true</Item>
 <Item name="line-ring-delay" index="2">0</Item>

 <Item name="function-key-def" index="3">31</Item>
 <Item name="key-label-unicode" index="3">Line 3</Item>
 <Item name="line-primary" index="3">false</Item>
 <Item name="line-sip-uri" index="3">2405551111</Item>
 <Item name="line-ring" index="3">true</Item>
 <Item name="line-ring-delay" index="3">0</Item>

Item name	Item index	Type	Details
function-key-def	1	Enumeration	31=shared call appearance
key-label-unicode	1	String	Key label visible on phone
line-primary	1	Boolean	This line is the primary line (only required for own line). true or false
line-sip-uri	1	String	E164 number of this specific line
line-sip-user-id	1	String	SIP username for digest authentication
line-sip-pwd	1	String	SIP password for digest authentication
line-sip-realm	1	String	SIP realm for digest authentication
line-ring	1	Boolean	Enables ringing on this line. true or false
line-ring-delay	1	Integer	Make this line ring with delay of defined value in seconds

Multiuser

The configuration is similar to the Shared Call Appearance configuration. You need one line configured as primary line. The primary line will use the existing main configuration for XSI connection.

 <Item name="function-key-def" index="1">31</Item>
 <Item name="key-label-unicode" index="1">Line 1</Item>
 <Item name="line-primary" index="1">true</Item>
 <Item name="line-shared-type" index="1">0</Item>
 <Item name="line-sip-uri" index="1">2405551111</Item>
 <Item name="line-sip-user-id" index="1">bobsmith</Item>
 <Item name="line-sip-pwd" index="1">bobs</Item>
 <Item name="line-sip-realm" index="1">realm</Item>
 <Item name="line-ring" index="1">true</Item>
 <Item name="line-ring-delay" index="1">0</Item>

Additional line keys for separate users are configured in a similar way, except they must have the line share type set to private and (of cause) must not be a primary line

 <Item name="function-key-def" index="2">31</Item>
 <Item name="key-label-unicode" index="2">Line 2</Item>
 <Item name="line-primary" index="2">false</Item>
 <Item name="line-shared-type" index="2">1</Item>
 <Item name="line-sip-uri" index="2">2405552222</Item>
 <Item name="line-sip-user-id" index="2">markdoe</Item>
 <Item name="line-sip-pwd" index="2">markd</Item>
 <Item name="line-sip-realm" index="2">realm</Item>
 <Item name="line-ring" index="2">true</Item>
 <Item name="line-ring-delay" index="2">0</Item>

Every separate line can have its own XSI username by adding the following item to the configuration

 <Item name="line-xsi-username" index="2">markdoe@company.com</Item>

Item name	Item index	Type	Details
line-xsi-username	1	String	Username for XSI login. Line SIP username and passwort will be used for authentication

Additional required configuration in order to use the multiuser feature.

 <Item name="server-based-features">true</Item>
 <Item name="originating-line-preference">1</Item>

One additional optional configuration parameter controls if switching between users is done via long press or 2 short key presses on the line key

 <Item name="fpk-long-press-timer">0</Item>

Please see details for the configuration items above

Busy Lamp Field (BLF)

 <Item name="function-key-def" index="1">59</Item>
 <Item name="key-label-unicode" index="1">Bob Smith</Item>
 <Item name="blf-audible" index="1">true</Item>
 <Item name="blf-popup" index="1">true</Item>
 <Item name="stimulus-led-control-uri" index="1">user-a2</Item>

Item name	Item index	Type	Details
function-key-def	1	Enumeration	59=BLF
key-label-unicode	1	String	Key label visible on phone
blf-audible	1	Boolean	Get audible alert on incoming calls. true or false
blf-popup	1	Boolean	Get popup on incoming calls. true or false
stimulus-led-control-uri	1	String	User ID of resource that is part of the BLF resource list

Generic BLF related config items will allow to configure the behaviour of all BLF keys

 <Item name="blf-tone-type">0</Item>

Item name	Type	Details
blf-tone-type	Enumeration	Set the type of tone for an alerting BLF key. 0=beep, 1=ring burst, 2=ring continuous

Broadsoft Call Center

 <Item name="function-key-def" index="1">43</Item>
 <Item name="key-label-unicode" index="1">Agent Logon</Item>
 <Item name="xsi-call-center-name" index="1">my_call_center</Item>
 <Item name="xsi-call-center-related-line" index="1">7</Item>

Item name	Item index	Type	Details
function-key-def	1	Enumeration	43=Broadsoft Call Center
key-label-unicode	1	String	Key label visible on phone
xsi-call-center-name	1	String	Name of the call center the agent can logon or logoff
xsi-call-center-related-line	1	String	Index of the line key configured that should be used to authenticate with the server for Agent Logon/Logoff

Selected dialling

 <Item name="function-key-def" index="1">1</Item>
 <Item name="key-label-unicode" index="1">Selected Dial</Item>
 <Item name="select-dial" index="1">12345</Item>

Item name	Item index	Type	Details
function-key-def	1	Enumeration	1=selected dialling
key-label-unicode	1	String	Key label visible on phone
select-dial	1	String	dialling target

Forwarding

 <Item name="function-key-def" index="1">6</Item>
 <Item name="key-label-unicode" index="1">Forward unconditional</Item>
 <Item name="forwarding-type" index="1">0</Item>
 <Item name="forwarding-dest" index="1">123456</Item>

Item name	Item index	Type	Details
function-key-def	1	Enumeration	6=forward unconditional
key-label-unicode	1	String	Key label visible on phone
forwarding-type	1	Enumeration	Type of forwarding. 0=unconditional, 1=no reply, 2=busy

Send URL

Please see http://wiki.unify.com/wiki/Send_URL for details about this functionality

 <Item name="function-key-def" index="1">63</Item>
 <Item name="key-label-unicode" index="1">Send URL</Item>
 <Item name="send-url-address" index="1">some-address-or-ip.com</Item>
 <Item name="send-url-protocol" index="1">0</Item>
 <Item name="send-url-port" index="1">443</Item>
 <Item name="send-url-path" index="1">/some/path/on/server</Item>
 <Item name="send-url-query" index="1">paramA=1&paramB=2&paramC=3</Item>
 <Item name="send-url-method" index="1">1</Item>
 <Item name="send-url-user-id" index="1">username</Item>
 <Item name="send-url-passwd" index="1">password</Item>
 <Item name="send-url-push-support" index="1">true</Item>
 <Item name="send-url-symbolic-name" index="1">SymbolicName</Item>

Item name	Item index	Type	Details
function-key-def	1	Enumeration	63=Send URL
key-label-unicode	1	String	Key label visible on phone
send-url-address	1	String	Send URL server address
send-url-protocol	1	Enumeration	Protocol to use. 0=HTTPS, 3=HTTP
send-url-port	1	String	Send URL server port
send-url-path	1	String	Send URL server path to send request
send-url-query	1	String	Parameters send in the query
send-url-method	1	Enumeration	HTTP method to use for request. 0=GET, 1=POST
send-url-user-id	1	String	Username for accessing Send URL server. Sent as parameter in request
send-url-passwd	1	String	Password for accessing Send URL server. Sent as parameter in request
send-url-push-support	1	Boolean	Enable push support for this Send URL key
send-url-symbolic-name	1	String	Send URL symbolic name. Required for push support

Repertory Dial

Repertory Dial key is similar to a selected dial key, with the following special functionality

• $Q -> Release (WBM symbol=<)
• $R -> Consult (WBM symbol=~)
• $S -> Okay (WBM symbol=>)
• $T -> Pause (WBM symbol=-)

 <Item name="function-key-def" index="1">30</Item>
 <Item name="key-label-unicode" index="1">Repertory Dial</Item>
 <Item name="repertory-dial" index="1">55555$S$T1234#</Item>

Item name	Item index	Type	Details
function-key-def	1	Enumeration	30=repertory dialling
key-label-unicode	1	String	Key label visible on phone
repertory-dial	1	String	Repertory dial string

Generic FPKs

 <Item name="function-key-def" index="1">nn</Item>
 <Item name="key-label-unicode" index="1">Key label text</Item>

Item name	Item index	Type	Details
function-key-def	1	Enumeration	nn=number defining the key functionality
key-label-unicode	1	String	Key label visible on phone

Below you can find a list of possible values for item "function-key-def" and the corresponding functionality

Enumeration	Functionality
0	No function (default)
3	Redial
9	Ringer off
10	Hold
11	Alternate
12	Blind transfer
13	Transfer
18	Shift
22	Conference
25	Do not disturb
29	Group pickup
43	Broadsoft Call Center
45	Directed pickup
46	Release call
48	Callback
49	Cancel callback
50	Consultation
53	Call waiting
56	Call recording
64	Built in forwarding
74	Call log
75	Directory

Feature access settings

The phone allows to restrict access to specifc features for the user. This section will show the relevant Items to configure if you want the user to not have access to a specific functionality.

 <Item name="agent-feature-enabled">false</Item>
 <Item name="enable-bluetooth-interface">false</Item>
 <Item name="enable-WBM">false</Item>
 <Item name="pb-lookups-allowed">false</Item>
 <Item name="refuse-call">false</Item>
 <Item name="callback-busy-allow">false</Item>
 <Item name="allow-user-access-to-diagnostic-data">false</Item>
 <Item name="group-pickup-allowed">false</Item>
 <Item name="feature-toggle-allowed">false</Item>
 <Item name="feature-availability" index="1">false</Item>
 <Item name="feature-availability" index="2">false</Item>
 <Item name="feature-availability" index="11">false</Item>
 <Item name="feature-availability" index="23">false</Item>
 <Item name="feature-availability" index="24">false</Item>
 <Item name="feature-availability" index="27">false</Item>
 <Item name="feature-availability" index="28">false</Item>
 <Item name="feature-availability" index="29">false</Item>
 <Item name="feature-availability" index="31">false</Item>
 <Item name="feature-availability" index="32">false</Item>
 <Item name="feature-availability" index="34">false</Item>
 <Item name="feature-availability" index="35">false</Item>
 <Item name="feature-availability" index="36">false</Item>
 <Item name="feature-availability" index="37">false</Item>
 <Item name="feature-availability" index="38">false</Item>
 <Item name="feature-availability" index="39">false</Item>

Item name	Item index	Type	Details
agent-feature-enabled	no index	Boolean	Enables Broadworks Agent feature. true or false
callback-busy-allow	no index	Boolean	Enables Callback functionality. true or false
enable-bluetooth-interface	no index	Boolean	Enables Bluetooth interface on CP600. true or false
enable-WBM	no index	Boolean	Enables Web based interface. true or false
pb-lookups-allowed	no index	Boolean	Enables phone book lookups. true or false
refuse-call	no index	Boolean	Enables selective call rejection. true or false
allow-user-access-to-diagnostic-data	no index	Boolean	Enables user access to diagnostic data. true or false
group-pickup-allowed	no index	Boolean	Enables user access to group pickup. true or false
feature-toggle-allowed	no index	Boolean	Enables user access to feature toggle. true or false
feature-availability	1	Boolean	Enables selective call deflection. true or false
feature-availability	2	Boolean	Enables call forwarding functionality. true or false
feature-availability	11	Boolean	Enables do not disturb functionality. true or false
feature-availability	23	Boolean	Enables call pickup functionality. true or false
feature-availability	24	Boolean	Enables call recording functionality. true or false
feature-availability	27	Boolean	Enables blind transfer functionality. true or false
feature-availability	28	Boolean	Enables repertory dial keys. true or false
feature-availability	29	Boolean	Enables BLF keys. true or false
feature-availability	31	Boolean	Enables feature toggle keys. true or false
feature-availability	32	Boolean	Enables CTI functionality. true or false
feature-availability	34	Boolean	Enables third callleg functionality. true or false
feature-availability	35	Boolean	Enables group pickup functionality. true or false
feature-availability	36	Boolean	Enables phone lock functionality. true or false
feature-availability	37	Boolean	Enables Exchange integration functionality. true or false
feature-availability	38	Boolean	Enables Circuit integration functionality. true or false
feature-availability	39	Boolean	Enables OpenScape UC integration functionality. true or false

Locked config menus settings

The phone allows to lock specifc features for the user. This section will show the relevant Items to configure if you want specific menus to be locked.

 <Item name="locked-config-menus" index="1">true</Item>
 <Item name="locked-config-menus" index="2">true</Item>
 <Item name="locked-config-menus" index="3">true</Item>
 <Item name="locked-config-menus" index="4">true</Item>
 <Item name="locked-config-menus" index="5">true</Item>
 <Item name="locked-config-menus" index="8">true</Item>
 <Item name="locked-config-menus" index="9">true</Item>
 <Item name="locked-config-menus" index="10">true</Item>
 <Item name="locked-config-menus" index="11">true</Item>
 <Item name="locked-config-menus" index="14">true</Item>
 <Item name="locked-config-menus" index="15">true</Item>
 <Item name="locked-config-menus" index="16">true</Item>
 <Item name="locked-config-menus" index="17">true</Item>
 <Item name="locked-config-menus" index="18">true</Item>
 <Item name="locked-config-menus" index="19">true</Item>
 <Item name="locked-config-menus" index="21">true</Item>
 <Item name="locked-config-menus" index="23">true</Item>
 <Item name="locked-config-menus" index="32">true</Item>
 <Item name="locked-config-menus" index="33">true</Item>
 <Item name="locked-config-menus" index="35">true</Item>
 <Item name="locked-config-menus" index="38">true</Item>
 <Item name="locked-config-menus" index="43">true</Item>
 <Item name="locked-config-menus" index="44">true</Item>
 <Item name="locked-config-menus" index="48">true</Item>
 <Item name="locked-config-menus" index="49">true</Item>
 <Item name="locked-config-menus" index="52">true</Item>
 <Item name="locked-config-menus" index="53">true</Item>
 <Item name="locked-config-menus" index="56">true</Item>
 <Item name="locked-config-menus" index="60">true</Item>
 <Item name="locked-config-menus" index="61">true</Item>
 <Item name="locked-config-menus" index="62">true</Item>
 <Item name="locked-config-menus" index="63">true</Item>
 <Item name="locked-config-menus" index="64">true</Item>
 <Item name="locked-config-menus" index="66">true</Item>
 <Item name="locked-config-menus" index="68">true</Item>
 <Item name="locked-config-menus" index="70">true</Item>
 <Item name="locked-config-menus" index="71">true</Item>
 <Item name="locked-config-menus" index="72">true</Item>
 <Item name="locked-config-menus" index="73">true</Item>
 <Item name="locked-config-menus" index="77">true</Item>
 <Item name="locked-config-menus" index="78">true</Item>
 <Item name="locked-config-menus" index="79">true</Item>
 <Item name="locked-config-menus" index="80">true</Item>
 <Item name="locked-config-menus" index="81">true</Item>
 <Item name="locked-config-menus" index="82">true</Item>
 <Item name="locked-config-menus" index="83">true</Item>
 <Item name="locked-config-menus" index="84">true</Item>
 <Item name="locked-config-menus" index="85">true</Item>
 <Item name="locked-config-menus" index="86">true</Item>
 <Item name="locked-config-menus" index="87">true</Item>
 <Item name="locked-config-menus" index="88">true</Item>

Item name	Index	CP20X	CP400	CP600	Type	Details
locked-config-menus	1	Yes	Yes	Yes	Boolean	Lock country settings. true or false
locked-config-menus	2	Yes	Yes	Yes	Boolean	Lock language settings. true or false
locked-config-menus	3	Yes	Yes	Yes	Boolean	Lock date and time settings. true or false
locked-config-menus	4	Yes	Yes	Yes	Boolean	Lock call deflection settings. true or false
locked-config-menus	5	Yes	Yes	Yes	Boolean	Lock call forwarding settings. true or false
locked-config-menus	8	Yes	Yes	Yes	Boolean	Lock call waiting settings. true or false
locked-config-menus	9	Yes	Yes	Yes	Boolean	Lock call transfer settings. true or false
locked-config-menus	10	Yes	Yes	Yes	Boolean	Lock call join settings. true or false
locked-config-menus	11	Yes	Yes	Yes	Boolean	Lock display contrast settings. true or false
locked-config-menus	14	Yes	Yes	Yes	Boolean	Lock daylight saving settings. true or false
locked-config-menus	15	Yes	Yes	Yes	Boolean	Lock auto dial timer settings. true or false
locked-config-menus	16	Yes	Yes	Yes	Boolean	Lock call fwd no reply timer settings. true or false
locked-config-menus	17	Yes	Yes	Yes	Boolean	Lock hold ringback timer settings. true or false
locked-config-menus	18	Yes	Yes	Yes	Boolean	Lock music on hold settings. true or false
locked-config-menus	19	Yes	Yes	Yes	Boolean	Lock do not disturb settings. true or false
locked-config-menus	21	Yes	Yes	Yes	Boolean	Lock hold ring back settings. true or false
locked-config-menus	23	Yes	Yes	Yes	Boolean	Lock local conferencing settings. true or false
locked-config-menus	32	Yes	Yes	Yes	Boolean	Lock auto answer settings. true or false
locked-config-menus	33	Yes	Yes	Yes	Boolean	Lock auto answer beep settings. true or false
locked-config-menus	35	Yes	Yes	Yes	Boolean	Lock auto reconnect beep settings. true or false
locked-config-menus	38	Yes	Yes	Yes	Boolean	Lock inactivity timeout settings. true or false
locked-config-menus	43	Yes	Yes	Yes	Boolean	Lock default deflect address settings. true or false
locked-config-menus	44	Yes	Yes	Yes	Boolean	Lock line key settings. true or false
locked-config-menus	48	Yes	Yes	Yes	Boolean	Lock immediate dialing settings. true or false
locked-config-menus	49	Yes	Yes	Yes	Boolean	Lock callback and callback busy settings. true or false
locked-config-menus	52	Yes	Yes	Yes	Boolean	Lock immediate dialing settings. true or false
locked-config-menus	53	Yes	Yes	Yes	Boolean	Lock transfer on ring settings. true or false
locked-config-menus	56	Yes	Yes	Yes	Boolean	Lock secure call indication settings. true or false
locked-config-menus	60	Yes	Yes	Yes	Boolean	Lock audio settings. true or false
locked-config-menus	61	Yes	Yes	Yes	Boolean	Lock loudspeaker settings. true or false
locked-config-menus	62	Yes	Yes	Yes	Boolean	Lock forwarding alert settings. true or false
locked-config-menus	63	Yes	Yes	Yes	Boolean	Lock join in conference settings. true or false
locked-config-menus	64	No	No	Yes	Boolean	Lock Bluetooth settings. true or false
locked-config-menus	66	No	Yes	Yes	Boolean	Lock screen saver settings. true or false
locked-config-menus	68	Yes	Yes	Yes	Boolean	Lock BLF settings. true or false
locked-config-menus	70	Yes	Yes	Yes	Boolean	Lock forwarding party display settings. true or false
locked-config-menus	71	Yes	Yes	Yes	Boolean	Lock headset settings. true or false
locked-config-menus	72	Yes	Yes	Yes	Boolean	Lock key click settings. true or false
locked-config-menus	73	Yes	Yes	Yes	Boolean	Lock enable call log settings. true or false
locked-config-menus	77	Yes	Yes	Yes	Boolean	Lock missed logging settings. true or false
locked-config-menus	78	No	Yes	Yes	Boolean	Lock display brightness settings. true or false
locked-config-menus	79	No	Yes	Yes	Boolean	Lock backlight timeout and energy saving settings. true or false
locked-config-menus	80	Yes	Yes	Yes	Boolean	Lock special ringer internal calls settings. true or false
locked-config-menus	81	Yes	Yes	Yes	Boolean	Lock special ringer external calls settings. true or false
locked-config-menus	82	Yes	Yes	Yes	Boolean	Lock special ringer recall settings. true or false
locked-config-menus	83	Yes	Yes	Yes	Boolean	Lock special ringer emergency calls settings. true or false
locked-config-menus	84	Yes	Yes	Yes	Boolean	Lock special ringer special 1 calls settings. true or false
locked-config-menus	85	Yes	Yes	Yes	Boolean	Lock special ringer special 2 calls settings. true or false
locked-config-menus	86	Yes	Yes	Yes	Boolean	Lock special ringer special 3 calls settings. true or false
locked-config-menus	87	Yes	Yes	Yes	Boolean	Lock delete entry settings. true or false
locked-config-menus	88	No	Yes	Yes	Boolean	Lock Exchange settings. true or false

User settings

The following section is all about user settings, which the user can change on their own, but still allow to be remotely configured via DMS

 <Item name="country-iso">DE</Item>
 <Item name="language-iso">de</Item>
 <Item name="date-format">0</Item>
 <Item name="time-format">0</Item>
 <Item name="pixelsaver-timeout-xt">15</Item>
 <Item name="screensaver-enabled">true</Item>
 <Item name="inactivity-screen-type">0</Item>
 <Item name="inactivity-timeout">1</Item>
 <Item name="screensaver-image-timeout">10</Item>
 <Item name="landing-screen">2</Item>
 <Item name="key-click-volume">0</Item>
 <Item name="click-keys">0</Item>
 <Item name="busy-when-dialling-enabled">true</Item>
 <Item name="call-waiting-enabled">true</Item>
 <Item name="call-dnd-enabled">true</Item>
 <Item name="auto-answer">false</Item>
 <Item name="beep-on-auto-answer">false</Item>
 <Item name="beep-on-auto-reconnect">false</Item>  

Item name	Type	Details	Related WBM config item
country-iso	Enumeration	Country-iso defines country specific tones (2 letter codes as per ISO 3166). See: OpenScape_Desk_Phone_IP_Supported_Country_Tones	User -> Locality
language-iso	Enumeration	Language-iso defines the display language (2 letter codes as per ISO 639). See: OpenScape_Desk_Phone_IP_Supported_Languages	User -> Locality
date-format	Enumeration	Defines the date format displayed. 0=dd.mm.yy, 1=mm/dd/yy	User -> Locality
time-format	Enumeration	Defines the time format displayed. 0=24h, 1=12h	User -> Locality
pixelsaver-timeout-xt	Enumeration	Defines the timeout for dimming and shutting off display. 15=1min/5min, 16=5min/20min, 17=30min/2h, 18=45min/4h, 19=60min/8h	User -> Phone -> Energy saving
screensaver-enabled	Boolean	Enable the idle screen feature. true or false.	User -> Phone -> Idle screen
inactivity-screen-type	Enumeration	Defines the type of idle screen. 0=menu screen, 1=slideshow	User -> Phone -> Idle screen
inactivity-timeout	Integer	Defines the timeout (seconds) when idle screen will be enabled. (0, 1, 5, 10, 20, 30, 60, 120)	User -> Phone -> Idle screen
screensaver-image-timeout	Integer	Defines the picture display time (seconds) when idle screen type is slideshow. (5, 10, 20, 30, 60)	User -> Phone -> Idle screen
landing-screen	Enumeration	Defines the main landing screen of the phone. 0=Conversation list, 1=Favorites, 2=Main menu	User -> Phone -> Idle screen
key-click-volume	Enumeration	Defines the volume level for key click. 0=off, 1=low, 2=medium, 3=high	User -> Phone -> Key click
click-keys	Enumeration	Defines the keys active for key click. 0=dialpad, 1=all	User -> Phone -> Key click
busy-when-dialling-enabled	Boolean	Make the phone busy receiving calls when the user starts dialing. true or false	User -> Configuration -> Outgoing calls
call-waiting-enabled	Boolean	Enable call waiting. true or false	User -> Configuration -> Incoming calls -> Handling
call-dnd-enabled	Boolean	Enable toggline of do not disturb setting. true or false	User -> Configuration -> Incoming calls -> Handling
auto-answer	Boolean	Enable CTI auto answer. true or false	User -> Configuration -> Incoming calls -> CTI calls
beep-on-auto-answer	Boolean	Enable beep tone on CTI auto answer. true or false	User -> Configuration -> Incoming calls -> CTI calls
beep-on-auto-reconnect	Boolean	Enable beep tone on CTI reconnected calls. true or false	User -> Configuration -> Incoming calls -> CTI calls

Ringer settings

The following section is all about ringer settings.

Pattern ringers

This section describes the configuration of the integrated pattern ringtones

 <Item name="ringer-audio-file"></Item>
 <Item name="ringer-tone-sequence"></Item>
 <Item name="ringer-melody"></Item>

Item name	Type	Details
ringer-audio-file	String	needs to be empty when configuring built in patterns
ringer-tone-sequence	Enumeration	1=1.0sec ON, 4.0sec OFF 2=1.0sec ON, 2.0sec OFF 3=0.7sec ON, 0.7sec OFF, 0.7sec ON, 3.0sec OFF 4=2.0sec ON, 4.0sec OFF 5=1.64sec ON, 0.36sec OFF 8=0.7sec ON, 0.3sec OFF
ringer-melody	Enumeration	1,2,3,4,5,6,7 or 8. Different pattern melodies

Distinctive ringers

This section describes the configuration of the distinctive ringing table of the phone. The content of the XML items contains the following information.

• Bellcore-dr1: The string provided by the SIP server to identify a call type (e.g. internal calls, external calls, etc).
• 2: Pattern melody. Possible values are between 1 and 8 and reflect different melodies for the ringers.
• 3: Pattern sequence. Possible values are between 1 and 6 and reflect different sequences for the selected ringer melody.
• 60: Duration. Duration of the ringer.
• Ringer1.mp3: (optional) ringer file instead of selected melody is played.

 <Item name="alert" index="1">Bellcore-dr1^2^3^60^Ringer1.mp3</Item>
 <Item name="alert" index="2">Bellcore-dr2^2^3^60^Ringer2.mp3</Item>
 <Item name="alert" index="3">Bellcore-dr3^2^3^60^Ringer3.mp3</Item>
 <Item name="alert" index="4">alert-emergency^2^3^60^Ringer4.mp3</Item>

Diagnostic settings

The phone allows to diagnose issues with built in tracing capabilities. Traces can also be sent to a syslog server.

 <Item name="remote-trace-enable">true</Item>
 <Item name="remote-trace-user-notify">true</Item>
 <Item name="remote-trace-ip">1.2.3.4</Item>
 <Item name="remote-trace-port">514</Item>

Item name	Type	Details
remote-trace-enable	Boolean	true/false. Enables or disables the feature
remote-trace-user-notify	Boolean	true/false. Enables or disables user notification for this feature
remote-trace-ip	String	IP address or FQDN of remote trace server (syslog server)
remote-trace-port	Integer	Remote port used at the server to receive the syslog messages

Action: SoftwareDeployment

This chapter is about SoftwareDeployment. It is used to provide a new software image file to the OpenScape Desk Phone CP devices. The following items are required, so the phone can verify the software image file and proceed with the update.

 <Item name="file-name">OS_HI_SIP_V1_R1.7.0.img</Item>
 <Item name="file-https-base-url">https://1.2.3.4/OS_HI_SIP_V1_R1.7.0.img</Item>
 <Item name="file-type">APP</Item>
 <Item name="file-sw-version">1.1.7.0000</Item>
 <Item name="file-sw-type">SIP</Item>

Item name	Item index	Type	Details
file-name	no index	String	Filename, path is relative to XML config file. NOT to be used together with file-https-base-url
file-https-base-url	no index	String	Full URL to the file. NOT to be used together with file-name
file-type	no index	Enumeration	APP for software image file
file-sw-version	no index	String	Exact version of the software image linked to in "file-name" or "file-https-base-url"
file-sw-type	no index	Enumeration	SIP or HFA. Must be SIP for use with Broadsoft

The update procedure "in a nutshell":

• The phone will periodically check the DMS server for changes to the XML file
• When the XML file has changed, the SoftwareDeployment action will be parsed
• If file-sw-version differs from the version currently installed, the file at "file-name" or "file-https-base-url" will be downloaded and installed

Software version string

The format of "file-sw-version" is A.B.C.DDDD, which refers to V[A] R[B].[C].[DDDD]. Please see table below for details.

Letter	Version type	Length
A	Major	1
B	Minor	1
C	Fix	1
D	Hotfix	4

File name

The file name of the software image can have a special tag (___PHONE_MODEL___) that will be replaced by the actual device model. As an example, on an OpenScape Desk Phone CP600 the "file-name" of "___PHONE_MODEL___.img" will be replaced by "CP600.img" on sending the GET request to the file server. The tag (___PHONE_MODEL___) will also be replaced by the actual device model when used in "file-https-base-url"

Phone model	Replacement string
Desk Phone CP100	CP100
Desk Phone CP200	CP20X
Desk Phone CP205	CP20X
Desk Phone CP400	CP400
Desk Phone CP600	CP600
Desk Phone CP600E	CP600E
Desk Phone CP700	CP700
Desk Phone CP700X	CP700X

Action: FileDeployment

This chapter is about FileDeployment. It is used to provide Ringtones or Screensaver files for the phone to download. The following items are required.

 <Item name="file-https-base-url">https://1.2.3.4/file.type</Item>
 <Item name="file-type">RINGTONE</Item>

Item name	Item index	Type	Details
file-https-base-url	no index	String	The URL of the file to download
file-type	no index	Enumeration	RINGTONE, SCREENSAVER, LOGO