XSTIM - No Touch Cloud Provisioning

Table of Contents

1. Introduction
2. Prerequisites
3. Accessing the Provisioning Tool
4. Filtering Phones

1. Introduction

E-MetroTel's No-Touch Cloud XSTIM phone provisioning allows customers to activate and pre-configure XSTIM phones using a new Cloud Phone Provisioning Tool located on the E-MetroTel Partner Portal web site. Plug-in the phones into the LAN with internet access and the phones will retrieve their respective configuration files from the E-MetroTel Cloud repository servers. Easy!

Access to the XSTIM Provisioning Tool is provided to our valued partners who have access to E-MetroTel's Partner Portal.

2. Prerequisites

  • Access to E-MetroTel's Partner Portal.
  • The phone is connected to a network with internet access.
    NOTE: If your network is configured with DHCP Option 66 to retrieve configuration files from an internal server, this needs to be temporarily disabled to allow the phones to retrieve configuration files from E-MetroTel's public repository.
  • The XSTIM Infinity Phone must be on firmware version 2.0.4.6.35 or higher.
    NOTE: If the phone does not have the latest firmware release, as long as the firmware server path and the configuration server path fields are set to their default values, on boot-up it will automatically retrieve and update itself to the latest firmware and then proceed to retrieve the configuration file. The default server paths out-of-box are:
    • Firmware Server Path = repo.uc-x.org/infinity.fw
    • Configuration Server Path = repo.uc-x.org/infinity.cfg

3. Accessing the Provisioning Tool

