Basefiles-Version 12 or greater

Owned by Nathaniel Halbrooks
Last updated: Mar 19, 2024 by Kelli Higdon
7 min read

 

 

Basefiles are complex, confusing, and extremely powerful, once understood.

Basefiles are designed with universal fields, however depending on the phone brand, and in some cases phone model, they generate the config files differently.  The best way to use them is to make a change, then look at the config file to see if it is how you want it.  It may take some playing, but they can do just about anything you want them to. 

V12 Basefile Features:

  • Simplistic design

  • Faster

  • Live example to see changes

 

We have enhanced Basefiles by displaying a sample config for you to edit.  We do not replace variables, but this allows you to visually see the changes made before having to test with a physical phone.

 

Per Brand Explaination:

Aastra

Aastra configs are a direct 1-to-1 relationship.

PARAMETER = VALUE.  

We wrap the values with quotes in case of symbol or non-standard characters are used in passwords/values/etc

 

Algo

Algo configs are a direct 1-to-1 relationship.

PARAMETER = VALUE.

The part of the parameter before the period is the section.

 

And

AND uses an XML style.

Every basefile entry requires a "Section" to be set.

For instance:

  • To add an entry to the SIPConfig section, "Section" needs to be set to SIPConfig (case sensitive).

  • To create a new section, "Section" needs to be the section it will be within (use "TOP" if it should not be in a section), PARAMETER is the new sections name, and VALUE would be "PARENT" to define it as a new section.    

 

Audiocodes

Audiocodes configs are a direct 1-to-1 relationship.

PARAMETER=VALUE.

The PARAMETER includes the path to the setting.

 

Cisco

  • SPA Series

    • Cisco SPA Series configs are XML based.

    • All entries are <PARAMETER ua=ATTRIBUTE>VALUE</PARAMETER>

  • Enterprise Series

    • Cisco Enterprise uses an XML style.

    • Every basefile entry requires a "Section" to be set.

    • For instance:

      • To add an entry to the SIPConfig section, "Section" needs to be set to SIPConfig (case sensitive).

      • To create a new section, "Section" needs to be the section it will be within (use "TOP" if it should not be in a section), PARAMETER is the new sections name, and VALUE would be "PARENT" to define it as a new section.

  • Legacy Enterprise Series

    • Cisco Legacy Enterprise configs are a direct 1-to-1 relationship.

        

Cortelco

Cortelco uses a nested XML style.

Every basefile entry requires a "Section" to be set.

For instance:

  • To add an entry to the Port_Config section, "Section" needs to be set to Port_Config (case sensitive).

  • To create a new section, "Section" needs to be the section it will be within (use "TOP" if it should not be in a section), PARAMETER is the new sections name, and VALUE would be "PARENT" to define it as a new section.

 

Cyberdata

Cyberdata uses a nested XML style.

Every basefile entry requires a "Section" to be set.

For instance:

  • To add an entry to the DeviceSettings section, "Section" needs to be set to DeviceSettings (case sensitive).

  • To create a new section, "Section" needs to be the section it will be within (use "TOP" if it should not be in a section), PARAMETER is the new sections name, and VALUE would be "PARENT" to define it as a new section.

 

Digium

Digium uses a nested XML style.

Every basefile entry requires a "Section" to be set.

For instance:

  • To add an entry to the codecs section, "Section" needs to be set to codecs (case sensitive).

  • To create a new section, "Section" needs to be the section it will be within (use "TOP" if it should not be in a section), PARAMETER is the new sections name, and VALUE would be "PARENT" to define it as a new section.

  • To add to an account section, the "Section" should be the account number.  The "Parameter" should be the account number before the section.  ie:0acount_id

   

Grandstream

Grandstream configs are a direct 1-to-1 relationship.

PARAMETER = VALUE.

Default entries have a description above.

Some characters need to be encoded, so if adding to basefiles please replace the following:
+    =    %2B
%   =    %25
=    =    %3D
&    =    %26

 

