17
Obihai Technology, Inc. OBi Device Provisioning with BroadSoft DMS Models: OBi1062, OBi1032, OBi1022 OBi200, OBi202, OBi300, OBi302 OBi504, OBi508 Copyright, Obihai Technology, Inc. 2017. All Rights Reserved. Copyright material. Do not make copies. Do not distribute. All contents subject to change without notification.

Obihai Technology, Inc

Embed Size (px)

Citation preview

Obihai Technology, Inc.

OBi Device Provisioning

with BroadSoft DMS

Models:

OBi1062, OBi1032, OBi1022

OBi200, OBi202, OBi300, OBi302

OBi504, OBi508

Copyright, Obihai Technology, Inc. 2017. All Rights Reserved.

Copyright material. Do not make copies. Do not distribute.

All contents subject to change without notification.

Obihai Technology Proprietary Information

Copyright 2010-2017 Obihai Technology, Inc. 2

AUDIENCE ............................................................................................................................................................................ 3

WHERE TO GO FOR HELP ........................................................................................................................................................ 3

NOTATIONAL CONVENTIONS .................................................................................................................................................... 4 Boolean Values ......................................................................................................................................................................................................... 4

BROADSOFT DMS .......................................................................................................................................... 5

Device Profile ........................................................................................................................................................................................................... 5 Creating a Device Profile in DMS for an Obihai Device ........................................................................................................................................ 5

User and Line/Port ................................................................................................................................................................................................... 7 Create a New User in DMS .................................................................................................................................................................................. 7 Change Web/Portal User Login Password ........................................................................................................................................................... 9 Add Authentication Service to a New User.......................................................................................................................................................... 9 Assigning the Primary Device Line/Port to a User ............................................................................................................................................. 10

Viewing Configuration Files Generated by DMS for a Device Profile ...................................................................................................................... 11 Organization of Obihai Configuration Files in DMS............................................................................................................................................ 13

PREPARATION OF NEW OBIHAI DEVICES FOR PROVISIONING BY DMS ............................................................................................ 13 Example Preparing an Obihai Device for DMS Provisioning ................................................................................................................................... 14

A. Device Access User Name and Password either not configured or the same for ALL Device Profiles ........................................................... 14 B. Device Access User Name and Password are configured differently for each Device Profile ........................................................................ 15 DHCP Option 66 to Reference DMS URL Directly .............................................................................................................................................. 16

Obihai “Zero Touch” Device Preparation for DMS Provisioning ............................................................................................................................. 16 Zero-Touch Preparation of Obihai Devices for DMS Provisioning when Device Access User Name/Password are configured in the Device Profile in DMS .................................................................................................................................................................................................... 16

DMS with OBiTALK Device Provisioning Working Together .................................................................................................................................... 17 BROADSOFT CUSTOM TAGS ................................................................................................................................................... 17

Obihai Technology Proprietary Information

Copyright 2010-2017 Obihai Technology, Inc. 3

Audience Internet Telephony Service Providers (ITSPs), Managed Service VARS, IT Professionals who are interested in using OBi devices with BroadSoft.

Note for Australian readers: Throughout this document we refer to ITSPs – treat this term the same as you would for VSP (Voice Service Provider).

Where to Go for Help Obihai has a number of options available to customers who are seeking help regarding their Obihai products.

Obihai Support Web Site: http://www.obihai.com/support.html On this web site visitors will find links to the OBiTALK forum, Documents and Downloads, Tools Tips and Tricks as well as an FAQ / Knowledge Base.

Enter a Support Request at: http://www.obihai.com/supportTicketForm.php Go to the OBiTALK forum at: www.obitalk.com/forum E-mail the Obihai Support Team at: [email protected]

Obihai Technology Proprietary Information

Copyright 2010-2017 Obihai Technology, Inc. 4

Notational Conventions A device configuration parameter and it’s value is represented in the format:

Parameter Group Name::ParameterName = Parameter Value

Parameter Group Name::ParameterName = {replace-this-with-actual-value}

