Grandstream XML User Manual

Grandstream Networks, Inc.

XML Configuration File Generator User Guide

Table of Content
INTRODUCTION.............................................................................................................	4
CHANGE LOG................................................................................................................	5
Version 4.1..................................................................................................................................	5
Version 4.0..................................................................................................................................	5
Version 3.5..................................................................................................................................	5
Version 3.4..................................................................................................................................	5
Version 3.3..................................................................................................................................	5
Version 3.2..................................................................................................................................	5
Version 3.1..................................................................................................................................	5
Version 3.0..................................................................................................................................	5
FILES IN THE PACKAGE...............................................................................................	6
Example TXT Config Template (Config_Example_Ver1.txt) .......................................................	6
Example CSV File (MAC_Ver1.csv) ...........................................................................................	9
Example XML Config Template (Config_Example_Ver2_GXV.xml) .........................................	10
Example CSV File (MAC_Ver2_GXV.csv) ................................................................................	11
USE THE XML CONFIGURATION GENERATOR........................................................	13
Program Menu ..........................................................................................................................	15
General Settings .......................................................................................................................	16
Use CSV file to Generate XML files..........................................................................................	17
Use Manual Settings to Generate XML Files............................................................................	18

P a g e | 2

XML Configuration File Generator User Guide

Table of Figure
Figure 1: Files in the package .......................................................................................................................	6
Figure 2: Example CSV file in Excel .............................................................................................................	9
Figure 3: Example CSV file in Notepad++ ....................................................................................................	9
Figure 4: Example CSV file in Excel ...........................................................................................................	11
Figure 5: Example CSV file in Notepad++ ..................................................................................................	11
Figure 6: Program GUI - I............................................................................................................................	13
Figure 7: Program GUI -II............................................................................................................................	14
Figure 8: Program GUI - III..........................................................................................................................	15
Figure 9: Program Menu .............................................................................................................................	15
Figure 10: General Settings ........................................................................................................................	16
Figure 11: Use CSV file to generate XML ...................................................................................................	17
Figure 12: Use Manual Settings..................................................................................................................	18

P a g e | 3

XML Configuration File Generator User Guide

INTRODUCTION

All Grandstream SIP products support being provisioned by an XML configuration file which consists of <Pxxxxx > tags (xxxxx is a number that can be 0-99999) known as P values. Every P value is mapped to a configurable option of the device. By setting/changing the values of those P values, we can provision the device with zero touch. This XML provisioning mechanism is beneficial to every GS customer since the very beginning. To learn more about Grandstream SIP device provisioning, please refer GS SIP Device Provisioning Guide.

Since there are thousands of P values for each product, and all required configurations come with a default value, usually there is no need to set all the P values but only the ones to be customized in real usage. Also, some users, especially resellers and VoIP providers, need to deploy a lot of devices by using the XML files that only have different SIP credentials while all other settings such as network settings, call feature settings, audio settings and etc., which are the same parameters. Creating XML file one by one for each device is very time consuming. This XML configuration file generator is designed to save time for these customers in this situation.

The principle of this software is to use a TXT/XML format file to store all these “same” values of P values, and use a CSV format file to store the “various” value of P values, and generate a batch of XML configuration files from the two input files, with most identical settings having only a few fields different.

This user guide introduces how to use the windows-based XML configuration file generator to create XML configuration files.

P a g e | 4

XML Configuration File Generator User Guide

CHANGE LOG

Version 4.1

•Added support for Ver 2 XML template. (Only with CSV setting, not manual setting as alias may be different for each product.)

•Added support to self-adjust to high resolution screen and the scale and layout settings.

Version 4.0

•Added support for customized CSV file header to support unlimited P values. (for multiple accounts). Since v4.0, the CSV header must be the P values except the “mac” column. Users can add as many P values as needed into their CSV files to generate new XML config files.

•Removed restriction for GS MAC OUI, now it supports any MAC OUI address for GS Wave devices.

•Updated the UI to break CSV file and manual settings into 2 separate tabs to avoid confusing.

Version 3.5

•Fixed the issue that Windows Defense consider this tool as virus.

Version 3.4

•Added support for Grandstream new MAC OUI, now MAC address start with “C074AD” (not case sensitive) will also be supported.

Version 3.3

•Fixed bug that mistakenly escape \ sign into ', correct it to escape ‘ into '.

Version 3.2

•Added Gateway and Subnet Mask setting in CSV file.

Version 3.1

•Added IP address setting in CSV file.

•Fixed encrypt xml file could crash because of some template have non-ascii string issue.

Version 3.0

•Initial Version of 3.x, changed GUI framework from windows 2.3.

P a g e | 5

XML Configuration File Generator User Guide

FILES IN THE PACKAGE

After unzipping the software package, you will find all the files as below screenshot.

Figure 1: Files in the package

Main program is: GSXmlGenerator_[version].exe, double click the exe file to open it.

Example_Configure_CSV_file: It is a folder contains four example files. One example file is the “TXT format file” which is the configuration template containing all the constant P values (SIP credential P values can be different). The second example file is a CSV file which contains variables for SIP credential related P values for the “TXT format file”. The third example file is the “XML format file” (using GXV model as the example) which is the configuration template containing all pre-configure parameters (SIP credential parameters can be different). The fourth example file is a CSV file which contains variables for the preconfigure parameters for the “XML format file” (using GXV model as the example).

Notes:

1.For XML format file examples, the parameters in the XML template and the CSV file should match the parameters in the corresponding model (for different models, e.g. GXV/DP models, the parameter for the same option may be different) so that the parameters can be provisioned into the device successfully.

2.If the parameters in the CSV file do not exist in the XML template, the parameters will be created in the generated XML files.

Example TXT Config Template (Config_Example_Ver1.txt)

Below is the txt config template in the downloaded folder. It only includes a few P values for the most basic SIP account settings. You can always add as many P values as you need.

To find all the P values, you can download the full P value config template for all the devices from Grandstream Networks official website tools page.

P a g e | 6

XML Configuration File Generator User Guide