• For Staff Extensions you will need the extension number and the extensions SIP Secret (password)
• Navigate to Core Configuration > Extensions and choose to edit the extension by clicking on the edit action button for the extension

• Guest extensions use the same SIP password for all guest extensions.
• Navigate to Guest Management > General Settings to find the Guest SIP Password
  • Note: you can change this password before you begin to provision any guest devices 

• Module Settings - Firmware
  • This is where you can see what firmware version is installed for each model of the phones and expansion models.
  • You can also redownload the firmware to the ComXchange

• Templates are where you define general information that relates to a group of phones  

• Templates - General Settings
  • The General Settings Tab is where you will set some of your basic phone settings for a group of phones, such as the web GUI login information, the IP address the phones will be registering to and provisioning information for this group of phones if different than the module settings. 

• Templates - Phone Settings
  • The Phone Settings Tab is where you can set some general phone functionality options for the phones.

• Templates - Network and Wifi Settings
  • You can configure ClearlyIP phones to connect over wifi by adding the security type, SSID and password.
• Templates - Redundancy
  • Here you can define a failover host and SIP port

Model Layouts

Navigate to Core Configuration > Clearly Devices - Model Layouts

Model layouts are used to manage settings and keys for specific models of Clearly Devices.  To create a new Model Layout Click on + Add Model Layout

• Model Layouts - General Settings

• The General Settings tab is where you can Specify basic settings for a group of phones of a particular model such as a Dial plan, background image, and permissions.  

• Model Layouts - Line Keys

• The Line Keys tab is where you program the keys for a group of phones
• You can program keys for many things including BLF buttons for pickup and direct transfer, toggling call routing such as day/night mode and different Clearly Apps
• The Clearly Apps can be used on any ClearlyIP phone and have many different features including the hospitality specific apps for Wakeup calls and Guest management.  
• You can find more information on the hospitality apps here Hotel Console Phone Apps  
• For more information on non-hospitality Apps see the wiki article on ClearlyIP Phone Apps
• If you are setting up BLF Keys that incorporate extensions such as Queue logins or Find Me Follow Me toggles you can use the extension variable of __sip_user_1__

• Model Layouts - Horizontal Soft Keys
  • The horizontal soft keys can be programmed to do different options as well from different screens such as incoming calls, dialing, and connected calls etc

Mappings

Navigate to Core Configuration > Clearly Devices - Model Layouts

• Mappings is where you will associate an extension with a ClearlyIP phone.  
  • When creating a mapping you will associate an extension to the device using the device's mac address and assigning the device to a Template and Model.  
  • When submitted a configuration file is created and available for auto provisioning. 
  • Once the phone is plugged in and downloads its configuration you can verify the registration by navigating to Reports > Asterisk info - Peers and see if the phone appears with an IP address.
• Rebuilding a configuration.
  • After making any changes to a Template or Model of a device that has already been mapped you will need to rebuild the configuration.
  • Click on the cogwheel to the right of the mapping to rebuild the phones configuration.
• Rebooting devices
  • Click on the power icon to the right of the mapping to send a reboot command to the phone

 Endpoint Manager

Navigate to Core Configuration > Endpoint Manager

The Endpoint manager can be used to create configurations for some models of Yealink, Polycom, Snom phones as well as some legacy Aastra phones.  The Endpoint Manager is similar to the Clearly Devices Module as you will be able to create templates and configurations for groups of phones that include basic settings and key options.  You can associate an extension to a phone using the mac address then assign a template to the extension.  This will create the configuration that will be used to auto provision the phone.  

Templates

• Using Templates is an easy way to deploy phones that will have similar functionality such as a front desk phone.  Phones based on templates will have the same buttons on the display, dial plan information and any other information added to the template 
  • Click on Add a new Template

• Enter a template name, then choose the product type and model of the phone
• General Tab
  • Make any general changes such as time zone, logo, and GUI passwords
• preferences
  • Choose preferences such as missed call log and dial plan entries
• Network
  • Allows you to add vlan info for the phones
• keys
  • Enter choices for your phone keys such as BLF, speed dial, or an XML browser key for the Guest Management and Wakeup apps.
    • Guest Management XML browser value for Yealink: http://192.168.101.2/yl/guestmgmt.php
    • Wakeup XML browser app for Yealink:  http://192.168.101.2/yl/wakeup.php 
    • Snom Guest Management and Wakeup keys are available in a dropdown
    • If you are setting up BLF Keys for Yealink phones that incorporate extensions such as Queue logins or Find Me Follow Me toggles you can use the extension variable of {$username.line.1}