Parameter Group Name is the heading of the parameter group on the left side panel of the device configuration web page (or OBi Expert) and may contain spaces. When a group heading has more than one level, each level is separated with a – , such as:

Services Providers - ITSP Profile A – SIP::

ParameterName is the name of the parameter as shown on the web page and MUST NOT CONTAIN ANY SPACES. Parameter Value is the literal value to assign to the named parameter and may contain spaces. Group Name or its top-level headings may be omitted when the context is clear. For example:

SP1 Service::AuthUserName = 4082224312

ITSP Profile A - SIP::ProxyServer = sip.myserviceprovider.com

ProxyServerPort = 5082

[optional values]

Boolean Values Parameters that take a Boolean (true or false) value can be identified on the phone native configuration web pages (or OBi Expert) by a check box / tick box (instead of an input-box or drop-down list) next to the parameter name. Throughout the document we may loosely refer to a Boolean value as enable/disable or yes/no, but the only valid Boolean parameter values to use in a phone configuration file that is recognized by the phone is either true/false or True/False (case-sensitive!). This is equivalent to checked/unchecked on the configuration web pages.

Obihai Technology Proprietary Information

Copyright 2010-2017 Obihai Technology, Inc. 5

BroadSoft DMS The BroadWorks Device Management System (DMS) is the component responsible for provisioning endpoint devices (ATAs and IP Phones) in a BroadSoft installation. The table below lists the Obihai device models that have been certified by BroadSoft and can be provisioned by the DMS:

OBi Model

Description DMS Device Profile Type

Available Line/Ports

UC

1022 IP Phone w/ 5 Line Keys Obihai-OBi1022 5 y 1032 IP Phone w/ 3 Line Keys Obihai-OBi1032 6 y 1062 IP Phone w/ 6 Line Keys Obihai-OBi1062 6 y 200 1-Port ATA Obihai-OBi200 1 n 202 2-Port ATA w/ Router Obihai-OBi202 2 n 300 1-Port ATA Obihai-OBi300 1 n 302 2-Port ATA w/ Router Obihai-OBi302 2 n 504 4-Port ATA Obihai-OBi504 4 n 508 8-Port ATA Obihai-OBi508 8 n

There are three basic configuration entities in the DMS:

Device: Each device managed by the DMS must have a corresponding Device Profile defined based on a BroadSoft approved (and built-in) device type (such as Obihai-OBi1022). The device profile is identified with a unique name chosen by the admin, such as “Joe’s OBi1022”. A device profile contains a MAC Address parameter which should be set equal to the MAC Address of the device that the device profile is defined for. The DMS may generate/store a few downloadable configuration files for each device profile defined in the system.

User: A User is identified with a unique User ID. The information about each User can be viewed/edited in the DMS portal in the context of a corresponding User Profile. A User may have an IM&P (Instant Messaging and Presence) account ID and Password defined in the profile for example. Normally a User also has a (DID) Phone Number, a callable Extension, and a (primary) Line/Port assigned. The assigned (primary) Line/Port in a User Profile maps to a Line/Port of a specific (physical) device that the User will be using (primarily). If the User has Shared Call Appearance enabled, the User Profile may include one or more additional Line/Ports.

(Logical) Line/Port: A Line/Port, a.k.a. Device Endpoint in DMS, has a SIP account for voice service with a unique SIP address such as [email protected] and is associated with a Line/Port of a (physical) device (that has a device profile defined in the system). A DMS Line/Port must have an associated Device Profile where it is associated with one of the device Line/Ports of the corresponding device.

In the DMS portal there two basic levels of configuration: Group Level and User Level. The DMS portal indicates at the top left corner of each web page which level you are currently in.

Device Profile

Creating a Device Profile in DMS for an Obihai Device

A device profile is created by the admin to match the actual hardware (an Obihai IP Phone or ATA in this case) that is used with the system. Each device to be used in the installation MUST have its own device profile created.

At the Group level, click on Resources on the left side and click Identify/Device Profiles on the Resources page:

Obihai Technology Proprietary Information

Copyright 2010-2017 Obihai Technology, Inc. 6

