Difference between revisions of "Fanvil X4U"

From Bicom Systems Wiki

(Registering phone)
(Phone Settings)
 
(9 intermediate revisions by one user not shown)
Line 116: Line 116:
 
===UAD Settings===
 
===UAD Settings===
  
[[image:device.YealinkT22P.png|thumb|UAD settings]]  
+
[[image:manual-prov-fanvil-x4u.png|thumb|UAD settings]]  
  
 
Log in to the PBXware web administration interface
 
Log in to the PBXware web administration interface
Line 136: Line 136:
 
===Creating an Extension===
 
===Creating an Extension===
  
[[image:extension1.png|thumb|Creating Extension]]
+
[[image:extension.1.png|thumb|Creating Extension]]
  
 
Add an Extension
 
Add an Extension
Line 181: Line 181:
 
*Open a new browser window and enter the phone's IP address in order to access the phone's web administration interface login screen. Example: http://192.168.1.22
 
*Open a new browser window and enter the phone's IP address in order to access the phone's web administration interface login screen. Example: http://192.168.1.22
 
   
 
   
*Log in to the phone's web administration interface with the username and password. Please note that factory default login details are username: '''admin''' and password: '''admin'''.
+
*Log in to the phone's web administration interface with the username and password. Please note that factory default login details are as follows: username is '''admin''' and password is '''admin'''.
 
   
 
   
*Click on '''Line''' link in the left hand navigation menu
+
*Click '''Line''' in the left-hand navigation menu.
 
   
 
   
 
*Enter or set the following details into the respective fields.
 
*Enter or set the following details into the respective fields.
Line 191: Line 191:
 
*'''Username'''  
 
*'''Username'''  
  
:PBXware extension number. Example: '''1003'''
+
:PBXware Extension number. Example: '''1003'''
  
 
*'''Authentication Name'''  
 
*'''Authentication Name'''  
Line 199: Line 199:
 
*'''Authentication Password'''  
 
*'''Authentication Password'''  
  
:The Secret of the extension as received in the e-mail associated with this extension. Example: '''_%Z4M3*Ts9y7'''. A password is generated automatically for each newly created extension.
+
:The Secret of the Extension as received in the e-mail associated with this Extension. Example: '''_%Z4M3*Ts9y7'''. A password is generated automatically for each newly created Extension.
  
 
*'''Activate'''  
 
*'''Activate'''  
Line 207: Line 207:
 
*'''SIP Proxy Server Address'''
 
*'''SIP Proxy Server Address'''
  
:Enter the Hostname or IP Address of the PBXware.
+
:Enter the Hostname or IP Address of PBXware.
 
   
 
   
:- Example for Hostname: '''voip.bicomsystems.com'''
+
:- Example of a Hostname: '''voip.bicomsystems.com'''
  
:- Example for IP Address: '''192.168.1.10'''
+
:- Example of an IP Address: '''192.168.1.10'''
 
   
 
   
*Click on the '''Apply''' button.
+
*Click '''Apply'''.
 
   
 
   
*If everything is done as above described, you should have successfully registered your phone to PBXware. Dial *123 to verify registration.
+
*If everything is done as described above, you should have successfully registered your phone to PBXware.  
 +
 
 +
Dial *123 to verify the registration.
  
 
==Auto Provisioning==  
 
==Auto Provisioning==  
  
This chapter describes how to set UAD settings, create PBXware extension and register the phone using DHCP or Static IP address.
+
This section describes how to set UAD settings, create a PBXware Extension and register the phone using DHCP or Static IP address.
 
   
 
   
 
The following topics are covered:
 
The following topics are covered:
Line 225: Line 227:
 
*UAD Settings
 
*UAD Settings
  
*Creating Extension
+
*Creating an Extension
  
*Registering Phone  
+
*Registering a Phone  
  
 
===UAD Settings===  
 
===UAD Settings===  
[[image:auto.prov.device.yealinkT22P.png|thumb|UAD settings]]
+
[[image:auto-prov-fanvil-x4u.png|thumb|UAD settings]]
  
Login to PBXware web administration interface.
+
Log in to the PBXware's web administration interface.
 
   
 
   
 
*Open a new browser window and enter the IP address in order to access the PBXware web administration login screen. Example: '''http://192.168.1.10'''.
 
