Administering Outbound Fax

How Outbound Fax Services Work

Prerequisites

Managing Outbound Fax Services:

Engineering Considerations

Managing Fax Administrator Accounts

Adding a Fax Administrator

Modifying a Fax Administrator Account

Deleting a Fax Administrator Account

Administering the FaxPrint Application

Administering the Schedule Table for FaxPrint

Administering Outbound Fax

When a subscriber accesses a fax or e-mail message on the telephone, the subscriber has the option to send that fax or e-mail message to a fax machine to be printed.

Note The tasks presented in this section are required only if you implement Fax Services.

How Outbound Fax Services Work

When a subscriber accesses a fax or an e-mail message on the telephone and redirects that fax or e-mail message to be printed, UM sends the fax or e-mail message to a special mailbox called a Fax Administrator Account. This mailbox acts like a post office for those messages. Each Fax Administrator Account that is set up on the system has a FaxPrint application instance associated with it.

Each FaxPrint application instance constantly monitors its designated mailbox and looks for incoming fax messages. If there is a message, FaxPrint extracts the target fax machine telephone number from the message header and searches for the proper Gateway for this fax machine number. It then sends the fax message to the Gateway using SMTP. The Gateway processes and delivers the message to the appropriate fax machine. Messages are processed on a first-in first-out basis. Any fax messages that are not delivered successfully on the first try will be moved to a Fax retry folder.

When faxes are moved to the Fax retry folder, they are given a timestamp. All timestamps are based on the local GateServer time. After the number of retries designated by the FAXNumberofRetries attribute, the fax message is returned to the subscriber's mailbox as an undeliverable message. This message is inventoried as a fax message and is identified as an undeliverable Fax in the subject.

Since there is only one FaxPrint application instance for each Fax Administrator mailbox, the FaxPrint application instance delivers faxes for both the inbox and the Fax retry folder. When FaxPrint initializes, the Fax retry folder is scanned for any messages that have expired. (A message has expired when the faxretry message timestamp plus the fax retry timeout period (FAXRetryTimeout attribute) has surpassed the current time.) If there are expired messages, FaxPrint processes all expired messages, starting with the oldest message first. After a message has been delivered from the inbox, FaxPrint again checks whether any retry messages have expired.

If there are no faxes to process (inbox or retries), the cycle processing time is adjusted to either the configured sleep time (FAXSleepTime attribute) or the amount of time until the next retry, whichever is smaller.

Prerequisites

Before you start administering Outbound Fax Services, ensure that the following tasks have been completed.

The DialMap.ini file is configured for handling outbound faxes.
The Gateway is configured properly.
The Messaging Server must have a Postmaster account administered. This Postmaster account receives notification, such as fax failure notifications, and is used to return undeliverable messages to the Subscriber.
Unified Messaging System Administration (UMSA) must be installed and administered.
UMSA login account is set up.
The Text-to-Speech feature must be installed and configured for the Text-to Fax feature to work.
E-mail and Fax Services must be enabled in UMSA for Text-to-Fax feature to work.

Managing Outbound Fax Services :

You perform the following tasks to manage Outbound Fax Services.

Add a Fax Administrator Account in UMSA

Administer the FaxPrint application
Administer the Schedule table for FaxPrint

Engineering Considerations

You can have multiple FaxPrint applications available on the same GateServer. However, you must assign each FaxPrint application instance that resides on the same GateServer to a different Fax Administrator account.
Each subscriber is assigned to a specific Fax Administrator Account in the subscriber's profile on the Directory Server. If you have a distributed system, you might consider assigning the subscriber to FaxPrint application serving the fax machine to which the subscriber will be sending most faxes.
To improve performance, you should assign no more than 1000 subscribers to each Fax Administrator Account.
To improve performance through load balancing, you might consider configuring multiple FaxPrint applications on multiple GateServers and assigning subscribers appropriately.
Each FaxPrint application must use the telephony resources on their local GateServer .