Click Add button on the Identify/Device Profiles page:

On the Identify/Device Profile Add page: Depending on the hardware model, select one of Obihai-OBi1022, Obihai-OBi1032, Obihai-OBi1062, etc. from the “Identify/Device Profile Type” drop down list. Enter a unique device profile name for this profile, such as “Joe’s OBi1022” and the MAC Address of the phone if you already know it (otherwise you can open the device profile to add/change later). In the Authentication section at the bottom of the page, you may also define a Device Access User Name and Password if you check the Use Custom Credentials button. In that case whoever attempts to download the configuration files for this device profile will be challenged with the custom username and password. You must configure a different Device Access User Name for each device profile.

Obihai Technology Proprietary Information

Copyright 2010-2017 Obihai Technology, Inc. 7

The newly added device profile may now be shown on the screen on the Identity/Device Profiles page when you click the Search button with proper search criteria.

Click the device profile on the screen to view or make changes to the device profile

User and Line/Port

Create a New User in DMS

Click (Group Level) Profile on the left side and click Users on the Profile page:

Obihai Technology Proprietary Information

Copyright 2010-2017 Obihai Technology, Inc. 8

Click Add button on the Users page:

Enter the User ID and other required data for the new user on the Users Add page. Then click OK to save the new user:

Obihai Technology Proprietary Information

Copyright 2010-2017 Obihai Technology, Inc. 9

The newly added user may now be shown on the Users page when you click the Search button with proper search criteria. Click the specific user entry on the Users page to view/modify the profile of that user. Note that when you click the link of a specific user, you enter the User Level of the DMS portal as indicated at the top left corner of the web pages.

Change Web/Portal User Login Password

Click (User Level) Profile on the left and click Passwords on the (User Level) Profile Page

Note: This password is only for user login to the BroadSoft DMS/User Portals or other web applications. It is not used for SIP authentication, which would require additional passwords as described in the steps below.

Add Authentication Service to a New User

All Users that have been assigned to use an Obihai device profile must have Authentication Service enabled in the DMS. However by default a newly added user does not have this service enabled. You can follow the following steps to add the service to a new user:

Click the new user on the Users page and select Assign Services on the (User Level) Profile page of the selected user:

Add Authentication from the Available Services column to the User Services column (if it is not already there), then click OK to save the changes:

Obihai Technology Proprietary Information

Copyright 2010-2017 Obihai Technology, Inc. 10

Click the (User Level) Utitlites link on the left side menu and click Authentication on the Utilities page:

On the Authentication page of the selected user, enter the username and password (which will be used for SIP authentication):

Assigning the Primary Device Line/Port to a User

Each User in the system may be assigned a primary Line/Port from a specific device profile. For each assignment, the DMS allocates the next available Line/Port from the selected device profile, until all the Line/Ports in that device profile have been allocated. Note that the number of available Line/Ports in a device profile is fixed per the device type from

Obihai Technology Proprietary Information

Copyright 2010-2017 Obihai Technology, Inc. 11

which the profile is created. For example, the number of Line/Ports for each Obihai-OBi1062 based device profile is 6. Here are the steps to assign a device Line/Port to a User:

Select the User to configure and click (User Level) Profile on the left, then click Addresses on the (User Level) Profile page for the selected User (note the User ID of the selected User on the upper left corner of the page):

On the Addresses page click the Identity/Device Profile Name drop down and select the device profile to assign this user to:

Note that if you enable Shared Call Appearance feature on a User, you will have the opportunity to add one or more secondary Line/Ports to the User. These secondary Line/Ports should normally come from different device profiles.

Viewing Configuration Files Generated by DMS for a Device Profile By default DMS splits the Obihai device configuration into 3 files: a Template file, a System file, and a MAC file. The precise filenames for these files vary a little based on device model numbers:

For {model-number} = 504, 508, 1022, 1032, and 1062, the three filenames are:

OBi{model-number}Template.xml, OBi{model-number}System.xml, and OBi{model-number}-{MAC}.xml

For {model-number} = 300 and 302, the three filenames are:

