You are on page 1of 64

V7350

IP Messaging
Installation Guide

3Com Convergence Application Suite


IP Messaging Module Release 5.2
System Release 5.2

Part Number 900-0242-01 Rev AB


Published January 2005
http://www.3com.com/

3Com Corporation
350 Campus Drive
Marlborough, MA
01752-3064

Copyright 20022005, 3Com Corporation. All rights reserved. No part of this documentation may be
reproduced in any form or by any means or used to make any derivative work (such as translation,
transformation, or adaptation) without written permission from 3Com Corporation.
3Com Corporation reserves the right to revise this documentation and to make changes in content from
time to time without obligation on the part of 3Com Corporation to provide notification of such revision
or change.
3Com Corporation provides this documentation without warranty, term, or condition of any kind, either
implied or expressed, including, but not limited to, the implied warranties, terms, or conditions of
merchantability, satisfactory quality, and fitness for a particular purpose. 3Com may make improvements
or changes in the product(s) and/or the program(s) described in this documentation at any time.
If there is any software on removable media described in this documentation, it is furnished under a
license agreement included with the product as a separate document, in the hardcopy documentation, or
on the removable media in a directory file named LICENSE.TXT or !LICENSE.TXT. If you are unable to
locate a copy, please contact 3Com and a copy will be provided to you.
UNITED STATES GOVERNMENT LEGENDS:
If you are a United States government agency, then this documentation and the software described herein
are provided to you subject to the following:
United States Government Legend: All technical data and computer software is commercial in nature
and developed solely at private expense. Software is delivered as Commercial Computer Software as
defined in DFARS 252.227-7014 (June 1995) or as a commercial item as defined in FAR 2.101(a) and as
such is provided with only such rights as are provided in 3Coms standard commercial license for the
Software. Technical data is provided with limited rights only as provided in DFAR 252.227-7015 (Nov
1995) or FAR 52.227-14 (June 1987), whichever is applicable. You agree not to remove or deface any
portion of any legend provided on any licensed program or documentation contained in, or delivered to
you in conjunction with guide.
Unless otherwise indicated, 3Com registered trademarks are registered in the United States and may or
may not be registered in other countries.
3Com and the 3Com logo are registered trademarks of 3Com Corporation. VCX is a trademark of 3Com
Corporation.
Other brand and product names may be registered trademarks or trademarks of their respective holders.

CONTENTS
ABOUT THIS GUIDE
Conventions 7
Notices 7
Text 8
Figures 8
Related Documentation
Comments 10

OVERVIEW AND REQUIREMENTS


Software Overview and Requirements 12
Hardware Requirements 12
Compact Server Requirements 12
Mid-Sized Server Requirements 13
Premium Server Requirements 13
Common Server Network Requirements
IP Messaging Architecture 14
System Configurations 15
Small Systems 15
Mid-Sized Systems 16
IP Messaging System 16
Network Configurations 16
Single Pair of Servers 17
Two Pairs of Servers 17

14

IP MESSAGING MODULE CONFIGURATION


Configuration Overview 20
Configuration Requirements - Two Servers 20
Configuration Requirements - Four Servers 21
Configuring IP Messaging on a Standalone Server 21
Configuring the IP Messaging Management Server 25
Configuring the IP Messaging Client 27

Examining the hosts File 29


Upgrading or Downgrading an IP Messaging Configuration

30

PROCESS AND APPLICATION MONITORS


Accessing the Process Monitor and Application Utilities 32
Attaching to the Process Monitor 33
Determine if IP Messaging is Running 35
Starting and Stopping the Application Utility 36
Start and Stop the Process Monitor and Application Utilities from the
Command Line 37

IP MESSAGING BACKUP AND RESTORE


Backing Up IP Messaging Data 40
Scheduling Regular IP Messaging Backups
Restoring IP Messaging Data 41

41

INSTALLING OPTIONAL VOICE PROMPTS LANGUAGES AND


CODECS
Voice Prompt Overview 44
Installing a Set of Language Prompts 44
Downloading Language Prompts 45
Codec Overview 45
Changing Codecs 47
Converting Prompts and Messages to a Different Codec

CONFIGURING TEXT-TO-SPEECH
Text-To-Speech Overview 52
E-Mail Reader Requirements 53
Configuring IP Messaging to Support TTS 54
Installing and Uninstalling the E-Mail Reader TTS Adapter
Configuring the E-Mail Reader TTS Adapter 56

48

CONFIGURING A PRINTER
Printer Configuration Overview
Adding a Printer 60

60

55

INDEX

ABOUT THIS GUIDE

This guide describes how to install IP Messaging Module software. The IP


Messaging Module is a component of the 3Com 3Com Convergence
Applications Suite.
This guide is intended for network operations, internal support, and Voice
over Internet Protocol (VoIP) systems planning personnel. The users of this
document should have a thorough knowledge of telecommunications, IP
telephony technology, and networks.
Release Notes are issued with some products. If the information in the
release notes differs from the information in this guide, follow the
instructions in the release notes.

Conventions

This section describes notice, text, and figure conventions.


Notices

Table 1 lists notice icons.


Table 1 Notice Icon Descriptions
Icon

Notice Type

Description

Information note

Information that describes important features or


instructions

Caution

Information that alerts you to potential loss of data


or potential damage to an application, system, or
device

Warning

Information that alerts you to potential personal


injury

ABOUT THIS GUIDE

Text

Table 2 lists text conventions.


Table 2 Text Convention Descriptions
Convention

Description

Screen displays

This typeface represents information as it appears on


the screen.

Syntax

The word syntax means that you must evaluate the


syntax provided and then supply the appropriate
values for the placeholders that appear in angle
brackets. Example:
To enable RIPIP, use the following syntax:
SETDefault !<port> -RIPIP CONTrol =
Listen
In this example, you must supply a port number for
<port>.

Commands

The word command means that you must enter the


command exactly as shown and then press Return or
Enter. Commands appear in bold. Example:
To remove the IP address, enter the following
command:
SETDefault !0 -IP NETaddr = 0.0.0.0

The words enter


and type

When you see the word enter in this guide, you


must type something, and then press Return or Enter.
Do not press Return or Enter when an instruction
simply says type.

Keyboard key names

If you must press two or more keys simultaneously,


the key names are linked with a plus sign (+). Example:
Press Ctrl+Alt+Del

Words in italics

Italics are used to:

Emphasize a point.
Denote a new term at the place where it is defined
in the text.
Identify menu names, menu commands, and
software button names. Examples:
From the Help menu, select Contents.
Click OK.

Figures

This guide provides figures and screen captures that contain sample data.
This data may vary from the data on an installed system.

Related Documentation

Related
Documentation

These 3Com documents contain additional information about the


products in this release that are a part of or support the VCX V7000 IP
Telephony Solution and the 3Com Convergence Application Suite.
The following documents are a part of the VCX V7000 IP Telephony
Solution:

VCX Installation and Maintenance Guide

VCX Administration Guide

VCX Business Telephone Quick Reference Guide

VCX Basic Telephone Quick Reference Guide

V7000 Telephone Guide

VCX Security Guide

The following documents are a part of the 3Com Convergence


Application Suite:

V7350 IP Messaging Suite Product Overview

V7350 IP Messaging Suite Installation Guide

V7350 IP Messaging - 3Com Native Interface AT - A - GLANCE

V7350 IP Messaging Suite User Guide - 3Com Native Interface

V7350 IP Messaging - Traditional Interface AT - A - GLANCE

V7350 IP Messaging Suite User Guide - Traditional Interface

V7350 IP Messaging Suite Operations and System Administration


Guide

3Com E-Mail Reader Application ReadMe

V7350 IP Messaging Suite Intelligent Mirroring Guide

IP Conferencing Module Installation Guide

IP Conferencing Module User and Administration Guide

Convergence Center Client User and Administration Guide

The following documents provide information on products that support


this release:

Enterprise Management Suite User Guide, Version 2.0

VCX V7111 Fast Track Installation Guide

10

ABOUT THIS GUIDE

Comments

VCX V7111 VoIP SIP Gateways User Manual

VCX V7122 Gateway Fast Track Installation Guide

VCX V7122 VoIP SIP Gateways User Manual

Send e-mail comments about this guide or about any Voice product
documentation to:
VOICE_Techpubs_comments@3com.com

Include the following information with your comments:

Document title

Document part number (found on the front page)

Page number

Your name and organization (optional)

Example:
VCX V7350 IP Messaging Installation Guide
System Release 5.2
Part Number 900-0242-01 Rev AA
Page 25
Please address all questions regarding the 3Com software to your
authorized 3Com representative.

OVERVIEW AND REQUIREMENTS

This chapter describes the IP Messaging Module pre-installation


requirements. You must ensure that these requirements are completed
before installing IP Messaging software.
This chapter contains the following information:

Software Overview and Requirements

Hardware Requirements

System Configurations

Network Configurations

12

CHAPTER 1: OVERVIEW AND REQUIREMENTS

Software Overview
and Requirements