Managing Fax Administrator Accounts

Adding a Fax Administrator

Use the following steps to add a Fax Administrator Account. This account is the special Fax mailbox that is used to hold subscribers' faxes that are waiting to be printed.

Note When you name a Fax Administrator Account, make it descriptive (e.g., include the server name or some indicator of the location of the FaxPrint application). When you add subscribers in UMSA, a descriptive name will help you are choose the appropriate Fax Administrator Account.

Step 1 Access UMSA.

Step 2 Click on the Global Configuration button.

Step 3 Click on Add an Administrator.

Step 4 Enter the appropriate data in the input fields (Table 10-1).

Step 5 Click on Submit

Step 6 To add another administrative account, repeat steps Step 3 to Step 5.
Table 10-1: Add Fax Administrator Attributes

Attribute Description Valid Values

Directory Server

The current Directory Server. System-generated entry.

This field cannot be modified.

Entry DN

Indicates where in the LDAP database this entry resides. The entry distinguished name (dn) to which the administrator account belongs.

Select a dn from the drop-down menu.

Full Name

A name for this administrator account. Should indicate what is unique about this account (e.g area code, city, access server name, etc.)

Up to 60 characters. Should not use spaces.

Given Name

Any name. Consider using the Full Name for consistency. This field is required for LIPs entry.

Up to 60 characters. Should not use spaces.

Last Name

Any name. Consider using the Full Name for consistency. This field is required for LIPs entry.

Up to 60 characters. Should not use spaces.

Telephone Number

A fictitious unique telephone number. This field is required because it is typically used as a key when searching for a mailbox.

4 - 15 digit number.

E-mail Address

An e-mail address for this administrator. This is the mailbox that holds faxes that are being redirected for printing.

This information is required when setting up the following attributes in the FAXprint.ini file: FaxHost = <mail host> and FAXUser=<user id>.

The format is: <user id>@<host name>.

E-mail Password

The minimum and maximum length of this password is determined by the Class of Service (COS) assigned to this subscriber.

This information is required when setting up the following attribute in the FAXprint.ini file:
FAXPassword=<E-mail Password>.

The default password = abcd

Mail Server

Identifies the Messaging Server that contains this Fax Administrator mailbox. This should match the <host name> in the e-mail address.

Select the appropriate the Messaging Server from the drop-down list box.

The default is the Messaging Server that is set up as the system default during configuration.

Title

Identifies the type of special administrator account.

Select Fax Administrator from the drop-down list box.

Mail Quota

Enter the maximum amount of disk space in bytes that will be available for this administrative account. This amount depends on the volume of mail handled and the amount of free disk space that is available on the Messaging Server.

Default=0 (unlimited disk space)

Class of Service DN

Identifies the Class of Service and distinguished name (dn) for the class of service to which this account belongs.

Select the appropriate COS DN from the drop-down menu.

Attribute	Description	Valid Values
Directory Server	The current Directory Server. System-generated entry.	This field cannot be modified.
Entry DN	Indicates where in the LDAP database this entry resides. The entry distinguished name (dn) to which the administrator account belongs.	Select a dn from the drop-down menu.
Full Name	A name for this administrator account. Should indicate what is unique about this account (e.g area code, city, access server name, etc.)	Up to 60 characters. Should not use spaces.
Given Name	Any name. Consider using the Full Name for consistency. This field is required for LIPs entry.	Up to 60 characters. Should not use spaces.
Last Name	Any name. Consider using the Full Name for consistency. This field is required for LIPs entry.	Up to 60 characters. Should not use spaces.
Telephone Number	A fictitious unique telephone number. This field is required because it is typically used as a key when searching for a mailbox.	4 - 15 digit number.
E-mail Address	An e-mail address for this administrator. This is the mailbox that holds faxes that are being redirected for printing. This information is required when setting up the following attributes in the FAXprint.ini file: FaxHost = <mail host> and FAXUser=<user id>.	The format is: <user id>@<host name>.
E-mail Password	The minimum and maximum length of this password is determined by the Class of Service (COS) assigned to this subscriber. This information is required when setting up the following attribute in the FAXprint.ini file: FAXPassword=<E-mail Password>.	The default password = abcd
Mail Server	Identifies the Messaging Server that contains this Fax Administrator mailbox. This should match the <host name> in the e-mail address.	Select the appropriate the Messaging Server from the drop-down list box. The default is the Messaging Server that is set up as the system default during configuration.
Title	Identifies the type of special administrator account.	Select Fax Administrator from the drop-down list box.
Mail Quota	Enter the maximum amount of disk space in bytes that will be available for this administrative account. This amount depends on the volume of mail handled and the amount of free disk space that is available on the Messaging Server.	Default=0 (unlimited disk space)
Class of Service DN	Identifies the Class of Service and distinguished name (dn) for the class of service to which this account belongs.	Select the appropriate COS DN from the drop-down menu.

