Configuring Device Management on BroadWorks
This chapter introduces the privileges of the system administrator and group administrator on BroadWorks. The following two sections provide a system administrator or a group administrator with step-by-step instructions on how to configure device management feature, such as customizing tags, uploading files and so on.
The following sections provide information on how to customize BroadWorks tags, create the device profile type and define the device profile type files at the system level.
If you don’t have the privilege of system administrator, proceed to the next section
Log in BroadWorks as Group Administrator on page 15 .
Service integration on BroadWorks is based on the concept of “Tags”. Tags are variables that can be embedded in template configuration files. When BroadWorks generates a configuration file from a configuration template, the tags are replaced with actual values. Tags are delimited with a beginning and ending % sign.
There are two types of tags:
Dynamic Built-in Tags: These tags are predefined by BroadWorks. The value of each built-in tag is dynamically evaluated based on the context of the device profile. A built-in tag for one device is evaluated differently from another device.
All built-in tags are prefixed with “BW”.
For more information on dynamic built-in tags, refer to
BroadSoft Device
Management Configuration Guide
.
Static Tags: These tags are defined by the administrator. For example, system default tags and device type specific tags. The value of each static tag is assigned by the administrator.
5
IP Phones Deployment Guide for BroadWorks Environment
To create system default tags:
1. Click on Resources->Device Management Tag Sets.
2. Select the System Default.
3. Click Add to add a new tag.
4. Enter the desired name in the Tag Name field.
The tag name must not start with “BW”.
5. Enter the desired value in the Tag Value field.
The tag in template configuration files can be replaced by the configured tag value.
6
6. Click OK to accept the change.
7. Repeat steps 3 to 6 to add more system default tags.
The following table lists some system default tags required in template configuration files.
Tag Name
%SNTP_SERVER_1%
%SNTP_SERVER_2%
%DNS_SERVER_1%
Valid Value
IP address/FQDN
Example: time-a.nist.gov
IP address/FQDN
Example: time-b.nist.gov
IP address
Example: 199.19.193.12
Description
The NTP server address
The alternate NTP server address
The DNS server address
Tag Name
%DNS_SERVER_2%
%USE_SBC_BOOLEAN%
%SBC_ADDRESS%
%SBC_PORT%
Configuring Device Management on BroadWorks
Valid Value
IP address
Example: 199.19.193.39
Boolean
IP address/FQDN
Example: 199.19.193.9
Integer
Example: 5060
Description
The alternate DNS server address
Enables or disables the outbound proxy server
The outbound proxy server address
The outbound proxy server port
To create device type specific tags:
1. Click on Resources->Device Management Tag Sets.
2. Click Add.
3. Enter the tag set name in the Tag Set Name field (e.g., YealinkT23-Tags).
4. Click Add.
5. Enter the desired name in the Tag Name field.
The tag name must not start with “BW”.
6. Enter the desired value in the Tag Value field.
The tag in template configuration files can be replaced by the configured tag value.
7. Click Apply to accept the change.
8. Repeat steps 4 to 7 to add more device type specific tags.
The following table lists some device type specific tags required in template configuration files.
Tag Name
%LANGUAGEWEB%
Valid Value
English
Chinese_S
Chinese_T
French
German
Italian
Polish
Portuguese
Spanish
Turkish
Russian
Description
The language of the web user interface
7
IP Phones Deployment Guide for BroadWorks Environment
Tag Name
%LANGUAGEGUI%
% PhoneModel _FIRMWARE%
(e.g., T23_FIRMWARE)
%FEATURE_KEY_SYN%
Valid Value
English
Chinese_S
Chinese_T
French
German
Italian
Polish
Portuguese
Spanish
Turkish
Russian
<x.x.x.x>.rom
Example:
44.80.193.60.rom
Boolean
Description
The language of the phone user interface
The firmware version
Enables or disables feature key synchronization
Device profile types are the templates for device profiles. They can be created, modified and deleted at the system level. Creating device profile types is a crucial step in the initial planning and deployment. Device profile types should be defined in conjunction with the services being offered to the users. Device profile type can only be deleted when there is no any reference to the device profile type, for example, no device profile is associated with the device profile type.
There are two primary steps to create a device profile type:
Defining the access profile: For the aspects related to the signaling and media interoperability with BroadWorks.
Defining the configuration profile: For the aspects related to the configurations of the device.
8
When adding a new device profile type to the system, the first step is to define the access profile. The access profile consists of attributes relating to the signaling and media integration with BroadWorks. These attributes tell BroadWorks how to interact with device profiles of this type. Another important configuration of the access profile is the maximum number of ports available on the device. This attribute allows BroadWorks to control the number of users who can be associated with a given device. The other related configurations of the access profile are encapsulated in the “Standard Options” and the “Advanced Options” fields.
Configuring Device Management on BroadWorks
The following table shows an example of defining the access profile. Parameters not identified in the following table can be usually left as the defaults.
Description Parameter
Identity/Device Profile Type
Signaling Address Type
Standard Options
Value
Yealink T23
Intelligent Proxy
Addressing
Number of Ports
Ringback Tone/Early Media
Support
Authentication
Registration Capable
RFC3264 Hold
Limited To 6
Local Ringback - No
Early Media
Enabled
Checked
Checked
Defines the number of users who can be associated with a device of this device profile.
Determines SDP handing for initial INVITE messages sent to the device.
Defines whether requests for a device need to be authenticated.
Defines whether a device of this device profile type is allowed to be registered to the
BroadWorks.
Defines whether the 3264 hold mechanism is used in the SIP signaling.
Advanced Options
Reset Event checkSync
Determines which type of notify event is sent to the device. BroadWorks reboots the remote device via a NOTIFY request with an event type of either reSync or checkSync.
When adding a new device profile type to the system, the system administrator must decide which level of configuration management is supported. There are three levels available for configuring:
9
IP Phones Deployment Guide for BroadWorks Environment
Not Supported: this is the default option. You don’t need to make any configuration.
Device Management: when the Device Management is marked, the parameters needing to be configured are summarized in the following table. Parameters not identified in the following table can usually be left as the defaults.
Allow Groups to
Configure Custom
Tags
Parameter
Device Configuration
Tags
Allow Identity/Device
Profiles to Configure
Custom Tags
Device Access
Protocol
Device Access FQDN
Device Access Port
Device Access
Context Name
Value
Use Default System Tag
Set and Tag Set.
Select the tag set name
(e.g., YealinkT23-Tags) from the pull-down list of Use Default System
Tag Set and Tag Set.
Description
Selects the device tag set created in the section
Creating Device Type
Specific Tags on page 7 .
Checked
Checked http
Determines whether new static tags can be customized at the profile level.
For more information on how to customize static tags at the profile level, refer to
Customizing a Static Tag
on
page 17 .
Determines whether new static tags can be customized at the group level.
For more information on how to customize static tags at the group level, refer to
Customizing a Static Tag
on
page 17 .
Determines the transfer protocol used by the device to get its files.
<BroadWorks-Xsp-Clus ter-Address>
Example: xsp.yealink.com
<BroadWorks-Xsp-Port
>
Example: 80 dms
Represents the FQDN of the
XSP used by the device to get its files.
Represents the port number of the XSP used by the device to get its files.
Represents the name of the
Broadworks DMS web application which has been
10
Configuring Device Management on BroadWorks
Parameter Value Description predefined.
Device Access URI
<device-type-name>
Example: YealinkT23)
Ensures the uniqueness of the URL for each device type. It typically contains the device type name.
Legacy: when the Legacy is marked, the parameters needing to be configured are summarized in the following table:
Parameter
Legacy Configuration
Type
CPE System File
Name
Device File Format
Value
2 Config File y000000000044.cfg
%BWMACADDRESS%.cfg
Description
Defines the number of configuration files for the device profile type.
Specifies the system file name requested by the device.
Specifies the device file name requested by the device.
To create a device profile type:
1. Click on Resources->Identity/Device Profile Types.
2. Click Add.
11
IP Phones Deployment Guide for BroadWorks Environment
3. Make the desired change.
4. Click OK to accept the change.
This section describes how to define the configuration files and static files that IP phones download.
There are two configuration files both of which are CFG formatted. We call them the system file and the device-specific file. The static files are required when employing some particular features on IP phones. The following provides detail information for these files.
12
The system file will be effectual for all IP phones of the same model. The system file has a fixed name for each phone model. The names of the system files for different IP phone
Configuring Device Management on BroadWorks models are:
T49G: y000000000051.cfg
T48G: y000000000035.cfg
T46G: y000000000028.cfg
T42G: y000000000029.cfg
T41P: y000000000036.cfg
T40P: y000000000054.cfg
T29G: y000000000046.cfg
T27P: y000000000045.cfg
T23P/G: y000000000044.cfg
T21(P) E2: y000000000052.cfg
T19(P) E2: y000000000053.cfg
CP860: y000000000037.cfg
The following table lists the parameters used to define the system file:
Parameter
Device Access File
Format
Value
<system-file-name>.cfg
Example: y000000000044.cfg
GRepository File
Format
File Category
File Customization
Assign File
Authentication Mode
Device Access HTTP
Authentication
<system-file-name>.cfg
Example: y000000000044.cfg
Dynamic Per-Type
Administrator
Custom
User Name and Password
Digest
Description
Specifies the name of the system file.
Specifies the name of the system file stored in the Device
Management repository.
Specifies the type of the file.
Identifies who can customize the system file.
Defines the authentication method.
A device-specific file is only effectual for the specific IP phone. The device-specific file is named after the MAC address of the IP phone. The file name format of the
13
IP Phones Deployment Guide for BroadWorks Environment device-specific file is as below:
<mac-address>.cfg
The following table lists the parameters used to define the device-specific file:
Parameter
Device Access File
Format
Repository File Format
File Category
File Customization
Assign File
Authentication Mode
Custom
Value
%BWMACADDRESS%.cfg
%BWMACADDRESS%.cfg
Dynamic Per-Device
Administrator and User
User Name and Password
Description
Specifies the name of the device-specific file.
Specifies the name of the device-specific file stored in the Device
Management repository.
Specifies the type of the file.
Identifies who can customize the device-specific file.
Defines the authentication method.
Device Access HTTP
Authentication
Digest
14
In addition to configuration files, the IP phone may require static files before it can deliver service. The static files required may vary from different IP phone models. Tags cannot be added to the static files. The following lists the static files required for different IP phone models:
The Yealink SIP VP-T49G/SIP-T48G/T46G/T42G/T41P/T40P/T29G/T27P/T23P/T23G/T21(P)
E2/T19(P) E2 and CP860 IP phones require the following static files:
<firmware-version>.rom
Ring.wav
000.GUI.English.lang contact.xml
AutoDST.xml dialplan.xml dialnow.xml
