Difference between revisions of "Fax Attendant"

From PresenceWiki
Jump to: navigation, search
(Configuring FaxAttendant)
(AS400 Configuration)
Line 176: Line 176:
 
* '''Connection Username''' The user account to log on as
 
* '''Connection Username''' The user account to log on as
 
* '''Connection Password''' The password matching the account name above.
 
* '''Connection Password''' The password matching the account name above.
 +
* '''TF400 Gateways''' This allows you to configure one or more TF400 Gateways for monitoring purposes. Typically the port will be ''4173''.
  
 
Note that a default value is provided for the Connection URL - usually you will just have to replace "[hostname]" with the actual hostname of the server.
 
Note that a default value is provided for the Connection URL - usually you will just have to replace "[hostname]" with the actual hostname of the server.

Revision as of 16:16, 25 May 2012

FaxAttendant is part of the CloudFax suite. It can be run alongside the CloudFax delivery system, or on its own.

FaxAttendant connects to the TF400 Gateway and records details of incoming and outgoing fax and email transmissions as well as providing visual dashboards for transmission statistics.

Installing FaxAttendant

http://www.international-presence.com/wikidocs/images/cloudfax_install_screen.png

To begin installation, download cloudfax400_install.exe and double-click the exe file. Read the introduction screen and then click "Next". Select an install folder - this will default to your C: drive, so change this if you would prefer to install on a different drive. Click "Next" to select the short-cut folder name. Click "Next" to read the Pre-Installation Summary, and then Next again to begin the installation. Finally, when the "Install Complete" screen appears, click "Done" to exit the installer.

Configuring FaxAttendant

CloudFax / FaxAttendant runs as a web server on port 85 by default. Make sure the "CloudFax 400" Windows service is started, then direct your browser to:

http://[hostname]:85

where [hostname] represents the hostname of the server that CloudFax was installed onto. If it is installed on your local machine, use "localhost" or "127.0.0.1".

Core configuration

http://www.international-presence.com/wikidocs/images/cloudfax_core_settings.png

This should be configured by your support representative. Click the "Config" screen and then click the "Click for core settings" link at the foot of the screen. This will display the core configuration screen:

Provider

For FaxAttendant installation, this should contain the text "faxattendant". Username and password fields can be left blank.

Additional Provider Attributes

No additional provider attributes need to be supplied.

IP Account Settings

In the first field (Customer ID), the customer account reference should be entered. In the "License" field, enter the customer license code, generated by Presence.

Finally, enter the support representative code in the field next to "Submit" to affect the changes.


General Configuration

Click the "Config" link to access the general configuration screen. Click "Next" to begin.

Screen 1

The following options are available for the first screen:

Date Format: The format that dates should be displayed when viewing log files etc. The following characters describe various parts of the date format:

  • y - a year digit. "yy" represents the two-digit year, "yyyy" represents the four-digit year.
  • M - a month digit. "MM" represents the two-digit month (e.g. "05"), MMM represents the three-character month representation - e.g. "May".
  • d - a day digit. "dd" represents the two-digit day, e.g. "16".
  • H - an Hour digit (24 hour). Usually appears as "HH".
  • m - the minute digits.
  • s - the second digits
  • S - milliseconds.

For example the following (default) time-format:

  • yyyy-MM-dd HH:mm:ss

Formats the date as follows:

  • 2011-08-01 17:00:00

What is the address of the TF400 Gateway?

This specifies the IP address of the TF400 Gateway.

TF400 > Cloud Server Port

This is the port that the TF400 uses to establish connections to the FaxCloud server. This should match the "CloudGatewayPortSend" field in the tf400.ini file.

Cloud Server > TF400 Port

This is the port that the FaxCloud server uses to establish connections to the TF400 Gateway. This should match the "CloudGatewayPortListen" field in the tf400.ini file.

Screen 2

File Root:

This specifies the location of CloudFax operation files. The default is "C:\cloudfax400_files\", but can be changed to any valid path. The directory will be created automatically.

Please specify which types of log entry you wish to record:

This allows you to control which log entries are recorded according to type / severity.

Screen 3

Here you can specify the rules for archiving of log, queue and audit files. After an initial period of days, these files will be archived into a zip file. These zip files will be permanently deleted after an additional period of days.

Number of days before archiving to zip files:

This sets the number of days that files should be kept before being archived (added to zip files at the root of the operation files directory).

Number of days before permanently deleting zip files:

After this period of time archive (zip) files will be permanently deleted from the system.

Screen 4

This section allows you to modify the settings for the FaxCloud management console (i.e. this web application). You can change the port number from the default of 85 and add / remove users.

FaxCloud Management Console Port:

This specifies the port on which the management console HTTP server listens on. The default is 85, but you can change it to any convenient port.

Management Console Users

