NEW CallerID Superfecta 2.2.3: THE MODULE

[patrick_elx]

that's my fault, I updated this source to improve the way the match is done (as a lot of people are entering numbers in database with country code, +, space and bracket). But I forgot to code a test to check that the options are set up properly.

I've open a feature request #194 to make sure that default values are setup on install.

[tshif]

New Superfecta Data Sources for Sweden and the UK
And the community just keeps giving! Four new sources for non North American CID lookup have recently been added to the Superfecta Live Update repository.

source-Lokaldelen_SE.php (contributed by Nixi)
source-Eniro_SE.php (contributed by Nixi)
source-Vemringde_SE.php (contributed by Nixi)
source-PhoneLookup_UK.php (contributed by Chris Bailes)

Thanks to Nixi and Chris, these three new Swedish sources and one UK source are NOW AVAILABLE within the Superfecta v 2.2. modules' built in data source update function. Be sure and check them out!

The time has never been better to get involved and help create new data sources for the Superfecta Module! The documentation to help get you started is here.

-tshif

OOPS: The sources didnt make it to the live update function the first time - they are there now.

[tshif]

Updated Superfecta Data Sources available now in Live Update Repo
Big thanks to developer Patrick for this maintenance release of 7 Data sources, which have now been updated in the Superfecta Live Update repository.

source-Hitta_SE.php
source-Infobel.php
source-Open79XX.php
source-PhoneSpamFilter.php
source-PhoneSpamFilter_UK.php
source-SugarCRM.php
source-Superfecta_Cache.php

These newly upgraded sources bring these data sources into compliance with the new data source coding standards.

These upgrades make the data sources smarter and faster in operation. - and new default paramters have been added to make their installation more mistake-proof than ever.

These updated data sources are NOW AVAILABLE within the Superfecta v 2.2. modules' built in data source update function. Be sure and check them out!

[tshif]

Did you know that you can easily stay on top of all the news related to the development effort for Caller ID Superfecta: THE MODULE?

It's true - and its really easy using the Superfecta RSS news feed.

To sign up for the feed, visit the Superfecta News Page, go to the bottom of the page, and use the "Atom" link at the bottom of the page to subscribe.

Anytime Superfecta news is announced there - it will show up in your feeds.

-tshif

[tshif]

Caller ID Superfecta: THE MODULE v 2.2.1 Release Announcement
(The first portions of this article consist of a review of the modules principle technical features, the second major section is about installation and configuration.)

When I was preparing to write this introduction to the latest release of the caller ID Superfecta module for FreePBX, I looked back at the very first announcement I made when version 1.0 of the module was released. As it turns out, it wasn't too hard to find - as it was released right here in the PBX in a flash forums. http://pbxinaflash.com/forum/showthread.php?t=3747 , a mere 7 months ago.

So, if you count the time I spent pulling out my hair, and trying to understand how to build a module in the first place, we can say that the caller ID Superfecta module for FreePBX has been under development for a total of about 10 months. Of course, the basis for the caller ID Superfecta module was Ward Mundy's program, the caller ID Superfecta script. That script itself was based on a previous work of Ward himself called the caller ID trifecta.

I know in technological terms, that 10 months can be a long time; But I can't help but be very nearly awestruck by the progress that has occurred in the evolution and development of Caller ID Superfecta: THE MODULE in that time.

In fact, this version of Superfecta: THE MODULE has achieved a long list of medium and long-range goals that have been being collected for as long as the project has existed. This version is considered a feature release for the version 2.2.x series of the Superfecta module.

In version 2.0.0, the underlying architecture of Superfecta was changed to prepare for better support of caller ID schemes used outside of the United States, as well as other changes designed to enhance the configuration options available within Superfecta.

In releasing version 2.2.0 (8/17/09) , the Superfecta development team addressed and closed every trouble ticket which had been filed against all version 2.0 releases. Project lead developer Jeremy Jacobs also quietly deployed some of the most exciting changes to the module yet: (1) The concept of CID Schemes – which allows the use of different sources for different inbound routes based on pattern matching on both CID and DID, and (2) Online Source Updating, which provides a completely interface driven way of updating data source scripts direct from the development live update repository.

So – what could we possibly add to that? I’m so glad you asked!

I am delighted to announce the immediate release and availability of Caller ID Superfecta: THE MODULE Version 2.2.1.