Modifying a Fax Administrator Account

Step 1 Access UMSA.

Step 2 Click on the Global Configuration button.

Step 3 Click on Modify an Administrator.

Step 4 Select a search option from the drop-down list box. The options correspond to fields in LDAP entries.

Step 5 Enter the data in the input field.

Step 6 Click on Search.

Step 7 Click on the appropriate Fax Administrator account, if necessary.

Step 8 Enter the appropriate data in the input fields (Table 10-1).

Step 9 Click on Submit

Step 10 To modify another administrative account, repeat steps Step 3 to Step 9.

Deleting a Fax Administrator Account

Note You cannot delete a Fax Administrator that has subscribers assigned to it. Before you delete the Fax Administrator, you must delete the subscribers first. Then, you can create new subscriber entries and reassign those subscribers to another Fax Administrator, if necessary.

Step 1 Access UMSA.

Step 2 Click on the Global Configuration button.

Step 3 Click on Delete an Administrator.

Step 4 Select a search option from the drop-down list box. The options correspond to fields in LDAP entries.

Step 5 Enter the data in the input field.

Step 6 Click on Search.

Step 7 Click on the appropriate Fax Administrator account, if necessary.

Step 8 Click on Delete.

Step 9 To delete another administrative account, repeat steps Step 3 to Step 8.

Administering the FaxPrint Application

The Faxprint application monitors a specific Fax Administrator mailbox for fax messages, and delivers those faxes to the appropriate fax machines. During initial system configuration, the Quick Configuration tool configures a single FaxPrint application. Use the following procedure to configure additional FaxPrint applications.

Step 1 Go to the GateServer to which you want to add the FaxPrint application.

Step 2 Type: cd $PARMLIB/apps/UM

Step 3 If a FaxPrint.ini file does not exist, simply copy the FaxPrint.ini file from the Samples directory before going to step Step 4. Otherwise, skip this step.

Step 4 Edit theFaxPrint.ini file and set the following attributes (Table 10-3, Table 10-4,Table 10-5):

[UMConfig]

Postmaster=

[LDAPConfig]

LDAPhost=

LDAPDnPassword

LDAPsearchbase=

[FAX]

FaxHost=

FaxUser=

FaxPassword=

SMTPHostSection=

ModemCard=
Table 10-2: Phrase Variables Section Attributes

Attribute Description Valid Values

TmpPhraseDirectory

Phrase directory.

Valid phrase directory to store the temp files created by the application. Set this attribute to the same directory as defined for the TmpPhraseDirectory attribute in UM.ini file.

Default =/home2/spmaster/r410/TNT/containers/scratch

Table 10-3: UMConfig Variables Section Attributes

Attribute Description Valid Values

AppRunMode

Application's running mode.

Static or Dynamic

Default = Dynamic

AudioSubType

Audio type. This attribute is used in creation of VPIM message. The only value currently supported is wav, but when G726.1 encoding format is available on DSP cards, the applicable values will be extended.