IP Messaging is a component of the 3Com Convergence Applications


Suite. This suite is itself a component of the 3Com VCX V7300 IP
Telephony Applications Suite (VCX).
VCX is assembled from independent components, which are designed to
work with each other over the network. For example, the operating
system (VCX Linux), VCX applications (such as IP Messaging and the Call
Processor), and configuration databases, are all components of VCX.
A VCX assembly, as defined by a VCX Software Bill of Materials (VSBOM)
configuration file, is constructed from a specified version of each
component. A script is run to perform the assembly using the VSBOM as
input. Each component is constructed as an RPM Package Manager
package, and is installed by the script in a version-specific location.
For Release 5.2, each VCX system ships with a working version of all
required software pre-installed by 3Com Corporation. When the system is
initially started at the target site, an interactive script runs to provision the
system with networking details. Consequently, the system is ready to
provide a default level of service. Further configuration customizes the
system according to site-specific requirements. For more information,
refer to the VCX Installation and Maintenance Guide.
IP Messaging can support Text-To-Speech (TTS). TTS enables the
conversion of text into speech. For example, if a voice mailbox is
configured to receive e-mail messages, when the subscriber accesses the
mailbox through a SIP-enabled telephone, the TTS engine speaks the
contents of the e-mail message. TTS support requires the 3Com E-Mail
Reader application, which must be installed on a Windows system. See
Chapter 6 for more information.

Hardware
Requirements

Compact Server
Requirements

VCX Release 5.2 software, including IP Messaging, can be installed on


three server configurations: compact server, mid-sized server, and
premium server.
A compact server has the following requirements:

Processor Single Pentium 4 or higher

Memory 2 GB

Hardware Requirements

Mid-Sized Server
Requirements

Hard Disk 40 GB (supports 30 minutes of voice mail (using the


G.711 codec) and 6 MB of e-mail for each subscriber)

Network Interface Card 10/100BASE-T

Power supply units Single

CD-ROM drive

A mid-sized server configuration has the following requirements:

Processor Single Pentium 4 or higher, with dual- or multi-processor


capability

Memory 2 GB

Hard Disk 40 GB (supports 30 minutes of voice mail (using the


G.711 codec) and 6 MB of e-mail for each subscriber)

Network Interface Card 10/100BASE-T

Power supply units Redundant pairs required


AC power with enough outlets is required to support the system:
100-240VAC, 47-63 Hz; 7.6A at 110V. The minimum number of
outlets is two for each server and four normal AC outlets for a
monitor, network hubs, and other items. Inform 3Com whether
outlets are on the floor or the ceiling.
If DC power is necessary, contact 3Com for specifications.

Premium Server
Requirements

13

Redundant Array of Independent Disks Server must be


RAID-capable

CD-ROM drive

A premium server configuration has the following requirements:

Processor Dual Pentium 4 or higher

Memory 4 GB

Hard Disk 80 GB (supports 30 minutes of voice mail (using the


G.711 codec) and 6 MB of e-mail for each subscriber)

Network Interface Card 10/100BASE-T

Power supply units Redundant pairs required


AC power with enough outlets is required to support the system:
100-240VAC, 47-63 Hz; 7.6A at 110V. The minimum number of
outlets is two for each server and four normal AC outlets for a

14

CHAPTER 1: OVERVIEW AND REQUIREMENTS

monitor, network hubs, and other items. Inform 3Com whether


outlets are on the floor or the ceiling.
If DC power is necessary, contact 3Com for specifications.

Common Server
Network
Requirements

IP Messaging
Architecture

Redundant Array of Independent Disks Server must be


RAID-capable

CD-ROM drive

A server name and static IP address are required for each server. The
installation technician must have the DNS and subnet mask information.
E-mail support requires a mail server, gateway, SMTP, and default router
information.

IP Messaging is based on the Media Management Unit (MMU) and Media


Service Unit (MSU) computing platforms. These platforms are
implemented on single or multiprocessor servers that run the VCX Linux
operating system.

MMUs are management servers whose primary function is to maintain


application, subscriber profile, and subscriber mailbox data. Mailbox
data is voice, facsimile, and e-mail messages for subscribers. In a
typical deployment, there are two MMUs that operate in active or hot
standby mode. Multiple pairs of management servers can be
deployed; each pair serves a group of subscribers. MMUs provide
centralized operations such as notification, Short Message Service
(SMS), Wireless Application Protocol (WAP), web services, alarms,
reports, and billing.

MSUs provide the application, call control, and voice resource


functions that implement service logic. UMS supports multiple sets of
MSU clusters that are geographically dispersed and connected to
switches or IP gateways. The number of MSUs in a cluster depends on
the required density (number of ports). The number of voice ports
supported on each MSU depends on the computing platform
(described in System Configurations).
MSUs support the Session Initiation Protocol (SIP) on each platform;
MSUs also provide functions such as Text-to-Speech and automatic
voice recognition.

During IP Messaging configuration, you can select the type of IP


Messaging system you want to set up: standalone, client, or server.

System Configurations

15

A client IP Messaging configuration creates an MSU. You must also


configure a IP Messaging server (MMU) on a separate Linux server.

A server IP Messaging configuration creates an MMU. You must also


configure a IP Messaging client on a separate Linux server.

A standalone configuration combines the MSU (client) and MMU


(server) functions in a single IP Messaging system.

Standalone and server IP Messaging configurations must be mirrored on


separate servers. A client IP Messaging configuration cannot be mirrored.
Refer to the V7350 IP Messaging Intelligent Mirroring Guide for more
information.

System
Configurations

Small Systems

IP Messaging can be installed in different system configurations according


to the features required and the number of subscribers that must be
supported. The system configuration determines which server
configuration is required.
VCX Release 5.2 software can support the following two small system
configurations:

Redundant system for small branch offices 200 telephone


subscribers

All VCX components, including IP Messaging, run on one compact


system (two redundant, compact servers). IP Messaging is optional
in this system.
Supports 200 subscribers, all with voice mail functionality.
Supports 800 subscribers for non-voice mail traffic (BHCA) and 35
subscribers with simultaneous voice mail access during the busy
hour.

Redundant system for large branch offices 500 telephone


subscribers

All VCX components, including IP Messaging, run on one


mid-sized system (two redundant, mid-sized servers). IP Messaging
is optional in this system.
Supports 500 subscribers, all with voice mail functionality.
Supports 2,000 subscribers for non-voice mail traffic (BHCA) and
83 subscribers with simultaneous voice mail access during the busy
hour.

16

CHAPTER 1: OVERVIEW AND REQUIREMENTS

Mid-Sized Systems

VCX Release 5.2 software can support the following two mid-sized
system configurations:

Redundant system for branch offices 1,500 telephone subscribers

Supports 3,600 subscribers for non-voice mail traffic (BHCA) and


125 subscribers with simultaneous voice mail access during the
busy hour.

VCX components, except IP Messaging, run on one premium


system (two redundant, premium servers). IP Messaging is optional
but if installed, runs on a second pair of redundant, mid-sized
servers.
Supports 5,000 subscribers, all with voice mail functionality.
Supports 12,000 subscribers for non-voice mail traffic (BHCA) and
240 subscribers with simultaneous voice mail access during the
busy hour.

VCX Release 5.2 software can support the following IP Messaging system
configuration:

Redundant system for large branch offices 1,500 telephone


subscribers

IP Messaging runs on a pair of redundant, mid-sized servers.

Supports 1,500 subscribers, all with voice mail functionality.

Network
Configurations

Supports 1,500 subscribers, all with voice mail functionality.

Redundant system for large branch offices 5,000 telephone


subscribers

IP Messaging System

VCX components, except IP Messaging, run on one mid-sized


system (two redundant, mid-sized servers). IP Messaging is optional
but if installed, runs on a second pair of redundant, mid-sized
servers.

Supports 125 subscribers with simultaneous voice mail access


during the busy hour.

This section describes two possible network configuration options for a


VCX/IP Messaging system.

With the first option, VCX software and IP Messaging software are
each installed on a single pair of servers.

Network Configurations

17

With the second option, VCX software is installed on one pair of


servers and IP Messaging software is installed on a second pair of
servers.

In both cases, IP Messaging is installed in a standalone configuration and


the IP Messaging servers are mirrored. See IP Messaging Architecture.
Also refer to the VCX Installation and Maintenance Guide and the V7350
Unified Messaging Suite Intelligent Mirroring Guide for more information
on installing VCX software and IP Messaging Intelligent Mirroring.
Single Pair of Servers

Figure 1 shows VCX software and IP Messaging (IPM in the figure)


software are installed on a primary server and also installed on a
secondary server. For IP Messaging, one server is in an active state and is
mirrored by the second server, which is running in a standby state.
Figure 1 VCX and IP Messaging Installed on a Single Pair of Servers

Primary Server

Secondary Server

IPM - eth0

eth0 - IPM

VCX - eth1

eth1 - VCX

