Cisco Unity Express 3.2 IVR CLI Administrator Guide
Configuring the IVR Fax Subsystem

Table Of Contents

Configuring the IVR Fax Subsystem

Configuring the Fax SMTP DNS Hostname or IP Address

Examples

Configuring the Fax Default-From Address

Examples


Configuring the IVR Fax Subsystem


Last Updated: July 24, 2008

This chapter describes how to configure Cisco Unity Express IVR fax subsystem parameters. The following sections describe the procedures for configuring IVR fax parameters:

Configuring the Fax SMTP DNS Hostname or IP Address

Configuring the Fax Default-From Address

The Cisco Unity Express IVR fax subsystem uses e-mail components to generate an e-mail or e-mail attachments. Faxes are sent to a configurable fax SMTP server. The fax SMTP server configuration is different from the SMTP server configuration you use for sending outbound e-mails (see the "Configuring the IVR Outgoing E-Mail Subsystem Notifications" section on page 35). Outbound faxes are generated using a specially formatted e-mail address.

The fax subsystem can generate an e-mail notification to describe the disposition of the fax message. If this option is enabled, an e-mail is generated and sent to the address listed in the from field for both successful and unsuccessful conditions.

The fax subsystem maintains a queue of outbound fax requests. Any request by the script to send a fax from the Editor step inserts the request in the queue and returns to prevent waiting for a response from the router (see the Cisco Unity Express 3.2 Guide to Writing and Editing Scripts). The system does not return an SMTP reply until the fax is completely sent, and this can take 10 minutes. If the reply from the SMTP server indicates that the fax was sent successfully, the request is removed from the queue. If the reply indicates that there was a failure in sending the fax, sending the fax is retried after 10 minutes. If it is unsuccessful after three retries, then the fax request is marked as failed.

The queue is maintained in the database so that it can persist across a reboot of the system. If the fax was generated using a document or TIFF attachment, then the pointer to the document is stored in the database. If the fax was generated using a text substituted template file, then the file is stored in a temporary directory and stored in the database.

Configuring the Fax SMTP DNS Hostname or IP Address

Use the fax gateway outbound address command to configure the fax SMTP server for fax steps in running the script (see the Cisco Unity Express 3.2 Guide to Writing and Editing Scripts). The outbound address is the address of the fax SMTP server on the Cisco IOS gateway, which generates the fax call. An error message appears if an attempt is made to enter a DNS hostname without first configuring the DNS server.

The no and default form of this command removes the fax SMTP server configuration.

SUMMARY STEPS

1. config t

2. fax gateway outbound address {hostname | ip-address}

3. smtp server address {hostname | ip-address} {none | credentials credential-string | username userid password password}

4. end

5. exit

6. show ccn subsystem fax

DETAILED STEPS

 
Command or Action
Purpose

Step 1 

config t

Example:

se-10-0-0-0# config t

Enters global configuration mode.

Step 2 

fax gateway outbound address {hostname | ip-address}

Example:

se-10-0-0-0(config)# fax gateway outbound address 10.0.0.1

Specifies the fax gateway outbound address DNS hostname or IP address.

Step 3 

smtp server address {hostname | ip-address} {none | credentials credential-string | username userid password password}

Example:

se-10-0-0-0(config)# smtp server address 172.16.0.0 credentials abcdefg

Specifies the SMTP server DNS hostname or IP address and authentication. This step is required to generate the disposition notification e-mails.

Step 4 

exit

Example:

se-10-0-0-0(config)# exit

Exits global configuration mode.

Step 5 

show fax configuration

Example:

se-10-0-0-0# show fax configuration

Displays the fax configuration parameters.

Examples

The following example displays the output of the show fax configuration command.

se-10-0-0-0> show fax configuration 
Inbound Fax Gateway:                    
Outbound Fax Gateway:                   10.0.0.1
Fax Printing Number: 

Configuring the Fax Default-From Address

Use the default-from fax command to configure the default-from e-mail address for the fax application.

The default-from address is the address that your recipients see in the From field of outgoing e-mails and, if undeliverable, e-mails are returned to this address. Although the message is being sent from Cisco Unity Express servers and e-mail domains, you can set this to read name@domain.com. The default-from address can be customized for your chosen e-mail address, meaning the e-mail can be from a specific address on your domain.

Enter a valid e-mail address string that is capable of receiving e-mail deliveries. This address must also be capable of receiving notifications of delivery failures. The Send Fax step in the script forces the application to use this address for successful delivery notifications (see the Cisco Unity Express 3.2 Guide to Writing and Editing Scripts).

If the Send Fax step has the Use Default option checked and the default-from address is not configured, Cisco Unity Express uses user@localhost.com as the address.

The no and default form of this command removes this configuration.

SUMMARY STEPS

1. config t

2. ccn subsystem fax

3. default-from email-address-string

4. default

5. end

6. exit

7. show ccn subsystem fax

DETAILED STEPS

 
Command or Action
Purpose

Step 1 

config t

Example:

se-10-0-0-0# config t

Enters configuration mode.

Step 2 

ccn subsystem fax

Example:

se-10-0-0-0(config)# ccn subsystem fax

se-10-0-0-0(config-fax)#

Enters fax configuration mode.

Step 3 

default-from email-address-string

Example:

se-10-0-0-0(config-fax)# default-from name@domain.com

Specifies the default-from e-mail address.

Step 4 

default

Example:

se-10-0-0-0(config-fax)# default default-from name@domain.com

Deletes the IVR fax subsystem default-from e-mail address.

Step 5 

end

Example:

se-10-0-0-0(config-fax)# end

Saves and exits fax configuration mode.

Step 6 

exit

Example:

se-10-0-0-0(config)# exit

Exits global configuration mode.

Step 7 

show fax configuration

or

show ccn subsystem fax

or

show ccn subsystem fax outbound queue

Example:

se-10-0-0-0# show fax configuration

or

se-10-0-0-0# show ccn subsystem fax

or

se-10-0-0-0# show ccn subsystem fax outbound queue

Displays the fax configuration parameters, fax default-from address, or queued outbound fax messages.

Examples

The following example displays the output of the show fax configuration command.

se-10-0-0-0> show fax configuration 
Inbound Fax Gateway:                    
Outbound Fax Gateway:                   10.0.0.1
Fax Printing Number:

The following example displays the output of the show ccn subsystem fax command.

se-10-0-0-0> show ccn subsystem fax 
FAX Default From Address:               man2821-cue@cisco.com

Faxes are always sent in queued mode. The following example displays the output of the show ccn subsystem fax outbound queue command. If no faxes are in the outbound queue, the system responds with "No jobs in queue."

se-10-0-0-0> show ccn subsystem fax outbound queue
============================================================================
Fax ID    Recipient      Subject                         Retry     Scheduled
                                                         Count     Send Time
============================================================================
15        9784551212     subject of Fax - max 30 char    1         2007/05/30 10:52:00