From Snom User Wiki
Introduction
Setting files are container for a subset of configuration parameters needed to customize and maintain snom phones remotely.
Format
Depending on the firmware version currently installed on the snom phones two formats can be distinguished:
| Firmware Version
| Text Format
| XML Format
|
| 4,5,6
| full provisioning support
| NOT applicable
|
| 7
|
limited provisioning support
|
full provisioning support:
|
Structure
Both formats are structured distinctly
| Structure
| Text Format
| XML Format
|
| File Types
|
- One "general setting file" per phone type, i.e. snom300, snom320, etc., containing general configuration parameters
- One "specific setting file" per phone, i.e. (MAC address based), contain phone specific configuration parameters
- One "firmware setting file" per phone type OR phone containing firmware related configuration parameters in order to perform automated firmware updates
|
- One "general setting file container <setting-files>" per phone type, i.e. snom300, snom320 etc., providiong a list of setting file URLs linked to:
- One "settings container (<settings>)" per phone type containing general configuration parameters grouped in XML tags (<phone-settings>, <functionKeys>, <tbook>, <dialplan>) OR/AND individual XML Settings Files per phone type containing general configuration parameters:("Phone settings setting file", "Function key setting file", "Directory setting file", "Dial plan setting file")
- One "Phone user interface language file container" per phone type with a list of phone user interface language file URLs
- One "Web user interface language file container" per phone type with a list of web user user interface language file URLs
- One "specific setting file container <setting-files>" per phone, i.e. MAC address based, providing a list of setting file URLs linked to:
- One "settings container (<settings>)" per phone containing phone specific configuration parameters grouped in XML tags (<phone-settings>, <functionKeys>, <tbook>, <dialplan>) OR/AND individual XML Settings Files one per phone containing phone specific configuration parameters:("Phone settings setting file", "Function key setting file", "Directory setting file", "Dial plan setting file")
- Firmware setting files contains a subset of firmware related configuration parameters allowing automated firmware updates
|
Syntax
Both formats require distinct syntax.
| Syntax
| Text Format
| XML Format
|
| Description
|
<html>
<pre>
#comment
<parameter(1) name><flag>:<value>
...
#comment
<parameter(n) name><flag>:<value>
</pre>
</html>
|
The syntax depends on the XML tag:
|
| Coding
| ASCII
| UTF-8
|
| Hints
|
- lines may end with newline or carriage return/newline pairs
- Comments start with "#" or "<"
- The "<" and ">" characters allow easy integration of HTML tags
- Names may consist of the characters a-z, A-Z, 0-9 and _.
|
<?xml version="1.0" encoding="utf-8"?>
|
| Flags
| Parameter names can be followed by one specific character called flag:
- A parameter followed by ! can be changed by the user. However the parameter value will only be stored if that parameter has not been configured yet. Only parameters followed by $ can be overwritten, DO NOT use ! in that case.
- A parameter followed by & (or no flag) becomes write-protected (read only)
- A parameter followed by $ can be changed but will be overwritten on reboot. $ will appear on the Settings page as ! (available from firmware version 4.2 onwards)
| Flags are defined as "permission flags" in the string "perm" within XML tags. Valid values are:
- perm="!": The configuration parameter can be changed by the user. However the parameter value will only be stored if that parameter has not been configured yet. Only parameter definitions using perm="$" can be overwritten, DO NOT use perm="!" in that case.
- perm="&" or perm="R" or perm=" ": The configuration parameter becomes write-protected (read only)
- perm="$" or perm="RW" The configuration parameter can be changed but will be overwritten on reboot.
|
Hints
| Hints
| Text Format
| XML Format
|
| Start
|
- Start with a factory resetted phone
- Apply the desired modifications in your working (live) phone environment first.
- Observe the stability and performance of the applied changes.
- Do NOT use the complete parameter list as starting point, instead:
- Delete or uncomment unused configuration parameters from the complete parameter list.
- Specify only those parameters you really want to change --> Check the meaning of each parameter before usage.
- Finally your setting file may contain only a few parameters as shown in the sample file (Text / XML).
|
| Flags
|
- Do NOT use read- only flags at the beginning. They can be added at last in order to protect certain parameters to be notified by the user!
- Inside firmware setting files do NOT use any flags at all.
|
| Network/System Settings
|
- Do NOT provide network settings when using DHCP.
- Do NOT specify setting_server unless a redirection to a different setting server is desired.
- Remember the phone has already obtained the setting file correctly - repeated usage of the same setting server can have unpredictable side effects and is NOT recommended
|
| Firmware Setting Files
|
- Do NOT specify neither bootloader (FW < Version 5)] nor firmware inside setting files:
- In order to perform automated firmware updates specify a firmware setting file URL inside firmware status which points to the firmware setting file containing the firmware image URL.
- Inside firmware setting files use ONLY the configuration parameters bootloader (FW < Version 5)] or firmware
|
