Table Of Contents
T.37/T.38 Fax Gateway
Feature Overview
Using Interactive Voice Response for Call Processing
Benefits
Restrictions
Related Features and Technologies
Related Documents
Supported Platforms
Supported Standards, MIBs, and RFCs
Prerequisites
Downloading VCWare to the VFC
Determine the Number of VFCs
Identify the VFC Mode
Download the Software in VCWare Mode
Download the Software in ROM Monitor Mode
Copying Flash Files to the VFC
Downloading from the AS5300 Motherboard
Downloading from a TFTP Server
Unbundling VCWare
Adding Files to the Default File List
Adding Codecs to the Capability List
Deleting Files from VFC Flash Memory
Erasing the VFC Flash Memory
Configuring the Fax Gateway to Support IVR
Configuration Tasks
Specifying the Interface Type for Fax Calls
Configuring IVR Functionality
Configuring the On-Ramp Gateway
Configuring the Called Subscriber Number
Configuring the Sending MTA
Configuring the POTS Dial Peer
Configuring the MMoIP Dial Peer
Verifying the On-Ramp Gateway Configuration
Configuring the Off-Ramp Gateway
Configuring the Transmitting Subscriber Number
Configuring the Fax Transmission Speed
Configuring the Receiving Mail Transfer Agent
Configuring the POTS Dial Peer
Configuring the MMoIP Dial Peer
Configuring the Faxed Header Information
Configuring the Fax Cover Page Information
Verifying the Off-Ramp Gateway Configuration
Configuring the Gateway Security
Configuring On-Ramp Gateway Security
Configuring Off-Ramp Gateway Security
Configuring the ACLs
Using Attribute-Value Pairs
Configuring the Gateway for TCL Application Files
Verifying the Gateway Security Configuration
Configuring MDN
Configuring the On-Ramp Gateway Elements for MDN
Configuring the Off-Ramp Gateway Element for MDN
Verifying MDN Configuration
Configuring DSN
Verifying DSN Configuration
Configuration Examples
T.37/T.38 Fax Gateway
This document provides the required information for configuration of a T.37/T.38 Fax Gateway on a Voice Feature Card (VFC) installed in the Cisco AS5300 access server. Store-and-forward fax, previously documented in the Cisco IOS Multiservice Applications Configuration Guide, enables Cisco AS5300s to send and receive faxes across packet-based networks. This document includes the following sections:
•
Feature Overview
•Supported Platforms
•Supported Standards, MIBs, and RFCs
•Prerequisites
•Configuration Tasks
•Configuration Examples
Feature Overview
When the Cisco AS5300 is equipped with VFCs, it supports carrier-class Voice over IP (VoIP) and fax over IP services. Since the Cisco AS5300 is H.323 compliant, it supports a family of industry-standard voice codecs and provides echo cancellation and Voice Activity Detection (VAD)/silence suppression. There is an Interactive Voice Response (IVR) application that provides voice prompts and digit collection in order to authenticate the user and identify the call destination.
The VFC is a co-processor card with a powerful Reduced Instructions Set Computing (RISC) engine and dedicated, high-performance Digital Signal Processors (DSPs) to ensure predictable, real-time voice processing. The design enables steamlined packet forwarding. The Cisco AS5300 supports two VFCs that are scalable up to 96 E1 or 120 T1 voice connections within a single chassis.
Previously store-and-forward fax was supported only on modem cards while voice applications ran on the C542 Digital Signal Processing Module (DSPM) and C549 DSPMs that populated Cisco AS5300 VFCs. Each type of call required different technologies. With this software release, a single DSPM technology supports:
•Voice, fax relay, and store-and-forward fax on both the C542 and C549 DSPM and the same voice port.
•Dynamic switching from one application to another in the same call (IVR, voice, fax relay, and store-and-forward fax).
Figure 1 highlights the real-time (T.38 path) versus the store-and-forward processing (T.37 path) for fax transactions over IP networks.
Figure 1 Real-time versus Store-and-Forward Fax Processing
Previously, fax over IP used a proprietary protocol and an H.323 connection, represented by the T.37 path in the diagram. The T.37 path used the Extended Simple Mail Transfer Protocol (ESMTP) store and forward method. The on-ramp gateway router accepted fax data from the PSTN fax machine.
It converted the fax data into a TIFF attachment in a MIME e-mail message and transmitted it to a store and forward SMTP server. These servers would deliver the faxmail message to the off-ramp gateway router. Once the off-ramp gateway router received the faxmail message, it processed the message and initiated a session with the destination fax machine.
With this software release, the T.38 path will take precedence over the T.37 path whenever possible. This means that as a fax session is being set up, the sending gateway will first communicate using the T.38 path. If the communication fails, the sending gateway will rollover to the Cisco T.37 path if it is configured to rollover.
Note It is strongly recommended that the Cisco AS5300 access server packet filters be configured to accept only incoming SMTP connections from trusted mailers (off-ramp gateway).
To configure store-and-forward fax, the VoIP software component must be installed and functional on the Cisco AS5300.
Using Interactive Voice Response for Call Processing
IVR applications control calls in the T.37/T.38 Fax Gateway. They can be assigned to specific ports or invoked based on DNIS and accommodate many gateway services by customizing the presentation of the interfaces to callers.
IVR uses Tool Control Language (TCL) scripts to gather information. For example, a TCL script plays when the caller receives a voice-prompt to enter a specific type of information, such as a PIN. After the caller inputs the PIN, TCL collects the digits and forwards the digits to the server for storage and retrieval.
Note All IVR scripts are modified and secured with a proprietary Cisco locking mechanism. Only Cisco internal technical support personnel can open and modify these scripts.
Benefits
Cost Savings and Port Density
The cost of maintaining two architectures, one for voice and one for fax, is eliminated. Service providers can use a single port for both voice, fax relay, and store-and-forward fax. For smaller POPs, the single-port configuration for both technologies is even more significant because mixed traffic can be handled more efficiently (only a single pool of ports versus splitting traffic across two pools).
Single Number for Voice and Fax Access
Service providers can offer the new service of a single number for subscriber voice and fax access. The applications that use a single number for voice and fax require only half as many DNIS numbers and dial peers as would be required with separate voice and fax applications.
Switch from Fax Relay to Store-and-Forward Fax
Service providers can offer applications that require toggling from voice to fax. Applications such as never-busy fax service can be addressed once the gateway can dynamically switch from fax relay to store-and-forward fax.
Restrictions
The Cisco AS5300 access server must be equipped with 128 MB of Random Access Memory (RAM) in the following situations:
•When a maximum of 120 store-and-forward fax simultaneous sessions is required.
•If IVR Version 2.0 is required.
Related Features and Technologies
Store-and-forward fax and fax relay make use of and are related to the following features and technologies:
•Dial peers
•Destination patterns and prefixes
•Number expansion
•Cisco VoIP
•IVR
•Authentication, Authorization, and Accounting (AAA) security services
•RADIUS security server protocol
Related Documents
For related information on this feature, refer to the following documents:
•New feature documentation for Cisco IOS Release 12.1(1)T, Store and Forward Fax with ESMTP
•New feature documentation for Cisco IOS Release 12.0(3)T Voice over IP for the Cisco AS5300
•Cisco IOS Multiservice Applications Configuration Guide, Release 12.1
•Cisco IOS Multiservice Applications Command Reference, Release 12.1
•Cisco IOS Security Configuration Guide, Release 12.1
•Cisco IOS Security Command Reference, Release 12.1
•Cisco AS5300 Universal Access Server Software Configuration Guide
•Cisco AS5300 Universal Access Server Module Installation Guide
Supported Platforms
•Cisco AS5300
Supported Standards, MIBs, and RFCs
Standards
•ITU-T.37—Procedures for the Transfer of Facsimile Data Via Store-and-forward on the Internet, June 1998
•ITU-T.38—Procedures for Real-time Group 3 Facsimile Communication over IP Networks, June 1998
•ITU-T.38—Procedures for Real-time Group 3 Facsimile Communication over IP Networks, Amendment 1, April 1999
•ITU-T.38—Revised Annex B of Recommendation T.38, November 1998
MIBs
For descriptions of supported MIBs and how to use MIBs, see the Cisco MIB web site on CCO at http://www.cisco.com/public/sw-center/netmgmt/cmtk/mibs.shtml.
RFCs
•RFC 821, Simple Mail Transfer Protocol
•RFC 822, Standard for the Format of ARPA Internet Text Messages
•RFC 1652, SMTP Service Extension for 8bit-MIME Transport
•RFC 1869, SMTP Service Extensions
•RFC 1891, SMTP Service Extension for Delivery Status Notifications
•RFC 1892, The Multipart/Report Content Type for the Reporting of Mail System Administrative Messages
•RFC 1893, Enhanced Mail System Status Codes
•RFC 1894, An Extensible Message Format for Delivery Status Notifications
•RFC 1896, The Text/Enriched MIME Content-Type
•RFC 2034, SMTP Service Extension for Returning Enhanced Error Codes
•RFC 2045, Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies
•RFC 2046, Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types
•RFC 2047, MIME (Multipurpose Internet Mail Extensions) Part Three: Message Header Extensions for Non-ASCII Text
•RFC 2197, SMTP Service Extension for Command Pipelining
•RFC 2298, An Extensible Message Format for Message Disposition Notifications
•RFC 2301, File Format for Internet Fax
•RFC 2302, Tagged Image File Format (TIFF) - Image/TIFF MIME Sub-Type Registration
•RFC 2303, Minimal PSTN Address Format in Internet Mail
•RFC 2304, Minimal Fax Address Format in Internet Mail
•RFC 2305, A Simple Mode of Fax Using Internet Mail
•RFC 2532, Extended Facsimile Using Internet Mail
Store-and-forward fax is also compliant with the SMTP requirements in RFC 1123, Requirements for Internet Hosts—Application and Support.
Prerequisites
Before configuring the T.37/T.38 Fax Gateway on a Cisco AS5300 VFC, the following tasks must be completed:
•Downloading VCWare to the VFC
•Copying Flash Files to the VFC
•Unbundling VCWare
•Configuring the Fax Gateway to Support IVR
These tasks are described in the following sections.
Note Before using SMTP in Cisco gateways, configure the domain name and host hame configured.
VFCs for the Cisco AS5300 come with a single bundled image of VCWare stored in VFC Flash memory. Table 1 shows the extension types defined for these embedded firmware files.
Table 1 VFC Firmware Extensions
Firmware
|
Filenames
|
Description
|
VCWare
|
vcw-vfc-*
|
Latest version of VCWare stores in Flash memory, including:
•Datapath engine
•Message dispatcher
•DSP manager
•VC manager
•Process scheduler
|
DSPWare
|
btl-vfc-*
|
DSP bootloader
|
cor-vfc-*
|
Core operating system and initialization
|
bas-vfc-*
|
Base voice
|
cdc-*-*
|
Voice codec files
|
fax-vfc-*
|
Fax relay files
|
DSPWare is stored as a compressed file within VCWare. VCWare must be unbundled to install DSPWare into Flash memory. During the unbundling process, two default lists (default file and capability) are automatically created, populated with default files from that version of VCWare, and stored in VFC Flash memory. The default file list contains the filenames indicating which files are initially loaded into DSP upon bootup, and the capability list defines the set of codecs that can be negotiated for a voice call.
VFC management enables:
•Adding versions of VCWare to Flash memory (downloads and unbundles files).
•Erasing files contained in Flash memory.
•Adding files to the default file and capability lists.
•Deleting files from the default file lists and capability lists.
These tasks are described in the following sections:
•Downloading VCWare to the VFC
•Copying Flash Files to the VFC
•Unbundling VCWare
•Adding Files to the Default File List
•Adding Codecs to the Capability List
•Deleting Files from VFC Flash Memory
•Erasing the VFC Flash Memory
•Configuring the Fax Gateway to Support IVR
Downloading VCWare to the VFC
Before downloading VCWare to the VFC, determine that the version of VFC ROM Monitor software is compatible with the installed Cisco IOS image. VFC ROM version 1.2 requires Cisco IOS image 0.14.1 (1.6 NA1) or later. VFC ROM Monitor version 1.2 can be made to work with Cisco IOS image 0.13 (or later) by appending the suffix ".VCW" to the VCWare image stored in VFC Flash memory.
These are required tasks:
•Determine the Number of VFCs
•Identify the VFC Mode
•Download the Software in VCWare Mode
•Download the Software in ROM Monitor Mode
Determine the Number of VFCs
To determine the number of installed VFCs and their location, use the following command in privileged EXEC mode:
Command
|
Purpose
|
Router# show vfc slot directory
|
Determines the number of installed VFCs and their location.
|
For each VFC identified and located, upgrade the system software on that VFC.
Identify the VFC Mode
To identify the mode (whether VCWare or ROM Monitor), use the following commands in privileged EXEC mode:
Command
|
Purpose
|
Router# show vfc slot board
|
Determines whether your VFC is operating in VCWare mode or ROM Monitor mode.
|
If the mode is VCWare, the VFC status is "VCWARE running." If the mode is ROM Monitor, the VFC status will be "ROMMON."
Download the Software in VCWare Mode
To download VFC software to the VFC while in VCWare mode, use the following commands beginning in privileged EXEC mode:
| |
Command
|
Purpose
|
Step 1
|
|
Erases the Flash memory.
|
Step 2
|
Router# show vfc slot directory
|
Verifies that the VFC Flash memory is indeed empty.
|
Step 3
|
|
Downloads the VCWare from a TFTP Boot server into VFC Flash memory
or
Downloads the VCWare from the VFC motherboard into VFC Flash memory.
Note The colons in this command are required.
|
Step 4
|
|
Reboots the VFC.
|
Step 5
|
Router# show vfc slot board
|
Checks whether the VFC is back up in VCWare mode.
|
Step 6
|
Router# show vfc slot directory
|
Verifies that VCWare is in the VFC Flash.
|
Step 7
|
Router# unbundle vfc slot
|
Unbundles the DSPWare from the VCWare and configures the default file list and the capability list.
|
Step 8
|
Router# show vfc slot directory
|
Verifies that the DSPWare has been unbundled.
|
Step 9
|
Router# show vfc slot default-list
|
Verifies that the default file list has been populated.
|
Step 10
|
Router# show vfc slot cap-list
|
Verifies that the capability list has been populated.
|
Reboot the Cisco AS5300 for these changes to take effect.
Note If the VFC ROM is version 1.1, the image name must end in ".VCW." If the VFC ROM is version 1.2, the image name must start with "vcv-."
Download the Software in ROM Monitor Mode
To download VFC software while in ROM Monitor mode, use the following commands beginning in privileged EXEC mode:
| |
Command
|
Purpose
|
Step 1
|
Router# clear vfc slot purge
|
Erases the VFC Flash memory.
|
Step 2
|
|
Downloads the VCWare from a TFTP server into VFC Flash memory
or
Downloads the VCWare from the VFC motherboard into VFC Flash memory.
Note The colons in this command are required.
|
Step 3
|
|
Reboots the VFC.
|
Step 4
|
Router# show vfc slot board
|
Checks whether the VFC is back up in VCWare mode.
|
Step 5
|
Router# show vfc slot directory
|
Verifies that VCWare is in the VFC Flash.
|
Step 6
|
Router# unbundle vfc slot
|
Unbundles the DSPWare from the VCWare and configures the default file list and the capability list.
|
Step 7
|
Router# show vfc slot directory
|
Verifies that the DSPWare has been unbundled.
|
Step 8
|
Router# show vfc slot default-list
|
Verifies that the default file list has been populated.
|
Step 9
|
Router# show vfc slot cap-list
|
Verifies that the capability list has been populated.
|
Reboot the Cisco AS5300 for these changes to take effect.
Note The image name must start with "vcw-."
Copying Flash Files to the VFC
Each VFC comes with a single bundled image of VCWare stored in Flash memory. VoIP for the Cisco AS5300 enables two different ways to copy new versions of VCWare to the VFC Flash memory by:
•Downloading from the AS5300 Motherboard
•Downloading from a TFTP Server
Downloading from the AS5300 Motherboard
To download from the AS5300 motherboard to Flash memory, use the following command in privileged EXEC mode:
| |
Command
|
Purpose
|
Step 1
|
|
Downloads (copies) the Flash file from the AS5300 motherboard to the Flash memory on the VFC.
Note The colon in this command is required.
|
Step 2
|
|
Reboots the VFC.
|
Downloading from a TFTP Server
To download the latest version of VCWare from a TFTP server, ensure that the file is stored on the TFTP server. If a copy of the current version of VCWare is resident on disk, store that image on a TFTP server or the file cannot be downloaded into VFC memory. To copy the Flash file from a TFTP server, use the following command in privileged EXEC mode:
| |
Command
|
Purpose
|
Step 1
|
|
Downloads (copies) the Flash file from a TFTP server to the Flash memory on the VFC.
Note The colon in this command is required.
|
Step 2
|
|
Reboots the VFC.
|
Unbundling VCWare
VCWare must be unbundled before DSPWare can be loaded in Flash memory. The default file and capability lists are created and populated with the appropriate default files for that version of DSPWare. Table 1 shows the files associated with each firmware file.
Table 2 VFC Firmware Filenames
Firmware
|
Filenames
|
VCWare
|
vcw-vfc-mz.c542.t1.6
|
DSPWare Initialization and Static Files
|
btl-vfc-l.0.1.bin
btj-vfc-l.0.1.bin
jbc-vfc-1.3.0.bin
cor-vfc-hc-1.3.4.24l.bin
|
DSPWare Overlay Files
|
bas-vfc-hc-1.3.4.24l.bin
fax-vfc-hc-1.3.4.24l.bin
cdc-g711-hc-1.3.4.24l.bin
cdc-g726-hc-l.3.4.24l.bin
cdc-g729-hc-1.3.4.24l.bin
cdc-g728-hc-l.3.4.24l.bin
cdc-g723.1-hc-l.3.4.24l.bin
|
To unbundle the current running image of VCWare, use the following command in privileged EXEC mode:
Command
|
Purpose
|
Router# unbundle vfc slot
|
Unbundles the current image of VCWare.
|
Adding Files to the Default File List
After the VCWare is unbundled, the default file list is automatically created and populated with the default files for that version of VCWare. The default file list indicates which files are initially loaded into DSP at bootup. The following example shows the output from the show vfc def command, which displays the contents of the default file list:
Default List for VFC in slot 1:
Under most circumstances, these default files should be sufficient. If needed, files can be added from those stored in VFC Flash memory to the default file list or existing files replaced from the default file list. When a specific file is added to the default file list, it replaces the existing default for that extension type.
To add a file to the default file list, use the following command in global configuration mode:
Command
|
Purpose
|
Router(config)# default-file filename vfc slot
|
Selects a file stored in the Flash memory to be added to the default file list.
|
Adding Codecs to the Capability List
The capability list defines the set of codecs that can be negotiated for a voice call. Like the default file list, the capability list is created and populated when VCWare is unbundled and DSPWare added to VFC Flash memory. The following example shows the output from the show vfc cap command, which displays the contents of the capability list:
Capability List for VFC in slot 1:
Codec files can be added, using VFC management, if needed for a specific telephony network.
Note The capability list does not indicate codec preference, it only reports available codecs. The session application decides which codec to use.
To add a codec overlay file to the capability list, use the following command in global configuration mode:
Command
|
Purpose
|
Router(config)# cap-list filename vfc slot-number
|
Selects a codec overlay file to be added to the capability list.
|
Deleting Files from VFC Flash Memory
In some instances, a file may need to be deleted from the default file or capability lists. To delete a file from VFC Flash memory, use the following command in privileged EXEC mode:
Command
|
Purpose
|
Router# delete file-name vfc slot
|
Deletes the specified file from VFC Flash memory.
|
Erasing the VFC Flash Memory
When upgrading to a more current version of VCWare, new files are stored in VFC Flash and do not overwrite existing files. The contents of VFC Flash memory must be erased to free memory space. To erase the Flash memory of a specific VFC, use the following command in privileged EXEC mode:
Command
|
Purpose
|
|
Erases the Flash memory on the VFC.
|
For more information about VFC management commands, refer to the Cisco IOS Multiservice Applications Command Reference publication.
Configuring the Fax Gateway to Support IVR
Before configuring the Cisco gateway to support IVR, perform the following:
•Configure VoIP to support H.323-compliant gateways, including specific devices in the network to act as gateways, such as configuring dial peers and voice ports.
•Configure a TFTP server to perform storage and retrieval of the required audio files.
•Download the appropriate classic or TCL IVR script from the CCO Software Support Center. Use the copy command to copy the audio file (.au file) to Flash memory, and the audio-prompt load command to read it into RAM. For more information about copying files into Flash memory, refer to "Copying Flash Files to the VFC" section.
•Ensure that the audio files are in the proper format. The IVR prompts require audio file (.au) format with 8-bit, u-law, and 8-Khz encoding. To encode the audio files, it is recommended that one of these two audio tools (or a similar tool of comparable quality) be used:
–Cool Edit, manufactured by Syntrillium Software Corporation.
–AudioTool, manufactured by Sun Microsystems.
•Ensure that the access platform has a minimum of 16 MB of Flash memory and 64 MB of DRAM.
•Install and configure the appropriate RADIUS security server in the network. The version of RADIUS must be able to support IETF-Supported VSAs, which are implemented by using IETF RADIUS Attribute 26.
Configuration Tasks
The configuration tasks that must be performed are:
•Specifying the Interface Type for Fax Calls
•Configuring IVR Functionality
•Configuring the On-Ramp Gateway
•Configuring the Off-Ramp Gateway
•Configuring the Gateway Security
•Configuring MDN
•Configuring DSN
Specifying the Interface Type for Fax Calls
To select the VFC, use the following command in global configuration mode:
Command
|
Purpose
|
Router(config)# fax interface-type vfc
|
Specifies a VFC. On the Cisco AS5300 access server, the keyword vfc maps to the fax-mail keyword. If you enter the show run command, the fax-mail keyword will display.
|
Configuring IVR Functionality
To configure IVR functionality using either classic or TCL scripts, perform the following:
•Create an application that interacts with the appropriate classic or TCL script. Use show call application voice to view the contents of the TCL IVR script.
•Define and pass the defined parameter values to the application. Depending on the selected TCL script, these values can include the language of the audio file and the location of the audio file. Table 3 lists the required TCL scripts and the parameter values.
•Associate the application to the incoming POTS dial peer.
•Define the appropriate method lists using AAA so that RADIUS is identified as the security protocol performing accounting.
To configure IVR functionality, use the following commands, beginning in privileged EXEC mode:
| |
Command
|
Purpose
|
Step 1
|
Router# configure terminal
|
Enters global configuration mode.
|
Step 2
|
Router(config)# call application voice
application-name location
|
Defines the name to be referenced and indicates the URL of the IVR script to be used.
Note The application-name is a user-defined name which, once defined, is referenced in all other IVR commands except for application used with the on-ramp MMOIP dial peer.
|
Step 3
|
Router(config)# call application voice
application-name language language
|
(Optional) Defines the language of the audio file and passes that information to the application.
|
Step 4
|
Router(config)# call application voice
application-name pin-length number
|
(Optional) Defines the number of PIN characters and passes that information to the application.
|
Step 5
|
Router(config)# call application voice
application-name retry-count number
|
(Optional) Defines the number of times a caller is permitted to reenter the PIN and passes that information to the application.
|
Step 6
|
Router(config)# call application voice
application-name uid-length number
|
(Optional) Defines the number of UID characters and passes that information to the application.
|
Step 7
|
Router(config)# call application voice
application-name set-location language category
location
|
(Optional) Defines the location, language, and category of the audio files and passes that information to the application.
|
Step 8
|
Router(config)# aaa new-model
|
Enables AAA security and accounting services.
|
Step 9
|
Router(config)# gw-accounting h323
|
Enables gateway-specific H.323 accounting.
|
Step 10
|
Router(config)# aaa authentication login h323
radius
|
Defines a method list called h323 where RADIUS is defined as the only method of login authentication.
|
Step 11
|
Router(config)# aaa accounting connection h323
start-stop radius
|
Defines a method list called h323 where RADIUS is used to perform connection accounting, providing start-stop records.
|
Step 12
|
Router(config)# radius-server host ip-address
auth-port number acct-port number
|
Identifies the RADIUS server and the ports that will be used for authentication and accounting services.
|
Step 13
|
Router(config)# radius-server key key
|
Specifies the password used between the gateway and the RADIUS server.
|
Step 14
|
Router(config)# dial peer voice number pots
|
Changes mode to dial peer configuration.
|
Step 15
|
Router(config-dial-peer)# port port number
|
Defines the voice port associated with the POTS dial peer.
|
Step 16
|
Router(config-dial-peer)# ctrl + z
|
Exits to privileged EXEC mode.
|
Table 3 lists the required TCL scripts for fax applications on VFCs.
Table 3 Required TCL Scripts for VFCs
TCL Script Name
|
Description —Summary
|
Commands to Configure
|
app_libretto_onramp9.tcl
|
Authenticates the account and PIN using the following: prompt-user, ANI, DNIS, gateway ID, redialer ID, and redialer DNIS.
|
None
|
app_libretto_offramp5.tcl
|
Authenticates the account and PIN using the following: envelope-from, envelope-to, gateway ID, and x-account ID.
|
None
|
fax_rollover_on_busy.tcl
|
Used for on-ramp T.38 fax rollover to T.37 fax when the destination fax line is busy.
|
voice hunt user-busy
|
Use the following commands to verify the IVR configuration:
•Show running configuration - verifies the configuration parameters.
•Show call application summary - displays a list of all voice applications.
•Show call application voice - shows the contents of the script.
•Show dial-peer voice - verifies that dial peer is operational.
Configuring the On-Ramp Gateway
When acting as the on-ramp gateway, the Cisco AS5300 receives faxes from end users, converts them into TIFF files, creates standard MIME e-mail messages, attaches the TIFF files to the e-mail messages, and forwards the fax-mail messages to the designated SMTP server for storage.
The gateway uses the sending MTA and dial peers to complete these tasks. The sending MTA, which is the Cisco AS5300, defines delivery parameters associated with the e-mail message to which the fax TIFF file is attached. The delivery parameters include defining a return e-mail path or designating a destination mail server.
Note Before using SMTP in Cisco gateways, be sure to configure the domain name and host name.
To configure the on-ramp gateway, perform the tasks described in the following sections:
•Configuring the Called Subscriber Number
•Configuring the Sending MTA
•Configuring the POTS Dial Peer
•Configuring the MMoIP Dial Peer
•Verifying the On-Ramp Gateway Configuration
•Verifying the On-Ramp Gateway Configuration
Configuring the Called Subscriber Number
The called subscriber number is the number displayed in the LCD of the fax device when a fax is sent to a recipient. Typically, with a standard Group 3 fax device, this is the telephone number associated with the receiving fax device. To configure the called subscriber number, use the following commands beginning in privileged EXEC mode:
| |
Command
|
Purpose
|
Step 1
|
Router# configure terminal
|
Enters global configuration mode.
|
Step 2
|
Router(config)# fax receive called-subscriber
{$d$|string}
|
Defines the number that is displayed in the LCD of the sending fax machine. This parameter defines the called subscriber identification (CSI).
|
Configuring the Sending MTA
MTAs define the elements of the e-mail message to which the fax TIFF file is attached, which includes:
•Originator
•Subject of the message
•Destination mail server
•Return path
•Postmaster (default mail station for undeliverable messages)
•E-mail header information
•Address to which any disposition notices are sent
Note The mta send mail-from username and mta send mail-from hostname commands configure the From: username. The To: address is configured with session target and is the on-ramp gateway MMoIP dial peer.
To configure the sending MTA, use the following commands in global configuration mode:
| |
Command
|
Purpose
|
Step 1
|
Router(config)# mta send mail-from hostname
string
|
Specifies the originator (host name) of the e-mail fax message. This information appears in the RFC 822 From: field and the RFC 821 MAIL FROM field of the e-mail fax message. This information is also used for generating DSNs.
When the mta send mail-from hostname command is configured, the configured host name is used with the mta send mail-from username command to form a complete e-mail address, like faxuser@onramp-gateway.com.
|
Step 2
|
Router(config)# mta send mail-from {username
string | username $s$}
|
Specifies the originator (username portion) of the e-mail fax message. This information appears in the RFC 822 From: field and the RFC 821 MAIL FROM field of the e-mail fax message. This information is also used for generating DSNs.
When the mta send mail-from username command is configured, the configured username is used with the mta send mail-from hostname command to form a complete e-mail address, like faxuser@onramp-gateway.com.
|
Step 3
|
Router(config)# mta send server {host-name |
IP-address}
|
Specifies the destination server.
DNS MX records are not used to determine the IP address of the host specified with the mta send server command.
|
Step 4
|
Router(config)# mta send subject string
|
Defines the text that appears in the Subject field of the e-mail fax message.
|
Step 5
|
Router(config)# mta send postmaster
e-mail-address
|
Defines address to be used as the mta send mail-from address if the evaluated string is blank. An address such as fax-administrator@example.com is recommended (where company.com is replaced with the domain name, and fax-administrator is aliased to the person responsible for the operation of the Cisco AS5300 fax functions).
At some sites this may be the same person as the e-mail postmaster, but at most sites this is likely to be a different person.
|
Step 6
|
Router(config)# mta send origin-prefix string
|
(Optional) Defines additional identifying information to be prepended to the e-mail header.
|
Step 7
|
Router(config)# mta send return-receipt-to
{hostname string username string}
|
(Optional) Specifies the address where MDNs are sent.
|
Configuring the POTS Dial Peer
To configure the POTS dial peer, use the following commands beginning in global configuration mode:
| |
Command
|
Purpose
|
Step 1
|
Router(config)# dial-peer voice number pots
|
Defines the POTS dial peer tag number and enters dial-peer configuration mode.
|
Step 2
|
Router(config-dial-peer)# application name
|
Associates a specific IVR application with this dial peer. The out-bound keyword is not used with the POTS dial peers, but is used in the MMoIP dial peer configuration.
|
Step 3
|
Router(config-dial-peer)# information-type fax
|
Identifies calls associated with this dial peer as being fax transmissions, as opposed to being voice calls.
|
Step 4
|
Router(config-dial-peer)# direct-inward-dial
|
(Optional) Specifies DID. If you are not using a redialer, you must enable DID to use store-and-forward fax.
|
Step 5
|
Router(config-dial-peer)# incoming called-number
string
|
Defines the telephone number associated with the POTS dial peer—in store-and-forward fax, if DID is enabled, the incoming called number (DNIS number) is used to match the destination pattern of outgoing MMoIP dial peers.
|
Step 6
|
Router(config-dial-peer)# max-conn number
|
(Optional) Defines the maximum number of on-ramp connections used simultaneously on this Cisco AS5300 to send fax-mail.
|
Step 7
|
Router(config-dial-peer)# exit
|
Exits dial-peer configuration mode.
|
Configuring the MMoIP Dial Peer
To configure the MMoIP dial peer, use the following commands beginning in global configuration mode:
| |
Command
|
Purpose
|
Step 1
|
Router(config)# dial-peer voice number mmoip
|
Defines the MMoIP dial peer tag number and enters dial-peer configuration mode.
|
Step 2
|
Router(config-dial-peer)# application name
[out-bound]
|
Associates a specific IVR application with this dial peer. If the out-bound keyword is used, the named application will handle the MMOIP dial peer in the outgoing mode.
|
Step 3
|
Router(config-dial-peer)# destination-pattern
[+]string
|
Identifies the destination fax telephone number. If DNIS has been enabled, this number should be the same as the configured incoming called number. If DNIS is not enabled, this should be the number from the redialer DNIS.
|
Step 4
|
Router(config-dial-peer)# session target
{mailto:{name | $d$}@domain-name |
ipv4:destination-address | dns:[$s$. | $d$. |
$u$. | $e$.] host-name| loopback:rtp
|loopback:compressed | loopback:uncompressed}
|
Defines the destination e-mail address for the fax-mail, meaning the e-mail address identifying the SMTP server.
|
Step 5
|
Router(config-dial-peer)# session protocol smtp
|
Identifies the session protocol being used between the on-ramp gateway and the remote mail server as SMTP.
|
|
