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. 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
- The phone must be assigned to the correct reseller and registered to a UCX in the Partner Portal. If the phone is not assigned, follow the steps in Sections 2.1 and 2.2.
- To find out if the phones are assigned, go to Section 3.1. If the phones are listed, then skip Section 2 and continue from Section 3.1.
- If the phones are not listed, then go to Section 2.1 to assign the phones first.
2.1 Assigning Phones in the Partner Portal
Before you can use the provisioning tool to configure a phone, the phone must first be assigned to the correct reseller and also to the parent UCX.
From the Partner Portal, click on the Child SN Registration icon.
All the unassigned software and hardware that is associated with your account will be listed on this page.
To assign the phone(s), perform the following steps:
- Select the checkbox beside the phone in the Unregistered Hardware section.
- Enter the “Serial Number of the UCX Server“ that the phone(s) will connect to in the Assign To UCX Parent section.
- Click the ASSIGN TO UCX PARENT button.
If the phone(s) are not listed here, then proceed to the next section (Section 2.2 Assigning to Reseller) to assign the phone(s) first. Once assigned, then you can come back here to register the phone(s).
2.2 Assigning to Reseller
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:
- Select the Manual radio button
- Select the Reseller Name from the drop-down list
- Enter the Serial Number of the phone(s)
- 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:
- Select the Import CSV file radio button
- Select the Reseller Name from the drop-down list
- Click the Choose File button and select the CSV file containing the list of serial numbers.
- 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:
- Select the Barcode Reader radio button
- Select the Reseller Name from the drop-down list
- Grant camera permissions and scan the serial number(s) using the barcode reader.
- Click the ADD TO UNREGISTERED HARDWARE button to add the phone(s)
3. Accessing the Provisioning Tool
Login to the Partner Portal with your partner account. (https://portal.emetrotel.com/)
From the Partner Portal, navigate to Provisioning – Infinity Phones.
3.1 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 2.2 to assign the phone to the reseller first, then Section 2.1 to register the phone.
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.
- 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.
- Update the desired fields in the area beneath the Phone List – UPDATE SELECTED ENTRIES.
- Fields that are left blank will not be updated, that is, the field will retain its current value.
- 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 rebooted, it will retrieve its own configuration file from the server specified in the Configuration Server Path.
You can reboot an XSTIM phone from the UCX following these steps:
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.
Common Configuration Files
All Infinity phones on booting up or auto provisioning, will first retrieve the common configuration file cfg0xxx.xml. This common configuration file is model specific, all phones of the same model will retrieve the same file.
Filename | Phone Model |
---|---|
cfg0013.xml | 5006 1st generation |
cfg0010.xml | 5010 1st generation |
cfg0113.xml | 5006 2nd generation |
cfg0110.xml | 5010 2nd generation |
cfg0201.xml | 5004 |
cfg0202.xml | 5008 |
cfg0203.xml | 5010W |
Below is an example of a common configuration file:
Device Configuration File
The next file to retrieve is the device specific configuration file cfg<MD5MAC>.xml.
For example cfgC6E217F4D578BB9D09003F2F5726EEFF.xml where <MD5MAC> is the MD5 hashed MAC address of the device. Each phone will retrieve the configuration file that matches its own MD5MAC address.
Set Server Paths to UCX
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. Configuring Custom Fields using PCODE
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 |
---|---|---|---|---|---|
Firmware Mode | P5900 | 0 | 1 | SIP | XSTIM | ||
Home | Server Information | S1 IP | P5902 | <text> maxlength 64 | |
S1 Port | P5903 | ||||
S1 Retry Number | P5904 | ||||
S2 IP | P5902 | <text> maxlength 64 | |||
S2 Port | P5903 | ||||
S2 Retry Number | P5904 | ||||
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 | WAN Port Active | P24053 | 0 | 1 | Disable | Enable | |
WAN Port VID | P51 | <text> maxlength 4 | |||
WAN Port Priority | P87 | <text> maxlength 3 | |||
PC Port Active | P24054 | 0 | 1 | Disable | Enable | ||
PC Port VID | P229 | <text> maxlength 4 | |||
DHCP VLAN Active | P8684 | 0 | 1 | Disable | Enable | ||
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 | ||
Network – Wifi | Wifi Active | P23372 | 0 | 1 | Disable | Enable | |
Security Mode | P23380 | 0 | 1 | 2 | 3 | None | WEP | WPA PSK | WPA2 PSK | ||
Wifi Setting | Wifi Mode | P23394 | 0 | 1 | Manual | Provision | |
Provision Mode | SSID | P23378 | <text> maxlength 64 | ||
Password | P23379 | <text> maxlength 64 | |||
Setting – Preference | Web Language | P2525 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 19 | 0=English 1=French 2=German 3=Spanish 4=Portuguese 5=Russian 6=Italian 7=Polish 8=Turkish 9=Serbian 10=ChineseSimplified 19=Dutch | |
LCD Font Size | P24771 | 0 | 1 | Normal | Large | ||
CallID Font Size | P24814 | 0 | 1 | Auto | Large | ||
Handsfree AGC | P5 | 0 | 1 | Disable | Enable | ||
Tone Select Country | P20058 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 0=Custom 1=Australia 2=Austria 3=Brazil 4=Belgium 5=China 6=Chile 7=Czech 8=Denmark 9=Finland 10=France 11=Germany 12=Great Britain 13=Greece 14=Hungary 15=Lithuania 16=India 17=Italy 18=Japan 19=Mexico 20=New Zealand 21=Netherlands 22=Norway 23=Portugal 24=Spain 25=Switzerland 26=Sweden 27=Russia 28=United States | ||
NTP Server | P30 | %NULL% | Date and Time must be from UCX Server. Set NTP Server to NULL. | ||
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 | ||
Volume Amplication | Handset Extra Loud | P24936 | 0 | 4 | 8 | 12 | 16 | 18 | 20 | 0db | +2db | +4db | +6db | +8db | +10db | +12db | |
Headset Extra Loud | P24937 | 0 | 4 | 8 | 12 | 16 | 18 | 20 | 0db | +2db | +4db | +6db | +8db | +10db | +12db | ||
Handsfree Extra Loud | P24938 | 0 | 4 | 8 | 12 | 16 | 18 | 20 | 0db | +2db | +4db | +6db | +8db | +10db | +12db | ||
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 | Upgrade Mode | P212 | 0 | 1 | 2 | 3 | TFTP | HTTP | FTP | HTTPS |
Firmware Server Path | P192 | <text> maxlength 255 | |||
Configuration Server Path | P237 | <text> maxlength 255 | |||
Allow DHCP Option | P1145 | <text> maxlength 5 | |||
Auto Upgrade Setting | Auto Upgrade | P194 | 0 | 1 | No | Yes | |
Power On | P25020 | 0 | 1 | No | Yes | ||
Minute | Repeatedly | P25021 | 0 | 1 | No | Yes | |
Check for Upgrade every | P193 | Numeric | |||
Week | Weekly | P25022 | 0 | 1 | No | Yes | |
– Weekly Upgrade Interval (0~12W) | P25023 | 0 – 12 | |||
– Inactivity Time Expire (0~120Min) | P25024 | 0 – 120 | |||
– Time | P25025 P25026 P25027 P25028 | 00 – 23 00 – 59 00 – 23 00 – 59 | Start hour Start minute End hour End minute | ||
– Day of Week | P25029 P25030 P25031 P25032 P25033 P25034 P25035 | 0 | 1 0 | 1 0 | 1 0 | 1 0 | 1 0 | 1 0 | 1 | Sunday Monday Tuesday Wednesday Thursday Friday Saturday | ||
Day | Flexible Auto Provision | P25036 | 0 | 1 | No | Yes | |
– Flexible Interval Days | P25037 | 1 – 1000 | |||
– Flexible Time | P25038 P25039 P25040 P25041 | 00 – 23 00 – 59 00 – 23 00 – 59 | Start hour Start minute End hour End minute | ||
OTHERS | Upgrade Expansion Firmware | P23132 | 0 | 1 | No | Yes | |
Ring Server Path | P20174 | <text> maxlength 255 | |||
Screensaver Server URL | P20051 | <text> maxlength 255 | |||
Wallpaper Server URL | P20052 | <text> maxlength 255 | |||
Management – Configuration | System Log | Syslog Server | P207 | <text> maxlength 64 | |
Syslog Level | P208 | 0 | 1 | 2 | 3 | 4 | None | Debug | Info | Warning | Error | ||
Others | Sidetone | P20992 | 0 | 1 | Off | On |