The principle goals for this release were to correct three minor bugs that had been reported in v2.2.0 since its release (8/17/2009), and to execute our final planned changes for support of worldwide CID schemes.

With this release of version 2.2.1, the Superfecta development team addressed and closed every trouble ticket which had been filed against 2.2.0 – including what we think are the last few bumps in the road to Superfecta supporting virtually any caller ID format you can imagine. You read that right – international support has arrived in Superfecta: THE MODULE version 2.2.1 in a big way.

As if that wasn’t enough – Developer Patrick_elx developed and deployed several key changes that make the many data sources, smarter and faster.

Module’s Principle Technical Features
In case you’ve just joined the party, Caller ID Superfecta: THE MODULE provides for the selection, configuration and use of multiple data sources for caller ID and SPAM scoring within most any FreePBX based Asterisk distribution. Its installation, configuration, use, and upgrade is 100% interface driven. There are no “drop to the command line and…” things needed in order to utilize all of its features.

· Seamless Module Upgrades
The caller ID Superfecta version 2.2.1 is compliant with the free PBX module install, upgrade, and uninstall functions. It is not necessary or desirable to remove previous versions of the caller ID Superfecta from your PBX before installing version 2.2.1 The module installation or upgrade process will correctly deal with previous versions of the module, and previous versions of the data sources. This has been the case since the Superfecta was put into FreePBX module format.

· Separation of Module Code and Data Sources Code
The program code for the caller ID Superfecta module and the code for the individual caller ID and phone Spam data sources has been separated. New data sources may now be introduced, and old ones updated, without the need to rerelease (or regression test) the entire module.

This will allow for much more rapid development, testing, and deployment of new data sources, and much more rapid updates when data sources change their formats. The idea for this separation came about in discussions between the project lead developer Jeremy Jacobs, and myself.

· Support for Caller ID / SPAM Lookup Outside the United States
Previous versions of the caller ID Superfecta had a bit of a struggle trying to work for caller ID schemes outside of the United States. This version, thanks to support for multiple caller ID schemes (see below), as well as some minor changes to the data source files, is expected to allow Superfecta to handle virtually any caller ID scheme in use worldwide.

Now, as new online sources of data for various regions are uncovered, data source script files for them may be quickly developed (almost template based) , and easily introduced to the PBX, all without having to reinstall the module.

The goal of getting Superfecta to support caller ID schemes beyond just those in North America has been around a long time, and was made real by our lead developer, Jeremy Jacobs, with contributions by Patrick_elx.

· Support for Multiple Caller ID schemes
Previous versions of the caller ID Superfecta were not well equipped to deal with a variety of formats for inbound caller ID. For example, a PBX with two inbound service providers, one delivering caller ID in 10 digit format, and one delivering caller ID and 11 digit format-caused some real pain (and probably some “by hand” editing) for the system administrator.

Version 2.2.1 supports multiple caller ID schemes, each scheme giving the administrator remarkable flexibility and call handling options.

As we have for inbound call routing and trunk selection in FreePBX, caller ID Superfecta now provides configuration options to specify both the DID, and the caller ID rules to be used for each schema. Both of these fields support most of the traditional pattern matching capabilities.

Using the DID number and CID rules configuration fields allows you to direct inbound calls to a Superfecta Schema whose data sources, search order, and other options have been optimized for calls matching specific criteria in CID and DID.

This capability is also integral to the caller ID Superfecta's ability to support caller ID lookup and telephone Spam Lookup functions for not only the United States, but literally anywhere in the world for which data sources can be found.

This concept of dealing with multiple formats of caller ID as a "caller ID context" originated right here in the forums, with user patrick_elx. Thanks for that extremely good idea Patrick! (Patrick has since joined the Superfecta development team. Among other tasks, Patrick has introduced several user contributed scripts to the project, and also handles correcting the vast majority of bug reports which get filed. ) The concept was brought online and made real in the form of CID Schemes by our lead Developer.

(See next article, Part 2 for continuance)

[tshif]

(Continued from previous article)

· Smarter data source scripts
In previous versions of Superfecta, data source scripts would attempt to look up any caller ID number presented to them, regardless of the format. In general, data sources tend to be regional in nature. Thus telephone numbers originating from outside the region need not be processed through them-since they have absolutely no chance whatsoever of delivering a positive result. Yet the data sources would allow it - and basically waste the number of seconds that it took to fail in a futile attempt.

