NOTE: This thread covers the early released versions of the Caller ID Superfecta module for FreePBX.
THIS INFORMATION IS OBSOLETE and is maintained here for historical and reference purposes only.
Go here for the current CID Superfecta thread. (tshif)
Caller ID Superfecta: THE MODULE
If there is one thing that is universally expected when people set up a PBX, it’s got to be Caller ID. And, as we all know – Caller ID is the responsibility of the receiving party’s telephone providers. Um, in simpler terms, that's US, and our PBX's.
There’s at least two very good examples of this function right here in the forum. The Ultimate CNAM, originally created by former forum participant Titanous and the Caller ID Superfecta, originally written by our own Nerd Uno, Ward Mundy.
As a testimony to open software – both of these creations have now exceeded their original programmers’ vision because the community here at the PBXIAF forums has contributed to their growth. Today – each of these Caller ID look up programs has been extended to include more sources of information than the original authors would have imagined.
There’s just a couple little hiccups with getting all this good stuff working right. The install scripts have to be run from a CLI, and their configuration parameters have to be edited in a text file editor. I always thought it should be possible to install, configure and use these great tools without having to do all that. And - when its time to upgrade – its just to messy for an end user to attempt.
Since I’ve been on a module kick of late – it occurred to me that all that could be solved by “modularizing” the Caller ID function into a FreePBX Module.
Open Software Should Be Open
It’s a rare and beautiful thing to see folks contributing to a coding project. But have a look around here at the PBXIAF forums and you see it; A lot of it. It may not be unique – buts its rare enough. I most sincerely hope that all of you who have contributed to the Superfecta code upgrade along the way will consider updating this module in the same way. I will certainly keep track of its status – but everyone here who has been contributing should feel as welcome to provide upgrades to the module as they have for the non module version of the Superfecta. I hope to have it in a svn soon – so that all can have easy access.
The module still installs and uses callerid.php. The only changes I have made were to comment out the configuration section in the script, and add a few lines of code to cause it to gather those same configuration items from a database. The changes are well commented, and highly localized, just as the previous block of config data was at the top of the script. For the typical upgrade, such as when a provider changes their output, modifying the script will feel identical to how you have done so in the past.
To add additional sources can be accomplished almost as easy with more changes to the supporting module code.
Install and Upgrade
This module should co reside with any and all other CID solutions you maybe running. It will take about 1 minute to complete the install. Upgrading will not wipe out your settings.
Installation:
(This download link was updated on 5-3-2009 to point to the most current version of this module - tshif)
Step 1: Download the module to your desktop From here. (Generally, you'll want to select the most recent released (non-dev) version.)
Don’t decompress the archive!
Step 2: Use a web browser to access FreePBX on your PBX. Choose Tools, Module Admin, Upload Module.
Now, browse to the superfecta-1.0.3.3.tgz file on your Desktop and click the Upload button. Now click local module administration, scroll down and click on CID Superfecta and then the Install radio button. Now click Process, and complete the usual FreePBX install and reload process.
Step 3: Use a web browser to access FreePBX on your PBX. Choose Setup, CID Superfecta.
You will be presented with configuration screen. Establish settings that make sense for your PBX, and Save your changes.
Step 4: Use a web browser to access FreePBX on your PBX. Choose Setup, Caller ID Look Up Sources.
The module installer has already created the entry for Caller ID Superfecta. Select if from the list. In the USERNAME enter MAINT, PASSWORD field enter your current PBXIAF MAINT password.
NOTE: Yes, I know the password is visible. It’s a FreePBX thing. If it means anything to you, I think the password box should be obfuscated (stars) by FreePBX. But until they come around to my way of thinking (lol), consider this. If the person is already viewing this screen, they have to have the password already – or they couldn’t be here. If this STILL drives you crazy - look here for a fix. (4/1/09: (http://freepbx.org/trac/ticket/3613. Sorry - I tried. I guess I didn't do the naked dance around the fire well enough to appease the "great ones". If I ever get so closed-eared and arrogant, please somebody shoot me.)
Conditions/Prerequisites:
TThis module is compatible with the security models used in, and has been tested with the following distributions:
Fonicatec PABX
Foncordiax
PBX In A Flash
TrixBOX CE
The Module’s wiki Page is here.
(If you use a distro other than PBXIAF, read the wiki for more installation help.)
Asterisk Version Compatibility
This module has been tested and found to work correctly with Asterisk versions 1.4 and 1.6.
Credits:
The CallerID Superfecta was written originally by Ward Mundy, as the Caller ID Trifecta. It has evolved to support more sources, and is now maintained by the community of forum users at PBX In a Flash.
The Superfecta was converted to FreePBX Module format by Tony Shiffer & Jerry Swordsteel.
Notice:
The Developement Home page for this module is here.
The Caller ID code undergoes regular maintenance - it is our hope that by placing the module in an svn that everyone who wants to contribute can and still will do so. Besides, this a great way for you to start getting familiar with modules in general!
I’ll post the link to the svn back to this article as soon as its ready.
Until next time
-tshif
THIS INFORMATION IS OBSOLETE and is maintained here for historical and reference purposes only.
Go here for the current CID Superfecta thread. (tshif)
Caller ID Superfecta: THE MODULE
If there is one thing that is universally expected when people set up a PBX, it’s got to be Caller ID. And, as we all know – Caller ID is the responsibility of the receiving party’s telephone providers. Um, in simpler terms, that's US, and our PBX's.
There’s at least two very good examples of this function right here in the forum. The Ultimate CNAM, originally created by former forum participant Titanous and the Caller ID Superfecta, originally written by our own Nerd Uno, Ward Mundy.
As a testimony to open software – both of these creations have now exceeded their original programmers’ vision because the community here at the PBXIAF forums has contributed to their growth. Today – each of these Caller ID look up programs has been extended to include more sources of information than the original authors would have imagined.
There’s just a couple little hiccups with getting all this good stuff working right. The install scripts have to be run from a CLI, and their configuration parameters have to be edited in a text file editor. I always thought it should be possible to install, configure and use these great tools without having to do all that. And - when its time to upgrade – its just to messy for an end user to attempt.
Since I’ve been on a module kick of late – it occurred to me that all that could be solved by “modularizing” the Caller ID function into a FreePBX Module.
Open Software Should Be Open
It’s a rare and beautiful thing to see folks contributing to a coding project. But have a look around here at the PBXIAF forums and you see it; A lot of it. It may not be unique – buts its rare enough. I most sincerely hope that all of you who have contributed to the Superfecta code upgrade along the way will consider updating this module in the same way. I will certainly keep track of its status – but everyone here who has been contributing should feel as welcome to provide upgrades to the module as they have for the non module version of the Superfecta. I hope to have it in a svn soon – so that all can have easy access.
The module still installs and uses callerid.php. The only changes I have made were to comment out the configuration section in the script, and add a few lines of code to cause it to gather those same configuration items from a database. The changes are well commented, and highly localized, just as the previous block of config data was at the top of the script. For the typical upgrade, such as when a provider changes their output, modifying the script will feel identical to how you have done so in the past.
To add additional sources can be accomplished almost as easy with more changes to the supporting module code.
Install and Upgrade
This module should co reside with any and all other CID solutions you maybe running. It will take about 1 minute to complete the install. Upgrading will not wipe out your settings.
Installation:
(This download link was updated on 5-3-2009 to point to the most current version of this module - tshif)
Step 1: Download the module to your desktop From here. (Generally, you'll want to select the most recent released (non-dev) version.)
Don’t decompress the archive!
Step 2: Use a web browser to access FreePBX on your PBX. Choose Tools, Module Admin, Upload Module.
Now, browse to the superfecta-1.0.3.3.tgz file on your Desktop and click the Upload button. Now click local module administration, scroll down and click on CID Superfecta and then the Install radio button. Now click Process, and complete the usual FreePBX install and reload process.
Step 3: Use a web browser to access FreePBX on your PBX. Choose Setup, CID Superfecta.
You will be presented with configuration screen. Establish settings that make sense for your PBX, and Save your changes.
Step 4: Use a web browser to access FreePBX on your PBX. Choose Setup, Caller ID Look Up Sources.
The module installer has already created the entry for Caller ID Superfecta. Select if from the list. In the USERNAME enter MAINT, PASSWORD field enter your current PBXIAF MAINT password.
NOTE: Yes, I know the password is visible. It’s a FreePBX thing. If it means anything to you, I think the password box should be obfuscated (stars) by FreePBX. But until they come around to my way of thinking (lol), consider this. If the person is already viewing this screen, they have to have the password already – or they couldn’t be here. If this STILL drives you crazy - look here for a fix. (4/1/09: (http://freepbx.org/trac/ticket/3613. Sorry - I tried. I guess I didn't do the naked dance around the fire well enough to appease the "great ones". If I ever get so closed-eared and arrogant, please somebody shoot me.)
Conditions/Prerequisites:
TThis module is compatible with the security models used in, and has been tested with the following distributions:
Fonicatec PABX
Foncordiax
PBX In A Flash
TrixBOX CE
The Module’s wiki Page is here.
(If you use a distro other than PBXIAF, read the wiki for more installation help.)
Asterisk Version Compatibility
This module has been tested and found to work correctly with Asterisk versions 1.4 and 1.6.
Credits:
The CallerID Superfecta was written originally by Ward Mundy, as the Caller ID Trifecta. It has evolved to support more sources, and is now maintained by the community of forum users at PBX In a Flash.
The Superfecta was converted to FreePBX Module format by Tony Shiffer & Jerry Swordsteel.
Notice:
The Developement Home page for this module is here.
The Caller ID code undergoes regular maintenance - it is our hope that by placing the module in an svn that everyone who wants to contribute can and still will do so. Besides, this a great way for you to start getting familiar with modules in general!
I’ll post the link to the svn back to this article as soon as its ready.
Until next time
-tshif
Last edited by a moderator: