3com IP Messaging Module Administration Guide

Download

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.

Starting Call Builder 31

Starting Call Builder This section describes how to launch the Call Builder utilities.

To run one of the Call Builder application utilities:

1 Start an X-Windows session by launching the startxwin.bat file.

You can change the font size in the Cygwin/X window by holding down the Ctrl button, clicking the right mouse button, and selecting a font size option.

2 Enter the following command to log in to your IP Messaging system as

app:

ssh -Y -l app <IPM-IP-address>

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

The -Y switch enables trusted X11 forwarding. Trusted X11 forwardings are not subjected to the X11 SECURITY extension controls. The -l switch specifies the login ID.

3 Enter the password for app at the prompt. The default password is nice.

A message might appear that says

Warning; No xauth data; using fake authentication data for X11 forwarding.

Application Utility (AppMon)

This warning message can be ignored.

4 Enter one of the following commands to start a Call Builder application

utility (you can run multiple utilities at the same time):

xattach app — starts the Application utility.

xattach mon — starts the Process Monitor utility.

xattach msg — starts the Message utility.

Message utility functionality is duplicated on the main AppMon screen.

To go directly to the IP Messaging utility, type vmlogin at the prompt and enter the appropriate username and password.

The Application utility is a runtime environment-monitoring program that displays multichannel information. Each channel represents an IP Messaging executable program that is running. The Application utility displays IP Messaging activities and updates the display for each new

32 CHAPTER 1: CALL BUILDER

1 Launch AppMon. See “Starting Call Builder”.

activity. The Application utility is the launch point for the interface used to configure and manage IP Messaging.

To run the Application utility:

The Application Utility screen displays (Figure 1). All IP Messaging functions appropriate to the attached process are now available.

The Application Utility screen is divided into several areas: Voice and Channel screen, Message Window, and Intelligent Mirroring Status. If an error occurs, it is displayed in red.

Figure 1 Application Utility Screen

To end the attach session, select Close from the Application Utility pull-down menu (top left corner of screen). You can also press Shift and F2 or Alt and F4. This disconnects the X-Windows session from the attachment process. The process continues to run.

Application Utility (AppMon) 33

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.

Voice and Channel

Screen

The Voice and Channel screen (Figure 2) provides a real-time status of current voice or local channel activity and shows the number of voice and local channels installed on the system. You can monitor the status of call activity when sending and receiving calls on the Voice Processor channels and when running local background tasks.

Figure 2 Voice and Local Channel Screen

34 CHAPTER 1: CALL BUILDER

IP Messaging automatically identifies the number of installed voice and fax ports and displays them in this window. As you add more voice ports, the system expands the window to accommodate the new ports. Local channels appear under the voice channels.

Local channels are for background tasks and are identified with an LC instead of a channel number. They are highlighted when a local channel is being used.

Message Window

Screen

Intelligent Mirroring

Status

The purple window is the Message window. Programmer-defined messages are written to this message window using the message and message commands.

Figure 3 Message Window Screen

Figure 3 shows a sample message window.

This status window is used for primary and secondary server configurations. The name and operating status of each server is displayed

Figure 4).