Mitel

Mitel uses a nested XML style, but simplified.  All entries are treated as a direct 1-to-1 relationship.

PARAMETER = VALUE

The small amount of nesting is done by the module.

 

Mocet

Mocet uses a nested XML style.

Every basefile entry requires a "Section" to be set.

For instance:

  • To add an entry to the codecs section, "Section" needs to be set to codecs (case sensitive).

  • To create a new section, "Section" needs to be the section it will be within (use "TOP" if it should not be in a section), PARAMETER is the new sections name, and VALUE would be "PARENT" to define it as a new section.

  • Every entry should also have a "Type" setting.  This defines what the value type should be. Either "string" for text or "integer" for a number.

    

Obihai

Obihai configs are a direct 1-to-1 relationship.

PARAMETER = VALUE.

 

Panasonic

  • Legacy Panasonic

    • Configs are a direct 1-to-1 relationship.

    • PARAMETER = VALUE.

    • We wrap the values with quotes in case of symbol or non-standard characters are used in passwords/values/etc

  • Current Panasonic

    • Configs use a nested XML style.

    • Every basefile entry requires a "Section" to be set.

    • For instance:

      • To add an entry to the codecs section, "Section" needs to be set to codecs (case sensitive).

      • To create a new section, "Section" needs to be the section it will be within (use "TOP" if it should not be in a section), PARAMETER is the new sections name, and VALUE would be "PARENT" to define it as a new section.

 

Phoenix

Phoenix configs are a direct 1-to-1 relationship.
PARAMETER = VALUE.

Polycom

Polycom uses a nested XML style with multiple files.
Every basefile entry requires the following.

  • A "File".

    • Needs to be the name of the file the setting will be in.  ie:mac-legacy, features, etc.  If you do not know what the file name is, click on an existing setting.

  • A "Section".

    • For instance

      • To add an entry to the Port_Config section, "Section" needs to be set to Port_Config (case sensitive).

      • To create a new section, "Section" needs to be the section it will be within (use "TOP" if it should not be in a section), PARAMETER is the new sections name, and VALUE would be "PARENT" to define it as a new section.

  • A "Parameter".

    • This is the setting name.

  • A "Value".

    • This is the actual setting.


Sangoma

Sangoma configs are a direct 1-to-1 relationship.
PARAMETER = VALUE.


Snom

Snom uses a nested XML style, but simplified.
All entries are treated as a direct 1-to-1 relationship.
PARAMETER = VALUE
The small amount of nesting is done by the module.


Uniden

Uniden configs are a direct 1-to-1 relationship.
PARAMETER = VALUE.
All Parameters are wrapped with % by the module.  You do not need to enter these.


Vtech

VTech configs are a direct 1-to-1 relationship.
PARAMETER = VALUE.


Xorcom

Xorcom configs are a direct 1-to-1 relationship with sections.
Every basefile entry requires a "Section" to be set.
For instance:

Yealink

Yealink has two styles.

 

Once complete. You need to go to either the template page and "Save and Rebuild" or the extension mapping page and rebuild the extensions affected.

 

This is only a simple example of what can be done.

Please, have patience, and take it step by step.

Samples:

1-to-1 Style

(Aastra, Algo, Audiocodes, Cisco Legacy Enterprise, Grandstream, Mitel, Obihai, Panasonic Legacy, Phoenix, Sangoma, Snom, Uniden, VTech, Yealink Current V70)

Config style:

Add Entry:

 

XML Sections Style

(And, Cisco Enterprise, Cortelco, Cyberdata, Digium, Mocet, Panasonic Current, Xorcom, Yealink Legacy)

Config style:

 

Add Entry:

 

XML 1-to-1 with Attributes Style

(Cisco SPA)

Config style:

 

Add Entry:

 

XML File and Sections Style:

(Polycom)

Config style:

Add Entry:

Return to Documentation Home I Return to Sangoma Support