Obihai Technology Proprietary Information

Copyright 2010-2017 Obihai Technology, Inc. 12

Obi{model-number}Template.xml, Obi{model-number}System.xml, and {MAC}.xml

where {MAC} is the device MAC address in upper case HEX characters, such as 9CADEF1A2E3C. Note that the filenames are case-insensitive (hence in the filename OBi is the same as Obi, 9CADEF123456 is the same as 9cadef123456). Each of the three files is a valid Obihai device configuration file that covers a subset of the configuration parameters. Normally the Template file is the first file the device would download. After processing this file, the device would automatically proceed to download the System file and the MAC file. Following this flow, the device administrator needs to make sure the device is initially setup to download the corresponding Template file in the ConfigURL parameter.

DMS keeps the above set of three configuration files for each Obihai device profile. These files are automatically (re)generated when changes are made to the device profile. For example, whenever a Line/Port of the device profile is allocated to a User, or when some changes are made to the profile of the user that has been assigned one of its Line/Ports, etc. For example, follow these steps to access the configuraiton files for “Joe’s OBi1022”:

To view the configuration files for “Joes OBi1022”, first bring up the device profile page:

o Click (Group) Resources and click the Identity/Device Profiles link

o Search for “Joe’s OBi1022” on the Identity/Device Profiles page and click the entry when it shows up on that page:

o On “Joe’s OBi1022” Device Profile page, click the “Files” tab on the top to see the files generated for this device profile:

Obihai Technology Proprietary Information

Copyright 2010-2017 Obihai Technology, Inc. 13

Note that the three configuration files are generated from the corresponding template files with the same name. The templates are common to all device profiles of the same device type. The template files can be modified by clicking the Edit link. The template may contain one or more tags (%xxx%) which would be expanded into actual parameter values if the tag defined (otherwise the generated file keeps the tag name as is for the corresponding parameter value) when the corresponding configuration file is generated.

Note that the request to download any of the three configuration files may be authenticated by the DMS. When challenged by the DMS, the device must authenticate itself using the Device Access User Name and Password defined in its device profile.

Organization of Obihai Configuration Files in DMS

As described above by default the Obihai device configuration is split into three files, where the device should be initially set up to download the OBi{device-model}Template.xml. The default Template file contains only a few parameters to set up how the device should contact the DMS (such as how often to poll the server, whether to use http or https, etc.), and the URL to download the OBi{device-model}System.xml and the MAC file. Subsequently, the device will only download the System file and the MAC file from DMS for any configuration updates. The System file normally contains parameters that are common among all devices, such as ProxyServer and OutboundProxy, while the MAC file normally contains parameters that are different for each device, such as AuthUserName and AuthPassword for each SIP Account.

However this is just a guideline, not a requirement. When it is more convenient, it is perfectly alright to keep all parameters in just the MAC file, and have the device download just the MAC file from the very beginning. To do this one can merge the contents of the three templates into one template to replace the MAC template file in DMS, and set the ConfigURL parameter in the Obihai device to point to the MAC file in DMS. You should remove any duplicate parameters in the merged MAC file, and should not include the ConfigURL parameter in the original Template file template.

Preparation of New Obihai Devices for Provisioning by DMS From the above discussion we know which configuration files the devices should download from the DMS: The very first file that each new device (or after a factory reset) must download is OBi{model-number}Template.xml. The Obihai device parameter group that controls ITSP Provisioning on the phone is Auto Provisioning – ITSP Provisioning, in which the following parameters can be initially configured on a new device to download the first configuration file from DMS:

Method = System Start

ConfigURL = http://$SPRM0:[email protected]:80/dms/Obihai-$DM/${DM}Template.xml

The prefix “$SPRM0:$SPRM1” in the URL designates the username and password to use in case the HTTP request is challenged by the server. $SPRM0 and $SPRM1 are expanded into the value stored in the device parameter

Obihai Technology Proprietary Information

Copyright 2010-2017 Obihai Technology, Inc. 14