Network
Note that each server includes two Network Interface Cards (NICs), eth0
and eth1. IP Messaging is configured to use eth0 on each server, while
VCX is configured to use eth1.
Two Pairs of Servers

Figure 2 shows VCX software installed on one pair of servers and IP


Messaging software installed on a second pair of servers. For IP
Messaging, one server is in an active state and is mirrored by the second
server, which is running in a standby state.

18

CHAPTER 1: OVERVIEW AND REQUIREMENTS

Figure 2 VCX Installed on One Pair of Servers, IP Messaging Installed on a


Second Pair

Primary
VCX Server

Secondary
VCX Server

eth0

eth0

eth1

eth1

Primary
IPM Server

Secondary
IPM Server
eth0

eth0

eth1

eth1

Network
As in Figure 1, each server includes two NICs, eth0 and eth1. For the VCX
and IP Messaging server pairs, both NICs on each server can be
connected to the network.

IP MESSAGING MODULE
CONFIGURATION

This chapter describes how to configure the IP Messaging Module


software.
For Release 5.2, each VCX system ships with a working version of
software pre-installed by 3Com Corporation. When the system is initially
started, an interactive script runs to provision the system with IP
Messaging configuration details.
This chapter contains the following information:

Configuration Overview

Configuring IP Messaging on a Standalone Server

Configuring the IP Messaging Management Server

Configuring the IP Messaging Client

Examining the hosts File

Upgrading or Downgrading an IP Messaging Configuration

Before you install IP Messaging, make sure you have installed all the
required hardware and software; see Chapter 1.
When you have finished the IP Messaging installation, refer to the V7350
IP Messaging Operations and System Administration Guide to set up IP
Messaging for your environment.

20

CHAPTER 2: IP MESSAGING MODULE CONFIGURATION

Configuration
Overview

When you first start a VCX V7000 server, first boot scripts run
automatically for each installed VCX component, including IP Messaging.
Each script asks questions and configures the component based on your
answers.
For new installations, the IP Messaging first boot script prompts you to
select one of three possible system configurations (described in
Chapter 1):

Configuring IP Messaging on a Standalone Server

Configuring the IP Messaging Management Server

Configuring the IP Messaging Client

If you are upgrading an existing version of IP Messaging, see Upgrading


or Downgrading an IP Messaging Configuration.
Bold text indicates values that you must type. Press Enter after each
entry.
Configuration
Requirements - Two
Servers

IP Messaging software can run in a two server configuration. In this case,


IP Messaging software and VCX software run on each server (see Single
Pair of Servers). In this environment, Intelligent Mirroring must be
configured for IP Messaging.
To configure the two servers and Intelligent Mirroring, you should have
the following information available to complete the IP Messaging first
boot script:

Primary server host name

Primary server IP address (static) for the eth0 interface Used by IP


Messaging.

Primary server IP address (static) for the eth1 interface Used by


VCX.

Secondary server host name

Secondary server IP address (static) for the eth0 interface Used by IP


Messaging.

Secondary server IP address (static) for the eth1 interface Used by


VCX.

Configuring IP Messaging on a Standalone Server

Configuration
Requirements - Four
Servers

21

IP Messaging software can also run in a four server configuration. In this


case, IP Messaging software and VCX software run on a separate pair of
servers (see Two Pairs of Servers). In this environment, Intelligent
Mirroring must be configured for the two IP Messaging servers.
To configure the two IP Messaging servers and Intelligent Mirroring, you
should have the following information available to complete the IP
Messaging first boot script:

Configuring IP
Messaging on a
Standalone Server

Primary VCX server IP address (static) for the eth1 interface

Secondary VCX server IP address (static) for the eth1 interface

Primary IP Messaging server host name

Primary IP Messaging server IP address (static) for the eth0 interface

Secondary IP Messaging server host name

Secondary IP Messaging server IP address (static) for the eth0 interface

This section describes how to enable a IP Messaging standalone


configuration. A standalone configuration combines the MSU (client) and
MMU (server) functions in a single IP Messaging system.
If you are installing an Intelligent Mirroring configuration and a version of
IP Messaging is already running on any of the machines in the
configuration, you must stop the IP Messaging processes. See Chapter 3.
For Intelligent Mirroring configurations, /etc/hosts on all machines
(servers and standalones) should be identical and should contain entries
for all the machines on the network as well as the Spoof name and
address by which the servers will be collectively known.
Refer to the V7350 Unified Messaging Suite Intelligent Mirroring Guide.
Default or recommended answers are in [brackets].
The following first boot script shows the steps required to configure a IP
Messaging standalone server.
1 Select the type of IP Messaging system you want to configure, in this
case, standalone:
Type of 3Com IP Messaging Installation
(S-Standalone/C-Client/V-Server)? [S]

22

CHAPTER 2: IP MESSAGING MODULE CONFIGURATION

To configure IP Messaging as a standalone system (both server and


client on one Linux server), enter s.
To configure a client (requires that a server be configured on
another Linux server), enter c. For client configuration instructions,
see Configuring the IP Messaging Client.
To configure a server (requires that a client be configured on
another Linux server), enter v. For server configuration instructions,
see Configuring the IP Messaging Management Server.

2 Press Enter to accept the default number (144) of VOIP ports the system
will support. Do not enter a different value without consulting 3Com.
Number of voip ports? [144]

3 Enter the IP address of the Call Processor:


IP address of the outbound proxy? [0.0.0.0]

The Call Processor uses the IP address of eth1 on the server hosting VCX
software.
4 Enter the IP address of the SIP DDD:
Name of the SIP DDD?

[call_processor_ip]

If the Call Processor functions all reside on one Call Processor, press
Enter to accept the default. The default is the IP address you
entered in step 3.
If the default dialing domain (DDD) functions reside on a different
Proxy, enter the IP address of the default dialing domain server.

5 Enter the TCP or UDP port on which the VCX 7300 server will receive SIP
packets:
TCP/UDP Port on which the 3Com IP Messaging will receive SIP
messages [5060]

To accept the default port (5060), press Enter. Note the following
considerations:

If the VCX Call Processor and IP Messaging reside on the same


system and do not share a IP address (there are two interfaces),
they can use the same port number, 5060.
If this is a IP Messaging-only system, accept the default port
number, 5060.
If the VCX Call Processor and IP Messaging reside on the same
system and share a single IP address, they cannot use the same

Configuring IP Messaging on a Standalone Server

23