(

Application Utility (AppMon) 35

Figure 4 Intelligent Mirroring Status

Error Messages Error messages appear in wide, red windows on the App window. You

can remove these error messages by clicking them with the left mouse button.

Figure 5 Error Messages Screen

Figure 5 shows a sample error message screen.

Application Utility

Menu Options

Figure 6 shows the menu options at the top of the Application utility

window.

Figure 6 Application Utility Menu Bar

Ta bl e 3 lists the options on the menu.

Ta bl e 3 Options on the Application Utility Menu

Menu Item Description

App System Contains system-wide features.

Reports The Reports section is not enabled on the current version of IP

Messaging.

Utilities Contains the utilities to maintain system-wide tasks such as table

maintenance, clock display, and counts check.

This menu item also includes the option that launches the IP Messaging provisioning interface.

Scripts Displays a drop-down menu used to access scripting options.

36 CHAPTER 1: CALL BUILDER

Table 3 Options on the Application Utility Menu (continued)

Menu Item Description

Documents Displays the Document menu used to create documents from a

collection of pages, maintaining broadcast fax lists, and initiating broadcast fax jobs.

This option is not available in this release.

Network This window monitors inter-system communications between

multiple Call Builder-based systems.

This option is valid only if multiple Call Builder-based systems are installed.

Shell A DOS-only menu option that is non-functional in VCX Linux

environments.

Each menu option has a corresponding drop-down menu. To see the drop-down menu, click the menu option with the left mouse button. To select an item from the drop-down list, point and click it. To close the menu, press Cancel.

App System Menu

Figure 7 shows the App System drop-down menu.

Figure 7 App System drop-down menu

Ta bl e 4 lists the options on the App system drop-down menu.

Ta bl e 4 App System Menu Options

Menu Option Description

Cancel Closes the drop-down menu.

Application Utility (AppMon) 37

Table 4 App System Menu Options (continued)

Menu Option Description

View System Displays current system information such as version number,

space remaining on the hard drive, and the number of installed voice and fax ports.

Rec Sys Msg Records the standard system recordings such as the number,

System Setup Displays the system configuration screen used to set the

Exit System Shuts down the system and terminates Call Builder and all active

App Config Lets you edit the Call Builder Configuration file. Call Builder

Key Mapping Allows you to create macros that execute a series of commands

months, and days of the week.

This works only in an analog development environment and is not intended for customer use.

voice/fax port options.

calls.

If you use the Exit System option under the App System menu in the App window, the calls and script processes running on that machine terminate. The script processes restart, but the calls do not.

reads this file when the system starts up. You can set system-wide configuration options, start developer applications, and add items to the Utilities menu.

with one keystroke.

Reports Menu

This option is not supported in this release.

Utilities Menu

Figure 8 shows the options on the Utilities drop-down menu. Use the

Utilities Menu option to maintain system-wide tasks.

38 CHAPTER 1: CALL BUILDER

Figure 8 Utilities Menu Options

Ta bl e 5 lists the options on the Utilities drop-down menu.

Ta bl e 5 Utilities Menu Options

Menu Option Description

Cancel Closes the drop-down menu.

Tab l e M a in t Accesses the Call Builder database.

Disp Clock Displays the current date and time.

Monitor Com Enables you to view data across serial ports. This feature is not

VM Admin Enables you to view and provision IP Messaging configuration

Counts Chk Displays and verifies message counts for system mailboxes.

Speak Util Places an outbound call to a phone so that the system speaks can

Port Util Displays the port configuration window that enables you to

enabled in this release

parameters. Requires a user name and password for access. See

“Accessing Voicemail Administration”.

be reviewed or recorded.

change inbound port parameters.

Scripts Menu Options

Figure 9 shows the options on the Scripts drop-down menu. Use this

option to develop scripts on the Call Builder window.

Application Utility (AppMon) 39

Figure 9 Scripts Menu Options

Ta bl e 6 lists the options on the Scripts drop-down menu.

Ta bl e 6 Scripts Menu Options

Option Description

Cancel Closes the drop-down menu.

Edit Script Displays a windows-based list of scripts to edit. To create a new

script, enter a new name.

Spawn Script Runs a user-developed script on a local channel (runs a script as a

background task).

Run Script Executes a script on a voice channel instead of a local channel.

Flush Scripts Clears out cached scripts and speaks.

Import Text Takes a text file from the /usr/app/app.dir/scripts directory and

creates an executable script from it. Then, the system puts it into the /usr/app/im/app.dir/message directory with the other executable scripts.

Document Menu Options

This option is not supported in this release.

Network

Figure 10 shows the Network window that you use to monitor

inter-system communication when multiple Call Builder base systems are connected to create a large system (larger than 120 ports).

40 CHAPTER 1: CALL BUILDER

Figure 10 Network Window

Shell

This option is not supported in this release.

Accessing Voicemail Administration

To access the IP Messaging provisioning interface:

1 Start the Application utility. See “Application Utility (AppMon)”.

2 From the command line, type vmlogin to directly access Voicemail

Administration. If you already have AppMon open, select VM Admin from the Utilities pull-down menu.

3 Enter the required username and password.

The Main menu appears, as shown in Figure 11.

The Local Office Admin feature only appears on systems that are configured as Global Voicemail Central Servers.

Global Voicemail is supported only on VCX systems.

4 To select an option, select it and then press Enter.

Accessing Voicemail Administration 41

Figure 11 Main Menu

Ta bl e 7 lists the options on the Main menu.

Ta bl e 7 Main Menu Options

Option Description

Subscriber Profile Add or modify the parameters for a system subscriber.

Class of Service Define a set of parameters for a group of subscribers.

Administrator Profile Add and change system administrator parameters,

including the access permission levels for each administrator.

Reports Generate and view call processing and status reports.

Company Define a group of subscribers who belong to an

Send User Groups Define a group of subscribers to whom a specific user can

System Status View the number of free megabytes, active calls, media

System Configuration View and edit information for system parameters.

Pager Templates Define templates and protocols for pagers.

Time Zones View, add, or modify time zone data for the system.

Auto Attendant Define the menu structure for the Auto Attendant user

organization or company.

send messages.

service units (MSUs), and the number of calls made during the current hour.

interface and to configure custom Auto Attendants.

42 CHAPTER 1: CALL BUILDER

Table 7 Main Menu Options (continued)

Option Description

Distribution Lists Create, store, and access lists and view, create, and modify

system lists.

Local Office Admin

(supported on VCX only)

VPIM Set up the Voice Profile for Internet Mail (VPIM). VPIM is

Create, edit, and delete regional and branch IP Messaging systems. This feature only appears on servers configured as Global Voicemail Central Servers.

an industry-standard protocol (rfc3801) that allows subscribers to exchange (send, receive, and forward) voice messages between different voice mail systems. IP Messaging supports VPIM, Version 2.

Process Monitor Utility

The Process Monitor utility is a runtime environment-monitoring program that verifies what processes exist for your system. The Process Monitor utility displays a list of system processes, central processing unit (CPU) usage, and the size of each process. You can view, stop, and start Call Builder processes. For example, you can stop and start IP Messaging from within the Process Monitor.

To run the Process Monitor:

1 Launch the Process Monitor utility. See “Starting Call Builder”.

The Process Monitor screen appears (Figure 12).

Figure 12 Process Monitor Screen

Process Monitor Utility 43

Ta bl e 8 lists the columns on the Mon window.

Ta bl e 8 Columns on the Process Monitor Screen

Column Name Description

Program The name of the process being monitored

Days The number of days that this program has been running since

hh:mm:ss The length of time that this program has been running since the

CPU The percent of CPU currently being used by the named program

Size The amount of memory used by the named program

Procs The number of times that the initialization procedure has been

Restarts The number of times this program was terminated and restarted

the last start

last start

run: the number of processes currently running

since the last reboot.

Ta bl e 9 lists the control buttons on the Process Monitor screen.

CAUTION: The system is not being monitored in Edit mode. A process that terminates does not restart until you return to the Process Monitor.

44 CHAPTER 1: CALL BUILDER

Ta bl e 9 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 e n d t he attach session, select Close from the Process Monitor pull-down menu (or press Shift and F2 or Alt and F4). This disconnects your console or xterm window from the attachment process, but the process continues to run.

Message Utility The Message utility is a runtime environment-monitoring program that

monitors the interprocess communicators (IPC) packet activity between communicating processes. A running log of these messages is found in /usr/app/gen.app.out.

To run the Message utility:

1 Launch the Message utility. See “Starting Call Builder”.

The Message utility screen appears (Figure 13).

Figure 13 Message Utility Screen

The Message utility’s functionality is duplicated in AppMon.

Stopping Call Builder 45

Stopping Call Builder

To stop Call Builder on any machine, attach to the Process Monitor (Mon) and click Stop.

This stops all processes running on that machine except for the Process Monitor. The SysDown button stops all processes running on that machine and then terminates the Process Monitor (

If you use the Exit System option under the App System menu in the App window, all calls and script processes running on that machine terminate; the script processes restart, but the calls do not. You should stop Call Builder only from the Mon process (Process Monitor) to completely stop the system.

Figure 12).

46 CHAPTER 1: CALL BUILDER

MAINTENANCE

This chapter covers these topics:

■ About VCX Passwords

■ System Startup

■ IP Messaging Shut Down and Restart

■ Using EMS to Change IP Messaging System Status

■ IP Messaging Backup and Restore

■ Managing Archived Messages

■ Enabling Secure Copy and Secure Shell Commands

■ Network Time Protocol (NTP) Configuration

■ Manual Switchover

■ Verifying Server Synchronization

■ Managing Log and CDR Files

■ CODEC Overview

■ Voice Prompt Overview

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

48 CHAPTER 2: MAINTENANCE

About VCX Passwords

The commands you execute to perform the maintenance tasks described in this chapter require logging in to a server using the appropriate VCX system account. The username and default password for each account is shown in

Ta bl e 10 VCX System Accounts

Username Default Password

root pvadmin

oracle oracle

tomcat tomcat

cworks cworks

vcx vcx

app nice

Ta bl e 10.

During the VCX installation procedure, the installer has the option to change the default password for each account. For security reasons,

3Com

strongly recommends that installers change the default passwords. 3Com also recommends that customers change passwords regularly. Consult with your installer for the current passwords.

These passwords can be changed after the initial installation by running

vcx-reconfigure script. See the VCX Maintenance Guide for more

the information.

CAUTION: Do not use operating system commands or utilities to change these passwords. The

vcx-reconfigure script changes the password

where necessary in VCX scripts and configurations. Operating system commands and utilities do not.

System Startup IP Messaging starts automatically or manually:

■ Automatic startup — IP Messaging is configured to start automatically

when the system on which IP Messaging is installed is booted. This may be a VCX system that includes other VCX components or it may be a standalone IP Messaging system used in conjunction with an NBX call processor.

■ Manual startup — You can manually stop and start the Call Builder

runtime engine, including IP Messaging, through the command line interface or through the Process Monitor if necessary. However, you should not use this method as a routine way of starting the system.

System Startup 49

After the Call Builder runtime engine starts, voice messaging, fax services, and control interfaces are enabled.

Facsimile is supported only on VCX systems.

Determining if IP

Messaging is Running

IP Messaging consists of multiple processes, including app, cw_ipums, and e-mail. You can determine if IP Messaging is currently operational through the command line, by running the Process Monitor, or by monitoring the system status in 3Com’s Enterprise Management Suite (EMS) software.

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 14 shows a possible response to this command.

Figure 14 Process Monitor and IP Messaging Status - Running

In Figure 14, lines 4, 5, and 9 (app, cw_ipums, and e-mail) indicate that IP Messaging is running. Line 2 (mon) indicates that the Process Monitor is running.

Figure 15 shows the results of the ps -fu app command and indicates

that IP Messaging and the Process Monitor are not running.

50 CHAPTER 2: MAINTENANCE

Figure 15 Process Monitor and IP Messaging Status - Not Running

IP Messaging Shut Down and Restart

This section describes how to shut down and restart IP Messaging. These instructions apply to all configurations (standalone, client, and server).

To shut down IP Messaging:

1 Log in to the IP Messaging system as app.

If you are logged in as another user, use the following command to switch to app:

su - app

2 You can stop IP Messaging processes using one of the following options:

■ Enter the following command at the system prompt:

stopmon

■ Navigate to the scripts directory and run the S60ums script:

/opt/3com/VCX/scripts/rc3.d/

./S60ums stop

Depending on your installation configuration, this directory can contain scripts you can use to stop, start, and check the status of other processes (for example, the call processor). Each script, including IP Messaging, takes the following arguments:

stop — Stops the process.

start — Starts the process.

status — Shows the status of the process.

IP Messaging Shut Down and Restart 51

■ Access the Call Builder interface by starting an X-Windows session.

“System Requirements”.

See

Click Stop on the Process Monitor screen (Figure 12).

Either option stops all IP Messaging processes, but keeps the Process Monitor running.

■ Access the EMS client. See “Using EMS to Change IP Messaging

System Status”.

3 To shut down all IP Messaging processes and the Process Monitor, click

SysDown on the Process Monitor screen.

To restart IP Messaging:

1 Log in to the IP Messaging system as app.

If you are logged in as another user, use the following command to switch to app:

su - app

2 You can restart IP Messaging processes using one of the following

options:

■ Enter the following command at the system prompt:

startmon start

■ Navigate to the scripts directory and run the S60ums script:

/opt/3com/VCX/scripts/rc3.d/

./S60ums start

■ If the Process Monitor is running, access the Call Builder interface

by starting an X-Windows session. See

“System Requirements”.

Click Start on the Process Monitor screen (Figure 12).

■ Access the EMS client. See “Using EMS to Change IP Messaging

System Status”.

You can also restart IP Messaging processes and the Process Monitor by rebooting the IP Messaging system.

52 CHAPTER 2: MAINTENANCE

Using EMS to Change IP Messaging System Status

You can use the EMS application to start and stop an IP Messaging server:

1 Launch the EMS client.

The EMS client software works in conjunction with EMS server software. You can install the client and server software on the same system or on different systems.

2 In the EMS client’s Explorer window, select an IP Messaging server from a

system’s equipment tree. Messaging server.

Figure 16 IP Messaging Server Shutdown using the EMS Client

Figure 16 shows an example of a Region 1 IP

3 Right-click on the name of the IP Messaging server that you want to start

or stop.

4 Select Maintenance from the right-click menu and start or stop the

server by selecting Graceful Restart or Graceful Shutdown.

For more information on using the EMS application, refer to the Enterprise Management Suite User Guide and the Enterprise Management Suite Getting Started Guide.

IP Messaging Backup and Restore 53

IP Messaging Backup and Restore

Backing Up IP

Messaging Data

This section describes how to back up and restore IP Messaging data.

Data backup and message archival are two distinct operations.

■ An IP Messaging backup is a snapshot of the current state of an IP

Messaging system and includes subscriber profiles, subscriber

messages, and other system configuration data.

■ IP Messaging message archival copies all messages (and only

messages) to an external archival server for long-term storage.

For more information on managing archived messages, see “Managing

Archived Messages”.

This procedure describes how to back up provisioned IP Messaging data such as configured subscriber profiles and system access numbers. User mailbox data (voice mail, fax, and e-mail messages) is also backed up.

Facsimile is supported only on VCX systems.

The backup script requires that IP Messaging be in an idle state and not taking calls before the backup can be executed. There is no command to put IP Messaging in an idle state. In this context, “idle state” simply means that you should perform the backup during off-peak hours. However, do not shut down IP Messaging before the backup.

Redundant servers and Intelligent Mirroring are supported only on VCX systems. On an NBX system, you only need to back up a single IP Messaging server.

During installation, the installer configures IP Messaging on a pair of redundant servers and enables Intelligent Mirroring. One server is designated the Primary; the second server is designated the Secondary. One of the two servers is in active mode; the other server is in standby mode.

Data is mirrored in real time along with background processes that provide various services in real time. If the active server fails, the background processes on the Standby server take over and start providing services.

When you back up an IP Messaging system, you should back up either the Primary server or the Secondary server. Then you can restore the backup to both the Primary and Secondary servers. You can also back up

54 CHAPTER 2: MAINTENANCE

1 Log in to your IP Messaging server as app.

2 At the prompt, enter the following command:

both the Primary and Secondary servers and restore the individual back ups to their respective servers, but the first back up and restore method is recommended.

To backup IP Messaging data, follow these steps:

If you are logged in as another user, use the following command to switch to app:

su - app

/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

■ msgm8.tgz

■ msgm9.tgz

■ pg.tgz

■ table.tgz

■ vmcdr.tgz

■ vmlog.tgz

IP Messaging Backup and Restore 55

Scheduling Regular IP

Messaging Backups

Use the standard Linux cron service to schedule backups of IP Messaging data.

When IP Messaging is installed and configured, the configuration procedure asks if daily IP Messaging backups should be enabled. If enabled, the procedure asks the installer for the IP address of the backup server.

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.

Restoring IP

Messaging Data

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

Ty pe info crontab at the system prompt for more information on crontab.

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

CAUTION: IP Messaging should be shut down before restoring IP Messaging data. If IP Messaging is active, the script performs a shutdown before restoring the data.

56 CHAPTER 2: MAINTENANCE

Redundant servers and Intelligent Mirroring are supported only on VCX systems.

During installation, the installer configures IP Messaging on a pair of redundant servers and enables Intelligent Mirroring. One server is designated the Primary and the second server is designated the Secondary. One of the two servers is in active mode and the other server is in standby mode.

When you back up an IP Messaging system, you should back up either the Primary server or the Secondary server. Restore the back up to the Primary and Secondary servers. You can also back up both the Primary and Secondary servers and restore the individual back ups to their respective servers, but the first back up and restore method is recommended.

Bring up the Primary server first, followed by the Secondary server.

To restore IP Messaging data, follow these steps:

1 Log in to the IP Messaging server 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 is the location for 06_16_04 files.

3 To restart IP Messaging, enter the following command:

startmon start

This restarts all the IP Messaging processes.

Managing Archived Messages 57

Managing Archived Messages

Data Backup An IP Messaging backup creates a file that includes subscriber profiles,

This section describes how to manage archived messages and describes the differences between message archival and data backup.

Facsimile is supported only on VCX systems.

E-mail is supported only on the 3Com Native Telephone User Interface (TUI).

current subscriber messages, and other IP Messaging configuration data.

If an IP Messaging backup operation is run multiple times, the backups can include duplicate messages.

A backup may not include deleted messages if the messages have already been purged (see

Backup operations are performed to preserve the current state of an IP Messaging system.

When a backup is restored, all subscriber profiles, their messages, and IP Messaging configuration data are restored. Subscribers can then access their restored messages.

“Message Archival”).

Message Archival An archive is a cumulative backup of all subscriber messages (voice,

e-mail, and fax) only, and is typically written to an external archiving server for long-term storage.

Messages are archived only once (there is no duplication).

Even though a subscriber can delete messages through the TUI or through an e-mail client, all messages are archived because IP Messaging archives messages before they are purged out of the system.

Message archiving is usually enabled when IP Messaging is installed and is done for regulatory or legal purposes.

When archived messages are restored, they are not restored to subscriber mailboxes. Only system administrators or subscribers with system privileges can listen to archived messages.

See “IP Messaging Backup and Restore” for more information on managing backup and restore operations.

58 CHAPTER 2: MAINTENANCE

Implementing

Message Archival

IP Messaging message archival is implemented as a standard Linux cron service.

Message archival must be configured during the installation of IP Messaging software, because it cannot be enabled later. The installation procedure prompts the installer for the following information:

■ The IP address of an external archival server

■ The username required for access to the archival server

■ The password associated with the username

■ The directory on the archival server where messages will be archived

The installation procedure uses this information to create a cron job. By default, this cron job runs a file named ums_arch.pl at 3:00 AM and 12:00 PM (noon). However, you can run the file manually at any time by following this procedure:

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:

/usr/app/gen/ums_arch.pl

IP Messaging uses secure ftp (sftp) to transfer the archive tar file to the external archival server. If the server is not available (for example, because of network problems), the archive tar files are created in the /usr/app/archival directory and are transported to the archival server the next time ums_arch.pl runs.

You can also use Linux crontab commands to change the default cron job run times:

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

Managing Archived Messages 59

3 Edit the line (or lines) that specify when ums_arch.pl is run. The format is

similar to the following:

0 3 * * * /usr/app/gen/ums_arch.pl >> <external server>

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/ums_arch.pl >> <external server>— Specifies

the command to run and the destination of the output.

Ty pe info crontab at the system prompt for more information on crontab.

Intelligent Mirroring is supported only on VCX systems.

Retrieving Archived

Messages

When Intelligent Mirroring is enabled, each IP Messaging server in the mirrored system archives its own messages independent of the other server. There is no duplication of archived messages.

Retrieving archived messages typically copies a subset of messages from the archival server to the IP Messaging system where they can be reviewed by an administrator. You can filter the messages to be retrieved according to sender, receiver, or a date range.

CAUTION: If you want to use an existing IP Messaging system to listen to archived messages, you must perform an IP Messaging backup before retrieving the archived messages. After listening to the archived messages, you must restore the backup to return the IP Messaging system to where it was before the archived messages were retrieved. See

IP Messaging Backup and Restore” for more information.

“

60 CHAPTER 2: MAINTENANCE

1 Set up mailbox system privileges (SysPv). See Tab le 13 in “Creating a

2 Configure a mailbox extension that is dialed to listen to archived

1 Log in to your IP Messaging system as app.

2 Connect to the archival server using the username and password

3 Copy the tar files from the appropriate archival server directory (also

To configure the retrieval of archived messages:

Subscriber Profile”. Only subscriber mailboxes with system privileges can

retrieve and listen to archived messages.

messages. See

“Configuring the Message Archival Access Number”.

To retrieve and listen to archived messages:

If you are logged in as another user, use the following command to switch to app:

su - app

configured when message archiving was set up during IP Messaging installation.

configured when message archiving was set up) to the /tmp/archival directory.

The tar filenames contain a date range. If you are interested in messages between a certain date range, copy those files to IP Messaging system.

4 Enter the following command:

/usr/app/gen/ums_arch_retrv.pl

You can add input filters to the command, such as sender, receiver, or date range. The ums_arch_retr.pl command will provide help if no parameters are supplied.

5 Stop and restart IP Messaging. See “IP Messaging Shut Down and

Restart”.

6 Dial the archival number that was set up to listen to archived messages.

All archived messages are played in sequence.

Enabling Secure Copy and Secure Shell Commands 61

Enabling Secure Copy and Secure Shell Commands

IP Messaging uses shell scripts to synchronize servers. These scripts use the Secure Copy (scp) and Secure Shell (ssh) commands. For these commands to work properly in this environment, you must configure each IPM server so that the commands do not prompt for a password.

Primary and secondary server configurations are used only on the VCX system.

Perform these steps on the Primary and Secondary IP Messaging servers:

1 Log in to the IP Messaging system as app.

If you are logged in as another user, use the following command to switch to app:

su - app

2 To create the private and public keys, enter this command:

ssh-keygen -t dsa

3 When you are prompted for a key location, press Enter to accept the

default.

4 When you are asked for a passphrase, press Enter to leave the

passphrase blank.

Perform these steps to copy the key from one server to another:

1 On the Primary IP Messaging server, copy the public key to the Secondary

IP Messaging server using this command:

cat ~app/.ssh/id_dsa.pub | ssh app@<IP address of Secondary IPM server> "cat - >> ~app/.ssh/authorized_keys"..

2 On the Secondary IP Messaging server, copy the public key to the Primary

IP Messaging server using this command:

cat ~app/.ssh/id_dsa.pub | ssh app@IP address of Primary IPM server>"cat - >> ~app/.ssh/authorized_keys"..

62 CHAPTER 2: MAINTENANCE

Network Time Protocol (NTP) Configuration

Configuration To configure Network Time Protocol on the two systems:

Intelligent Mirroring requires that the clocks on the two systems be synchronized to within 1 second.

3Com recommends that you use an external NTP server to maintain time synchronization with Universal Time.

Intelligent Mirroring is supported only on VCX systems.

™

NTP Server Configuration is configured through NetSet

for the NBX system. See the NBX Administrator’s Guide or the NetSet online help for more information.

1 On the Primary IP Messaging server, create the /etc/ntp.conf file.

2 Edit the file and add these lines:

server 127.127.1.1

fudge 127.127.1.1 stratum 8

peer <IP address of Secondary IPM server>

The IP address 127.127.1.1 designates the local oscillator (clock). This entry is required. If no external NTP server is configured or available, the two systems use the local oscillator. The fudge command sets the local oscillator to stratum 8 in order to allow the two systems to use a lower stratum server (7 or lower) if one is available. By default, the system uses this drift file: /etc/ntp/drift.

3 On the Secondary IP Messaging server, create the /etc/ntp.conf file.

4 Edit the file and add these lines:

server 127.127.1.1

peer <IP address of Primary IPM server>

5 On the Primary IP Messaging server, su to root and execute these

commands:

/etc/init.d/ntpd stop

/etc/init.d/ntpd start

Manual Switchover 63

6 On the Secondary IP Messaging server, su to root and execute the same

commands:

/etc/init.d/ntpd stop

/etc/init.d/ntpd start

Optionally, you can add any number of additional server entries in the ntp.conf file.

Verification To verify that the NTP service is properly configured, run this command:

ntpq -p

Any user can run the ntpq command.

The output from this command shows the state of all of the NTP servers with which the local system is communicating.

Manual Switchover You can manually switch either server to the active or standby state,

provided that you have root privileges.

Manual switchover is required only on VCX systems.

1 Log in to the IP Messaging system as app. See “Application Utility

(AppMon)”.

If you are logged in as another user, use the following command to switch to app:

su - app

2 Launch AppMon with this command:

xattach app

See “Application Utility (AppMon)”.

3 Select Scripts > Spawn Scripts from the AppMon pull-down menu. The

Spawn Scripts dialog box is displayed (

Figure 17).

64 CHAPTER 2: MAINTENANCE

4 Select one of these two items from the drop-down list to command the

Figure 17 Spawn Scripts Dialog Box

system to switch state:

■ vssu_active

■ vssu_stanby

5 In the Intelligent Mirroring Status window, verify that the state changes

appear immediately.

6 In the Message window, verify that the messages indicate the progress of

the switchover.

Example:

The following message window sequence is typical when you command the active server to go to standby mode:

../app_ss.c:137 Request to become standby

../app_ss.c:193 Remote end has requested to become active

Shutdown from msg4

This side is standby

VSSI_STNDBY vm_nanch=29028

Verifying Server Synchronization 65

Verifying Server Synchronization

Database To verify database synchronization, at the command line, enter this

You can verify that the databases and the file systems on the Primary and Secondary Servers are synchronized.

Primary and Secondary IP Messaging server configurations are supported only on VCX systems.

command:

tblcmp

If the databases are synchronized, you see this message:

Tables are identical

If the databases are not synchronized, you see a list of the records that are different.

The synchronization of the Primary and Secondary servers is a real-time activity. The tblcmp utility gives accurate results only on an idle system (one that is not processing telephone calls).

To re-synchronize the databases:

1 On the active server, at the command line enter this command:

xattach app

2 In the screen that appears, click Scripts/Spawn vssu_sync.

3 In the blue Tab le s window that appears, click the SS button to select all

the tables that are synchronized with Intelligent Mirroring.

4 Page down until you see checked boxes that indicate that the associated

tables are selected for synchronization.

5 Click the UD button to synchronize the selected tables.

The standby server is updated and restarted.

66 CHAPTER 2: MAINTENANCE

File System To verify that the file systems are synchronized, follow the procedures in

1 Enter this command:

2 If the value of files to copy is not 0 (zero), then enter the command:

this section.

At the command line on both the Primary and Secondary Servers:

diffmsg

If there are many files on the system, the diffmsg utility may take some time to complete operation.

When the diffmsg utility stops, the system displays these two file counts:

■ Files to copy: — The number of files that exist on the other server

but do not exist on the local server.

■ Files to remove: — The number of files that exist on the local server

but do not exist on the other server.

If the value of files to copy is 0 (zero), then the file system is synchronized from the perspective of the local server.

diff2rcp

This command creates a shell script (/usr/app/app.dir/diffmsg.rcp) that you can run from the command line to copy the missing files from the other server.

Managing Log and CDR Files

3 If the value of files to remove is not 0 (zero), then run this command on

the local server:

diffmsg

and run this command on the other server:

diff2rcp

To run the synchronization command line utilities, both servers must have secure shell information configured (see “

Enabling Secure Copy and

Secure Shell Commands”).

VCX software writes data to various log files and call information to Call Detail Records (CDRs). IP Messaging software also writes call information to CDRs. As part of your routine VCX server maintenance schedule, you should examine the directories containing these files and purge older files to maintain sufficient disk space.

Managing Log and CDR Files 67

You should monitor the following applications and services:

■ Tomcat and IP Messaging log files

■ Accounting service for CDR collection

Tomcat and IP

Messaging Log File

Maintenance

Files in the tomcat directory (/opt/3com/VCX/tomcat/logs/) you should monitor include:

■ catalina.out files, for example, catalina.2006-07-10.log

■ localhost_access_log files, for example,

localhost_access_log.2006-08-08.txt

There is currently no mechanism in place to roll over these files or limit file size. You can either move the older versions of these files to another server for storage or delete them.

You should closely monitor the following IP Messaging log file:

■ ums_cbipi.log located in the /usr/app/cbipi/ directory

This file grows indefinitely and, if it reaches the operating system limit, can prevent IP Messaging from taking calls. Growth rate depends on the call load on the system. Restarting IP Messaging does not reset the file—you must either move ums_cbipi.log to another server for storage or delete the file.

■ Additional IP Messaging files you should periodically examine include:

■ /usr/app/gen/app.out

■ /usr/app/gen/eml_client.out

■ /usr/app/gen/cpy4.out

Each of these files resets after a restart of IP Messaging. Consequently, these files will not grow too large unless the system is extremely busy or the system runs without a restart for a long period of time (months).

CDR File Maintenance Storage of CDRs is not an issue if your VCX system includes a dedicated

server running the Call Records service. In this case, the Call Records service off loads CDRs from each configured Accounting service. If your VCX system does not include a Call Records service, CDRs continually accumulate on each server running the Accounting service.

68 CHAPTER 2: MAINTENANCE

1 Log in to the server running the Accounting service using the root

2 Enter the following command:

3 Use an editor to open the following file:

4 In the <CONFIGURATION_INFO> section, locate the

If your VCX system does not include a Call Records service, you can configure the Accounting service to be self-cleaning by editing the Accounting service configuration file or modifying the appropriate SNMP MIB variables.

To modify the Accounting service configuration file:

account.

cd /opt/3com/VCX/acctxml/conf/

acctxmlconfig.xml

<BES_CDRFILE_CONFIG> subsection and find the following variables:

AUTO_CLEAN_IF_NO_LATEST_UPDATE="N" AUTO_CLEAN_IF_NO_LATEST_UPDATE_INTERVAL="96"

The first variable determines whether or not CDRs are purged if the Accounting service has not received notification from the Call Records service within the time period (96 hours) specified by the second variable.

By default, the variable AUTO_CLEAN_IF_NO_LATEST_UPDATE is set to N. If you have Call Records service configured to collect CDRs from the Accounting server, do not change this setting. The Call Records service will purge CDRs from the Accounting server after collecting them.

If you do not have Call Records service, change this setting to

AUTO_CLEAN_IF_NO_LATEST_UPDATE="Y" to enable self-cleaning on the

Accounting service.

The variable AUTO_CLEAN_IF_NO_LATEST_UPDATE_INTERVAL is set to 96 hours (four days) by default. A smaller value initiates the self-cleaning more often. A larger value allows the CDRs to remain on the Accounting server longer.

5 Save your changes.

You can also configure the Accounting service to be self-cleaning by modifying the itbes_xml_cdr.mib variables:

■ itbesCdrAutoCleanIfLatestStale

itbesCdrAutoCleanIfLatestStalePeriod

CODEC Overview 69

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. It is then decoded back into a voice waveform. Software called a CODEC 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. High quality audio typically requires more network bandwidth. Compressing the digitized audio data can conserve bandwidth with little compromise in audio quality. However, 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.

Each CODEC includes a set of language prompts. By default, IP Messaging operates with the G.711u CODEC and US English language prompts.

Each set of language prompts is available with the G.711u CODEC or the G.729a CODEC and is constructed as an RPM Package Manager package. For example, IP Messaging provides the following two RPMs for UK English:

■ IPMSG-UK-EN-G711u-SPEAK-1-1.i386.rpm

■ IPMSG-UK-EN-G729a-SPEAK-1-1.i386.rpm

If you want to enable a set of language prompts that are compatible with the currently operating CODEC, run the add_language utility as described

“Adding a Set of Language Prompts” (also see the MB Language field

in description in Ta bl e 13).

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

“Changing CODECs”.

70 CHAPTER 2: MAINTENANCE

■ If you want to convert custom recorded prompts and saved voice mail

from one CODEC to another, you must run the codec_data_convert utility, as described in

“Converting Prompts and Messages to a

Different CODEC”.

Changing CODECs When you change the CODEC used on an IP Messaging system, you must

make the change on both the primary IP Messaging server and the secondary IP Messaging server.

Redundant servers are supported only on VCX systems.

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

If you have upgraded your IP Messaging system, new files are located in

/opt/installtemp/upgrade_6_0_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.

CODEC Overview 71

7 Enter the following command to run the change_codec utility:

./change_codec g729a

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

/opt/3com/VCX/scripts/rc3.d/

./S60ums stop ./S60ums start

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

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.

Redundant servers are supported only on VCX systems.

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.

72 CHAPTER 2: MAINTENANCE

1 Log in as root on the primary IP Messaging server.

2 Enter the following command to switch to the IP Messaging installation

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

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

5 Enter the following command to run the codec_data_convert utility:

IP Messaging must not be actively processing calls while the codec_data_convert utility is running. The IP Messaging server must be in an idle state. There is no command to put IP Messaging in an idle state. In this context, “idle state” simply means that you should perform the codec conversion during off-peak hours. However, do not shut down IP Messaging before performing this conversion.

directory:

cd /opt/installtemp

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

codec_data_convert utility:

cd /usr/app/app.dir

./codec_data_convert g711u g729a

Voice Prompt Overview

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

This section mentions VCX components as part of a software build, but it also applies to the NBX system.

VCX is assembled from independent components. For example, IP Messaging and each set of language-specific voice 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.

Voice Prompt Overview 73

IP Messaging voice prompts are available in multiple languages. Each language and CODEC combination is provided in an RPM file. For example, IP Messaging provides the following two RPMs for UK English:

■ IPMSG-UK-EN-G711u-SPEAK-1-1.i386.rpm

■ IPMSG-UK-EN-G729a-SPEAK-1-1.i386.rpm

There are two general steps required to assign a voice prompt language to a mailbox:

1 Run a script to add the prompts to your IP Messaging system. See

“Adding a Set of Language Prompts”.

2 Use the IP Messaging Administrator interface to assign an installed set of

prompts to a IP Messaging mailbox. See

“Creating a Subscriber Profile”.

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.

“Downloading Language Prompts”.

See

Adding a Set of

Language Prompts

You must add a set of language prompts on both the primary IP Messaging server and the secondary IP Messaging server.

Redundant servers are supported only on VCX systems.

To add 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

y based on the current software version that is running on your

and system:

cd /usr/app/app.dir

3 Enter the following command to run the add_language script:

./add_language

74 CHAPTER 2: MAINTENANCE

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

5 Stop and restart IP Messaging by entering the following commands:

If the add_language command does not display the language you want to add, ensure that the RPM for that language is available and has been installed. Change to the

/opt/installtemp directory and check the list

of language RPMs.

■ If the RPM for the language you want to add is not listed, see the

next section,

■ If the RPM for the language is listed, you must install it. See step 4

in the next section,

/opt/3com/VCX/scripts/rc3.d/

./S60ums stop ./S60ums start

“Downloading Language Prompts”.

Downloading

Language Prompts

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

If you want to add voice prompts in additional languages, 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:

Redundant servers are supported only on VCX systems.

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.

Voice Prompt Overview 75

4 Enter these commands:

cd /opt/installtemp vcx-install IPMSG-UK-EN-G711u-SPEAK-1-1.i386.rpm

5 Follow the instructions in “Adding a Set of Language Prompts” to install

the prompts.

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

76 CHAPTER 2: MAINTENANCE

CONFIGURING THE SYSTEM ADMINISTRATOR PROFILE

This chapter covers these topics:

■ Configuring the Administrator Profile

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

Configuring the Administrator Profile

Creating a New

Administrator Profile

This section describes the Administrator Profile option. Use this option to:

■ create new users with administrator permissions

■ delete existing administrators

■ change existing administrator parameters

The administrator user has management privileges and must be defined first.

To create a new profile:

1 Select Administrator Profile from the Main menu.

The Administrator Profile screen appears (Figure 18).

78 CHAPTER 3: CONFIGURING THE SYSTEM ADMINISTRATOR PROFILE

Figure 18 Administrator Profile Screen

2 Type in a new login ID and press Enter. The following message appears:

Administrator Not Found -- Add? (Y/N)

3 Enter Y. The cursor moves to the Password field and the Perm and Del

buttons appear on the screen.

4 Type in a password for the new administrator and press Enter.

The cursor moves to the next field.

5 Fill in the fields on the screen as necessary. For example, you do not have

to fill in the Phone Number field or the Pager Number field.

6 Press Exit and save your changes by typing Y.

7 Press Exit again to return to the Main menu.

Ta bl e 11 lists the fields on the Administrator Profile screen.

Ta bl e 11 Fields on the Administrator Profile Screen

Field Description

Password 1 to 15 character alpha-numeric password

Last Name The administrator's last name; maximum of 15 letters

First Name The administrator's first name; maximum of 15 letters

Home Number The administrator's 10-digit telephone number

Pager Number The administrator's 10-digit pager number

Configuring the Administrator Profile 79

Table 11 Fields on the Administrator Profile Screen (continued)

Field Description

Multi-login Enables multiple, concurrent login sessions for this

administrator

Inactive Disables the active account

Password Days Number of days that a password is valid

Ta bl e 12 lists the buttons on the Administrator Profile screen.

Ta bl e 12 Buttons on the Administrator Profile Screen

Button Description

Perm Sets administrator permissions for various system functions.

Del Deletes an administrator profile.

Setting Permissions Setting permissions grants or limits privileges to administrators. You can

set an administrator’s permissions to less than a full set of privileges. To set permissions for an administrator profile:

1 Select Administrator Profile from the Main menu.

2 Type in the administrator’s login ID. Any fields that were previously set are

filled in.

3 Click Perm (permissions). This button does not appear on the

Administrator Profile screen until you enter a value in the Login ID field

The Administrator Permissions screen appears (Figure 19).

Figure 19 Administrator Permissions Screen

80 CHAPTER 3: CONFIGURING THE SYSTEM ADMINISTRATOR PROFILE

4 Check the boxes of the functions you want to authorize for an

administrator. For example, you can deny access to the Class of Service option by leaving the Class of Service box unchecked when you create a new administrator.

5 Press Exit twice and type Y to enable the permissions and save your

changes.

Deleting an

Administrator Profile

Modifying an

Administrator Profile

To delete an administrator profile:

1 Select Administrator Profile from the Main menu.

The Administrator Profile screen appears (Figure 18).

2 Type in the administrator’s login ID and press Enter.

The system populates the fields with the administrator information and the Perm and Del buttons appear.

3 Click Del. The system displays the following message:

Delete This Administrator? (Y/N)

4 Enter Y and press Enter. The system deletes the administrator profile.

5 Click Exit to return to the Main menu.

To modify an administrator’s profile:

1 Select Administrator Profile from the Main menu.

The Administrator Profile screen appears (Figure 18).

2 Type in the administrator’s login ID and press Enter.

The system populates the fields with this administrator’s information and the Perm and Del buttons appear.

3 You now have the option of changing:

■ fields on the Administrator Profile screen. See steps 5 through 7 of

“Creating a New Administrator Profile”.

■ administrator permissions. See “Setting Permissions”.

4 Click Exit. The system prompts you to save changes.

5 Enter Y and then press Enter.

6 Select Exit to return to the Main menu.

PROVISIONING THE SUBSCRIBER PROFILE

This chapter covers these topics:

■ Creating a Subscriber Profile

■ Modifying a Subscriber Profile

■ Setting Delivery Options

■ Setting up the Password

■ Provisioning a Subscriber Alias

■ Provisioning FMFM

■ Changing Profile Settings

■ Integrating a Subscriber Mailbox with an E-Mail Application

■ Deleting a Subscriber Profile

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

Creating a Subscriber Profile

Creating a subscriber profile associates a subscriber mailbox with a set of attributes. These attributes can be defined in a Class Of Service (COS) or defined for an individual subscriber. When the same attribute appears in both subscriber profile and the COS associated with the profile, the value for the profile attribute is used.

If you attempt to create a mailbox for this user and specify the user’s extension for the mailbox number, IP Messaging responds with the message “mailbox already exists.” You must coordinate mailbox creation

82 CHAPTER 4: PROVISIONING THE SUBSCRIBER PROFILE

with the telephony system administrator. By default, mailboxes that are automatically created by the administrator are assigned to COS 102. You can change the subscriber’s assigned COS by editing mailbox settings.

To create a new subscriber profile:

1 Select Subscriber Profile from the Main menu.

2 Type a mailbox number in the text box and press Enter. The following

message displays:

Subscriber XYZ Not Found - Add? (Y/N)

To access an existing profile, type in the mailbox number or select it from the drop-down menu.

3 Ty pe Y and press Enter.

The system prompts you for the Class of Service.

4 Enter a Class of Service identifier.

You can also press F1 to see a drop-down list of existing Classes of Service. Double-click the desired Class of Service from the COS List drop-down menu.

5 Select a company or division name from the drop-down menu. The

following message displays:

You’ve Selected: ABC Company (Y/N)

If the subscriber is going to be added to the Global Voicemail directory, then ‘Unassigned’ must be chosen for a Company.

6 Ty pe Y to accept the company/division name.

The Subscriber Profile screen (Figure 20) for the new mailbox appears. If the account already exists, the information for the account appears automatically.

To access an existing profile, type in the mailbox number or select it from the drop-down menu.

Creating a Subscriber Profile 83

Figure 20 Subscriber Profile Screen

Ta bl e 13 lists the fields on the Subscriber Profile screen.

Ta bl e 13 Fields on the Subscriber Profile Screen

Field Description

Mailbox Number The subscriber’s mailbox number.

First Name Subscriber’s first name (maximum of 11 alpha-numeric

Last Name Subscriber’s last name (maximum of 11 alpha-numeric

Admin Update Displays the time and date of the last change made to this

User Last Login Displays the time and date of the last login to this mailbox.

characters).

subscriber’s file by a system administrator.

84 CHAPTER 4: PROVISIONING THE SUBSCRIBER PROFILE

Table 13 Fields on the Subscriber Profile Screen (continued)

Field Description

MB Language Specifies the language used for mailbox voice prompts for this

Class of Service The Class of Service identifier. Lists COS 101 - 102 and any

Menu Style Select a menu style for the Telephone User Interface (TUI)

Send Msg Order To define the order of preference for sending a message,

subscriber.

The administrator can configure the voice prompt language for each mailbox. The subscriber cannot change the language used for his or her mailbox.

The default language is US English. To assign another language, you must:

1 Install the language. See “Adding a Set of Language

Prompts” for details.

2 In the IP Messaging Provisioning interface:

■ Configure information for the company that employs the

subscribers. See

■ On the Company/Division Profile - Permission screen,

“Creating a Company Profile”.

ensure that Soft is enabled for the Language parameter. See

“Setting Permission Levels”.

■ Assign the subscriber to the company using the Company

and Division fields (see below).

custom Classes of Service that have been defined.

from the drop-down list. Different styles provide different menu prompts for users when they use the voice mail system. The supported styles are cti (the 3Com

native style) and ftl

(the traditional Octel style).

Note: E-mail is supported only on the 3Com Native TUI. If you select ftl, do not enable any of the Email, POP3, or IMAP options on this screen. Also, ignore the LIFO (Rev Order) options if you select ftl.

select from the drop-down list of the combinations, Destination (Dst), Record (Rec) and Options (Opt) for Send.

Note: Send Msg Order is supported only on the 3Com® Native TUI.

Creating a Subscriber Profile 85

Table 13 Fields on the Subscriber Profile Screen (continued)

Field Description

Message Arrival When a subscriber is logged into voice mail and a new

message arrives, there are three notification options that can be selected from the drop-down list.

■ subscriber is notified when he/she returns to the Listen

Menu.

■ subscriber is notified when he/she returns to the Main

menu.

■ subscriber is notified when he/she returns to either the

Main menu or the Listen menu.

■ subscriber is not notified.

FMFM Feature Enables Find Me Follow Me (FMFM).

■ Mailbox Only — IP Messaging creates a mailbox for the

subscriber but FMFM is not enabled.

■ FMFM + Mailbox — IP Messaging creates a mailbox for

the subscriber and enables FMFM.

Note: FMFM is supported only on the 3Com® Native TUI.

Review Options When checked, the following options are active during

message review:

Sender: The sender of the message

Time: The time the message was received

Save: For how long the message is saved

Del: Enables or disables the ability to review deleted

messages in the system. When the field is checked, Del is enabled.

Alias: Enables creation of an alias that allows another device to point to the original user mailbox.

86 CHAPTER 4: PROVISIONING THE SUBSCRIBER PROFILE

Table 13 Fields on the Subscriber Profile Screen (continued)

Field Description

MB (Mailbox) Send Media

MB (Mailbox) Receive Media

Check one or more of the following boxes to enable the following options during message review for the subscriber using this profile:

■ Vmail — Enables the subscriber to send voice mail

messages.

■ Phone — Enables CMD (call message delivery).

■ Fax — Enables fax printing.

Note: Facsimile is supported only on VCX systems.

■ E-mail — Enables the subscriber to send e-mail messages

through the mailbox using the TUI.

■ POP3 — Enables IP Messaging to act as a POP3 e-mail

server. Once POP3 is enabled, a link for External E-Mail is added to the IP Messaging Web Provisioning interface and subscribers can configure their external e-mail accounts.

Note: E-mail is supported only on the 3Com® Native TUI.

Check one or more of the following boxes to enable the following options during message review for the subscriber using this profile:

■ Vmail — Enables the subscriber to receive voice mail

messages.

■ Phone — Enables message reception via personal

greeting.

■ Fax — Enables reception of fax messages.

Note: Facsimile is supported only on VCX systems.

■ E-mail — Enables the subscriber to receive e-mail

messages through the mailbox using the TUI.

■ POP3 — Enables message retrieval using a standard POP3

e-mail client such as Outlook Express.

■ IMAP — Enables message retrieval using a standard IMAP

e-mail client such as Outlook.

Note: E-mail is supported only on the 3Com® Native TUI.

Creating a Subscriber Profile 87

Table 13 Fields on the Subscriber Profile Screen (continued)

Field Description

Options MWI: Message Waiting Indicator — When checked, this

activates the Message Waiting function and indicator light on the subscriber's telephone or stutter dial tone.

SysPv: System Privilege — When the System Privileges field is checked, it allows a subscriber to send system messages. For example, a message can be sent to every subscriber with a specific Class of Service (Class Of Service users group). System messages are not counted in the total number of messages in a mailbox. Therefore, they will not be purged by default when a mailbox is full.

Also allows the mailbox to retrieve archived messages. See

“Managing Archived Messages”.

Noti: Notification — Checking this box will enable the

Message Notification features for this mailbox. See

“Provisioning the Notification Feature” for more information.

You can also use Message Notification when you set up Find Me Follow Me for a subscriber. See

Note: The Message Notification feature will not be available to this subscriber if this box is not checked.

Urev: Unreviewed Messages — If this box is checked, the

Auto Attendant informs the subscriber of the number of reviewed and unreviewed messages in the subscriber's mailbox. If this box is not checked, the Auto Attendant informs only the total number of messages in the mailbox.

Tutor : Run Tutorial — This field determines if the Tutorial will run the first time that the subscriber accesses his or her mailbox. This field will be cleared by default after the Tutorial is run successfully.

Send User Group Select the SUG (Send User Group) configuration from the

drop-down list of available SUG. Send User Group refers to the group of persons, entities, divisions or classes of such to which this subscriber can send messages.

Company Select the Company from the drop-down list of Companies,

to which this particular subscriber belongs. The Company profile displayed on the drop-down list is defined in the Company Administration Setup. See

Division Select the Division of the Company from the drop-down list

of Divisions, to which this particular subscriber belongs. The Divisions displayed on the drop-down list is defined on the Company Administration Setup. See

“Provisioning FMFM”.

Chapter 7.

88 CHAPTER 4: PROVISIONING THE SUBSCRIBER PROFILE

Table 13 Fields on the Subscriber Profile Screen (continued)

Field Description

LIFO (Rev order) Sets up the order (Last In First Out) in which

Ta bl e 14 lists the functions of the buttons on the Subscriber Profile

screen.

messages are reviewed.

■ Old — If this box is checked, the old messages (saved and

deleted messages in the mailbox) can be reviewed in the Last In First Out order and if unchecked, FIFO (First In First Out) order.

■ New — If this box is checked, the new messages (reviewed

and unreviewed messages in the mailbox) can be reviewed in the Last In First Out order and if unchecked, FIFO (First In First Out) order.

■ Email — If this box is checked, e-mail messages

downloaded from an external e-mail server (see

“Linking a Mailbox to an External Email Account”) can be reviewed in

the Last In First Out order and if unchecked, FIFO (First In First Out) order.

Note: LIFO is supported only on the 3Com® Native TUI.

Ta bl e 14 Buttons on the Subscriber Profile Screen

Button Description

Rule Determines what happens to a caller based on a particular event (such

as a busy signal). See

“Provisioning FMFM”.

Delv Message delivery options for the subscriber profile. See “Setting

Delivery Options”.

Pass Changes password for a subscriber. See “Setting up the Password”.

Alis Creates an alias for a subscriber. See “Provisioning a Subscriber Alias”.

Noti Parameters that define how (schedule type and timeframe) a subscriber

is notified when a message is received in the mailbox. See

“Provisioning

FMFM” and “Provisioning the Notification Feature”.

Prof Summarizes all the parameters and values associated with a subscriber

profile. See

“Changing Profile Settings”.

Delt Deletes a subscriber profile and its parameters. See “Deleting a

Subscriber Profile”.

Exit Prompts you to save any changes (if any were made) or presents the

Mailbox Entry screen.

Modifying a Subscriber Profile 89

Modifying a Subscriber Profile

The Subscriber Profile administration screens allow you to modify the options for an existing subscriber profile.

To access an existing subscriber profile:

1 Select Subscriber Profile from the Main menu.

2 Type in a mailbox number or click the drop-down menu to see the list of

existing mailboxes.

The Mailbox Entry screen appears (Figure 21). This screen lists mailbox numbers.

If you leave the mailbox text entry box empty, you can select one of the buttons displayed at the bottom of the screen. See Tabl e 15

for a

description of button functions.

3 Specify a mailbox and press Enter.

If the selected mailbox includes submailboxes (as shown in Figure 21), the submailboxes appear in a separate box. You can select either the main mailbox or one of its submailboxes. After selecting a mailbox or submailbox and pressing Enter, the Subscriber Profile screen appears

Figure 20).

(

Figure 21 Mailbox Entry Screen

Ta bl e 15 lists the functions of the buttons on the Mailbox Entry screen.

90 CHAPTER 4: PROVISIONING THE SUBSCRIBER PROFILE

Ta bl e 15 Buttons on the Mailbox Entry Screen

Button Description

Impt Import one or more subscriber mailboxes from a properly provisioned,

tab-delimited text file with the Import Utility. By default, the file is stored in /usr/app/app.dir. See more information on importing subscriber mailboxes.

Expt Export the configuration settings of one or more subscriber mailboxes

to a text file. You can use this feature to backup mailbox settings or to migrate mailboxes to a different system. By default, the exported file is saved in /usr/app/app.dir. See more information on exporting subscriber mailboxes.

Rang With the Rang button, you can create a range of new mailboxes or

delete an existing range of mailboxes based on a specific Class of Service or by selecting a range of numbers.

Select the Class of Service from a drop-down list for this range of mailbox numbers after selecting the Create or Delete function.

When you select Delete, the system prompts you to delete by Class of Service or by selecting a range of numbers.

Rnum Select Rnum to rename the current mailbox number.

UnLg Select UnLg to log a subscriber off a mailbox. This feature is useful in

an emergency where a subscriber is not able to login to a mailbox for any reason like the system access to this mailbox is hung up or another person was logged to this mailbox for a long time and did not log off.

You can look at a subscriber profile for current activity on this mailbox before logging out or unlogging a mailbox.

Exit Click Exit to return to the previous menu.

“Importing Subscriber Information” for

“Exporting Subscriber Information” for

Importing Subscriber

Information

The Import Utility (Impt button) is designed to accept an import file format that is compatible with a simple Excel spreadsheet that has been exported as a tab-delimited text file. The spreadsheet is formatted with column headings in a single row. Importable mailbox data is located in the rows under the headings.

The column headings are case-insensitive keywords that describe the data in the fields below. If a field is populated, then the feature corresponding to the column heading will be provisioned by using the data in the field. Column headings may be in any order and unsupported column headings are ignored. The rows above the column heading row may contain titles, notes or any other extraneous information, but the rows following the column heading row must only contain import data.

Modifying a Subscriber Profile 91

Several column heading types have optional parameters available that must appear in the next column to the right under the appropriate column sub-heading. Some column headings such as Alias can appear multiple times so that multiple values can be provisioned for the same mailbox.

The supported column headings are listed in Ta bl e 16.

Ta bl e 16 Imported File – Supported Headings

Heading Name Description

Mailbox Required field. 3 to 15 digit mailbox number to be imported.

COS Optional field. 1 to 4 digit COS to use when creating a

Company Optional field. Name of company used when creating a

Division Optional field. Name of Division used when creating a

Firstname Optional field. Alpha-numeric string with length up to 20

Lastname Optional field. Same requirements as Firstname.

Password Optional field. Must be all numeric digits of 4 to 15 digits in

Language Optional field. 2 character language prefix. If not specified,

Operator Optional field. 0 to 15 digit operator extension number. If

Family mailbox sub-mailboxes may be specified using the main mailbox number followed by an underscore and the 1 to 3 digit sub-mailbox number. (i.e. 7035551212_3).

mailbox. If the COS does not exist, then it will be created using default values which can be changed later and pushed out to all the mailboxes. If COS is not specified, then new mailboxes use default COS 102.

mailbox. If not specified, then the Unassigned Company is used.

mailbox.

characters. Greater than 20 characters is truncated.

length. If not specified, then the password will be the last 4 digits of the mailbox or the mailbox number itself if only 3 digits.

then the language defaults to the language specified in the Company used to create the mailbox.

not specified, then the operator extension will default to the value specified in the Company used to create the mailbox.

92 CHAPTER 4: PROVISIONING THE SUBSCRIBER PROFILE

Table 16 Imported File – Supported Headings (continued)

Heading Name Description

SiteName Optional field that is only valid for Global Voicemail Central

Alias Optional field with multiple occurrences allowed. 0 to 44

Pager Optional field with multiple occurrences allowed. 0 to 44

Template Optional sub-heading for the immediately preceding pager

SMDIMWI Optional field with multiple occurrences allowed. 3 to 15

Link Optional sub-heading for the preceding SMDIMWI column.

NBXMWI Optional field with multiple occurrences allowed. 3 to 17

NBXServer Optional sub-heading for the preceding NBXMWI column.

Servers. Up to an 11 character hostname that specifies the local office that a mailbox is hosted on. If the sitename refers to a valid local office, then the mailbox has Global Voicemail enabled and is automatically created on the specified local office. If the sitename is not a valid local office, then the mailbox is created as a local mailbox on the Central Server and has Global Voicemail disabled.

character alpha-numeric string; greater than 44 characters is truncated. Aliases must be unique system wide. Non-unique aliases are ignored.

digit pager number; greater than 44 characters is truncated. Each occurrence of the pager heading will create a pager notification procedure with the specified pager number.

column. 0 to 18 character alpha-numeric string; greater than 18 characters is truncated. If the named template does not exist, then it is created using the "Default" template. If not specified, then the pager notification procedure will use the "Default" template.

digit phone number which is typically the same as the mailbox number. This field provisions MWI over an SMDI serial port link only.

Single digit specifying the number of the SMDI link to send MWI packets to. If not specified, it defaults to link 0.

digit NBX extension number that is typically the same as the mailbox number. This field will enable MWI and create an nbxmwi notification procedure. NBXMWI must be enabled on the system and an NBX server must be defined. Otherwise, this field will be ignored. Specifying the NBX extension number as -1 will remove any existing nbxmwi notification procedures for an update import.

The named NBX server must already be provisioned on the system. Otherwise, it will be ignored and the default will be used. The default is the oldest NBX server provisioned on the system.

Modifying a Subscriber Profile 93

Table 16 Imported File – Supported Headings (continued)

Heading Name Description

NBXPass Optional sub-heading for the preceding NBXMWI column.

This field specifies the password to use when sending MWI to the NBX server. Normally, password checking for MWI is disabled on NBX systems, so the default is NULL.

Note: If both NBXServer and NBXPass are specified, NBXServer must be the first column after NBXMWI.

UMServer Optional field with one occurrence allowed. Alpha-numeric

string specifying the name of the IMAP server to synchronize with this mailbox. Specifying this field creates an external e-mail account that is enabled for synchronization, background polling, and polling at login with a polling interval of 1 minute. If the mailbox already has an external e-mail account that has synchronization enabled, then this entry will be ignored. The next three sub-fields are optional, but if they are left blank, then account synchronization will not occur until all the required information is provided.

UMEmail Optional sub-heading for the preceding UMServer column;

e-mail address of an account on an external e-mail server. This information can be populated by the mailbox owner using a web interface.

UMUser Optional sub-heading for the preceding UMServer column;

username for accessing the external e-mail account. This information can be populated by the mailbox owner using a web interface.

UMPass Optional sub-heading for the preceding UMServer column;

password for accessing the external e-mail account. This information can be populated by the mailbox owner using a web interface.

To import subscriber information:

1 Copy a tab-delimited text file to the /usr/app/app.dir on your IP

Messaging server. The filename must not be longer than 8 lowercase characters. A sample file is shown in

Figure 22.

Use the sftp command to copy the text file to /usr/app/app.dir. FTP is disabled on IP Messaging servers for security reasons.

94 CHAPTER 4: PROVISIONING THE SUBSCRIBER PROFILE

Figure 22 Sample Tab-Delimited File

Mailbox COS Company Division Firstname Lastname

2000 200 3Com Jane Doe

2001 200 3Com China John Smith

2002 200 3Com Engineering Jim Jones

2003 200 3Com Sales Sam Baker

2004 202 Unassigned Nicole Stevens

2 Verify that the ownership (file permissions) of the file is set to app. Only

administrators and the file owner can change file ownership.

Use the chown command to change ownership. For example, if you need to change ownership on the file sample.txt, the command would be

chown app:cti sample.txt

3 Select Subscriber Profile from the Main menu.

4 Click Impt.

5 Type the name of the tab-delimited text file in the Enter the import

filename field. The Import Utility will start processing the subscriber

information. If a mailbox listed in the text file already exists, the importing process will pause and the following prompt will appear:

Mailbox <mailbox number> exists! Update/Overwrite/Renum/Skip/Cancel (U/O/R/S/C)?

■ Update will only set the parameters specified in the import file. All

other subscriber profile settings will be left intact.

■ Overwrite will delete the existing mailbox, including all messages,

and create a new mailbox with the specified number.

■ Renum will prompt you to enter a different mailbox number instead

of the one specified in the file.

■ Skip will skip this mailbox and make no changes to the existing

mailbox.

■ Cancel will cancel the entire import and return to the mailbox entry

screen.

6 Several of the options will be followed by a second prompt such as:

Update One or update All (O/A)?

Modifying a Subscriber Profile 95

■ Selecting One will update (or overwrite or skip) the current mailbox. If

another mailbox exists that is also listed in the import file, the import will pause again.

■ Selecting All will update (or overwrite or skip) the current mailbox and

any remaining mailboxes in the import file.

7 When the import file has been completely processed, a summary is

displayed:

Import complete, X lines processed. Summary: Y mailboxes imported.

8 Click the OK button to return to the mailbox entry screen.

Exporting Subscriber

Information

The Export Utility (Expt button) is outputted as a tab-delimited text file and is compatible with Excel.

Export subscriber information as follows:

1 Select Subscriber Profile from the Voicemail Administration menu.

2 Press the Expt button.

The system displays the following message:

Enter the range for export, Minimum Mailbox Number:

3 Type in the lowest mailbox number that you want to export and press

Enter. For this example, 631100 is the minimum mailbox number.

The system displays the following message:

Enter the range for export, Maximum Mailbox Number:

4 Type in the highest mailbox number you want to export and press Enter.

For this example, 631102 is the maximum mailbox number.

The system displays the following message:

Enter the export filename:

5 Type in a filename that is no longer than 8 lowercase characters and press

Enter. For this example, test is the filename.

The system displays the following message:

Export Succeeded!

Summary: 5 mailboxes have been exported to file test.

The exported file is copied to /usr/app/app.dir on your IP Messaging server.

6 Press OK to exit back to the main screen.

96 CHAPTER 4: PROVISIONING THE SUBSCRIBER PROFILE

A sample of the exported file is shown in Figure 23.

Figure 23 Exported Subscriber Information

Setting Delivery Options

The Delivery Options allow you to specify a second delivery destination for a subscriber’s messages. If you have configured a subscriber to receive voice, fax, and e-mail messages on the Subscriber Profile screen

Figure 20), you can specify that all e-mail messages also be sent to a

( second e-mail address for that subscriber.

1 Select Subscriber Profile from the Main menu.

2 Select a subscriber number from the Mailbox Entry screen.

3 Click Delv to access the Delivery Options screen (Figure 24).

Figure 24 Delivery Options Screen

4 Fill in the fields as required. See Tab le 17 for Delivery Options field

descriptions.

Setting Delivery Options 97

Ta bl e 17 Fields on the Delivery Options Screen

Field Description

Maximum Retries The maximum number of times that IP Messaging attempts

to deliver a voice or fax message before declaring the delivery unsuccessful.

Retry Interval (sec) The time (in seconds) between delivery attempts.

Voice AutoDelivery Voice message notification is automatically delivered to the

voice number entered in the Voice Number field. The voice message will also be sent to the mailbox configured on the Subscriber Profile screen (

Figure 20).

Fax AutoDelivery Fax message notification is automatically delivered to the

fax number entered in the Fax Number field or to the printer selected in the Printer Name field. The fax message will also be sent to the mailbox configured on the Subscriber Profile screen (

Figure 20).

Automatically sending fax message notification directly to a printer requires setting up one or more printers in a VCX Linux environment. See Appendix A for information.

Note: Facsimile is supported only on VCX systems.

E-mail AutoDelivery E-mail notification is automatically delivered to the e-mail

address entered in the E-mail Address field. The e-mail message will also be sent to the mailbox configured on the Subscriber Profile screen (

Figure 20).

Note: E-mail is supported only on the 3Com Native TUI.

After Delivery Specifies the action taken on auto-delivered messages. The

options are:

■ Leave New — A voice message will be delivered to the

voice number listed on the Delivery Options screen and placed in the new messages folder in the mailbox.

■ Save — A voice message will be delivered to the voice

number listed on the Delivery Options screen and placed in the saved message folder in the mailbox.

■ Delete — A voice message will be delivered to the

voice number listed on the Delivery Options screen and placed in the deleted messages folder in the mailbox.

Digits Allowed The maximum number of digits allowed for either the voice

or fax Auto Delivery number for any outbound dial.

Note: Facsimile is supported only on VCX systems.

Voice Number The number to which a voice message delivery notification

will be sent.

Fax Number When enabled, allows you to enter the number to which a

fax message delivery notification will be sent.

Note: Facsimile is supported only on VCX systems.

98 CHAPTER 4: PROVISIONING THE SUBSCRIBER PROFILE

Table 17 Fields on the Delivery Options Screen (continued)

Field Description

Printer Name Allows you to select a printer to which a fax message is

Line Group This designates a specific line or lines to which the message

Line Turnaround Turns on detection of a fax receive tone and enables the

CNG Tone Turns on the automatic detection of a fax send tone

Urgent voice msg only Turns on the auto delivery feature only for the messages

Cover Sheet Accepts a maximum of 44 characters for each line and a

delivered and printed.

Note: Facsimile is supported only on VCX systems.

is sent.

Note: Facsimile is supported only on VCX systems.

sending of faxes that have not already been sent to be printed.

Note: Facsimile is supported only on VCX systems.

(Comfort Noise Generator) and allows receipt of the fax.

Note: Facsimile is supported only on VCX systems.

marked urgent.

maximum of six lines to serve as a cover sheet for a fax message.

Add or change the message delivery criteria on the Message Delivery screen and click on Exit to log those changes and move on.

Note: Facsimile is supported only on VCX systems.

Fax Printing Options This release of IP Messaging provides three fax printing options:

Facsimile is supported only on VCX systems.

■ You can enable Fax AutoDelivery on the Delivery Options screen and

specify a fax machine as the destination. Enter the fax number in the Fax Machine field. Incoming faxes will be automatically sent to and printed at the specified fax machine.

■ You can enable Fax AutoDelivery on the Delivery Options screen and

specify a printer as the destination. Enable the Printer Name field and select a printer from the drop-down list. Incoming faxes will be automatically sent to and printed at the specified printer. Configuring a printer in the VCX Linux environment is described in

■ You can enable your mailbox to receive e-mail messages. Incoming

Appendix A.

faxes will be embedded as TIFF image attachments. You can then use the e-mail account associated with the mailbox to view the message,

Setting Delivery Options 99

open the TIFF attachment, and print the fax. See “Sending Faxes as

TIFF Attachments”.

E-mail is supported only on the 3Com Native TUI.

Sending Faxes as TIFF Attachments

To enable fax delivery as a TIFF image in an e-mail message:

1 Enable the following options on the Subscriber Profile screen (Figure 20),

for the MB Receive Media field:

Fax

POP3 or IMAP (select the protocol used by your e-mail system)

2 Click the Srvs button (on the System Configuration screen) to access the

System Servers screen (

Figure 78). Identify IP Messaging as the Reply

Server (ReplySv). This step is optional. If you do not configure this server type, the From field of the e-mail message containing the fax shows <phone_number/mailbox_number> only instead of <phone_number/mailbox_number@reply_server>.

3 Configure an e-mail account (in Outlook Express, Outlook, or Lotus

Notes) for the mailbox.

4 Create an IMAP or POP3 account that points to your IP Messaging

mailbox. Set the incoming mail server (IMAP or POP3) to be the IP Messaging IP address or domain name.

You can choose to either use the IP Messaging as your outgoing server (SMTP) or a third party server.

5 Configure a third-party SMTP server to allow subscribers to send e-mail

messages to external destinations. If you configure IP Messaging as your only SMTP server, subscribers can send e-mail messages to other IP Messaging subscribers only.

100 CHAPTER 4: PROVISIONING THE SUBSCRIBER PROFILE

Defining a Fixed Text

Message

Setting up the Password

You can set the system to display a fixed message at the top of every e-mail message you send.

To define a fixed text message:

1 Click Ftxt on the Delivery Options screen.

2 Type a message in the textbox.

3 Click Save and then click Exit to return to the Subscriber Profile screen.

To delete a fixed text message:

1 Click Ftxt on the Delivery Options screen.

2 Click Delt to delete the fixed text message. The system asks you:

Delete file? (Y/N)

3 Ty pe Y to delete the file and click Exit to return to the Delivery Options

screen.

The Pass button enables you to change the current password for this mailbox. The subscriber must then change the system password on the next call to the mailbox.

1 Click Pass on the Subscriber Profile screen.

The Enter New Password text box appears.

Provisioning a Subscriber Alias

2 Type in the new password and press Enter. The system prompts you to

reenter the password.

3 Type in the password again and press Enter to exit to the Subscriber

Profile screen.

Use the Alis button to create an alias for a subscriber. An alias is an alternative identifier for a mailbox.

Aliases can only be configured by administrators.

An alias provides the ability to define multiple devices that point to a single mailbox. IP Messaging is then made aware of the subscriber's identity even when that subscriber calls from another phone. The alias type can include telephone numbers, e-mail addresses and names. Each alias can have its own password, personal greeting, and auto login defined by the subscriber.

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

Starting Call Builder 31

Application Utility (AppMon)

Figure 3 Message Window Screen

Error Messages Error messages appear in wide, red windows on the App window. You

Accessing Voicemail Administration

Process Monitor Utility

Message Utility The Message utility is a runtime environment-monitoring program that

Stopping Call Builder

MAINTENANCE

About VCX Passwords

System Startup IP Messaging starts automatically or manually:

IP Messaging Shut Down and Restart

Using EMS to Change IP Messaging System Status

IP Messaging Backup and Restore

Managing Archived Messages

Data Backup An IP Messaging backup creates a file that includes subscriber profiles,

Message Archival An archive is a cumulative backup of all subscriber messages (voice,

Enabling Secure Copy and Secure Shell Commands

Network Time Protocol (NTP) Configuration

Configuration To configure Network Time Protocol on the two systems:

Manual Switchover 63

Verification To verify that the NTP service is properly configured, run this command:

Verifying Server Synchronization

Database To verify database synchronization, at the command line, enter this

File System To verify that the file systems are synchronized, follow the procedures in

Managing Log and CDR Files

CDR File Maintenance Storage of CDRs is not an issue if your VCX system includes a dedicated

CODEC Overview 69

Changing CODECs When you change the CODEC used on an IP Messaging system, you must

Voice Prompt Overview

CONFIGURING THE SYSTEM ADMINISTRATOR PROFILE

Configuring the Administrator Profile

Setting Permissions Setting permissions grants or limits privileges to administrators. You can

PROVISIONING THE SUBSCRIBER PROFILE

Creating a Subscriber Profile

Modifying a Subscriber Profile

Setting Delivery Options

Fax Printing Options This release of IP Messaging provides three fax printing options:

Setting up the Password

Provisioning a Subscriber Alias