All data source scripts for the caller ID Superfecta have now been modified and upgraded so that they do not attempt to process numbers whose CID is not supported by the source.; Instead, the data source will fail immediately, thus preventing the waste any time on searching a provider who could not possibly produce positive results. Smarter faster data source scripts is another one of the many contribution of “Developer Patrick”.

· Extremely Flexible Data Sourcing
Many readers have probably been using the caller ID Superfecta since before it was modularized, probably since before it was even called the Superfecta. Back then, it was called the Caller ID Trifecta, and it sported three sources of data.

As of this writing, there are 25 individual data source scripts available for use with the caller ID Superfecta 2.2.1 and higher. I can barely believe it myself - but it's true.

Easy Integration of New Sources
For the developer, the new release of the Caller ID Superfecta sports a fairly sophisticated mini API (Application Programmers Interface), that allows Superfecta data-source scripts to support some pretty exciting capabilities. Data-source scripts can provide very detailed debug information from each source, and can easily support sources that have specialized data needs, such as authentication.

"Automatic" Support for Services Which Require Authentication/Token
Adding new data sources, even those which require some form of authentication, no longer requires a separate development effort to modify the user interface, or the database structure. When a properly coded data source script is added to the module – all the necessary user interface elements (special configuration items, etc) automatically become available to the administrator to configure in the ui. (If you're a developer who's dying to add his or her favourite source, check out the source creation documentation here, and then share your creation with the rest of us. ) http://projects.colsolgrp.net/documents/show/8

Report Back
Some data sources (such as WhoCalled.us) are made up of user contributed data, it seems only fair that we help populate the information pool. Toward that end, data source scripts can include “report back’ capabilities.

If Superfecta finds a CID in any enabled data source, it will be a good net-itizen and “report back” this finding to enabled sources that have “Report back” turned on.

International Number Format Support
For the first time, in the last several days, we have released caller ID and or spam scoring source scripts specifically for Sweden, Switzerland, the UK. There’s even a data source being prepared for Scandinavian locations, and should I mention LDAP? ! (Shhhh! I’m not supposed to talk about future happenings to much…) Having seen the way people here in the forums pitch in, I'm sure they'll be many more to come. With the current architecture, its hard to imagine a data source which could not be mined with a properly coded data-source script.

The goal of making it easier to add and repair the data sourcing aspects of the Superfecta has been around since before the module version of Superfecta was first created. Our own Uncle Ward was among the first to point out the advantages of separating the programming of data source scripts from the coding of the main Superfecta script Our lead developer Jeremy Jacobs made it reality with the series 2.X, and fine tuned it with 2.2.1.

· Built In "live update" for data source scripts
One of the most important requirements for getting the most out of the Superfecta module is to keep the data source scripts up to date with changes made by the data suppliers.

“I know data providers – they love to change things.”
As we all have experienced, the data providers have an unwitting (and annoying) tendency to make changes to the way the data we seek is being returned to our queries.

When they do this, some contributing developer somewhere has to roll up his or her sleeves, and change the code in Superfecta to accommodate the new data format. In version 2.0 of the Superfecta module, we already had already separated the development of the data source scripts from that of the main module -- but we had no mechanism available to distribute the updated data source scripts other than to re-release the entire Superfecta module.

As I mentioned earlier, this was not optimal for several reasons. Among them, it takes longer to troubleshoot and quality test the entire module for re-release than it does to troubleshoot and quality test a single data script for release.

Version 2.2.1 of Superfecta solves this problem entirely – and in a way that’s realllly cool.

From within the Superfecta module itself, simply check mark the “Check for Source File updates online” box, and wait a moment. (You can also click on any source name, or debug).

When you do, Superfecta looks at the live update repository; Any installed data sources for which there are updates will be visually flagged with the phrase “Update Available”. The Cool part is that you may install available data source file updates with a single click of a mouse button. (They come directly from the development repository.) In the event the new data source version does not perform for you, you may “roll back” to the immediately preceding version with a single mouse click on the “rollback” icon.

New Data source files may be added from within the Superfecta module interface screen in the same way. As soon as they are released to the public in the live update development repository, they become available for download via this Superfecta “live update” function.

To look for new sources, one simply enables the “Check for Source File updates online” box. A drop down list of all available data source files is presented to you underneath your installed sources – any one of which can be installed to your PBX with a single Mouse click. (These also come directly from the development repository.)

