3com IP Messaging Module Administration Guide

IP Messaging Module Operations and System Administration Guide

3Com® Convergence Applications Suite IP Messaging Module Release 7.1 VCX System Release 7.1 NBX System Release 6.0

Part Number 900-0371-01 Rev. AF Published December 2006

http://www.3com.com/

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

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 such is provided with only such rights as are provided in 3Com’s 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 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, the 3Com logo, NBX, and Call Builder are registered trademarks of 3Com Corporation. VCX and NBX NetSet are trademarks of 3Com Corporation.

Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. FLEXlm® is a registered trademark of Macrovision Corporation. Speechify is a trademark of ScanSoft, Inc. Other

brand and product names may be registered trademarks or trademarks of their respective holders.

52.227-14 (June 1987), whichever is applicable. You agree not to remove or deface any

2.101(a) and as

1 SYSTEM OVERVIEW

Overview 15 Platform Architecture 16

Single-Site Systems 16 Multi-Site Systems 17

Regional Offices with Branch Offices 17 Regional Offices with no Branch Offices 18

System Configurations 18

Single Office Configurations 18

500 Users 18 1,500 Users 19 5,000 Users 19

Multi-Site Configurations 19

IP Messaging Configuration Tools 20

ABOUT THIS GUIDE

Conventions 24

Notices 24 Text 24

Figures 24 Related Documentation 25 Comments 26

1 CALL BUILDER

Call Builder Description 27

System Requirements 28 Installing Cygwin/X 28

Configuring Your PC 29 Installing the Apprentice Font 29

Setting Environment Variables 30 Starting Call Builder 31 Application Utility (AppMon) 31

Voice and Channel Screen 33

Message Window Screen 34

Intelligent Mirroring Status 34

Error Messages 35

Application Utility Menu Options 35

App System Menu 36 Reports Menu 37 Utilities Menu 37 Scripts Menu Options 38 Document Menu Options 39 Network 39

Shell 40 Accessing Voicemail Administration 40 Process Monitor Utility 42 Message Utility 44 Stopping Call Builder 45

2 MAINTENANCE

About VCX Passwords 48 System Startup 48

Determining if IP Messaging is Running 49 IP Messaging Shut Down and Restart 50 Using EMS to Change IP Messaging System Status 52 IP Messaging Backup and Restore 53

Backing Up IP Messaging Data 53

Scheduling Regular IP Messaging Backups 55

Restoring IP Messaging Data 55 Managing Archived Messages 57

Data Backup 57

Message Archival 57 Implementing Message Archival 58

Retrieving Archived Messages 59 Enabling Secure Copy and Secure Shell Commands 61 Network Time Protocol (NTP) Configuration 62

Configuration 62

Verification 63 Manual Switchover 63

Example: 64

Verifying Server Synchronization 65

Database 65

File System 66 Managing Log and CDR Files 66

Tomcat and IP Messaging Log File Maintenance 67

CDR File Maintenance 67 CODEC Overview 69

Changing CODECs 70

Converting Prompts and Messages to a Different CODEC 71 Voice Prompt Overview 72

Adding a Set of Language Prompts 73

Downloading Language Prompts 74

3 CONFIGURING THE SYSTEM ADMINISTRATOR PROFILE

Configuring the Administrator Profile 77

Creating a New Administrator Profile 77

Setting Permissions 79

Deleting an Administrator Profile 80

Modifying an Administrator Profile 80

4 PROVISIONING THE SUBSCRIBER PROFILE

Creating a Subscriber Profile 81

88 Modifying a Subscriber Profile 89

Importing Subscriber Information 90

Exporting Subscriber Information 95 Setting

Delivery Options 96

Fax Printing Options 98

Sending Faxes as TIFF Attachments 99

Defining a Fixed Text Message 100 Setting up the Password 100 Provisioning a Subscriber Alias 100

Merging Mailboxes 103

Splitting a Mailbox 104

Sharing a Mailbox 104

Merging Two Mailboxes 104 Aliasing an Extension with a Mailbox 106

Provisioning FMFM 107

Defining a New Procedure 110

Setting Filter Parameters 113

Setting the Notification Schedule 116

Configuring the Filter for the Default Schedule 117 Configuring a Message Notification Filter for a Day of the

Week 118 Configuring a Message Notification Filter for a Specific Date 119

