Technical information

INSTALLATION AND ADMINISTRATION GUIDE
112
Custom notify procedures
Event notify procedures are typically Tool Command Language (Tcl) or shell scripts run by the scheduler at a
particular notification point.
All notify procedures must be located in the $VSIFAX/lib/enp directory. This directory is the only place the fax
server looks for notify procedures. In addition to any site, user, or device notify procedures you place there, this
directory also contains the system LNP, TNP, GNP, and RNP scripts (lnp-system, tnp-system, gnp-
system,and rnp-system).
Important
Esker strongly recommends that you do not modify the system LNP, TNP, GNP, and RNP scripts (lnp-system,
tnp-system, gnp-system,and rnp-system). Improper modifications can cause unpredictable system
behavior. Furthermore, any modifications to these scripts will be lost the next time you upgrade your VSI-FAX
system.
Notify procedures are named as follows:
<type>-<name>.<ext>
Where <type> is lnp, tnp, gnp, rnp, or sys ; <name> is a short descriptive name for the notify procedure
and <ext> is tcl, sh or other file extension associated with a command interpreter in the notify.lst file.
The following rules apply to <ext> in the naming convention:
If there is no extension, it is assumed to be a simple executable.
If the extension is .sh, the script is run using the shell interpreter.
If the extension is .tcl, the script is run using the Tcl interpreter.
Note
VSI-FAX installs a Tcl interpreter with all fax server installations. Therefore, Tcl scripts will run on all supported
platforms (Unix, Linux and Windows). However, shell scripts normally only run on Unix and Linux. If you want to
run shell scripts on Windows, you must install a third-party shell interpreter, such as MKS Toolkit.
If the extension is anything else, the fax server looks in the $VSIFAX/lib/notify.lst file for information
about how to process this file.
For example, in order for the fax server to run tnp-site.zz, there must be a line in notify.lst like:
"zz; /<interpreter>/zz"
Where zz is an alias in the notify.lst file that points to the full path and file name of the command
<interpreter> you want to use for that file extension.
Associating a device rnp script with a fax destination
To associate a device rnp script with a fax destination, enter the following:
vfxadmin device -u -P <partofscriptname> <faxdestination>
If the name of the script is rnp-hello.tcl and the fax destination name is fax1, you can use the following
command to associate the script with the fax1 destination:
vfxadmin device -u -P hello fax1
Editing notify.lst to run batch files
Add the following entry to notify.lst to configure VSI-FAX to run batch files:
bat;cmd.exe
Launch notify procedures (LNPs)
Site or user LNPs can be used to archive faxes, transmit accounting codes, or for fax request control.