Avaya Communication Manager API and Call Capture EngineInstallation and Administration for Witness ContactStore for Communication Manager
07-300033Issue 1
October 2003
© 2003 Avaya Inc.All Rights Reserved.
NoticeWhile reasonable efforts were made to ensure that the information in this document was complete and accurate at the time of printing, Avaya Inc. can assume no liability for any errors. Changes and corrections to the information in this document may be incorporated in future releases.
Preventing toll fraud"Toll fraud" is the unauthorized use of your telecommunications system by an unauthorized party (for example, anyone who is not a corporate employee, agent, subcontractor, or person working on your company's behalf). Be aware that there may be a risk of toll fraud associated with your system and that, if toll fraud occurs, it can result in substantial additional charges for your telecommunications services.
Avaya fraud interventionIf you suspect that you are being victimized by toll fraud and you need technical assistance or support, call Technical Service Center Toll Fraud Intervention Hotline at +1-800-643-2353 for the United States and Canada. For additional support telephone numbers, see the Avaya Web site:http://www.avaya.com Select Support, then select Escalation Lists. This Web site includes telephone numbers for escalation within the United States. For escalation telephone numbers outside the United States, select Global Escalation List.
Providing telecommunications securityTelecommunications security (of voice, data, and video communications) is the prevention of any type of intrusion to (that is, either unauthorized or malicious access to or use of) your company's telecommunications equipment by some party.Your company's "telecommunications equipment" includes both this Avaya product and any other voice/data/video equipment that could be accessed via this Avaya product (that is, "networked equipment").An "outside party" is anyone who is not a corporate employee, agent, subcontractor, or person working on your company's behalf. Whereas, a "malicious party" is anyone (including someone who may be otherwise authorized) who accesses your telecommunications equipment with either malicious or mischievous intent.Such intrusions may be either to/through synchronous (time-multiplexed and/or circuit-based) or asynchronous (character-, message-, or packet-based) equipment or interfaces for reasons of:
� Use (of capabilities special to the accessed equipment)� Theft (such as, of intellectual property, financial assets, or
toll-facility access)� Eavesdropping (privacy invasions to humans)� Mischief (troubling, but apparently innocuous, tampering)� Harm (such as harmful tampering, data loss or alteration,
regardless of motive or intent)Be aware that there may be a risk of unauthorized intrusions associated with your system and/or its networked equipment. Also realize that, if such an intrusion should occur, it could result in a variety of losses to your company (including, but not limited to, human and data privacy, intellectual property, material assets, financial resources, labor costs, and legal costs).
Your responsibility for your company's telecommunications securityThe final responsibility for securing both this system and its networked equipment rests with you, an Avaya customer's system administrator, your telecommunications peers, and your managers. Base the fulfillment of your responsibility on acquired knowledge and resources from a variety of sources, including, but not limited to:
� Installation documents� System administration documents� Security documents� Hardware-/software-based security tools� Shared information between you and your peers� Telecommunications security experts
To prevent intrusions to your telecommunications equipment, you and your peers should carefully program and configure:
� Your Avaya-provided telecommunications systems and their interfaces
� Your Avaya-provided software applications, as well as their underlying hardware/software platforms and interfaces
� Any other equipment networked to your Avaya products.
WarrantyAvaya Inc. provides a limited warranty on this product. Refer to your sales agreement to establish the terms of the limited warranty. In
addition, Avaya�s standard warranty language, as well as information regarding support for this product, while under warranty, is available through the following Web site:http://www.avaya.com/support
Link disclaimerAvaya Inc. is not responsible for the contents or reliability of any linked Web sites and does not necessarily endorse the products, services, or information described or offered within them. We cannot guarantee that these links will work all of the time and we have no control over the availability of the linked pages.
TrademarksAvaya is a trademark of Avaya Inc.
All trademarks identified by the ® or � are registered trademarks or trademarks, respectively, of Avaya Inc. All other trademarks are the property of their respective owners
Third-party software license agreements
Castor software Castor Copyright 2000-2002 (C) Intalio Inc. All Rights Reserved. Redistribution and use of this software and associated documentation (�Software�), with or without modification, are permitted provided that the following conditions are met:
� Redistributions of source code must retain copyright statements and notices. Redistributions must also contain a copy of this document.
� Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
� The name �ExoLab� must not be used to endorse or promote products derived from this Software without prior written permission of Intalio Inc. For written permission, please contact [email protected].
� Products derived from this Software may not be called �Castor� nor may �Castor� appear in their names without prior written permission of Intalio Inc. Exolab, Castor and Intalio are trademarks of Intalio Inc.
� Due credit should be given to the ExoLab Project (http://www.exolab.org/).
THIS SOFTWARE IS PROVIDED BY INTALIO AND CONTRIBUTORS ��AS IS�� AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
JBossJBoss is licensed under GPL license. See http://www.gnu.org for details.JBoss and JBoss Group are a registered trademark and servicemark of Mark Fleury under operation by the JBoss Group, LCC.ApacheThis product includes software developed by the Apache Software Foundation (http://www.apache.org/).The Apache Software License, Version 1.1Copyright (c) 2000 The Apache Software Foundation. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
� Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
� Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
� The end-user documentation included with the redistribution, if any, must include the following acknowledgment: "This product includes software developed by the Apache Software Foundation (http://www.apache.org/)." Alternately, this acknowledgment may appear in the software itself, if and wherever such third-party acknowledgments normally appear.
� The names "Apache" and "Apache Software Foundation" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact [email protected].
� Products derived from this software may not be called "Apache", nor may "Apache" appear in their name, without prior written permission of the Apache Software Foundation.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.This software consists of voluntary contributions made by many individuals on behalf of the Apache Software Foundation. For more information on the Apache Software Foundation, please see <http://www.apache.org/>.Portions of this software are based upon public domain software originally written at the National Center for Supercomputing Applications, University of Illinois, Urbana-Champaign.
Ordering information: Avaya Publications CenterVoice: +1-207-866-6701
1-800-457-1764 (Toll-free, U.S. and Canada only)
Fax: +1-207-626-72691-800-457-1764 (Toll-free, U.S. and Canada only)
Write: Globalware Solutions200 Ward Hill AvenueHaverhill, MA 01835 USAAttention: Avaya Account Manager
Web: http://www.avayadocs.com E-mail: [email protected]
Avaya supportAvaya provides a telephone number for you to use to report problems or to ask questions about your contact center. The support telephone number is 1-800-242-2121 in the United States. For additional support telephone numbers, see the Avaya Web site:http://www.avaya.com Select Support, then select Escalation Lists. This Web site includes telephone numbers for escalation within the United States. For escalation telephone numbers outside the United States, select Global Escalation List.
CommentsTo comment on this document, send e-mail to [email protected].
AcknowledgmentThis document was written by the CRM Information Development group.
Issue 1 October 2003 5
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9About Communication Manager API and Call Capture Engine . . . . . . . . . . . . . . 9Purpose of this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Intended user of this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Overview of this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Safety labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Reasons for reissuing this document . . . . . . . . . . . . . . . . . . . . . . . . . . 12Availability of this document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Related documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Conventions used in this document . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Verifying Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Call Capture Engine hardware requirements . . . . . . . . . . . . . . . . . . . . . . . 16Call Capture Engine software requirements . . . . . . . . . . . . . . . . . . . . . . . 17Communication Manager and media server requirements . . . . . . . . . . . . . . . . 18Required network characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Installing softwareon the Call Capture Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Installing Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Tuning the Linux installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Installing Java . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Installing the server software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
User accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28What�s next? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Administering Communication Manager for Call Capture Engine and Communication Manager API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Procedures specific to Communication Manager API and Call Capture Engine. . . . . . . 30Checking for Communication Manager licenses. . . . . . . . . . . . . . . . . . . . . 30
Example screens:checking for Communication Manager licenses . . . . . . . . . . . . . . . . . . . 31
Example screens:checking for IP API_A licenses. . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Setting system parameters on
Avaya Communication Manager APIand Call Capture Engine
Installation and Administration
Contents
Contents
6 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Communication Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Example screens:
setting system parameters on Communication Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Setting feature access codes required by theCall Capture Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Example screen:setting feature access codes for Call Capture Engine . . . . . . . . . . . . . . . . . 35
Adding stations for the Call Capture Engine . . . . . . . . . . . . . . . . . . . . . . 35Example screens:
adding stations for the application . . . . . . . . . . . . . . . . . . . . . . . . . 37Administering hunt groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Configuring IP services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Example screen:configuring IP services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Setting up a network region for Communication Manager API . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Creating the Communication Manager APICODEC set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Example screen:setting up a CODEC set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Administering a network region with that CODEC set . . . . . . . . . . . . . . . . . 41Example screen:
administering a network region . . . . . . . . . . . . . . . . . . . . . . . . . . 42Adding the Communication Manager API
softphones to the network region . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Example screen:
mapping IP addresses (for API softphones). . . . . . . . . . . . . . . . . . . . . 44Other Communication Manager Procedures . . . . . . . . . . . . . . . . . . . . . . . 45
Adding a media gateway to the network . . . . . . . . . . . . . . . . . . . . . . . . 45Example screen:
adding a media gateway. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Adding a C-LAN to the network . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Example screen:Adding a data module (C-LAN) . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Example screen:changing an IP node name (C-LAN and media processor). . . . . . . . . . . . . . 48
Example screen:changing an IP interface (C-LAN and media processor) . . . . . . . . . . . . . . . 48
Adding a media processor circuit pack to the network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Setting up tone detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Setting up out-of-band tone detection
(recommended) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Example screens:
setting up out-of-band tone detection. . . . . . . . . . . . . . . . . . . . . . . . 51Setting up inband tone detection . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Example configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53What�s next? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Contents
Issue 1 October 2003 7
Administering the Communication Manager API and Call Capture Engine . . . . . . 55Configuring the Communication Manager API and Call Capture Engine . . . . . . . . . . 56
Editing the startup configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . 56Editing the Communication Manager API configuration properties file . . . . . . . . . . 57Example Communication Manager API
configuration properties file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Customizing OpenLDAP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Customizing the Samba server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Starting the Call Capture Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64What�s next? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Appendix A: Sample RPM execution . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Appendix B: Tuning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Utilizing more physical memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Setting up the hard disk drive to use DMA . . . . . . . . . . . . . . . . . . . . . . . . 72
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Contents
8 Avaya Communication Manager API and Call Capture Engine Installation and Administration
About Communication Manager API and Call Capture Engine
Issue 1 October 2003 9
Preface
This document includes the following topics:
● About Communication Manager API and Call Capture Engine on page 9
● Purpose of this document on page 10
● Intended user of this document on page 10
● Overview of this document on page 11
● Safety labels on page 12
● Reasons for reissuing this document on page 12
● Availability of this document on page 12
● Related documentation on page 13
● Conventions used in this document on page 14
About Communication Manager API and Call Capture Engine
The Avaya Communication Manager API and the Call Capture Engine software is provided as the convergence technology to support the Witness ContactStore solution. In order to support the Witness ContactStore call recording solution for both IP and traditional end-points, the Communication Manager API and Call Capture Engine software run on industry-standard harware and operating systems. This software enables up to 60 ports of simultaneous call recording sessions for the following recording modes:
● Station bulk recording - record all calls for this station unless the user initiates a delete command during the call.
● Station executive recording - record all calls for this station, but retain the recording only by user request
● Station on-demand recording - record the current call from the point that user initiates the recording. This feature is typically invoked through a feature button on the telephone.
Preface
10 Avaya Communication Manager API and Call Capture Engine Installation and Administration
● Meeting recording - record meetings or conversations for later review by conferencing in a recording line.
See the Witness ContactStore documentation for further details.
Purpose of this documentThe purpose of this document is to describe installation and administration procedures for the Avaya Communication Manager API and Call Capture Engine to work with the Witness ContactStore for Communication Manager.
Intended user of this documentThis document is written for the system administrators, system integrators, and support personnel with Linux experience to install and configure the following components to operate with the Call Capture Engine and Witness ContactStore:
● the Linux environment
● the Communication Manager
● the Communication Manager API
● the Call Capture Engine software
Overview of this document
Issue 1 October 2003 11
Overview of this documentThis document includes the following topics:
● Verifying Prerequisites on page 15.
● Installing software on the Call Capture Engine on page 21
● Administering Communication Manager for Call Capture Engine and Communication Manager API on page 29
● Administering the Communication Manager API and Call Capture Engine on page 55
● Sample RPM execution on page 67
● Tuning on page 69
● Index on page 75.
Preface
12 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Safety labelsIf you see any of the following safety labels in this document, take careful note of the information presented.
! CAUTION:CAUTION: Caution statements call attention to situations that can result in harm to
software, loss of data, or an interruption in service.
! WARNING:WARNING: Warning statements call attention to situations that can result in harm to
hardware or equipment.
! DANGER:DANGER: Danger statements call attention to situations that can result in harm to
personnel.
! SECURITY ALERT:SECURITY ALERT: Security alert statements call attention to situations that can increase the
potential for unauthorized use of a telecommunications system.
Reasons for reissuing this documentThis is the first issue of this document.
Availability of this documentCopies of this document are available from the Avaya online support Web site, http://www.avayadocs.com
Related documentation
Issue 1 October 2003 13
Related documentationYou might find the following documentation useful:
● AvayaTM Communication Manager Contact Center - Guide to ACD Contact Centers, 555-233-516-1
● Administrator�s Guide for AvayaTM Communication Manager, 555-233-506-6
● Administration for Network Connectivity for AvayaTM Communication Manager, 555-233-506-4
● Witness ContactStore documentation
Note:Note: Avaya documentation is available through the Avaya online support Web
site, http://www.avayadocs.com.
Preface
14 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Conventions used in this documentThe following typefaces are used in this document:
Torepresent . . .
This typeface and syntax are shown as . . .
For example, . . .
SAT commands
● Bold for literals● Bold italic for variables
change signaling group x
SAT screen input and output
● Bold for input● Constant width for output (screen displays and messages)
For DTMF Over IP, enter in-band-g711The message Command successfully completed should appear.
Linux commands
● Constant-width bold for literals
● Constant-width bold italics for variables
As root, enter rpm -Uv mvcs-release#-1.noarch.rpm
Linux output and screen displays
Constant width If the following lines appear and there are no exceptions, the system has successfully started:
INFO | jvm 1 | timestamp info INFO [MainDeployer] Deployed package: file:/opt/mvcscce/jboss-3.0.7/server/default/conf/jboss-service.xml
Linux interface
Bold for menu selections, tabs, buttons, and field names
At the Installation Type prompt, select Install and Server.
Issue 1 October 2003 15
Verifying Prerequisites
This chapter explains the prerequisites for running the Call Capture Engine. These prerequisites include:
● Call Capture Engine hardware requirements on page 16
● Call Capture Engine software requirements on page 17
● Communication Manager and media server requirements on page 18
● Required network characteristics on page 19
Before installing the Call Capture Engine, make sure your system meets the following hardware, software, and network requirements.
Verifying Prerequisites
16 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Call Capture Engine hardware requirementsMinimum specifications 2-GHz single-processor Pentium IV class
machine with:● 500 MHz front side bus● 512K of L2 cache● 1 GB RAM● 40 GB hard disk with at least 7200 rpm rating
Note:Note: See sizing recommendations for
the disk in Installing Linux on page 22.
● 10/100 ethernet NIC port (should be duplex)● CD-ROM drive
The above specifications provide this performance:
Supports 60 active simultaneous calls, call rate of 60 calls per station per hour (or 3600 calls/hour total)
Call Capture Engine software requirements
Issue 1 October 2003 17
Call Capture Engine software requirementsBesides the Call Capture Engine software, the following software is needed to run the server.
Operating system Red Hat Linux 7.3, with● kernel version 2.4.20-18● modutils-2.4.18-3.7x
Note:Note: Linux 9.0 does NOT work with
Communication Manager API and Call Capture Engine 1.3 software.
Other software Java 2 platform (Java SDK J2SE 1.4.1_03, which includes Runtime Environment 1.4.1_03)
Verifying Prerequisites
18 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Communication Manager and media server requirements
You must have Communication Manager R1.3 or later running the latest load. Check for the latest load at http://support.avaya.com.
The server running Communication Manager must be a DEFINITY server SI or Linux-based Avaya media server such as S8700 or S8300. This document set provides further information and procedures for only the Linux-based media servers.
Additional hardware requirements for these servers include:
● For G3SI
- C-LAN circuit pack: TN799DP or newer
- Media processor circuit pack: TN2302AP
(one for every 64 G.711 channels of media)
● For S8700
- C-LAN circuit pack: TN799DP or newer
- Media processor circuit pack: TN2302AP
(one for every 64 G.711 channels of media)
- (optional) G700 media gateway
● For S8300
- G700 media gateway
- AvayaTM MM760 VoIP media module (in the G700)
Software requirements for all media servers include:
● When using On-Demand Recording or Meeting Recording, one of the following licenses is required:
- Communication Manager Advanced Software License
- Communication Manager Enhanced Software License (if the media server has the Communication Manager Basic Software License)
● When using Station Bulk Recording or Station Executive Recording, the Communication Manager Advanced Software License
Witness ContactStore licenses are required based on the number of lines and features you require. Also, an IP_API_A license is required for every Witness ContactStore license purchased for the Avaya Communication Manager to operate the Call Capture Engine successfully. See Checking for Communication Manager licenses on page 30 to determine if you have the sufficient number of licenses.
Required network characteristics
Issue 1 October 2003 19
Required network characteristicsThe following minimum network characteristics must be met on the connection between the Communication Manager and the Call Capture Engine:
● 100 Mbps full duplex network interface on the server
● 100% switched network, ideally on the same switch
● All-LAN network (no WAN links)
Verifying Prerequisites
20 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Issue 1 October 2003 21
Installing softwareon the Call Capture Engine
This chapter explains how to install all of the software necessary to run the Call Capture Engine. The procedures include:
● Installing Linux on page 22
● Installing Java on page 25
● Installing the server software on page 26
Installing software on the Call Capture Engine
22 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Installing Linux 1. Install Red Hat Linux 7.3. Follow the instructions of the Red Hat installation utility to
install your system.
2. At the Installation Type prompt, select Install and Server. If you select a different installation type, you may neglect to install necessary software packages.
3. At the Disk Partitioning Setup prompt, select Manually Partition with Disk Druid to allow the creation of a partition solely for the use of the voice files recorded by the Call Capture Engine.
If you choose Have the installer automatically partition for you, the system uses the root partition to store recordings and you must ensure the root partition is large enough to handle these recordings.
4. At the Disk Setup prompt, press DELETE to remove any partitioning that appears for the hard drive.
5. Add partitions according to the recommendations in the table below, using the NEW button.
* 2048MB is based on a rule using twice the size of the physical memory as the size of the swap partition.
** The /cce partition will be used to store or buffer the voice recordings captured until they are moved into the ContactStore. The larger the /cce partition or disk space available for the /cce directory, the longer the system is able to recover from a network outage preventing the ContactStore from moving the voice files. Usually the ContactStore copies the files in a matter of seconds to keep the time the files are stored on the Call Capture Engine to a minimum as the files are not covered by a backup mechanism.
Mount Point Partition Size(40 GB HD)
File System Type
Remark
/boot 100 MB Ext3
/swap 2048 MB * Swap
/ 9800 MB Ext3
/cce 27000 MB ** Ext3 To store the captured voice files
Total 38948 MB
Installing Linux
Issue 1 October 2003 23
If you are using smaller or larger disks please adjust the size of the /cce partition accordingly. Assuming that 60 lines are capturing calls all the time, the system requires approximately 1.7 GB for a full hour of recording to temporarily store the recording files on the system in case of a network outage in the communication with the ContactStore.
6. At the Network Configuration prompt, select whether your network parameters are configured using DHCP or enter the parameters manually for all your network interface cards. Enable �Activate on boot� for all devices you are using.
Note:Note: Make sure not to enter any spaces for the Hostname parameter as this will
lead to errors.
7. At the Firewall configuration prompt, select No Firewall as the security level.
! SECURITY ALERT:SECURITY ALERT: Selecting No Firewall allows internal users to access the Linux server.
Place the server in a properly protected network segment. Your network firewall should provide the needed security to prohibit access to the Linux server from outside your network.
8. At the Account Configuration prompt, enter the root password. Note the password chosen and keep it in a safe place. You will need the password later on to complete the installation process and for future system maintenance.
The Call Capture Engine installation process automatically adds additional accounts to the system later.
Note:Note: It is your responsibility to keep all passwords secure.
9. At the Package Group Selection choose the following:
X Window SystemGNOMEKDENFS File ServerWindows File ServerSelect individual packages
10. At the Individual Package Selection, select the package openldap-servers under 'System Environment', 'Daemons' (assuming you are using the tree view). This package is required for the overall installation to complete successfully.
If this prompt isn't presented, go back one step to Package Group Selection and check Select individual packages (see above).
11. After having installed all packages, at the Customize Graphics Configuration choose your default desktop environment as GNOME or KDE. If your Call Capture Engine solution will record a large number of calls, you may choose Text as your login type. Using this login type avoids additional process load on the system as a result of the graphical user interface which may impact performance of the call capture process.
Installing software on the Call Capture Engine
24 Avaya Communication Manager API and Call Capture Engine Installation and Administration
12. Complete the Linux installation and reboot the system.
13. Install these additional Red Hat packages. This kernel package and the modutils package it depends on must be installed to allow access to more of the system�s physical memory. For example, it allows a system with 1 GB RAM access to more than 960 megabytes of memory.
● modutils-2.4.18-3.7x.i386.rpm
● kernel-2.4.20-18.7.i686.rpm
You can find these packages on:
● One of the mirrors on the Red Hat Web site (www.redhat.com).
or
● www.rpmfind.net
In the Search box, enter kernel (or modutils), and in the System box, enter redhat-7.3.
The system provides a list of RPMs from which to select a download.
For instructions for performing the steps to utilize more of the physical memory, see Utilizing more physical memory on page 70.
Tuning the Linux installationThe standard installation of Linux activates some daemons not needed for the Call Capture Engine. Use the following procedure to disable the sendmail and lpd daemons:
1. Log in as root, if you are not already.
2. At the root prompt, enter the following commands:
chkconfig --del sendmail
chkconfig --del lpd
The daemons are disabled at the next system reboot.
Tuning on page 69 contains additional information on how to tune the Linux system if you experience performance issues (for example, high processor occupancy when the Call Capture Engine is operational). Avaya recommends you implement the suggestions contained in the appendix regardless of actual resource utilization. In many cases, these recommendations may be activated by default when installing Linux.
Installing Java
Issue 1 October 2003 25
Installing JavaTo install the Java 2 Platform SDK:
1. Download the latest Java 2 platform, standard edition (J2SE) from http://java.sun.com.
Note:Note: Communication Manager API has been tested on J2SE 1.4.1_03. It will not
work with earlier versions of the Sun Java JDK.
2. Install the Java J2SE SDK through the RPM mechanism according to the instructions provided by Sun Microsystems.
Note:Note: Do not use the self-extracting executable as the Java installation program
checks the Java RPM is being installed.
3. Run a sample Java program to verify the proper installation of the Java platform.
Installing software on the Call Capture Engine
26 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Installing the server software The server software RPM is:
mvcscce-release#1-release#2-1.noarch.rpm
where release#1 is the Communication Manager API software and release#2 is the Call Capture Engine software (for example, mvcscce-0069-0069-1.noarch.rpm).
The RPM contains the Communication Manager API, the JBoss Web application server, the Call Capture Engine software, and various configuration files. To install these software components, do the following:
1. Copy the RPM to your computer.
It doesn�t matter where you place them in your directory system.
If the software has been provided on a CD, do the following:
a. Insert the CD in the drive.
b. Enter mount /mnt/cdrom
c. Copy the file to system.
d. Enter eject to remove the CD from the drive.
2. To expand the RPM that contains the Communication Manager API, JBoss, and Call Capture Engine software:
As root, execute rpm -Uv mvcscce-release#1-release#2-1.noarch.rpm (where release#1 and release#2 are composed of digits that represent the release numbers).
See Sample RPM execution on page 67 to show the output of the RPM expanding successfully. When the RPM expands, the following directories and files are placed in these locations:
● The main server directory
/opt/mvcscce● The JBoss server
/opt/mvcscce/jboss-3.0.7
Installing the server software
Issue 1 October 2003 27
● The configuration files
Note:Note: The Communication Manager API configuration file must be modified before
completing installation. See Editing the Communication Manager API configuration properties file on page 57.
Communication Manager API /opt/mvcscce/jboss-3.0.7/server/default/conf/cmapi-user-configuration.properties
LDAP access for Call Capture Engine/opt/mvcscce/jboss-3.0.7/server/default/conf/ldapConfig.xml
● The installation configuration files
Note:Note: These files are used only in the configuration process. Changing these files
will not change your running configuration. Do not change these files in order to use them for debugging.
Open LDAP/opt/mvcscce/cce-ldapSamba server/opt/mvcscce/cce-sambaNFS/opt/mvcscce/cce-nfs
● The startup configuration file
/etc/sysconfig/cce● The start/stop script for the application
/etc/init.d/cce● Log files
/opt/mvcscce/jboss-3.0.7/logs/opt/mvcscce/jboss-3.0.7/server/default/log
● The directory to temporarily store captured calls
/cce/recorder● The directory for files to be played by the application
/cce/player
Installing software on the Call Capture Engine
28 Avaya Communication Manager API and Call Capture Engine Installation and Administration
User accountsThe Call Capture Engine RPM installation created the following three additional user accounts on the system:
● avaya - This account is only for internal use by the Communication Manager API and Call Capture Engine software.
● cceaudio - This account is only for internal use to allow the ContactStore to access the captured voice files through Samba or NFS.
● cceadmin - This account is intended for administration and maintenance of the Call Capture Engine software.
To change the default cceadmin password after installation, do the following:
1. Log in as root.
Note:Note: Use the root login only in necessary situations, such as when changing
default passwords.
2. Enter passwd cceadmin3. Enter the new cceadmin password.
4. Write down all passwords and store them in a secure place.
What�s next?Continue with Administering Communication Manager for Call Capture Engine and Communication Manager API.
Issue 1 October 2003 29
Administering Communication Manager for Call Capture Engine and Communication Manager API
This section explains how to administer Communication Manager so that it can work with the server to run Communication Manager API and the Call Capture Engine software. The Call Capture Engine software uses the Communication Manager API as the underlying software to interact with the Communication Manager. You use Communication Manager system access terminal (SAT) commands to perform these procedures.
The following sections explain:
● Procedures specific to Communication Manager API and Call Capture Engine on page 30. Describes the Communication Manager administration procedures specific to Call Capture Engine
● Other Communication Manager Procedures on page 45 that may or may not have already been performed for your Communication Manager network
● Example configuration on page 53. Provides a graphical view of the example Communication Manager/Communication Manager API/Call Capture Engine configuration followed in this chapter.
Note:Note: The procedures and screen examples in this chapter reference the
configuration example provided on page 55.
Administering Communication Manager for Call Capture Engine and Communication Manager API
30 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Procedures specific to Communication Manager API and Call Capture Engine
This section explains procedures that are necessary for running the Call Capture Engine. These are procedures that probably have not been performed for other Communication Manager configurations.
Checking for Communication Manager licensesCertain licenses on Communication Manager must be obtained and activated to successfully run the Communication Manager API and Call Capture Engine. See Communication Manager and media server requirements on page 18 for additional information.
To see if you have the correct or sufficient number of licenses enabled to run the Communication Manager API and Call Capture Engine, check the System-Parameters Customer-Options screen:
1. Run display system-parameters customer-options
2. On page 3 verify that Enhanced Conferencing is set to y.
3. On page 5 verify that Service Observing Basic and Service Observing by FAC are set to y.
Note:Note: Service Observing is required only for the following recording modes:
● Station Bulk Recording
● Station Executive Recording
Service Observing VDN is not supported by this solution.
4. On page 9 or 10 (it varies depending on your system), verify that you have the appropriate number of IP_API_A licenses by checking Maximum IP registrations by product ID field. This field tells you how many IP_API_A licenses you have and how many you have already used. You must have an IP_API_A license for each Communication Manager API softphone run by the Call Capture Engine. These licenses are equivalent to the number of simultaneous recordings the server will support. The maximum number of licenses is 60).
If you do not have enough IP_API_A licenses or if IP_API_A product ID is not listed on this screen, contact your Avaya representative for more licenses.
Procedures specific to Communication Manager API and Call Capture Engine
Issue 1 October 2003 31
See the following examples for how to fill out the forms.
Example screens:checking for Communication Manager licenses
display system-parameters customer-options Page 3 of 10 OPTIONAL FEATURES
Emergency Access to Attendant? y ISDN Feature Plus? y Enable 'dadmin' Login? n ISDN Network Call Redirection? y Enhanced Conferencing? y ISDN-BRI Trunks? y Enhanced EC500? n ISDN-PRI? y Extended Cvg/Fwd Admin? y Local Spare Processor? n External Device Alarm Admin? y Malicious Call Trace? y Five Port Networks Max Per MCC? n Media Encryption Over IP? y Flexible Billing? n Mode Code for Centralized Voice Mail? n Forced Entry of Account Codes? n Global Call Classification? y Multifrequency Signaling? y Hospitality (Basic)? y Multimedia Appl. Server Interface (MASI)? n Hospitality (G3V3 Enhancements)? n Multimedia Call Handling (Basic)? n IP Trunks? y Multimedia Call Handling (Enhanced)? n Multiple Locations? y IP Attendant Consoles? n Personal Station Access (PSA)? y IP Stations? y Posted Messages? n Internet Protocol (IP) PNC? n
(NOTE: You must logoff & login to effect the permission changes.
display system-parameters customer-options Page 5 of 10 CALL CENTER OPTIONAL FEATURES
Call Center Release: 11.1
ACD? y PASTE (Display PBX Data on Phone)? y BCMS (Basic)? y Reason Codes? y
BCMS/VuStats Service Level? y Service Observing (Basic)? y Business Advocate? y Service Observing (Remote/By FAC)? y Call Work Codes? y Service Observing (VDNs)? y DTMF Feedback Signals For VRU? y Timed ACW? y Dynamic Advocate? n Vectoring (Basic)? y Expert Agent Selection (EAS)? y Vectoring (Prompting)? y EAS-PHD? y Vectoring (G3V4 Enhanced)? y Forced ACD Calls? n Vectoring (ANI/II-Digits Routing)? y Vectoring (G3V4 Advanced Routing)? y Lookahead Interflow (LAI)? y Vectoring (CINFO)? yMultiple Call Handling (On Request)? y Vectoring (Best Service Routing)? y Multiple Call Handling (Forced)? y Vectoring (Holidays)? y
(NOTE: You must logoff & login to effect the permission changes.)
Administering Communication Manager for Call Capture Engine and Communication Manager API
32 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Example screens:checking for IP API_A licenses
Setting system parameters onCommunication Manager
In order for the Call Capture Engine to work properly with Communication Manager, do the following:
1. Enter change system-parameters features
2. On page 4 set Create Universal Call ID (UCID) to y
! CAUTION:CAUTION: Do not administer a UCID Network Node ID larger than 9200. Larger UCID
network node IDs are not supported in this release of the Call Capture Engine software.
3. On page 10, you may want to enable the Service Observing warning tone. This is not required.
The warning tone can be generated either by the Communication Manager or the Call Capture Engine. Refer to the Witness ContactStore documentation for additional information. We recommend generating the Service Observing warning tone on Communication Manager as this can be executed more efficiently than on the Call Capture Engine.
MAXIMUM IP REGISTRATIONS BY PRODUCT ID
Product ID Rel. Limit UsedIP_API_A : 60 0IP_Agent : 0 0IP_Phone : 1000 104IP_ROMax : 50 15IP_Soft : 500 0IP_eCons : 5 0 : 0 0 : 0 0 : 0 0 : 0 0 : 0 0 : 0 0 : 0 0 : 0 0 : 0 0(NOTE: You must logoff & login to effect the permission changes.)
Procedures specific to Communication Manager API and Call Capture Engine
Issue 1 October 2003 33
! CAUTION:CAUTION: Listening to someone else's call may be subject to federal, state, or local
laws, rules, or regulations. It may require the consent of one or both of the parties on the call. Familiarize yourself with all applicable laws, rules, and regulations and comply with them when using the Call Capture Engine. If you have any questions, seek in-house legal support.
The Service Observing warning tone plays either a one time tone or a repeating tone indicating that the conversation is recorded for the following recording modes:
● Station Bulk Recording
● Station Executive Recording
For On-demand Recording, Communication Manager offers the ability to play warning tones through the conference tone or directly associated with One-Step Recording through AUDIX (audix-rec) feature button, depending on the method chosen to invoked recording.
For Meeting Recording, the default is to not set a warning tone to prevent distrubtion of the meeting. However, if you do require a warning tone, you can set it as described fro On-Demand Recording.
See the following example for how to fill out the form.
Example screens:setting system parameters on Communication Manager
change system-parameters features Page 4 of 12 FEATURE-RELATED SYSTEM PARAMETERS
SYSTEM PRINTER PARAMETERS System Printer Endpoint: Lines Per Page: 60
SYSTEM-WIDE PARAMETERS Switch Name: Your switch Emergency Numbers - Internal: External: No-License Incoming Call Number:
MALICIOUS CALL TRACE PARAMETERS Apply MCT Warning Tone? n MCT Voice Recorder Trunk Group: Delay Sending RELease (seconds)? 0SEND ALL CALLS OPTIONS Send All Calls Applies to: station Auto Inspect on Send All Calls? y
UNIVERSAL CALL ID Create Universal Call ID (UCID)? y UCID Network Node ID: 1
Administering Communication Manager for Call Capture Engine and Communication Manager API
34 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Setting feature access codes required by theCall Capture Engine
To set the feature access codes required by the Call Capture Engine, do the following:
1. Run change feature-access-codes
2. On page 5, set following feature access codes according to your dial plan:
● Service Observing Listen Only Access Code
● Service Observing Listen/Talk Access Code
The codes you enter here on the Communication Manager must match the codes you enter when administering the ContactStore.
See the following example for how to fill out the form.
change system-parameters features Page 10 of 12 FEATURE-RELATED SYSTEM PARAMETERS
CALL CENTER SYSTEM PARAMETERS EAS Expert Agent Selection (EAS) Enabled? y Minimum Agent-LoginID Password Length: Direct Agent Announcement Extension: Delay: Message Waiting Lamp Indicates Status For: station
VECTORING Converse First Data Delay: 0 Second Data Delay: 2 Converse Signaling Tone (msec): 100 Pause (msec): 70 Prompting Timeout (secs): 10 Interflow-qpos EWT Threshold: 2 Reverse Star/Pound Digit For Collect Step? n Available Agent Adjustments for BSR? y SERVICE OBSERVING Service Observing: Warning Tone? y or Conference Tone? n ASAI Call Classification After Answer Supervision? y Send UCID to ASAI? y
Procedures specific to Communication Manager API and Call Capture Engine
Issue 1 October 2003 35
Example screen:setting feature access codes for Call Capture Engine
Adding stations for the Call Capture EngineYou must add stations on the Communication Manager that the Call Capture Engine uses to register the lines or ports for the call capturing process. One Call Capture Engine supports a maximum of 60 ports and the same number of stations need to be administered on the Communication Manager.
All lines will be assigned to specific recording modes detailing their mode of operation through the Witness administration procedures. See specific details in Witness ContactStore documentation.
Use the add station command to add as many stations as your design requires. The data you enter must match the data when administering the ContactStore later.
1. Run add station xxxx, where xxxx is the new station's extension you want to administer.
2. For station type, enter 4624
change feature-access-codes Page 5 of 6 FEATURE ACCESS CODE (FAC)
Automatic Call Distribution Features
After Call Work Access Code: *84 Assist Access Code: Auto-In Access Code: *82 Aux Work Access Code: *85 Login Access Code: *80 Logout Access Code: *81 Manual-in Access Code: *83 Service Observing Listen Only Access Code: *87 Service Observing Listen/Talk Access Code: *89 Add Agent Skill Access Code: Remove Agent Skill Access Code: Remote Logout of Agent Access Code:
Call Vectoring/Prompting Features Converse Data Return Code:
Administering Communication Manager for Call Capture Engine and Communication Manager API
36 Avaya Communication Manager API and Call Capture Engine Installation and Administration
3. For security code, enter a numeric security code to be used by the Call Capture Engine to register with the Communication Manager. Note this security code, as you will use this same security code when administering the ContactStore.
Note:Note: You must select the same security code for all stations being used by the
Call Capture Engine.
4. Ensure that the Class of Restriction (COR) you choose has Can Be A Service Observer �enabled� and Can Be Service Observed �disabled� when you intend to use Station Bulk Recording or Station Executive Recording. Avaya strongly recommends a dedicated COR for the stations being used by the Call Capture Engine.
The COR of the stations you want to record with the recording modes mentioned above must have Can Be Service Observed �enabled�. For more information on how to administer Class of Restriction and Service Observing, see these resources
● �Class of Restriction� in Chapter 18, �Screen reference� in Volume 3 of the Administrator's Guide for Avaya Communication Manager, 555-233-506-6
● �Service Observing� in Chapter 21, �Features and technical reference� in Volume 3 of the Administrator's Guide for Avaya Communication Manager, 555-233-506-6
● �Service Observing� in Chapter 2, �ACD contact center features� in the Avaya Communication Manager Contact Center - Guide to ACD Contact Centers, 555-233-516-1
5. In the IP Softphone field, enter y.
6. Assign the following feature buttons in addition to the three default call appearances:
Position 4: conf-dspPosition 5: serv-obsrv
7. Delete the default call-appearance feature button (call-appr) on feature button number 3.
See the following example for how to fill out the form.
Procedures specific to Communication Manager API and Call Capture Engine
Issue 1 October 2003 37
Example screens:adding stations for the application
Add as many stations as you need for your application and for the Communication Manager API softphones.
add station 23200 Page 1 of 5 STATION
Extension: 23200 Lock Messages? n BCC: 0 Type: 4624 Security Code: * TN: 1 Port: S00142 Coverage Path 1: COR: 1 Name: call capture port 23200 Coverage Path 2: COS: 1 Hunt-to Station:
STATION OPTIONS Loss Group: 19 Personalized Ringing Pattern: 1 Message Lamp Ext: 23200 Speakerphone: 2-way Mute Button Enabled? y Display Language: english
Media Complex Ext: IP SoftPhone? y
add station 23200 Page 2 of 5 STATIONFEATURE OPTIONS LWC Reception: spe Auto Select Any Idle Appearance? n LWC Activation? y Coverage Msg Retrieval? y LWC Log External Calls? n Auto Answer: none CDR Privacy? n Data Restriction? n Redirect Notification? y Idle Appearance Preference? n Per Button Ring Control? n Bridged Call Alerting? n Restrict Last Appearance? y Active Station Ringing: single
H.320 Conversion? n Per Station CPN - Send Calling Number? Service Link Mode: as-needed Multimedia Mode: enhanced Audible Message Waiting? n MWI Served User Type: Display Client Redirection? n AUDIX Name: Select Last Used Appearance? n Coverage After Forwarding? s Multimedia Early Answer? n IP Emergency Calls: extension Direct IP-IP Audio Connections? y Emergency Location Ext: 23200 IP Audio Hairpinning? y
Administering Communication Manager for Call Capture Engine and Communication Manager API
38 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Administering hunt groupsIf your solution is going to use On Demand Recording or Meeting Recording modes, you may want to group the ports dedicated to these recording modes into a hunt group for each mode. This administration allows you to access the recording functionality through the number of the hunt group rather through individual ports and the Communication Manager automatically selects an available port.
How many hunt groups you need and which port you assign to it depends on the solution you want to provide. Maybe you want to assign all ports for On Demand Recording and Meeting Recording into a hunt group to implement a �first come, first served� strategy. Perhaps you may want to assign ports to ensure that a port is available for them.
add station 23200 Page 3 of 5 STATION SITE DATA Room: change sta Headset? n Jack: Speaker? n Cable: Mounting: d Floor: Cord Length: 0 Building: Set Color:
ABBREVIATED DIALING List1: List2: List3:
BUTTON ASSIGNMENTS 1: call-appr 7: 2: call-appr 8: 3: 9: 4: conf-dsp 10: 5: serv-obs 11: 6: 12:
add station 23200 Page 4 of 5 STATION
FEATURE BUTTON ASSIGNMENTS
13: 19:14: 20:15: 21:16: 22:17: 23:18: 24:
Procedures specific to Communication Manager API and Call Capture Engine
Issue 1 October 2003 39
To allow a user to easily access On-Demand Recording from a station, Avaya recommends that you combine On-Demand Recording with the "One-Step Recording via Audix" Communication Manager feature. When using this feature, enter the hunt group with the On-Demand Recording lines as the parameter for the audix-rec feature button you want to assign to the user�s station.
For more information, consult "One-Step Recording via Audix" in Chapter 21, Features and technical reference in Volume 3 of the Administrator�s Guide for Avaya Communication Manager, 555-235-506-6 or the Witness ContactStore documentation.
For more information about hunt groups, consult �Managing Hunt Groups� in Chapter 7, �Handling incoming calls� in Volume 1 of the Administrator's Guide for Avaya Communication Manager, 555-233-506-6
Note:Note: Assigning ports to recording modes is done using Witness administration
procedures.
Configuring IP servicesUse the change ip-services command to enable the DAPI server.
On the IP Services form:
● For Service Type, enter DAPI● For Enabled, enter y● For Remote Node, enter the IP address of the Call Capture Engine.
● For Local Node:- For an S8700/S8500, enter the C-LAN name.
- For an S8300, enter procrSee the following example for how to fill out the form. For a screen reference, see �IP Services� in Chapter 18,�Screen Reference� in the Administrator�s Guide for Avaya Communication Manager, 555-233-506-6.
Administering Communication Manager for Call Capture Engine and Communication Manager API
40 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Example screen:configuring IP services
Note:Note: For an S8700/S8500, enter the C-LAN name as the Local Node.
Note:Note: For an S8300, enter procr as the Local Node.
Setting up a network region for Communication Manager API
! CAUTION:CAUTION: Communication Manager API and Call Capture Engine softphones must be
in an IP network region that supports G.711A and G.711MU and nothing else. This IP network region should have no media encryption. Additionally, there must be a media gateway or a media processor resource in the same network region or in an interconnected network region. Otherwise, there will be no media resources.
Creating the Communication Manager APICODEC set
Use the change ip-codec-set command to create a CODEC set that uses G.711A and G.711MU:
● Make sure that G.711MU and G.711A are the only CODECs administered.
● Silence Suppression must be n
change ip-services Page 1 of 2
IP SERVICES Service Enabled Local Local Remote Remote Type Node Port Node PortSAT y st1-clan 9000 any 0DAPI y st1-clan 0 192.11.12.1 0 0
Procedures specific to Communication Manager API and Call Capture Engine
Issue 1 October 2003 41
The following is a example of how to fill out the form.For more information, see these resources:
● For an explanation of administering IP CODEC sets, see �Administering IP CODEC sets� in Chapter 5, �Network Quality and Management� in the Administration for Network Connectivity for Avaya Communication Manager, 555-233-506-4.
● For a screen reference, see �IP Codec Set� in Chapter 18, �Screen Reference� in the Administrator�s Guide for Avaya Communication Manager, 555-233-506-6.
Example screen:setting up a CODEC set
Note:Note: Media Encryption may or may not show up on this form. If it does, enter
never.
Administering a network region with that CODEC set
To administer the network region with that CODEC set, do the following:
1. Use the change ip-network-region command to administer a network region with that CODEC set:
2. Specify the CODEC set and the UDP port range (minimum and maximum) for the network region you assigned to the Communication Manager API softphones and to the media processor.
The CODEC Set field reflects the CODEC set that must be used for connections between phones within this region or between phones and media processor boards within this region.
change ip-codec-set 3 Page 1 of 1
IP Codec Set
Codec Set: 3
Audio Silence Frames Packet Codec Suppression Per Pkt Size(ms) 1: G.711MU n 2 20 2: G.711A n 2 20 3: 4: 5: 6: 7:
Media Encryption: never
Administering Communication Manager for Call Capture Engine and Communication Manager API
42 Avaya Communication Manager API and Call Capture Engine Installation and Administration
The following is an example of how to fill out the form. For more information, see these resources:
● �Administering IP network regions� in Chapter 5, �Network Quality and Management� in the Administration for Network Connectivity for Avaya Communication Manager, 555-233-506-4.
● For a screen reference, see �IP Network Region� in Chapter 18, �Screen Reference� in the Administrator�s Guide for Avaya Communication Manager, 555-233-506-6.
Example screen:administering a network region
For this example network, you will administer the following CODEC connectivity within each network region and between network regions:
Note:Note: This administration is specific to the example network provided. You will
need to make the necessary modifications to match your configuration.
● network region 1 <-> network region 1: CODEC 1
● network region 2 <-> network region 2: CODEC 2
● network region 3 <-> network region 3: CODEC 3
● network region 1 <-> network region 2: CODEC 2
● network region 1 <-> network region 3: CODEC 3
● network region 2 <-> network region 3: CODEC 3
Procedures specific to Communication Manager API and Call Capture Engine
Issue 1 October 2003 43
change ip-network-region 3 Page 1 of 3 IP NETWORK REGION
Region: 3 Name: Location: Intra-region IP-IP Direct Audio: noAUDIO PARAMETERS Inter-region IP-IP Direct Audio: no Codec Set: 3 IP Audio Hairpinning? n UDP Port Range Min: 2048 RTCP Reporting Enabled? y Max: 65535 RTCP MONITOR SERVER PARAMETERS Use Default Server Parameters? y
DIFFSERV/TOS PARAMETERS Call Control PHB Value: 34 Audio PHB Value: 46 AUDIO RESOURCE RESERVATION PARAMETERS RSVP Enabled? n 802.1P/Q PARAMETERS Call Control 802.1p Priority: 7 Audio 802.1p Priority: 6
change ip-network-region 3 Page 2 of 3
Inter Network Region Connection Management
Region (Group Of 32) 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2001-032 3 3 3033-064065-096097-128129-160161-192193-224225-250
Administering Communication Manager for Call Capture Engine and Communication Manager API
44 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Adding the Communication Manager APIsoftphones to the network region
Use the change ip-network-map command to add the API softphones to the network region you administered for Communication Manager API.
See the following example for how to fill out the form. For a screen reference, see �IP Address Mapping� in Chapter 18, �Screen Reference� in the Administrator�s Guide for Avaya Communication Manager, 555-233-506-6.
Example screen:mapping IP addresses (for API softphones)
change ip-network-map Page 1 of 32
IP ADDRESS MAPPING
Subnet From IP Address (To IP Address or Mask) Region VLAN 192.11 .12 .4 192.11 .12 .5 1 n 192.11 .12 .6 192.11 .12 .7 2 n 192.11 .12 .10 192.11 .12 .10 3 n . . . . . . n . . . . . . n . . . . . . n . . . . . . n . . . . . . n . . . . . . n . . . . . . n . . . . . . n . . . . . . n . . . . . . n . . . . . . n . . . . . . n . . . . . . n
Other Communication Manager Procedures
Issue 1 October 2003 45
Other Communication Manager ProceduresDepending on what you have already administered for Communication Manager, you may have to perform other Communication Manager administration procedures. Following is a list of these procedures along with references to Communication Manager documentation sources for understanding and performing these procedures.
Adding a media gateway to the networkIf you are using a media server (S8300/S8500/S8700) with a G700 media gateway, you must add the media gateway to the Communication Manager network:
Use the add media-gateway command to add the media gateway to the Communication Manager network
If you are adding this media gateway to the network region you created for Communication Manager API, make sure to enter that network region number for Network Region.
For an example of how you fill out the form, see Example screen: adding a media gateway on page 46.
For more information about adding a media gateway, see:
● �S8300 server adding a G700 gateway,� in Chapter 2, �Administering Converged Networks,� in the Administration for Network Connectivity for Avaya Communication Manager, 555-233-506-4.
This section also explains how to add a media gateway with an S8700 media server.
● �Administer Communication Manager: The Primary Controller is an S8700,� in Chapter 4, �Installing a New G700 without an S8300,� in Installation and Upgrades for the AvayaTM G700 Media Gateway controlled by an AvayaTM S8300 Media Server or an AvayaTM S8700 Media Server.
For a screen reference, see:
● �Media-Gateway� in Chapter 18, �Screen Reference� in the Administrator�s Guide for Avaya Communication Manager, 555-233-506-6.
Administering Communication Manager for Call Capture Engine and Communication Manager API
46 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Example screen:adding a media gateway
Adding a C-LAN to the networkIf you are using an S8700 media server, you must add the C-LAN to the Communication Manager network.
Use these commands in this order to add the C-LAN to the network:
1. add data-module
For an example of how you fill out the form, see Example screen: Adding a data module (C-LAN) on page 47.
For a screen reference, see �Data modules� in Chapter 18, �Screen Reference� in the Administrator�s Guide for Avaya Communication Manager, 555-233-506-6.
2. change node-name ip
For an example of how you fill out the form, see Example screen: changing an IP node name (C-LAN and media processor) on page 48.
For a screen reference, see �IP Node Name� in Chapter 18, �Screen Reference� in the Administrator�s Guide for Avaya Communication Manager, 555-233-506-6.
add media-gateway 1 Page 1 of 1 MEDIA GATEWAY Number: 1 Name: ST1 MG1 30N73 Identifier: 01DR10238742 IP Address: 192.11.12 .3 MAC Address: 00:04:0d:02:05:04Network Region: 2 Location: 1 Site Data: 30N73 TBL G Registered? y
Slot Module Type V1: V2: ds1 V3: V4: dcp
V8: V9:
Other Communication Manager Procedures
Issue 1 October 2003 47
3. change ip-interfaces
If you are adding this C-LAN to the network region you created for Communication Manager API, make sure to enter that network region number for Net Reg.
For an example of how you fill out the form, see Example screen: changing an IP interface (C-LAN and media processor) on page 48.
For more information, see these resources:
● For a screen reference, see �IP interfaces� in Chapter 18, �Screen Reference� in the Administrator�s Guide for Avaya Communication Manager, 555-233-506-6.
● For information about adding a C-LAN to a network region, see �Administering C-LAN and IP Media Processor circuit packs,� in Chapter 2, �Administering Converged Networks,� in the Administration for Network Connectivity for Avaya Communication Manager, 555-233-506-4.
Example screen:Adding a data module (C-LAN)
add data-module 44444 Page 1 of 1 DATA MODULE
Data Extension: 44444 Name: BCC: 2 Type: pdm COS: 1 Remote Loop-Around Test? n Port: COR: 1 Secondary data module? n ITC: restricted TN: 1 Connected To: dte
ABBREVIATED DIALING List1:
SPECIAL DIALING OPTION:
ASSIGNED MEMBER ( Station with a data extension button for this data module )
Ext Name (first 26 characters) 1:
Administering Communication Manager for Call Capture Engine and Communication Manager API
48 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Example screen:changing an IP node name (C-LAN and media processor)
Example screen:changing an IP interface (C-LAN and media processor)
change node-names ip Page 1 of 1 IP NODE NAMES Name IP Address Name IP Addressdefault 0 .0 .0 .0 . . .st1-clan 192.11 .12 .1 . . .st1-prwlr1 192.11 .12 .2 . . .
change ip-interfaces Page 1 of 19
IP INTERFACES
NetON Type Slot Code Sfx Node Name Subnet Mask Gateway Address Rgn VLAy MEDPRO 17E11 TN2302 st1-prwlr1 255.255.0 .0 192.11 .12 .254 1 ny C-LAN 17D07 TN799DP C st1-clan 255.255.0 .0 192.11 .12 .254 1 nn 255.255.255.0 . . . nn 255.255.255.0 . . . nn 255.255.255.0 . . . nn 255.255.255.0 . . . nn 255.255.255.0 . . . nn 255.255.255.0 . . . nn 255.255.255.0 . . . nn 255.255.255.0 . . . n
Other Communication Manager Procedures
Issue 1 October 2003 49
Adding a media processor circuit pack to the network
If you are using an S8700 media server, you must add the media processor circuit pack to the Communication Manager network.
Use these commands in this order to add a media processor to the network:
1. change node-name ip
● For an example of how you fill out the form, see Example screen: changing an IP node name (C-LAN and media processor) on page 48.
● For a screen reference, see �IP Node Name� in Chapter 18, �Screen Reference� in the Administrator�s Guide for Avaya Communication Manager, 555-233-506-6.
2. change ip-interfaces
If you are adding this media processor to the network region you created for Communication Manager API, make sure to enter that network region number for Net Reg.
For an example of how you fill out the form, see Example screen: changing an IP interface (C-LAN and media processor) on page 48.
For more information, see these resources:
● For a screen reference, see �IP interfaces� in Chapter 18, �Screen Reference� in the Administrator�s Guide for Avaya Communication Manager, 555-233-506-6.
● For information about adding a media processor to a network region, see �Administering C-LAN and IP Media Processor circuit packs,� in Chapter 2, �Administering Converged Networks,� in the Administration for Network Connectivity for Avaya Communication Manager, 555-233-506-4.
Setting up tone detectionWe recommend that you use out-of-band tone detection as the default tone detection mode for Communication Manager API unless your system requires in-band. The following sections explain how to set up both of these tone detection modes.
Administering Communication Manager for Call Capture Engine and Communication Manager API
50 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Setting up out-of-band tone detection(recommended)
● Use these commands:
- change system-parameters ip-options For Intra-System IP DTMF Transmission Mode, enter out-of-band.
For an example of how you fill out the form, see Example screens: setting up out-of-band tone detection on page 51.
For a screen reference, see �IP-Options System Parameters� in Chapter 18, �Screen Reference� in the Administrator�s Guide for Avaya Communication Manager, 555-233-506-6.
- For each of the IP signaling groups, use change signaling-group x For DTMF Over IP, enter out-of-band. For an example of how you fill out the form, see Example screens: setting up out-of-band tone detection on page 51.
For a screen reference, see �Signaling Group� in Chapter 18, �Screen Reference� in the Administrator�s Guide for Avaya Communication Manager, 555-233-506-6.
Note:Note: The Communication Manager API server must also be configured for
out-of-band. Make sure that the following line in the Media section of the configuration properties file contains this value:
com.avaya.mvcs.media.DataCollectionServices.ttd_mode=OUT_BAND
Other Communication Manager Procedures
Issue 1 October 2003 51
Example screens: setting up out-of-band tone detection
change system-parameters ip-options Page 1 of 1 IP-OPTIONS SYSTEM PARAMETERS
IP MEDIA PACKET PERFORMANCE THRESHOLDS Roundtrip Propagation Delay (ms) High: 800 Low: 400 Packet Loss (%) High: 40 Low: 15 Ping Test Interval (sec): 20 Number of Pings Per Measurement Interval: 10
RTCP MONITOR SERVER Default Server IP Address: . . . Default Server Port: 5005 Default RTCP Report Period(secs): 5
IP DTMF TRANSMISSION MODE Intra-System IP DTMF Transmission Mode: out-of-band Inter-System IP DTMF: See Signaling Group Forms
H.248 MEDIA GATEWAY Link Loss Delay Timer (Minutes): 5
change signaling-group 18 Page 1 of 5 SIGNALING GROUP
Group Number: 18 Group Type: h.323 Remote Office? y Max number of NCA TSC: 0 SBS? n Max number of CA TSC: 0 Trunk Group for NCA TSC: Trunk Group for Channel Selection: 18 Supplementary Service Protocol: a
Near-end Node Name: st1-clan1 Far-end Node Name: E1_systest1 Near-end Listen Port: 6001 Far-end Listen Port: 1720
LRQ Required? n Calls Share IP Signaling Connection? y RRQ Required? y Bypass If IP Threshold Exceeded? n
DTMF over IP: out-of-band Direct IP-IP Audio Connections? y IP Audio Hairpinning? y Interworking Message: PROGress
Administering Communication Manager for Call Capture Engine and Communication Manager API
52 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Setting up inband tone detection
Follow these directions if your system requires inband tone detection
● Use these commands:
- change system-parameters ip-options
For Intra-System IP DTMF Transmission Mode, enter in-band-g711For a screen reference, see �IP-Options System Parameters� in Chapter 18, �Screen Reference� in the Administrator�s Guide for Avaya Communication Manager, 555-233-506-6.
- For each of the IP signaling groups, use change signaling-group x
For DTMF Over IP, enter in-band-g711For a screen reference, see �Signaling Group� in Chapter 18, �Screen Reference� in the Administrator�s Guide for Avaya Communication Manager, 555-233-506-6.
Note:Note: The Communication Manager API must also be configured for in-band.
Make sure that the following line in the Media section of the configuration properties file contains this value:
com.avaya.mvcs.media.DataCollectionServices.ttd_mode=IN_BAND
Example configuration
Issue 1 October 2003 53
Example configurationThe following figure shows a graphical view of the example Communication Manager/Communication Manager API/Call Capture Engine configuration. This example configuration includes:
● An S8700 media server with a C-LAN circuit card and a media processor circuit card
● A G700 media gateway
● Communication Manager API/Call Capture Engine server and one or more Communication Manager API softphones
● The ContactStore
.
central office
S8700(st1)
C-L
AN19
2.11
.12.
1
med
iapr
oces
sor.
192.
11.1
2.2
port network(st1)
NR 1 G729, G711A
G700 media gateway
(st1)192.11.12.3
NR 2G711AG729
DCP D4
DCP D3
D6 DCP
D5 DCPan
alog
isdn
(25532)
(25531)
(25534)
(25533)
ContactStore CMAPI/CCE server
NR 3 G711A/MU
CMAPI IP softphonesS1 .............................. S60
(23200) ........................(23259)192.11.12.10
NR 2G.711AG.729
NR 1G.729, G711A
IP3 IP4 IP5 IP6 ---------->IP30(25511) (25512) (25513) (25514) -> (xxxxx)192.11.12.4 192.11.12.5 192.11.12.6 192.11.12.7 -> xxx.xx.xx.x
Administering Communication Manager for Call Capture Engine and Communication Manager API
54 Avaya Communication Manager API and Call Capture Engine Installation and Administration
What�s next? Continue with Administering the Communication Manager API and Call Capture Engine on page 55.
Issue 1 October 2003 55
Administering the Communication Manager API and Call Capture Engine
This chapter provides information on configuring and customizing the Communication Manager API and the Call Capture Engine. This chapter includes the following topics:
● Configuring the Communication Manager API and Call Capture Engine on page 56
● Customizing OpenLDAP on page 61
● Customizing the Samba server on page 63
● Starting the Call Capture Engine on page 64
Administering the Communication Manager API and Call Capture Engine
56 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Configuring the Communication Manager API and Call Capture Engine
You configure the Communication Manager API and Call Capture Engine by editing three configuration files:
● The startup configuration file
/etc/sysconfig/cceSee Starting the Call Capture Engine on page 64
● The configuration properties file:
/opt/mvcscce/jboss-3.0.7/server/default/conf/cmapi-user-configuration.properties See Editing the Communication Manager API configuration properties file on page 57
● The OpenLDAP file
Editing the startup configuration fileThe startup configuration file (/etc/sysconfig/cce) contains variables used by the boot initialization script.
Edit the JAVA_HOME variable (bolded in the example), assigning it a value matching the installation directory of the Java 2 SDK.
Note:Note: Do not modify anything else in this file.
Following is an example startup configuration file:
# Avaya Communication Manager Connector Server
# Java SDK Home Directory.# Ensure this variable is set to directory where# the Java SDK is installed.JAVA_HOME=/usr/java/j2sdk1.4.1_03
# Connector Server Home Directory# (Do not change these variables.)CMAPI_HOME=/opt/mvcscce/jboss-3.0.7SERVER=${CMAPI_HOME}/bin/cmserverSERVER_USER=avaya
Configuring the Communication Manager API and Call Capture Engine
Issue 1 October 2003 57
Editing the Communication Manager API configuration properties file
The configuration properties file contains properties for specifying the networking addresses and ports as well as other configurable information the connector server requires to run in your environment. The file is located at:
/opt/mvcscce/jboss-3.0.7/server/default/conf/cmapi-user-configuration.properties Review the value assigned to each property and change the value where necessary, using the comments as a guideline.
The lines that you can edit with configuration information are shown in bold. These editable lines include:
● The lines that you are required to edit, which are uncommented and in bold. When values are provided in these lines, they are example values.
● The lines that are optional. These lines are commented out and bolded. The values provided in these lines are the default values.
If you leave these optional lines commented out, the system uses the default values that are represented in the lines. If you want to change any of these values, uncomment the line and edit it to add that value to your configuration.
Other commented lines explain the following:
● The configuration properties that are defined by the following editable line.
● Whether editing is required or optional for the property defined by the following editable line.
Administering the Communication Manager API and Call Capture Engine
58 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Example Communication Manager API configuration properties file
The IP addresses in the example below need to be specific to your configuration. They are provided here, referencing the Example configuration on page 53.# Properties File for The Avaya Communication Manager Connector Server
[SYSTEM]############################################################################# General properties for the Connector Server.############################################################################
# REQUIRED:# com.avaya.util.BindAddressUtil.local_ip: Local IP Address of Avaya# Communication Manager Connector Server for the RAS link.## Some systems may return the loopback IP address (127.0.0.1) rather than# the IP address of the NIC on a call to getLocalHost(). This parameter# must be used to specify the local IP address of the desired NIC.
com.avaya.util.BindAddressUtil.local_ip=192.11.12.10
[CALL MANAGER]############################################################################# Properties used for communication between the Connector Server and# Avaya Communication Manager.############################################################################
# REQUIRED:# com.avaya.mvcs.call_mgr.DefinityCallManager.callmgr: IP Address of Avaya# Communication Manager (C-LAN for S8700, or the S8300 itself) for the Call# Manager Link. Use IP addresses (135.9.71.153), not DNS names.
com.avaya.mvcs.call_mgr.DefinityCallManager.callmgr=192.11.12.1
[MEDIA]############################################################################# Properties used for the Media Services of the Connector Server.############################################################################
# REQUIRED:# com.avaya.mvcs.media.MediaManager.local_ipaddress_1: Local IP Address# of Avaya Communication Manager Connector Server for Media RTP Sessions.
Configuring the Communication Manager API and Call Capture Engine
Issue 1 October 2003 59
com.avaya.mvcs.media.MediaManager.local_ipaddress_1=192.11.12.10
# REQUIRED:# com.avaya.mvcs.media.MediaManager.local_udpport_min: Local UDP Port# (minimum) of Avaya Communication Manager Connector Server for Media# RTP Sessions.
com.avaya.mvcs.media.MediaManager.local_udpport_min=9000
# REQUIRED:# com.avaya.mvcs.media.MediaManager.local_udpport_max: Local UDP Port# (maximum) of Avaya Communication Manager Connector Server for Media# RTP Sessions.
com.avaya.mvcs.media.MediaManager.local_udpport_max=9500
# REQUIRED:# com.avaya.mvcs.media.VoiceUnitServices.dir.recorder: Directory of# recorded files for VoiceUnit Services.
com.avaya.mvcs.media.VoiceUnitServices.dir.recorder=/cce/recorder
# REQUIRED:# com.avaya.mvcs.media.VoiceUnitServices.dir.player: Directory of# PlayFiles for Player and InsertFiles for Recorder for VoiceUnit Services.
com.avaya.mvcs.media.VoiceUnitServices.dir.player=/cce/player
# REQUIRED:# com.avaya.mvcs.media.DataCollectionServices.ttd_mode: Tone Detection# Mode. Valid values are "IN_BAND" and "OUT_BAND". OUT_BAND disables# the detection of tones sent across the RTP stream as they are handled# through ESIG. IN_BAND enables detection of tones sent across the# RTP stream.
com.avaya.mvcs.media.DataCollectionServices.ttd_mode=OUT_BAND
[STATION]############################################################################# Properties used for the Station Manager Services of the Connector Server.############################################################################
# OPTIONAL:# com.avaya.mvcs.station.StationManager.tcpport_min:# com.avaya.mvcs.station.StationManager.tcpport_max:# TCP Port Range for Call Control Link on the Avaya Communication Manager# Connector Server. If min or max is not set, both default values are used.## Default min is 3000.# Default max is 4999.
Administering the Communication Manager API and Call Capture Engine
60 Avaya Communication Manager API and Call Capture Engine Installation and Administration
# com.avaya.mvcs.station.StationManager.tcpport_min=3000# com.avaya.mvcs.station.StationManager.tcpport_max=4999
# OPTIONAL:# com.avaya.mvcs.station.StationManager.udpport_min:# com.avaya.mvcs.station.StationManager.udpport_max:# If min or max is not set, the server binds to any available port# for Call Control Link (RAS) on the Avaya Communication Manager# Connector Server.## Default is no minimum or maximum.
# com.avaya.mvcs.station.StationManager.udpport_min=5000# com.avaya.mvcs.station.StationManager.udpport_max=6999
# OPTIONAL:# com.avaya.mvcs.station.StationManager.grq_number_retries: Gatekeeper# Registration Request (GRQ) retries for the RAS link to the Avaya# Communication Manager from the Avaya Communication Manager Connector Server.## Default is 2.
# com.avaya.mvcs.station.StationManager.grq_number_retries=2
# OPTIONAL:# com.avaya.mvcs.station.StationManager.rrq_number_retries: Gatekeeper# Registration Request (GRQ) retries for the RAS link to the Avaya# Communication Manager from the Avaya Communication Manager Connector Server.## Default is 2.
# com.avaya.mvcs.station.StationManager.rrq_number_retries=2
# OPTIONAL:# com.avaya.mvcs.station.StationManager.urq_number_retries: Unregistration# Request (URQ) retries for the RAS link to the Avaya Communication Manager# from the Avaya Communication Manager Connector Server.## Default is 1.
# com.avaya.mvcs.station.StationManager.urq_number_retries=1
# OPTIONAL:# com.avaya.mvcs.station.StationManager.misc_number_retries: Non-Standard# Message (NSD) retries for the RAS link to the Avaya Communication# Manager from the Avaya Communication Manager Connector Server.## Default is 2.
# com.avaya.mvcs.station.StationManager.misc_number_retries=2
# OPTIONAL:# com.avaya.mvcs.station.StationManager.grq_timeout: Gatekeeper# Registration Request (GRQ) timeout in milliseconds for the RAS link to# the Avaya Communication Manager from the Avaya Communication Manager
Configuring the Communication Manager API and Call Capture Engine
Issue 1 October 2003 61
# Connector Server.## Default is 5000 milliseconds.
# com.avaya.mvcs.station.StationManager.grq_timeout=5000
# OPTIONAL:# com.avaya.mvcs.station.StationManager.rrq_timeout: Registration Request# (RRQ) timeout in milliseconds for the RAS link to the Avaya Communication# Manager from the Avaya Communication Manager Connector Server.## Default is 3000 milliseconds.
# com.avaya.mvcs.station.StationManager.rrq_timeout=3000
# OPTIONAL:# com.avaya.mvcs.station.StationManager.urq_timeout: Unregistration# Request (URQ) timeout in milliseconds for the RAS link to the Avaya# Communication Manager from the Avaya Communication Manager Connector Server.## Default is 3000 milliseconds.
# com.avaya.mvcs.station.StationManager.urq_timeout=3000
# OPTIONAL:# com.avaya.mvcs.station.StationManager.misc_timeout: Non-Standard# Message (NSD) timeout in milliseconds for the RAS link to the Avaya# Communication Manager from the Avaya Communication Manager Connector Server.## Default is 3000 milliseconds.
# com.avaya.mvcs.station.StationManager.misc_timeout=3000
Customizing OpenLDAPOpenLDAP hosts configuration data for the Call Capture Engine. Initial data has been pre-loaded in the installation of the RPM. Additional information will be added later in the process by the ContactStore (for example, details about what recording mode is used for a specific line and which stations will be monitored).
To customize OpenLDAP, do the following:
1. Open the /opt/mvcscce/jboss-3.0.7/server/default/conf/ldapConfig.xml file.
Administering the Communication Manager API and Call Capture Engine
62 Avaya Communication Manager API and Call Capture Engine Installation and Administration
2. Change the hostname (shown in bold) to match the IP address of the Call Capture Engine server.
The IP address listed below is provided as an example only. Enter the IP address that is specific to your configuration.
<?xml version="1.0" encoding="UTF-8" ?> <!--==============================================================--> <!-- CCE LDAP CONFIGURATION --> <!-- --> <!-- hostname : IP Address of the Machine where slapd is running --> <!-- Use IP addresses, not DNS names or 'localhost' ! --> <!-- port : Port where slapd is listening on. --> <!-- Normally ldap as a well known service use 389. --> <!-- user : Distinguished Name of the Manager, which is the --> <!-- Administrator of the ldap store. --> <!-- password : The Administrators Password. --> <!-- The password is encrypted. --> <!-- --> <!--==============================================================--> <ldap> <hostname>192.11.12.10</hostname> <port>389</port> <user>cn=Manager,dc=MVCCE,dc=Avaya,dc=com</user> <password>3dvmfAkYZ8w=</password> </ldap>
Customizing the Samba server
Issue 1 October 2003 63
Customizing the Samba serverThe Call Capture Engine software installation provides a default configuration file for the Samba server on the Linux system. It has also configured the system for Samba to start automatically after reboot. The ContactStore accesses the system using the Samba server to copy captured voice files from the Call Capture Engine into the ContactStore for archiving.
You may need to change the default configuration of Samba server located at /etc/samba/smb.conf. Parameters to change include:
● workgroup - This parameter defines the Windows domain/workgroup of which the Call Capture Engine is part. The default value is 'CCE'.
● server string - This parameter provides the description of the Call Capture Engine. The default value is 'CCE Samba Server'�.
● hosts allow - This parameter specifies the remote IP addresses that can access the Call Capture Engine using Samba. The ContactStore requires that this access be open. Therefore, this line is commented out by default so every system can access the Call Capture Engine using Samba.
Other parameters might be needed to change depending on your specific system requirements. Please consult Samba documentation to perform this task.
Administering the Communication Manager API and Call Capture Engine
64 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Starting the Call Capture EngineThe Call Capture Engine is configured to start automatically after the reboot of the Linux server.
To start the Call Capture Engine, execute the cce boot initialization script as follows:
/etc/init.d/cce start
If exceptions appear, the server has not started successfully. Check the configuration properties file to make sure that you have entered values that are correct for your system. If you can�t find any problems with the configuration properties file, call Avaya support.
What�s next?
Issue 1 October 2003 65
What�s next?This document has provided information for:
● Installing a Red Hat 7.3 Linux server and the software necessary for running the Call Capture Engine, including:
- OpenLDAP and Samba as part of the Linux installation
- Java
- Communication Manager API
- Call Capture Engine software
● Administering the underlying Communication Manager API and Call Capture Engine software
● Administering the Communication Manager to support the Call Capture Engine
The Call Capture Engine is now operational for additional administration for recording modes and monitoring stations. Refer to your ContactStore documentation for additional administration procedures.
Administering the Communication Manager API and Call Capture Engine
66 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Issue 1 October 2003 67
Appendix A: Sample RPM execution
This following output is a sample of executing the RPM.Preparing packages for installation...mvcscce-r0097_0097-1Group ID avaya created.User ID avaya created.User ID avaya's Group ID is avaya.This is the correct Group ID.User ID cceaudio created.User ID cceaudio's Group ID is avaya.This is the correct Group ID.User ID cceadmin created.User ID cceadmin's Group ID is avaya.This is the correct Group ID.Changing owner and group of everything under /opt/mvcscce to:User ID: avayaGroup ID: avayaConfigured cce to start automatically.unable to open passdb database.Added user cceaudio.Assigned password to Samba user cceaudio.Configured Samba to start automatically.Starting SMB services: [ OK ]Starting NMB services: [ OK ]Configured NFS to start auotmatically.Starting NFS services: [ OK ]Starting NFS quotas: [ OK ]Starting NFS mountd: [ OK ]Starting NFS daemon: [ OK ]Configured LDAP to start automatically.Stopping slapd: [FAILED]Starting slapd: [ OK ]Waiting for LDAP to complete restart...Adding the initial LDIF configuration.adding new entry "dc=MVCCE,dc=Avaya,dc=com"adding new entry "cn=Manager, dc=MVCCE,dc=Avaya,dc=com"adding new entry "dc=SystemData, dc=MVCCE,dc=Avaya,dc=com"adding new entry "dc=RecModeParams, dc=MVCCE,dc=Avaya,dc=com"adding new entry "dc=Machine, dc=MVCCE,dc=Avaya,dc=com"adding new entry "dc=Line, dc=MVCCE,dc=Avaya,dc=com"adding new entry "MachineNumber=A01,dc=Machine, dc=MVCCE,dc=Avaya,dc=com"adding new entry "dc=Configuration, dc=MVCCE,dc=Avaya,dc=com"LDIF configuration added.
Sample RPM execution
68 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Issue 1 October 2003 69
Appendix B: Tuning
The following sections explain how to tune your system if the application is using too much of the system�s resources.
● If you are running applications that causes the system to run out of physical memory, see ��Utilizing more physical memory�� on page 70.
● If you are running an application that causes the CPU usage to go to 100%, see ��Setting up the hard disk drive to use DMA�� on page 72.
Tuning
70 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Utilizing more physical memorySome high-intensive memory applications may cause the server to run out of physical memory. You can make the Red Hat Linux kernel utilize more of the physical memory by editing the kernel version line in the grub.conf file.
For example, the following procedure shows how to make a system with 1GB of memory utilize the full 1 GB.
1. Log in as root with the root password.
2. Open the file /etc/grub.conf with a text editor such as vi or Emacs.
Following is an example grub.conf file:
default=0timeout=10splashimage=(hd0,0)/grub/splash.xpm.gztitle Red Hat Linux (2.4.20-13.7)root (hd0,0)
kernel /vmlinuz-2.4.20-13.7 ro root=/dev/hda2 initrd /initrd-2.4.20-13.7.img
Note:Note: The path for root (root=/dev/hda2) may be different for your configuration,
depending on the disk partitioning of your system. Please do not change this detail in your file.
3. Edit the line that describes the kernel version
● If you are using Linux kernel version 2.4.20-13.7 or higher, add mem=1000M to the line. For example:
kernel /vmlinuz-2.4.20-13.7 ro root=/dev/hda2 mem=1000M
● If you are using a Linux kernel version lower than 2.4.20-13.7, add mem=960M to the line. For example:
kernel /vmlinuz-2.4.18-3 ro root=/dev/hda2 mem=960M
4. Save the file grub.conf.
5. Reboot the computer by typing the command shutdown -r now
Utilizing more physical memory
Issue 1 October 2003 71
6. Verify that the actual 1 GB (or 960 MB if using an earlier version of the kernel) is being used:
a. Log back into Linux.
b. Use the top command to check how much memory is being used.
The following two lines are a sample output from the top command. Note that the Mem field equals the memory that is available.
Mem: 998888K av, 986416K used, 12472K free, 0K shrd, 116536K buffSwap: 2024180K av, 76K used, 2024104K free 800708K cached
Tuning
72 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Setting up the hard disk drive to use DMAIf the CPU usage goes to 100%, you should set up your hard disk drive to use DMA. To turn on DMA:
1. Log in as root with the root password.
2. To see if DMA is already turned on:
a. Enter the following command:
/sbin/hdparm /dev/hda
The system provides several lines of output about the hard drive parameters. For example:
3. Check to see if the using_dma flag is turned on or off.
● If it turned on (using_dma = 1), you do not need to take any action.
● If it is turned off (using_dma = 0), continue following these steps.
4. Find out if DMA can be turned on by typing the following command:
/sbin/hdparm -d 1 /dev/hda
● If DMA can not be turned on, the system returns an error or does not turn on DMA. Your disk drive probably does not support DMA.
● If DMA can be turned on, the system turns on DMA and displays output similar to the following:
/dev/hda:
setting using_dma to 1 (on)
using_dma = 1 (on)
DMA will stay on only until you turn your system off or reboot.
5. Permanently turn on DMA.
/dev/hda: multcount = 16 (on) I/O support = 0 (default 16-bit) unmaskirq = 0 (off) using_dma = 1 (on) keepsettings = 0 (off) nowerr = 0 (off) readonly = 0 (off) readahead = 8 (on) geometry = 7476/255/63, sectors = 120103200, start = 0 busstate = 1 (on)
Setting up the hard disk drive to use DMA
Issue 1 October 2003 73
a. Open the file /etc/rc.d/rc.local for editing, using an editor like vi or emacs.
b. Add the following line to the file:
/sbin/hdparm -d 1 /dev/hda
6. Save the file.
7. Reboot your server by using the command shutdown -r.
8. To verify that DMA is set, log into Linux and execute this command:
/sbin/hdparm /dev/hda
If DMA is set, the output from the command includes this line:
using_dma = 1 (on)
Tuning
74 Avaya Communication Manager API and Call Capture Engine Installation and Administration
Issue 1 October 2003 75
IndexAadd data-module command . . . . . . . . . . . . 46add station command . . . . . . . . . . . . . . . 35
Bboot initialization script . . . . . . . . . . . . . . . 64
Cchange ip-codec-set command . . . . . . . . . . . 40change ip-interfaces command . . . . . . . . . 47, 49change ip-network-region command . . . . . . . . 41change ip-services command. . . . . . . . . . . . 39change node-name ip command . . . . . . . . 46, 49change signaling-group command . . . . . . . 50, 52change system-parameters ip-options command 50, 52C-LAN, adding . . . . . . . . . . . . . . . . . . 46configuration properties file. . . . . . . . . . . . . 57
example . . . . . . . . . . . . . . . . . . . . 58configuring IP services . . . . . . . . . . . . . . . 39connector server
configuring. . . . . . . . . . . . . . . . . . . 56connector server machine
minimum hardware specifications . . . . . . . . 16
DDMA . . . . . . . . . . . . . . . . . . . . . . . 72
Eexample configuration . . . . . . . . . . . . . . . 53
Hhardware requirements . . . . . . . . . . . . . . 16
Iinstalling
Linux . . . . . . . . . . . . . . . . . . . . . 22server software. . . . . . . . . . . . . . . . . 26
IP services . . . . . . . . . . . . . . . . . . . . 39
JJava 2 Platform SDK
installing . . . . . . . . . . . . . . . . . . . . 25Java 2 platform SDK . . . . . . . . . . . . . . . . 17
LLinux
installing . . . . . . . . . . . . . . . . . . . . 22Linux operating system . . . . . . . . . . . . . . . 17
Mmedia gateway, adding . . . . . . . . . . . . . . . 45media processor, adding . . . . . . . . . . . . . . 49media servers
hardware requirements . . . . . . . . . . . . . 18memory, utilizing more . . . . . . . . . . . . . . . 70
Nnetwork characteristics, required . . . . . . . . . . 19network region
adding softphones . . . . . . . . . . . . . . . 44setting up. . . . . . . . . . . . . . . . . . . . 40
Ooperating system requirements . . . . . . . . . . . 17
Pprerequisites . . . . . . . . . . . . . . . . . . . . 15
RRed Hat Linux . . . . . . . . . . . . . . . . . . . 17requirements
connector server machine . . . . . . . . . . . . 16hardware . . . . . . . . . . . . . . . . . . . . 16media server hardware . . . . . . . . . . . . . 18network characterisitics . . . . . . . . . . . . . 19network characteristics . . . . . . . . . . . . . 19operating system . . . . . . . . . . . . . . . . 17
76 Avaya Communication Manager API and Call Capture Engine Installation and Administration
software . . . . . . . . . . . . . . . . . . . . 17
Sserver software
configuring . . . . . . . . . . . . . . . . . . . 26installing . . . . . . . . . . . . . . . . . . . . 26
setting hard drive to use DMA. . . . . . . . . . . . 72softphones
adding to network region . . . . . . . . . . . . 44software requirements . . . . . . . . . . . . . . . 17startup configuration file . . . . . . . . . . . . . . 56stations
adding . . . . . . . . . . . . . . . . . . . . . 35stations, adding
example screens . . . . . . . . . . . . . . . . 37
Ttone detection
setting up inband . . . . . . . . . . . . . . . . 52setting up out-of-band . . . . . . . . . . . . . . 50