Apart from the standard features users already expect from phones, what functions are important for the successful operation of a communication solution?
The most important functions are mostly not implemented by the end users themselves. During
installation and configuration, however, they form a basis that enables phones to be tailored to
user requirements.
This is the decisive factor that shows whether the advantages of IP-based voice services can
also be suitably integrated in the overall solution - from the user to the service provider.
IP terminals offer a range of functions and characteristics that were unknown or technically impossible in analog or early digital system environments (for example, ISDN). But increased
product flexibility requires more complex technology. For this reason, it is essential that VoIP
devices be optimally configured for users while at the same time expenditure (costs, time, training) must be kept to a minimum for service providers.
Different scenarios have different requirements. However the following factors are critical for
all solutions:
●Minimum network intervention or modification
●No inflexible or costly preconfiguration at the terminal
●No or minimum (one-off) user activities
There are two main scenarios:
Scenario 1: Communication solutions for medium-size and large businesses
This scenario has the following characteristics:
●A stronger focus on internal communication performance, in other words the company
runs key IT components itself. A typical example of this scenario is a Siemens HiPath 8000
real-time communication system installed in a company’s data center.
●Medium to large installations (1000 - 10,000 subscribers).
●Trained personnel available (IT, LAN and server operation), company-performed mainte-
nance or partial implementation of Managed Services.
The Deployment Service Tool (DLS) is best suited to this scenario. This tool enables optiPoint
terminals to be installed as plug-and-play devices and provides a range of high-performance
functions:
●Administration of up to 10,000 subscribers
A31003-J4260-M101-2-76A9, 03-2007
XML Configuration Management, Administrator Manual
1-1
xml_01.fm
Introduction
Overview and Areas of Use
●Simultaneous access for up to five administrators
●Client/server architecture
●Database
●Job management
●Provision of parameters and software for terminals
For detailed information on this tool, see the HiPath Deployment Service Administrator Manual.
Scenario 2: Hosted Office solutions in a carrier/Internet Service Provider (ISP) environment
●Small to medium-size businesses connected to central systems via a WAN or the Internet.
●LAN/WAN interfaces with NAT and firewalls.
●No company-performed maintenance, outsourcing of (voice) communication services.
●Administrative modifications from outside the customer LAN are either not possible (fire-
walls) or not desired - access to configuration information and software is only required
from the terminal.
A configuration procedure that is based on XML files is ideally suited to this scenario.
This manual is designed to help you get to know and correctly use XML configuration files. Follow these instructions carefully to use the tool as effectively as possible and avoid operating
errors.
The following chapters contain information on how to use XML configuration management as
well as detailed descriptions on how to configure and control terminals.
●XML Configuration Management: This chapter presents the concept and contents of
XML files and provides information on initial phone installation.
●XML Overview: This chapter describes the structure of an XML file and its elements. It lists
available tags and their parameters and provides an example for each case. Tags are sorted on the basis of the Web interface and refer to the entry in the corresponding dialog.
●WEB Interface: This chapter contains a graphical presentation of the Web interface with
the possible dialogs and corresponding jump labels for the relevant XML parameter description.
●Sample Configurations: This chapter contains brief examples of system and device con-
figurations together with corresponding references to parameter descriptions.
●Index: This section provides a comprehensive directory for finding terms in the dialogs and
XML parameters.
A31003-J4260-M101-2-76A9, 03-2007
XML Configuration Management, Administrator Manual
optiPoint SIP phones not only provide a direct interface to a management system (Deployment
Service), they also permit configuration tasks that are both system-independent and centralized.
In the course of these tasks, configuration parameters are stored as XML files on a server
where they can be retrieved independently by each phone. This results in a "loose" connection
between the management system (which places the configuration files on the server) and the
phones (which may be located in different WANs or LANs). In other words, a phone usually retrieves the information independently. Downloads are not initiated manually at the phone. Users do not require any knowledge of the LAN structure which means it does not have be to included in technical considerations.
●The phone can access the server (via FTP or HTTPS)
●The phone can download files independently (after startup or periodically)
●Technicians can trigger a download via a menu option (local administration menu or admin
Web pages)
●Users can trigger a download indirectly via a restart (by entering the restart sequence on
the keypad (- + * 2))
●A management system can trigger a download (SIP NOTIFY message)
If the downloaded configuration files contain information on a new application software version
available, the phone automatically downloads the software from the FTP software server.
The two configuration files are as follows:
●the system configuration file which contains identical parameters (for example, the soft-
ware version or registrar address) for all phones of the same model (for example, optiPoint
410 standard S) and
●the device configuration file which contains parameters for each phone (for example,
phone number).
It is also possible to specify that only the device configuration is loaded. This ensures that only
phone-specific parameters are modified. System-wide parameters that may be have been
modified locally on the phone, for example, are not affected.
The configuration download setup is only designed to configure parameters administered by
technicians. User parameters are not changed during this procedure. For information on configuration changes, see ! page 2-4.
A31003-J4260-M101-2-76A9, 03-2007
XML Configuration Management, Administrator Manual
2-1
xml_02.fm
XML Configuration Management
File Formats
If the configuration download setup program is not available, for example, if a configuration update server has not been installed, the phone does not initiate a download. In this case, an alternative procedure must be used for the configuration update.
2.2File Formats
2.2.1Configuration Files
Configuration files are stored on the configuration server. There are two kinds of configuration
files.
2.2.1.1System Configuration File
The system configuration file has a unique name for every phone model (for example,
op410adv_conf.xml). This file does not contain any phone-specific parameters (see
3-2).
! page
2.2.1.2Device Configuration File
Each device configuration file name contains the MAC address of the corresponding phone (for
example, op410adv_conf001E300A9F3.xml). This file only contains phone-specific parameters (see ! page 3-2).
2.3Download
2.3.1Downloading Configuration Files
Every phone expects a default account named "config" on the FTP server with the password
"config" (the plug-and-play settings are also located in the "Configuration management settings" dialog on the phone’s Web interface
been downloaded, the phone checks the file versions. To do this, it searches for a "systemconfig-version" tag in the system configuration file and a "device-config-version" tag in the device configuration file.
The phone then compares the system configuration file version with the version in the last
download. If the version has changed, the phone executes the write instructions in the system
and device configuration files
If the system configuration file version has not changed but the device configuration file version
has, the phone only executes the write instructions from the device configuration file. If neither
version has changed, the action is terminated.
When downloading configuration files, the phone first downloads the system configuration file
and then the device configuration file. Each parameter value in the system configuration file
overwrites an existing value. Each parameter value in the device configuration file overwrites
existing values and values from the system configuration file.
2.3.2Periodically Checking Configuration Files
To ensure that it always retrieves modifiable configuration parameters, the phone constantly
updates its configuration by activating a configuration server and periodically downloading configuration files (for example, once a day) while logged on to the SIP server.
This is useful in the following two scenarios:
●if the phone’s parameters are out of date because it was unable to download configuration
files (due to an FTP server overload, for instance), it still has the possibility of downloading
all modified new parameters.
●if the phone is in a state that does not support the notification mechanism, for example:
–the user is conducting a call
–the administration menu is currently activated
–the phone’s Web interface is currently in use
The periods between configuration file checks can be modified as required.
2.3.3Automatic Software Download
The device configuration file contains a tag called "dl-ftp-firmware-filename" which contains the
file name of the current software version. The phone treats this tag differently to other tags. If
the file name in the element is the same as the file name of the current software, the phone
skips this tag and continues processing the other tags in the configuration file.
However, if the file names are different, only the FTP download parameters are configured. After this configuration, the phone loads the new software and restarts. The configuration files are
reloaded during the restart. The phone now detects that it has the correct software version and
continues processing the remaining tags in the configuration file.
>
Once the download is complete, the optiPoint 410/420 restarts.
A31003-J4260-M101-2-76A9, 03-2007
XML Configuration Management, Administrator Manual
2-3
xml_02.fm
XML Configuration Management
Download
2.3.4Defining Configuration File Parameters in the Phone
ParameterWEB settings for Configuration Management
(menu ! page 4-25)
FTP IP
Description: ! page 2-5
FTP Port
Description: ! page 2-5
Pathname
Description: ! page 2-5
Account ID
Description: ! page 2-5
User Name
Description: ! page 2-5
Password
Description: ! page 2-5
Https DL Params
! page 4-25
Filename
Description: ! page 2-5
FTP server IP address or DNS name
FTP server port
FTP path
FTP account name
FTP username
New FTP password
IP address
IP address port:
File path for URL:
Configuration file name
File Type
Description
: ! page 2-5
Periodic Timer
Configuration file type
After registration, check for updates every n seconds.
Description: ! page 2-6
Unregistration Timer
Description
: ! page 2-6
Authentication
If registration fails, check for updates every n seconds
This parameter contains the IP address of the FTP server used for configuration download. The
address and port are normally obtained at startup via DHCP (as a "Vendor Specific" extension),
or if this fails, via DNS (as a text record linked to the phone’s domain name). When it is obtained
in this way, the address automatically updates this menu item. If the DHCP or DNS procedures
do not provide a valid IP address, the menu item value is used, provided it contains an IP address (in other words, if it is not empty).
The IP address cannot be modified if it has been obtained via DHCP or DNS. For other scenarios, the IP address editor can be accessed by clicking OK. The address can then be
changed in this editor. The updated address is used for the next configuration download. The
IP address is set during startup if a valid IP address is obtained via DHCP or DNS.
2.3.5.2Config Update FTP Port
The FTP server port used for configuration download.
2.3.5.3Config Update Pathname
The path from the FTP server root directory to the directory that contains the configuration files.
2.3.5.4Config Update Account ID
The name of the FTP user account that contains the configuration files.
2.3.5.5Config Update User Name
The name of the FTP user with configuration file authorization.
2.3.5.6Config Update Password
The FTP password used to download configuration files.
2.3.5.7Config Update Filename
The name of the system configuration file (also used as a template for the device configuration
file name).
2.3.5.8Config Update File Type
File name extension for the system configuration file (also used for the device configuration
file).
A31003-J4260-M101-2-76A9, 03-2007
XML Configuration Management, Administrator Manual
2-5
xml_02.fm
XML Configuration Management
Download
2.3.5.9Config Update Periodic Timer
The interval at which the SIP phone automatically checks for configuration file downloads after
registration (usually the primary line of a multiline phone). The value "0" deactivates this check.
2.3.5.10Config Update Unregistration Timer
The interval at which the SIP phone checks for configuration file downloads if it cannot perform
registration (any line of a multiline phone).
2.3.5.11Config Update Authentication
This parameter is only used in a BroadSoft environment. It indicates if digest authentication is
required for the check-sync notify message.
In order for it to reach the phone, the FTP, DLS or HTTPS server address must be entered in
DHCP option 43.
Tag 03 is used to configure the following:
●the FTP server:
"FTP://[<host-ip-addr>|<host-name>][:port"]"
●the HTTPS server
"https://[base URL of link on Download Web Server]
Option 43 on the DHCP server in the customer LAN must be modified accordingly before any
phone is configured. This must be done once so that no further intervention is required, no matter how many phones need to be installed or require maintenance.
The following step only applies to FTP and HTTPS servers.
Step 2
Generate the XML files and save them to the FTP or HTTPS server. XML files can either be
generated manually (for example, if you only want to use the model-specific file and not the
phone-specific file) or are generated by the platform management system (for example, BroadSoft).
A31003-J4260-M101-2-76A9, 03-2007
XML Configuration Management, Administrator Manual
2-7
xml_02.fm
XML Configuration Management
Installation
2.4.1.1Further Information on Option 43 (DHCP Support)
As there is no DHCP option for exchanging VLAN information via DHCP, the "Vendor Specific
Information" option (43) is used to encapsulate VLAN and download information. 1The following diagram illustrates the format of the "Vendor Specific" option.
Byte 1 contains tag "43", "Option 1 data" contains the "Siemens" identifier. The "VLAN ID" is
contained in "Option 2". Five padding bytes (starting at byte 20) and the "Terminate Option 255"
tag in byte 25 complete the option frame.
You must enter the server values if you have to specify a configuration download server for the
configuration update. You can enter the new option before or after the VLAN information but
the five padding bytes (value 0) and the "Terminate Option 255" tag must close the option
frame.
Example:
Code: 3
Length: 21
File: ftp://ftp.siemens.com (or https://www.siemens.com, for example)
The five padding bytes and the "Terminate Option 255" tag now complete the option frame in
byte 48.
1. Data is transferred from the application layer to the transport layer, where it is assigned a TPC or UDP header
and split into datagrams. The transport layer forwards the datagrams to the network layer which divides them
into packets and assigns them headers.
You can use a DNS TXT record to transfer the FTP, DLS or HTTPS server address to the
phone or you can enter it manually at the terminal.
2.4.2.1DNS Entry
Step 1
Generate a DNS TXT record with the following parameters:
●for the FTP server
"FTP://[<host-ip-addr>|<host-name>][:port"]"
●for the HTTPS server
"https://[base URL of link on Download Web Server]
The DNS TXT record is generated in the same domain as the phones. The domain name must
be configured in the phone.
The following step only applies to FTP and HTTPS servers.
Step 2
Generate the XML files and save them to the FTP or HTTPS server. XML files can either be
generated manually (for example, if you only want to use the model-specific file and not the
phone-specific file) or are generated by the platform management system (for example, BroadSoft).
2.4.2.2Manual
Step 1
Enter the IP address via Web admin or locally at the phone.
Step 2
Generate the XML files and save them to the FTP or HTTPS server. XML files can either be
generated manually (for example, if you only want to use the model-specific file and not the
phone-specific file) or are generated by the platform management system (for example, BroadSoft).
Step 3
Enter the data required for the configuration download: FTP server, user and password, account and path.
A31003-J4260-M101-2-76A9, 03-2007
XML Configuration Management, Administrator Manual
2-9
xml_02.fm
XML Configuration Management
Installation
The default user name and user password in the FTP server account data is "config". The setting is individual and can be modified.
The server, port, and path must be entered for the HTTPS server.
Step 4
The phone attempts to download the XML files either after manual initiation or a restart. A restart may be activated after download, depending on the modified parameters the phone receives.
XML files for system and device configuration contain tags (command lines) which can be used
to configure one or more optiPoint phones.
3.1Tag Structure
An XML file is a text file that contains "tags" (command lines) which can be edited using a text editor.
XML tags always have the same structure.
A parameter and a value is transferred for optiPoint phones. Each phone function is assigned a parameter which in turn can have one or more values. Some parameters may be interdependent.
Example:
<Item name="admin-pwd">123456</item>
A tag consists of three parts.
The first part (<Item name="admin-pwd">) specifies which parameters are transferred.
The second part (123456) defines the parameter value, in this example the administration password
"123456". The third part (</Item>) completes the tag.
Indexed XML tags are the exception as they contain an index in an additional fourth part.
Example:
<Item name=“function-key-def“ Index=“5“>1</Item>
This additional index, for example, specifies the number on the keypad or the value in question (index="5").
3.2Structure of an XML File
An XML file always has the same structure. It starts with the following tags:
<?xml version=“1.0“ encoding=“utf-8“ ?>
This tag describes the text file language (XML version and encoding).
<Message>
<Action>WriteItems</Action>
This tag instructs the phone to process the following tags.
<ItemList>
This chapter contains a list of other configuration tags that form the main part of the XML
file.
</ItemList>
</Message>
These tags complete the XML file.
A31003-J4260-M101-2-76A9, 03-2007
XML Configuration Management, Administrator Manual
3-1
xml_03.fm
XML Overview
Structure of an XML File
3.2.1General and Phone-Specific XML Files
Phones load the following two files during every XML upload:
●the general XML file for system-wide configuration.
●the device-specific XML file with settings that apply to specific phone models.
A phone uses the file name and XML header to differentiate between files.
3.2.1.1File names
The MAC address of the phone is attached to the file name of the device-specific XML file. The
first part of the name is generated using the type and version of the phone and suffixed with
the attribute "_conf" (op410adv_conf). This procedure ensures that a unique name is generated for every type of phone.
Example: op420adv_conf0001e321bb06.xml
The above example is a device-specific configuration file for an optiPoint 420 advance.
The following table contains a list of default file names:
At the start of the item list, you must specify whether the XML file contains a system-wide or
device-specific configuration. The header also contains the current file release.
Example of a system-wide configuration: 0001e321bb06
<Item name = "system-config-version">2005.09.20 09:54 GMT</Item>
Example of a device-specific configuration:
<Item name = "device-config-version">2005.09.20 09:54 GMT</Item>
Make sure you enter spaces before and after the "=" sign.
7
3.2.1.3Implementation in the Phone
The XML file can be provided via an FTP server (non-secure connection) or via a HTTPS connection.
●When using FTP, the IP address, user, password and filename must be entered on the
phone.
●When using HTTPS, the IP address or DNS of the URL, port number and path must be
entered on the phone.
For both types of synchronization you also need to configure the interval time to resynchronize
with the XML file, as well the device filename and extension.
For both procedures, a time interval must be specified in which the synchronization with the
XML file as well as with the device file name and file extension should take place.
A31003-J4260-M101-2-76A9, 03-2007
XML Configuration Management, Administrator Manual
3-3
xml_03.fm
XML Overview
Administration Tags
3.3Administration Tags
The sequence of tags described in this section is based on the sequence in WBM and its dialogs.
3.3.1System Tag
Determines whether there is a system-wide or device-specific configuration and whether the
file content was modified - in this case via the "Value" field. Every time the content of the "Value" field does not match the previous entry, the phone will read all items in the file. If the content
is unchanged, no action is taken.
3.3.1.1System config
Parametersystem-config-versionStart of system-wide configuration
file
Index–
Value2005.09.20 09:54 GMTDate and time of modification
<Item name = "system-config-version">2005.09.20 09:54 GMT</Item>
Example
NotesOnly applies to system-wide configuration - excludes device configuration
Make sure you enter spaces be-fore and after the "=" sign.
3.3.1.2Device config
Parameterdevice-config-version
Index–
Value2005.09.20 09:54 GMTDate and time of modification
Example<Item name = "device-config-version">2005.09.20 09:54 GMT</Item>
Start of device-specific configuration file
Make sure you enter spaces before and after the "=" sign.
NotesOnly applies to device-specific configuration - excludes system configuration.