Directory Button


REQUIRES Clearly Devices module 14.0.12 or newer.

Overview

  • Clearly IP phones support a XML style Directory files that the phone can import to populate the Directory Application.  In the module we expose 2 different ways to setup a Directory List.  Once you have created a Directory button it will display the 2 Directory List options as outlined below.
    • Auto Sync of User Contacts - Auto created Contact Directory for each user based on what contacts the user has permissions to from the FreePBX Contact manager
    • Custom XML Directory File - Create a custom XML config of your own Directory List that you upload to the server that the phone will pickup.

Setup Directory Button

  • Navigate to the Models Layout section of Clearly Devices module on your PBX and pick which layout you want to add a Directory button for.

  • Click on Line Keys at the top

  • Setup a Line Key to be a Directory button

  • Submit your changes, it will re-write all the configs to all the phones using this model layout.
  • Now that we have the Directory button created we need to include 1 or more Directory List as outlined below.

Setup Auto Sync of User Contracts

  • If you want the Directory button to include a Directory list of all the contacts that each user has access to based on the Contact Manager module in FreePBX you would follow these steps.
  • From your FreePBX system navigate to the Clearly Devices module and on the right menu locate the Template and edit it. 
  • Click on the Directory Settings tab at the top


  • Fill in the following 2 fields
    • Contact Manager Directory - Enable or Disable if you want any user that uses this template to auto create a Directory List for the user based on what contact groups the user have permissions to in FreePBX Contact Manager.
    • Contact Manager Directory Name - The name of this Directory List that will be shown when pressing the Directory button on the phone.

  • Submit your changes, it will re-write all the configs to all the phones using this template.

Setup Custom XML Directory File

  • Create a file called something like phonebook.xml with the following content.  Below is a sample XML directory that you would have to populate on your PBX.  Once populated you just need to point the phone on where to retrieve the file from and every time it reboots or is told to check for config updates it will pull down the latest XML Directory file. It also will look every 300 minutes for an updated directory xml automatically.
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <PhoneDirectory>
  3. <DirectoryEntry>
  4. <Name> John Doe</Name>
  5. <Telephone>101</Telephone>
  6. </DirectoryEntry>
  7. <DirectoryEntry>
  8. <Name> Mike Smith</Name>
  9. <Telephone>120</Telephone>
  10. <Telephone>121</Telephone>
  11. <Telephone>122</Telephone>
  12. </DirectoryEntry>
  13. <DirectoryEntry>
  14. <Name> Jenny Smith</Name>
  15. <Telephone>130</Telephone>
  16. </DirectoryEntry>
  17. </PhoneDirectory>
  • Save the file on a server in the same directory that you have your config files saved in.  If you are using FreePBX this would be the /tftpboot/ which is where all the config files and firmware for your phones are save already.
  • We now need to go edit the configuration file for the phone.  From your FreePBX system navigate to the Clearly Devices module and on the right menu locate the Template and edit it. 

  • Click on the Directory Settings tab at the top


  • Fill in the following 2 fields
    • Directory Name - The name of this Directory List that will be shown when pressing the Directory button on the phone for this list.
    • Directory URL - This is the file name of the file you created earlier.  You do not need to put in the path for the file since the file is saved in the same directory as the config files it will just use that URL.
  • Submit your changes, it will re-write all the configs to all the phones using this template.



     RSS of this page