Simple Hotel Style Wake-Up Calls – THE MODULE
The Hotel Style Wake Up call function has proven to be of interest to many of us. Simpler than Ward’s Voice Reminders, the system emulates the wake-up calls you might get when staying at a hotel.
So far – in the previous thread about this topic – we learned several ways of manually deploying the existing scripts. From all feedback – those methods are working well for most folks. But, from the stand point of being easy to install and configure – well, some folks had issues.
When it comes right down to it – I just don’t prefer to make the PBX administrator drop into a command line or text file to make simple configuration changes. And I have always wanted to try my hand at making an actual FreePBX module……
I am pleased to release to general use today the Hotel Style Wake Up Calls Module for FreePBX. The module uses essentially the same scripts used in the manually installed version – but with some significant changes.
Ok - On with the Show.
Prerequisites – Pay Attention
For those interested in the details, the typical version of the Wake-Up scripts use variables (set in the include script) to establish various details, such as Operator Mode config, and other similar configuration settings. Also, the two scripts used different methods and locations for storing their configuration variables – leaving the installer to configure things in three separate places.
In the module version, both of the work-horse scripts have been modified to gather their configurations from the same .inc script. The .inc script itself has been modified to gather most configuration details from the database, instead of fixed values found in the scripts. To round it all out, the module has a user interface that allows the most common configuration settings to be changed (and stored in the database) – without ever opening a text editor.
Installation and Configuration – Wake-Up Calls: THE MODULE
Works exactly like installing any other third party module.
The module installer installs default values.
Operator Mode
When enabled, the operator mode allows those extensions listed as Operator Extensions to request a Wake Up Call for any telephone number, up to the length specified in the Extension length drop down box.
If you do not wish to support WakeUp calls to outside numbers, select the extension length which matches the extension length used on your PBX.
If you do plan on supporting outside telephone numbers, select 10 or 11 as the extension length – dependant upon how your PBX dialing is set up (to require a leading ‘1’ or not.)
If you enter a destination number that is less than your maximum extension length - you must end your input with the # key, or it wont process your input. (Thanks for pointing this out, HAT!)
General Conifguration
Ring Time determines how long the Wake Up Call will ring the destination number before giving up for that attempt.
Retry time is the wait period between retries.
Max Retries is the maximum number of times the system will attempt the wake up call, or snooze call back.
WakeUp Caller ID allows you to customize the Caller ID info displayed by the wake up service. By default, the phone number shows the default feature code assigned when you install the module. If you change the feature code – make sure to come here and change the caller id to reflect the new value.
Changing the Dail String (Feaure Code)
In keeping with the goal of not having to edit config files, the Wake-Up Module sets the feature code (or dial string) using the FreePBX Feature Codes Page. (In FreePBX, under Setup, Select Feature Codes).
In the WakeUp Calls section, find the Wake Up Calls item. All controls work as expected here. You may change the feature code to suit your needs, and even disable the Wake Up calls service.
Future Module Updates
The FreePBX module update process works as expected for this module. Should an update be released, simply upload it to your PBX in the same way as the original. The Module Admin will then recognize a pending upgrade, and offer you that choice. Upon Upgrade, your previously established configuration items are not disturbed.
This module is not in the FreePBX third party modules repository, and as of this writing, there is no help page for it available from the More Information link in the FreePBX Module Admin. This may be accomplished in future releases.
Roadmap to Future Module Updates
In the future, I hope to add support for authenticating outside callers, in order to restore all the functionality in the Outside the Box version previously mentioned,
Credits/Thanks
I would never have been able to start this module without Jeremy Coulter, who provided me with actual working copies of the scripts to begin with, and lots of encouragement. I have naturally left any and all credit/author lines in the original scripts that were present when I got them.
Also – my ego would have taken a lethal beating from all the failures along the way were it not for Joe Roper – who provided encouragement, advice, and shared his immense knowledge of the FreePBX environment freely along the way.
Last – certainly not least, Jerry Swordsteel in far away Sweden jumped in and spent a good 4-5 hours coding the PHP for the Module’s user interface screen, and data/string manipulation needs. Jeremy, Joe, Jerry – thanks for helping make this module possible!
As always – share your results – and let us know how the Wake Up Module works for you.
Until next time –
tshif
The Hotel Style Wake Up call function has proven to be of interest to many of us. Simpler than Ward’s Voice Reminders, the system emulates the wake-up calls you might get when staying at a hotel.
So far – in the previous thread about this topic – we learned several ways of manually deploying the existing scripts. From all feedback – those methods are working well for most folks. But, from the stand point of being easy to install and configure – well, some folks had issues.
When it comes right down to it – I just don’t prefer to make the PBX administrator drop into a command line or text file to make simple configuration changes. And I have always wanted to try my hand at making an actual FreePBX module……
I am pleased to release to general use today the Hotel Style Wake Up Calls Module for FreePBX. The module uses essentially the same scripts used in the manually installed version – but with some significant changes.
Ok - On with the Show.
Prerequisites – Pay Attention
- If you currently run any version of the Wake-Up scripts (from agi-bin), such as those discussed in this article, the module version will not co-reside. You should REMOVE the wakeup scripts from previous versions from your platform before installing the module. Failure to do so will cause unanticipated behaviors (Read: The old scripts wont work, may be replaced, and the new module won’t work either. Not good).
- If you currently run the Outside The Box Wakeup Calls – The module will do the same work, but be aware you still have to manually configure one aspect of it. (http://pbxinaflash.com/forum/showpost.php?p=20864&postcount=9)
- The Wake Up Calls Module requires PHP version 5.x, which is installed by default (we are spolied!) on PBXIAF. FreePBX however CAN RUN under PHP 4.x, so if your not running on PBXIAF, check your distro and make sure you have an appropriate version of PHP.
- This module uses the mySql database to store and read its configuration values. If you are running your pbx under a database other than MySQL, this module will fail.
- If you have changed the asterisk user password to the MySQL asterisk database, this module will fail. (It can be edited to work under these circumstances, but that is outside the scope of this article)
(New Info 4/8/2009: This is no longer the case. the current module handles this situation without problems.)
- If you have changed the asterisk user password to the MySQL asterisk database, this module will fail. (It can be edited to work under these circumstances, but that is outside the scope of this article)
For those interested in the details, the typical version of the Wake-Up scripts use variables (set in the include script) to establish various details, such as Operator Mode config, and other similar configuration settings. Also, the two scripts used different methods and locations for storing their configuration variables – leaving the installer to configure things in three separate places.
In the module version, both of the work-horse scripts have been modified to gather their configurations from the same .inc script. The .inc script itself has been modified to gather most configuration details from the database, instead of fixed values found in the scripts. To round it all out, the module has a user interface that allows the most common configuration settings to be changed (and stored in the database) – without ever opening a text editor.
Installation and Configuration – Wake-Up Calls: THE MODULE
Works exactly like installing any other third party module.
- Download the module. You can get if HERE. (In General, Select the newest build.)
- In FreePBX, Module Admin, Upload the Module to your PBX.
- In FreePBX, Module Admin, under Third Party Addon, Locate Wake Up Calls, and INSTALL.
- In FreePBX, Under tools, Third Party Addon, Select Wake Up Calls.
The module installer installs default values.
Operator Mode
When enabled, the operator mode allows those extensions listed as Operator Extensions to request a Wake Up Call for any telephone number, up to the length specified in the Extension length drop down box.
If you do not wish to support WakeUp calls to outside numbers, select the extension length which matches the extension length used on your PBX.
If you do plan on supporting outside telephone numbers, select 10 or 11 as the extension length – dependant upon how your PBX dialing is set up (to require a leading ‘1’ or not.)
If you enter a destination number that is less than your maximum extension length - you must end your input with the # key, or it wont process your input. (Thanks for pointing this out, HAT!)
General Conifguration
Ring Time determines how long the Wake Up Call will ring the destination number before giving up for that attempt.
Retry time is the wait period between retries.
Max Retries is the maximum number of times the system will attempt the wake up call, or snooze call back.
WakeUp Caller ID allows you to customize the Caller ID info displayed by the wake up service. By default, the phone number shows the default feature code assigned when you install the module. If you change the feature code – make sure to come here and change the caller id to reflect the new value.
Changing the Dail String (Feaure Code)
In keeping with the goal of not having to edit config files, the Wake-Up Module sets the feature code (or dial string) using the FreePBX Feature Codes Page. (In FreePBX, under Setup, Select Feature Codes).
In the WakeUp Calls section, find the Wake Up Calls item. All controls work as expected here. You may change the feature code to suit your needs, and even disable the Wake Up calls service.
Future Module Updates
The FreePBX module update process works as expected for this module. Should an update be released, simply upload it to your PBX in the same way as the original. The Module Admin will then recognize a pending upgrade, and offer you that choice. Upon Upgrade, your previously established configuration items are not disturbed.
This module is not in the FreePBX third party modules repository, and as of this writing, there is no help page for it available from the More Information link in the FreePBX Module Admin. This may be accomplished in future releases.
Roadmap to Future Module Updates
In the future, I hope to add support for authenticating outside callers, in order to restore all the functionality in the Outside the Box version previously mentioned,
Credits/Thanks
I would never have been able to start this module without Jeremy Coulter, who provided me with actual working copies of the scripts to begin with, and lots of encouragement. I have naturally left any and all credit/author lines in the original scripts that were present when I got them.
Also – my ego would have taken a lethal beating from all the failures along the way were it not for Joe Roper – who provided encouragement, advice, and shared his immense knowledge of the FreePBX environment freely along the way.
Last – certainly not least, Jerry Swordsteel in far away Sweden jumped in and spent a good 4-5 hours coding the PHP for the Module’s user interface screen, and data/string manipulation needs. Jeremy, Joe, Jerry – thanks for helping make this module possible!
As always – share your results – and let us know how the Wake Up Module works for you.
Until next time –
tshif
Last edited by a moderator: