Difference between revisions of "Broadsoft DMS"

Revision as of 20:17, 19 December 2016

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.

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)

Content of config.xml file

The content of the XML file provided by the DMS server has the following schema

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

Generic Items

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

Network related Items

System related Items

Feature related Items

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>

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-allowed" index="1">true</Item>
 <Item name="codec-allowed" index="2">true</Item>
 <Item name="codec-allowed" index="3">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-rank" index="1">2</Item>
 <Item name="codec-rank" index="2">1</Item>
 <Item name="codec-rank" index="3">3</Item>
 <Item name="audio-silence-suppression">false</Item>

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.

• 48 keys on CP600 (with 4 Key modules attached. 4 times 12 keys on the key modules)
• 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 (all on the base device)

First you need the key index where the functionality will be put on.

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>

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="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="36">false</Item>