Commercial Module

This wiki is for faxing with the commercial Fax Pro. If you are looking for the standard (non-commercial) fax options, please visit the Fax Configuration wiki.

Overview 

What does this module do?

Fax Pro is a commercial add-on that enhances the built-in fax capabilities of your PBX. With the commercial Fax Pro module, users can send and receive faxes in the User Control Panel (UCP) as well as receive faxes at an e-mail address. You can manage your cover page settings such as company name, address, etc. for the whole company.

Without Fax Pro, only inbound fax-to-email. Fax Pro offers a full inbound and outbound faxing solution.

Where is the Fax Pro module?

Please note, there is no standalone item called "Fax Pro" in the PBX GUI menus.

Fax Pro enables additional settings in the existing Fax Configuration and User Management modules. You'll use those modules, in addition to Inbound Routes and the User Control Panel (UCP), to manage faxing. This wiki describes how to set fax settings in all of these areas.

To see whether you have Fax Pro installed and enabled, visit Admin → Module Admin and look for "Fax Configuration Professional." The basic (non-commercial) version is called "Fax Configuration."


Global Fax Settings

Global Fax Settings are set in the Fax Configuration module. If you do not see all the options shown below, double-check to ensure you have Fax Configuration Professional installed and enabled.

To navigate to the Fax Configuration module in the PBX GUI:

Here, you can set some global options including global cover sheet data.

Fax Presentation Settings

Default Fax header

Header information that is passed to remote side of the fax transmission and is printed on top of every page. This usually contains the name of the person or entity sending the fax.

Default Local Station Identifier

The outgoing Fax Machine Identifier. This is usually your fax number.

Outgoing Email address

This is the email address all outbound faxes appear to be coming from when they are sent to the recipient.

Email address

Email address that faxes are sent to when using the "Dial System Fax" feature code. This is also the default email for fax detection in legacy mode (if there are routes still running in this mode that do not have email addresses specified).

Error Correction Mode

Yes/No: Whether to enable Error Correction Mode (ECM). Many new fax machines are capable of resending data that was corrupt. If set to “yes,” we will attempt to negotiate error correction mode (ECM) with the other fax machine.

Maximum transfer rate

Maximum transfer rate used during fax rate negotiation. We recommend 14400.

Minimum transfer rate

Minimum transfer rate used during fax rate negotiation. We recommend 9600.

Default Paper Size

Letter/A4: Select the default paper size. This specifies the size that should be used if the document does not specify a size.

Fax Cover Page Options

Here you can set all the company information you want to be displayed on your fax cover page when sending outbound faxes from the user control panel. You can click the preview button to preview what the cover sheet will look like.

Company Logo

Click the Browse button to upload an image to be used as the company logo on the cover sheet. Note: file type MUST be JPG.

Company Name, Address, Phone, & Web Site

The company contact information that will be displayed on the cover sheet. Address can be entered using 1 to 3 lines.

Company Footer

Text that will appear at the bottom of every page.

Preview Coverpage 

Click the Preview button to download a PDF preview of the cover sheet.

User Control Panel Faxing Options

Global Prefix

A number to prefix to the outbound fax number. Used to route a fax to a certain outbound route.

Failure Recovery Options

Retries

The maximum number of times the system will retry sending a fax upon a failure.

Failure Notification Options

Email Results

Never/Always/Success/Failure: When to e-mail the results of an outgoing fax.

Local Storage Options

Max Pages

The maximum number of total pages each user is allowed to store locally. This also affects the maximum page number for a single fax.

Excess Faxes

Reject/Delete Oldest: How the system should respond when a new fax arrives for a user whose storage quota is full. Note: With either option, a single fax that is larger than max pages set above will be deleted after it is received.

Channel Control Option

FreePBX 14+ (v14.0.1.10) onward, we have added option to add multiple fax recipients to send a fax using UCP. 

following "Channel Control option" configuration option present under Settings→Fax Configuration and will be visible only if "Faxpro" commercial module is installed and licensed.




Depends on above "Concurrent Fax" configuration value, UCP will show the option to send the fax to multiple recipients.

for example, We have "Concurrent Fax" option configured as "1" so below UCP snapshot is showing "Max concurrent channels" is 1.



User Fax Settings

This wiki focuses on fax settings and assumes you already know how to set up users and give them access to the User Control Panel (UCP). If you need more information on this, please visit the User Management module user guide.

In FreePBX 13+, a fax recipient's settings are found in the User Management Module instead of the Extensions module. Faxing is now linked to a user, not directly to an extension. This means you can now have "standalone" fax users who aren't associated with an extension, if desired.

After you've enabled fax for a user, you'll be able to select that fax recipient as a destination in other modules.

 

Navigate to the User Management module:

If you are not already viewing a user, click the edit button  for the user.

Click the Fax tab.

When you first arrive, fax settings will be grayed-out.


Next to Enabled on the first line, click the Yes button to enable faxing and edit the information below.

Enabled

Yes/No/Inherit: Whether to enable fax for this user.

Attachment Format

PDF/TIFF/Both: Format(s) to convert incoming fax files to before e-mailing them to a recipient.

Store Locally

Yes/No/Inherit: Whether to store this user's inbound faxes on the server after the faxes have been e-mailed to the user. If Yes, a user will be able to access the fax in the User Control Panel.

Outgoing Station ID

The outgoing Fax Machine Identifier. This is usually your fax number.

Outgoing Header

The outgoing Fax Machine Header. This usually contains the name of the person or entity sending the fax.

Coversheet name

The name that should appear on the outbound coversheet.

Coversheet Tel

The phone number that will appear on the coversheet.

Coversheet Email

The email address that will appear on the coversheet.

Email Results

Use Global Setting/Never/Always/On Success/On Failure: When to e-mail the results of an outgoing fax. The global setting is set in the Fax Configuration module. You can override it on a per-user basis here.

Retries

Use Global Setting/0/1/2/3: Number of times to retry sending a fax upon failure. The global setting is set in the Fax Configuration module. You can override it on a per-user basis here.

Save

After making your changes, Click the Submit button, then click the Apply Config button.


 

Inbound Route Fax Settings

This wiki focuses on fax settings and assumes you already know how to set up inbound routes. For details on inbound route settings not covered here, visit the Inbound Routes module user guide.

Navigate to the Inbound Routes module:

Select an inbound route by clicking the edit button, or create a new inbound route.

Click on the Fax tab.

Detect Faxes

No/Yes: Whether to attempt to detect faxes on this DID. Note: Fax detection is not always totally accurate. It will also cause inbound calls to take longer to ring through, since the system attempts to detect a fax tone before routing the call.

If Detect Faxes: Yes, you will see the additional options below.


Fax Detection type

(Only if Detect Faxes:Yes) - Type of fax detection to use. If the call is coming from a SIP trunk, select  SIP. If the call is coming in on a Analog or PRI line, select DAHDI.

Fax Detection Time

(Only if Detect Faxes:Yes) - How long, in seconds, to wait and try to detect fax. If no fax is detected within this time, the call will be routed to the regular destination set in the General tab. Please note that callers to a Dahdi channel will hear ringing for this amount of time (i.e. the system won't "answer" the call, it will just play ringing).

Fax Destination

(Only if Detect Faxes:Yes) - Where to send the fax if it's detected within the time set above. If sending to a user, choose Fax Recipient: (user name) in the menus. Set up users in the User Management Module as described earlier.

Save

When finished making changes, click the Submit button, then click the Apply Config button.

 


Note: The information below is available as a standalone page at Fax - UCP.