Wav

Default = wav

BillingLogging

Whether the billing records will be output (logged) or not. If it is set to On, UM will log all outbound calls, login/logout for subscriber access, leave message access, and inbound fax access to the Application Object via event logs. The Unified Messaging System Administration application will log the addition/deletion of subscribers in the network to http logs.

On or Off.

Default = Off

Informational Logging

Indicates whether event logging occurs, other than billing information. Information such as imap, ldap, dtmf keys will be logged. You can use this information to recreate user problems to troubleshoot problems.

On or Off

Default = Off

MailProtocolDebug

IMAP APIs debug information at the protocol level.

On or Off

Default = On

MailProtocolTimeout

Controls timeout for SMTP sends. If MailProtocolTimeout is undefined or is set to 0, the timeout for SMTP sends would be infinite.

Any reasonable number.

Unit is seconds.

Default=20

MailServer

Mail server. This attribute is used to fine tune the application based upon the backend server characteristics. Currently, only two values are allowed.

Netscape or ATT

Default = Netscape

Postmaster

Destination e-mail address for non-deliverable messages.

E-mail address of postmaster.

Default = N/A

SNAMode

Indicates whether or not Personal Access is enabled.

This attribute is not included in the Samples/UM.ini file.

Enabled or Disabled.

Default = Enabled

TableDefinition

The table that defines the rest of the table in the application. This attribute should not be changed without consulting development team.

Valid and existing table name. For example, Menus_define.tab.

Default = Menus_define.tab

TableInstance

The table that defines the instances of the tables specified in the TableDefinition. This attribute should not be changed without consulting development team.

Valid and existing table name. For example, Menus_inst.tab.

Default = Menus_inst.tab

TimeOutValue

Application's time out value.

0 - 30

Default = 5

Table 10-4: LDAPConfig Variables Section Attributes

Attribute Description Valid Values

LDAPBindDn

The authority to bind as to the directory, and to have sufficient privilege to perform all the operations that UM requests.

Specify all UM operations here.

Default = cn=Directory Manager

LDAPDnPassword

The e-mail password (in other words, the IMAP password) of the above authority.

The password of LDAPBindDn

Default = N/A

LDAPhost

The centralized Directory Server name that UM uses.

Valid machine names separated by commas.

Default = N/A

LDAPport

The port on which slapd (LDAP daemon) is running for the centralized server.

Valid port number. For example, 389.

Default = 389

LDAPsearchbase

Entry DN from which UM can see all entries that will be accessed. Use this attribute to restrict and/or partition the Directory Server from the perspective of UM and other applications. In a large-scale directory setting, an appropriate search base will improve performance.

Top of the directory.

Default =

o=Organization

LDAPTimeout

Controls timeout for LDAP calls. If LDAPTimeout is undefined or is set to 0, the timeout for LDAP calls would be infinite.

Any reasonable number. Should be set to a high value to avoid FaxPrint failure.

Unit is seconds.

Default=10

Table 10-5: Fax Section Attributes

Attribute Description Valid Values

FAXConfigFile

Filename for FAXFile that contains extensions used for Group Fax numbers.

Valid filename existing in $PARMLIB/apps/UM directory. For example, FAXFile.

Default = FAXFile

FAXHost

IMAP host name for FaxPrint application. UM does not use this configurable but FaxPrint needs it.

IMAP host name for FaxPrint application.

Default = N/A

FAXInactivityTimeout

InactivityTimeout value passed to TNT before receiving a fax.

0 - 30000
0 indicates no timeout

Default = 0

FAXNumberOfRetries

Number of failed attempts for each fax. Used by FaxPrint only.

1 - 10

Default = 3

FAXPassword

Password for faxadmin user used by FaxPrint application. UM does not use this configurable, only FaxPrint does.

Password for faxadmin user.

Default = N/A

FAXRetryFolder

Name of folder under faxadmin user where failed faxes are sent. Used by FaxPrint only.

