Difference between revisions of "Fax2Email"

From Kolmisoft Wiki
Jump to navigationJump to search
 
(20 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This feature let's user receive normal fax and get it to email in PDF format. The following image shows common implementation of Fax2Email functionality:
= Definition =
 
This feature allows the user to receive a normal fax and get it to email in PDF format. The following image shows the common implementation of the Fax2Email functionality:


[[Image:fax2mail_schema.png]]
[[Image:fax2mail_schema.png]]




<big>'''NOTE: [[Fax over VoIP]] does not work reliably and should only be used for testing purposes only.'''</big>
<big>'''NOTE: [[Fax over VoIP]] does not work reliably and should only be used for testing purposes.'''</big>
 
 
= Setup =


In order to start using this feature, '''Fax device enabled''' should be checked in '''SETTINGS -> Setup -> Settings –> Functionality'''.


In order to start using this feature it should be enabled in Settings – Various – Fax2Email enabled.
When it's enabled, you need to create a device and make it FAX type. This can be done in Device Settings:


When it's enabled you need to create some device and make it FAX type. It can be done in device settings:
[[File:Devices fax.png]]


[[Image:fax2email1.png]]


When a device's type is FAX, it is marked as a FAX device everywhere with the icon [[Image:icon_fax.png]].


When device's type is FAX it is marked as FAX device everywhere with icon [[Image:icon_fax.png]]
Since MOR12 there is an option to choose a server for a fax device.


Then you need to add emails to which received fax should be sent. You can enter unlimited emails here.
Then you need to add the email address or addresses to which the received fax should be sent. You can enter unlimited addresses.




When fax device is created you have two possibilities to use it:
When the fax device has been created, you have two possibilities for using it:


# It is possible to route call directly to fax device
# It is possible to route a call directly to the fax device.
# You can use fax-detection, so when fax is detected – it will be routed to fax device and if it is not detected – to nornal device.
# You can use fax-detection, so that when a fax is detected, it will be routed to the fax device. If it is not detected, it is routed to a normal device.


Second choice lets you save one DID – e.g. lets receive calls and faxes on same number.
The second choice lets you save one DID by receiving calls and faxes on the same number.


First method is very easy to implement – you just need to assign FAX device to some DID:
The first method is very easy to implement – you just need to assign the FAX device to a DID:


[[Image:fax2email2.png]]
[[Image:fax2email2.png]]




When you want to do fax-detection you need to set this in some device's [[Call Flow]]. In Before Call state:
When you want to do fax-detection, you need to set this in a device's [[Call Flow]]. In the Before Call state:


[[Image:fax2email3.png]]
[[Image:fax2email3.png]]




Here when call comes system will try to decide is it fax – if so – call is routed to FAX device and sent to appropriate emails. If call is simple call – it will gets sent to IAX2/101 device.
Here, when a call comes, the system will try to decide whether it is a fax. If it decides that it is, the call is routed to the FAX device and sent to the appropriate email addresses. If the call is a simple call, it is sent to an IAX2/101 device.


For received faxes and various stats check Fax statistics in '''STATISTICS - Various - Faxes''' section:
For received faxes and various statistics, check Fax statistics in the '''STATISTICS - Various - Faxes''' section:


[[Image:fax2email4.png]]
[[Image:fax2email4.png]]


= Stats =
This report show all information about faxes received (or not received). It can be found in '''STATISTICS – Various – Faxes''':
[[Image:faxes_stats1.png]]
All users are visible here. A fax can have three states:
* '''Received''' – everything okay with this fax. It's been received and sent to the appropriate email addresses.
* '''Corrupted''' – the fax has been received but is corrupted. It cannot be to sent to an email address.
* '''Mistaken''' – this was simple call to a fax number, not a fax.
You can click on a number for each state to get a list of these faxes:
[[Image:faxes_stats2.png]]
Clicking on [[Image:icon_pdf.png]], you can get this fax in PDF format.
<br><br>
= Codecs =
Fax Devices only support '''G.711 A-law''' and '''G.711 u-law''' codecs, both are enabled and not editable, you can adjust their priority by dragging them.
<br><br>
[[Image:Fax_codecs.png‎]]
<br><br>
= Email Template =
Available from MOR X17.
Email template for Fax2Email is named: fax2email
<br><br>
= Troubleshooting =


* All converting from the received .tif format to pdf is done by KOLMISOFT writtent agi script which basically performs this command:
/usr/bin/tiff2pdf -o pdf_file, tif_file
* Sometimes new changes are brought to AGI scripts in order to improve them. So and [[Upgrade MOR GUI | update]] might also solve problems.
* Check log file: /var/log/mor/fax2email.log or /var/log/mor/fax2email.log (in newer versions) for more details
* If tif file size is 0 - that means that fax failed


<br><br>
<br><br>

Latest revision as of 07:24, 29 November 2022

Definition

This feature allows the user to receive a normal fax and get it to email in PDF format. The following image shows the common implementation of the Fax2Email functionality:

Fax2mail schema.png


NOTE: Fax over VoIP does not work reliably and should only be used for testing purposes.


Setup

In order to start using this feature, Fax device enabled should be checked in SETTINGS -> Setup -> Settings –> Functionality.

When it's enabled, you need to create a device and make it FAX type. This can be done in Device Settings:

Devices fax.png


When a device's type is FAX, it is marked as a FAX device everywhere with the icon Icon fax.png.

Since MOR12 there is an option to choose a server for a fax device.

Then you need to add the email address or addresses to which the received fax should be sent. You can enter unlimited addresses.


When the fax device has been created, you have two possibilities for using it:

  1. It is possible to route a call directly to the fax device.
  2. You can use fax-detection, so that when a fax is detected, it will be routed to the fax device. If it is not detected, it is routed to a normal device.

The second choice lets you save one DID by receiving calls and faxes on the same number.

The first method is very easy to implement – you just need to assign the FAX device to a DID:

Fax2email2.png


When you want to do fax-detection, you need to set this in a device's Call Flow. In the Before Call state:

Fax2email3.png


Here, when a call comes, the system will try to decide whether it is a fax. If it decides that it is, the call is routed to the FAX device and sent to the appropriate email addresses. If the call is a simple call, it is sent to an IAX2/101 device.

For received faxes and various statistics, check Fax statistics in the STATISTICS - Various - Faxes section:

Fax2email4.png

Stats

This report show all information about faxes received (or not received). It can be found in STATISTICS – Various – Faxes:

Faxes stats1.png


All users are visible here. A fax can have three states:

  • Received – everything okay with this fax. It's been received and sent to the appropriate email addresses.
  • Corrupted – the fax has been received but is corrupted. It cannot be to sent to an email address.
  • Mistaken – this was simple call to a fax number, not a fax.

You can click on a number for each state to get a list of these faxes:

Faxes stats2.png

Clicking on Icon pdf.png, you can get this fax in PDF format.




Codecs

Fax Devices only support G.711 A-law and G.711 u-law codecs, both are enabled and not editable, you can adjust their priority by dragging them.



Fax codecs.png



Email Template

Available from MOR X17.

Email template for Fax2Email is named: fax2email



Troubleshooting

  • All converting from the received .tif format to pdf is done by KOLMISOFT writtent agi script which basically performs this command:
/usr/bin/tiff2pdf -o pdf_file, tif_file
  • Sometimes new changes are brought to AGI scripts in order to improve them. So and update might also solve problems.
  • Check log file: /var/log/mor/fax2email.log or /var/log/mor/fax2email.log (in newer versions) for more details
  • If tif file size is 0 - that means that fax failed



See also:

Retrieved from "https://wiki.kolmisoft.com/index.php?title=Fax2Email&oldid=27990"