Changing Profile Settings 120

Configuring Mailbox Options 122

Configuring Personal Address Book Entries 126 Configuring Additional Mailbox Options 127 Identifying a Call Processor for a Subscriber 130 Configuring Delivery Reports and Call Bridging Options 132

Call Monitor 135 Linking a Mailbox to an External Email Account 137

Integrating a Subscriber Mailbox with an E-Mail Application 139

Constructing From: Field Information 140

Deleting a Subscriber Profile 142

5 PROVISIONING CLASS OF SERVICE

Accessing the Class of Service Option 143 Message Delivery 150 Updating the Subscriber Records 152 Provisioning Permission Levels 154 Provisioning the Notification Feature 155 Provisioning the COS Profile 158

Delivery Reports 163

Provisioning Call Monitor for a Class of Service 167

Creating a Class of Service 169

6 REPORTS

Accessing the Reports Screen 172 Generating a Report 173 Setting a Schedule 174 All Subscribers 176 NPA Subscribers 177 NPA-NXX Subscribers 178 Subscribers by Company/Division 178 All Classes of Service 179 ID Class of Service 180 Administrators 181 Message Time Stats 181 Port Usage Stats 182 Mailbox Usage Stats 184 Disk Usage by Message Type 184 Idle Mailboxes and Active Mailboxes 185 Call Processing By Mbx 187 Call Processing By Port 188 Initialized Mailboxes 189 Failed Login Attempts 191 System Information 192

7 COMPANY AND DIVISION PROFILES

Overview 194 Creating a Company Profile 194 Renaming a Company Profile 196 Deleting a Company Profile 197 Creating Or Deleting a Range of Mailboxes 197 Updating Subscribers 198 Setting Permission Levels 199 Importing a Company Profile 200 Defining E-mail Domains 202

Adding Domains 202

Deleting Domains 203

8 SEND USER GROUPS

Send User Groups Overview 205 Provisioning the SUG Option 207

Adding Companies 207 Adding and Deleting Subscribers 208

9 SYSTEM CONFIGURATION AND SYSTEM STATUS

System Configuration Description 212 System Configuration Screen Buttons 213 E-mail Banner 214

Deleting Banner Information 215

Additional Servers 215 Access Number Management 217

Configuring an IP Messaging Voicemail Access Number 218 Configuring Music on Hold 220 Configuring a Hunt Group Announcement 222

Converting a Voice File 222

Configuring an Announcement Number 224 Configuring the Message Archival Access Number 226 Deleting an Access Number 227

Inbound Ports 227 Line Groups 229 MWI Configuration 231 System Status Screen 234 System Alarms 235

10 PAGER TEMPLATES AND TIME ZONES

Pager Templates 237 Time Zones 240

11 AUTO ATTENDANT

Auto Attendant Overview 244 Provisioning the Auto Attendant 246

Creating a New Auto Attendant 246 Assigning Key Button Options 249 Configuring Other Auto Attendant Options 251 Advanced Options 255 Creating Sub-nodes 257 Recording a Voice File 257

Associating a Voice File with an Auto Attendant Function 258 Scheduling an Auto Attendant 258 Exporting an Auto Attendant 260

Using an Existing Configuration 260

Telephone User Interface 261

TUI Menu System for the Auto Attendant 262

12 DISTRIBUTION LISTS

Distribution List Overview 265 Subscriber Distribution Lists 266

Adding Subscribers 268 Adding Phone Numbers 268 Adding VPIM Destinations 269 Adding Lists 269 Adding E-mail Addresses 270 Editing a Distribution List 270 Address Book 270

Using the Address Book Option 271 Importing Distribution List Entries 273 Adding a Company to a Distribution List 273 Adding a Class of Service to a Distribution List 273

System Distribution List 274

Creating a System Distribution List 274

13 GLOBAL VOICEMAIL INTEGRATION

Description 277 Architecture 278 Features 278

Global Name Directory 278 Global Message Sending 279 Global Name Announcements 279

Global Provisioning 280 Installation and Configuration 280 Local Office Administration 281

Adding Local Servers 282

Editing Local Servers 283

Deleting Local Servers 284 Adding a Subscriber to the Global Voicemail Central Server Directory 284 Enabling Global Voicemail for a Class of Service 285 Enabling Global Voicemail using Web Provisioning 286