Name of folder under faxadmin user where failed faxes are sent.

Default = faxretry

FAXRetryMode

Indicates whether faxprint should attempt retries. Used by FaxPrint only.

Should only be disabled if another FaxPrint application is running in FAXRetryMode = Enabled on another box.

Enabled or Disabled

Default = Enabled

FAXRetryTimeout

Number of seconds between retries of failed faxes.

1-10000

Default=300

FAXRunMode

Indicates whether FaxPrint runs in static or dynamic mode.

Used by FaxPrint only. Currently only supports Static.

Static

Default = Static

FAXSendperPageTimeout

SMTP send timeout only for sending faxes via Allegro. It will be calculated in FaxPrint based on the size of the fax/e-mail message.

Default=120

Unit is seconds.

FAXSleepTime

Number of seconds between FaxPrint processing cycles.

1-10000

Default=30

FaxSubType

File type for faxes written to disk. This attribute is used to create VPIM message and should not be changed without consulting development team.

tif

Default = tif

FAXUser

User ID for faxadmin user used by FaxPrint application.

User ID for faxadmin user.

Default = N/A

ModemCard

Indicates the type of modem card in the Gateway.

Microcom

MICA

Default=N/A

SMTPHostSection

Provides the host and domain for a given fax number.

Valid section label from the DialMap.ini file.

Default=GWHOSTS

Attribute	Description	Valid Values
TmpPhraseDirectory	Phrase directory.	Valid phrase directory to store the temp files created by the application. Set this attribute to the same directory as defined for the TmpPhraseDirectory attribute in UM.ini file. Default =/home2/spmaster/r410/TNT/containers/scratch

Attribute	Description	Valid Values
AppRunMode	Application's running mode.	Static or Dynamic Default = Dynamic
AudioSubType	Audio type. This attribute is used in creation of VPIM message. The only value currently supported is wav, but when G726.1 encoding format is available on DSP cards, the applicable values will be extended.	Wav Default = wav
BillingLogging	Whether the billing records will be output (logged) or not. If it is set to On, UM will log all outbound calls, login/logout for subscriber access, leave message access, and inbound fax access to the Application Object via event logs. The Unified Messaging System Administration application will log the addition/deletion of subscribers in the network to http logs.	On or Off. Default = Off
Informational Logging	Indicates whether event logging occurs, other than billing information. Information such as imap, ldap, dtmf keys will be logged. You can use this information to recreate user problems to troubleshoot problems.	On or Off Default = Off
MailProtocolDebug	IMAP APIs debug information at the protocol level.	On or Off Default = On
MailProtocolTimeout	Controls timeout for SMTP sends. If MailProtocolTimeout is undefined or is set to 0, the timeout for SMTP sends would be infinite.	Any reasonable number. Unit is seconds. Default=20
MailServer	Mail server. This attribute is used to fine tune the application based upon the backend server characteristics. Currently, only two values are allowed.	Netscape or ATT Default = Netscape
Postmaster	Destination e-mail address for non-deliverable messages.	E-mail address of postmaster. Default = N/A
SNAMode	Indicates whether or not Personal Access is enabled. This attribute is not included in the Samples/UM.ini file.	Enabled or Disabled. Default = Enabled
TableDefinition	The table that defines the rest of the table in the application. This attribute should not be changed without consulting development team.	Valid and existing table name. For example, Menus_define.tab. Default = Menus_define.tab
TableInstance	The table that defines the instances of the tables specified in the TableDefinition. This attribute should not be changed without consulting development team.	Valid and existing table name. For example, Menus_inst.tab. Default = Menus_inst.tab
TimeOutValue	Application's time out value.	0 - 30 Default = 5

