Configuration files

Configuration files are the containers for a subset of configuration parameters (“Settings”). They are UTF-8 XML coded, and can be apply to a specific phone type and/or a specific MAC address.

Index

Used Tags
File format
Provisioning Parameter
Example of a simple configuration file
Example of a more extensive configuration file for a German user including address book entries & function keys
Example of a configuration file with most used parameters
Permission Flags

Used Tags

File format

The files should be written in the UTF-8 XML format. They can be segmented into the following tags:

<phone-settings>
<functionKeys>
<tbook>
<dialplan>
<ReplacementPlan>
<certificates>

Each of these tags can be stored as individual XML files, or within the <settings>-tag.

Provisioning Parameter

A provisioning parameter is defines as follows:

<parameter(1)> idx="<index>" perm="<permission flag>"<value></<parameter>
...
<parameter(n)> idx="<index>" perm="<permission flag>"<value></<parameter>

where:

parameter = provisioning parameter see: FAQ Desktop - Settings
idx = representing a valid SIP account index (Optional setting)
permission flag = see: Permission flags parameters
value = provisioning parameter value see: FAQ Desktop - Settings

Example of a simple configuration file

<?xml version="1.0" encoding="utf-8"?>
<settings>
  <phone-settings>
    <language perm="">English</language>
    <setting_server perm="R">https://my.pbx.com/{mac}</setting_server>
    <timezone perm="">ITA+1</timezone>
    <user_active idx="1" perm="RW">on</user_active>
    <user_realname idx="1" perm="R">John Doe - 401</user_realname>
    <user_name idx="1" perm="">401</user_name>
    <user_host idx="1" perm="">my.pbx.com</user_host>
    <user_active idx="2" perm="RW">on</user_active>
    <user_realname idx="2" perm="R">Artur Black - 500</user_realname>
    <user_name idx="2" perm="">500</user_name>
    <user_host idx="2" perm="">company.com</user_host>
  </phone-settings>
</settings>

Example of a more extensive configuration file for a German user including address book entries & function keys

<?xml version="1.0" encoding="utf-8"?>
<settings>
    <phone-settings> 
 
        <!-- General settings, e.g. localisation and update policy -->
         
        <update_policy>auto_update</update_policy>
        <phone_name perm="R">Gigaset-P820</phone_name> <!-- hostname of the phone. If set, the hostname is used to sign syslog packages and as the title of the WUI -->
        <language perm="">Deutsch</language>
        <web_language perm="">Deutsch</web_language>
        <date_us_format perm="">off</date_us_format>
        <dialnumber_us_format perm="">off</dialnumber_us_format>
        <timezone>GER+1</timezone>
        <tone_scheme>GER</tone_scheme>
 
        <!-- SIP identity settings. As config files contain sensible data such as user names and passwords in plaintext, please always make sure they are sent over a secure network connection -->
 
        <user_name idx="1" perm="">201</user_name> <!-- SIP account user name -->
        <user_pass idx="1">eR_63grTfhgm#</user_pass> <!-- SIP account password. Please always use strong passwords -->
        <user_host idx="1">192.168.2.1</user_host> <!-- SIP registrar -->
        <user_realname idx="1">P820</user_realname> <!-- display name of the registered identity -->
        <user_active idx="1">on</user_active> <!-- Enables the SIP account -->
         
        <!-- Security settings for admin mode and Web User Interface -->
 
        <admin_mode_password perm="">@GhRTyuvDs52L8</admin_mode_password> <!-- Please always use strong passwords -->
        <http_user perm="">gigaset</http_user>
        <http_pass perm="">BHgdVs64Fr3D#ft</http_pass> <!-- Please always use strong passwords -->
    </phone-settings>
 
    <!-- Here we define the functions and values of the fkeys on the phone -->
 
    <functionKeys e="2">
        <fkey idx="1" context="active" label="Meier" lp="on" default_text="$name" perm="">blf sip:202@192.168.2.1;user=phone</fkey> <!-- fkey monitoring line 202 -->
        <fkey idx="2" context="active" label="Müller" lp="on" default_text="$name" perm="">blf sip:203@192.168.2.1;user=phone</fkey> <!-- fkey monitoring line 203 -->
        <fkey idx="3" context="active" label="Schulze" lp="on" default_text="$name" perm="">blf sip:204@192.168.2.1;user=phone</fkey> <!-- fkey monitoring line 204 -->
        <fkey idx="5" context="active" label="" lp="on" default_text="$name" perm="">keyevent F_REDIAL</fkey> <!-- fkey with function show last dialled numbers -->
    </functionKeys>
     
    <!-- Phone directory entries locally stored on the phone -->
     
    <tbook e="2">
        <item context="active" type="none" fav="false" mod="true" index="0"><name>Kapowski</name><number>202</number><number_type>extension</number_type><birthday>00.00.99</birthday></item>
        <item context="active" type="none" fav="false" mod="true" index="1"><name>Stahl</name><number>203</number><number_type>extension</number_type><birthday>00.00.99</birthday></item>
        <item context="active" type="none" fav="false" mod="true" index="2"><name>Schulze</name><number>204</number><number_type>extension</number_type><birthday>00.00.99</birthday></item>
    </tbook>