Disabling Global Voicemail 287

14 VPIM

VPIM Overview 289 Configuring VPIM Domains and Mailboxes 290

15 ACCESSING THE WEB PROVISIONING INTERFACE

Accessing the Web Interface 293 Class of Service 295

Editing an Existing Class of Service 295

Creating a New Class of Service 296

Deleting a Class of Service 297 Company Administration 297 VPIM Administration 298 System Configuration 301

Configuring the Banner and E-Mail Reply Server 301

Configuring the Voicemail Access Number 303

303

Configuring MOH and Announcement Access Numbers 304 Replacing Forgotten Passwords 306

16 CREATING, DELETING, AND EDITING MAILBOXES

Creating Mailboxes 309

Email Address Field 311

Adding a Range of Mailboxes 311 Deleting Mailboxes 312

Deleting a Range of Mailboxes 313

Editing Mailboxes 314

Viewing Message Information 317 Personal Address Book 317 External Email 319 Distribution Lists 322 Scheduled Greetings 325 Notification 326

Create a Notification Filter 327 Create a Notification Procedure 329

Create a Notification Schedule 333 Alias Configuration 335 Virtual Calling Card 337 Toggle On/Off Preferences 338 Family Mailboxes 339 Delivery Options 341

Integrating a Subscriber Mailbox with an E-Mail Application 343

17 SETTING UP FIND ME FOLLOW ME

Find Me Follow Me Description 347 Configuring FMFM 348

Accessing the Basic FMFM Screen 348 Allowing All Callers to Find a User 349 Allowing Some Callers to Find a User 349 Preventing Callers From Finding a User 350 Entering Destination Phone Numbers 351

18 CALL REPORTING

Call Reports Utility Overview 356 Accessing the Call Reports Utility and Configuring the Server 357 Data Display Options 360

Display Tab Options 360 Changing Column Selections 361

Navigation Pane Display Options 362

Grid Navigation Tab 362

Retrieving CDRs 363

Retrieve IP Messaging CDRs Manually 363 Retrieve IP Messaging CDRs Automatically 364

Purging CDRs 365 IP Messaging CDR Field Descriptions 366 Creating Custom Reports 369 Report Grids 370

Customized Grids 370 Locking /Unlocking Columns 371 Filtering Columns 371 Sorting Columns 371

Status Bar 371

19 CONFIGURING TEXT-TO-SPEECH

Text-To-Speech Overview 374 Installation Requirements 375 Installation Overview 376

Installing the Engine 376 Installing a Voice 376 TTS Adapter Installation 377

Installing the Adapter 377 Configuring the Adapter 377 Starting the Adapter Service 380

License Configuration 381

Automatic License Activation 381 Manual License Activation 381 Starting the Licensing Service 383

Automatic Start-up 383

Manual Start-up 383 Uninstalling the E-Mail Reader TTS Adapter 384 Adding TTS

with the VCX Reconfiguration Script 384

A CONFIGURING A PRINTER

Printer Configuration Overview 385 Adding a Printer 386

B OBTAINING SUPPORT FOR YOUR 3COM PRODUCTS

Solve Problems Online 387 Purchase Extended Warranty and Professional Services 388 Access Software Downloads 388 Contact Us 388

Telephone Technical Support and Repair 389

INDEX

SYSTEM OVERVIEW

This chapter covers these topics:

■ Overview

■ Platform Architecture

■ IP Messaging Configuration Tools

Features that are supported only on VCX™ systems are noted throughout this Administration Guide.

Overview The IP Messaging (IPM) Module is part of the 3Com

Applications Suite. IP Messaging centralizes and integrates voice mail, e-mail, and fax mail so users can combine communications modes and take advantage of powerful message handling and distribution features.

The IP Messaging Module provides services that enable users to contact each other and access information in a customized way. This product is used primarily for:

■ Voice mail

Facsimile is supported only on VCX systems.

■ Unified messaging (the integration of voice, facsimile, and e-mail into

a single inbox for message retrieval and management)

■ User interactive applications in IP networks

■ The delivery of value-added targeted services that are standalone or

integrated features

IP Messaging enables users to see their voice and fax mail as e-mail and hear e-mail messages over the phone. They can control call paths with Find Me Follow Me capabilities. This sends all calls or special calls to their choice of phones and determines response times and messaging media

Convergence