Allows you to add and remove users for the management console. Click "Add User" to create a new user. Specify the username and password for that user, then select a role. This can be "Admin" or "User". A "User" account will not be able to see the configuration or server management screens. An "Admin" account can access all screens.

Screen 5

Here you can specify the SMTP settings so that fax attendant alerts and incoming fax images can be emailed to people in your organisation.

SMTP Server hostname: The hostname of your SMTP server.

SMTP Server port: The port number that your SMTP server listens on (default is 25).

Requires Authentication? Select "yes" or "no". If "yes", please enter the username and password that you use to connect to your SMTP server.

Please specify the email addresses of anyone that you would like to receive alerts from the CloudFax400 system. Leave this field blank if you do not wish to receive alerts.

Click the "Send Test Email" button to verify these settings and to send a test email.

Screen 6

POP / IMAP Settings

This allows you to configure the settings for downloading faxes via an email account. If you do not wish to use this feature of CloudFax, just leave the fields blank and click Next.

  • Protocol: Specify whether your mail server uses POP or IMAP or protocol.
  • Mail Folder: Typically this will be "inbox", or blank if you are using a POP server.
  • Server Hostname: The hostname of your POP/IMAP server.
  • Server Port The port on which your POP/IMAP server listens for connects. Typically this will be 110 for POP3 and 143 for IMAP, although this may vary according to your product.
  • Account username The username to use for connecting to your POP/IMAP server
  • Account password The password to use for connecting to your POP/IMAP server
  • Use SSL? Determines whether connections use secure socket layer.
  • Use certificate? If true, a security certificate will be sent when connecting.

Screen 7

Incoming Fax Routing

This allows you to specify how incoming faxes are routed according to the TSID (Transmitting Subscriber Identification, i.e. the originating telephone number). The following two options are available:

  • The fax file can be copied to a network folder
  • The fax file can be emailed to one or more addresses.

To create a new Rule, click the "New Rule" button. The first thing you will be asked for is the TSID that this rule should be applicable for. Multiple TSIDs can be provided by using commas to separate them. Partial TSIDs can be used.

Add Email Address

This allows you to add an email address for the rule specified. Please provide a personal name (e.g. John Smith) and an email address (e.g. john.smith@thecompany.com)

Add UNC

This allows you to add a UNC path for files to be transferred. UNCs will be validated in real-time before submit.

Screen 8

This is the summary screen and allows you to review your changes. If you are happy with the changes, click "Finish" to commit them. A server restart will be required to affect the changes. If you wish to edit any parts, click the "Edit" button next to the information which you wish to change.

AS400 Configuration

In order to allow connections to multiple AS400s this has been moved to a separate configuration screen. Click the "Start" button beneath "AS400 Configuration" to launch this configuration editor:

http://www.international-presence.com/wikidocs/images/cloudfax/as400_config.png

FaxAttendant has one pre-configured AS400 connection that you can edit by clicking on the name in the left-hand menu. To add a new connection click the "Create New" button. You will need to provide:

  • Name of this As400 A user-friendly name identifying this AS400 connection
  • AS400 Connection URL The Connection URL used by JDBC to connect
  • Drivers Library Name The name of the library containing the fax queue files etc.
  • Connection Username The user account to log on as
  • Connection Password The password matching the account name above.
  • TF400 Gateways This allows you to configure one or more TF400 Gateways for monitoring purposes. Typically the port will be 4173.

Note that a default value is provided for the Connection URL - usually you will just have to replace "[hostname]" with the actual hostname of the server.

Use the "Test" button to check that your connection parameters are correct. If so, a message will be displayed saying "Test was successful" - otherwise the error message returned will be displayed.

When all AS400s have been set up you can restart the Fax Attendant service through the Server Management screen for your changes to take effect.

Configuring the TF400Gateway and Impsgateway To Work With FaxAttendant

To configure the TF400Gateway edit the TF400.ini file located at c:\TF400Gateway\tf400.ini

[CloudFax400]
CloudGatewayAddress=unknown
CloudGatewayPortListen=4450
CloudGatewayPortSend=0
FaxCloudDateFormat=dd/MM/yyyyHH:mm:ss
FaxCloudDirectory=c:\\FaxCloudGateway\
FaxCloudEnabled=false
FaxCloudGatewayAddress=unknown
FaxCloudGatewayPortListen=4450
FaxCloudGatewayPortSend=0
FaxCloudMOQTimeOut=120
FaxCloudSendLogAuditRequest=true
FaxCloudTF400GatewayMachineName=GRAHAMXP

It is also possible to edit these settings using the CloudFax400Configure.exe which can be found in c:\TF400Gateway\Tools\CloudFax400Configure.exe

To configure the ImpsGateway edit the impsini.ini located at c:\Program Files\Impsgateway\impsini.ini

[GENERAL]
TF400GATEWAY_TF400_AUDIT_COPIES_DIRECTORY=E:\TF400Gateway\TF400\Audit\Copies\EP400P1A