SURVIVOR: About Transmit Modules
What Transmit Modules Do Module Types Module Data Adding Custom Modules
What Transmit Modules Do
Transmit Modules are used as part of the alert transmission mechanism. Data relevant for an alert is assembled and then passed to a Format Module, which converts it according to what the Module does (eg: making it suitable for a pager, or incorporating a help file). The resulting formatted alert data is then passed to a Transmit Module, which is responsible for the actual data transmission.
Module Types
Like Check Modules, Transmit Modules may be either compiled or scripted, but unlike Check Modules, Transmit Modules only run on the scheduler host.
Module Data
Transmit Modules take as input on stdin an XML document containing a `SurvivorFormattedAlertData` element, as described in the Survivor DTD. The module simply exits with an appropriate return code to indicate success or failure.
Adding Custom Modules
All Transmit Modules must conform to the Transmit Module Specification, otherwise they may not interact correctly with the scheduler. Routines useful for building Transmit Modules in Perl are provided in `Survivor.pm` and `Survivor::Transmit.pm`. As a starting point, see the sample test module in `src/modules/transmit/test`. For information on these modules, run
         % perldoc src/modules/common/Survivor.pm
         % perldoc src/modules/common/Survivor/Transmit.pm
Other languages may be used, but no routines are provided with this package. For assistance in testing Transmit Modules, the XML Maker utility may be useful. Important: Please see the license for this package to see if custom modules are subject to the same license. $Date: 2006/11/19 22:37:03 $ $Revision: 0.5 $ | keywords