Working With FaxAttendant

From PresenceWiki
Jump to: navigation, search

The FaxAttendant runs as part of the CloudFax400 suite. It allows you to monitor inbound and outbound faxes sent either via the cloud, or via Faxcom, and to receive alerts when there are problems with the drivers.

Please see the FaxAttendant Wiki page for installation information and instructions.

Dashboard Screen

This gives an overall picture of the fax activity, and displays the following graphs:

Audit Summary

This Graph shows a summary view of the statuses of the most recent faxes. Gone faxes have been successfully delivered. Failed faxes were successfully queued but could not be delivered to the recipient.

"Failed to Queue" faxes could not be sent to the cloud provider, or when they could not be queued on Faxcom. The presence of these may indicate a fundamental problem with your configuration and generally needs attention.

Faxes Processed Summary

This graph shows a representation of the throughput of faxes over a period of time (one hour, eight hours or twenty-four hours).

Use the dropdown list to select the type of event you wish to see. You can choose between sent faxes (delivered), failed faxes or queued faxes. Queued faxes included both "sent" and "failed" faxes.

Failure Reasons

This graph shows the most common reasons for failure. This can help to identify common repeating problems.

Disk Usage

This Graph shows the amount of free and used space on the drive that FaxCloud400 was installed to.

Additional Reports

These reports can help to identify fax destinations that frequently cause failures. Top Failed Numbers shows the most common numbers which cause failure. Top Failed-To-Queue numbers shows numbers which cause a failure to queue the fax (failing initial screening).

Server Management

This screen is only available for users that have "Admin" rights. It displays a list of installed services and their status, and provides buttons to stop and start these individual services. Next to each service is an "Information" icon. Clicking this shows a pop-up message dialog which explains what that service is for.

License Information

This panel displays information about the currently installed license for this software, if appropriate. If no license is installed, or if the license has expired, this information will be displayed. Clicking the "View License" button (if available) will show more information about the currently installed license such as company name and expiry date.

HTTP Server

This button allows you to restart the HTTP (management) server.

Server Activity

This button launches a new screen displaying the currently running Java threads. This is useful for tracing problems.


This screen launches the configuration wizard. Use the "Back" and "Next" buttons to navigate between the various screens. More information is available in the FaxAttendant installation Wiki.

As with the Server Management screen, this is only available to users with "Admin" permissions.

Note on users

Screen 4 of the configuration wizard allows you to create or remove users for the FaxAttendant / CloudFax application. Click the "Add user" button to create a new user. If no users are configured the application will be available to anyone that accesses it. Creating users causes it to be restricted to people with a relevant username / password. Users with "Admin" role will be able to access the Server Management and Config screens. Profiles with "User" role will not be able to see these screens but will be able to see all other screens.


This displays any system alerts. When alerts are present the link button will be highlighted red, and an email will be sent to the administrator(s) once per hour:

The following FaxAttendant status queries are executed periodically for each AS400 connection created in the FaxAttendant configuration:

  • Check drivers reading queue: Queries the TF400MON and TF400EML files to check the last updated time for each driver. If the update has not been performed within the last five minutes an alert will be raised.
  • Check for messages left in relay status: Queries the TF400MON and TF400EML files to check for messages which remain in relay status after a period of time.
  • Check for statuses not updating: Queries the TF400MON and TF400EML files to check for messages whose status has not been updated after a period of time.
  • Check Imps communicating with hosts: Queries the TF400MON and TF400EML files to check that the IMPS server is communicating with the AS400.

This screen will also show any other problems encountered with the FaxAttendant / CloudFax software.


This screen shows a list of faxes received via Faxcom or via the Cloud service. The "Receive Date" dropdown allows you to filter the messages according to the date received. "Max Records" specifies the maximum number of faxes to be shown on the screen. "CallerID" and "Destination" filter the results according to the originating number and destination number.

Clicking on an item allows you to view details for the fax, any activity that has taken place, and to view the fax file if present:


The Outbound Faxes Audit screen shows a list of faxes that have been queued, or attempted to be queued. The following filters are available:

  • From Date: The minimum date of faxes to show
  • To Date: The maximum date of faxes to show
  • Origin: The AS400 host and driver that this fax originated from
  • Max Records: The maximum number of records to show (default 1000)
  • Fax Status: Restricts the results to only show faxes matching the selected status (All, All (Excluding Pending), Gone, Failed, Not Queued, Pending)
  • File Name: Restricts the results to only show faxes whose filename contains the specified string.
  • AS400 Ref: Restricts the results to only show faxes with the specified AS400 Reference.
  • Destination: Restricts the results to only show faxes sent to numbers containing the specified string.

Clicking on an item shows the Fax Audit Details screen, which contains information about the fax delivery. If the fax failed, this should display the reason for the failure. Click the "View Fax and Attachments" button to view the fax image.

The status column reflects the status of the item at the time of creating the audit entry. So a fax that delivers successfully will have two entries – one for when the fax is first queued (PENDING) and one for when it is delivered, or a failure report is received. The following statuses are available for filtering:

  • All: All faxes are displayed, regardless of their status.
  • All (Excluding Pending): Only faxes that have gone, failed or failed to queue will be displayed (omitting the newly queued items)
  • Gone: Faxes that have successfully delivered (regardless of attempts)
  • Failed: Faxes that were attempted to be delivered but failed due to a problem such as a busy dial tone, invalid number, etc.
  • Not Queued: Faxes that could not be queued or could not be delivered to the remote delivery service (account problems, invalid numbers etc)
  • Pending: Faxes that have been queued but not yet transmitted (this will be a separate entry)


This screen displays CloudFax400 log entries, useful for debugging or solving application-level problems. Logs can be filtered by date and severity / type (see below). The types of log that can be written are:

  • Trace
  • Debug
  • Info
  • Warn
  • Error

Items that are of Warn or Error type will be displayed in red to distinguish them from normal entries (Trace, Debug or Info). Clicking on a log entry will display the entry in a separate screen, un-truncated, with further debugging information such as the Java class and the line number at which the log entry was generated.

The following filters are available:

  • Date: The date of the log entries to view
  • Max Lines: The maximum number of log entries to view
  • Show Type: Filters log entries according to type (TRACE, DEBUG, INFO, WARN,


  • Time of Day: Allows the user to filter results according to the time of day. The default is to show the most recent log entries.

Log Out

If the current user has provided security credentials, they will be logged out and will have to re-enter their username and password to re-access the FaxAttendant / CloudFax application.