Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

Info

Not all DHCP servers support "Option 66". This is common in typical small office routers. If your router's DHCP server does not support "Option 66" (also sometimes called TFTP option) we recommend using either the PnP service, or the Sangoma redirection service to auto-provision your phones.

This procedure will not work for remote users  

FreePBX / PBXact Administration

...

  • Navigate to the Global Settings section of EPM from the right nav bar.

    Image RemovedImage Added
  • Define the Internal IP Address or FQDN that phones will connect to when local to the PBX.

    Image RemovedImage Added
  • Define the External IP Address or FQDN that phones will connect to when not local to the PBX.

    Image RemovedImage Added
  • Also take note what port you have HTTP Provisioning setup on as that port needs to be accessible for your phone to receive its configrations.

    Image RemovedImage Added
  • Press the Save Global button.

...

  • In the right nav menu, under Brands, click on Sangoma.

  • Either click on the New Template button at the top to create a new template, or click on the default-sangoma template name to edit the included default template.

     

    • Give the template a Name. For the Destination Address, pick either the Internal or External option. This will pull in the IP address that you entered in the Global Settings section earlier.

      Image RemovedImage Added

       

    • Define your Time Zone and if you want Daylight Savings time mode to be enabled.

      Image RemovedImage Added

       

    • For Firmware Version, pick Firmware Slot 1 from the drop-down menu. (When you install EPM it will install the latest firmware in slot 1.)  See Firmware Management for more information on updating firmware for your phones in the future.

      Image RemovedImage Added

       

    • Define what Provision Server Protocol you want to use to have your phones receive their config files:

      • TFTP should be used when phones are local to the PBX, as it's easy to use and requires no setup.  

      • HTTP should be used for local or remote phones and is easy to use and required no other setup.  The default HTTP port used for phone configs is port 83 but may be different on your PBX.  You can view the port that is currently setup for HTTP in the Global Settings section we just went through above. 

      • FTP should be used if your phones are remote, as it requires the phone to know the FTP username and password to receive the config file.

        • If using FTP, you will need to set up an FTP username and password for the PBX. Review the System Admin - FTP Setup wiki for information on setting up a username and password for phones to receive their configuration files via FTP.

...

  • Click on the Groups tab at the top
     

    Image RemovedImage Added
  • Press the Edit button

     next to the group you want to edit permissions for.  By default on a new system we create a Group called All Users and when you create extension they should be auto assigned to this group.  

    Image RemovedImage Added

  • We will first see all the users who are apart of this group and can add any missing users to this group from here.

    Image RemovedImage Added

  • Click on the tab at the top for Phone Apps

    Image RemovedImage Added

  • From here we can see we have Allow Access to Phone Apps enabled

     

  • Click on any specific application tab we can now set permissions on that application. In our example we will select the Conference tab 

    Image RemovedImage Added

     

  • We will verify that access to the Conference Room is set to yes for this group.

    Image RemovedImage Added

     

  • We can also then control what conference rooms the user can see.  

    • in our example below we are saying the user has access to their own conference room that is linked to them from the conference room module in your PBX and also we have shared the General Conference Room to all users in this group.

...

  • By default when a new user is created most permissions for that user are told to be inherited by the group they are apart of.  We are going to go verify they are all setup correct.  If a user permission is not setup when they try to use a app on the phone or login to the phone they will get error saying they do not have permissions.

  • Navigate in your PBX to the User Management module.

  • Click on the Users tab at the top

    Image RemovedImage Added

     

  •  Press the Edit button next to the user you want to edit permissions for.

    Image RemovedImage Added
  • Click on the Phone Apps tab on the top

    Image RemovedImage Added

     

  • For each permission you want to verify it is set to inherit from the group.  If you wanted to override a permission for a user to be different then the group permissions you can do that here by not using the inherit option.

    Image RemovedImage Added

     

  • From here go into each tab under Phone Apps and make sure you have your permissions setup correct and press the submit button at the bottom of the page when done.

...

In the case that your voice network will not have IP connectivity to the Internet, you can use the "Option 66" feature built inside your company DHCP server to auto-provision your Sangoma phones. This requires the IT administrator to insert the IP address/FQDN of the FreePBX server into the company router, under the "Option 66" parameter of the DHCP settings. This procedure is required only once. Since no configuration is required on the Sangoma phones, this procedure is beneficial for mass deployments.

Examples of valid URIs, showing the URL with port would be:

http://HTTP Username:HTTP Password@FQDN:84

...

  • In the right nav menu, under Brands, click on Sangoma

  • Click on the default-sangoma template name to edit the included default template or any other template that you want to edit.

  • Click on the 'Models' tab to list the available Phones, then select the phone model.

  • You will be presented with a view of all available programmable buttons for that phone model.

    example from S700

  • The first 2-3 buttons should always be set up as line keys. A line key is what allows you to make or receive a call, so if you want to manage two calls at a time, you need to set up two line keys.

    Image RemovedImage Added
  • If you wish to add more Line keys, beside the line key number, select the Type drop down,  and choose Line.

    Image RemovedImage Added
  • For the remaining buttons on your phone, assign whichever phone apps you wish, to each button.  

  • To assign a phone app, beside the line key number, select the Type drop-down, and choose XML-API

    Example for Line key 5 on S700:

    Image RemovedImage Added

  • Click on the Value drop-down beside the line key and select the phone app you wish to assign to that line key

     

    • Once selecting the phone app the line key will be updated with the phone app.
      In the below image, the Call Flow phone app was chosen for line key 5

      Image RemovedImage Added

Info

The default text presented under the Value field is the name of the phone app that will be displayed on the phone's screen for that button. Feel free to change the default name

...

  • Finish selecting the phone app you wish to assign for each button

  • Once completed, your phone app view would look something like the following image, based on the phone apps chosen

    Image RemovedImage Added

     

  • When done editing, press the Save Model button to save your settings for this model.

  • You now need to update the phone configuration file. Choose an option and click the Apply button. The three options at the bottom of the template are:

    • Save- This will only save your changes into the PBX database. It will not write out new config files for the phones that are using this template as mapped in the Extension Mapping section of End Point Manager.

      Image RemovedImage Added

       

    • Save and Rebuild Config(s)- This will save your changes to the PBX Database and also write out new config files for the phones that are using this template as mapped in the Extension Mapping section of End Point Manager. The phones do not retrieve the updates and will need to be rebooted to get their update.

      Image RemovedImage Added

       

    • Save, Rebuild Config(s) and Update Phones- This will save changes into the PBX database, write out new config files for the phones, and also immediately update any phones that are mapped to use this template and currently registered to the PBX. This may cause the phones to reboot in rare instances but while the phone is processing the updated config for 5-10 seconds the buttons will not be usable on the phone.

      Image RemovedImage Added

  • The Phone apps on the phone's display should now be presented by each button. Below is a screenshot of a phone with some phone apps configured.

    Image RemovedImage Added

     

  • For information on how to use each phone app, visit: Application Userguides

...