• expansion
  • Enter extra keys if you are using an expansion module

Mapping Devices

Navigate to Core Configuration > Clearly Devices - Extension Mapping (flyout menu) 

• Extension Mapping is where you will associate an extension with a phone.  
  • When creating a mapping you will associate the device's mac address choosing the Brand, Model, and extension to be mapped to along with a Template.  
  • When you click on the +ADD button a configuration file is created and available for auto provisioning.

• once plugged in the phones should download their configuration and a green power button signifies the phone is registered.
  • You can also verify phone registration by navigating to Reports > Asterisk info - Peers and see if the phone appears with an IP address.
• At the bottom or the bottom of the Mapping page there is a place for rebuilding specific configurations or all of them at once.
  • If you check the Reboot option when you rebuild the ComXchange will send out a SIP message for the phone to reboot.

Gateway Provisioning - Analog Guest and Staff Phones

Default Templates

• Click on Submit to open the form for editing.
• In this form make any changes that you will want to apply to all gateways of this type
  • This will usually concern Provisioning Server, Clock Settings, Interdigit Timeout, and GUI passwords in the Advanced settings, and SIP Server settings in the Voip Trunk Tab.
• Note: when making changes to a field you can use the hint to see options that can be copied and pasted into the field.

Gateway Wizard

• Choose a unique name for the configuration.
• Add a description (optional), will default to the name of the gateway.
• You can disable the gateway configuration on creation.
  • Disabling a configuration on creation will not create a configuration file in the /tftpboot directory for the gateway to download.
  • Disabling a configuration after creation will remove the configuration file in the /tftpboot directory. 
• Fill in the Gateways Mac Address (must be unique for each configuration)
• Choose a hostname for the gateway configuration
• Choose the beginning and ending FXS port then choose the Extension type
• Choose the starting extension from the assign extension dropdown 

Add Gateway

General Tab

FXS Ports Tab

• Choose the extension from the Admin or Guest dropdown
  • The Account / Extension information will be pulled from the database
• Disable any unused ports by unchecking the registration box 
  • If they are left checked they will use the default information and will continually try to register to the ComXchange and fail

FXS Ports Advanced Tab

Use this tab to make changes to an individual ports.

• You can turn registration on and off, add a hotline number and turn Open Loop Disconnect (Disconnect Supervision) on.
• Register Voip Trunk ID gives you flexibility to have an individual port register to a specific ip address or fqdn and a specific port.
• You can use this if you are using PJSIP for staff extensions that need to register to the gateway or if you need to assign a failover Sip server.
  • The Voip Trunk ID directly correlates with the VOIP Trunk number in the VOIP Trunks Tab
  • If using a mix of ChanSIP (guest extensions or staff) and PJSIP staff extensions you will need to assign one of the trunks the default port of 5160.  Then assign that Trunk ID to the Register Voip Trunk ID for the port  

Advanced Tab

In the Advanced tab you can make setting changes for an individual gateway that you may want different than the default template for the gateway.  This could include Clock Settings, Interdigit timeout, provisioning method, the interval the gateway looks for configuration, etc.

• Provisioning Method is dhcp by default. You will need to change this to server if using a static IP address
• Provisioning server is the ip address or FQDN of the server that stores the configuration which should be the ComXchange.
• Interval is how often the gateway should look for the configuration in seconds. (120 Seconds by default)
  •   You can change this to a longer interval after the initial configuration is complete so the gateway contacts the server less often
• Clock Settings are usually changed in the default template but can be changed per gateway configuration
• Dial Settings are usually changed in the default template but can be changed per gateway configuration
• Gateway Access Passwords can be used to change the password from the Admin and Operator's default password
  • these are usually changed in the default template but can be changed per gateway configuration

Digit Map Patterns Tab

• You can add or remove digit map patterns per gateway

• VoIP Trunks settings can be changed for individual gateways to provide specific extensions the ability to register to servers and ports that are not in the default template.
• This is where you can set the IP address for the secondary or failover SIP server which can then be assigned to individual ports in the FXS Ports Advanced tab.
  • The VoIP Trunk number is the Trunk ID that you will use for the Register VoIP Trunk ID and the Failover VoIP
• The gateways will associate VoIP Trunk 1 with the Primary SIP server in the gateway and VoIP Trunk 2 as a failover server for the gateways in the basic SIP settings.  If all of 

Auto provisioning to ComXchange in the cloud

