...

•  First, make sure you have some global settings set correctly, so choose the Global Settings option on the right.
  

  

• Internal IP - You need to set the Internal IP Address to be whatever the IP Address of the PBX is. You will use this later when creating a template.
  In our example this is set to 192.168.0.1.
  

  

   
   

• External IP - If you are going to have any phones connecting to the PBX from outside your local network, then make sure to define the External IP address or FQDN that will resolve to the External IP Address of your PBX.
  In our example we have set this to 178.891.919.111.
  

  Image RemovedImage Added

   
   

• Ports - This section displays which ports are used for the web server, HTTP provisioning, and RESTful Apps. This information is based on what you have set up in the Port Mapping section of the System Admin module. For instructions on how to change the ports, see the System Admin - Port Management wiki.

• • Web Server Port - This is the port for the PBX Admin GUI for controlling the system.

  • HTTP Provision Port - Set the phone's config to this port number if you are using HTTP provisioning for your phones. All traffic from this port will automatically be directed to the folder that contains your phone configuration and firmware.  

  • RESTful Apps Port - If you are using Phone Apps, this is the port that the applications will use to communicate with the PBX.

• Phone Admin Password - All phones that we support have a Phone Admin Password. You can set this password here, and it will be used by all phones as the Admin password for logging into the phone's web GUI. You are required to use at least 6 characters for your password. You can also use this password when using the Login REST App on the phone to login as a user without knowing the user's password.
  

  

• Phone User Password - Some phones, such as Cisco, have both an Admin User and a Normal User. You need to first log in as a Normal User, then log in as the Admin User. The Phone User Password set here defines the password for the Normal User. You are required to use at least 6 characters for your password. You can also use this password when using the Login REST App on the phone to login as a user who does not have a voicemail password set up.
  

  Image RemovedImage Added

• ReSync Time - Most phones will auto sync periodically to see if there are any phone config changes for the phone to apply. You can define this interval here in seconds.
  In our example below, 86400 would tell the phone to check once every 24 hours for new configurations and apply them if found.
  

  

• XML-API (RestAPI) Default Login - If you want to allow a phone to use the Phone Apps Login/Logout hot-desking feature, if supported by the phone, then you need to enable this option. This will cause the system to generate a default config that will present a new user with a login button on the phone after the previous user logs out. If this default login option is set to No, then when a user logs a phone out, there will be no login button available to a new user. Be sure to set this to Yes if you need to enable hot-desking. (Dark blue background = selected)
  

  

   

• Extension Mapping IP Address and Phone Status - Choose whether to display these items.

  • IP Address - This will display the IP address that the phone is reporting to your PBX while it is registered to the PBX.

  • Phone Status - This will display the ping time of the phone from the PBX while the phone is registered to the PBX.
     

    Image RemovedImage Added

• Click the Save Global button to save your changes when done.
  

  

...

• Click the menu 

  

   button on the right to expand the nav menu.

• Click on the Sangoma option under brands.
  

  Image RemovedImage Added

• At this point you can either edit an existing template or create a new template.

  • To Edit an Existing Template: Click on any template name from the list. A list of all extensions that are mapped to the template will be listed under the "Used By" section.
    

    

  • To Create a New Template: Click the New Template button.
    

    

    
    

• Template Name- Give your template a name, such as “Default.”

...

• Default Template- A single template for each brand can be marked as the default template. Please review our Hot Desking Primer wiki for EPM and Rest Apps.
  

  

  
   

• Destination Address-  Here you define what IP Address or FQDN you will program the phone with. This will tell the phone how to reach the PBX and where to register. You can either type an IP or FQDN, or select the Internal or External button to automatically pull the information from the EPM Global Settings.

...

Time Zone- The time offset from 0 (GMT) for the time zone where the phone is located, in +/-HH:MM format. For example, Central Time would be -06:00.

...

• Background Image- Use this option to change the background image used on your phone. See the Image Management section later in this wiki for information on how to upload a background image for devices.
  

  

• Line Label-  If the device supports an LCD screen for the line label you can pick between having the extension name, extension number, or both show up on the LCD for the line label on the device. Please note, the label portion of your phone is limited in the number of characters it supports. Anything too long will be cropped.

  • Name- Only the assigned name will show up, for example, "John Doe."

  • Extension- Only the extension number will show up, for example, "4000."

  • Name-Extension- Both the name and number will show up, for example, "John Doe 4000."
    

    

    • Multicast Enable- Enable or disable multicast paging on this device. If enabled, you can define a list of addresses it will listen on for a multicast page, below.
      

      Image RemovedImage Added

      
       

      • Multicast Address- List of IP addresses that the device should listen on for multicast pages, separated by commas.
        

        Image RemovedImage Added

        
         

• Dial Patterns- Here you can change the default included dial pattern for the phone. A dial pattern is what the phone looks to for a match for sending calls to the PBX.

...

• Firmware Version- The firmware slot this template will use for the firmware for these devices. Please see the Firmware Management section later in this wiki for instructions on how to create firmware slots. Each brand has an included recommended firmware slot by default, which is the version that we have tested with. This does not mean all features will work or that the firmware is bug-free; it is just the version we tested with. You can pick between Recommended, Slot 0, Slot 1 and Slot 2.
  

  