It is our hope and belief that this “live update” capability will give us the fastest, and most organized way to manage and rapidly distribute the new and updated versions of source data files.

The idea for the live update capability was actually mine (First one I’ve had all by myself in a while! J ) – and after some discussion, it was made real by our Lead Developer Jeremy Jacobs. (Forgive me for admitting this is one of my most favorite aspects of the new functionality! Its just so easy and effective!)

• Expanded Debug function
The debug function is built into the Web user interface. By entering the target telephone number into the debug field and pressing the debug button on the form -- you are provided with the results, and latency for each enabled data source. The debug function greatly enhances and speeds up troubleshooting.

The debug function a great tool to help you fine tune your provider selection and sort order. Providers who can’t be reached, or who perform too slowly can be turned off.

(See part 3 for continuance)

[tshif]

(Continuance from part 2)

In version 2.2.0, the debug function was limited to testing a single CID scheme at a time. What’s New in 2.2.1 is that debug can now also be applied to all schemes at once. Simply turn on the check mark box labeled Test all CID schemes – and the debug function will display data for the entire inbound call process – using all defined schemes. This feature lets you test your logic for fall through from one scheme to the other.

The debug function is also used in conjunction with the data source live update ability. Pressing debug after enabling Check for Source File updates online, exposes both the list of available (and not presently installed) data source scripts, and the “update available” flags for any installed and enabled data sources for which there is a newer version available. From there, you may update or install new data sources directly from the development repository.

Caller ID Superfecta: THE MODULE – Version 2.2.1 Installation and Use

If there was any doubt weather or not Caller ID was important to folks, consider this. In this forum alone, the two principle Superfecta threads alone have more than 33,600 reads. The Caller ID Superfecta has proven to be the most often downloaded module, and the most actively maintained in the Development support site – and for good reasons.

Everyone expects caller ID services with their telephone service. And WE ALL KNOW there’s only a few choices for getting it. We can pay our TSP’s for it – if available, we can pay an outside source for it, or we can use something like The Caller ID Superfecta for it.

In the beginning, Ward Mundy developed the Caller ID Trifecta, and released it into the wild. As a testimony to open software – his original creation went on to be maintained and updated by the members of the development support site.. Renamed by Ward in one of it’s previous upgrades to “Caller ID Superfecta”, and in line with his original vision, it had been extended to include more sources of information than ever before.

Then, I released Superfecta: THE MODULE to take advantage of the FreePBX module format for ease of install and upgrade – to make Ward’s brilliant idea (the Superfecta script) more readily usable by a larger number of users. But – as we know, nothing is as consistent as change – and change is exactly what several of the data providers regularly undergo. This of course requires updates to the Superfecta code to keep everything working.

Open Software Should Be Open
I have said this before – but it bears saying again. Every aspect of “Caller ID Superfecta: THE MODULE“code is available for inspection, and customization. No part of it is compiled, or obfuscated in any way, and it never will be.

It’s a rare and beautiful thing to see folks freely contributing to a coding project. But have a look around here at the PBXIAF forums and you see just that. In fact, you see a LOT of it. Every single bit of work done on the module has been accomplished – on a completely volunteer basis. It may not be unique – buts its rare enough, and worthy of all our support.