*Open a new browser window and enter the IP address in order to access the PBXware web administration login screen. Example: '''http://192.168.1.10'''.
 
   
 
   
*Login to PBXware with your e-mail address and password.
+
*Log in to PBXware with the e-mail address and password.
 
   
 
   
UAD settings.
+
UAD Settings
 
   
 
   
*Navigate to '''Settings:UAD'''.
+
*Navigate to '''Settings: UAD'''.
 
   
 
   
*Make sure Fanvil UAD is enabled. To check the UAD status click on the '''edit''' icon corresponding to your Fanvil phone.
+
*Make sure Fanvil UAD is enabled. To check the UAD status, click the '''Edit''' icon corresponding to the Fanvil phone.
 
   
 
   
 
*Make sure '''Status''' is set to '''Active''', '''Auto provisioning''' is set to '''Yes''', and '''DHCP''' is set to '''Yes'''.  
 
*Make sure '''Status''' is set to '''Active''', '''Auto provisioning''' is set to '''Yes''', and '''DHCP''' is set to '''Yes'''.  
  
*Click on the '''Save''' button to save changes.
+
*Click '''Save'''.
  
===Creating Extension===  
+
===Creating an Extension===  
[[image:extension2.png|thumb|Creating Extension]]  
+
[[image:extension.2.png|thumb|Creating Extension]]  
Add Extension
+
Add an Extension
 
   
 
   
*Navigate to '''Extensions'''. Click on '''Add Extension'''.
+
*Navigate to '''Extensions'''. Click '''Add Extension'''.
 
   
 
   
 
*The standard options window will be shown below.
 
*The standard options window will be shown below.
 
   
 
   
*Select Fanvil phone model from the '''UAD''' select box.
+
*Select a Fanvil phone model from the '''UAD''' select box.
 
   
 
   
 
*Select Location: '''Local''' or '''Remote'''.
 
*Select Location: '''Local''' or '''Remote'''.
:'''Local''' is for all extensions registered on the LAN and '''Remote''' is for all extensions registered from remote networks, WAN, Internet etc.
+
:'''Local''' is for all Extensions registered on the LAN and '''Remote''' is for all Extensions registered from remote networks, WAN, Internet etc.
 
   
 
   
*Click on the '''Next step''' button.
+
*Click '''Next step'''.
 
   
 
   
Extension values
+
Extension Values
  
 
:Enter values into the required field text boxes.
 
:Enter values into the required field text boxes.
Line 271: Line 273:
 
*'''Name'''  
 
*'''Name'''  
  
:Enter a name for the extension being created. Example: '''John Smith'''.
+
:Enter a name for the Extension being created. Example: '''John Smith'''.
  
 
*'''E-mail'''  
 
*'''E-mail'''  
  
:Enter the e-mail address associated with this extension. This e-mail address will receive all system notification messages. Example: '''john.smith@bicomsystems.com'''  
+
:Enter the e-mail address associated with this Extension. This e-mail address will receive all system notification messages. Example: '''john.smith@bicomsystems.com'''  
  
 
*'''Auto Provisioning'''  
 
*'''Auto Provisioning'''  
Line 283: Line 285:
 
*'''MAC Address'''
 
*'''MAC Address'''
  
:Enter Fanvil phone MAC address. Example: '''0C383E123456'''. MAC address can be found at the back of the phone.  
+
:Enter the Fanvil phone's MAC address. Example: '''0C383E123456'''. The MAC address can be found on the back of the phone.  
  
*Click on the '''Save''' button.
+
*Click '''Save'''.
  
 
===Registering Phone===  
 
===Registering Phone===  
  
This chapter describes how to register Fanvil phone using '''TFTP''' & '''HTTP & HTTPS'''.
+
This section describes how to register a Fanvil phone using '''TFTP''' & '''HTTP'''.
  
====TFTP & HTTP & HTTPS====  
+
====TFTP & HTTP====  
 
   
 
   
*Open a new browser window and enter your phone IP address, e.g. '''http://192.168.1.22'''.
+
*Open a new browser window and enter the phone's IP address, e.g. '''http://192.168.1.22'''.
 
   
 
   
*Enter '''username''' and '''password''' and press '''Confirm''' button. <font color="red">'''NOTE:'''</font> Factory default login details are username: '''admin''' and password: '''admin'''.
+
*Enter '''username''' and '''password''' and press the '''Confirm''' button. <font color="red">'''NOTE:'''</font> The factory default login details are as follows: username is '''admin''' and password is '''admin'''.
  