• Ring Tones- Here you can pick from the 5 included ring tones that you want to set as the default ring tone. This will be used for calls to this device any time something in the PBX is not explicitly set to override the ring tone. Please see the Sangoma phone Ring Tones wiki for more information on how Sangoma phones can dynamically change the ring tone from within the PBX based on where the caller originated.
  

  

  
   

• Screen Saver and Screen Saver Timeout- You can optionally turn on a Screen Saver and what time it should wait before it kicks on.

  • Screen Saver- Select one of the available types.
    

    

  • Screen Saver Timeout- If you do not want to enable the screen saver, select Screen Saver Off. Otherwise, select one of the time delay options for how long the phone should wait before turning on the screen saver.
    

    Image RemovedImage Added

• Headset Priority- Enable this option if you want to connect an Electronic Hook Switch (EHS) headset to the phone.
  

  

• Call Waiting Signal- Enable this option if you want to hear a beep on the phone when a call is sent to your device while you are already on a call. If you set this to Disabled, the call is still sent to your device and you can see the inbound call on the screen of the phone, but an audible call waiting tone will not be played to you.
  

  

• BLF Alert- If you have a BLF button set up to monitor 1 or more extensions, you can optionally have an audio alert, visual alert, or both sent to your phone. See the BLF Alerts wiki for more information. 
  

  

  
   

• HotLine and HotLine Destination- The Hotline Dial option allows you to set up the phone to auto-dial a specific extension or phone number when you take the receiver off hook. This is handy in a lobby area where you can inform the caller to pick up the handset in order to automatically place a call. You can set this to route the call to a destination such as an extension, outside phone number, queue, ring group or IVR. 

  • HotLine-  Pick whether to enable or disable the hotline dial option. If you Enable it, you will see the option to enter a destination below.

  • HotLine Destination- The destination that the phone will automatically dial when a user takes the receiver off hook.
    

    

• Provision Server Address- This is used to tell the phone what IP or FQDN Address it should use to locate and pull firmware and configuration files from. This is usually your PBX IP or FQDN.
     

  

...

• You can optionally change the Label name to be something different for any button type except Line. The Label is the name that will be shown on your phone screen for that button.  

  • For the Line type, the Label name will automatically be whatever you defined in the Template Settings section called Line Label. The default is to show the extension number of the device. You can change this to show the name instead, or both name and extension number.
     

    

• You can also drag the button to be in a different position. Left-click on the table row for the button, and while holding down your left mouse button, drag the button to a different spot and release it.
  In our example we will drag Button 21 up toward the top to make it button 4 on the phone. Note that it will initially say "21" instead of "4" after dragging it to position 4. However, the number sequence will be corrected after you save your settings.
   

  

• Once done, click the Save Model button to save your settings for this model.
  

  Image RemovedImage Added

• If you go back into the model number it will show the new numbering.
  For example, our Intercom button that was 21, is now 4 instead of 21.
  

  

• You now need to update the phone config. Choose an option from the drop-down and click the Apply button. Your 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 Extension Mapping section of End Point Manager.
    

    

     
     

  • Save and Rebuild Config(s)- This will save your changes to the PBX database and write out new config files for the phones that are using this template as mapped in Extension Mapping section of End Point Manager. The phones will not retrieve the changes.
    

    

     
     

  • Save, Rebuild Config(s) and Update Phones- This will do both the Save Template and Rebuild Configs options above. It will also immediately update any phones that are mapped to use this template and currently registered to the PBX with no need to reboot the phones.
    

    

     

...

• Click the menu   button on the right to expand the nav menu.

• Click on Extension Mapping in the nav menu.
   

  

  • You should see a table similar to this, showing any extensions you have mapped.
    

    

...

• On the Extension Mapping home screen, click the Add Extension button at the top. This will add a new row to the table of extensions.
   

  

  • Here you can configure 6 options:

    • In the first column select an Extension Number and Name on the top and an Account on the bottom.

    •  In the second column, select a phone Brand on the top and enter the phone's MAC Address on the bottom.

    • In the third column, select a Template on the top in and a phone Model on the bottom.
      

      

  • Scroll to the bottom and select one of the options from the drop-down menu. Then click the Use Selected button to apply the action. The options are:

    • Save and Rebuild Config(s)- This will save the information to the database and build the config file for that phone, so the phone can retrieve the configuration file.
      

      

    • Save, Rebuild Config(s) and Update Phones- This will save the information to the database, build the config file for that phone, and tell the phone to retrieve its config file. The reboot option will only work if the phone is currently registered with the PBX.
      

      

    • Delete Selected- Deletes the selected Extension from Extension Mapping.
      

      

...

• In End Point Manager, click the menu   button on the right to expand the nav menu.

• Click on Image Management in the nav menu, under the Advanced section.
   

  

  • You will now see a list of any images you have uploaded.
    

    

...

Basefile editing is designed to let you edit all the hidden default settings that EPM hard codes for each template created.

Reveiw our EPM-Basefiles wiki for more in-depth information on basefile editing.

