...
2. Manage Configuration
2.1 Htek IP Phone Provision Process
When Htek IP Phone boots up, it will issue request one by one for these configuration files named "cfgDeviceCode.xml" → "cfgMAC" → "cfgMAC.xml ".
...
But the "cfgDeviceCode.xml" could used to provision all phones if they are the same model, at the same time, "cfgMAC.xml" is unique for every phone.
Also, the The file "cfgMAC" is also unique for every phone. But it is proprietary binary format and is usually be used for backup the configurations because it is encrypted when you download it.
...
Thus we don't recommend you use it to provision the phone.
Configuration File Type | Example | Description |
---|---|---|
cfgDeviceCode.xml | cfg0012.xml | used for provisioning one model of phones |
cfgMAC | cfg001fc110d3a9 | this file is a private format for specific device |
cfgMAC.xml | cfg001fc110d3a9.xml | used for configuration for specific device |
...
- factory000x.bin is used in Htek factory, please don't try to provision it, otherwise it will influence the stability and Htek reserves the right to refuse to provide support in this case.
- If the phone retrieved a configuration file successfully, it will not continue to get the next one. For example, if the phone get cfg0010"cfgDeviceCode.xml" successfully, it will not try to get cfg001fc1xxxxxx and cfg001fc1xxxxxx"cfgMAC" and "cfgMAC.xml".
2.2 Obtain Configuration Template Files
You The fastest way you could obtain the cfgMAC.xml configuration template is to download it from any phones with factory default settings.
Just enter phone's webpage → Management → Configuration → Download Xml File.
And you could also use HPT (Htek Provision Tool Quick Guide) to generate the configuration files.
...
2.3 Manage configuration files
Auto provision enables Htek IP Phone to update automatically via downloading configuration files. Before provisioning, you may need to edit and customize your configuration file which is composed of many configuration parameters. A configuration parameter is associated with particular field in the web configuration page. A parameter consists of a Capital letter P and 2 to 5 digit numeric numbers. i.e., P2 is associated with "Admin Password" in the Advanced Page. For detailed parameter list, please refer to <<parameter list>> in page 77.
2.4 How to edit cfg000x.xml file
You can customize configuration parameters by editing XML configuration file "cfg000x.xml", and different device would use different file name. you can refer to << How to Edit cfg000x.xml>> in page 39.
2.5 How to edit cfg$mac file
The cfg$mac file is a binary format configuration.
We offer free Windows software to help you generate the configuration file, please refer to Htek Provision Tool Quick Guide.
2.6 How to edit cfgMAC.xml file
The format of the Htek cfgMAC.xml if simple.
P-Value is the element and value of the element represents the value for a particular configuration which P-Value represents corresponding.
Method 1:
You need to download cfg.xml file from IP Phone webpage(Management->Configuration ->Download xml file) or download this cfgMAC.xml file from website www.htek.com, then change the file name to cfgMAC.xml(mac is IP Phone address), and open the cfgMAC.xml, See the below screen shot:
The parameters edited in the cfgMAC.xml file are described as follows:
...
<?xml version="1.0" encoding="UTF-8" ?>
<hl_provision version="1">
<config version="1">
<!--Account1/Basic--> <P271 para="Account1.Active">1</P271>
<P47 para="Account1.Sipserver" />
<P967 para="Account1.FailoverSipserver" />
<P8851 para="Account1.SecondFailoverSipserver" />
<P4567 para="Account1.PreferPrimaryServer">0</P4567>
<P48 para="Account1.OutboundProxy" />
<P20047 para="Account1.BackUpOutboundProxy" />
<P130 para="Account1.SipTransport">0</P130>
<P52 para="Account1.NatTraversal">2</P52>
<P20000 para="Account1.Lable" />
<P35 para="Account1.SipUserId" />
<P36 para="Account1.AuthenticateID" />
<P34 para="Account1.AuthenticatePassword" />
<P3 para="Account1.DispalyName" />
<P103 para="Account1.DnsMode">0</P103>
<P63 para="Account1.UserIdIsPhoneNumber">0</P63>
<P31 para="Account1.SipRegistration">1</P31>
<P81 para="Account1.UnregisterOnReboot">0</P81>
<P32 para="Account1.RegisterExpiration">15</P32>
<P109 para="Account1.OutCallWithoutReg">1</P109>
<P40 para="Account1.LocalSipPort">5060</P40>
<P78 para="Account1.UseRandomPort">0</P78>
<P33 para="Account1.VoiceMailId" />
<P136 para="Account1.RPort">0</P136>
<P1100 para="Account1.RFC2543Hold">1</P1100>
...
You can edit the value in <></>field.
For example: The phone's SIP Server is 192.168.0.100, you need to edit the <P47 para="Account1.Sipserver">192.168.0.100</P47>.
If you want to configure others, for example: , you need to change it as , only in this way you can change the value.
Method 2:
Login phone webpage, configure each item you want (like, account information, programmable keys, firmware upgrade path...). Management ->Configuration, download XML file, then change the name to cfgMAC.xml.
...
You could refer to IP Phones Firmware & Release Note to get the latest firmware, so you will get the latest cfgMAC.xml. Also, you could contact support@htek.com.
2.3 Know about P-Code and P-Value
P-Code is a code starts with a capital letter P and follow by at least one positive integer.
One P-Code represents one single setting, like P47 represents Primary SIP Server of Profile 1, P747 represents Primary SIP Server of Profile 2.
The value of a P-Code is called P-Value.
For example, the Primary SIP Server of Profile 1 is 192.168.0.68:5060. In this case, P-Code is P47, P-Value is 192.168.0.68:5060.
2.4 Edit cfgDeviceCode.xml and cfgMAC.xml
The format of "cfgDeviceCode.xml" and "cfgMAC.xml" is very simple.
All the settings are contained in such a fixed structure like below.
Code Block | ||
---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8" ?>
<hl_provision version="1">
<config version="1">
......
...settings area...
......
</config>
</hl_provision> |
And the format of the setting is <P-Code para="Description">P-Value</P-Code>
, e.g., <P47 para="Account1_Sipserver">192.168.0.68:5060</P47>. Although the Description
field is not required, it is friendly for read.
You may see some settings don't have the same format, like <P-Code Para="Description" />, this format is only used when a setting is blank and has no default value.
Here is an example which contains a few settings to show the unbroken structure.
Code Block |
---|
<?xml version="1.0" encoding="UTF-8" ?>
<hl_provision version="1">
<config version="1">
<!--Profile1/Basic-->
<P47 para="Profile1_Sipserver">192.168.0.68:5060</P47>
<P967 para="Profile1_FailoverSipserver" />
<P4567 para="Profile1_PreferPrimaryServer">1</P4567>
<P24065 para="Profile1_DHCPSIPServer">0</P24065>
<P48 para="Profile1_OutboundProxy" />
<P20047 para="Profile1_BackUpOutboundProxy" />
<P130 para="Profile1_SipTransport">0</P130>
<P52 para="Profile1_NatTraversal">2</P52>
<P103 para="Profile1_DnsMode">0</P103>
<P63 para="Profile1_CallMessageFormat">0</P63>
<P24785 para="Profile1_TrsRelSetting">0</P24785>
<P31 para="Profile1_SipRegistration">1</P31>
<P81 para="Profile1_UnregisterOnReboot">1</P81>
<P32 para="Profile1_RegisterExpiration">15</P32>
<P24816 para="Profile1_FallBackInterval">600</P24816>
<P25092 para="Profile1_ServerRetryCounts">3</P25092>
<P109 para="Profile1_OutCallWithoutReg">1</P109>
<P136 para="Profile1_RPort">0</P136>
<P1100 para="Profile1_RFC2543Hold">1</P1100>
<P8775 para="Profile1_ConnectMode">1</P8775>
</config>
</hl_provision> |
If a P-Code is missed in a "cfgDeviceCode.xml" or "cfgMAC.xml" file, you could add it in the <settings area> just follow the format, but please note the validity of the P-Value.
For all P-Codes and the P-Value, please ask your sale, provider or support@htek.com for the file Htek_Parameter_List.
3. Encrypt cfgMAC.xml
Htek Configuration Generator allows user to encrypt the generated configuration file with AES 128-bit encryption. It allows user to choose not to encrypt the configuration file in Windows version, but it is recommended to use encryption for security reason.
...