Académique Documents
Professionnel Documents
Culture Documents
IP Messaging
Installation Guide
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
14
30
41
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
Conventions
Notice Type
Description
Information note
Caution
Warning
Text
Description
Screen displays
Syntax
Commands
Words in italics
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
10
Comments
Send e-mail comments about this guide or about any Voice product
documentation to:
VOICE_Techpubs_comments@3com.com
Document title
Page number
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.
Hardware Requirements
System Configurations
Network Configurations
12
Software Overview
and Requirements
Hardware
Requirements
Compact Server
Requirements
Memory 2 GB
Hardware Requirements
Mid-Sized Server
Requirements
CD-ROM drive
Memory 2 GB
Premium Server
Requirements
13
CD-ROM drive
Memory 4 GB
14
Common Server
Network
Requirements
IP Messaging
Architecture
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.
System Configurations
15
System
Configurations
Small Systems
16
Mid-Sized Systems
VCX Release 5.2 software can support the following two mid-sized
system configurations:
VCX Release 5.2 software can support the following IP Messaging system
configuration:
Network
Configurations
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
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
18
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
Configuration Overview
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
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):
Configuration
Requirements - Four
Servers
21
Configuring IP
Messaging on a
Standalone Server
22
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]
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:
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 enabled, the IP Messaging first boot script presents the following subset
of TTS questions.
a
24
[Y]:
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
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
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
[Y]:
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
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
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]
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
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 enabled, the IP Messaging first boot script presents the following subset
of TTS questions.
a
29
TTS Server 2:
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
30
umshost
Upgrading or
Downgrading an IP
Messaging
Configuration
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:
Start and Stop the Process Monitor and Application Utilities from the
Command Line
32
Accessing the
Process Monitor
and Application
Utilities
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
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:
34
Descriptions
Edit
Start
Stop
SysDown
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
35
36
Starting and
Stopping the
Application Utility
Start and Stop the Process Monitor and Application Utilities from the Command Line
37
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.
You can use the following commands from the command line to start
and stop 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
40
Backing Up IP
Messaging Data
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
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
This command runs the backupums command every day at 3:00 a.m.:
0 Specifies minutes.
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
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
Codec Overview
44
Voice Prompt
Overview
Installing a Set of
Language Prompts
45
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
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
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
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.
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
48
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
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
CONFIGURING TEXT-TO-SPEECH
Text-To-Speech Overview
52
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.
53
E-Mail Reader
Requirements
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).
54
Configuring IP
Messaging to
Support TTS
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
55
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
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>
57
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
<Logging>
<EngineName>
Speechify
<EnginePort>
5555
58
Default Value
Description
<License>
<Language>
1 = US English
2 = UK English
3 = Spanish
CONFIGURING A PRINTER
Adding a Printer
60
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
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
61
62
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
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