16 CHAPTER 1: SYSTEM OVERVIEW

that meet changing needs. Users can also schedule message delivery and send voice mails to an individual or group of fellow users, which is aided by extensive, easily maintained distribution list capabilities.

IP Messaging uses the Session Initiation Protocol (SIP) standard for signaling. The IP Messaging architecture enables service providers to deploy applications in basic, small-scale systems or in complex, fully redundant, large-scale distributed or centralized systems. IP Messaging communicates with external IP network resources by using a SIP gateway or directly connected SIP endpoints.

Platform Architecture

The 3Com Convergence Applications Suite is a system of components that work together to provide services. These components can be combined in various ways that depend on application requirements, hardware configuration, and customer preferences. All components, including IP Messaging, are installed on single or multiple servers. IBM X306 or IBM X346 servers are the standard platforms that run the VCX Linux operating system.

Multi-site, client-server, and redundant server configurations are supported only on VCX systems.

VCX systems can be categorized by the number of sites a system supports. Single-site and multi-site configurations are described below.

Single-Site Systems In a VCX single-site system, software is installed on a single pair of

redundant servers or on four servers (5000 user configuration).

For IP Messaging, the primary and secondary servers in a single-site system mirror each other. This enables the duplication of application data on two independently running servers. The mirrored application data consists of table data and message component files.

There are three configuration options:

■ IP Telephony and Messaging Configuration – Install all VCX

components (including IP Messaging) on a pair of redundant servers. The primary server is active and the secondary server acts as a standby. If the primary server fails, the secondary server assumes call processing and messaging functions.

■ IP Messaging Configuration -Install the IP Telephony VCX call

processor software on one pair of redundant servers. Install IP

Platform Architecture 17

Messaging software on a second pair of redundant servers. The primary server in each pair is active and the secondary server in each pair is in standby mode.

■ Client-Server Configuration – For large numbers of telephone

users, add up to 20 IP Messaging clients to an IP Messaging configuration to provide server load-balancing and improve IP Messaging performance. Up to 20 IP Messaging clients (voiceless) can be dedicated to non-voice applications such as Web provisioning, e-mail synchronization, and logging. The remaining clients can be dedicated to voice functions. IP Messaging Clients should be located on the same subnet as the Primary IP Messaging server.

Multi-Site Systems In a VCX multi-site system, software is installed on multiple,

geographically dispersed servers. Multi-site configurations usually include one or more regional offices and each regional office may support one or more branch offices.

Regional Offices with Branch Offices

■ Local Messaging – In a local messaging configuration, IP Messaging

is installed in the regional office and in each branch office.

At the regional office, IP Messaging is installed on a pair of redundant, mirrored servers. IP Messaging clients can also be added to a regional office. See Client-Server Configurations in

“Single-Site Systems” for

more information.

At each branch office, IP Messaging is only installed on a single server as part of an IP Telephony and Messaging configuration. IP Messaging data is not mirrored because there is only one server.

If global voicemail integration has been enabled during installation, then one or more additional servers need to be added to an existing configuration to act as Global Voicemail Central Servers. A Global Voicemail Central Server carries no voice traffic and coordinates mailbox creation and updates on regional and branch office systems. When global voicemail is enabled for two subscribers on different systems, they can communicate as if they were hosted on the same system. See

“Global Voicemail Integration” for more information.

Global Voicemail Integration should not be confused with Global Messaging or the Global Directory feature.

18 CHAPTER 1: SYSTEM OVERVIEW

■ Global Messaging – In a global messaging configuration, IP

Regional Offices with no Branch Offices

All regional offices are self-contained but interconnected. Each office runs two IBM X306 servers using the IP Telephony and Messaging configuration and supports up to 500 users. One of the offices also has a Call Records Server that runs on a separate IBM X346 server and provides billing-related information (call detail reports) to all of the offices.

Messaging is installed in only one regional office but not in branch offices. All IP Messaging processing is done at the regional office.

At the regional office, IP Messaging is installed on a pair of redundant servers that can be geographically separated. IP Messaging clients can also be added to a regional office. See Client-Server Configurations in

“Single-Site Systems” for more information.

At each branch office, IP telephony software is installed on a single server.

See “System Configurations” for more information on configuration capacities and requirements. Refer to the VCX Installation Guide and the VCX Administration Guide for installation instructions and general information on VCX and IP Messaging hardware and software requirements.