Toward that end, a Development Support Site and SVN has been provided to host the Superfecta (and several other Open Source PBX projects’) development effort and provide a place for the distributed community development effort to thrive. (http://projects.colsolgrp.net) This new release of Caller ID Superfecta: THE MODULE is just one of the several exciting pieces of software to be released through the Dev support site.

If you have ever considered contributing to an open source project – consider dropping by the development site and “kicking the tires” on a project or two. You may be surprised by how easy it is to contribute.

Additional Documentation Available
User and technical documentation is available that discusses the inner workings of the new version of the Caller ID Superfecta are generally located here: (http://projects.colsolgrp.net/projec...ecta/documents) . As in many projects, documentation is often a little behind development. If you like to write this kind of docs, drop by the dev site and consider contributing.

Superfecta Compatibilities
Here is the total compatibility picture for Caller ID Superfecta module version 2.0 and higher.

Distributions:
This 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
Elastix *

The Module’s wiki Page is here.
The Module’s Development Support Site is here.

*Special Installation Steps for Elastix users
You just need to add the following line to allow Superfecta access in /etc/httpd/conf.d/elastix.conf (Provided by Superfecta participating developer patrick_elx)
<Directory "/var/www/html">
# Redirect administration interface to https
RewriteEngine on
RewriteCond %{HTTPS} off
RewriteCond %{REQUEST_URI} !(/admin/modules/superfecta/*)
RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI}
</Directory>
These conditions need to be BEFORE the RewriteRule, not after!

then execute a httpd -k restart

If you have an older version of Elastix or one that was updated from an older version, check also in the /etc/httpd/conf/httpd.conf if there are some rewrite condition also that need to be modified/removed.

Asterisk Version Compatibility
This module has been tested and found to work correctly with Asterisk versions 1.4 and 1.6.


(See part 4 for continuance)

[tshif]

(Continued from part 3)
Install and Upgrade
This module is a direct upgrade of the previous Caller ID Superfecta module. It can co-reside with the non-module version of Superfecta, or any other Caller ID solution, without difficulty. It will take less than 1 minute to complete the install.


Upgrading from versions prior to 2.2.0 pretty much wipes out your previous settings, so make notes of how you had things setup before proceeding.

NOTE: After upgrading the Module from 2.2.0 to version 2.2.1, - your previously selected and configured data sources will seem to have "disappeared". Not to worry - using the live update function, simply re-add your previosu data sources. All configuration items for them will reappear. You may have to resort their positions on the list at this time.

The newest versions of the data sources take best advantage of the new capabilities in the module. The answer to any troubleshooting issue you may have will allways start with the words "upgrade to the newest version of the data source script".

If you are upgrading from a version of the module that did not have CID schemes, your previous settings are not retained.


Installation of the module is covered in steps 1 and 2 below. It will take LESS than 1 minute to complete.
Configuration and use of the module is covered in steps 3 and 4, and will take LONGER than one minute.


Installation:
Step 1: Download the module to your desktop From here.
(You'll want to select the Version 2.2.1 release.)
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-2.2.X.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.

Configuration:
(The rest of this article is dedicated to covering step 3 in detail. Don’t worry. Its EASY.)
Step 3: Use a web browser to access FreePBX on your PBX. Under Setup, Select CID Superfecta. You will be presented with configuration screen. Establish settings that make sense for your PBX, and Save your changes.

Step 4: The module installer has created the entry for Caller ID Superfecta in the FreePBX Caller ID Lookup Sources. The ID and Password Fields for the Caller ID Superfecta entry in the FreePBX Caller ID Lookup Sources area will be filled in by controls on the CallerID Superfecta Module Web ui.

Use a web browser to access FreePBX on your PBX. Under Inbound Routes, for each inbound route that you wish to use The Superfecta for Caller ID, select “CallerID Superfecta” as the CID Source.

Now, how about those more detailed configuration details? OK -

The Caller ID Superfecta User Interface



Selecting and Configuring Data Source Services
As you know, the current version of FreePBX can only assign ONE CallerID lookup source per inbound route. CallerID Superfecta gets around this limitation quite nicely by allowing you to configure from a large selection of different sources, to be used in any combination you see fit.

When installed for the first time, the Superfecta loads and makes ready for use a very limited set of data sources. As in previous releases of Superfecta, the administrator may enable and disable data sources at will – what’s new is that data sources may be completely removed, and or added to the interface now as well. When removed, a data source is not displayed on the list any more – keeping the items on the list relevant.

Data Source Management
When Superfecta had only a few data sources, it wasn’t to hard to figure out what they all were. With 25 data sources and still growing, its getting a little harder to remember what they all are. Hover the mouse over the data source name to get more information about the data source – such as what region the data source is designed for.

The ENABLED and DISABLED radio buttons, allow the selection of those services you wish to use for your Caller ID.

All data sources which have been in enabled in Superfecta are polled in the order they are displayed in the Superfecta Interface. When operating in the normal non-debug mode, Superfecta tries each source in order, stopping and returning to the PBX the result provided only by the first Data source to respond positively. (In the debug mode, all data sources are polled to assist in troubleshooting and fine tuning you data source selection and arrangement.)

Data sources are ordered by the blue up and down arrow icons next to each data source name. Click on a data sources up-ward pointing blue arrow to move it up in priority, click the down-ward pointing blue arrow icon to lower it in priority.

The Red X icon deletes the related data source from the pbx, removing it from the list.

Data Source Configuration
Some data sources require additional configuration items to be provided to Superfecta before they will work. For example, the data source Superfecta Cache likes to have its cache period configured, and the Who Called. data source requires a login and password be sent with the query.

If a data source needs additional configuration, the data source name has the “==>>” symbol displayed to its right. These items can be displayed and configured by clicking on the name of the data source in the list. If a data source has NO special configuration items, then clicking on its name will have no effect, and the “==>>” symbol will not be present.

New in 2.2.1, data sources that require extra parameters before working correctly now have reasonable default values applied during installation, rather than being left blank.

Checking for Data Source Updates
Placing a check mark in the “Check for Data Source File updates online” box, and clicking on any link within the Data Source section of the user interface, or on the debug button, the system:

• Displays a link which says “Update Available” to the right of any data source for which there is a newer version available.

To perform the update for a data source, click the link. Superfecta will download and install to the module the new version of the data source file.

Data sources which have been updated in this manner will display the Roll Back Icon (a light blue arrow) to the left of the data source name. Clicking on the roll-back icon will cause Superfecta to roll back to the previous version of the data source file. (The roll-back copies are locally cached on your PBX. Only the most recent previous version is available in this way. You can not roll back multiple generations.)

• Displays a drop down list box containing a list of all the available (but not currently installed) data sources.

You may install any listed data source by selecting it in the drop down box, and clicking the upward pointing arrow to the left of the box.

Data sources which have been added in this way appear on the list of installed data sources, and may be enabled, disabled, configured and sorted normally.

Installed data sources that have no source file equivalent on the Superfecta live update repository will have the phrase unsupported module displayed to the right of the data source name. In this case, unsupported means that it is unsupported by the live update feature.

(See part 5 for continuance)

[tshif]

(Continued from part 4)

Caller ID Schemes
Although we have been working toward better international telephone number format support for a while now – Superfecta and most of its data sources remained stubbornly 10/11 digit CID centric until the advent of Caller ID Schemes.

Caller ID Schemes bring great flexibility in fine tuning the Caller ID process used for inbound calls, based on their DID number or Caller ID format, and form the basis for Superfecta’s ability to deal with international / worldwide caller id and telephone number formats.

In Previous versions of the caller ID Superfecta, a PBX with two inbound service providers, one delivering caller ID in 10 digit format, and one delivering caller ID and 11 digit format-caused some real pain (and probably some “by hand” editing) for the system administrator.

PBX’s that had to deal with the likelihood of receiving calls from international numbers of varying format simply had to accept failure in the CID process for some of this unhandled caller ID formats.

That’s has all changed in version 2.2.1.

As we have always had in FreePBX for inbound call routing and trunk selection, Caller ID Superfecta now supports fields to specify both the DID, and the CID rules to be used for each schema. Both of these fields support most of the traditional pattern matching capabilities.

Each CID Scheme gets it own dedicated DID and CID rules. Using the DID number and CID rules configuration fields allows you to direct inbound calls to a Superfecta CID schema whose data sources, search order, and other options have been optimized for calls matching specific criteria in CID and DID.

Many data lookup sources require the number be presented in a very specific number of digits. The CID rules can be used to remove excess data (such as country codes) and greatly increase the effectiveness of the Superfecta Module.

This capability is also integral to the Caller ID Superfecta's ability to support caller ID lookup and telephone Spam Lookup functions for not only the United States, but literally anywhere in the world for which data sources can be found.

This approach to dealing with multiple formats of caller ID as a "caller ID context" originated right here in the forums, with user patrick_elx, and was made real by Jeremy Jacobs. Thanks for that extremely good idea Patrick! (Patrick has since joined the Superfecta development team. Among other tasks, Patrick has introduced several user contributed scripts to the project, and also handles correcting the vast majority of bug reports which get filed. )

Using the Caller ID Schemes Controls
Managing Caller ID schemes works very much like other FreePBX functions.

Clicking on Add Caller ID Scheme presents you with a blank box for Scheme Name, DID Number and CID Rules. Provide a name, and any rules you wish – and click Save and Agree. Your new CID Scheme is ready for configuration.

Caller ID Schemes may be sorted by using the blue up and down arrows to change each Scheme’s position on the list. Inbound calls are passed through the various caller ID Schemes in the order the schemes are sorted.

To delete a Scheme, click the red “X”. To copy a Scheme, click the icon with two sheets of paper on it. Deleted schemes are removed from the list, and deleted from the system.

Schemes may also be enabled and disabled, without effecting their position on the list or their configuration, by clicking the black enable/disable toggle icon. Disabled sources change color to light red on the list. When a source is DISABLED, it will not be used during the Caller ID process. Use this enable/disable function when you want to temporarily stop using a scheme – but not remove it from the system.

Using the Caller ID Scheme DID and CID Configuration Items
Each CID Scheme may have configured for it DID and CID rules / pattern matching. These functions are used to control what calls are accepted and processed by the scheme, and also to manipulate the CID itself.

Note: If your CID information is presented by your carrier in 10 digit format, and you have no need to assign data sources based on CID or DID, - then no CID or DID rules are required. You may run Superfecta exactly as you did before these rules were available - in other words, ignore them. Superfecta already strips out and leading "+" sign which some voip providers prepend to their CID numbers.

Using the DID number and CID rules configuration fields allows you to direct inbound calls to a Superfecta Schema whose data sources, search order, and other options have been optimized for calls matching specific criteria in CID and DID.

DID Number allows you to specify a number, or partial number, or even more complex pattern matching to compare against the DID number. In this way, you could created Schemes which are used only for specific DID numbers, or groups of DID numbers which match specified patterns.

CID Rules: Incoming calls whose CID matches the patterns specified here will use this CID Scheme. If this is left blank, this scheme will be used for any/all CID.

It can be used to add or remove prefixes. Many sources require a specific number of digits in the phone number. It is recommended that you use the patterns to remove excess country code data from incoming CID to increase the effectiveness of this module.

Note that a pattern without a + or | (to add or remove a prefix) will not make any changes but will create a match. Only the first matched pattern will be executed and the remaining rules will not be acted on.

Rules:
X matches any digit from 0-9
Zmatches any digit from 1-9
N matches any digit from 2-9
[1237-9] matches any digit or letter in the brackets (in this example, 1,2,3,7,8,9)
. wildcard, matches one or more characters (not allowed before a | or +)
| removes a dialing prefix from the number (for example, 613|NXXXXXX would match when some one dialed "6135551234" but would only pass "5551234" to the trunk)
+ adds a dialing prefix from the number (for example, 1613+NXXXXXX would match when some one dialed "5551234" and would pass "16135551234" to the trunk)

You can also use both + and |, for example: 01+0|1ZXXXXXXXXX would match "016065551234" and dial it as "0116065551234”
Note that the order does not matter, eg. 0|01+1ZXXXXXXXXX does the same thing.

General Options
The ID and password in General Options is required when your PBX runs on Apache Security (Such as PBXIAF 1.1-1.3/4, and Generally TrixboxCE). This will usually be your MAINT/maintpassword combination.

If you run a distribution or configuration that uses the FreePBX ACL (credentials) method instead of Apache security, these two fields may be left blank. (PBXIAF 1.0 in ACL mode, Foncordiax, Fonica PABX distributions, Etc.)

Lookup Timeout allows you to define how long Superfecta waits on a result from its individual data sources before giving up and moving on. Expressed in seconds.

(See part 6 for continuance)

[tshif]

(Continued from part 5)

Spam Text allows you to define the SPAM flag text that will be pre pended to the CID data when a caller is judged to be SPAM by the installed data sources. Only data sources designed to be used as a spam scoring service, such as PhoneSpamFilter and PhoneSpamFilter_UK uses this value.

CID Prefix URL allows the caller ID Superfecta to trigger an additional outside process when the caller ID function is run. For example, this feature might be used in a call center to allow the system to automatically bring up a customer ID number for the customer service representatives' use. The syntax looks like this example:
http://special.someonescallcenter.or...?phone_number=[thenumber]

In this example, the Superfecta would send this URL as it begins the lookup process, and the pre-pend the results to the caller id data. (This function is provided for advanced users with advanced needs.)

Debug Functions
The Debug functions are now built into the application. The debug feature has lots of uses, and it’s easier to use than ever. The debug system takes the number you enter, and runs it through all the sources you have selected. It displays the results for each source, as well as the time it took to get the result. Using this information, you can now make more informed choices about which sources you want to use, and in what order you want to use them.

What’s New in 2.2.1 is that debug can now also be applied to all schemes at once. Simply turn on the check mark box labeled Test all CID schemes – and the debug function will display data for the entire inbound call process – using all defined schemes.

The last bit of info in the debug window shows you which data source would have been used, and how long it would have taken to do so.

Find out which sources give the best data for your use, which sources are fastest and slowest, and use this information to determine exactly which service you want to use, and in what order. The debug function greatly enhances and speeds up troubleshooting.

Use it to help you fine tune your provider selection and sort order. Providers who can’t be reached, or who perform too slowly can be turned off.

The debug function is also used in conjunction with the data source live update ability. Pressing debug after enabling Check for Source File updates online, exposes both the list of available (and not presently installed) data source scripts, and the “update available” flags for any installed and enabled data sources for which there is a newer version available. From there, you may update or install new data sources directly from the development repository.

User / Administrator Documentation
When the caller ID Superfecta: THE MODULE was first released, the functions were so basic, and the user interface so straightforward -- little user documentation was ever really required.

Because version 2.2.1 supports multiple caller ID schemes, and support for worldwide caller ID formatting schemes, the presense and use of certain capabilities may not be as immediately recognizable and obvious.

In order to help you understand how to get the most out of caller ID Superfecta version 2.2.1, we're doing our best to produce end-user documentation at the development support site. Look at the link here to see what exists today. Don't hesitate to contribute to the documentation effort if you have suggestions or recommendations about how others users may get the most out of caller ID Superfecta. http://projects.colsolgrp.net/projec...ecta/documents

Credits:
The original CallerID Superfecta was written originally by our fearless forum leader Ward Mundy, as the Caller ID Trifecta. (Nerd Vittles Original Article (1/17/2007) http://nerdvittles.com/index.php?p=164

Since that time, It has evolved to a FreePBX module format, and to support more sources. The code is now maintained by the community of forum users at PBX In a Flash and the CSG Software Project Management site. The Superfecta was converted to FreePBX Module format by Tony Shiffer.

During its evolution, the Superfecta has benefitted greatly from many people’s contributions – especially in the area of data sources. Since before it was a module, the PBXIAF community has had along tradition of rolling up their sleeves and pitching in to keep the Superfecta running right in the face of unpredictable changes by data suppliers.

The principle and lead developer of Caller ID Superfecta: THE MODULE v 2.0.x - 2.2.X is Jeremy Jacobs. Our principle maintenance developer, bug squasher, and all around fixer-upper is Participating Developer patrick_elx. The Caller ID Superfecta dev project administrator is Tony Shiffer.

Why is this software Free? Why don’t I have to pay for it?
Developing good software is hard work and takes a lot of time.
Doing it for free, when you already have a full-time job, as well as a "real life" is a gift of precious value to all of us who use the software every day.

To all the participants like Patrick_elx, zorka, Nixi, Bitnetix, Chris Bailes, and so many more who stayed up nights and weekends to help us get this project to the state its in now; To everyone who pitched in and created a trouble ticket, or fixed one, everyone who suggested a important feature – and a way to get the job done, and all the folks who helped us understand how to design it right – Thank You!

A labor of …. Something!?!
From “idea men” like Ward and Joe who dream the dreams and seed our imaginations, to good folks like HAT, klingon888, dad311, TheDeacon, TDF and others who write up error reports and give us encouragement in the middle of the night when things can look their darkest – work on this module has been an “orchestration of the believers”.

To top it off, that great team of folks has had the benefit of a genuine professional programmer to help make all our dreams come true. Through his dedicated participation, the “orchestration of the believers” became an actual symphony! Our lead developer, Jeremy Jacobs has brought the Superfecta Module to a level of feature and functionality that I only barely had the guts to dream and wish for a year ago.

I’m sure you will agree Jeremy deserves a lot more than only our thanks and appreciation for these great upgrades. I hope Karma rewards him richly! (Jeremy – do you have an Amazon wish list?)

Until Karma gets around to it, please join me in a round of applause and sincere thanks for forum member Jeremy Jacobs (FitnessPlus) for taking on the most recent upgrade of CallerID Superfecta: THE MODULE.

Caller ID Superfecta: THE MODULE Version 2.2.1 May Be Downloaded from the Development Support Site at This Location.

As always – let us know how this newest version works for you!
Until next time

- tshif