Skip to end of metadata
Go to start of metadata

The XML provisioning file


Configuration data for Gigaset VoIP phones is provided by means of XML files.

XML files


XML files can be created based on templates that are delivered by Gigaset, you can download template here.

Configuration parameters


Each Gigaset IP phone has a lot of further configuration parameters which can be provided by the XML input file additionally to the provider data.


You can get more information about the available commands via:

Info

The list of modifiable parameters can change if further features are added to the phone in the future.

 

XML template - example

The following is a short extract from an example template.xml file.

<?xml version="1.0" encoding="ISO-8859-1"?>
<ProviderFrame xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="DE410.xsd">
<Provider>
<!-- Please enter the correct MAC Address example: 3E2F800E1234
Please enter correct Version value: DDMMYYHHMM example: 2811120928
Please enter a Profile name
If not correct, no settings will be changed
-->
<MAC_ADDRESS value="7C2F80208402"/>
<VERSION value="1001130101"/>
<PROFILE_NAME class="string" value="DE410"/>

<!-- Connected with phone system, 2 = Standard system -->
<I_PHONE_SYSTEM class="integer" value="2"/>

<!-- Allow access from other networks to the WEB configurator -->
<B_REMOTE_MANAGEMENT class="boolean" value="0"/>

<!-- VoIP account 1, example config -->
<B_SIP_ACCOUNT_IS_ACTIVE_1 class="boolean" value="true"/>
<S_VOIP_PROVIDER_1 class="string" value=""/>
<S_SIP_ACCOUNT_NAME_1 class="string" value="Gigaset PRO"/>
<S_SIP_LOGIN_ID_1 class="string" value="LoginID"/>
<S_SIP_PASSWORD_1 class="string" value="Password"/>
<S_SIP_USER_ID_1 class="string" value="LoginID"/>
<S_SIP_DISPLAYNAME_1 class="string" value="DisplayName"/>
<S_SIP_PROVIDER_NAME_1 class="string" value=""/>
<S_SIP_DOMAIN_1 class="string" value="192.168.178.100"/>
<S_SIP_SERVER_1 class="string" value="192.168.178.100"/>
<I_SIP_SERVER_PORT_1 class="integer" value="5060"/>
<S_SIP_REGISTRAR_1 class="string" value="192.168.178.100"/>

</Provider>
</ProviderFrame>

How to manage the VERSION parameter


The VERSION parameter in the XML file is somewhat special because it is not really a configuration item, but instead is used by the phone to detect whether there have been any changes in the configuration since the last time it was changed.
The parameter is a time string with the following mandatory format:


ddmmyyhhmm

where dd, mm, yy, hh and mm represent the decimal numeric values for day, month, year, hours and minutes respectively. Because the phone converts this string into an equivalent integer value, it is important to choose valid date & time values.


In the phone, the change detection algorithm works as follows:

  • Whenever the phone has requested and processed an auto-provisioning file, it converts the string contained in the VERSION parameter into an integer, which is saved in the non-volatile RAM.
  • In future, the phone compares this saved integer with the value of the integer calculated from the VERSION parameter contained in any newly requested auto-provisioning file.
  • As long as the two integers are equal, the phone assumes that the auto-provisioning file is identical with the old one, and will ignore it.
  • If, however, the integers are different, the phone assumes that a new auto-provisioning file has been issued and updates its configuration accordingly, replacing its saved copy of the integer with the one calculated from the new file.

For the auto-provisioning system, this means that whenever it wishes the phone to update its configuration, it must generate a new value of the VERSION parameter.


The design assumes that the auto-provisioning system will store this version string in the database entry belonging to a given end-customer, thus indicating the last time the configuration for that particular end-customer was changed.

 

  • No labels