Attribute	Description	Valid Values
LDAPBindDn	The authority to bind as to the directory, and to have sufficient privilege to perform all the operations that UM requests. Specify all UM operations here.	Default = cn=Directory Manager
LDAPDnPassword	The e-mail password (in other words, the IMAP password) of the above authority.	The password of LDAPBindDn Default = N/A
LDAPhost	The centralized Directory Server name that UM uses.	Valid machine names separated by commas. Default = N/A
LDAPport	The port on which slapd (LDAP daemon) is running for the centralized server.	Valid port number. For example, 389. Default = 389
LDAPsearchbase	Entry DN from which UM can see all entries that will be accessed. Use this attribute to restrict and/or partition the Directory Server from the perspective of UM and other applications. In a large-scale directory setting, an appropriate search base will improve performance.	Top of the directory. Default = o=Organization
LDAPTimeout	Controls timeout for LDAP calls. If LDAPTimeout is undefined or is set to 0, the timeout for LDAP calls would be infinite.	Any reasonable number. Should be set to a high value to avoid FaxPrint failure. Unit is seconds. Default=10

Attribute	Description	Valid Values
FAXConfigFile	Filename for FAXFile that contains extensions used for Group Fax numbers.	Valid filename existing in $PARMLIB/apps/UM directory. For example, FAXFile. Default = FAXFile
FAXHost	IMAP host name for FaxPrint application. UM does not use this configurable but FaxPrint needs it.	IMAP host name for FaxPrint application. Default = N/A
FAXInactivityTimeout	InactivityTimeout value passed to TNT before receiving a fax.	0 - 30000 0 indicates no timeout Default = 0
FAXNumberOfRetries	Number of failed attempts for each fax. Used by FaxPrint only.	1 - 10 Default = 3
FAXPassword	Password for faxadmin user used by FaxPrint application. UM does not use this configurable, only FaxPrint does.	Password for faxadmin user. Default = N/A
FAXRetryFolder	Name of folder under faxadmin user where failed faxes are sent. Used by FaxPrint only.	Name of folder under faxadmin user where failed faxes are sent. Default = faxretry
FAXRetryMode	Indicates whether faxprint should attempt retries. Used by FaxPrint only. Should only be disabled if another FaxPrint application is running in FAXRetryMode = Enabled on another box.	Enabled or Disabled Default = Enabled
FAXRetryTimeout	Number of seconds between retries of failed faxes.	1-10000 Default=300
FAXRunMode	Indicates whether FaxPrint runs in static or dynamic mode. Used by FaxPrint only. Currently only supports Static.	Static Default = Static
FAXSendperPageTimeout	SMTP send timeout only for sending faxes via Allegro. It will be calculated in FaxPrint based on the size of the fax/e-mail message.	Default=120 Unit is seconds.
FAXSleepTime	Number of seconds between FaxPrint processing cycles.	1-10000 Default=30
FaxSubType	File type for faxes written to disk. This attribute is used to create VPIM message and should not be changed without consulting development team.	tif Default = tif
FAXUser	User ID for faxadmin user used by FaxPrint application.	User ID for faxadmin user. Default = N/A
ModemCard	Indicates the type of modem card in the Gateway.	Microcom MICA Default=N/A
SMTPHostSection	Provides the host and domain for a given fax number.	Valid section label from the DialMap.ini file. Default=GWHOSTS

Administering the Schedule Table for FaxPrint

A single FaxPrint application is added to Schedule.<hostname> file during the initial installation of your system. The following procedure shows how manually set up additional FaxPrint applications in the Schedule file.

Step 1 Go to GateServer where the FaxPrint application should reside and type: Type:

cd $PARMLIB/parms/APP

Step 2 Add the following information to the Schedule.<hostname> file:

STATIC_NOWAIT 100 1 1 1 * * FaxPrint UM/FaxPrint FaxPrint.ini

Step 3 If the system is operational and you are reloading changes to an existing FaxPrint application, you must stop the application first.

Type: kill <PID>
where <PID> is the process ID of the FaxPrint application instance that you want to stop

Step 4 Reload the schedule table. Type:

umcli
resched static FaxPrint

Table of Contents