System Configurations

Single Office

Configurations

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.

Multi-site, client-server, and redundant server configurations are supported only on VCX systems.

Three supported configurations are available for a single office and each supports a different number of users.

500 Users

This configuration provides 33 voice mail ports and is based on two IBM X306 servers running the IP Telephony and Messaging software configuration.

The Call Records Service is enabled on the primary server only.

System Configurations 19

1,500 Users

This configuration provides 75 voice mail ports and is based on two IBM X346 servers running the IP Telephony and Messaging software configuration.

The Call Records Service is enabled on the primary server only.

5,000 Users

This configuration provides 200 voice mail ports and is based on four servers:

■ Two IBM X306 servers that run the IP Telephony software

configuration. The Call Records Service is enabled on the primary server only.

■ Two IBM X346 servers that run the IP Messaging configuration.

Optional – IP Messaging can also be configured as a client-server setup. One to twenty IBM X306 servers can be configured as IP Messaging clients. This option provides expanded load capacity. See Client-Server Configurations in

“Single-Site Systems” for more information.

Multi-Site

Configurations

Multi-site configurations can be configured in two ways:

■ Multiple regional offices, all of which are self-contained but

interconnected. Each office runs two IBM X306 servers using the IP Telephony and Messaging configuration and supports up to 500 users. One of the offices also has a Call Records Server that runs on a separate IBM X346 server and provides billing-related information (call detail reports) to all of the offices.

■ Multiple regional offices, each of which supports several branch

offices. Each branch office supports between 200 and 500 users.

One of the regional offices contains:

■ Two IBM X346 servers running the Call Server configuration

■ One or two IBM X346 servers running the IP Messaging

configuration. The number of servers depends on whether the branch offices are configured to have their own IP Messaging or obtain that service from the regional office.

■ One IBM X346 server running the Authentication and Directory

Server configuration.

20 CHAPTER 1: SYSTEM OVERVIEW

■ One IBM X346 server running the Call Records Server

configuration.

■ (Optional) – One to twenty IBM X306 servers configured as IP

Messaging clients. See Client-Server Configurations in

“Single-Site

Systems” for more information.

■ (Optional) – One to two IBM X306 servers configured as Global

Voicemail Central Servers. See

“Global Voicemail Integration” for

more information.

The other regional office contains:

■ Two IBM X346 servers running the Call Records Server

configuration.

■ One or two IBM X346 servers running the IP Messaging

configuration. The number of servers depends on whether the

branch offices are configured to have their own IP Messaging or

obtain that service from the regional office.

■ One IBM X346 server running the Authentication and Directory

Server configuration.

■ (Optional) – One to twenty IBM X306 servers configured as IP

Messaging clients. See Client-Server Configurations in

“Single-Site

Systems” for more information.

IP Messaging Configuration Tools

■ Each branch office contains a single IBM X306 server that runs either

the IP Telephony and Messaging configuration or the IP Telephony configuration. The IP Telephony and Messaging configuration enables each branch office to have its own (local) IP Messaging. The IP Telephony configuration requires that each branch office obtain IP Messaging services from the regional office.

Once IP Messaging has been installed, the next step is to create subscriber accounts and assign telephone extensions to subscribers. These configuration steps are described in the VCX Administration Guide.

After a subscriber is assigned a telephone extension, you can create a voicemail box for that extension and configure IP Messaging options.

When an administrator creates a user account and assigns a telephone extension to that account, the administrator can specify that an IP Messaging mailbox be automatically created for the user. The mailbox number will be identical to the user’s telephone extension.

IP Messaging Configuration Tools 21

You have the following IP Messaging configuration options:

■ Use the IP Messaging Application utility (AppMon) through the

Call Builder Graphical User Interface (GUI).

This option requires a Linux, Solaris, or Windows system with an X-Windows environment. You then use Secure Shell (ssh) to log in directly to the IP Messaging system and run the Call Builder GUI using xattach.

■ See “System Requirements” for system access requirements.

■ See Chapter 6-8 for detailed configuration information. Each

chapter describes a different configuration task such as creating or editing a Class of Service, and creating or editing subscriber profiles and mailboxes.

■ Use the IP Messaging Web Provisioning interface through a web

browser.

