Revolabs UC Provisioning Utility Help

Copyright © 2017, Revolabs Inc.

Version 24354

Introduction

Operation

The utility converts user input to provisioning files. The following example illustrates how a user can generate provisioning files for two devices.

1. A device with MAC address F0DEF1A064E6, that registers with the SIP server with credentials: ID(id6), Display Name(name6), Username(user6), and Password (password6)
2. A device with MAC address F0DEF1A064E7, that registers with the SIP server with credentials: ID(id7), Display Name(name7), Username(user7), and Password (password7)

Create Devices Input File

1. Create a file named devices.csv with Excel or similar software, and edit it
2. The following picture shows the file layout:
   
   Each line contains properties for exactly one device.
   The first column is the MAC address of the device, and the following columns contain "property name"-"property value" pairs.
3. Enter the lines as shown in the picture for the two devices. Do not specify empty properties, or properties that do not have a value in the devices input file.
4. Save devices.csv, then exit the Excel program.

Create Provisioning Input Files

All provisioning input files contain "property name"-"property value" pairs common to all devices specified in the devices.csv file. These files have ".prv" extension. Use the following steps to create, add, and edit the provisioning input files:

1. Open the Revolabs UC Provisioning Utility, and see the "ready!" message in the log view at the bottom in the following figure:
   
   
2. Select "Combined" in the provisioning input file view. "Combined" shows the combined common properties. After selecting "Combined," the common properties will be shown on the "Property Name"-"Property Value" view.
   Expand the property hierarchy as shown in the figure below:
   
   
3. While "Combined" is selected, press Ctrl+S on the keyboard (or File->Save in the menu) to save the combined properties to a file as shown in the following figure:
   
   
4. Create two more saved copies of this initial and default combined properties. Call them "test.prv," and "test_higher_prio.prv"
5. Now press Ctrl+O on the keyboard (or File->Open in the menu) to add a file to the provisioning input file area. You can also add files to this view using drag and drop feature of your OS. Add the newly saved file named "test.priv" using drag and drop, and it will show in the view as shown in the following figure:
   
   
6. Select the just added properties input file "test" in the provisioning file input, and expand its sys properties. Check on left of sys.region to include it in provisioning output.
7. Hover over a property name to see its description.
8. Double click on a property to see its default value and to change its value as shown in the figure below:
   
9. Press Ctrl+S on the keyboard to save the file "test.prv". This operation overwrites the file without asking.
10. User can click on a file in the provisioning input file view to perform operations on that file. User can Remove, Prioritize, and Deprioritize the file. User can also include/exclude all its properties with Check/Uncheck All Properties.
    

Combined Provisioning View

All provisioning input files shown in the provisioning input file view are combined to form the combined common properties view on the top of the list under "Combined." The lower the file is in the list, the higher its priority is in the overall combined view. Do the following step to see combined common properties of two or more files:

1. Press Ctrl+O on the keyboard (or File->Open in the menu) to add a file to the provisioning input file area. You can also add files to this view using drag and drop feature of your OS. Add the newly saved file named "test_higher_prio.priv" using drag and drop, and it will show in the view as shown in the following figure:
   
   
2. Select the just added properties input file "test_higher_prio" in the provisioning file input, and expand its voip properties. Check voip.registrar to include it in provisioning output. Double click on it to and enter sip.com as its value.
3. Click on "Combined" to see that input from "test" (sys.region) and input from "test_higher_prio" (sys.registrar) appears combined in the "Combined" common properties view. If two files set the same property to a conflicting value, the value from the file higher in priority is taken in the combined view.

Generating Device Provisioning Files

After all provisioning input files are prepared and added to the input file view, provisioning files for all devices can be generated.

1. Enter the provisioned build number in the firmware.version property of any input file (for example 2.5.204), or leave empty to not include it in the provisioning output. See the figure below:
   
   
2. Enter the provisioned firmware file name in the firmware.file property of any input file (for example FLX-UC1000-2.5.204.img), or leave empty to not include it in the provisioning output.
3. Press Ctrl+B to build the provisioning output (or use menu Provision->Build).
4. Select the "devices.csv" file prepared earlier in this help as shown in the figure below:
   
   
5. After the provisioning output is generated, a success message is shown in the log view as shown in the figure below:
   
   
6. Find that several XML files are generated for provisioned output: firmware.xml, test.xml, test_higher_prio.xml, and one for each device MAC, as shown in the figure below:
   
   
7. Move these XML files to the device provisioning folder of the server for DHCP/TFTP boot up configuration.

Tips

1. Each line in "devices.csv" file contains unique properties for that device. Number of columns and number of properties do not have to be same for all devices however, the first column must be the device’s MAC address.
2. Properties in "device.csv" have higher priority than properties in Combined common properties.
3. You can import existing XML provisioning files to the provisioning tool using the File->Import menu. Imported XML files contribute to the combined provisioning output. However, imported XML files cannot be saved.