*Click on '''Auto Provision''' in the navigation tab.
+
*Click '''Auto Provision''' in the navigation tab.
  
*Enter '''Auto Provisioning''' username and password into '''Authentication Name''' and '''Authentication Password''' fields.
+
*Enter the '''Auto Provisioning''' username and password into the '''Authentication Name''' and '''Authentication Password''' fields.
  
 
:Make sure the '''Download CommonConfig enabled''' check box is NOT selected.
 
:Make sure the '''Download CommonConfig enabled''' check box is NOT selected.
  
*Click on '''Static Provisioning Server'''
+
*Click '''Static Provisioning Server'''
  
*Choose what '''Protocol Type''' you intend to use: '''HTTP''', '''HTTPS''' or '''Trivial FTP'''. <font color="red">'''NOTE:'''</font> Our recommendation is to use the '''HTTP'''.
+
*Choose what '''Protocol Type''' you intend to use: '''HTTP''' or '''Trivial FTP'''. <font color="red">'''NOTE:'''</font> Our recommendation is to use '''HTTP'''.
 
   
 
   
::If you choose to use '''Protocol Type''' '''HTTP''' or '''HTTPS''' enter '''http://''' or '''https://''' followed by '''Hostname''' or '''IP Address''', followed then by '''/prov'''.
+
::If you choose to use '''Protocol Type''' '''HTTP''', enter '''http://''' followed by '''Hostname''' or '''IP Address''', then followed by '''/prov'''.
  
:::Example for Hostname using HTTP: '''http://abc.bicomsystems.com/prov'''
+
:::Example of a Hostname using HTTP: '''http://abc.bicomsystems.com/prov'''
  
:::Example for Hostname using HTTPS: '''https://abc.bicomsystems.com/prov'''
+
:::Example of an IP Address using HTTP: '''http://192.168.1.10/prov'''
 +
 +
::If you choose to use '''Protocol Type''' '''TFTP''',  enter '''tftp://''' followed by '''Hostname''' or '''IP Address'''
  
:::Example for IP Address using HTTP: '''http://192.168.1.10/prov'''
+
:::Example of a Hostname: '''tftp://voip.bicomsystems.com'''
  
:::Example for IP Address USING HTTPS: '''https://192.168.1.10/prov'''
+
:::Example of an IP Address: '''tftp://192.168.1.10'''
 +
 
 +
*Make sure the '''Update Mode''' is set to '''Update After Reboot'''.
 
   
 
   
::If you choose to use '''Protocol Type''' '''TFTP'''  enter '''tftp://''' followed by '''Hostname''' or '''IP Address'''
+
*Click '''Apply'''.
  
:::Example for Hostname: '''tftp://voip.bicomsystems.com'''
+
*Click '''Tools''' in the navigation tab.
  
:::Example for IP Address: '''tftp://192.168.1.10'''
+
*Click '''Reboot'''.
 +
 +
*A pop-up window will show up, click '''OK''' to confirm the action.
  
*Make sure the '''Update Mode''' is set to '''Update After Reboot'''.
+
*You will have to wait for a couple of seconds for the configuration to be updated. <font color="red">'''NOTE:'''</font> Do not power off the phone.
 
   
 
   
*Click on '''Apply''' button.
+
*The auto-provisioning process will start during the phone's reboot process. the phone will pick up the appropriate configuration file from PBXware. If everything is done as described above, you should have successfully registered your phone to PBXware.  
  
*Click on '''Tools''' in the navigation tab.
+
Dial '''*123''' to verify the registration.
  
*Click on '''Reboot''' button.
+
=Configure BLF=
 +
 
 +
==Extension Settings==
 +
 
 +
This section describes how to configure BLF (Busy Lamp Field) for Fanvil X4U.
 
   
 
   
*A pop up window will show up, click on '''OK''' button to confirm your action.
+
Log in to the PBXware's web administration interface.
 +
 +
*Open a new browser window and enter the IP address in order to access the PBXware's web administration login page. Example: '''http://192.168.1.10'''.
 +
 +