...

• Click the menu   button on the right to expand the nav menu.
   

• Click on Basefile Edit in the Advanced section in the nav menu.
  

  

• You will see a list of all your templates. Click on the name of the template you want to edit.
  

  

• Pick which model number to edit.
  

  

• Click on the option you want to change.
  

  

• Make your changes.
  

  

• At the top is a list of models that your change will affect. (Dark blue background = selected.) You can deselect any model numbers you do not want to change. Click the model names to select or deselect them.
  In the example below, we have selected only the s500 and s700.
  

  

• Pick the Change Basefile button to save your change, or the Delete Entry button to delete the entry.
  

  

Custom Extension Management

...

Adding a Custom Extension 

• Click the menu   button on the right to expand the nav menu.

• Click Custom Ext Management in the Advanced Section of the nav menu.
  

  

• Click on the New Custom Extension button at the top of the page.
  

  

   

• Fill in the following information.

  • Extension Number- The extension number for this custom extension.

  • Extension Password- The SIP Secret or Password for this extension, as defined on your other PBX, to allow this extension to register.

  • Label- The name that you want associated with this custom extension, such as "John Doe."

  • Destination- The IP address of where this extension needs to register to.

  • SIP Port- The SIP port where this extension needs to register to. The default for FreePBX or PBXact systems is port 5060.

...

• When done, click the Save Custom Extension button.
  

  

   

• Now your new custom extension will show up in the dropdown of available extensions in the Extension Mapping section of EPM.
  

  

...

In the example below, Soft Key 1 is only shown when the phone is idle. Soft Key 2 is shown in all states.

...

Algo Templates

...

All the device settings for the AND Clock are as follows. You can hover over the “?” for more information on each setting.

...

Audio Codes Templates

(no special settings)

Cisco Templates

...

Some models of Cisco phones support Expansion modules. You can have a total of 2 expansion modules per phone. You set up the Expansion Module buttons just like any other phone button. You will use the Extension Mapping section of EPM to actually map which extensions use which expansion modules, and in what order.

...

CyberData Templates

...

• Relay Destination- What number to dial when someone presses the intercom button. This can be any phone number or destination on your PBX, like a ring group, queue, or extension number.

• Momentary Key Press Digit- What digit you can press on your phone to unlock the door after answering a call from the call button. 

• Pincode 1-10- These are PIN codes that a user can press on the keypad of the device to unlock the door from the keypad. 

• Dial Code 00-14- These are the 15 different paging zones that someone can enter when dialing the zone controller. You can then pick which combination of zones for each code will be included in the page.

...

Digium Templates 

Below are settings that are unique to Digium that are different from the standard example we used with the Sangoma brand earlier in this wiki. 

Horizontal Soft Key States

...

• Idle- The phone has no call activity.

• Hold- The phone has a call on hold.

• Incoming- The phone is receiving an inbound call it has not answered yet. 

• Connected- The phone has an active call.

• Dial- The user is dialing a number.

• Calling- The phone is making an outbound call that has not been answered yet.

...

Grandstream Templates

...

• Auto Answer- If you want the device to auto answer to the speaker phone for every call that comes to the device.
  

  

   

• Mute Mic- If you have Auto Answer set to Enabled, you can choose if you want the microphone on the phone to be muted by default when it auto answers.
  

  

   

• Auto Off Hook- If you have Auto Answer set to Enabled, and the person calling this device hangs up, the phone can hang up or go back into idle mode.
   

  

Button Types

For each button you can pick from the following types:

...

Button Types

For each button you can pick from the following types:

...

Button Types

For each button you can pick from the following types:

• Line- Since Mocet phones do not have dedicated line keys, you have to program 1 or more of the buttons on your phone to be your line key so that you can make outbound calls.

• BLF- Busy Lamp Field allows you to program a button to monitor another extension. The light by the button will be red whenever that extension is on a call. You can also press the button to call the user.

• Speed Dial- Allows you to program a number that will automatically be dialed when you press this button.
   

Obihai Templates

...

•  Line- Since Panasonic phones do not have dedicated line keys, you need to program 1 or more of the buttons on your phone to be your line key so that you can make outbound calls.  

•  BLF- Busy Lamp Field allows you to program a button to monitor another extension. The light by the button will be red whenever that extension is on a call. You can also press the button to call the user.

•  Speed Dial- Allows you to program a number that will automatically be dialed when you press this button.

Phoenix Audio Templates

(no special settings)

...

Polycom Built-In Features

 You can choose whether you want the following buttons to be displayed on the bottom horizontal row of each phone. 

...

Some models of Polycom phones support expansion modules. You can have a total of 3 expansion modules per phone. You set up the Expansion Module buttons just like any other phone button. You will use the Extension Mapping section of EPM to actually map which extensions use which expansion modules, and in what order.

...

SNOM Templates

...

Some models of Snom phones support expansion modules. You can have a total of 3 expansion modules per phone. You set up the Expansion Module buttons just like any other phone button. You will use the Extension Mapping section of EPM to actually map which extensions use which expansion modules, and in what order.

...

Xorcom Templates

...