Login to the Partner Portal with your partner account. (https://www.emetrotel.com/online-partner-portal/)

 
From the Partner Portal, click on the Infinity Phones Provisioning icon.

Phone List

The default screen shows a list of the phones that have been assigned to the reseller(s) associated with your account.
If the phone you want to configure does not appear in this list, then you have to go to Section 9 to register the phone first.

4. Filtering Phones

You can filter entries in the phone list by clicking on the  Filter Items  expand link box

Enter a full or partial value in any of the listed fields and click on the  APPLY  button.

To clear the search, click on the  RESET  button.

5. Updating Phones

There are two ways to make changes to the phones in the list:

  • One phone at a time
  • Bulk update

5.1 Update One Phone

From the Phone List, click on the Serial Number link of the desired phone.

From the Phone Details page, modify the desired fields and click on the  APPLY  button to save the changes.

Note that the Activation and Expiry Dates cannot be modified. 

5.2 Bulk Update

The phone(s) can also be updated from the Summary page by selecting the desired phones and using the UPDATE function on the page.

  1. Select the phone(s) by clicking on the checkbox beside the phone(s), or click on the checkbox in the header to select all phones in the list.
  2. Update the desired fields in the area beneath the Phone List - UPDATE SELECTED ENTRIES.
  3. Fields that are left blank will not be updated, that is, the field will retain its current value.
  4. Click on the  UPDATE  button.

6. Exporting Phones

If you want to keep a record of the configuration settings of your phones, you can export the list of phones to a CSV file. From the Phone List page,

  • Filter the phone(s) to your desired list.
  • Click on the  EXPORT  button.

7. Clearing Configuration Data

You cannot delete phones from the list, but you can delete the configuration data of the phone(s). From the Phone List page,

  • Select the phone(s) by clicking on the checkbox beside the phone(s), or click on the checkbox in the header to select all phones in the list.
  • Click on the  CLEAR  button.

When the configuration data is cleared, the phone's configuration information will not be changed by this tool.

8. Retrieving Configuration Files

8.1 E-MetroTel Public Repository

When a phone is added to the Provisioning Tool, the corresponding configuration file is created and placed on the E-MetroTel public repository. Any changes made in the Provisioning Tool will be reflected immediately in the configuration file stored on the public repository. Most importantly, the phone must be configured to retrieve via HTTP or HTTPS from the E-MetroTel public server:

  • Firmware Upgrade Mode = HTTP or HTTPS
  • Configuration Server Path = repo.uc-x.org/infinity.cfg 

When the phone is power cycled, it will then retrieve its own configuration file.

8.2 UCX Server

The XML configuration file generated by the provisioning tool can also be downloaded and then placed on the UCX Server.
This allows phones to retrieve their configuration file from the UCX Server instead of the public repository.

Perform the following steps to download the XML configuration file:

  • From the Infinity Phone List, click on the desired phone entry.
  • From the Phone Details page, click on the  DOWNLOAD XML  link located on the bottom right.
  • Click on the desired filename to download the file.

The XML configuration file(s) can now be uploaded to the tftpboot directory of the UCX Server.

See Infinity 5000 Series - Auto Firmware Update to configure your UCX to provide phone firmware updates.
Now configure the phones to retrieve both firmware and configuration file(s) from the UCX Server:

  • Firmware Upgrade Mode = TFTP
  • Firmware Server Path = <IP Address of UCX Server> (e.g. 192.168.1.200)
  • Configuration Server Path = <IP address of UCX Server> (e.g. 192.168.1.200)

9. Registering Phones

9.1. Child SN Registration

From the Partner Portal, click on the Child SN Registration icon.

All the unregistered software and hardware that is associated with your account will be listed on this page.

To register the phone(s), perform the following steps:

  1. Select the checkbox beside the phone in the Unregistered Hardware section.
  2. Enter the Serial Number of the UCX Server that the phone(s) will connect to in the Assign To UCX Parent section.
  3. Click the  ASSIGN TO UCX PARENT  button.

If the phone(s) are not listed here, then proceed to the next section Upload Hardware.

9.2 Upload Hardware

From the Child SN Registration page, click on the  Child Serial Number Hardware Upload  button at the top right of the page.

There are 3 methods to upload your hardware: Manual, Import CSV file, Barcode Reader.

METHOD 1 - Manual

To add the phone(s) manually, perform the following steps:

  1. Select the Manual radio button
  2. Select the Reseller Name from the drop-down list
  3. Enter the Serial Number of the phone(s)
  4. Click the  ADD TO UNREGISTERED HARDWARE  button to add the phone(s)

METHOD 2 - Import CSV file

To add the phone(s) using CSV file, perform the following steps:

  1. Select the Import CSV file radio button
  2. Select the Reseller Name from the drop-down list
  3. Click the Choose File button and select the CSV file containing the list of serial numbers.
  4. Click the  UPLOAD  button to add the phone(s)

METHOD 3 - Barcode Reader

To add the phone(s) using a barcode reader, perform the following steps:

  1. Select the Barcode Reader radio button
  2. Select the Reseller Name from the drop-down list
  3. Grant camera permissions and scan the serial number(s) using the barcode reader.
  4. Click the  ADD TO UNREGISTERED HARDWARE  button to add the phone(s)

10. Configuring Custom Fields

The Provisioning Tool supports the most common fields that customers would use to configure their phones. 
If the desired field is not listed in the provisioning tool, you can add your own custom field(s).

The capability to add your own custom field is provided in the Phone Details page.

  • From the Infinity Phone List, click on the desired phone entry.
  • From the Phone Details page, scroll down to the  CUSTOM Settings  section.
  • Enter the PCODE of the field you want to configure and the VALUE
  • Click Add Parameter to add more fields or click the delete  icon to remove the parameter.

Note that validation is NOT done on the custom fields, you have to ensure the PCODE and VALUE fields are valid. See the list of supported PCODE(s) below.
If you cannot find the field you need in the list, please submit a Support Ticket.
TAB Section Parameter PCODE VALUE Value description
Network - Basic Internet Port IP Mode P20181 0 | 1 | 2 IPv4 | IPv6 | IPv4&IPv6
IPv4 Setting P8 0 | 1 | 2 DHCP | Static | PPPoE
DHCP Hostname P146   <text> maxlength 32
Domain P147   <text> maxlength 32
Vendor Class ID P148   <text> maxlength 32
User Class P149   <text> maxlength 32
Static IP Address IP Address P9.P10.P11.P12 0-255.0-255.0-255.0-255 Add 4 separate pcodes, one for each octet.
Subnet Mask P3.P14.P15.P16 0-255.0-255.0-255.0-255 Add 4 separate pcodes, one for each octet.
Default Gateway P17.P18.P19.P20 0-255.0-255.0-255.0-255 Add 4 separate pcodes, one for each octet.
Static DNS P20163 0 | 1 No | Yes
Primary DNS P21.P22.P23.P24 0-255.0-255.0-255.0-255 Add 4 separate pcodes, one for each octet.
Secondary DNS P25.P26.P27.P28 0-255.0-255.0-255.0-255 Add 4 separate pcodes, one for each octet.
PPPoE PPPOE Account ID P82   <text> maxlength 64
PPPOE Password P83   <text> maxlength 32
PPPOE Service Name P269   <text> maxlength 64
Preferred DNS Server P92.P93.P94.P95 0-255.0-255.0-255.0-255 Add 4 separate pcodes, one for each octet.
Network - PC Port PC Port P231 0 | 1 | 2 Router | Bridge | Expansion Module
Network - Advanced LLDP Active P5438 0 | 1 Disable | Enable
Packet Interval P5439 15 - 3600  
CDP Active P23133 0 | 1 Disable | Enable
Packet Interval P23134 1 - 3600  
VLAN Voice QoS P23130   <text> maxlength 3
SIP QoS P23129   <text> maxlength 3
Web Server HTTP Port P901   <text> maxlength 5
HTTPS Port P8724   <text> maxlength 6
Type P8725 0 | 1 | 2 | 3 Disable | HTTP&HTTPS | HTTP Only | HTTPS Only
Setting - Preference   Web Language P2525 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 English | French | German | Spanish | Portuguese | Russian | Italian | Polish | Turkish | ChineseSimplified | ChineseTraditional | Dutch
  LCD Font Size P24771 0 | 1 Normal | Large
  CallID Font Size P24814 0 | 1 Auto | Large
  Handsfree AGC P5 0 | 1 Disable | Enable
Volume Amplication Handset Send Volume P20083 1 | 2 | 3 | 0 | 4 | 5 | 6 +6db | +4db | +2db | 0 | -2db | -4db | -6db
Headset Send Volume P20084 1 | 2 | 3 | 0 | 4 | 5 | 6 +6db | +4db | +2db | 0 | -2db | -4db | -6db
Handsfree Send Volume P249 1 | 2 | 3 | 0 | 4 | 5 | 6 +6db | +4db | +2db | 0 | -2db | -4db | -6db
  Call Waiting Tone Volume P25072 4 | 3 | 2 | 1 | 0 Level 4 | Level 3 | Level 2 | Level 1 | 0
  Backlight Inactive Level P20642 0 | 1 Low | Off
  Backlight Active Level P20643 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10
  Backlight Time P8683   <text> maxlength 4
  Screen Time Out P8940 0 | 1 | 2 | 3 | 4 | 5 Off | 1 min | 2 mins | 5 mins | 10 mins | 30 mins
  Expansion screensaver P40004 0 | 1 | 2 | 3 | 4 | 5 | 6 Off | 1 min | 5 mins | 10 mins | 20 mins | 30 mins | 60 mins
  Text Logo P8951   <text> maxlength 15
  Screensaver Type P8950 0 | 13 | 1 | 2 | 3 | 4 time&logo | time only | photo switch | photo1 | photo2 | photo3
  Ring volume P8503 0 - 14  
  Wallpaper P8660 0 | 1 | 2 | 3 | 4 | 5 wallpaper1 | wallpaper2 | wallpaper3 | wallpaper4 | wallpaper5 | wallpaper6
    Wakeup and perform action on key press P20018 0 | 1 Disable | Enable
Setting - Sleep Mode Office Hours Monday P25011 00 - 23,00 - 23 Enter the start and end hour separated by comma.
Tuesday P25012 00 - 23,00 - 23 Enter the start and end hour separated by comma.
Wednesday P25013 00 - 23,00 - 23 Enter the start and end hour separated by comma.
Thursday P25014 00 - 23,00 - 23 Enter the start and end hour separated by comma.
Friday P25015 00 - 23,00 - 23 Enter the start and end hour separated by comma.
Saturday P25016 00 - 23,00 - 23 Enter the start and end hour separated by comma.
Sunday P25017 00 - 23,00 - 23 Enter the start and end hour separated by comma.
Inactive Timeout Office Hour Inactive Timeout P25018 1 - 960  
Free Hour Inactive Timeout P25019 1 - 960  
Management - Auto Provision Firmware Upgrade Allow DHCP Option P1145   <text> maxlength 5