X_DeviceManagement.ITSPProvisioning.SPRM0 and X_DeviceManagement.ITSPProvisioning.SPRM1 respectively. These parameters are blank by (standard non-customized) default.

The Template file from the DMS is an OBi Device Configuration XML file that contains the following parameters (using OBi1022 as an example):

<?xml version="1.0" encoding="UTF-8"?> <ParameterList> <O> <N>X_DeviceManagement.ITSPProvisioning.</N> <P> <N>Method</N> <V>Periodically</V> </P> <P> <N>Interval</N> <V>3600</V> </P> <P> <N>ConfigURL</N> <V> SYNC http://$SPRM0:[email protected]:80/dms/Obihai-OBi1022/OBi1022System.xml; SYNC http://$SPRM0:[email protected]:80/dms/Obihai-OBi1022/OBi1022-$MAC.xml </V> </P> </O> </ParameterList>

Note: Among the Obihai device template files shipped with DMS, only OBi1022Template.xml, OBi1032Template.xml, and OBi1062Template.xml includes the SPRM0/SPRM1 syntaxes as shown in the above insert; OBi504Template.xml and OBi508Template.xml uses GPRM0/GRPM1 instead of SPRM0/SPRM1 for the same purpose; OBi300Template.xml and OBi302Template does not include SPRM or GPRM syntax at all. You can modify the template files accordingly if you need to use this mechansim to insert user-name and password information for device authentication with the DMS.

After applying the configuraiton in the first Templage file, the ConfigURL parameter will be changed to download OBi{model-number}System.xml and OBi{model-number}-{mac}.xml. Note that $MAC is expanded internally by the device into the MAC address of the device.

When a Device Access User Name and Password are specified in the device profile, the DMS will challenge the device when it attempts to download a configuration file. The device must authenticate to the DMS with same user name and password. In other words, the Device Access User Name and Password must be stored into the SPRM0 and SPRM1 parameters before the device can be provisoned by the DMS. Note that SPRMn, for n = 0 – 7, are eight general purpose Obihai device configuration parameters that are not read/writable on the device’s built-in configuration web pages, but can only be set via device provisioning (i.e. by downloading a configuration file from a provisioning server).

Example Preparing an Obihai Device for DMS Provisioning By (standard non-customized) default all Obihai devices have the the follow setting: X_DeviceManagement.ITSPProvisioning.ConfigURL = tftp://$DHCPOPT66/$DM.xml

where $DHCPOPT66 is expanded into the value of the option 66 from the DHCP offer and $DM the deivice model, such as OBi1022 or OBi300, etc. Consider the following two cases:

A. Device Access User Name and Password either not configured or the same for ALL Device Profiles

Use the following example procedure:

1. Setup a DHCP server in a private LAN with option 66 that points to a TFTP server

2. Store a configuration file OBi{model-number}.xml (e.g. OBi1022.xml) on the TFTP server with the following contents:

<?xml version="1.0" encoding="UTF-8"?> <ParameterList> <O> <N>X_DeviceManagement.ITSPProvisioning.</N>

Obihai Technology Proprietary Information

Copyright 2010-2017 Obihai Technology, Inc. 15

<P> <N>Method</N> <V>System Start</V> </P> <P> <N>ConfigURL</N> <V>http://$SPRM0:[email protected]:80/dms/Obihai-$DM/${DM}Template.xml</V> </P> <P> <N>SPRM0</N> <V>common-device-access-username</V> </P> <P> <N>SPRM1</N> <V>common-device-access-password</V> </P> </O> </ParameterList>

Note that $DM will be expanded by the device into the device model name (such as OBi1022).

3. Unbox and connect each device to the LAN and wait until it has downloaded and saved the above configuration file

B. Device Access User Name and Password are configured differently for each Device Profile

Use the following example procedure:

1. Setup the DHCP server in a private LAN with option 66 that points to a TFTP server

2. Store a configuration file OBi{model-number}.xml (e.g. OBi1022.xml) on the TFTP server with the following contents (assuming the IP address of the TFTP server is 192.168.15.123):

