Custom Application Sample

The example of the custom routing application (RouteCustom.exe) can be found in the Fax Voip FSP installation folder, usually C:\Program Files (x86)\FaxVoip FSP\RouteCustom.exe.

The source codes (RouteCustom.zip archive) can be found in the Fax Voip FSP data folder, usually C:\ProgramData\FaxVoip FSP\Samples\RouteCustom.zip. To unpack the archive, right click it and then select Extract All... from the context menu.

The code example is a console application written in Visual Basic .Net and can be compiled using Microsoft Visual Studio 2013 or later versions.

This sample demonstrates the use of a custom routing method for incoming faxes, taking into account the requirements for writing such application, see also in the Custom Application Requirements (Developer's Guide) chapter of this user manual.

• The application parses the predefined command line and populates the internal structure where it stores path to the temporary TIFF file and other routing info parameters, such as CallerID, Called Number (DID), TSID, CSID etc.
• Writes the routing info into standard ini file.
• Copies the temporary TIFF file to the specified folder with an unique name that contains the date and time the fax was received.
• Before the application finishes, it deletes the temporary folder and the temporary TIFF file placed in this folder.
• The application provides automatic completion after performing all necessary actions.
• The application uses folders and files for which Network Service account definitely has write access.

To use the sample

1.     Copy the RouteCustom.exe file into the Fax Voip FSP installation folder. You can use a different folder, but make sure that the Network Service account has access to your folder.

2.     Open Fax Voip FSP Control Panel. Click Incoming Methods in TreeView, then click Custom.

3.     On the Custom routing for incoming faxes page, select the Enable custom routing check box.

4.     In the Custom application that should be started after receiving a fax field, enter the path to RouteCustom.exe file or select it using the small button placed to the right of the field.

5.     Select the Create temporary copy of the received fax (TIFF file) check box.

6.     Click <Apply> button to save changes.

After receiving a fax,

1.     Open the Fax Voip FSP data folder in Windows Explorer, usually C:\ProgramData\FaxVoip FSP\.

2.     Check the RouteCustom subfolder for RouteCustom.ini file.

3.     Check the RouteCustom\Incoming Faxes subfolder for copy of the received fax.

4.     The RouteCustom.txt log file is stored in the log subfolder.