When registering to ComXchange in the cloud, you can either set up a OpenVPN connection between the premise LAN (local area network) for you VoIP devices or you can register gateways and phones directly over the internet.  In either case if option 66 can be offered from a dhcp server you can auto provision your devices with minimal to no manual configuration in the devices web gui.  If you do not have the ability to hand out option 66 you will need to configure the auto provisioning information in each device using the built in web GUI.  

Using a VPN

If you choose to use an OpenVPN connection from the premise to the cloud server, the router you use will need to be an openVPN client and should be able to offer up DHCP.  The devices can get their configurations using the default protocol of TFTP and or http(s).   Also, You should be able to connect to the devices on the premise LAN through the VPN connection going through the cloud server.

Direct Registration and Provisioning Over the Internet

If you choose to have your devices register directly over the internet, creating the configurations for the phones and gateways will be very similar to creating them for an on premise deployment with some changes to how the devices reach the ComXchange for their configurations and to help with possible audio issues.  Provisioning over the internet will be done using the http or https protocol depending on which protocol is set up in the Clearly Devices module.  The Clearly Devices Module will act as a proxy for the devices to reach the ComXchange and download the configuration for the device.   The information for the proxy can be found in the clearly devices module as seen below.  

• Navigate to Core Configuration > Clearly Devices  and choose a template.  
• The Template will contain a string with the protocol, username, password, ip address or FQDN, and port number for the devices to connect to the ComXchange to download the devices configuration. 

Provisioning Phones for the Cloud

Different SIP phones will have different fields to enter the auto provisioning information to reach out to the Cloud server to download a configuration.  This will need to be setup properly for DHCP option 66 to hand out the Provisioning Address which can be acquired from the clearly devices module as noted above or it will need to be manually added in the web GUI of the phone.  Below is an example of how to manually configure a Clearly IP phone for Auto Provision. 

• Log into the web GUI and navigate to Management > Auto Provision 
• Set Upgrade Mode to use http or https (depending on your clearly devices configuration)
• Copy and paste the Provisioning Address from Clearly Devices module in both the Firmware Server Path and the Config Server Path
• Click on Save Set on the bottom of the page 

The phone should the reach out to the ComXchange cloud server and download any firmware and a configuration if available for the device.

Provisioning Gateways for the Cloud

To provision gateways for registering directly to the cloud, the gateway provisioning tool will need to be set up with the Provisioning Method to be server and the Provisioning Server field should contain the provisioning address from Clearly devices as discussed above.   You will then have to direct the gateway to get the initial configuration from DHCP or manually provisioning the Auto provisioning settings.  There are also a few other settings that may need to be set if in the Gateways Web GUI to help with NAT and Audio issues.  Otherwise creating the configurations should be very similar to setting up the gateways for a premise deployment.

Parameters to be set in the gateway Provisioning tool

• Navigate to Core Configuration > Gateway provisioning create or edit the template for the gateway.
• General Tab.
  •  In the General tab set the DNS field to use public DNS server such as 8.8.8.8 and 8.8.4.4 as you will be connecting to the ComXchange with a FQDN.

• Advanced Tab. 
  • Set the Provisioning Method to server. 
  • Add the Provisioning Address from the Clearly Devices module in the Server field.

• If DHCP is available to offer option 66 set the option in the dhcp server to point to this provisioning address as well.
• If option 66 is not available find the IP Address of the Gateway and log into the Web Gui with the Admin account and the default password of clearly.
• VoIP Trunks Tab.
  • Set the Voip Trunk to use the FQDN of the Cloud ComXchange.

Parameters to set in Gateways Web GUI

•  Navigate to Basic > Network  - Stun Server
  • Set Stun to enable
  • Set the Stun server field to stun2.l.google.com (or other Stun server)
  • Set server port to 19302
  • Click on the radio button for SIP re-registration & NAT address updating

• Navigate to Advanced > SIP - Request/Response message configuration
  • Contact field in Register should be set to External Network IP address
  • Via field should be set to External Network IP address

• Navigate to Advanced > System - NAT
  • In the  NAT traversal dropdown set to Dynamic NAT
  • Set SDP address to External Network IP Address

• Navigate to Advanced > System - Management System Type.
  • In the drop down choose Auto provision
  • copy and paste the Provisioning Address from Clearly devices in the in the ACS URL field.
  • Click on Save.
  • The Username and Password will autofill.
  • You will need to reboot for the changes to take effect and the gateway should now be looking for a configuration based on the Upgrade mode and Upgrade Period.