*Log in to PBXware with the e-mail address and password.
 +
 
 +
Edit an Extension
 +
 +
*On the '''Extensions''' page, click the '''Edit''' icon corresponding to the Extension.
 +
 +
*Click '''Advanced Options'''.
 +
 +
*Navigate down to the '''Auto Provisioning''' and '''Presence''' group of settings.
 +
 +
*Make sure '''Auto Provisioning''' is set to '''Yes'''.
 +
 +
*Make sure '''Presence''' is set to "Yes".
 +
 +
*Click '''Save'''.
 +
 +
*Click '''Enhanced Services'''.
 +
 +
*Click the '''Directory / BLF List''' check box and click the '''Save''' button in order to enable this feature.
 +
 +
*Click Directory / BLF List '''Edit'''.
 +
 +
*Enter the user's Extension number and click the '''BLF''' check box.
 +
 +
*Click '''Save'''.
 +
 
 +
==Phone Settings==
 +
 
 +
Log in to the phone's web administration interface.
 +
 +
*Open a new browser window and enter the phone's IP address in order to access the phone's web administration interface login screen. Example: '''http://192.168.1.22'''.
 +
 +
*Log in to the phone's web administration interface with the username and password. Please note that factory default login details are as follows: username is '''admin''' and password is '''admin'''.
 +
 
 +
*Click the '''Function Key''' link in the left-hand navigation menu
  
*You'll have to wait couple of seconds for the configuration to be updated. <font color="red">'''NOTE:'''</font> Do not power off your phone.
+
*Configure 1 to 12 DSS Keys from the list.
 +
:Type: Select '''BLF List Key'''.
 +
:Value: Enter the user's Extension. Example: '''1005'''
 
   
 
   
*Auto provisioning process will start during phone reboot process, phone will pickup appropriate configuration file from PBXware. If everything is done as above described, you should have successfully registered your phone to PBXware. Dial '''*123''' to verify registration.
+
*Click '''Confirm''' to save changes.

Latest revision as of 16:52, 3 November 2021

Introduction

Fanvil X4U User Guide

This Configuration Guide is written as a general guide on how to configure the Fanvil phone model X4U to work with PBXware 5.3.9.

Video Tutorial

Please refer to the video tutorial explaining setting up Auto Provisioning for Fanvil on PBXware 5.

Requirements

Identifying Phone Model

To start and successfully complete the registration of the Fanvil phone, users need to know which phone model to set up.

On the back of each Fanvil phone, there is model information that you should check. Although various phone models can have exactly the same requirements and installation procedures, they can also have significantly different requirements and installation procedures, so that is why it is important to know the model you own which results in you setting up the device successfully.

Phone Firmware

  • Make sure that the phone is loaded with an appropriate firmware version, 2.4.3.
  • To find out the firmware version of the Fanvil phone model, open a new browser window and enter the phone's IP address in order to access the phone's web administration interface login screen. Example: http://192.168.1.22.
  • Log in to the phone's web administration interface with a username and password. Please note that factory default login details are as follows: username is admin and password is admin.

DHCP Server

Fully configured and operational DHCP server.

PBXware Version

PBXware version 5.3.9

In order to find out the PBXware version:

  • Log in to PBXware
  • Navigate to Settings: About.

On the top of About page, you may see a code similar to this one PBXware Edition: Multi-Tenant Release: 5.3.9.0 (41a4f0e6) Running: 13.23.1-gc-2e09fa3d, Proxy v5.3.9 (231c5f3), API: 5.3, libmemcached version: 1.0.18, where Release denotes the current version of your PBXware.

Installation

This section describes how to install and connect the phone to the electrical power and data network as well as how to apply factory settings.

The following topics are covered:

  • Power Adapter
  • Power over Ethernet (PoE)
  • Factory Settings

Power Adapter

Connect the Network and Power

  • Connect the DC plug on the power adapter to the DC port on the phone and connect the other end of the power adapter into an electrical power outlet.
  • Connect the Ethernet cable between the Internet port on the phone and the network port on a router or switch to access LAN.

NOTE: If you are using Power over Ethernet (PoE), you don't need to connect the AC adapter. Make sure that the Ethernet cable and router or switch is Power over Ethernet (PoE) compliant.

Power over Ethernet (PoE)

Connect the Network (only)

Using a regular Ethernet cable, your phone can be powered from a Power over Ethernet (PoE) compliant router or switch.

  • Connect the Ethernet cable between the Internet port on the phone and an available port on the in-line power router or switch.

NOTE: If you are using Power over Ethernet (PoE), you don't need to connect the AC adapter. Make sure that the Ethernet cable and router or switch is Power over Ethernet (PoE) compliant.

Find the Phone's IP Address

  • Press the Down navigation key

The IP address will be shown on top of the display.

Reset to factory settings

This step is not required for brand new out-of-the-box phones, however, if the phone has been already used then it is a must.

  • Open a new browser window and enter the phone's IP address in order to access the phone's web administration interface login screen. Example: http://192.168.1.22.
  • Log in to the phone's web administration interface with the username and password. Please note that factory default login details are as follows: username is admin and password is admin.
  • Click the Configurations tab.
  • Click the Reset button in order to reset the phone to factory settings. The phone will reset to the factory settings and reboot.
  • Wait some time for a device to reboot.

NOTE: Do not unplug or remove power to the phone while it is updating firmware and configuration.

Registering Phone

This section describes how to register the phone using manual configuration or auto provisioning.

The following topics are covered:

  • Manual Configuration
  • Auto Provisioning

Manual Configuration

This section describes how to set UAD settings, create a PBXware Extension, and register a phone.

The following topics are covered:

  • UAD Settings
  • Creating an Extension
  • Registering a Phone

UAD Settings

UAD settings

Log in to the PBXware web administration interface

  • Open a new browser window and enter the IP address in order to access the PBXware web administration login screen. Example: http://192.168.1.10.
  • Log in to PBXware with the e-mail address and password.

UAD Settings

  • Navigate to Settings:UAD.
  • Make sure Fanvil UAD is enabled. To check the UAD status, click the Edit icon corresponding to the Fanvil phone.
  • Make sure Status is set to Active, Auto provisioning is set to No, and DHCP is set to Yes.
  • Click Save.

Creating an Extension

Creating Extension

Add an Extension

  • Navigate to Extensions. Click Add Extension.
  • The standard options window will be shown below.
  • Select a Fanvil phone model from the UAD select box.
  • Select Location: Local or Remote.
Local is for all Extensions registered on the LAN and Remote is for all Extensions registered from remote networks, WAN, Internet, etc.
  • Click the Next step button.

Extension Values

Enter values into the required field text boxes.

REQUIRED FIELDS:

  • Name
Enter a name for the Extension being created. Example: John Smith.
  • E-mail
Enter the e-mail address associated with this Extension. This e-mail address will receive all system notification messages. Example: john.smith@bicomsystems.com
  • Department
Department to which Extension belongs to. Example: Sales.
  • Click Save.

Registering a Phone

This section describes how to register a Fanvil phone using Hostname or IP Address.

Hostname or IP Address

Log in to the phone's web administration interface

  • Open a new browser window and enter the phone's IP address in order to access the phone's web administration interface login screen. Example: http://192.168.1.22
  • Log in to the phone's web administration interface with the username and password. Please note that factory default login details are as follows: username is admin and password is admin.
  • Click Line in the left-hand navigation menu.
  • Enter or set the following details into the respective fields.
REQUIRED FIELDS:
  • Username
PBXware Extension number. Example: 1003
  • Authentication Name
Usually the same number as the Phone Number.
  • Authentication Password
The Secret of the Extension as received in the e-mail associated with this Extension. Example: _%Z4M3*Ts9y7. A password is generated automatically for each newly created Extension.
  • Activate
Make sure the Activate check box is selected.
  • SIP Proxy Server Address
Enter the Hostname or IP Address of PBXware.
- Example of a Hostname: voip.bicomsystems.com
- Example of an IP Address: 192.168.1.10
  • Click Apply.
  • If everything is done as described above, you should have successfully registered your phone to PBXware.

Dial *123 to verify the registration.

Auto Provisioning

This section describes how to set UAD settings, create a PBXware Extension and register the phone using DHCP or Static IP address.

The following topics are covered:

  • UAD Settings
  • Creating an Extension
  • Registering a Phone

UAD Settings

UAD settings

Log in to the PBXware's web administration interface.

  • Open a new browser window and enter the IP address in order to access the PBXware web administration login screen. Example: http://192.168.1.10.
  • Log in to PBXware with the e-mail address and password.

UAD Settings

  • Navigate to Settings: UAD.
  • Make sure Fanvil UAD is enabled. To check the UAD status, click the Edit icon corresponding to the Fanvil phone.
  • Make sure Status is set to Active, Auto provisioning is set to Yes, and DHCP is set to Yes.
  • Click Save.

Creating an Extension

Creating Extension

Add an Extension

  • Navigate to Extensions. Click Add Extension.
  • The standard options window will be shown below.
  • Select a Fanvil phone model from the UAD select box.
  • Select Location: Local or Remote.
Local is for all Extensions registered on the LAN and Remote is for all Extensions registered from remote networks, WAN, Internet etc.
  • Click Next step.

Extension Values

Enter values into the required field text boxes.
REQUIRED FIELDS:
  • Name
Enter a name for the Extension being created. Example: John Smith.
  • E-mail
Enter the e-mail address associated with this Extension. This e-mail address will receive all system notification messages. Example: john.smith@bicomsystems.com
  • Auto Provisioning
Set to Yes.
  • MAC Address
Enter the Fanvil phone's MAC address. Example: 0C383E123456. The MAC address can be found on the back of the phone.
  • Click Save.

Registering Phone

This section describes how to register a Fanvil phone using TFTP & HTTP.

TFTP & HTTP

  • Enter username and password and press the Confirm button. NOTE: The factory default login details are as follows: username is admin and password is admin.
  • Click Auto Provision in the navigation tab.
  • Enter the Auto Provisioning username and password into the Authentication Name and Authentication Password fields.
Make sure the Download CommonConfig enabled check box is NOT selected.
  • Click Static Provisioning Server
  • Choose what Protocol Type you intend to use: HTTP or Trivial FTP. NOTE: Our recommendation is to use HTTP.
If you choose to use Protocol Type HTTP, enter http:// followed by Hostname or IP Address, then followed by /prov.
Example of a Hostname using HTTP: http://abc.bicomsystems.com/prov
Example of an IP Address using HTTP: http://192.168.1.10/prov
If you choose to use Protocol Type TFTP, enter tftp:// followed by Hostname or IP Address
Example of a Hostname: tftp://voip.bicomsystems.com
Example of an IP Address: tftp://192.168.1.10
  • Make sure the Update Mode is set to Update After Reboot.
  • Click Apply.
  • Click Tools in the navigation tab.
  • Click Reboot.
  • A pop-up window will show up, click OK to confirm the action.
  • You will have to wait for a couple of seconds for the configuration to be updated. NOTE: Do not power off the phone.
  • The auto-provisioning process will start during the phone's reboot process. the phone will pick up the appropriate configuration file from PBXware. If everything is done as described above, you should have successfully registered your phone to PBXware.

Dial *123 to verify the registration.

Configure BLF

Extension Settings

This section describes how to configure BLF (Busy Lamp Field) for Fanvil X4U.

Log in to the PBXware's web administration interface.

  • Open a new browser window and enter the IP address in order to access the PBXware's web administration login page. Example: http://192.168.1.10.
  • Log in to PBXware with the e-mail address and password.

Edit an Extension

  • On the Extensions page, click the Edit icon corresponding to the Extension.
  • Click Advanced Options.
  • Navigate down to the Auto Provisioning and Presence group of settings.
  • Make sure Auto Provisioning is set to Yes.
  • Make sure Presence is set to "Yes".
  • Click Save.
  • Click Enhanced Services.
  • Click the Directory / BLF List check box and click the Save button in order to enable this feature.
  • Click Directory / BLF List Edit.
  • Enter the user's Extension number and click the BLF check box.
  • Click Save.

Phone Settings

Log in to the phone's web administration interface.

  • Open a new browser window and enter the phone's IP address in order to access the phone's web administration interface login screen. Example: http://192.168.1.22.
  • Log in to the phone's web administration interface with the username and password. Please note that factory default login details are as follows: username is admin and password is admin.
  • Click the Function Key link in the left-hand navigation menu
  • Configure 1 to 12 DSS Keys from the list.
Type: Select BLF List Key.
Value: Enter the user's Extension. Example: 1005
  • Click Confirm to save changes.