The web interface provides a subset of the configuration and management features available through the Call Builder GUI. However, you can enable basic IP Messaging operation through the web interface by completing the following tasks:

■ Identify the voicemail access number and the Music on Hold (MOH)

number. See

■ Create subscriber mailboxes. See “Creating Mailboxes”.

“System Configuration”.

You can use the IP Messaging Web Provisioning interface for many other tasks, but you must use the Call Builder GUI for other tasks such as setting up an Auto Attendant.

See “Accessing the Web Provisioning Interface” for information on accessing and using the web interface.

You can allow subscribers to access the IP Messaging Web Provisioning interface to modify their profiles and mailbox attributes. Subscribers do not have access to features that affect the system or other subscribers. The IP Messaging Application utility is for administrators only and does not allow subscriber access.

An IP Messaging system can be managed as an SNMP device through the 3Com Enterprise Management System (EMS). As an SNMP device, an IP Messaging system can send traps for significant system events such as startup and shutdown. See the Enterprise Management Suite User Guide for more information.

22 CHAPTER 1: SYSTEM OVERVIEW

ABOUT THIS GUIDE

This guide describes how to set up, maintain, and provision the IP Messaging Module of the 3Com

This guide is for network operations, internal support, and Voice over Internet Protocol (VoIP) systems planning personnel. Users of this document should have a thorough knowledge of telecommunications, IP telephony technology, and networks.

Features that are supported only on VCX™ systems are noted throughout this Administration Guide.

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.

Convergence Applications Suite.

24 ABOUT THIS GUIDE

Conventions This section describes notice, text, and figure conventions.

Notices Tab le 1 lists notice icons.

Ta bl e 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

Warning

Te xt Ta bl e 2 lists text conventions.

Ta bl e 2 Text Convention Descriptions

Convention Description

Screen displays This typeface represents information as it appears on the

Commands The word “command” means that you must enter the

Words in italics Italics are used to:

screen.

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

■ 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.

data or potential damage to an application, system, or device

Information that alerts you to potential personal injury

Figures This guide provides figures and screen captures that contain sample data.

This data may vary from the data on an installed system.

Comments Send e-mail comments about this guide or about any Voice product

documentation to:

Voice_Techcomm_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:

IP Messaging Module Operations and System Administration Guide System Release 7.1

Part Number 900-0371-01 Rev. AF Page 25

Please address all questions regarding 3Com software to your authorized 3Com representative.

CALL BUILDER

This chapter covers these topics:

■ Call Builder Description

■ System Requirements

■ Installing Cygwin/X

■ Starting Call Builder

■ Application Utility (AppMon)

■ Accessing Voicemail Administration

■ Process Monitor Utility

■ Message Utility

■ Stopping Call Builder

Call Builder Description

Features that are supported only on VCX™ systems are noted throughout this Administration Guide.

3Com® IP Messaging provides services that enable users to contact each other and access information in a customized way. IP Messaging is based on an application creation and runtime environment called Call Builder.

Call Builder supports the development and deployment of voice, facsimile, and e-mail messaging applications. These applications are written in a scripting language interpreted by Call Builder through commands that execute functions. You can develop and debug applications by using a text-based graphical user interface (GUI) driven by the Call Builder engine.

Call Builder includes three utilities that are briefly described in this chapter: the Application utility (AppMon), Process Monitor utility, and the Message utility.

28 CHAPTER 1: CALL BUILDER

System Requirements

All software (including Call Builder and IP Messaging) is installed on systems running VCX Linux. Run Call Builder using one of the following options:

■ Remotely, through a Linux or Solaris system. The system must include

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

■ Remotely, through a Windows system. The system must include an

X-Windows environment such as Cygwin/X. You then use Secure Shell (ssh) to log in to the IP Messaging system and run Call Builder using mattach or xattach. See

“Installing Cygwin/X” for information on

installing and configuring Cygwin/X on a PC.

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

You can also access IP Messaging remotely through the IP Messaging Web Provisioning interface. This interface provides a subset of the configuration and management features available through Call Builder.

Chapter 15 for more information.

See

Installing Cygwin/X This section describes how to install and configure one of many possible

X-Windows environments, Cygwin/X, on a Personal Computer (PC) running a Windows operating system.

Cygwin/X creates an X-Windows environment on a Windows PC. This allows an application (in this case, 3Com application running on VCX Linux) to be displayed on the remote PC.

