Transmission reports
GFI FaxMaker notifies the user about the status of sent faxes/SMS by sending a transmission report. The report contains details of the fax/SMS transmission. Optionally you can configure to include the fax content and fax body.
A sample fax transmission report
Configuring fax transmission reports
1. From GFI FaxMaker Configuration, right-click Advanced > Transmission reports and select Properties.
Fax transmission report options
2. Configure the following options:
|
Option |
Description |
|---|---|
|
Report successful outgoing FAX transmissions |
Send a transmission report when a fax is sent successfully. |
|
Include attachments with success reports |
Includes the transmitted fax with successful transmission reports. |
|
Report failed outgoing FAX transmissions |
Send a transmission report when a fax fails. |
|
Include attachments with failure reports |
Includes the fax content with failed transmission reports. |
|
Append original message body |
Include the original fax message body in the transmission report, below the report text. Using this option allows users to re-submit faxes and find sent faxes. |
| Send one summary report when faxing to multiple recipients | When sending a fax to multiple recipients, GFI FaxMaker sends the fax to each recipient individually. Select this option to group transmission reports in one summary report. When unselected, a transmission report is sent for each fax recipient. |
3. Click OK.
Configuring SMS transmission reports
1. From GFI FaxMaker Configuration, right-click Advanced > Transmission reports and select Properties.
SMS transmission report options
2. From the SMS tab, configure:
|
Option |
Description |
|---|---|
| Report successful outgoing SMS transmissions |
Send a transmission report when an SMS is sent successfully. |
| Send one summary report when sending SMS to multiple recipients | When sending an SMS to multiple recipients, GFI FaxMaker sends the SMS to each recipient individually. Select this option to group transmission reports in one summary report. When unselected, a transmission report is sent for each SMS recipient. |
NOTE
A report is always sent if transmission of SMS fails.
3. Click OK.
Customizing transmission reports
The template of transmission reports can be customized. To do this:
1. Navigate to <GFI FaxMaker installation folder>\data\reports.
2. Open the template to edit in Notepad:
|
Report template |
Description |
|---|---|
|
error.fbt |
Transmission reportAn email sent by GFI FaxMaker to internal users that contains information about sent/received faxes/SMS. for failed faxes |
|
recv.fbt |
|
|
sent.fbt |
Fax report for sent faxes |
|
smserror.fbt |
Transmission report for failed SMS |
|
smsrecv.fbt |
Fax report for received SMS |
|
smssent.fbt |
Fax report for sent SMS |
| summarysent.fbt | Summarized transmission report when a fax is sent to multiple recipients. |
| summarysent_details.fbt | The details of failed fax transmissions. This section is appended to summarysent.fbt for each failed transmission. |
3. Modify the file using the following fields. Some fields may not be applicable for certain reports.
NOTE
Reports starting with html prefix (for example, htmlrecv.fbt), are the equivalent reports in HTML format. In this case use square brackets [ and ] for fields instead of angled brackets.
|
Field |
Description |
|---|---|
|
<status> |
Transmission status |
|
<date> |
Transmission date |
|
<time> |
Transmission time |
|
<date_time> |
Shows both transmission date and time |
|
<speed> |
Transmission speed |
|
<connection_time> |
Duration of transmission |
|
<pages> |
Number of pages sent |
|
<total_pages> |
Total number of pages requested to be sent |
|
<resolution> |
The fax resolution. |
|
<remote_id> |
Recipient’s line number |
|
<local_id> |
Local line number |
|
<line> |
GFI FaxMaker line number. |
|
<retries> |
Number of retries that GFI FaxMaker tried to establish connection with recipient. |
|
<description> |
A description of the status of fax transmission. |
|
<dtmf_did> |
The DTMFDual-tone multi-frequency signalling/DID number. |
|
<subject> |
The subject of the email requesting the fax transmission. |
|
The billing code. |
|
|
<r_last_name> |
Recipient’s last name |
|
<r_first_name> |
Recipient’s first name |
|
<r_name> |
Recipient’s display name |
|
<r_company> |
Recipient’s company name |
|
<r_department> |
Recipient’s department |
|
<r_email> |
Recipient’s email address |
|
<r_fax> |
Recipient’s fax number |
|
<r_voice> |
Recipient’s phone number |
|
<s_last_name> |
Sender’s last name |
|
<s_first_name> |
Sender’s first name |
|
<s_name> |
Sender’s name |
|
<s_company> |
Sender’s company name |
|
<s_department> |
Sender’s department |
|
<s_email> |
Sender’s email address |
|
<s_fax> |
Sender’s fax number |
|
<s_voice> |
Sender’s phone number |
|
<total_faxes> |
Total number of faxes (summary reports only) |
|
<succeeded_sendings> |
Number of faxes sent successfully (summary reports only) |
|
<failed_sendings> |
Number of faxes that failed transmission (summary reports only) |