</settings>

Example of a configuration file with most used parameters

<?xml version="1.0" encoding="utf-8" ?>
<settings>
  <setting-files>

	<!--########################################################-->
	<!--###               Phonebook Settings                 ###-->
	<!--########################################################-->

    <!--# The "url" parameter of the "file" field specifies the filename which contains the Company Directory -->

	<file url="http://www.gigaset.com/phonebook.xml"/>

  </setting-files>

  <phone-settings e="2">

	<!--# How to represent the User and Phone Number on the display of the device -->
	
		<user_idle_text idx="1" perm="">Gigaset P820</user_idle_text>
	
	<!--########################################################-->
    <!--###       SIP Settings for Identity 1      ###-->
    <!--########################################################-->

    <!--# The Extension Number must be specified in the "user_name" field. The "extension_number" variable will be replaced by the Extension's Extension Number.-->
    <user_name idx="1" perm="">102</user_name>

    <!--# The Authentication ID must be specified in the "user_pname" field. The "extension_auth_id" variable will be replaced by the Extension's Authentication ID.-->
    <user_pname idx="1" perm="">102</user_pname>

    <!--# The Authentication Password must be specified in the "user_pass" field. The "extension_auth_pw" variable will be replaced by the Extension's Authentication Password.-->
    <user_pass idx="1" perm="">xxxxx</user_pass>

    <!--# The "user_realname" field contains the Caller Name which the phone will send, and also the name which will be displayed on the phone's LCD.-->
    <user_realname idx="1" perm="">Gigaset P820</user_realname>

	<!--# Provisioning Update Link #-->
	<!--# The "setting_server" field specifies the URL from where the phone will retrieve its configuration file-->
    <setting_server perm="">http://www.gigaset.com/{mac}.xml</setting_server>

    <!--# the "update_policy" field specifies the update policy for the phone. Valid values are "auto_update"==Update Without Prompting User, "ask_for_update"==Prompt User To Allow Update, "settings_only"==Retrieve Settings Only, "never_update"==Do Not Retrieve Settings. The provisioning template sets the value to "auto_update"==Update Without Prompting User.-->
    <update_policy perm="">auto_update</update_policy>

    <!--# the "settings_refresh_timer" field specifies the frequency (in seconds) with which the phone will refresh its configuration and phonebook settings. Valid values are any positive integer, or "0" if you want to restrict the phone to refresh settings only upon reboot. The default value is "0".-->
    <settings_refresh_timer perm="">86400</settings_refresh_timer>


	<!--########################################################-->
	<!--###     Network Location Setting for Identity 1      ###-->
	<!--########################################################-->
	<mac_info_in_sip_register idx="1" perm="">On</mac_info_in_sip_register>

	<!--######################### LAN  #########################-->
	

	<!--# IP Address of the PhoneSystem to register to (SIP) #-->
	<!--# The "user_host" field contains the ip address and SIP port of the SIP Registrar and Proxy  -->
    <user_host idx="1" perm="">192.168.2.134:5060</user_host>


	<!--# Audio Default Port Range (SDP/RTP) #-->

	<!--# Supporting the DNS helper mechanism with explicit routing (RFC5626), offer_outbound requires keepalive_interval #-->
	<offer_outbound perm="">on</offer_outbound>
	<keepalive_interval idx="1" perm="">60</keepalive_interval>

	<!--# SPM Default Setting #-->
	<user_outbound idx="1" perm="">192.168.2.134:5060</user_outbound>

	<!--# Registration and Subscription timeouts/renewal #-->
	<!--# The "user_expiry" field specifies the length of time (in seconds) the phone will be registered. The phone will attempt to re-register before this time expires. The provisioning template sets the value to 120 sec (2 minutes). Valid values are any positive integer.-->
    <user_expiry idx="1" perm="">120</user_expiry>

    <!--# The "user_subscription_expiry" field specifies the length of time (in seconds) the phone will be subscribed for MWI and BLF notifications. The phone will attempt to re-subscribe before this time expires. The provisioning template sets the value to 900 (15 minutes). Valid values are any positive integer.-->
    <user_subscription_expiry idx="1" perm="">900</user_subscription_expiry>


	<!--# Filter Packets from Registrar set to off #-->
	<filter_registrar perm="">on</filter_registrar>



	<!--# This value specifies after how many seconds the phone should attempt to re-register when the initial registration has failed. If this value is zero, the phone will make no such attempt #-->
	<retry_after_failed_register perm="">30</retry_after_failed_register>

    <!--########################################################-->
    <!--###          Generic SIP Or Phone Settings           ###-->
    <!--########################################################-->
    <!--# Quick Transfer when pressing BLF and Speed Dial -->
    <quick_transfer perm="">blind</quick_transfer>																					   

    <!--# The "active_line" field specifies which will be the identity selected for making calls. The provisioning template sets the value to 1-->
    <active_line perm="">1</active_line>


    <!--# The "auto_connect_indication" field enables or disables a warning tone to play when the phone receives an intercom call. Valid values are "on"==Play Warning Tone, "off"==Do Not Play Warning Tone. The provisioning template sets the value to "on"==Play Warning Tone.-->
    <auto_connect_indication perm="">on</auto_connect_indication>

    <!--# The "time_24_format" field specifies whether to display the time in 24-hour format or in AM/PM format. Valid values are "on"==24-hour Format, "off"==AM/PM Format. The provisioning template sets the valut to "on"==24-Hour Format.-->
    <time_24_format perm="">on</time_24_format>

	<!--INVITE Requests without SDP should not change the state of the SDP. However, in the case of transfer via Bridges a sendrecv in the response is required.-->
	<sip_force_sendrecv_on_invite_wo_sdp idx="1" perm="">on</sip_force_sendrecv_on_invite_wo_sdp>

	<!--This setting may be used to enable the auto reboot feature during provisioning but preserve old behaviour if needed. Some settings need a reboot to get applied (i.e. vlan, dhcp, ip_address, etc.).-->
	<auto_reboot_on_setting_change perm="">on</auto_reboot_on_setting_change>

    <!--# The fields "codec1_name", "codec2_name", "codec3_name", and codec4_name" specify the codec preference order (with "codec1_name" being the first preference). Valid values are 0==G711u, 2==G726-32, 3==GSM, 4==G723, 8==G711a, 9==G722, 18==G729. The provisioning template sets the preference order to G711u, G711a, G729, GSM.-->
	<codec_priority_list idx="1" perm="">pcmu,pcma,g722,g729-annexb=no,telephone-event</codec_priority_list>

	<!--# The "user_srtp" enables or disables the RTP encryption via SRTP.-->
	<user_srtp idx="1" perm="">off</user_srtp>

    <!--# The "user_mailbox" field contains the destination number for the VoiceMail service. The "vm_number" variable will be replaced by the VoiceMail Menu Extension Number.-->
    <user_mailbox idx="1" perm="">999</user_mailbox>


	<!--# Default Ring Tone-->
	<user_ringer idx="1" perm="$">Ringer1</user_ringer>


	<!--########################################################-->
    <!--###       Language Settings                          ###-->
    <!--########################################################-->

	<language perm="">English</language>
	<web_language perm="">English</web_language>
	<tone_scheme perm="$">GBR</tone_scheme>

	<!--########################################################-->
    <!--###       Regional Settings                          ###-->
    <!--########################################################-->
	

	<always_show_active_call perm="">on</always_show_active_call>
	<transfer_dialing_on_other perm="">blind</transfer_dialing_on_other>
	<cw_dialtone perm="">on</cw_dialtone>
	<auto_dial perm="">off</auto_dial>

    <!--########################################################-->
    <!--###              Time and DST Settings               ###-->
    <!--########################################################-->

    <ntp_server perm="">pool.ntp.org</ntp_server>
    <timezone perm="">NLD+1</timezone>

	<!--# When you select “on”, the timestamps will be formatted in 24-hour format, otherwise in 12-hour format. -->
	<time_24_format perm="">on</time_24_format>
	

    <!--########################################################-->
    <!--###              Caller ID Display Settings          ###-->
    <!--########################################################-->

	<!--# Specifies how incoming and outgoing calls are displayed -->
	<display_method perm="">display_name_number</display_method>

	<!--# Prioritise which source for looking up details (names) to show in PUI takes priority. First one in list has highest priority. -->
	<contact_source_priority perm="">Sip Ldap InternalTbook Memory</contact_source_priority>


    <!--########################################################-->
    <!--###                 Other Settings                   ###-->
    <!--########################################################-->

	<!--# Change the hostname of the phone here-->
	<phone_name perm="">Gigaset-P820-102</phone_name>


	<!--# This setting controls whether digits pressed during a connected call are shown on the display or not. -->
	<show_ivr_digits perm="">on</show_ivr_digits>

	
		<!--# Remove entries in Call history, which contain Feature Access Codes -->
		<filter_numbers_from_history perm="">on</filter_numbers_from_history>

		<!--# Show MAC header in every SIP message -->
		<mac_info_in_every_sip_message perm="">true</mac_info_in_every_sip_message>

		<!--# This is the automatic number completion which will begin after you have entered the minimum number of digits -->
		<guess_number perm="">on</guess_number>
	
	<!--########################################################-->
    <!--###                 Security                   ###-->
    <!--########################################################-->

	<admin_mode perm="">off</admin_mode>
	<admin_mode_password perm="">xxxxxxx</admin_mode_password>
	<admin_mode_upon_http_login perm="">on</admin_mode_upon_http_login>
	<service_mode_login perm="">admin</service_mode_login>
	<service_mode_password perm="">xxxxxx</service_mode_password>
	<ignore_security_warning perm="">on</ignore_security_warning>
	<http_user perm="">admin</http_user>
	<http_pass perm="">xxxxx</http_pass>

    
    <webserver_admin_name perm="">admin</webserver_admin_name>
    <webserver_admin_password perm="">xxxxx</webserver_admin_password>
    <webserver_user_name perm="">user</webserver_user_name>
    <webserver_user_password perm="">xxxx</webserver_user_password>
    							 
	<!--########################################################-->
    <!--###                 User Security                   ###-->
    <!--########################################################-->

	<!--# Allows the user to lock the keyboard of the phone by holding down the * key -->
	<enable_keyboard_lock perm="">on</enable_keyboard_lock>
	<!--# User need to unlock the phone with the pin -->
	<keyboard_lock_pw perm="">123456</keyboard_lock_pw>
	<!--# Auto Locking of the phones keyboard after X seconds (0 for disabled) -->
	<keyboard_lock_timeout perm="">0</keyboard_lock_timeout>

	<!--########################################################-->
    <!--###           Transfer Settings                      ###-->
    <!--########################################################-->

	<!-- If you want to transfer two calls by placing the handset onhook (one incoming call and one outgoing call) -->
	<transfer_on_hangup perm="">on</transfer_on_hangup>

	<!-- If you want to transfer two calls by placing the handset onhook (independent of call direction (incoming / outgoing) -->
	<transfer_on_hangup_non_pots perm="">on</transfer_on_hangup_non_pots>

	<!-- If setting 'transfer on hangup' is set to on and the first call was picked up with a PBX starcode then the transfer will be done if this setting is set to on. -->
	<transfer_on_hangup_with_starcode perm="">on</transfer_on_hangup_with_starcode>

	<!-- This settings specifies at which point the transferring party will release the transferred call. -->
	<release_xferred_call_on perm="">100</release_xferred_call_on>

	<!-- This settings specifies at which point the transferring party will deem the transfer failed and retrieve the transferred call. -->
	<retrieve_xferred_call_on perm="">400</retrieve_xferred_call_on>

	<!-- When this option is set to ‘off’, a call on hold cannot be cancelled by pressing the CANCEL button , but has to be taken up again and then canceled. This prevents the accidental cancellation of calls on hold. -->
	<cancel_on_hold perm="">on</cancel_on_hold>

	<!-- Semi Attendant Transfer Solution for early hand off -->
	<attended_transfer_on_ringing perm="">off</attended_transfer_on_ringing>

  </phone-settings>

</settings>

Permission Flags

You can find an overview in the following article: Permission Flags

Note

It is recommended to write-protect those parameters that are crucial for the correct functioning of the phone, e.g. Provisioning settings, SIP registrar and user credentials.

Page tree