For more information on Cygwin/X, go to the Cygwin/X web site,

http://x.cygwin.com/. This web site includes a link for downloading

Cygwin/X software and also includes a link to the Cygwin/X User’s Guide.

Chapter 2 of the Cygwin/X User’s Guide describes how to install the software. Cygwin/X files are organized in categories. It is critical that you install all the required files. Steps 15 and 16 in the guide describe the Cygwin Select Packages window.

Corporation’s Call Builder

Installing Cygwin/X 29

Follow these steps to select the required files in this window:

1 Scroll down the list of packages and expand the Net Default category.

a Select the inetutils package.

b Select the openssh package.

2 Scroll down and expand the X11 Default category.

3 Scroll down and select the X-startup-scripts package.

4 Scroll down and select the X-start-menu-icons package.

5 Within the X11 Default category, select the xorg-x11-base package.

6 Click Next to install the selected packages on your PC.

7 Continue with the installation as described in Chapter 2 of the Cygwin/X

User’s Guide.

8 See “Configuring Your PC” to complete the X-Windows configuration.

Configuring Your PC Once Cygwin/X is installed, you need to edit a batch file and install a

required font on your PC.

Installing the

Apprentice Font

To edit the batch file:

1 Open the following batch file in a text editor (for example, Notepad):

C:/cygwin/usr/X11R6/bin/startxwin.bat

2 Enter the following command at the end of the file:

run xhost +

3 Save the file and exit the editor.

You start Cygwin/X by launching the startxwin.bat file. You can either double-click on the file name or you can create a shortcut icon for the file on your desktop.

To install the required font, you must copy a font file on your IP Messaging system to a Cygwin font directory on your PC. You must use a secure copy utility for this task; for security reasons, the IP Messaging does not allow ftp access. You can use the scp utility included with Cygwin.

To copy the required font file to your PC:

1 On your PC, start Cygwin/X by launching the startxwin.bat file.

30 CHAPTER 1: CALL BUILDER

2 The general syntax for the scp command is:

3 At the prompts, enter the root password.

4 Enter the following commands to rehash the fonts database:

scp root@<source-IP-address>:/path/file.ext /target

To copy the font file from your IP Messaging system, enter the following command:

$ scp root@<IPM-IP-address>:/usr/app/fonts/apprfont.pcf /cygwin/usr/X11R6/lib/X11/fonts/misc

For <IPM-IP-address>, enter the IP address of your IP Messaging system.

The scp utility copies the file to your PC.

$ mkfontdir /usr/X11R6/lib/X11/fonts/misc $ xset fp rehash

You can now start any of the Call Builder application utilities (app, mon, or msg). See

“Starting Call Builder”.

Setting Environment

Variables

To complete Cygwin/X installation, you must add search path elements to the Windows PATH variable. Set these variables as follows:

1 Right-click on My Computer and select Properties.

2 Click on the Advanced tab and press the Environment Variables

button.

3 Scroll down in the System Variables field and double-click on Path.

The Edit System Variable dialog box is displayed.

4 Enter the following items at the end of the Variable Value field:

c:\cygwin\bin;C:\cygwin\lib;C:\cygwin\etc;C:\cygwin\usr;C:\c ygwin\var;C:\cygwin\usr\local\bin;C:\cygwin\usr\X11R6\bin;

5 Reboot your system.

+ 372 hidden pages

3com IP Messaging Module Administration Guide

Specifications and Main Features

Frequently Asked Questions

User Manual

CONTENTS

SYSTEM OVERVIEW

■ Overview

Platform Architecture

Single-Site Systems In a VCX single-site system, software is installed on a single pair of

Multi-Site Systems In a VCX multi-site system, software is installed on multiple,

System Configurations

IP Messaging Configuration Tools

ABOUT THIS GUIDE

Conventions This section describes notice, text, and figure conventions.

Notices Tab le 1 lists notice icons.

Te xt Ta bl e 2 lists text conventions.

Figures This guide provides figures and screen captures that contain sample data.

Related Documentation

Comments Send e-mail comments about this guide or about any Voice product

CALL BUILDER

Call Builder Description

System Requirements

Installing Cygwin/X This section describes how to install and configure one of many possible

Configuring Your PC Once Cygwin/X is installed, you need to edit a batch file and install a