<?xml version="1.0" encoding="UTF-8"?> <ParameterList> <O> <N>X_DeviceManagement.ITSPProvisioning.</N> <P> <N>Method</N> <V>System Start</V> </P> <P> <N>ConfigURL</N> <V>tftp://192.168.15.123/${DM}-${MAC}.xml</V> </P> </O> </ParameterList>

3. Store a configuration file OBi{model-number}-{mac}.xml for each device mac address (e.g. OBi1022-9CADEF790032.xml) on the TFTP server (at the IP address 192.168.15.123) with the following contents:

<?xml version="1.0" encoding="UTF-8"?> <ParameterList> <O> <N>X_DeviceManagement.ITSPProvisioning.</N> <P> <N>Method</N> <V>System Start</V> </P> <P> <N>ConfigURL</N> <V>http://$SPRM0:[email protected]:80/dms/Obihai-$DM/${DM}Template.xml</V> </P> <P> <N>SPRM0</N> <V>device-access-username</V> </P> <P> <N>SPRM1</N> <V>device-access-password</V> </P> </O> </ParameterList>

Obihai Technology Proprietary Information

Copyright 2010-2017 Obihai Technology, Inc. 16

4. Unbox and connect each device to the LAN and wait until it has downloaded and saved the MAC-specific configuration file

DHCP Option 66 to Reference DMS URL Directly

The last example illustrates how to use DHCP Option 66 to bootstrap device to be configured by the DMS. It entails the use of TFTP protocol only to download an intermediate configuration file from the IP address available from DHCP option 66. It is because with older Obihai device firmware, the device can recognize option 66 only if it is specified as an IP address of a TFTP server and only then it would proceed to download $DM.xml ($DM expands into OBi{model-number}) from the given IP address.