port number. In this case, enter 5065 as the port number for IP
Messaging; the Call Processor should use port 5060.
6 Enter the IP address of the backup Call Processor:
IP address of the secondary proxy? (hit Enter if none) [

If there is no secondary Call Processor press Enter to accept the


default.
If there is a secondary Call Processor, enter the IP address for eth1
on the secondary VCX server.

7 Specify whether or not you want to enable and identify a Text-To-Speech


server:
Enable Text to Speech (y/n)? [n]

TTS enables IP Messaging to convert text into speech. TTS capability is


provided by the 3Com E-Mail Reader application. This application is
shipped on a CD and must be installed on a Windows server. See
Chapter 6 for information.

If you want to enable TTS, enter y.

If you do not want to enable TTS, enter n.

If enabled, the IP Messaging first boot script presents the following subset
of TTS questions.
a

Enter TTS Server Addresses (press ENTER when done)?


TTS Server 1: nnn.nnn.nnn.nnn
TTS Server 2:

Enter the IP address of the Windows server on which E-Mail Reader


application is installed and press Enter. The first boot script prompts
you for the next IP address. You can enter up to 10 IP addresses (server
locations). When you are finished entering TTS server IP addresses,
press Enter to move to the next prompt.
b TTS Server Port [1722]?

Enter the port number IP Messaging should use when communicating


with the TTS Windows server. TTS address information is written to
the /usr/app/app.dir/config.app configuration file. You can add to or
modify information in this file after the first boot script completes. See
Configuring IP Messaging to Support TTS.
If you change the default TTS server port number (1722), you must
use the same value when you configure the TSS adapter. See
Configuring the E-Mail Reader TTS Adapter.

24

CHAPTER 2: IP MESSAGING MODULE CONFIGURATION

8 Specify whether or not you want to enable mirroring. Mirroring is


required for standalone systems. Refer to the V7350 Unified Messaging
Suite Intelligent Mirroring Guide.
Should Intelligent Mirroring be enabled (Y/N)?

To enable intelligent mirroring, enter y.

To disable intelligent monitoring, enter n.

[Y]:

If enabled, IP Messaging presents the following subset of mirroring


questions.
a

Name of the Remote Intelligent Mirrored System? :

Enter the name of the IP Messaging server that will mirror this server.
b IP Address for <remote_system_name> [ ]? :
Enter the IP address assigned to eth0 (the IP Messaging interface) on
the remote, mirrored system.
c

Is this host the primary or the secondary (P/S)? [P] :

If this system is the primary IP Messaging server, enter P.

If this system is the secondary IP Messaging server, enter S.

9 IP Messaging displays the IP address assigned to eth0 on this server.


IP Address for Server <system_name> [ip_address]? :

If this address is correct, press Enter. If the address is incorrect (or no


address is displayed), enter the IP address assigned to eth0.
10 Enter the customers name:
Enter the Customer name? [customer] :

Although not required, you can enter a customer name (maximum of 8


characters).
11 Specify whether you would like to view and edit the file that contains the
configuration data you have entered in steps 1 through 10:
Would you like to edit the file containing your selections
(Y/N)? [N]:

To edit current selections, enter y. Note that entering y opens the


configuration file in the vi editor. It does not restart the first boot
script.
To accept your selections without changing the selection file, enter
n.

Configuring the IP Messaging Management Server

25

The installation script verifies that the system prerequisites are met and
then continues the installation.
Status and success messages are printed to the screen during installation.

Configuring the IP
Messaging
Management
Server

This section describes how to enable a IP Messaging management server.


This IP Messaging configuration creates an MMU. You must also
configure a IP Messaging client (MSU) on a separate Linux server.
If you are installing an Intelligent Mirroring configuration and a version of
IP Messaging is already running on any of the machines in the
configuration, you must stop the IP Messaging processes. See Chapter 3.
For Intelligent Mirroring configurations, /etc/hosts on all machines
(servers and standalones) should be identical and should contain entries
for all the machines on the network as well as the Spoof name and
address by which the servers will be collectively known.
Refer to the V7350 Unified Messaging Suite Intelligent Mirroring Guide.
Default or recommended answers are in [brackets].
The following first boot script shows the steps required to configure a IP
Messaging management server
1 Select the type of IP Messaging system you want to configure, in this
case, server:
Type of 3Com IP Messaging Installation
(S-Standalone/C-Client/V-Server)? [S]

To configure a server (requires that a client be configured on


another Linux server), enter v.
To configure a client (requires that a server be configured on
another Linux server), enter c. For client configuration instructions,
see Configuring the IP Messaging Client.
To configure IP Messaging as a standalone system (both server and
client on one Linux server), enter s. For standalone configuration
instructions, see Configuring IP Messaging on a Standalone Server.

2 Press Enter to accept the default number (144) of VOIP ports the system
will support. Do not enter a different value without consulting 3Com.
Number of voip ports? [144]

26

CHAPTER 2: IP MESSAGING MODULE CONFIGURATION

3 Specify whether or not you want to enable mirroring. Intelligent mirroring


allows messaging servers to synchronize data. Refer to the V7350 Unified
Messaging Suite Intelligent Mirroring Guide.
Should Intelligent Mirroring be enabled (Y/N)?

To enable intelligent mirroring, enter y.

To disable intelligent monitoring, enter n.

[Y]:

If enabled, IP Messaging presents the following subset of mirroring


questions.
a

Name of the Remote Intelligent Mirrored System? :

Enter the name of the IP Messaging server that will mirror this server.
b IP Address for <remote_system_name> [ ]? :
Enter the IP address assigned to eth0 (the IP Messaging interface) on
the remote, mirrored system.
c

Is this host the primary or the secondary (P/S)? [P] :

If this system is the primary IP Messaging server, enter P.

If this system is the secondary IP Messaging server, enter S.

4 IP Messaging displays the IP address assigned to eth0 on this server.


IP Address for Server <system_name> [ip_address]? :

If this address is correct, press Enter. If the address is incorrect (or no


address is displayed), enter the IP address assigned to eth0.
5 Enter the customers name:
Enter the Customer name? [customer] :

Although not required, you can enter a customer name (maximum of 8


characters).
6 Specify whether you would like to view and edit the file that contains the
configuration data you have entered in steps 1 through 7:
Would you like to edit the file containing your selections
(Y/N)? [N]:

To edit current selections, enter y. Note that entering y opens the


configuration file in the vi editor. It does not restart the first boot
script.
To accept your selections without changing the selection file, enter
n.

Configuring the IP Messaging Client

27

The installation script then verifies that the system prerequisites are met
and then continues the installation.
Status and success messages are printed to the screen during installation.

Configuring the IP
Messaging Client

This section describes how to enable a IP Messaging client. This IP


Messaging configuration creates an MSU. You must also configure a IP
Messaging server (MMU) on a separate Linux server.
Default or recommended answers are in [brackets].
The following first boot script shows the steps required to configure a IP
Messaging client.
1 Select the type of IP Messaging system you want to configure, in this
case, client:
Type of 3Com IP Messaging Installation
(S-Standalone/C-Client/V-Server)? [S]

To configure a client (requires that a server be configured on


another Linux server), enter c.
To configure a server (requires that a client be configured on
another Linux server), enter v. For server configuration instructions,
see Configuring the IP Messaging Management Server.
To configure IP Messaging as a standalone system (both server and
client on one Linux server), enter s. For standalone configuration
instructions, see Configuring IP Messaging on a Standalone Server.

2 Press Enter to accept the default number (144) of VOIP ports the system
will support. Do not enter a different value without consulting 3Com.
Number of voip ports? [144]

3 Enter the IP address of the Call Processor:


IP address of the outbound proxy? [0.0.0.0]

The Call Processor uses the IP address of eth1 on the server hosting VCX
software.
4 Enter the IP address of the SIP DDD:
Name of the SIP DDD?

[call_processor_ip]

If the Call Processor functions all reside on one Call Processor, press
Enter to accept the default. The default is the IP address you
entered in step 3.

28

CHAPTER 2: IP MESSAGING MODULE CONFIGURATION

If the default dialing domain (DDD) functions reside on a different


Proxy, enter the IP address of the default dialing domain server.

5 Enter the TCP or UDP port on which the VCX 7300 server will receive SIP
packets:
TCP/UDP Port on which the 3Com IP Messaging will receive SIP
messages [5060]

To accept the default port (5060), press Enter. Note the following
considerations:

If the VCX Call Processor and IP Messaging reside on the same


system and do not share a IP address (there are two interfaces),
they can use the same port number, 5060.
If this is a IP Messaging-only system, accept the default port
number, 5060.
If the VCX Call Processor and IP Messaging reside on the same
system and share a single IP address, they cannot use the same
port number. In this case, enter 5065 as the port number for IP
Messaging; the Call Processor should use port 5060.

6 Enter the IP address of the backup Call Processor:


IP address of the secondary proxy? (hit Enter if none) [

If there is no secondary Call Processor press Enter to accept the


default.
If there is a secondary Call Processor, enter the IP address for eth1
on the secondary VCX server.

7 Specify whether or not you want to enable and identify a Text-To-Speech


server:
Enable Text to Speech (y/n)? [n]

TTS enables IP Messaging to convert text into speech. TTS capability is


provided by the 3Com E-Mail Reader application. This application is
shipped on a CD and must be installed on a Windows server. See
Chapter 6 for information.

If you want to enable TTS, enter y.

If you do not want to enable TTS, enter n.

If enabled, the IP Messaging first boot script presents the following subset
of TTS questions.
a

Enter TTS Server Addresses (press ENTER when done)?


TTS Server 1: nnn.nnn.nnn.nnn

Examining the hosts File

29

TTS Server 2:

Enter the IP address of the Windows server on which E-Mail Reader


application is installed and press Enter. The first boot script prompts
you for the next IP address. You can enter up to 10 IP addresses (server
locations). When you are finished entering TTS server IP addresses,
press Enter to move to the next prompt.
b TTS Server Port [1722]?

Enter the port number IP Messaging should use when communicating


with the TTS Windows server. TTS address information is written to
the /usr/app/app.dir/config.app configuration file. You can add to or
modify information in this file after the first boot script completes. See
Configuring IP Messaging to Support TTS.
If you change the default TTS server port number (1722), you must
use the same value when you configure the TSS adapter. See
Configuring the E-Mail Reader TTS Adapter.
8 Enter the customers name:
Enter the Customer name? [customer] :

Although not required, you can enter a customer name (maximum of 8


characters).
9 Specify whether you would like to view and edit the file that contains the
configuration data you have entered in steps 1 through 10:
Would you like to edit the file containing your selections
(Y/N)? [N]:

To edit current selections, enter y. Note that entering y opens the


configuration file in the vi editor. It does not restart the first boot
script.
To accept your selections without changing the selection file, enter
n.

The installation script then verifies that the system prerequisites are met
and then continues the installation.
Status and success messages are printed to the screen during installation.

Examining the
hosts File

IP Messaging and the Call Processor (which resides on a VCX server)


require a common connection for mailbox synchronization and mailbox
login. To enable this connection, a hostname of umshost must be

30

CHAPTER 2: IP MESSAGING MODULE CONFIGURATION

configured in the /etc/hosts file on the VCX servers (primary and


secondary).
This hostname entry must point to the IP address of the active IP
Messaging system. The IP Messaging configuration procedure normally
adds the required entries in the /etc/hosts file. However, you should open
the file to ensure that a hostname of umshost is configured.
If the network is managed through DNS than the umshost entry should
be entered there.
To examine the /etc/hosts file on a VCX server, follow these steps:
1 Log in to the primary VCX server.
2 Open the /etc/hosts file in an editor and look for the following line (the
example assumes the IP address of the active IP Messaging system is
151.104.122.180):
151.104.122.180

umshost

3 If the entry is missing, add it using the IP address of your active IP


Messaging system.
4 Save the file and exit.
5 Log in to the secondary VCX server and repeat steps 2 and 3.

Upgrading or
Downgrading an IP
Messaging
Configuration

You can upgrade an IP Messaging configuration from either version


5.0.2c to 5.2, or from version 5.2.x to 5.2.y. You can also downgrade
your system from version 5.2 to 5.0.2c, which must have been previously
installed.
Because IP Messaging software upgrades and downgrades are done
within the context of upgrading or downgrading VCX software, refer to
the VCX Administration Guide for detailed information.
Before you upgrade or downgrade an existing IP Messaging
configuration, perform a backup (see Backing Up IP Messaging Data) on
both the primary and secondary IP Messaging servers.

PROCESS AND APPLICATION


MONITORS

This chapter describes how to start and stop the IP Messaging Process
Monitor utility and the IP Messaging Application utility. These
console-based applications allow you to monitor processes and
applications running on the IP Messaging server. This chapter includes the
following topics:

Accessing the Process Monitor and Application Utilities

Attaching to the Process Monitor

Determine if IP Messaging is Running

Starting and Stopping the Application Utility

Start and Stop the Process Monitor and Application Utilities from the
Command Line

32

CHAPTER 3: PROCESS AND APPLICATION MONITORS

Accessing the
Process Monitor
and Application
Utilities

UMS is based on an application creation and run time environment called


Call Builder. Call Builder supports the development and deployment of
voice, facsimile and e-mail messaging applications. The Call Builder GUI
includes the Process Monitor and Application utilities.
The Process Monitor utility is a runtime environment-monitoring program
that verifies what processes are running on your system. The Process
Monitor utility displays a list of system processes, central processing unit
(CPU) usage, and the size of each process.
The Application utility is a runtime environment-monitoring program that
displays multichannel information: each channel represents a IP
Messaging executable program that is running. The Application utility
displays IP Messaging activities and updates the display for each new
activity. The Application utility is the launch point for the interface you
use to configure and manage IP Messaging.
For Version 5.2, all VCX software, including the Process Monitor and
Application utilities, is installed on systems running VCX Linux. You can
access these utilities using one of the following options:

Remotely, through a Linux, Solaris system. Each system must include


an X-Windows environment. You then use Secure Shell (ssh) to log in
to the IP Messaging system and run the Call Builder GUI using xattach.

Remotely, through a Windows system. Each system must include an


X-Windows environment (for example, Cygwin/X. You then use
Secure Shell (ssh) to log in to the IP Messaging system and run the Call
Builder GUI using mattach or xattach. See the V7350 Unified
Messaging Suite Operations and System Administration Guide for
information on installing and configuring Cygwin/X on a PC.

The Call Builder GUI requires the Apprentice font to display properly. This
font is included in the IP Messaging installation
(/usr/app/fonts/apprfont.pcf). You must ensure the Apprentice font is
installed on the system that will display the Call Builder GUI.

Attaching to the Process Monitor

Attaching to the
Process Monitor

33

You can use the Process Monitor to view, stop, and start Call Builder
processes.
The steps required to start the Process Monitor depends on whether you
are accessing the utility locally (through a console interface), remotely
from Linux or Solaris system (using an X-Windows interface), or remotely
through a Windows system (using an X-Windows interface). The
following steps are a generalized description; your steps may vary
according to your environment.
To run the Process Monitor:

From a local xterm window:

a Log on to the IP Messaging system as app.


b Set the environment variable by typing:
setenv DISPLAY <machinename>:0

c Enter the following command to start the Process Monitor:


xattach mon

From an X-Windows session on a remote system:

a Connect to the IP Messaging system. For example, if IP Messaging is


running on a machine with the IP address 192.164.10.10, you would
enter:
ssh mon@192.164.10.10

b Enter the following command:


mattach mon

The Process Monitor screen appears (see Figure 3).

34

CHAPTER 3: PROCESS AND APPLICATION MONITORS

Figure 3 Process Monitor Window

Table 3 lists the control buttons on the Process Monitor screen.


.

Table 3 Control Buttons on the Process Monitor Screen


Button Name

Descriptions

Edit

Displays the Edit System Procedures Window.


Caution: Do not use the Edit button without consulting
3Com.

Start

Stops and restarts every process, including IP Messaging.

Stop

Stops all processes, but keeps the Process Monitor running.

SysDown

Stops all Call Builder processes and terminates the Process


Monitor.

To end the attach session, click File, then select Exit (or press Shift and
F2). This disconnects your console or xterm window from the attachment
process, but the process continues to run.

Determine if IP Messaging is Running

Determine if IP
Messaging is
Running

35

IP Messaging is composed of multiple processes, including app,


cw_ipums, and email. You can determine if IP Messaging is currently
operational through the command line (see Start and Stop the Process
Monitor and Application Utilities from the Command Line) or by running
the Process Monitor.
The following command indicates whether IP Messaging and the Process
Monitor are running (note that you should be logged on as app):
-bash-2.05b# su - app
yak:/usr/app>ps -fu app

Figure 4 shows a possible response to this command.


Figure 4 Process Monitor and IP Messaging Status - Running

In Figure 4, lines 4, 5, and 9 (app, cw_ipums, and email) indicate that IP


Messaging is running. Line 2 (mon) indicates that the Process Monitor is
running.
In Figure 5, the results of the ps -fu app command indicate that IP
Messaging and the Process Monitor are not running.

36

CHAPTER 3: PROCESS AND APPLICATION MONITORS

Figure 5 Process Monitor and IP Messaging Status - Not Running

Starting and
Stopping the
Application Utility

To run the Application utility:

From a local xterm window:

a Log on to the IP Messaging system as app.


b Set the environment variable by typing:
setenv DISPLAY <machinename>:0

c Enter the following command to start the Application utility:


xattach app

From an X-Windows session on a remote system:

a Connect to the IP Messaging system. For example, if IP Messaging is


running on a machine with the IP address 192.164.10.10, you would
enter:
ssh app@192.164.10.10

b Enter the following command:


mattach app

The Application utility (Attach App) window opens, as shown in Figure 6.

Start and Stop the Process Monitor and Application Utilities from the Command Line

37

Figure 6 Application Utility Screen

6 To end the attach session, click File, then select Exit (or press Shift and
F2).
This disconnects the console or X-Windows session from the attachment
process. The process continues to run.
If you use the Exit System option on the App System menu, calls and
script processes running on that machine terminate; the scripts
processes restart, but calls do not.

Start and Stop the


Process Monitor
and Application
Utilities from the
Command Line

You can use the following commands from the command line to start
and stop the Application and the Process Monitor utilities.

stopmon Stops the Application and the Process Monitor utilities.

startmon start Starts the Application and the Process Monitor


utilities.

Note that you can also stop and start the Application from within the
Process Monitor (see Attaching to the Process Monitor).

38

CHAPTER 3: PROCESS AND APPLICATION MONITORS

IP MESSAGING BACKUP AND


RESTORE

This chapter describes how to backup and restore IP Messaging data.


This chapter includes the following topics:

Backing Up IP Messaging Data

Scheduling Regular IP Messaging Backups

Restoring IP Messaging Data

40

CHAPTER 4: IP MESSAGING BACKUP AND RESTORE

Backing Up IP
Messaging Data

You can use the procedure in this section to back up provisioned IP


Messaging data such as configured subscriber profiles and system access
numbers. This procedure also backs up user mailbox data (voicemail, fax,
and e-mail messages).
You cannot backup IP Messaging data and restore that data on a
different release. Data must be backed up and restored on the same
release of IP Messaging software.
The backup script requires that IP Messaging be in an idle state and not
taking calls before the backup can be executed. Note that there is no
command to put UMS in an idle state. In this context, idle state simply
means that you should perform the backup during off-peak hours.
However, IP Messaging must not be shutdown before the backup.
To backup IP Messaging data, follow these steps:
1 Log in to your IP Messaging system as app. If you are logged in as
another user, use the following command to switch to app:
su - app

2 At the prompt, enter the following command:


/usr/app/gen/backupums

This command creates the following tgz files in the directory


/opt/3comdata/umsdata/backup/DATE/, where DATE is the date the
backup script (backupums) is run in the format mm_dd_yy.

doc.tgz

speak.vox.tgz

msgm0.tgz

msgm1.tgz

msgm2.tgz

msgm3.tgz

msgm4.tgz

msgm5.tgz

msgm6.tgz

msgm7.tgz

Scheduling Regular IP Messaging Backups

Scheduling Regular
IP Messaging
Backups

msgm8.tgz

msgm9.tgz

pg.tgz

table.tgz

vmcdr.tgz

vmlog.tgz

You can use the standard Linux cron service to schedule backups of IP
Messaging data.
To schedule a IP Messaging backup, edit the crontab file:
1 Log in to your IP Messaging system as app. If you are logged in as
another user, use the following command to switch to app:
su - app

2 Enter the following command to edit the crontab file:


crontab -e

3 Add a line similar to the following:


0 3 * * * /usr/app/gen/backupums >>
/usr/app/backup/backup.log 2>&1

This command runs the backupums command every day at 3:00 a.m.:

0 Specifies minutes.

3 Specifies the hour.

* Specifies the day (* means every day).

* Specifies the month (* means every month).

* Specifies the day of the week (* means every day of the


week).
/usr/app/gen/backupums >> /usr/app/backup/backup.log
2>&1 Specifies the command to run.

Type info crontab at the system prompt for more information on


crontab.

Restoring IP
Messaging Data

You can use this procedure in this section to restore the IP Messaging
data created by the backup script (backupums).

41

42

CHAPTER 4: IP MESSAGING BACKUP AND RESTORE

IP Messaging should be shutdown prior to restoring IP Messaging data. If


IP Messaging is active, the script performs a shutdown before restoring
the data.
To restore IP Messaging data, follow these steps:
1 Log in to your IP Messaging system as app. If you are logged in as
another user, use the following command to switch to app:
su - app

2 At the prompt, enter the following command:


/usr/app/gen/restoreums DIRECTORY

DIRECTORY specifies the location of the tgz files listed in the previous
section, for example, /opt/3comdata/umsdata/backup/06_16_04.
3 To restart IP Messaging, enter the following command:
startmon start

This restarts all the IP Messaging processes.

INSTALLING OPTIONAL VOICE


PROMPTS LANGUAGES AND
CODECS
You can enable multiple language voice prompts on a IP Messaging
system. This allows you to specify the language used by the voice
prompts for individual mailboxes within the same company. Thus
subscribers on the same IP Messaging system can hear mailbox voice
prompts in their own language.
This chapter also describes the codecs supported by IP Messaging, how to
switch from the default G.711u codec to the G.729a codec, and how to
convert custom voice prompts and saved voice mail messages from one
codec to another codec.
This chapter includes the following topics:

Voice Prompt Overview

Installing a Set of Language Prompts

Downloading Language Prompts

Codec Overview

44

CHAPTER 5: INSTALLING OPTIONAL VOICE PROMPTS LANGUAGES AND CODECS

Voice Prompt
Overview

VCX is assembled from independent components. For example, IP


Messaging and each set of language prompts are considered separate
components. A VCX assembly, as defined by a VCX Software Bill of
Materials (VSBOM) configuration file, is constructed from a specified
version of each component. Each component is constructed as an RPM
Package Manager package, and is installed by the script in a
version-specific location.
For Release 5.2, each VCX system ships with a working version of all
required software, including the language prompt RPMs, pre-installed by
3Com Corporation.
There are two general steps required to assign a voice prompt language
to a mailbox:
1 Run a script to install the prompts on your IP Messaging system. See
Installing a Set of Language Prompts.
2 Use the IP Messaging Administrator interface to assign an installed set of
prompts to a IP Messaging mailbox. Refer to the V7350 Unified
Messaging Suite Operations and System Administration Guide.
In addition to the languages supported in the current release, 3Com
Corporation may develop voice prompts for other languages and make
these prompts available through a partner site. If other languages
become available, you can download and install the appropriate RPM.
See Downloading Language Prompts.

Installing a Set of
Language Prompts

You must install a set of language prompts on both the primary IP


Messaging server and the secondary IP Messaging server.
To install a set of language prompts on the primary IP Messaging server,
follow these steps:
1 Log in as root on the primary IP Messaging server.
2 Enter the following command, substituting the appropriate numbers for x
and y based on the current software version that is running on your
system:
cd /opt/3com/components/UMS.5.2.x.y/app/app.dir

3 Enter the following command to run the add_language script:


./add_language

Downloading Language Prompts

45

4 Answer the questions to install the prompts that you want.


5 Stop and restart IP Messaging by entering the following commands:
cd /opt/3com/components/UMS.5.2.x.y/vcx-scripts/init.d
./S95ums stop
./S95ums start

6 Log in to the secondary IP Messaging server and install the same set of
language prompts by repeating steps 2 through 5.

Downloading
Language Prompts

If 3Com makes voice mail prompts available in other languages at partner


sites, you must download and install the appropriate RPM file on both the
primary IP Messaging server and the secondary IP Messaging server.
To download a language RPM file from a partner site to a primary IP
Messaging server, follow these steps:
1 Log in as root on the primary IP Messaging server.
2 Access the site hosting the language RPM file.
3 Download the language RPM file and place it in this directory:
/opt/installtemp

Example: The file that contains the UK English prompts and is compatible
with a G711u codec is IPMSG-UK-EN-G711u-SPEAK-1-1.i386.rpm. This
file name is used in the remaining steps of this procedure. Select the file
name that applies to the language and codec that you want. The version
numbers within the file (-1-1 in this example) will change over time.
4 Enter these commands:
cd /opt/installtemp
vcx-install IPMSG-UK-EN-G711u-SPEAK-1-1.i386.rpm

5 Follow the instructions in Installing a Set of Language Prompts to install


the prompts.
6 Log in to the secondary IP Messaging server and download the same set
of language prompts by repeating steps 2 through 5.

Codec Overview

Before voice traffic can be transmitted over a digital network, the audio
waveform, an analog signal, must be encoded into a digital format. The
digitized audio is packetized and delivered over the network to a
destination, and then decoded back into a voice waveform. Software

46

CHAPTER 5: INSTALLING OPTIONAL VOICE PROMPTS LANGUAGES AND CODECS

called a codec (coder/decoder) converts the audio information between


digital and analog formats.
Digitized audio formats have different properties. Each format represents
a compromise between bandwidth and audio quality, that is, high quality
audio typically requires more network bandwidth. Compressing the
digitized audio data can conserve bandwidth with little compromise in
audio quality, but compression requires increased processing overhead
when encoding and decoding the audio information. Too much
processing overhead can introduce delay.
IP Messaging can operate with either the G.711u codec or the G.729a
codec.
The E-Mail Reader application supports the G.711u codec only. IP
Messaging must also use the G.711u codec if you want to enable Text to
Speech (TTS). See Text-To-Speech Overview for more information on the
E-Mail Reader TTS application.
Each codec includes a set of language prompts. By default, IP Messaging
operates with the G.711a codec and US English language prompts.
For the current release, each IP Messaging system also includes the
following codecs and language prompts, constructed as RPM Package
Manager packages:

IPMSG-US-EN-G729a-SPEAK-1-1.i386.rpm (US English)

IPMSG-UK-EN-G711u-SPEAK-1-1.i386.rpm (UK English)

IPMSG-UK-EN-G729a-SPEAK-1-1.i386.rpm (UK English)

IPMSG-MX-SP-G711u-SPEAK-1-1.i386.rpm (Mexican Spanish)

IPMSG-MX-SP-G729a-SPEAK-1-1.i386.rpm (Mexican Spanish)

If you want to enable a set of language prompts that are compatible with
the currently operating codec, simply run the add_language utility as
described in Installing a Set of Language Prompts.
IP Messaging supports only one codec at a time.

If you want your IP Messaging system to operate with a different


codec (for example, switch from the default G.711u codec to the
G729a codec), you must run the change_codec utility, as described in
Changing Codecs.

Codec Overview

Changing Codecs

47

If you want to convert custom recorded prompts and saved voice mail
from on codec to another, you must run the codec_data_convert
utility, as described in Converting Prompts and Messages to a Different
Codec.

When you change the codec used on a IP Messaging system, you must
make the change on both the primary IP Messaging server and the
secondary IP Messaging server.
CAUTION: If you configure an existing IP Messaging system to use a
different codec, all custom prompts and voice mail messages saved in the
previous codec format will be lost. To avoid this loss, run the
codec_data_convert utility before running the change_codec utility. See
Converting Prompts and Messages to a Different Codec.
The following example assumes the IP Messaging system is operating
with the default codec (G.711u) and the default set of language prompts
(US English). The steps in the example install the G.729a codec and
enable UK English language prompts.
1 Log in as root on the primary IP Messaging server.
2 Enter the following command to switch to the IP Messaging installation
directory:
cd /opt/installtemp

Note that if you have upgraded your IP Messaging system, new files are
located in /opt/installtemp/upgrade_5_2_x_y, where x and y
represent the specific software upgrade.
3 Enter the following command to install the G.729a codec:
vcx-install IPMSG-UK-EN-G729a-SPEAK-1-1.i386.rpm

4 Enter the following command to switch to the directory containing the


add_language and change_codec: utilities:
cd /usr/app/app.dir

5 Enter the following command to run the add_language utility:


./add_language

6 Enter the appropriate response to the prompt to add UK English language


prompts.
7 Enter the following command to run the change_codec utility:
./change_codec g729a

48

CHAPTER 5: INSTALLING OPTIONAL VOICE PROMPTS LANGUAGES AND CODECS

8 Stop and restart IP Messaging by entering the following commands,


substituting the appropriate numbers for x and y based on the current
software version that is running on your system:
cd /opt/3com/components/UMS.5.2.x.y/vcx-scripts/init.d
./S95ums stop
./S95ums start

9 Log in to the secondary IP Messaging server and repeat steps 2 through


8.
Note that steps 5 and 6 may be optional. If, in the example, you were
changing to the G.729a codec with US English language prompts, steps 5
and 6 would be unnecessary because the US English prompts are already
enabled.
Converting Prompts
and Messages to a
Different Codec

IP Messaging supports only one codec at a time and operates with the
G.711a codec by default.
If you want to switch to a different codec (for example, switch from the
default codec to the G729a codec), you can run the change_codec utility.
However, if you run the change_codec utility on an IP Messaging system
on which custom prompts have been recorded and voice mail messages
have been saved in the previous codec format, those prompts and
messages will be lost. To preserve existing custom prompts and voice mail
messages, run the codec_data_convert utility before running the
change_codec utility. Note that the codec_data_convert utility retains a
copy of the custom prompts and voice mail messages in the original
codec format.
When you convert custom prompts and voice mail messages to a
different codec, you should run the codec_data_convert utility on both
the primary IP Messaging server and the secondary IP Messaging server.
The following example assumes the IP Messaging system is operating
with the default codec (G.711u) and the default set of language prompts
(US English). The steps in the example install the G.729a codec and

Codec Overview

49

convert any existing custom prompts and voice mail messages to the
G.729a codec format.
IP Messaging must not be actively processing calls while the
codec_data_convert utility is running.
1 Log in as root on the primary IP Messaging server.
2 Enter the following command to switch to the IP Messaging installation
directory:
cd /opt/installtemp

3 Enter the following command to install the G.729a codec:


vcx-install IPMSG-UK-EN-G729a-SPEAK-1-1.i386.rpm

4 Enter the following command to switch to the directory containing the


codec_data_convert utility:
cd /usr/app/app.dir

5 Enter the following command to run the codec_data_convert utility:


./codec_data_convert g711u g729a

If the utility runs successfully, it returns a list of converted files and the
total number of files processed. If the utility fails to run successfully, it
returns an error message and stops further processing.
6 Log in to the secondary IP Messaging server and repeat steps 2 through
5.

50

CHAPTER 5: INSTALLING OPTIONAL VOICE PROMPTS LANGUAGES AND CODECS

CONFIGURING TEXT-TO-SPEECH

Text-To-Speech (TTS) enables IP Messaging to convert text into speech.


For example, if a voice mailbox is configured to receive e-mail messages,
when the subscriber accesses the mailbox through a SIP-enabled
telephone, the TTS engine speaks the contents of the e-mail message.
TTS capability is provided by the 3Com E-Mail Reader application. This
chapter describes E-Mail Reader application installation and configuration
requirements, and includes the following topics:

Text-To-Speech Overview

E-Mail Reader Requirements

Configuring IP Messaging to Support TTS

Installing and Uninstalling the E-Mail Reader TTS Adapter

Configuring the E-Mail Reader TTS Adapter

52

CHAPTER 6: CONFIGURING TEXT-TO-SPEECH

Text-To-Speech
Overview

The 3Com E-Mail Reader application is a Text To Speech (TTS) feature that
enables IP Messaging to use a TTS engine to speak words based on text
strings.
IP Messaging currently uses the E-Mail Reader application to speak the
content of e-mail message headers and body to subscribers when they
retrieve e-mail using the Telephone User Interface (TUI).
The E-Mail Reader application is available for download from the Web
and includes the following components:

TTS engine The TTS engine converts text into encoded voice. The
E-Mail Reader application uses Speechify software from ScanSoft, Inc.
as the TTS engine. For the current release, Speechify software is
installed from the downloaded E-Mail Reader application on to a
Windows server.

TTS adapter The TTS adapter provides a link from the TTS engine,
Speechify, to IP Messaging software running on VCX Linux. The TTS
adapter is installed on same Windows server as the Speechify TTS
engine.

The E-Mail Reader application supports the G.711u codec. The Speechify
software available through the E-Mail Reader application supports US
English, UK English, and Latin American Spanish.
Because the E-Mail Reader application supports the G.711u codec and
not the G.729a codec, IP Messaging must also use the G.711u codec if
you want to enable TTS. G.711u is the default codec enabled for IP
Messaging. See Codec Overview for more information on codecs.
When a subscriber accesses an e-mail message in a voice mailbox through
the TUI, a TTS request is relayed by IP Messaging software to the TTS
adapter. Each request specifies the text to be converted, and the codec
and language to use. The TTS adapter sends the request to the Speechify
TTS engine.
The Speechify TTS engine converts the text to speech and the subscriber
hears the contents of the e-mail message.
If the TTS engine cannot process the request, an error code is returned
back to the IP Messaging system.

E-Mail Reader Requirements

53

If the conversion does not happen within an internally calculated time


interval, the TTS adapter returns error to the IP Messaging system.
The IP Messaging system and the TTS adapter exchange keep-alive
messages. If the IP Messaging system fails to receive a keep-alive
message, the IP Messaging system switches to another TTS adapter (see
Configuring IP Messaging to Support TTS). Current conversions are lost.
Subsequent conversions are routed to the new adapter.
Enabling IP Messaging to use TTS requires the following general steps:

Install and configure Speechify software from the E-Mail Reader


application on to a Windows server. The application includes ScanSoft
documentation that describes this process. This chapter assumes
Speechify software is already installed and configured.

ScanSoft documentation indicates that Speechify software may be


installed on multiple hardware platforms and operating systems.
However, the E-Mail Reader application runs on a Windows platform
only. Do not install Speechify software on any other system.

E-Mail Reader
Requirements

During the IP Messaging first boot script, answer the prompts to


enable TTS and identify the location of the Windows server running
the Speechify software. See the section appropriate for your IP
Messaging configuration in Chapter 2. See also Configuring IP
Messaging to Support TTS.

Install and configure the TTS adapter from the E-Mail Reader
application on to a Windows server. The application includes a
ReadMe file that describes this process. The information is also
included in this chapter (see Installing and Uninstalling the E-Mail
Reader TTS Adapter and Configuring the E-Mail Reader TTS Adapter).

The hardware and software requirements for the E-Mail Reader


application are determined by the Windows requirements for Speechify
software.
The E-Mail Reader application has the following minimum hardware and
software requirements for a Windows installation:

A 500 MHz Intel Pentium III-based computer.

54

CHAPTER 6: CONFIGURING TEXT-TO-SPEECH

Configuring IP
Messaging to
Support TTS

Memory requirements vary but, in general, a server that supports 72


ports, requires 512 MB of RAM. Refer to the ScanSoft documentation
or contact ScanSoft Technical Support for specific voice requirements.

Speechify server run-time software requires 60 MB of free disk space.


Each Speechify voice requires additional disk space. Refer to the
ScanSoft documentation or contact ScanSoft Technical Support for
specific voice requirements.

Minimum system paging file size is 300 MB.

A Network Interface Card.

Windows 2000 Service Pack 3 or 4, or Windows XP Professional.

A utility to open the tar file containing the TTS adapter.

Internet Explorer 5.0 or later.

Adobe Acrobat Reader 5.0 or later for reading the full Speechify
documentation set.

The 3Com TTS adapter links the Speechify TTS engine running on a
Windows server with IP Messaging software running on a VCX Linux
server.
To enable TTS on an IP Messaging system, you specify the transport
address of the Windows server where the TTS adapter is installed. The
transport address is specified in the /usr/app/app.dir/config.app
configuration file using following syntax:
tts_format=mulaw
luc_tts=<ip_address>
tts_ip_port=1722

The value specified for tts_format is always mulaw (the coding


standard used for sampling an audio signal). You only need to enter
this line once.
The value specified for luc_tts is the IP address of the Windows
system hosting a TTS adapter.
The value specified for tts_ip_port is the port number IP Messaging
should use when communicating with the TTS Windows system. The
default value is 1722. This value must match the TTS port number
configured in the IP Messaging first boot script (see Chapter 2).

Installing and Uninstalling the E-Mail Reader TTS Adapter

55

You can configure a maximum of 10 TTS adapters by entering this line up


to 10 times and specifying a different IP address for the luc_tts variable
along with the appropriate tts_ip_port value.
Initially, the values for luc_tts and tts_ip_port in the config.app
configuration file are specified when you enable TTS during execution of
the IP Messaging first boot script (see Chapter 2). You can modify a
configured value or create new entries by opening config.app in an
editor.
IP Messaging connects to first available TTS adapter and, at any given
time, is connected to single TTS adapter. The order in which TTS adapters
appear in config.app determines the order in which IP Messaging tries to
connect to them.
IP Messaging reads the config.app configuration file when the system
starts. If you make changes to this file, you must reboot the system for
the new values to take effect.

Installing and
Uninstalling the
E-Mail Reader TTS
Adapter

The TTS adapter is installed on same Windows server as the Speechify TTS
engine, and is implemented as a Widows Service. A single TTS adapter
installation can support one or more IP Messaging systems.
You must install the ScanSoft Speechify TTS engine before installing the
3Com TTS adapter. The Speechify software is included with the 3Com
E-Mail Reader application and is typically installed by a reseller or
distributor. Speechify documentation is also included with the
application.
The TTS adapter is provided as a tar file, 3ComIpMsgTtsAdapter.tar,
through the 3Com E-Mail Reader application.
To install the TTS adapter, follow these steps:
1 Create a folder to host the TTS adapter files on the Windows system
where the Speechify TTS engine is installed, and make it the working
folder.
2 Download the tar file from the web to the working folder.
3 Extract the files from 3ComIpMsgTtsAdapter.tar using your tar file utility.
4 Execute following command:
3comttsservice -install

56

CHAPTER 6: CONFIGURING TEXT-TO-SPEECH

This command installs 3ComUmsTtsAdapter as service in the Windows


system.
5 Start the 3Com TTS adapter service:
a Launch the Windows Control Panel.
b Click Performance and Maintenance.
c Click Administrative Tools.
d Double-click Services.
e Find and select the 3Com TTS adapter service:
3COM IPMESSAGING TTS Adapter
f Click the right mouse button on the service and select Start.
If the Windows system hosting the TTS adapter must be rebooted or if
the TTS adapter service has been stopped, you must manually restart the
service as described in step 5. The TTS adapter service will not
automatically restart even if you have configured it to do so in the
Windows Services dialog box.
To uninstall the TTS adapter, follow these steps:
1 Go to the folder where 3ComIpMsgTtsAdapter is installed.
2 Execute the following command:
3comttsservice -remove

This removes 3ComUmsTtsAdapter from the Windows Service Control


Manager.

Configuring the
E-Mail Reader TTS
Adapter

Once the TTS adapter is installed, you must configure the adapter. TTS
adapter configuration specifies parameter values that enable the adapter
(and IP Messaging) to communicate with the Speechify TTS engine.
These parameter values are specified in the 3COMTTS.XML configuration
file. A sample of this file is included with the 3Com E-Mail Reader
application and is shown below.
<!DOCTYPE database SYSTEM "3ComTts.dtd">
<!-- 3COM Tts Adapter Layer Configuration File -->
<database>
<table name="ComsTtsCfg">
<row>
<!-- Port between Ip Messaging System and TTS Adapter -->
<column name="IPMCommPort">1722</column>

Configuring the E-Mail Reader TTS Adapter

57

<!-- Logging. 1 = ON. 0 = OFF -->


<column name="Logging">0</column>
</row>
</table>
<table name="TtsEngineCfg">
<row>
<column name="EngineName">Speechify</column>
<column name="EnginePort">5555</column>
<column name="License">1</column>
<!-- Language 1 = US English 2 = UK English 3 = Spanish -->
<column name="Language">1</column>
</row>
</table>
</database>

Download the 3COMTTS.XML configuration file from the web site to the
TTS adapter installation directory. Next, open the file in a text editor and
change the sample values as necessary. See Table 4.
IP Messaging reads the 3COMTTS.XML configuration file when the
system starts. If you make changes to this file, you must reboot the
system for the new values to take effect.
Table 4 3COMTTS.XML Parameters
Parameter

Default Value

Description

<IPMCommPort>

1722

Specifies the port used by IP Messaging to


communicate with the TTS adapter. 1722 is
the default value and must match the TTS
port number configured in the IP Messaging
first boot script (see Chapter 2).

<Logging>

Specifies whether logging is enabled


( 1 ) or disabled ( 0 ). The log file is written to
the TTS adapter installation directory.

<EngineName>

Speechify

Specifies the TTS engine that IP Messaging


will communicate with through the TTS
adapter. For this release, the only valid value
is Speechify.

<EnginePort>

5555

Specifies the port used by the TTS adapter to


communicate with the TTS engine. The
specified value, 5555, is a sample and
should be changed. To determine the port,
start Speechify server management
(Start->Programs->Speechify->Speechify
Server Management), The Speechify dialog
box displays a port number. Use this number
in place of the sample value, 5555.

58

CHAPTER 6: CONFIGURING TEXT-TO-SPEECH

Table 4 3COMTTS.XML Parameters


Parameter

Default Value

Description

<License>

Specifies the number of Speechify licenses


provided by ScanSoft.

<Language>

1 = US English

Specifies the language supported by the


Speechify TTS engine. Specify the language
you have purchased and installed.

2 = UK English
3 = Spanish

CONFIGURING A PRINTER

This appendix describes how to configure a printer in the VCX Linux


environment and includes the following topics:

Printer Configuration Overview

Adding a Printer

60

APPENDIX A: CONFIGURING A PRINTER

Printer
Configuration
Overview

VCX Linux includes the Common Unix Printing System (CUPS) for printing
support in IP Messaging. This support enables IP Messaging to
automatically send faxes to a printer. Fax auto-delivery is described in the
V7350 IP Messaging Operations and System Administration Guide.
This appendix describes how to set up a default printer. For more
information on printer configuration, refer to one of the following
resources:

Adding a Printer

CUPS documentation On your VCX or IP Messaging system, access


the /usr/share/doc/cups-1.1.17 directory. This directory contains
several documents in PDF format, including the CUPS Software
Administrators Manual (filename: sam.pdf). This manual provides
extensive information on printing.

CUPS web page The web page, http://www.cups.org, also includes


extensive information on CUPS.

Man page Enter the command man lpadmin for a quick reference
to printer configuration.

VCX Linux uses the lpadmin interface for printer setup. This interface is
the standard command line tool for configuring CUPS. Note that you
should be logged in as root to execute these commands.
The following commands set up a remote PostScript printer.
/usr/sbin/lpadmin -p myPrinter -v lpd://10.1.1.1/lp -m
postscript
/usr/bin/enable myPrinter
/usr/sbin/accept myPrinter

The first command identifies name of the printer as myPrinter and the
name of the printer queue as lp. The printers IP address is 10.1.1.1.
The second and third commands enable the printer and allow it to accept
print jobs.
The following command sets this printer as the default. This step is not
necessary unless you have more than one printer defined.

Adding a Printer

/usr/sbin/lpadmin -d myPrinter

Other useful commands include:

lpstat Displays status information about current print jobs and


printers.

lp Submits files for printing or cancels print jobs.

lpq Shows information about print queue status.

61

62

APPENDIX A: CONFIGURING A PRINTER

INDEX

requirements 53

Numerics
3COMTTS.XML configuration file 56

A
Application utility 32
accessing 32
starting 36
stopping 37
assembly
defined 12

F
first boot script 20

H
hardware requirements 12
hosts file
adding an entry for IP Messaging 29

Call Builder
utilities 32
client configuration 15
enabling 27
codec
changing 47
overview 45
supported types 46
compact server
requirements 12
config.app configuration file 54
configuration options
IP Messaging-only systems 16
mid-sized systems 16
network 16
small systems 15

installing voice prompts 44


Intelligent Mirroring
for server configurations 25
for standalone configurations 21
IP Messaging
Application utility 32
architecture 14
configuration options 14
configuring TTS adapter support 54
first boot script 20
mirroring requirements 15
Process Monitor 32
updating 30
IP Messaging client configuration 15
enabling 27
IP Messaging data
scheduling backups 41
IP Messaging server configuration 15
enabling 25
IP Messaging standalone configuration 15
enabling 21
IP Messaging-only system configuration 16

downloading voice prompts 45

Media Management Unit


see MMU
Media Service Unit
see MSU
mid-sized server

backup
IP Messaging data, scheduling 41

E
E-Mail Reader application 52

64

INDEX

requirements 13
mid-sized system configurations 16
mirroring 15
see also Intelligent Mirroring
MMU
defined 14
in server configuration 25
MSU
defined 14
in client configuration 27

N
network configuration 16
network interfaces 17, 18

P
premium server
requirements 13
printer configuration 60
Process Monitor 32
accessing 32
functions 33
starting 33
stopping 37
prompts
downloading 45
installing 44

R
requirements
hardware 12
software 12
RPM 12

S
server configuration 15
enabling 25
Intelligent Mirroring requirements 25
IP requirements 20, 21
options 16
server requirements
common 14
compact configuration 12
mid-sized configuration 13
premium configuration 13
small system configuration 15
software requirements 12
Speechify software 52
standalone configuration 15

enabling 21
Intelligent Mirroring requirements 21
system configuration options 15

T
Text-To-Speech. See TTS
TTS 51
enabling 53
overview 52
Speechify software 52
TTS adapter 52
configuring 56
identifying for IP Messaging 54
installing 55
uninstalling 56
TTS engine 52

U
updating IP Messaging 30

V
voice prompts
downloading 45
installing 44
overview 44
VSBOM 12

You might also like