Starting from firmware release 3.0.2.xxxx for OBi300/302, 4.0.2.xxxx for OBi504/508, and 5.0.2.xxxx and 5.1.2.xxxx for OBi1022/1032/1062, the device can also recognize option 66 that is specified as a full URL (such as http://abcd.com/dms/Obihai-$DM/$DM-$MAC.xml) and will proceed to download the configuration file accordingly. Hence it is possible to direct the Obihai device to fetch configuration from the DMS by DHCP option 66 directly without needing any intermdiate provisioning.

Obihai “Zero Touch” Device Preparation for DMS Provisioning It is apparent from the above examples that, in order to prepare the device for provisioning by the DMS, the admin must first take the unit out of the box to configure some of the device parameters (X_DeviceManagement.ITSPProvisioning.ConfigURL and, if necessary, X_DeviceManagement.ITSPProvisioning.SPRM0, and X_DeviceManagement.ITSPProvisioning.SPRM1) before shipping the unit to the end user. Note that the value of the ConfigURL parameter varies for each DMS installation.

Obihai offers a ZT (or Zero Touch) service where by the units can be customized to have special default values. The process requires the customer to define a ZT profile which contains a small number of device onfiguration parameters with customized default values. Hence when a unit is powered on the first time it will already be configured to contact the proper DMS server for device provisioning. If Device Access authentication is not enabled in the DMS, the ZT profile may look just like the example XML file in Step 2 of Case A in the last section. Otherwise, the ZT process in combination with the OBiTALK.com/ITSP Portal can automate the setup of the SPRM0 and SPRM1 parameters without necessarily unboxing the units before shipping to the end-users, as described in the following procedure.

Zero-Touch Preparation of Obihai Devices for DMS Provisioning when Device Access User Name/Password are configured in the Device Profile in DMS

Use the following example procedure:

1. Contact an Obihai Sales Rep to request an OBiTALK.com ITSP Portal account created for your organization, with the “Managed-By-OBiTALK” feature turned on in that account

2. Define a ZT profile for your units at the time of placing an order. Obihai will review and install the ZT profile in their database. You may use a similar ZT profile as in Case A/Step 2 above, where the common SPRM0 and SPRM1 values, if configured, can be considered as the default DMS Device Access User Name and Password

3. When your order is ready to ship from Obihai factory, you can see a listing of the devices in your ITSP Portal Account. You will be able to view device information such as MAC Address, OBi Number, and Serial Number.

4. With the “Managed-By-OBiTALK” feature enabled (when you create the ITSP Portal account), your devices will also contact OBiTALK.com for device provisioning. This gives you an opportunity to configure individualized SPRM0 and SPRM1 values for each device as each device requests for configuration from OBiTALK.com. In general, Device Access User Name and Password are different for each DMS Device Profile. You can configure each device in your the OBiTALK.com/ITSP Portal account the proper SPRM0 and SPRM1 values that match the Device Access User Name and Password of the Device Profile that has been assigned the given device MAC Address.

Obihai Technology Proprietary Information

Copyright 2010-2017 Obihai Technology, Inc. 17

DMS with OBiTALK Device Provisioning Working Together We have already described above how using Obihai ZT can help with bootstraping device to DMS provisioning during initial setup. Subsequent to ZT during day-to-day operation, if device has Managed-By-OBiTALK enabled, you could further rely on OBiTALK to provide part of the device configuration not covered in your DMS provisioning. For example, you may choose to enable/disable Syslog debugging on the device from OBiTALK instead of DMS.

OBiTALK lets you set up device parameters for a group of devices or for a particular device. To set up a particular device, select the device from your ITSP Portal account on OBiTALK.com to enter the Device Configuration page of that device to make changes to any of the device parameters. To set up the device parameters for a group of devices, the group of device must be set up to reference the same base profile on obitalk: You can define up to 60 profiles in your ITSP Portal account and assign each device to reference of of these base profiles. A base profile is a device configuration file which one or more configuration parameters. By modifying parameter values in a base profile, all the devices referencing the base profile will get the update from OBiTALK.

Normally we expect OBiTALK to provision parameters that are NOT included in any of the DMS configuration files. In that case, the results of combining OBiTALK and DMS provisioning are very straightforward; the device gets the corresponding parameter values from OBiTALK and from DMS as configured. However, when both OBiTALK configuration and DMS configuration try to set the value of the same parameter, the DMS parameter value will always be used in favor. One important behavior derived from this is that once DMS sets a parameter value in the device, the device will NOT take the value for this parameter from OBiTALK again, until a factory reset of the device is done. For example, if at any time the DMS configuration file sent to the device contains the parameter X_DeviceManagement.Syslog.Server with any, then the device will not take the value for the same parameter from OBiTALK unti the device is factory reset. It does not matter if the parameter is subsequently removed from the DMS configuration files.

BroadSoft Custom Tags Device configuration template files may contain one or more parameter values that are specified as tags. A tag value is a tag name enclosed by a pair of %, such as %SBC_ADDRESS%. When a tempate file is invoked to generate the corresponding configuration file in the DMS to be sent to a device, the tag value is replaced with the actual value currently defined in the DMS. For example %SBC_ADDRESS% may become mysbc.abcd.com or 197.12.15.123 in the generated configuration file.

BroadWorks themselves have a lot of built-in tags with tag name that starts with BW, such %BWHOST-1% or %BWAUTHPASSWORD-1%. Refer to BroadWorks document on the available BroadWorks tags and their usage and meaning. BroadWorks tags are already defined in BroadWorks/DMS. However DMS admin may define additional custom tags to be used with the devices. The Obihai device templates contain several custom tags that may be useful for device administration in DMS. If the admin decides to use some of the Obihai suggested tags or add their own custom tags to the configuration file templates, these custom tags must be defined by the admin or their value will not be substituted during configuration file generation.

When a tag value say %some-tag% is not substituted by DMS, the value is used as is in the configuration file sent to the device and the device will use it like a normal parameter value and lead to unexpected behavior. For example, the OBi{model-number}System.xml contains the tag %IVR_PASSWORD% for the X_DeviceManagement.IVR.Password parameter, which by default is empty to allow full IVR access without needing to enter a password. However when this tag is not defined in DMS, the device would store the IVR password as %IVR_PASSWORD% which cannot entered from the phone as the password is not made of digits.