Professional Documents
Culture Documents
Communication Manager
Release 7.8
Planning, Installation and Administration
Guide
Issue 5
May, 2008
© 2003-2008 Verint Systems, Inc. availability of the linked pages.
All Rights Reserved.
Trademarks
Notice
Avaya and Communication Manager are trademarks of Avaya Inc.
While reasonable efforts were made to ensure that the information in this
eQuality® is a registered trademark, and Quality is a trademark of
document was complete and accurate at the time of printing, Verint
Systems, Inc. and Avaya Inc. can assume no liability for any errors. Verint Systems, Inc.
Changes and corrections to the information in this document may be
All other trademarks identified by the ® or ™ are registered trademarks
incorporated in future releases.
or trademarks of their respective owners.
Preventing toll fraud
Third-party software license agreements
"Toll fraud" is the unauthorized use of your telecommunications system
by an unauthorized party (for example, anyone who is not a corporate This computer program is protected by U.S. and international copyright
employee, agent, subcontractor, or person working on your company's laws, patent laws, and other intellectual property laws and treaties.
behalf). Be aware that there may be a risk of toll fraud associated with Unauthorized use, duplication, publication and distribution of all or any
your system and that, if toll fraud occurs, it can result in substantial portion of this computer program are expressly prohibited and will be
additional charges for your telecommunications services. prosecuted to the maximum extent provided by law. Your rights in this
computer program are limited to the license rights granted under the
Avaya fraud intervention license agreement executed by you in hardcopy form (or if none, by
If you suspect that you are being victimized by toll fraud and you need acceptance of the clickwrap terms included with this computer program).
technical assistance or support, call Technical Service Center Toll Fraud If needed, please contact your vendor for an additional copy of those
Intervention Hotline at +1-800-643-2353 for the United States and terms. All other rights, title and interest are expressly restricted and
Canada. retained by Verint Systems, Inc. and its licensors.
Providing telecommunications security The following open source applications are included with this computer
Telecommunications security (of voice, data, and video communications) program ("Open Source"), with ownership in those applications as
is the prevention of any type of intrusion to (that is, either unauthorized or indicated below.
malicious access to or use of) your company's telecommunications
Ant, Axis, log4j and Tomcat are each copyright © 2000 - 2003 The
equipment by some party. Your company's "telecommunications
Apache Software Foundation. All rights reserved. Licensed under the
equipment" includes both this Avaya product and any other voice/data/
Apache License, Version 2.0, which can be obtained at http://
video equipment that could be accessed via this Avaya product (that is,
www.apache.org/licenses/LICENSE-2.0.
"networked equipment"). An "outside party" is anyone who is not a
corporate employee, agent, subcontractor, or person working on your PostgreSQL is portions copyright © 1996 - 2005, The PostgreSQL Global
company's behalf. Whereas, a "malicious party" is anyone (including Development Group, and portions copyright © 1994, The Regents of the
someone who may be otherwise authorized) who accesses your University of California. All rights reserved. A copy of the PostgreSQL
telecommunications equipment with either malicious or mischievous license can be obtained at http://www.postgresql.org/about/licence.
intent. Such intrusions may be either to/through synchronous
(time-multiplexed and/or circuit-based) or asynchronous (character-, jcifs is copyright © 2004 The JCIFS Project. All rights reserved. Licensed
message-, or packet-based) equipment or interfaces for reasons of: under the terms of the GNU Lesser General Public License as published
• Use (of capabilities special to the accessed equipment) by the Free Software Foundation, which can be obtained at http://
• Theft (such as, of intellectual property, financial assets, or www.gnu.org/licenses/licenses.html.
toll-facility access)
JoeSNMP is copyright © 2002 - 2003 Blast Internet Services, Inc, and
• Eavesdropping (privacy invasions to humans)
copyright © 1999 - 2001 Oculan Corp. Copyrights for modified and
• Mischief (troubling, but apparently innocuous, tampering)
included code are included in the individual source files. All rights
• Harm (such as harmful tampering, data loss or alteration,
reserved. Licensed under the terms of the GNU Lesser General Public
regardless of motive or intent)
License as published by the Free Software Foundation, which can be
Be aware that there may be a risk of unauthorized intrusions associated obtained at http://www.gnu.org/licenses/licenses.html.
with your system and/or its networked equipment. Also realize that, if
A license in each Open Source software application is provided to you in
such an intrusion should occur, it could result in a variety of losses to your
accordance with the specific license terms specified above. EXCEPT
company (including, but not limited to, human and data privacy,
WITH REGARD TO ANY WARRANTIES OR OTHER RIGHTS AND
intellectual property, material assets, financial resources, labor costs, and
OBLIGATIONS EXPRESSLY PROVIDED DIRECTLY TO YOU FROM
legal costs).
VERINT, ALL OPEN SOURCE SOFTWARE IS PROVIDED "AS IS'' AND
Responsibility for your company's telecommunications security ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
The final responsibility for securing both this system and its networked
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
equipment rests with you, an Avaya customer's system administrator,
NO EVENT SHALL THE OWNERS OF THE OPEN SOURCE
your telecommunications peers, and your managers. Base the fulfillment
SOFTWARE OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
of your responsibility on acquired knowledge and resources from a
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
variety of sources, including, but not limited to:
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
• Installation documents
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
• System administration documents
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
• Security documents
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
• Hardware-/software-based security tools
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
• Shared information between you and your peers
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
• Telecommunications security experts
USE OF THE OPEN SOURCE SOFTWARE, EVEN IF ADVISED OF
To prevent intrusions to your telecommunications equipment, you and THE POSSIBILITY OF SUCH DAMAGE.
your peers should carefully program and configure your Avaya-provided
telecommunications systems and their interfaces. Your Avaya-provided Avaya support
software applications, as well as their underlying hardware/software Avaya provides a telephone number for you to use to report problems or
platforms and interfaces. Any other equipment networked to your Avaya to ask questions about your contact center. The support telephone
products. number is 1-800-242-2121 in the United States. For additional support
telephone numbers, see the Avaya Web site:
Warranty
http://www.avaya.com
Avaya Inc. provides a limited warranty on this product. Refer to your
sales agreement to establish the terms of the limited warranty. In Select Support, and then select Escalation Lists. This Web site includes
addition, Avaya's standard warranty language, as well as information telephone numbers for escalation within the United States. For escalation
regarding support for this product, while under warranty, is available telephone numbers outside the United States, select Global Escalation
through the following Web site: List.
http://www.avaya.com/support
Link disclaimer
Avaya 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
Verint ContactStore for Communication Manager
Release 7.8
G.729A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Storage Requirements . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 43
Storage at Each Recorder . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 43
Quality Monitoring. . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 44
Central Database Storage . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 45
Archive Call Storage . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 45
Backup Storage . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 45
Server Platform . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 46
Sizing . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 46
DVD+RW Drive . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 49
Network Issues. . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 51
Load . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 51
Ports Used . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 51
Network Address Translation Routing . . . . . . . . . . . . . . . . . . . . . . . . . 51
Recorder Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Server Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Port Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Other Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Timed Trials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Avaya system prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Communication Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Gateway Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
AE Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Expansion Interface Boards (TN570) . . . . . . . . . . . . . . . . . . . . . . . . . . 56
C-LAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
VoIP Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Multi-Connect Capacity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
DMCC (IP_API_A) Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
TSAPI Simultaneous User Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . 60
VoIP Network Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Topologies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Bulk Recording System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Sampled Quality Monitoring (only) System . . . . . . . . . . . . . . . . . . . . . . . 62
Bulk Recording + Quality Monitoring System . . . . . . . . . . . . . . . . . . . . . . 63
Large Bulk Recording Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Integrating with other systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Supplementary Tagging of Bulk Recordings . . . . . . . . . . . . . . . . . . . . . . 67
Explicit External Control of Bulk Recording . . . . . . . . . . . . . . . . . . . . . . . 67
Enhanced Quality Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Avaya System Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Communication Manager Configuration . . . . . . . . . . . . . . . . . . . . . . . . 71
AE Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
TSAPI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Test Phonesets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Order in which to Install Applications . . . . . . . . . . . . . . . . . . . . . . . . . . 80
4 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Contents
Platform Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Operating System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
DVD Drive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Network Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Installing Verint ContactStore for Communication Manager . . . . . . . . . . . . . . . . 86
Installing Verint eQuality Balance (V5) . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Installing Verint eQuality Balance (V7) . . . . . . . . . . . . . . . . . . . . . . . . . . 89
If using selective quality recording . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
If using "ContactStore Plus" style quality recording . . . . . . . . . . . . . . . . . . . 89
Installing Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Installing Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Create an MMC Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Configuring Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Configuring Verint ContactStore for Communication Manager . . . . . . . . . . . . . . 93
Installing Archive . . .
. . .. .. . . .. . . . . . . . . . . . . . . . . . . . . . . . 94
Overview . . . . . . . . .. .. . . .. . . . . . . . . . . . . . . . . . . . . . . . 96
Accessing the System . . .. .. . . .. . . . . . . . . . . . . . . . . . . . . . . . 97
URL . . . . . . . . . . .. .. . . .. . . . . . . . . . . . . . . . . . . . . . . . 97
Initial User Account .
. . .. .. . . .. . . . . . . . . . . . . . . . . . . . . . . . 97
Key Points . . . . .. . .. .. . . .. . . . . . . . . . . . . . . . . . . . . . . . 98
Licensing . . . . . . . . .. .. . . .. . . . . . . . . . . . . . . . . . . . . . . . 99
Terminology. . . . . . . .. .. . . .. . . . . . . . . . . . . . . . . . . . . . . . 99
Obtaining a License Activation Key . . .. . . . . . . . . . . . . . . . . . . . . . . . 100
Adding additional licenses . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 101
Reinstalling on the same PC . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 101
Reinstalling the Recorder on a new PC . . . . . . . . . . . . . . . . . . . . . . . . . 101
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Securing the System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Windows Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
System Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Communication Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
System Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Port Allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Common Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Assigning Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
On Demand Recording . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Meeting Recording . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Station Bulk Recording . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Station Executive Recording . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Conferenced Recording . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Quality Server Ports (for Selective Quality Recording) . . . . . . . . . . . . . . . . . . 130
Unify or Externally Controlled Ports . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Phone Replay Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Live Monitor Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
6 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Contents
8 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Contents
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Programmer’s Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Enable(in string station, in SeqCouple tags) . . . . . . . . . . . . . . . . . . . . . . 290
Disable(in string station) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Start(in string station) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Stop(in string station) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Tag(in string station, in string inum, SeqCouple tags) . . . . . . . . . . . . . . . . . . 291
Assign() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Principles of Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Choosing the dialler version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Changing the log level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Controlling the service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Automatic restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
Disks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
NICS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
DVD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
Soundcard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Kickstart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Installing Unlimited Strength Encryption . . . . . . . . . . . . . . . . . . . . . . . . . 302
Installing a Signed SSL Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Selecting a Certificate Authority (CA) . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Backing up the Keystore file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Creating the new Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Generating a Certificate Signing Request . . . . . . . . . . . . . . . . . . . . . . . . 305
Importing the CA's certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Backing up the keystore file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Changing Tomcat Port Numbers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Encrypting Properties File entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Configuring Viewer and Archive to use HTTPS . . . . . . . . . . . . . . . . . . . . . . 309
Importing the public certificates into Viewer and Archive . . . . . . . . . . . . . . . . . 309
Configure Viewer to use https and a secure port . . . . . . . . . . . . . . . . . . . . 310
Configure Archive to use https . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
Configuring Archive for a Key Management Server . . . . . . . . . . . . . . . . . . . . 313
Configuring Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
Signing and Delivering the certificate . . . . . . . . . . . . . . . . . . . . . . . . . . 313
Installing the Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
10 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
About This Guide
Intended audience
This guide is designed for use by:
● I.T. managers
● Installers
● System Administrators
12 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Conventions used in this guide
Information shown on Fixed width You should see the prompt below:
screen login:
Characters that you Fixed width, bold Enter the following command:
should type exactly as mount /mnt/cdrom
shown
Characters that you Fixed width, bold Browse to the new server by entering
should replace with italic http://servername:8080
appropriate information
Menu selections, Sans Serif, Bold Click on the Install button.
buttons and tabs
Helpful hints that can Tip: Tip:
improve the efficiency or If no part-time licenses are available,
effectiveness of your a full time license may be used
work instead.
Important details that we Note: Note:
want to make sure that Media Encryption may or may not
you do not overlook show up on this form.
Advice that can help you
avoid undesirable ! Important: ! Important:
results
If the network does not meet the three
conditions listed, there will be no
media resources.
Additional references
The following guides contain additional information you may find helpful.
● Avaya Communication Manager Call Recording: A Design Approach for Device Media
and Call Control (DMCC, previously called CMAPI) (Compas ID 128862)
● Verint ContactStore for Communication Manager User Guide
● Viewer for Communication Manager Installation Guide
● Viewer for Communication Manager Quick Reference Guide
● Contact Archive for Communication Manager Installation Guide
● Contact Archive for Communication Manager System Administration Guide
● Unify for Communication Manager Installation Guide
● Witness Enterprise Deployment Guides Impact 360, Full-time Recorder, Enterprise
Security Administration Guide Release 7.8
● Avaya Communication Manager Guide to ACD Contact Centers
● Administrator’s Guide for Avaya Communication Manager
● Administration for Network Connectivity for Avaya Communication Manager
Note:
Note: Avaya Communication Manager documentation is available through the
Avaya online support Web site, http://www.avaya.com.
14 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Chapter 1: System Overview
This chapter provides an overview of the design options for a Verint ContactStore for
Communication Manager system.
Introduction
Verint ContactStore for Communication Manager provides an extremely efficient and
scalable, software only, voice recording platform, running on standard PC Hardware. It
uses Avaya's Device, Media and Call Control (DMCC) features to provide a wide range of
recording modes with all the benefits of VoIP-based recording but without the limitations of
passive tap IP recording systems.
This new approach to recording offers the following benefits:
● The recorder can record potentially any call on the switch. Traditional trunk and
extension modes cannot record internal and tandem calls respectively.
● There is no cabling to maintain as new trunks or extensions are added to the switch.
● Uses standard PC servers with no proprietary cards.
This chapter describes the major components of the Verint ContactStore for
Communication Manager system. It describes the Verint ContactStore for Communication
Manager (which is a mandatory component) and the optional components
16 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Introduction
Server components
The Verint ContactStore for Communication Manager system can be installed as a single
server solution providing recording and replay of calls. Large systems can be built from
several independent recorders or in a master/slave topology. The former approach works
well for station-side recording while the latter provides many of the benefits of traditional
trunk-side approaches - without most of the disadvantages. Internal calls can still be
recorded, for example.
You can extend the scope of the system by adding additional optional server applications
in order to:
● perform quality monitoring and screen recording
● provide centralized shared search and replay
● provide centralized archive facilities
These optional server applications require their own physical server. All of the other
applications in the suite require Windows servers.
Note:
Note: This Guide is the detailed reference for the Verint ContactStore for
Communication Manager (CSCM) only. This component can record voice
calls over IP using Avaya DMCC softphones. It can also act as the Master -
controlling other recorders that provide additional capacity.
Each of the other components has a corresponding guide (as detailed in Additional
references on page 14), which you should refer to for more detail.
18 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Server components
● provide basic search and replay services to users connecting via their browser or via
their telephone
● provide voice recording services to the Verint eQuality Balance (V5 or V7) application
● control other Verint ContactStore for Communication Managers - known as Slaves
● be controlled by another Verint ContactStore for Communication Manager - i.e. act as a
Slave
● act as a warm Standby to a Verint ContactStore for Communication Manager Master
● act as a dedicated, centralized replay server, holding details of recordings made by
other Verint ContactStore for Communication Managers
Viewer
Although the Verint ContactStore for Communication Manager application includes search
and replay facilities within it, you will need to install this alternate replay server in the
following cases:
● If you wish to deploy centralized Archive
● If you wish to combine recordings with those made by other Verint recorder types
In such cases, you may install Viewer on an additional server and configure each of your
recorders to copy the details of its recordings to the database on this server. The database
holds detailed information on all recordings including where the audio content is stored (for
example, either on individual recorders or archived offline). The following figure shows a
typical system, using Viewer to provide access to recordings from two independent
recorders.
See Viewer Installation Guide for full details of this component and Installing Viewer on
page 90 for how to integrate this application into the overall system.
Archive
Each recorder can archive the recordings that it makes itself via a single, locally connected
DVD+RW drive. If you need more sophisticated archival - from multiple recorders to a
common destination, such as a Network Attached Storage (NAS) device or of selected
20 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Server components
recordings only, you can deploy the Archive application on a separate server as shown
below.
See Archive Installation Guide for full details of this component and Installing Archive on
page 94 for how to integrate this application into the overall system. Note that you must
first deploy Viewer in order to use Archive.
External Control
In addition to the data provided by the AES links, you may wish to control and/or tag your
recordings with details from other CTI feeds or application interfaces. These may include
third party systems and/or your own in-house applications. The recorder supports a wide
range of systems and allows them to be connected to your recording system. These
include:
● Avaya Interaction Center (AIC)
● Avaya Proactive Contact (formerly Predictive Dialing System, PDS)
22 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
End-User tools
End-User tools
To access the recordings held in the system, users have a variety of options.
Quality Monitoring
Supervisors and quality assessors use a Windows application (V5) or browser (V7) to
evaluate recordings - using both voice and screen content where available. They can
assess and review calls with their staff as well as analyze and report on the results of
assessments.
Audio is replayed via the desktop PC's soundcard or via the telephone.
Live monitoring of audio and screen content is also supported.
Verint eQuality Balance Evaluations Guide provides full details of the Quality Monitoring
application.
! Important:
Important: Verint ContactStore for Communication Manager does not retain those calls
recorded for Verint eQuality Balance; these use that product's own replay
mechanism.
Access restrictions determine which calls individual users are able to replay. Each
recording is assigned one or more "owners" at recording time (see Search and Replay
Access Rights on page 136 for further details).
The user can play and view details of any call that matches their search criteria and access
rights. When a call is played, a graphical representation of the audio level of the call, the
audio wave form, is displayed. The audio wave form shows silence and tones, so the user
can click beyond irrelevant sections and pinpoint parts of the call that are of interest. See
the accompanying User Guide for further details of this application.
Administration Tools
As the suite is designed specifically for Avaya systems, much of the complexity associated
with generic recording systems has been removed resulting in a system that is easy to
configure and maintain. With the exception of the Quality Monitoring (V5) system (which is
a Windows application), the recorders are administered via a web interface. The detailed
use of this interface is the subject of later Sections in this guide.
24 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Recording Functionality
Recording Functionality
The Verint ContactStore for Communication Manager system records telephone calls
made on Avaya Communication Manager release 3.0 and above - using analog, digital or
IP-based stations. The recorder hosts a bank of IP softphones - each of which provides a
recording or replay port. These record calls by conferencing into a live call using either the
Service Observe or single-step conferencing features of the switch.
This manual only considers audio recording load. For Screen Content recording, please
refer to the Verint eQuality Balance (V5 or V7) Server Infrastructure Guide.
The first task in designing any recording system is to define what is to be recorded. This in
turn is often driven by the reason for wanting the recordings. As the recorder's ports can
also be used for replay and live monitor, it is important to consider these together before
specifying a system. This section introduces the various ways in which recorders' ports can
be used but you should refer to Port Allocation on page 114 for detailed functionality and
limitations of each mode.
Licensing
The Verint ContactStore for Communication Manager must be provided with a license key
that includes the required number of Quality Channels (the sum of recording and replay
ports assigned to the Quality Monitoring application).
Conferenced Recording
Rather than dedicating ports to specific stations, a pool of ports can be used in conjunction
with an Avaya CT (also known as TSAPI) link to record calls on specific stations, agents,
skill groups or VDNs.
In this mode, the recorder uses single-step conferencing to connect into the calls to be
recorded.
Refer to Conferenced Recording on page 125 for a full description of this mode and how to
configure it.
26 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Recording Functionality
Which to use?
In essence, Station Bulk recording is simpler and more economic to deploy than
Conferenced mode. Against this, however, it is a little less flexible. Externally controlled
recording is normally only considered when complex recording rules or additional CTI
control is needed.
It is imperative that you review the detailed functionality, limitations and caveats in Station
Bulk Recording on page 121 and Conferenced Recording on page 125.
Licensing
A "full-time recording channel license" is required for each recording port assigned to these
modes. In Station Bulk, this equates directly to one such channel license per station to be
recorded. In conferenced mode, a channel license is required per port assigned to this
mode.
On Demand Recording
This mode lets users of any phone on your system dial into or conference in a recording
port as and when they want to start recording a call.
One or more "pools" of ports on the recorder can be assigned to this recording mode and
accessed via Hunt Group numbers so that callers automatically reach an available port.
The recorder automatically answers the incoming call on its port and starts recording.
Refer to On Demand Recording on page 119 for a full description of this mode and how to
configure it.
Meeting Recording
A novel use for recording is in taking a detailed log of a meeting, either as an audio record
for those attending, or as a way to include non-attendees later. You can use any meeting
room or office with a telephone that has a speakerphone or, ideally, conference phone
capabilities to record the meeting.
! Important:
Important: The audio recorded with Meeting Recording is the same as someone dialing
in would hear it on the phone used to record it. Place the phone so it picks
up the speech of all participants. They should speak loudly and clearly.
Experiment with this recording mode before relying on it to provide full and
complete records of your meetings. Verint cannot be held responsible for the
failure to pick up all of the audio intelligibly. Use this recording mode as an
aid to note taking, not a replacement for it.
One or more "pools" of ports on the recorder can be assigned to this recording mode and
accessed via Hunt Group numbers so that callers automatically reach an available port.
The user follows the spoken instructions to start the recording and specify which user(s)
can access it.
Refer to Meeting Recording on page 120 for a full description of this mode and how to
configure it.
Scope
Ports assigned to On Demand or Meeting recording
● can be assigned to one or more hunt groups making them easily shared across one or
more user populations
● can be used not only by stations on the switch but also from outside the switch if they
are made accessible via a DID number.
28 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Recording Functionality
Station Executive recording ports on the other hand are dedicated to specific stations and
can only be used to record those stations that can be service observed.
Licensing
As On Demand and Meeting recording ports are shared by all users, they typically record
many calls per day and hence a "full-time recording channel license" is required for each
port assigned to these modes.
Although Station Executive recording requires a dedicated port on the recorder for each
station that uses it, Verint recognizes that typically only a few recordings are made per
station per day. Hence the value of such a recording port is less - and a "part-time
recording channel license" is used.
Tip:
Tip: If no part-time licenses are available, a full time license may be used
instead.
Replay Options
Soundcard Replay
Many users choose to replay recordings via their browser and the soundcard on their PC.
This does not use any ports on the recorder and does not require any additional licensing.
See the eQuality Balance (V5) manuals for details of how to use this replay mechanism in
conjunction with this application.
Telephone Replay
However, the recorder also supports replay via the user's telephone and this does use a
port on the recorder.
eQuality Balance (V5) replay ports form part of the overall pool of ports assigned to Quality
Recording.
All other replay applications make use of telephony Replay ports on a Verint ContactStore
for Communication Manager. Ports configured in this way are compatible with Verint
"AudioServer" ports.
Refer to Phone Replay Ports on page 133 for a full description of this mode and how to
configure it.
Licensing
Replay channels that form part of the eQuality Balance (V5) port pool require a Quality
channel license.
Telephony replay ports used by all other applications require a replay channel license.
Live Monitoring
Via eQuality Balance (V5)
Users of eQuality Balance (V5) can listen in to calls in real-time using their telephone. This
uses one of the replay ports within the Quality pool. See the eQuality Balance (V5)
manuals for details of this live monitoring mechanism.
Licensing
Live monitoring via eQuality Balance (V5) uses a replay port within the Quality pool and is
therefore controlled by the overall Quality Channels license count.
Live Monitor ports on the recorder are licensed separately and a Live Monitor channel
license is required for each one.
30 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Recording Methods
Recording Methods
The recorder uses three different methods to record calls. The table below shows which
mode is used by each mode.
On Demand Recording
Conference
Meeting Recording
Station Bulk Recording
Station Executive Recording
Service Observe
Quality Monitoring for eQuality Balance V5
Externally Controlled (Service Observe mode)
Conferenced Recording
Externally Controlled (Single-step conference Single-step Conference
mode) where the external controller instructs the
recorder to establish a single-step conference.
Externally Controlled (Single-step conference Depends how the external
mode) where the external controller is responsible controller establishes the call.
for connecting the recorder port into the call to be May be conference or
recorded. single-step conference.
The recording mechanisms differ in several respects as described below. Refer to Port
Allocation on page 114 onwards for details of the pros and cons of these modes as these
must be considered alongside the issues listed here.
Note:
Note: Regardless of which recording method is used, each recorder port that joins
a call to record it counts as an additional party on that call. Hence your
normal limit of 6 parties on a call includes all of the recordings being made.
Every recording made reduces the number of "real" participants you can
have on the call.
Service Observe
Station Bulk, Station Executive and Quality recording modes use the Communication
Manager's Service Observe feature. This has the following characteristics.
32 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Recording Methods
● In Avaya Communication Manager 4.x, each call can be service observed up to twice.
Normal, two-way internal calls can therefore be recorded twice and it is only with three
(or more) way calls that the above limitations apply. It is still important to avoid service
observing VDNs related to calls that you need to record.
Call segmentation
As the recorder port sees the same activity as a real user would do when service observing
a station, audio ceases to flow when the station being observed places a call on hold.
Placing a call on hold (automatically as part of a transfer/conference setup or deliberately)
therefore stops recording. A new recording is started when the call is retrieved from hold.
The segments of the call are stored as separate recordings (.wav files) and can be
searched and played as two calls.
! Important:
Important: If the call is retrieved from hold by another station, either by means of a
transfer or a "park" operation, the subsequent segment of the call is only
recorded if the other station is also being recorded.
The recorder's Search and Replay mechanism treats these segments as two separate
calls. However, if you find one call segment, you can easily find the other segments by
clicking on the link in the UCID column. Viewer, a separate server replay application, on
the other hand, "merges" these call records into one and shows the hold period as silence.
If an external controller is used, it may segment calls at points it chooses.
Internal Calls via a VDN do not show who answered - CM 3.1 and earlier
If an agent handling a call dials a VDN to transfer, conference or simply consult on it, the
details of the party that answers the call are not visible to a station service observing that
call. The call will be tagged with the VDN number dialled but not the agent or station that
answered the call. This is corrected in CM3.1 load 632. If using an earlier version than this,
consider updating with Patch #11855.
Bridged Lines
Where bridged line appearances are used on stations being recorded, calls made on the
secondary line appearance will be recorded but the details about the call will be limited to
the identification of the station being recorded. Only calls made on the primary line
appearance will include full call details.
Exclusion
If any party on the call invokes the Exclusion feature, the call cannot be recorded. (Check
with Avaya for changes to this from CM 3.1 onwards).
Beep Tone
If you do not need to inject beep tone while recording, use "No Talk" service observe. This
option, available from CM 3.1 onwards, does not use up a time-slot. Otherwise you must
design for an additional time-slot being used to carry each call that is actually being
recorded. If you need to inject beep tone you must use "Talk/Listen" service observe.
"Listen Only" service observe should not be used with CSCM.
34 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Recording Methods
Single-step Conference
Single-step conferencing as used by Conferenced mode recording and Externally
controlled (single-step conference option) has the following issues:
CTI Requirement
When recording in this mode, the recorder uses JTAPI which in turn uses Avaya CT (also
known as TSAPI). This requires not only that the CTI feed be available but also that
sufficient licenses are available for it. See TSAPI Simultaneous User Licenses on page 60
for details.
Timeslots
Single-step conferences do not require an additional timeslot on the switch if beep tone is
NOT used.
Call Segmentation
The recorder continues to record only so long as the real parties on the call are connected.
If the call is on hold, recording stops.
If an external controller is used, it may segment calls at points it chooses.
Beep Tone
If you choose to inject beep tone on a single-step conferenced recording, the recorder
becomes a full member of the call rather than a listen-only member and therefore:
● Becomes visible to the agent, who can see that the call is conferenced
● Uses an extra timeslot on the switch
Conference
In some modes a user or an external application will dial a port on the recorder. When this
happens, the recorder answers the call and is therefore a normal party on the call.
Timeslots
As "just another party" on the call, the recorder port will use the single additional timeslot
that any other phone would use when added to a call.
Call Segmentation
As the recorder port is a normal party on the call, it is still connected even if one or more
other parties on the call places the call on hold. It will receive the same audio that the
parties remaining on the call receive. This may include music on hold or silence.
If an external controller is used, it may segment calls at points it chooses.
36 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Miscellaneous
Miscellaneous
Beep Tone
Some states and countries require that both parties on a call be made aware that the call is
being recorded. One way to do this is to apply a tone to the line. Note, however, that most
telephone users are unaware of the significance of this tone and might, in fact, regard it as
a fault. There are more effective means of informing the user that the call is being
recorded. For example, you can inform users on advertising and in contract literature or
play a recorded announcement before the call is connected. Check the legal position in
your jurisdiction and apply the appropriate settings.
See the discussions of how each recording mode works earlier in this chapter to determine
whether or not you need to turn on this warning tone within the recorder. In most cases, it is
recommended that you set this option to No and use the other mechanisms described
there.
International support
The recorder's browser-based Administration and Search/Replay interfaces are provided
in several languages. Check with Verint for availability of specific languages. International
support includes:
● Time zone and DST support. All dates and times are stored in the database in
Coordinated Universal Time (UTC). However, when you view records using the search
and replay application, these are converted to your local time. If you view the records
using a database query tool, the times will be shown in the time zone of the client
machine, which may be different from the server time. Note that the XML files relating to
the recordings include ISO standard timestamps, giving both UTC and offset from
Greenwich Mean Time (GMT).
Liability
Liability of Verint for failure to record any calls is limited under the terms of supply.
38 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Chapter 2: Planning and Prerequisites
This chapter gives details of the prerequisites for a Verint ContactStore for Communication
Manager system. You should also review Chapter 6 System Security as some of the
optional elements described there may also require additional cost and/or effort.
The main sections in this chapter are:
z Introduction on page 40
z Audio Format on page 41
z Storage Requirements on page 43
z Server Platform on page 46
z Network Issues on page 51
z Recorder Licensing on page 52
z Avaya system prerequisites on page 54
z Topologies on page 62
z Integrating with other systems on page 67
Introduction
Unfortunately, there is no one "right" order in which to plan a system. A number of the
requirements and pre-requisites are inter-dependent and it may be necessary to iterate
through this section several times, refining your plans each time. This Chapter assumes
that you have read the previous one and know the type and quantity of recording, replay
and live monitor that you require - and hence your total license requirements.
This Chapter will now guide you through:
z identifying what is to be recorded, the options for doing so and the relevant license
requirements for the preferred option
z determining the storage needed to hold your recordings
z sizing the servers needed for each application
z quantifying the network bandwidth needed
You can then determine an appropriate system topology.
40 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Audio Format
Audio Format
In all cases, calls are recorded using resources on the Avaya Communication Manager to
conference a recorder port into a live telephone call. One of the benefits of this approach is
that the recorder can ask to receive audio in a format that suits it - without impacting the
experience of the parties actually speaking on the call.
The recorder can request either G.711 (µ-law), or compressed G.729A data streams. You
must choose which is appropriate for your recording needs, network and server sizing.
G.711
If the recorder receives audio in G.711 (µ-law) rather than G.729A, bulk recordings will be
normally be compressed by the recorder and stored as G.726 (16kbps) files. (Compression
can be disabled by setting cscm.disablecompress=true in the properties file.) Selective
Quality recordings controlled by eQuality Balance will be passed to it unchanged.
Note:
Note: When using G.711, the recorder always requests µ-law, never A-law. This
applies to all countries regardless of that country’s national preference.
Therefore, if you select G.711 rather than G.729A the implications are:
G.729A
Conversely, if receiving G.729A, the recorder will not have to perform any compression
tasks - for either bulk or quality recording. The pros and cons are reversed from those
shown above.
Therefore, if you select G.729A rather than G.711 the implications are:
42 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Storage Requirements
Storage Requirements
Having determined the type, size and location of your recording capacity, you must now
determine how much storage is required within the system. Storage requirements of many
terabytes are not uncommon.
Storage is required for:
z the operating system and applications installed on each server
z the audio content of recordings
z the database holding the searchable details of these recordings
In each case you should consider requirements locally at each recorder and centrally.
To do this, you will need to know:
z how many recordings will be made on the recording channels already identified
(typically expressed in channel hours per day). In other words, how many hours of audio
you expect to record on each recorder every day.
z how long you wish to retain recordings (typically expressed in days).
z the average duration of a call (typically expressed in seconds).
Rather than storing bulk recordings on RAID arrays in each recorder, many customers
prefer to use Storage Attached Networks. These must be connected directly to recorders.
Hierarchical File Storage (HFS) Systems and Network Attached Storage (NAS), however,
can only be supported via the separate Archive application.
The table below summarizes the requirements for Bulk Recording on a Verint ContactStore
for Communication Manager.
Quality Monitoring
When used to provide selective audio recording services for the Verint eQuality Balance
application, the Verint ContactStore for Communication Manager only uses a small amount
of local storage for voice recordings (less than 1GB). As each Quality Monitoring recording
is completed, the recorder transfers it to the Quality Monitoring application's storage area.
As the volume of recordings made by a selective, quality monitoring application is normally
much less than that of a bulk recording system and is comparable to the screen recording
volumes, audio is normally stored in G.711 64kbps PCM µ-law format (approximately
27MB per channel hour).
This application also has to store:
z screen content recordings
44 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Storage Requirements
Backup Storage
See Backup/Restore on page 141 for a discussion of Backup and Restore options. You
should determine whether additional storage space is required in your corporate backup
system to accommodate the new recording system.
Server Platform
Taking the above factors and the potential location(s) of your recorders into consideration,
you must determine how many channels of each type of recording you wish to deploy and
on which site.
Having decided the total recording capacity at each of your locations, you must translate
this into one or more server platforms capable of handling the load identified.
Dedicated server(s) must be provided with no other applications running on them.
Sizing
The table below shows the maximum capacity of four server types that are used as
benchmarks for planning recorder hardware.
46 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Server Platform
Recorder
The following table shows the maximum channel counts supported for the above servers.
This table takes the following factors into account:
z Recording G.711 calls and compressing these to G.726 loads the server more heavily
than receiving and storing G.729A calls.
z The CTI feed required for Conferenced mode increases the load on the server
z Using recorder ports for replay via the telephone or live monitor not only loads the
recorder but these ports are more susceptible to packet jitter and therefore the recorder
cannot be loaded as heavily when using these modes.
z These figures assume NO encryption is being used. If the audio to and from the Avaya
system is encrypted, reduce capacities by 10%. If using a Key Management Server and
encrypted storage, capacities are futher reduced. Exact figures are not yet available.
NOTES
Conf = Conferenced mode recording ports.
Others = All other modes.
N/R = Not recommended.
Sizings assume an 8 hour working day. For 24 x 7 running, provide one server level
higher (for example, use server C instead of B).
Sizings assume moderate replay load. See below for further details.
Sizings assume an average of a three minute call handle time.
Replay Load
When using Replay Ports there are additional considerations.
z The above sizing assumes a moderate replay load of up to 5 concurrent replays. If using
telephone replay, up to 8 ports can be supported (of which rarely will more than 5
actually be playing concurrently) without compromising these loading limits.
z To support up to 10 concurrent replays, increase the server specification one level (for
example, use server C instead of B).
z For higher loads, separate replay onto a dedicated Viewer or Central Replay server.
48 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Server Platform
DVD+RW Drive
A wide range of DVD drives has been used successfully and Verint is not aware of any
specific model limitations at this time. Only single-layer 4.7GB DVD+RW media are
supported.
Note:
Note: Most drives are advertised as supporting a wide range of subtly different
media types (e.g. DVD+R, DVD-R, DVD+RW, DVD-RW, single and double
layer etc.). Regardless of which media the drive supports, the recorder
ONLY supports writing of DVD+RW single layer media. You must confirm
that the drive supports this media type, works under the version of operating
system you are using and that you only insert this type of media.
RedHat 5
RedHat Enterprise Linux 5 incorporates new features as part of it’s Hardware Abstraction
Layer. You need additional steps to turn off the HAL’s media detection service, which
interferes with the archiver.
To disable the media detection service follow these steps:
1. Execute the "lshal" command and direct its output to a file
lshal > hal.txt
2. Open the created file and look for the string storage.drive_type. It will list all
devices, local and external, so you will find the floppy, cdrom etc.
3. Locate your device. It would be either cdrom, cdrom1..etc, or dvd.
The adjacent lines for storage model and vendor will contain specific details regarding
the device, for example:
storage.serial = 'HL-DT-ST_DVDRAM_GSA-E50L_P01070913222527'
(string)
storage.vendor = 'HL-DT-ST' (string)
storage.model = 'DVDRAM GSA-E50L' (string)
storage.drive_type = 'cdrom' (string)
50 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Network Issues
Network Issues
In planning the network that will support your Verint ContactStore for Communication
Manager system, you must consider:
z the additional load imposed on the network
z the IP ports used - so that firewalls can be configured appropriately
Load
You must design your network topology to accommodate the additional traffic created by
the recording system. Each active recording port places the same load on the network as
an IP phone carrying the same call. Note that the recorder uses a 60ms packet interval,
which significantly reduces the total network load.
Ports Used
The components of the system use a number of IP ports to communicate:
z between each other
z with various Avaya Communication Manager components
z with end-users and administrators
Recorder Interfaces on page 199 provides a diagram and table listing all of the interfaces
to and from the Verint ContactStore for Communication Manager software. Your network
and firewalls must be configured to permit traffic to pass over these links.
Recorder Licensing
Verint ContactStore for Communication Managers are licensed through an Activation Key
which is tied to the hardware for which is it is issued. The license key contains details of
server type and port counts. It may also contain an expiry date.
Server Licenses
You will need:
z a server license for each Verint ContactStore for Communication Manager
z a Central Replay Server license for each Central Replay Server
Port Licenses
You will need an appropriate "port license" for each port on a recorder. There are five types
of port licenses as discussed under Recording Functionality on page 25. The table below
summarises which licenses are required for each recording mode.
Conferenced Recording
Externally Controlled Recording
eQuality Balance V5 Quality
(Recording or Replay)
Telephone Replay Replay
Live Monitor Live Monitor
52 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Recorder Licensing
Other Licenses
You will also require Avaya licenses as described in DMCC (IP_API_A) Licenses on
page 60 and TSAPI Simultaneous User Licenses on page 60.
Timed Trials
Verint can, at its discretion, issue an activation key which includes an expiration date. This
allows for timed trials of any combination of features and capacity. As the expiration date is
fixed within the license, the server will stop operating at that date regardless of when you
enter the license key.
To extend a timed trial of to upgrade to a full license, contact Verint for an updated license
activation key.
A five day trial license is available automatically from the license key entry page.
! CAUTION:
CAUTION: The five day trial license must not be used for production recording. When a
full license is installed, any trial recordings become unplayable
Communication Manager
Verint ContactStore for Communication Manager requires AE Services and hence is only
supported on the models and versions of Communication Manager that support this
platform.
Model
The Avaya media server running Communication Manager must be an S8xxx system
(currently S8300 through S8720).
Station Count
Each port on a recorder is an additional IP phone on the switch. Do not exceed the total
station count for the switch in question.
Loading
Each recording adds as much load to a switch as a normal call. Hence you can only record
100% of calls if your switch is running at no more than 50% of its design load. For example,
S8700 switches running at up to 20,000 BHCA (complex call center call types) can have all
calls recorded. Higher loads would require an S8710 or S8720.
Software Version
Verint ContactStore for Communication Manager requires one of the following:
z CM 3.1- CM 4.0
Please check on http://support.avaya.com for more recent loads.
54 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Avaya system prerequisites
Gateway Resources
These house the media switching components of the Avaya system. You must ensure that
the system has, or is expanded to have sufficient:
z Card Slots for the C-LANs and Media Processing Resources described below
z Time-slots for the original calls and, where needed, the recording channels.
Card Slots
Each C-LAN and Media Processing card must be located in the appropriate gateway and
therefore in an available card slot alongside the existing cards.
Time-slots
The recorder conferences into calls in order to record them - using Single-step conference
(conferenced modes only) or service observe.
z ANY recording in which the recorder is injecting beep-tone will require one additional
time-slot per concurrent recording.
z With Service Observe modes, use the "No-talk" option (if your switch supports it) in
preference to the "Listen-only" variant. The latter requires an additional time-slot per
concurrent recording - even if you do not inject beep tone.
Where additional timeslots are needed, the total timeslot count must not exceed the
maximum available on that port network (484). Therefore, for a 100% recorded system,
using service observe on a switch that does not support "No-talk" observe, or beep tone
injection do not equip any port network with more than:
z 6 x T1s (=144 calls, 432 timeslots)
or
z 5 x E1s (=150 calls, 450 timeslots)
These guidelines allow for reasonable additional timeslot usage for conferences with other
port networks, shared tones and so on.
Rebalance port networks or add new ones to reduce the timeslot requirement on each to
this level.
AE Services
Each port on a Verint ContactStore for Communication Manager uses a DMCC softphone.
When using Conferenced recording mode (or when an external controller needs to instruct
the record to single-step conference into calls) the recorder also makes use of Avaya CT
services.
From Communication Manager 3.0 onwards, these are both provided by Avaya's AE
Services platform.
Loading
Note:
Note: To avoid overloading an AE Server, do not attempt to record more than
20,000 calls per hour through each AE Server. (20,000 BHCA).
Note:
Note: You must not use more than 1,000 softphones (recorder ports) through a
single AE Server.
If several small recorders are used, you may connect them to a shared AE Server, but only
if the total load on the AE Server does not exceed this figure. If the load imposed by a
single recorder exceeds this figure, you must split the load across multiple smaller
recorders, spreading the load across multiple AE Servers.
Multiple AE Servers
Most Communication Managers can support up to 15 AE Servers but this is a total count -
not just those associated with recording. You may have othe AE Servers associated with
other CTI applications.
Location
In a multi-site system, you should always aim to install an AE server on the same site as
the recorder(s) that is (are) using it. This minimizes the chance of system failure due to
loss of connectivity between recorder and switching system.
Vintage
Verint ContactStore for Communication Manager 7.8 has been tested against AE Services
4.0. Ensure you are running the latest recommended load of AE Services.
56 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Avaya system prerequisites
C-LAN
C-LANs (TN799 DP) are used for two purposes:
z CTI information is passed through them
z DMCC softphones register through them.
Number of C-LANs
To ensure that a C-LAN does not become a single point of failure in a recording system,
you should always provide at least two C-LANs for each AE server. As the CTI load and
channel count increases, you should provide more C-LANs as shown below.
Location of C-LANs
For maximum resilience, spread C-LANs across multiple port networks.
To avoid bottlenecks between the port network and the switch, do not connect more than
400 recording ports to the C-LANs in any port network.
Vintage
Refer to the switch documentation for the release of Communication Manager you are
running.
Firmware
The latest update is recommended but these cards must be at least at Firmware update
132.
VoIP Resources
Each port on the recorder will use media processing resources on the Avaya system when
it is active (recording or replaying via the telephone). You must ensure that sufficient media
processing resources are available for the recording and replay load - in addition to any
existing use of these resources within your system.
Resource Requirements
G.711 recording or replay uses less resource than G.729A recording. Note that replay is
always performed using G.711. Depending on the type and version of your Communication
Manager, you may require one or more of the devices shown in the table below.
Media 64 32
Processing
Resource
TN2302AP
MM760 VoIP Included within 64 32
Module S8300
Media 320 280
Processing
Resource
2602AP
These requirements are solely for the recorder’s ports and are in addition to any used by
other IP phones or other switch components.
Note:
Note: It is not recommended to dedicate Media Processing resource to recording
so it is important to over- rather than under-provide as other users of this
resource could otherwise starve the recorder of this capability. On the plus
side, you may use existing spare capacity in the switch for recording - but
check the location of the resource as well as the amount.
Location of Resources
When adding recording to systems with multiple port networks, it is vital to check that the
recordings do not overload the interconnects between port networks.
If a call cannot be recorded using VoIP resources within a port network that the call would
have been routed through anyway, then the call must be routed to another port network to
58 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Avaya system prerequisites
reach the VoIP resource. This varies according to whether the phones are digital (DCP) or
IP and, with IP phones, whether the system is IP- or Multi-connect based.
Site the VoIP resources according to the table below.
Where, N=1 for G.711 recording and N=2 for G.729A recording.
Vintage
Refer to the switch documentation for the release of Communication Manager you are
running.
Firmware
The latest update is recommended but Media Processors must be at least at Firmware
update 105.
Fault Tolerance
You should consider providing one additional board per port network. In the event of a
board failing, a spare is then available to handle the full recording load, without having to
look outside the Media Gateway - which could introduce sub-optimal use of back-plane
timeslots and potentially impact recording in other gateways.
Further Information
For more information, refer to Chapter 2: Administering C-LAN and IP Media Processor
circuit packs, in the Administering Converged Networks section of the Administration for
Network Connectivity for Avaya Communication Manager manual.
Multi-Connect Capacity
Keeping in mind the number and location of recorders and VoIP resources as defined
above, confirm that the capacity of the Multi-connect switch (if present) is not exceeded.
For AES to 1
connect
To record Maximum Number of concurrent recordings
calls
To track Number of Skill groups being observed to track logins
agent logins
To observe If recording If recording If recording If recording
stations specific specific specific skill specific
currently of Stations agents groups VDNs
interest
Number of Maximum Maximum 0
stations to number of number of
be recorded these these
agents agents
logged in logged in
concurrently concurrently
60 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Avaya system prerequisites
Note:
Note: If an external controller is tracking CTI events, then it may require Avaya CT
licenses. In addition to its requirements, the recorder will still need one
license per concurrent recording and AES will still need its 1 license.
Topologies
This document has so far discussed functionality in terms of "applications" without being
specific as to the physical location of these. As the individual components of the recording
system interconnect using IP-based mechanisms, you may distribute the components
across your Enterprise's network in a wide range of topologies.
In small systems, a single server can perform recording, storage and retrieval but in larger
systems, you can separate these tasks onto different servers in a variety of ways as
discussed below. A number of the basic topologies have already been shown in the
diagrams of Recording Methods on page 31. The following paragraphs define the rules
under which each of these basic topologies can be used and introduce the more advanced
topologies required for larger and more fault tolerant systems.
62 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Topologies
Partitioned Systems
If your recording requirements can be completely separated, you can deploy multiple
independent recorders, each unaware of the others. This applies if you are using:
z Station Bulk mode
z Station Executive mode
z Conferenced mode to target specified stations.
Master/Slave Recorders
Where you are using Conferenced mode to record on the basis of Agent ID, Skill hunt
group or VDN, there must be a single recorder in charge of all recordings.
To support large systems, you can split the control of recording from the actual recording of
the audio stream.
In such cases, the "Master" recorder is connected to the Avaya CT feed and is aware of
the recording rules - and of the type and locations of the other, "Slave" recorders as shown
below.
The Master recorder communicates with each Slave via a TCP/IP link. It instructs the
slaves to tag the required data/voice streams with the details it learns from the Avaya CT
link.
64 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Topologies
Bonded and/or dual NIC cards are strongly recommended. Where two independent NIC
cards are used, these should be connected to independent Ethernet switches to provide
maximum fault tolerance. (Never give the two interfaces IP addresses in the same subnet.)
For still higher availability, you can provide one or more standby recorders. Advanced
configuration options let the recorders match your switch failover modes - supporting both
ESS and LSP.
This is a complex topic and a brief summary of the options is given below. (See also Fault
Tolerant Systems on page 251 for further details of how to design and configure fault
tolerant systems)
Master/Standby Recorders
In small systems, you can install and configure a Standby recorder to "shadow" another
recorder - referred to as the Master. The standby copies configuration details automatically
from the primary via a fault-tolerant TCP/IP connection between the two. Over these same
links, the two recorders exchange "heartbeats" every second. The standby will take over
should the heartbeat fail or should the master request that it do so. This latter case will
occur, for example, due to the master’s disk filling or connection to the AE Services failing.
The figure below shows a typical configuration.
Note:
Note: It is normal to provide Viewer or a Central Replay Server so that all
recordings, whether made by Master or Standby, are visible to end users in
a central database. Otherwise, users would have to know which recorder
was active at a given time and search against its database to be sure of
finding a recording.
In larger systems, where a Master recorder controls one or more "Slave" recorders, the
use of a Standby recorder ensures that the Master does not become a single point of
failure for the whole system. In this case, each of the slaves permanently connects to both
Master and Standby. This allows the Standby to take over rapidly should the Master fail.
Centralized Applications
In any system with more than one recorder, you may wish to deploy central search and
replay (Viewer or Central Replay Server) and/or Archive applications. In this case, each of
the recorders:
z provides details of its recordings to the central database
z responds to requests from the central applications for replay of recordings that it is
holding.
See Viewer Installation, Archive Installation and Archive Administrative Guides for sizing
and planning of these servers. Note that the recording system is designed to continue
recording regardless of the state of these central servers. This means that the availability
of the central applications cannot affect the reliability of the recorders themselves.
66 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Integrating with other systems
68 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Chapter 3: Installation
This chapter gives details of the steps to install a Verint ContactStore for Communication
Manager system.
The main sections in this chapter are:
z Overview on page 70
z Avaya System Configuration on page 71
z Order in which to Install Applications on page 80
z Platform Prerequisites on page 81
z Installing Verint ContactStore for Communication Manager on page 86
z Installing Verint eQuality Balance (V5) on page 88
z Installing Verint eQuality Balance (V7) on page 89
z Installing Viewer on page 90
z Installing Archive on page 94
Overview
Installation of a complete recording system requires:
z Configuration of your Avaya system to support recording.
z Planning the order in which to install the application servers
z Preparing each server
z Installing the Verint software on each server
z Installing client software for users of the Quality Monitoring application (if required).
70 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Avaya System Configuration
Prerequisites
Refer to the appropriate Avaya documentation to apply any prerequisite upgrades and/or
additional licenses as detailed in Avaya system prerequisites on page 54.
Customer-options
Set the required system parameters and check that IP_API_A licenses have been installed
as follows:
1. Run the following command
display system-parameters customer-options
2. On page 4, verify that Enhanced Conferencing is set to y.
3. On page 6, verify that Service Observing Basic and Service Observing Remote/By
FAC are set to y.
Note:
Note: Station Bulk, Station Executive, Quality and (optionally) Unify Recording
modes use Service Observe.
4. On page 9 or 10 (it varies depending on your system), check the 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. 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.
Features
You must set the following system-wide CM parameters.
1. Enter the following command line:
change system-parameters features
2. On Page 5, set Create Universal Call ID (UCID) to y and allocate a number to the
switch if it does not already have a unique reference. If there is only one switch, set it
to 1.
3. On Page 12, set Send UCID to ASAI.
Adding IP softphones
You must add a station on the Communication Manager for each port on the recorder.
Create all stations identically. You will subsequently use the recorder's Administration
pages to assign them to the various modes.
1. Use the add station command to add as many stations as there are ports on your
recorders. Note the station numbers as you will need to enter these into the recorder
later.
2. Run add station xxxx, where xxxx is the new station's extension that you want
to administer.
3. For Station Type, enter 4624.
4. For Security Code, enter the numeric security code the recorder must use to register
softphones with the Communication Manager. Note this security code as you will need
to enter it into the recorder later.
5. Verify 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 any of the
following recording modes:
a. Station Bulk
b. Station Executive
c. Quality
d. Unify/External Control (Service Observe)
! Important:
Important: Verint recommends that you use a dedicated CoR for the stations being
used as ports on the recorder.
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, refer to the following resources:
72 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Avaya System Configuration
! WARNING:
WARNING: Since a station can only be service observed once (CM 3.x) or twice (CM
4.x), it is important that you disable, through the use of appropriate CoRs,
the ability of anyone else to service observe those stations that must be
recorded at all times. If you must listen to these stations while they are being
recorded, use additional Live Monitor ports on the recorder.
6. In the IP Softphone field, enter y.
7. Set Display Language to english.
8. On Page 2:
Set IP-IP Audio Connections and IP Audio Hairpinning to n
9. On Page 3:
a. Assign the following feature buttons in addition to the three default call
appearances:
i. Button 4: conf-dsp
ii. Button 5: serv-obsrv
b. Clear the call-appr setting on Button 3.
STATION OPTIONS
Loss Group: 19 Personalized Ringing Pattern: 1
Message Lamp Ext: 11001
Speakerphone: 2-way Mute Button Enabled? y
Display Language: english
Survivable GK Node Name:
Survivable COR: internal Media Complex Ext:
Survivable Trunk Dest? y IP SoftPhone? y
IP Video Softphone? n
ABBREVIATED DIALING
List1: List2: List3:
BUTTON ASSIGNMENTS
1: call-appr 7:
2: call-appr 8:
3: 9:
4: conf-dsp 10:
5: serv-obsrv 11:
6: 12:
74 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Avaya System Configuration
You could assign all ports for a recording mode to a single hunt group to provide a single
shared pool of ports, available on a "first come, first served" strategy. Alternatively, you
could split the pools into several independent hunt groups - or even leave some individual
ports. For example, a dedicated port to be used only by the conference phone in the board
room would ensure that meetings there could always be recorded.
For more information about hunt groups, refer to Managing Hunt Groups in Chapter 7:
Handling incoming calls, in Volume 1 of the Administrator Guide for Avaya Communication
Manager.
Note which ports you have assigned to which hunt groups.
IP Codec Set
Codec Set: 4
76 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Avaya System Configuration
Emergency
Subnet Location
From IP Address (To IP Address or Mask) Region VLAN Extension
192.168.2 .100 192.168.2 .100 1 n
. . . . . . n
. . . . . . n
. . . . . . n
AE Server Configuration
The AE Server provides the recorder with DMCC client services and, (if using Conferenced
recording or eQuality Balance in selective mode) TSAPI services. The following
instructions assume the AE Server has been installed specifically for recording and that
OAM and User Management administrative accounts have been created. If the AE Server
to be used is already in use for other purposes, check these settings and confirm that its
current configuration is appropriate.
Administer C-LANs
Use the AES Administration Screens to add the C-LANs that will be used to register
softphones.
1. From the CTI OAM Admin OAM main menu, select:
Administration > Switch Connections
2. Click Edit H.323 Gatekeeper. OAM displays the Edit H.323 Gatekeeper - Switch1
page.
3. In the Name or IP Address field, type the hostname or IP Address of the switch
C-LAN, and then click Add Name or IP.
TSAPI Configuration
Even if there are no explicit CTI clients, you must configure TSAPI (also known as Avaya
CT). Do this after AE Services have been configured as above.
User Account
If you are using the Security Database for Authentication, create a CTI user account on the
AE Server as follows:
1. Go to: User Management > Add User
2. Complete all of the required fields (indicated by an asterisk).
3. Select userservice,useradmin from the Avaya Role drop-down menu.
4. Select Yes from the CT User drop-down menu.
5. Ensure that the new CTI user has access to all TSAPI-controlled devices by going to:
Administration > Security Database > CTI Users > List All Users
6. Click Enable next to the Unrestricted Access option.
78 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Avaya System Configuration
Test Phonesets
You should provide three Avaya phones close to the recorder - in the same or a
neighboring rack. Configure these phones with all of the features in use on the phones that
you intend to record. You can then use these to place test calls while working on the
recorder.
80 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Platform Prerequisites
Platform Prerequisites
Before installing the Verint ContactStore for Communication Manager (Master, Slave or
Standby) software on the designated server(s), you must prepare each server as
described below.
Note:
Note: For the other server components refer to the relevant product manual rather
than this one.
Operating System
Version
The operating system must be RedHat Enterprise Linux Version 4.0 Update 5 or higher or
Version 5.0. RedHat Enterprise Linux Version 3.0 is not supported for new installations but
existing systems running on it can be upgraded to CSCM 7.8. The operating system must
be installed using the RedHat kickstart process. Verint supplies a tool to generate the
kickstart script automatically. If you cannot use the kickstart process you must contact
Verint Professional Services for guidance.
Disk Storage
You must plan the partitioning of your server's disk(s) in line with the storage needs
outlined in Storage Requirements on page 43. The kickstart script supports servers with
one logical disk or two physical disks. If using RAID, use the RAID utility to make one large
logical volume.
The kickstart script partitions the disk(s) as follows:
! WARNING:
WARNING: The size of /var must be calculated carefully based on the number of
recordings per month and how many months the database records will be
retained.
! WARNING:
WARNING: Because good time synchronisation is so vital you must take care with this
setting and test that it is working after installation.
d. Fill in the address and netmask for the first NIC.
e. Specify the address of the default router, which must be in the same subnet as the
address that you specify for the first NIC.
f. Specify the hostname, preferably as a fully qualified domain name (e.g.
cscm1.bigcorp.com)
g. Specify the IP address of a DNS server
h. If there is a second NIC and you want to enable it, fill in the address and netmask.
This address must not be in the same subnet as the first NIC.
82 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Platform Prerequisites
i. For one logical drive or physical disk, select 1 disk, and specify the size of the /var
partition.
For two logical drives or physical disks, select 2 disks, and specify the device
names of the two devices. If you do not know the names of the two devices, follow
the first few steps of a normal interactive RedHat installation. After selecting the
keyboard type, the RedHat installer will display a menu showing the names of the
devices.
j. Select the number of Linux tools to install. Minimal chooses just those parts of
Linux needed to run the recorder (Choose this option only if you are familiar with
Linux and will perform all installation from the command line.) Recommended
installs other useful management tools and the Linux windowing system.
4. Click Generate Floppy.
5. Eject the floppy.
! WARNING:
WARNING: Make sure that the disks are the Update you require. RedHat and other
vendors still sometimes supply Update 0 disks.
3. Wait for the boot: prompt.
4. Insert the floppy.
5. Type linux ks=floppy
6. Wait for the automated install to complete and insert the other disks when requested.
4. Boot the target server using the first RedHat disk, and wait for the boot: prompt.
5. Type linux ks=http://webserveripaddress/path/ks.cfg
DVD Drive
Install and test your DVD+RW drive by writing a test file to the disk before attempting to
use it with the recording system.
Network Connectivity
Domain Name Server (DNS) Entries
Ensure that the IP node names of all servers that make up the recording system are stored
in the appropriate Domain Name Servers. Subsequent configuration can then be done by
using the host name rather than having to use numeric addresses.
Network Routes
You should ensure that valid IP paths exist between each of the servers and from servers
to the AES, CLANs and all media processing resources. See Recorder Interfaces on
page 199 for details of ports used.
84 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Platform Prerequisites
network paths between each Master and its standby. Failure to do so will leave the system
vulnerable to failure should a common component in the network paths between the two
fail. In such a case, both recorders will attempt to take control of all recording, with
unpredictable results.
To ensure this,
1. Assign IP addresses in one sub-net (call it A) for the first NIC on the Master and the
first on the Standby.
2. Assign IP addresses in a different sub-net (call it B) to the second NICs on the Master
and Standby
3. Connect the NICs in sub-net A to one Ethernet switch and those in sub-net B to a
different switch. (If you do not have two Ethernet switches you can use a cross-over
cable directly between the two NIC cards)
4. Log on to the Standby recorder and ping both IP addresses of the Master.
5. Remove the NIC cable from the first NIC (sub-net A) on the Standby server. Confirm
that you can only ping the Master on its sub-net B address. Replace the cable.
6. Remove the NIC cable from the second NIC (sub-net B) on the Standby server.
Confirm that you can only ping the Master on its sub-net A address. Replace the cable.
7. Log on to the Master recorder and ping both IP addresses of the Standby.
8. Remove the NIC cable from the first NIC (sub-net A) on the Master server. Confirm that
you can only ping the Standby on its sub-net B address. Replace the cable.
9. Remove the NIC cable from the second NIC card (sub-net B) on the Master server.
Confirm that you can only ping the Standby on its sub-net A address. Replace the
cable.
If any of the above tests fail, adjust your network routing and/or firewall settings until you
can be sure that there are two independent paths between Master and Standby and that
these are being used rather than just being theoretically available.
86 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Installing Verint ContactStore for Communication Manager
88 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Installing Verint eQuality Balance (V7)
Installing Viewer
The installation and configuration process for this server component is quite complex and
has many options. The instructions below describe a basic approach that is appropriate for
most installations. They complement the Viewer Installation Guide as they highlight easily
overlooked items. You should print out the guide for ease of reference as you work through
the installation.
Prerequisites
Before starting to install Viewer, double-check that:
z you have installed the Windows components IIS and Message Queuing services.
z you are not trying to access the server using Internet Explorer 5.0 or earlier. You must
use 5.5 or higher.
z you have either installed SQL Server 2005 Service Pack 2 OR SQL Server 2000 plus
Service Pack 4 and applied the Hotfix as specified in article 899761 of the Microsoft
Knowledgebase.
Follow the Viewer install guide meticulously. It is critical that you set up mixed mode
security and note the System Administrator (sa) password. Consider using "sa" as the
password temporarily and changing it once the system is fully configured. This helps
support personnel access the system to address any initial setup problems you may have.
z check that all the servers in the recording system exist in DNS correctly so that you can
ping each by name rather than just numerical address. You are less likely to make
errors entering names than numbers. Check that you can ping the Viewer server by
name from the recorders and vice versa.
Installing Viewer
You must install this application while logged in as an administrator.
Note:
Note: Do not forget to install the Core components first. Drill down into the
Installation\CoreInstall folder and run setup.exe.
When asked for a username and password for the Viewer account, consider leaving it at
the default username and setting the password temporarily to "W1tn355" and changing it
once the system is fully configured. This helps support personnel access the system to
address any initial setup problems you may have.
90 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Installing Viewer
Configuring Viewer
Follow Configuring the System in the Viewer Installation Guide, noting the corresponding
points below as you go. These will provide a basic working setup that you can then return
to as you become familiar with the application.
1. Using the console created above, add the local Administrator user to all four roles.
2. Open a browser on the server or any other networked computer and access
http://servername/avaya. If asked, log in as Administrator.
Note:
Note: If you see errors, try adding the server to your list of Trusted Sites - it is
trying to download an ActiveX control to you.
Tip:
Tip: You do not need to add locations at this stage.
! WARNING:
WARNING: You must use the server's hostname rather than dotted IP address (nor the
name localhost) when accessing the url and when entering the domain
name as part of the username if you are prompted for username and
password.
3. Add a system - with the following settings:
a. System Name = your server name
b. System Type = Contact Platform Database
c. Server Name = your server name
d. DatabaseName = EWareCalls (Case sensitive)
92 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Installing Viewer
Installing Archive
Do not attempt to install or configure Archive until you have proved that Viewer is working
with all recorders.
Follow the installation instructions in Archive Installation Guide.
Because Archive relies on Viewer, there is no additional configuration necessary on the
recorder itself.
94 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Chapter 4: Configuration
This chapter gives details of the steps to configure a Verint ContactStore for
Communication Manager system.
The main sections in this chapter are:
z Overview on page 96
z Accessing the System on page 97
z Licensing on page 99
z Security on page 103
z System Settings on page 105
z System Monitoring on page 113
z Port Allocation on page 114
z Search and Replay on page 136
z Backup/Restore on page 141
z Distributing User Instructions on page 145
Overview
You must now configure the recording suite to suit your requirements. This section guides
you through the various tasks in a logical order. You should follow its steps immediately
after installation of the Verint ContactStore for Communication Manager application.
96 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Accessing the System
URL
You administer the Verint ContactStore for Communication Manager system via a web
interface.
1. Open Internet Explorer and navigate to http://servername:8080 using the name
of the server you wish to administer.
2. Read the entire license agreement. If you choose to accept, click I Accept.
3. Enter a username of your choice and leave the password field blank.
4. Click OK.
Note:
Note: The login page uses Javascript. If you see the login page but nothing
happens when you click OK, your Internet Explorer settings may be blocking
this. See ActiveX Control Download on page 138 for detailed instructions on
this and other necessary settings.
Key Points
Before using the System Administration pages, familiarize yourself with the following key
points.
Invalid settings
Any of the system's settings that are known to be invalid are shown in red. Use the
information in this guide to change the settings to valid values. If you change a setting, but
submit an invalid entry, a message indicates the reason that the entry is rejected and you
are prompted to re-enter it. To quit without changing a parameter, click on the Close
Window link.
Page at a Time
If you have clicked the Show All link described above, you can return to seeing one page
of entries at a time by clicking this link.
Impact of changes
When you change a setting, the window into which you enter the new setting explains the
meaning of that setting and the consequences of changing it. Read these notes carefully.
Some settings require you to restart the recorder while others may truncate current
recordings.
98 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Licensing
Licensing
Until you enter a valid License Activation Key or select the Five day timed trial license, the
application will only show you the license entry screen.
Terminology
License Generation Key
This is a three digit number that is specific to a particular server. This is shown on the
license entry page. You will need it to obtain a valid License Activation key.
! Important:
Important: The 5-day license option uses serial number 800000. This temporary and
non-unique serial number is the only serial number that you can
subsequently override with the recorder's correct serial number, which is
included in the full license key.
100 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Licensing
! WARNING:
WARNING: If you reinstall the software, you must restore the database as described in
Restoring data to a new PostgreSQL database on page 142 before starting
recording. Otherwise the recorder will reuse recording identifiers that have
already been used.
Note the license generation key on the new server and request new activation keys as
outlined in Obtaining a License Activation Key on page 100.
! WARNING:
WARNING: If you reinstall the software, you must restore the database as described in
Restoring data to a new PostgreSQL database on page 142 before starting
recording. Otherwise the recorder will reuse recording identifiers that have
already been used.
102 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Security
Security
Security of recordings is very important and is discussed at length in System Security on
page 163. At this stage in the configuration of your system you should immediately create
appropriate user accounts as described below.
Note:
Note: If you have installed Viewer or a Central Replay Server then you should only
configure Administrator accounts on each recorder. Create and control end
user replay rights on the replay server.
Windows Authentication
If you enter a simple username without a domain qualifier (for example, admin rather than
mydomain\admin) then the account is administered by the recorder application.
Administrators may reset this account's password and the user may change their account
password and log off from the application using the administration web pages.
However, if you specify a windows domain and username, the system will attempt to
authenticate you via your normal Windows domain controller or WINS server(s). In this
case, you will not see Logoff or Change Password links on the web pages presented by
the recorder.
This feature is also known as "Single Sign On" (SSO) as users only have to log onto their
Windows workstation, but do not need to log on to the search and replay application
separately. See Windows Domain Authentication on page 165 for details of how to enable
this feature.
104 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
System Settings
System Settings
You should now configure how the system makes recordings and how it interfaces with
your Avaya Communication Manager. Follow the procedures below, clicking on the
appropriate link at the left of the Administration screen for each section.
Server
This is the section where you specify information about the recorder hardware and
environment.
Note:
Note: It is important that you review and change any of the settings that are not
correctly defaulted.
! WARNING:
WARNING: If you intend to install either a Central Replay or Viewer server and wish all
call recordings to be uploaded to it, set the appropriate address to a
temporary, dummy value before you start recording. Do this even if the
server is not yet ready. This way, all recordings' details will be queued ready
for upload when the server is available. The recorder will raise an alarm
daily until you install and correctly configure the server. Ignore this alarm.
106 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
System Settings
running. By default, the recorder will contact it on port 3020. If you need to override this
default, add a colon and the port number. For example: myeqbserver:3030.
SMTP Username
Leave this blank if your SMTP server allows unauthenticated sending. If it requires
authentication, set the username of the SMTP account here.
SMTP Password
Leave this blank if your SMTP server allows unauthenticated sending. If it requires
authentication, set the password of the SMTP account here. The password is masked
when entered in this field.
108 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
System Settings
z do not use the usual port of 161, but instead use 2161.
Communication Manager
This page lets you set details about the Avaya Communication Manager. The recorder
uses these settings to create softphones that it can use to record, replay and monitor calls.
The settings are described below in the order in which they appear on the screen.
AE Server Address(es)
The IP address of the Avaya Application Enablement Server on which the Device, Media
and Call Control (DMCC) API is running. If you want to specify backup servers, add a
semicolon before each subsequent address. If the first address in the list is unavailable,
the recorder attempts to establish a connection with the next server specified in the list.
DMCC Password
The password that the recorder should use to log in to the Device, Media AND Call Control
API.
Avaya CT Server(s)
Enter the IP address of the AE Server that is configured to provide TSAPI (Avaya CT)
services to the recorder. If you have one or more backup servers, you can specify further
addresses, separating them with a semi-colon. Names are attempted in order if the first
one fails.
Unassigned Capacity
This line shows how many ports are still available for allocation to a specific function before
using up your total licensed capacity. This value only refers to the recorder's own licenses.
110 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
System Settings
It does not indicate that the Communication Manager has a corresponding number of IP
softphone licenses installed.
Port Range(s)
Here you enter the ranges of stations that you configured earlier for the recorder to use.
Each port on the recorder corresponds to a station number on the Communication
Manager. Ideally, you should choose a single, contiguous range of station numbers.
However, you can choose multiple ranges.
To make subsequent administration as easy as possible, assign sufficient stations to
handle your entire licensed capacity, even if you do not intend to allocate all of these ports
immediately.
To add a port range
1. Click Add Port Range at the bottom left.
2. Enter a range of station numbers.
To edit a port range,
1. Click on the Edit link in the right-hand column.
2. Change lowest or highest port number or both.
To delete one or more port ranges:
1. Click the checkbox in the Select column for each station range you want to delete.
2. Click on the Delete selected port(s) link.
Note:
Note: You can only delete a port range if none of its stations is assigned to any of
the recording modes.
! Important:
Important: Set these port ranges up correctly before proceeding to the subsequent
pages on which you allocate these ports to the various recording and replay
tasks.
For a basic, small system, this is all that you need enter here. However, on larger systems
you may want to click on the Advanced link to set some or all of the following:
z Specify which of several servers should act as standby to a particular set of ports. Enter
the serial number of the server.
z Force the ports to register through a specific C-LAN(s) rather than allowing AES to
determine this automatically. Enter the IP address of the C-LAN they should use.
! Important:
Important: Since the C-LAN address is only used when registering a softphone on
startup, if you change the C-LAN address of a softphone that has already
successfully registered, it does not re-register to the new address until you
reset it, the recording service, or the server.
Once you have set any of these Advanced options, this setting will be shown on the list of
ports.
112 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
System Monitoring
System Monitoring
The status of your recording system is shown on several web pages beneath the Status
link on the Administration interface. Here you can see:
z overall status summary for the server and its interfaces to other components
z loading levels - both current and peak
z individual recording channel detail
Having just configured the recorder's main settings, you should now review the status and
address any problems highlighted on these pages or the Alarms page.
Alarms and events occurring within the system are stored in its local database. You can
view them via the Alarms link on the left of the Administration page. If this link is red, it
indicates that there are one or more uncleared alarms. As you address the cause of an
alarm, you should clear it by clicking the checkbox to the left of it and then clicking the
Clear Selected Event(s) link.
You should configure email alerting and/or SNMP monitoring of the system as described in
System Settings on page 105. The system will then be able to bring alarms to your
attention promptly.
Port Allocation
After initial setup, configuration of the recorder on a day-to-day basis largely consists of
changing what is being recorded and by which ports on the recorder.
Common Settings
The following settings are used on more than one port allocation page and have the same
meaning on each. This does not imply that all of these settings are applicable to ALL
modes.
Audio format
In most modes, you can specify whether the VoIP audio is sent to and from the recorder in
G.729A or in G.711. See Audio Format on page 41 for a discussion of compression
formats.
Ports Configured
This figure shows how many ports you have allocated to this recording mode - as detailed
in the table at the bottom of the page.
Unassigned Capacity
This shows how many more ports you could assign before using up the available channel
licenses on the recorder. (It does not indicate that the Communication Manager has a
corresponding number of IP softphone licenses installed.)
114 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Port Allocation
Recording owner
See Search and Replay Access Rights on page 136 for details of how a recording's
"owner" determines which user(s) can replay it. You can use this setting to override the
default ownership (station or agent number).
For example, if you are configuring a pool of ports for use by the human resources
department, you might find it more convenient to have all recordings made on them owned
by "hr" rather than several different station numbers, as would be the case if you left the
default ownership in place. You can then control access to all of these recordings by
assigning replay rights over "hr" to those users entitled to play them. You can enter an
alphanumeric string or a number. Leading zeroes, if entered, are significant and are
retained. All characters are stored in lowercase, so replay rights are applied case
insensitively.
! Important:
Important: Enter VDN numbers or skill hunt groups only. Not station or agent numbers.
When it appears at the top of an administration page, this rule applies to the recording
mode as a whole. It can be overridden for specific stations or ports using the Advanced
settings.
Assigning Ports
Links under "Port Allocations" let you assign these ports to any of the uses that are
appropriate given the server and channels licenses you have installed. You allocate these
ports to specific uses in two ways:
z Explicit Allocation - where you specify exactly which ports should be used. This
approach is used for all cases where users dial in to or conference in to the ports in
order to use them. An example is a pool of On Demand recording ports. The station
numbers assigned to this pool must match those you have placed in the hunt group that
you are going to tell your users they should dial for a recorder port.
z Automatic Allocation - where you specify what you want the ports to record or how
many ports are to be used. This approach is used for modes where users do not need to
dial into ports and hence it does not matter which ports the recorder selects for a given
task. An example is Station Bulk recording of a particular station. You tell the recorder
which station you want to record but don't care which of the recorder's stations is used
to service observe the "target" station so it can be recorded.
Read the text in the pop-up dialogs carefully to see whether you are being asked to specify
recorder ports or targets to be recorded.
Ranges
When assigning ports or specifying which stations or addresses are to be recorded, you
can enter single numbers or ranges of numbers. For example, entering "4000-4099" is
much easier to enter than 100 different numbers. Typically you need to enter some
contiguous ranges and some individual port numbers.
A set of recorder ports is referred to as a "pool" and is configured on the appropriate page
of the administration application by entering one or more port ranges. As you enter port
numbers, keep the following in mind:
116 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Port Allocation
Entering a range
Enter a range of ports as follows (station and address ranges are entered in the same
way):
1. Click the Add port range link. The Station Range dialog is displayed.
- To enter a single port, type the number in the top text box.
- To enter a range, type the number of the first port in the range into the top text box
and the final port in the range into the second text box.
2. Add a Comment (optional).
For pooled modes, you can use this field to name a range of ports and to note any hunt
group number that you assigned to these ports. The text you enter appears in status
reports and warning messages as labels for the specified range. For more information
about pooled modes, see Using pooled port modes on page 118.
3. To quit without entering the port numbers, click Close Window.
To enter the port numbers and keep the window open to specify additional port
numbers, click Enter and Stay Open.
To enter the port numbers and close the window, click Enter and Close.
Port ranges are checked for consistency with other ranges and with license conditions as
they are entered. If an entry is invalid, a message indicating the error is displayed; you can
change the information as necessary.
Editing ranges
You can either change or delete the ranges listed. You can change the following fields
without interrupting any recordings that might be active on the port(s) affected:
z Comment
z Prompt User in...
z Warning Level
z Recording Owner
z VDN recording rules
Some changes require that the softphone be reset and hence active recordings will be
truncated. These are:
z C-LAN address
z Standby Recorder Serial Number
z Any change to the number of ports in the range
z Any change to the port numbers in the range
z A change to the Codec
Deletion terminates any recording activity on a deleted port.
To edit a range:
1. Click the Edit link to the right of the range you want to alter.
2. Edit the range in the port entry form.
3. Click Enter.
Deleting ranges
Delete one or more ranges as follows:
1. Click the checkbox in the Select column for each range that you want to delete.
2. Click Delete selected port range(s).
Advanced settings
To implement advanced settings on a range of ports, stations or addresses:
1. Add or edit a range as above.
2. Click the Advanced link.
3. Enter data in the Advanced fields.
4. To quit without saving the settings, click Close Window.
To enter the port numbers and keep the window open to specify additional port
numbers, click Enter and Stay Open.
To enter the port numbers and close the window, click Enter and Close.
118 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Port Allocation
everyone else on another hunt group. You can track the status of these pools through the
Status pages. For each port range assigned to a mode, you can view activity for that port
range in the System Overview and Peak Activity pages.
On Demand Recording
This type of recording uses a pool of ports on the recorder that you can access via one or
more hunt groups.
Mode Setup
At the top of the page are the following settings:
z Apply Beep Tone within recorder
z Audio format
z Stop recording if the call drops to just one other party
z Ports Configured
z Unassigned Capacity
All of these are explained in Common Settings on page 114.
Ports
The table at the bottom of the page lets you assign specific recorder ports to this recording
mode. Refer to Assigning Ports on page 116.
In most cases, you will want to place each of these ports in a hunt group and make your
users aware of this hunt group number and/or set up a key on their phones to access it.
Advanced Settings
Click on the Advanced link when entering or editing a port range to set:
z Standby Recorder Serial Number
z Free port count warning level
z Recording owner
All of these are described under Common Settings on page 114.
Audix
To allow a user easy access to On Demand Recording from a station, combine On
Demand Recording with the "One-Step Recording via Audix" Communication Manager
feature. To do this, enter the hunt group used for some On Demand ports as the parameter
for the Audix-rec feature button you assign to the user's station.
When using the Audix-rec feature, keep in mind:
z Recording beep tone can only be applied by the Communication Manager, not by the
recorder
z The user pressing the button will not hear the beep tone.
z Calls recorded using this feature are only indexed with the party that pressed the button,
not the other party on the call.
For more information, refer to the One-Step Recording via Audix topic, Feature Related
System Parameters Section, in Chapter 19: Screen Reference of the Administrator Guide
for Avaya Communication Manager.
Meeting Recording
This type of recording uses a pool of ports on the recorder that you can access via one or
more hunt groups.
Mode Setup
At the top of the page are the following settings:
z Apply Beep Tone within recorder
z Stop recording if the call drops to just one other party
z Ports Configured
z Unassigned Capacity
All of these are explained in Common Settings on page 114.
Note that all Meeting recordings are performed in G.711 to make the production of custom
voice prompts simpler.
Ports
The table at the bottom of the page lets you assign specific recorder ports to this recording
mode. Refer to Assigning Ports on page 116.
In most cases, you will want to place each of these ports in a hunt group and make your
users aware of this hunt group number and/or set up a key on their phones to access it.
120 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Port Allocation
Tip:
Tip: On Meeting Recording ports, a user can enter a list of owners manually
using the dial pad .
All of the above are described under Common Settings on page 114.
z Prompt users in - Sets the language for spoken prompts. If using multiple languages,
you should configure a hunt group to correspond with each range of ports that uses a
different language.
Custom Prompts
If the language you require is not offered, select Customer defined prompts and provide
your own set of prompts. These files are located in /wav beneath the folder into which you
installed the recorder and are called:
z welcome_custom.wav
z owners_custom.wav
z recording_custom.wav
z help_custom.wav
You can replace these four files with your own recordings. Listen to the corresponding file
in a language you understand (for example, welcome_english.wav) and record the
equivalent messages in your own language.
! WARNING:
WARNING: You MUST use the same G.711 µ-law encoding that the supplied files use.
Mode Setup
At the top of the page are the following settings, most of which are are explained in
Common Settings on page 114:
Stations
The table at the bottom of the page lets you specify which stations are to be recorded. The
system determines which ports will do the recording. It does this to minimize the impact of
changes, leaving previously assigned ports untouched if possible to allow updates to
configurations to be done during business hours rather than having to wait for close of
business.
! Important:
Important: As the recorder picks the ports to use for this mode you must be careful
when YOU choose to assign ports to the other modes. Use the Status >
Port Details page to check if the ports you are about to assign are in use for
this mode before doing so. You can still assign them to the other mode but
any recording in progress will be truncated before being re-established on
another port.
For complete instructions on adding, editing and deleting stations, refer to the earlier
section "Port(s) and station(s)."
122 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Port Allocation
! WARNING:
WARNING: Do NOT enter Agent, Skill hunt group or VDN numbers. You can only record
STATIONS with this recording mode.
Mode Setup
At the top of the page are the following settings, most of which are are explained in
Common Settings on page 114:
z Apply Beep Tone within recorder - note that a third option is available in addition to
the normal Yes and No. You can choose to have beep tone start only once the user has
entered the retain command.
z Audio format
z Retain Recording by entering - You can specify a digit string that the user can dial to
retain the recording of the current call segment. Normally, the recording is deleted by
default as soon as the user ends the call segment, but entering the Retain digit string
during the course of the call instructs the recorder to retain the recording. If you enable
this option, ensure that you inform the users of the selected string. When choosing the
string for this command, consider the following:
- A very short string, such as *, can be entered by accident.
- A longer string is more difficult to remember and enter.
- You can use letters instead of numbers. For example, **R is actually **7 but R for
retain is easier to remember.
z Ports Configured
z Unassigned Capacity
Stations
The table at the bottom of the page lets you specify which stations are to be recorded. The
system determines which ports will do the recording. It does this to minimize the impact of
changes, leaving previously assigned ports untouched if possible to allow updates to
configurations to be done during business hours rather than having to wait for close of
business.
! Important:
Important: As the recorder picks the ports to use for this mode you must be careful
when YOU choose to assign ports to the other modes. Use the Status >
Port Details page to check if the ports you are about to assign are in use for
this mode before doing so. You can still assign them to the other mode but
any recording in progress will be truncated before being re-established on
another port.
For complete instructions on adding, editing and deleting stations, refer to the earlier
section "Port(s) and station(s)."
! WARNING:
WARNING: Do NOT enter Agent, Skill hunt group or VDN numbers. You can only record
STATIONS with this recording mode.
124 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Port Allocation
Where
z NN is a number of minutes from the end of the call within which the user can call the
"retain" number to retain the call
z NNNNN is the station number of an otherwise unallocated port on the recorder that will
be dedicated to receiving Retain commands after hang up.
If you set these properties, call segments recorded in Station Executive mode are not
deleted until the time specified has elapsed after the end of that recording segment. A
retain command entered during or after the recording ends (within the specified period) will
preserve the calls. When determining an appropriate value for this delay, consider the
following:
z You want to maximize the chance of retaining all segments of a call that the Station
Executive user chooses to Retain, but
z You should minimize the time in which unwanted or unauthorized recordings are
available for replay.
The Retain command applies only to the most recent call on a station. So, if a call is
placed on hold and a consultation call is made, this consultation call is now the most
recent.
Calling the retain number when the previous call is still on hold results in the consultation
call being retained. However, if the user resumes the held call, hangs up, then dials the
retain number, the original (and final) call is retained. In this case, the segment before the
call was placed on hold is retained, as long as it ended less than NN minutes before the
retain command was given.
Conferenced Recording
This type of recording uses single-step conferencing to record calls.
It offers a flexible alternative to Station Bulk and Unify/External control for rules-based
recording. Instead of relying solely on DMCC, this mode uses the more powerful CTI
capabilities of TSAPI (also known as Avaya CT), an extra cost option, to track call activity
and control recording.
The recorder does not dedicate a softphone to each recording target. Nor does it suffer
from some of the limitations noted with respect to recordings made via the service observe
feature of Communication Manager.
Recording is triggered by rules that can be applied to four types of "target" addresses:
z Stations
z Agent IDs
z Skill hunt groups
z VDNs
! Important:
Important: There are a number of prerequisites (including additional Avaya licenses)
and settings that are required for this recording mode.
! Important:
Important: If you are using a Security Database as part of your Avaya CT setup, you
must ensure that the recorder is granted access to all the addresses
(stations, VDNs and skill hunt groups) that it will need to observe.
Mode Setup
At the top of the page are the following settings. Those that are simply listed here are
explained in Common Settings on page 114. The other settings are unique to Conferenced
mode. You must set ALL of these parameters in accordance with the instructions below
before you specify which addresses are to be recorded.
z Apply Beep Tone within recorder
! Important:
Important: Setting this to Yes means that every Conferenced recording will use an extra
timeslot on the port network handling the call.
z Audio format
z VDN(s) to Observe - If you want the recorder to tag and/or control according to the
VDN(s) through which a call is routed, you must enter all of the VDNs in use here.
Separate VDNs with a semi-colon. You can enter ranges of VDNs - but only if all values
within the range are valid VDNs.
Tip:
Tip: If you have ranges of VDNs within which some numbers are not used,
consider creating these as VDNs to allow you to enter the whole range here.
The next two settings operate as described in Common Settings on page 114 but note that
these are secondary tests on a call. Calls must match an address shown at the bottom of
the screen before they are even considered for recording. These tests are then applied to
filter the calls further. These settings should only be used if your main recording rules (at
the bottom of the screen) target stations or agents.
z Record calls that do NOT have a VDN number?
z Filter calls by VDN and/or Skill?
z Test VDN filter against which VDN? - A call may be routed through several VDNs. If
you have specified a rule in the previous setting, you can use this setting to tell the
system whether your rule refers to the first, last or any VDN that the call has gone
through. The default is to use the first VDN. Note that the recorder will only be aware of
VDNs that you listed above. You therefore have considerable flexibility should you wish
to ignore specific VDNs.
126 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Port Allocation
z Tag calls with which VDN? - Each recording can only be tagged with a single VDN.
You can choose whether this is the first or last VDN that a call went through. As with the
previous setting, "first" and "last" are "as far as the recorder is aware" i.e. restricted to
those VDNs you tell it to observe.
z Maximum Concurrent Recordings (on this recorder) - determines how many of this
recorder's ports are assigned to this recording mode. If this recorder is controlling other
Slave recorders, their ports will be in addition to this count.
z Agent Skill Group(s) to Observe - Avaya CT does not let the recorder observe
AgentIDs directly. If you wish to record calls based on AgentID - or even to tag
recordings with Agent Ids and names, you MUST configure this setting. Enter enough
skill groups to ensure that each agent you wish to record is in at least one of these
groups. Separate skill groups with a semi-colon. You can enter ranges of skills - but only
if all values within the range are valid skill hunt groups.
Tip:
Tip: Consider creating one dummy skill hunt group and assign all agents to this
skill. You then need only enter that one skill hunt group here. This also
minimizes the number of Avaya CT licenses you need.
z Ports Configured - this should match the Maximum Concurrent Recordings figure that
you have specified. If it does not, you should provide more recorder ports.
z Unassigned Capacity
Addresses
The table at the bottom of the page lets you specify which addresses are to be recorded.
These addresses can be station numbers, agent logon ids, skill hunt groups or VDN
numbers.
! WARNING:
WARNING: Using a mixture of different address types can give confusing results. You
should normally choose which type of address you are going to use and not
use the other three. The exception to this is if you can clearly partition your
traffic so that there is no chance of multiple rules firing for a single call.
You can target single addresses or ranges. For example, if your 45 agent identifiers are all
in the range of 7400 to 7450, you can use the range 7400-7450, even though not all these
numbers have been assigned. Use this feature sparingly though as it will take longer for
the recorder to start and recover from outages if it has to try many more addresses than
are strictly necessary.
! Important:
Important: If you are targeting Agent logon IDs, the recorder notes which of these have
been identified as valid agents and does not attempt to observe them
directly. Instead, it waits to hear that they have been logged on. Should you
ever change your numbering plan so that numbers previously used for
Agent Logon IDs are now used as station numbers, you must restart the
recorder if you wish to record these stations.
The system automatically determines which ports will do the recording. It does this to
minimize the impact of changes, leaving previously assigned ports untouched if possible to
allow updates to configurations to be done during business hours rather than having to
wait for close of business.
! Important:
Important: As the recorder picks the ports to use for this mode you must be careful
when YOU choose to assign ports to the other modes. Use the Status >
Port Details page to check if the ports you are about to assign are in use for
this mode before doing so. You can still assign them to the other mode but
any recording in progress will be truncated before being re-established on
another port.
You can enter more addresses than you have assigned ports to this mode. The number of
ports assigned is controlled by the Maximum Concurrent Recordings (on this recorder)
setting above - not by the number of entries in this table.
For complete instructions on adding, editing and deleting addresses refer to the earlier
section "Port(s) and station(s)."
Advanced Settings
Click on the Advanced link when entering or editing an address range to set the following
options. Where these are simply listed below, full details can be found under Common
Settings on page 114. Those settings that are specific to this mode are described in full.
z Standby Recorder Serial Number
z Recording owner
z Record calls that do NOT have a VDN number?
z Filter calls by VDN and/or Skill?
The above two settings should only be used where the address range you are applying
them to is an agent or station range.
z Trigger recording on alert - If this box is ticked, a call will be recorded if it alerted the
specified address - even if it was never actually connected to this address. If the box is
cleared, calls are only recorded if they actually connected to the specified address.
128 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Port Allocation
Note:
Note: As calls are never actually connected to VDNs or Skill Hunt Groups (they
alert on them but are connected to a station or agent) you must leave this
box checked when specifying VDN or Skill Hunt Group address ranges.
z Continue recording to end of call - If checked, a call will be recorded until the call
ends. If cleared, the recording will stop once the address that triggered recording is no
longer connected to the call. For example, if the recorder is only configured to record
calls made by Agent 1234, then if this box is cleared, the recording will end if Agent
1234 transfers the call to another agent. If the box is checked, recording will continue.
As with the previous setting this must be checked if the address range specifies VDN or
Skill Hunt Groups.
! Important:
Important: These last two settings can cause the recorder to make more concurrent
recordings than you originally planned. As calls are diverted to or transferred
off to other stations, those you have targeted in this mode can take other
calls while those calls are still being recorded.
! CAUTION:
CAUTION: This setting cannot be used if any other application is using the Avaya "Take
Control" feature to control these calls. In order to maintain a CTI observer on
a call after it has left the originally observed address, the recorder implicitly
performs this "Take Control" function itself and only one application can do
so. Note that this effectively blocks the use of recording by VDN or Skill Hunt
Group if another application is controlling call routing. In this case, you must
specify station or agent ids as recording targets and uncheck this option.
Master/Slave Configurations
Because this recording mode can target skill hunt groups, agent ids and VDNs, it is not
easy to partition a large site into several independent recorders (as you can with Station
Bulk recording, for example).
If you need to record more channels than a single server can handle, you can configure
Conferenced recording on one (the Master) and provide one or more Slave recorders to
provide the required number of concurrent recording channels.
To configure a system in this way:
1. Configure the Conferenced recording mode on the Master as normal but specify 0
Concurrent Recording Channels (on this recorder).
2. On each Slave recorder, allocate all ports to On Demand mode and specify port 1416
on the Master recorder as the external controller.
3. On each Slave recorder, add the following line to their properties file:
ondemand.ocpneeded=false
If using a Standby recorder (recommended to avoid the Master becoming a single point of
failure in a large system),
1. Configure the standby as you would normally, specifying the Master recorder as the
primary recorder it should shadow.
2. On each Slave recorder, add the standby's IP address (again port 1416) to the list of
external controllers.
Mode Setup
At the top of the page are the following settings. Those that are simply listed here are
explained in Common Settings on page 114. The other settings are unique to this mode.
z Apply Beep Tone within recorder
z Audio format
! Important:
Important: If you want to use these quality ports to record stations that are also being
recorded in other service observe based modes, you must use the same
codec as these other modes.
z URL(s) of Quality server(s) to connect to - Specify the IP node name of the Quality
server. The port number will default to 1415. If the recorder is supporting multiple
servers, list their names separated by semi-colons.
z Username/Password for file-share on Quality server - Recordings made under the
control of this Quality application are only held temporarily in the recorder's bulk
recording call storage area. As each call completes it is copied onto a location
maintained by the Quality application. If you have configured eQuality Balance to store
recordings in a file-share, you must enter a username and password here so that the
recorder can write recordings to and read recordings from the file-share on the quality
server..
Note:
Note: When you use more than one Quality server, you must use the same
username and password on each one's fileshare.
z Ports Configured
z Unassigned Capacity
130 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Port Allocation
Ports
The table at the bottom of the page lets you assign specific recorder ports to this recording
mode. Refer to Assigning Ports on page 116.
For this mode, you typically add a single range of ports - large enough for the total number
of recording and replay ports. The split between recording and replay is set up on the
Quality Server not the recorder.
Advanced Settings
Click on the Advanced link when entering or editing a port range to set:
z Standby Recorder Serial Number
This is described under Common Settings on page 114.
Mode Setup
At the top of the page are the following settings. Those that are simply listed here are
explained in Common Settings on page 114. The other settings are unique to this mode.
Note:
Note: There are several additional properties file settings that can be used to
modify how the recorder controls these ports.
z Apply Beep Tone within recorder
z Audio format
z Record Calls Using - Use this option to specify how the recorder interacts with the
external controller(s).
- If you select Service Observe, this mode is configured and acts like Station Bulk
recording. You specify the set of stations to be recorded; the recorder will service
observe each of them. According to a properties file setting, the recorder either
starts and stops recordings or waits for the external controller to tell it to start and
stop.
- If you select Single-step Conference, Unify or the external server must determine
what to record - either by establishing a single-step conference with a recorder port
or asking the recorder to do so for it. In this case, the external server must provide
most of the call information.
! Important:
Important: If you change this setting you must restart the recorder.
The next two settings are only used if Service Observe is selected above - in which case
they act in the same way as defined for Station Bulk Recording on page 121.
z Record calls that do NOT have a VDN number?
z Filter calls by VDN and/or Skill Hunt Group
z Ports Configured
z Unassigned Capacity
Ports or Stations
If you have selected Record calls using Single-step Conference, the table at the bottom
of the page lets you assign specific recorder ports to this recording mode. Refer to
Assigning Ports on page 116. You would normally assign a single range of ports in this
mode.
If you have selected Service Observe, this table lets you specify the stations to be
recorded - as described for Station Bulk Recording on page 121.
Advanced Settings
If you have selected Record calls using Single-step Conference, click on the Advanced
link when entering or editing a port range to set:
z Standby Recorder Serial Number
z Free port count warning level
z Recording owner
If you have selected Record calls using Service Observe, click on the Advanced link
when entering or editing a station range to set:
z Standby Recorder Serial Number
z Recording owner.
z Record calls that do NOT have a VDN number?
z Filter calls by VDN and/or Skill Hunt Group?
132 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Port Allocation
Mode Setup
This mode requires no manual settings. The top of the page simply shows:
z Ports Configured
z Unassigned Capacity
These are explained in Common Settings on page 114.
Ports
The table at the bottom of the page lets you assign specific recorder ports to this recording
mode. Refer to Assigning Ports on page 116.
For this mode, you typically add a single range of ports - enough to handle the maximum
concurrent number of replay users the recorder is to support.
! Important:
Important: Replay ports impose a significant load on the recorder. Be sure that you
have specified a powerful enough server.
Advanced settings
Click on the Advanced link when entering or editing a port range to set:
z Standby Recorder Serial Number
z Free port count warning level
These are described under Common Settings on page 114.
Mode Setup
At the top of the page are the following settings:
z Audio format
Note:
Note: This must match the format used to record the stations you wish to live
monitor.
z Ports Configured
z Unassigned Capacity
All of these are explained in Common Settings on page 114.
Ports
The table at the bottom of the page lets you assign specific recorder ports to this recording
mode. Refer to Assigning Ports on page 116
For this mode, you typically add a single range of ports - enough to handle the maximum
concurrent number of live monitor users the recorder is to support.
Advanced settings
Click on the Advanced link when entering or editing a port range to set:
z Standby Recorder Serial Number
z Free port count warning level
These are described under Common Settings on page 114.
134 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Port Allocation
Hunt Groups
You might want to configure a hunt group on the switch to include all of these live monitor
ports; this configuration makes them accessible through the single hunt group number on a
"first come, first served" basis.
136 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Search and Replay
Note:
Note: Conferenced Recording is slightly unusual. Where an agent is logged in, the
recording will be "owned" by the station the call was taken on AND the agent
who was logged on.
Meeting Recording however, does not follow the above rules. In this mode, the voice
prompts advise the caller to enter one or more owners.
Tip:
Tip: Use dummy station identifiers to allocate owners to calls made in Meeting
Recording mode. All members of a particular team can be configured with
replay rights for a particular number, even though this is not a valid station
number. When prompted at the start of the call, mark meetings recorded for
and by a team with this "owner" so that all members of the team can access
the recording.
You control which recordings your users can search for and replay by adding a user
account for each person that needs to use the Replay page and specifying which range(s)
of owner they are entitled to see.
To add a user account, follow the same procedure that you used in Securing the
System on page 103 but do not check the User is an Administrator box.
In order to search for and replay a call, the user's replay rights must include at least one
owner of that call. Each user's rights are shown on the Security > Users page and are set
when adding the user account. You can change these by clicking on the Edit link next to
them.
The initial administrator's account is automatically given access rights to all number ranges
up to 10 digits. As you add other users you must specify which ranges of owners each user
is entitled to replay. The number of digits is significant. A user with replay rights over
0000-9999 cannot replay calls made by and "owned by" agent 567 though they could play
calls owned by agent 0567. In this example, you might grant the user replay rights over
0000-9999, 000-999.
Each user account is automatically entitled to replay any calls where the owner field is the
same as their user name. This makes it easy to assign each station to the person who
uses it by setting their username on the Advanced tab of the Port Allocation > Station
Bulk entry for that station.
Typical examples of how to use replay rights are:
z A user allowed to play calls made on his own station (1234) would be given replay rights
1234.
z An Agent who logs on as AgentID 5012 and is allowed to replay his own calls may be
given replay rights 5012.
z A supervisor who logs on as AgentID 5050 and manages AgentIDs 5010-5019 and
5025-5028 may be given replay rights 5050,5010-5019,5025-5028.
z All recorded stations used by the HR staff have their Recording Owner set to HR on
the Advanced settings. The Human Resources Manager, who uses station 5678 may be
given replay rights HR, 5678
138 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Search and Replay
Before you advise end users of the URL of the recorder, you should make sure that your
users can access the Replay page through your network and that the ActiveX controls
download successfully. To test this:
1. Create a non-administrator account and assign it some replay rights
2. From a typical client machine, enter the URL for the recorder in the form:
http://myservername:8080/ (using the recorder's IP address or hostname -
assuming you have entered it in your DNS server). If using https, replace 8080 with
8443.
3. When prompted, enter the account's Username and a blank Password.
4. Set a new password as directed.
5. Confirm that the Replay page displays correctly and that the ActiveX control is
downloaded.
Tip:
Tip: You may wish to copy steps 2 to 4 above, fill in your URL and send them out
as instructions to your end users.
140 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Backup/Restore
Backup/Restore
Due to the huge volume of new files created every day, a voice recorder is not backed up
in the same way as most application servers. This section guides you through the issues
around backing up the application, the call details database and the recordings.
Application
The recorder's configuration is stored in its database (using PostgreSQL), alongside the
details of the call recordings. To preserve the configuration of the server, back up the
database frequently as described below.
If you have not installed other applications on the server, there is no need to backup the
operating system or the recorder software. It is faster to reinstall these server components
in the event of disk failure. You should therefore retain the installation media and license
key that you used.
z using a smaller number makes the backup faster and uses fewer resources. However, it
results in a larger backup file.
142 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Backup/Restore
DVD+RW archive
This simplest and cheapest strategy is to use the built in DVD+RW archive mechanism.
This is not only fully integrated with the workings of the recorder and its search and replay
mechanism, but also is well suited to the incremental recording required for a recorder. As
recordings are added to the calls path they are copied to DVD in an efficient manner. Even
when they have been deleted from the hard disk, the recorder is still able to play them
because it knows which DVD they are on and can replay directly from DVD, without an
intervening 'restoration' step. Each DVD holds about 4GB, which means it can hold about
150 channel-days worth of recordings from a busy system. For less than a dollar a day,
even a busy system can have limitless backup.
Archive Server
The second most effective strategy is to implement the Archive system. This is a
rules-based system. It copies audio files from the Verint ContactStore for Communication
Manager onto different, centralized disks. The data on these centralized disks is
z organized in a more permanent way
144 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Distributing User Instructions
146 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Configuring Avaya Support Remote Access
148 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Chapter 5: Operations, Administration &
Maintenance
This chapter provides details of regular maintenance required for a Verint ContactStore for
Communication Manager system.
The main sections in this chapter are:
z Introduction on page 150
z Status Monitoring on page 151
z Local Archive on page 158
z Preventative Maintenance on page 160
Introduction
In addition to initial configuration, there are a number of tasks that need to be performed on
an ongoing basis. This section discusses
z the use of the Status monitoring pages
z the Audit Trail
z preventative maintenance tasks that should be carried out on a regular basis
150 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Status Monitoring
Status Monitoring
Status is shown over five pages that are accessed under the Status heading at the bottom
left of the Administration web interface. These show the current:
z Alarms and Events
z System Overview - links to other components, local archive and storage
z Port States - the state of each recording channel on this recorder.
z Peak Activity - the peak concurrent load on the recorder (and, if it is the Master, on any
Slaves it is controlling)
z Audit trail of all significant configuration and usage events.
System Overview
This page shows summary information about the current state of the recorder and should
be checked at least daily.
Overall Status
The title of this page includes the words:
z ACTIVE if the recorder is actively recording. During startup and when another recorder
has taken over (e.g. a standby) this will not be present.
z *** NOT VIABLE *** if the recorder has identified one or more problems that prevent it
from recording (e.g. disk full, cannot connect to DMCC etc.)
Links
This shows the status of each link that the recorder has with other components in the
network. These include, DMCC, Avaya CT, Viewer, eQuality Balance (V5 or V7), Standby,
Slave and Central Replay servers, The status of all these links should be UP.
See Recorder Interfaces on page 199 for a comprehensive list of interfaces.
152 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Status Monitoring
Faulty
These ports are incorrectly configured or have experienced an error. They will be
reregistered two seconds after the initial problem, in an attempt to recover them. If the
problem persists, they will back-off, doubling the time between retries until this reaches 1
minute. They attempt to reregister every minute thereafter.
Starting
These ports are registering or queuing to register with the Device, Media AND Call Control
API.
Idle
These ports have registered successfully, but are on-hook and not in use.
Setup
These ports are off-hook and are:
z Attempting to establish a Service Observe session
z Placing or answering a call
z Receiving instructions from the caller, for example, with Meeting Recording or Live
Monitor
! Important:
Important: A port used for Station Bulk or Station Executive Recording that stays in the
Setup state indicates that Service Observe cannot be established on the
target station. The station might not be configured to allow Service Observe
or another station might already be observing it. Recording is not possible in
either case.
Connected
These ports are in one of the following states:
z Have established a service observe connection but the port being observed is idle
z Are replay ports that have placed a call but are not currently playing a file
154 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Status Monitoring
Active
These ports are:
z Recording ports that are recording a call
z Replay ports that are actively playing a file
z Live Monitor ports that are connected to a station
Port States
The Port States page shows the current state and configuration of each channel on the
recorder:
z The station number of the softphone port on the recorder
z Its recording mode
z the external controller (if any) that is controlling the port
z whether or not a media (audio) stream is flowing to and from the port
z whether or not recording is enabled on this port
z the state of the channel (see Port Usage Summary on page 154 for an explanation of
channel states)
z which station it is recording
To reset an individual port, select the Reset link to the right of the port. This action stops
any current recording on that port.
To force a reset on all ports in quick succession, select the Reset All link at the upper left.
The Recorded Station column for ports in On Demand and Meeting modes shows the
port number that invoked the On Demand Recording and the owner of the Meeting
Recording. (It shows the first one entered if multiple owners were specified at the start of
the Meeting Recording.) Conferenced mode ports show multiple addresses if more than
one address rule has triggered a combined recording.
To update the page, click the Refresh link.
Peak Activity
This page shows the peak loading levels of the recorder. For each recording mode
configured, it shows
z how many channels have been allocated
z the maximum number that have been active concurrently since midnight
z the maximum number that have been active concurrently since the date and time shown
above the right-hand column
To reset the monitoring period, select the Restart Peak Activity Counts link. For example,
if your business has a weekly cycle, you may want to reset the monitoring period at the
start of each week. Use this page to predict when to expand your recording capacity.
For more detail of contention and "busy" events on the hunt groups associated with the
pooled recording modes, use the Communication Manager's call detail recording tools.
These tools might be useful if, for example, you are required to provide 98% availability of
Meeting Recording ports.
Audit Trail
The Status > Audit Trail page shows administrator and user actions over a specific
period. The default reporting period is the current day. You can also filter this report
according to Event Type and Username. To generate a report for a different period, enter
the date range in the calendar controls, and click the Refresh link.
The Audit Trail functions track the following user actions:
z Successful user logins
z Failed user logins
z Password changes (although, for security reasons, the actual password is not stored)
z End user searches on the database
z Replay requests
z Live Monitor requests
It also tracks all administrator actions that affect recording, such as configuration changes ,
manual port resets and creation or deletion of user accounts.
Note:
Note: Editing a station range is logged as a deletion followed by an addition.
The Detail column includes the SQL statement used in searching for calls. It also uses the
internal name of a setting rather than the user-friendly, localized name. This avoids any
change of meaning that could occur in internationalization.
Each report is restricted to a maximum of 1000 audit records. To report on more, break
your reporting period into a number of smaller date ranges.
Use your browser's print, save, or email features to provide a permanent record of the
details. To create a summary that presents all results on a single page, click the Show All
link at the top. The Show All and Page at a Time links are not shown if the list of audit
entries is less than one page long.
156 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Status Monitoring
Configuration records (which include the audit trail) are retained for 13 months. Each night
after that period has elapsed, a background job deletes any records older than 13 months.
If you want to retain the records longer, back up the database as described in Backing up
the Database on page 141. You can change this default value of 13 months using the
audit.purgemonths property as described in Properties File on page 174.
Local Archive
This section explains how to use a local DVD+RW drive to archive recordings,
The recorder writes both the audio (WAV) and call detail (XML) files to DVD in batches as
calls are recorded. Recording files are copied to the DVD disk when one of the following
occurs:
z 14 hours of recordings have been made (equivalent to 100MB when recording in G.726
or 50MB in G.729A mode)
z 24 hours have passed since the last write to DVD
The administration screens have an option to backup the calls details database to the end
of the DVD. You should consider changing the DVD before it is completely full to leave
space for the database backup.
Loading a disk
To load a new disk:
1. Insert a blank DVD+RW disk in the drive.
2. Wait for it to spin up and be recognized.
! Important:
Important: Do not close the rack door as the tray will eject and automatically re-insert
during the load process.
3. In the recorder Administration application, click on the System Overview link to
confirm that the recorder has recognized the disk.
158 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Local Archive
The Current DVD media field shows that the disk has been recognized and is being
written to; it also shows the volume label given to the new disk. The Free Space on
current DVD media line should show 4GB or more available on a clean disk.
Changing disks
The System Overview page shows when the disk is full and an alarm is raised.
To eject a disk that is still being recorded in order to retrieve calls from another disk,
1. Click on the Eject link on the System Overview page.
2. Insert the required archive disk.
3. When you have finished retrieving calls, replace the partially full disk so recording can
continue.
! Important:
Important: The archival process never writes to disks out of sequence. For example, if
you eject a partially full disk, then insert a blank disk onto which the next set
of calls is then written, you cannot then reinsert the previous disk.
Tip:
Tip: If you have enough disk space left when you change from a nearly full disk
to a new disk, you can automatically backup the database to the end of the
disk using the Backup database and Eject link
Labeling a disk
As you eject each disk, label the disk itself using an approved indelible marker. Your label
should indicate:
z The identifier of the recorder producing the disk. The identifier is Calls by default; you
can change this value on the System Settings > Server page of the System
Administration application.
z The sequential serial number of the disk.
z The date/time the disk became full.
Preventative Maintenance
This section highlights a number of administrative tasks that should be performed on a
regular basis to ensure the system continues to operate smoothly.
Daily
Unless you have fully automated alerting of these conditions, you should carry out the
following procedures at the start of each day:
Alarms
Check the Alarms page for new problems.
Disk capacity
Check the available disk space. The disk where recordings are stored will appear to be at
or near capacity. However, the system consistently maintains a level of 1 GB of free space
by deleting older files. This maximizes the number of recordings that are available online to
you. The Verint ContactStore for Communication Manager's disk manager thread deletes
files on a FIFO (First In First Out) basis. Check the contents of the log files as described in
Troubleshooting on page 205 and examine any errors logged since the previous check.
Look at all error and warning messages, not just those generated by the Verint
ContactStore for Communication Manager services.
System Status
It is difficult to detect some problems automatically. Check the system status regularly via
the Status > System Overview page and verify that all figures are in line with expectations
as described in System Overview on page 152.
160 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Preventative Maintenance
z Use the Replay page to select the most recent calls to verify that calls are accessible.
z Confirm that the start time of these calls matches expectations. Verify that the start time
corresponds to the most recent calls made on the extensions being recorded.
z Confirm that these calls are playable and that audio quality is good.
Archive
If using DVD+RW archive, check the current disk's available capacity. Change the disk
when it fills.
Weekly
As you become comfortable with the normal operation of your recorder, you can reduce the
frequency of the daily tasks. For example, if you know that the rate at which your disk is
filling is not going to fill the available space for several months, you can check it weekly.
Perform the following tasks each week:
! Important:
Important: When you are purging files, remember that files you delete go to the
Recycle Bin and that the space they occupy is not freed until you empty it.
large the database will get by the time old records begin to be purged. Many customers
plan never to purge call detail records, but choose instead to add disk capacity every year
or two as the database grows. If you do this, you should upgrade your server every few
years to compensate for the increasing size of the database and the reduction in search
and update speed.
Configuration Backup
Changes to system configuration that affect user access rights are stored in the
PostgreSQL database. This means that the system configuration is backed up whenever
the call detail records are. See Backing up the Database on page 141.
Monthly
Check the following aspects of the system on a monthly basis:
Loading trends
Note the total call volumes recorded every month to be aware of gradually increasing traffic
trends. To do this:
z Note the number of calls recorded at the end of each month and compare with previous
month's accumulated total.
z Note the age of the oldest call on the disk (only applicable once the disk has filled for the
first time)
z Note the CPU load during busy hour
If it appears that the load is increasing, consider purchasing extra licenses if required
and/or increasing server specification or disk space.
162 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Chapter 6: System Security
Security of customer recordings is very important. This Chapter discusses the various
features - some optional - that you can use to ensure the safety and integrity of recordings.
This chapter assumes that you have suitable firewall, antivirus software and physical
access procedures in place.
The mains sections in this chapter are:
z Use of SSL on page 164
z Windows Domain Authentication on page 165
z Blocking Replay from the Recorder on page 166
z Changing Passwords on page 167
z Encrypted File Storage on page 169
z PCI Compliance on page 170
Use of SSL
You should consider whether you wish to enforce the use of Secure Sockets Layer (SSL).
By default, users can access the recorder via http (on port 8080) or by encrypted https (on
port 8443). You can force users to use the secure https port, by setting Allow
unencrypted (http) access? to No on the Security > Users administration page. When
you do this, any user who attempts to access the recorder through the unsecured (http)
route is automatically redirected to the secure (https) address.
! WARNING:
WARNING: You should not force the use of https if you use Central Replay Server or
Telephone Replay.
The application is distributed with an SSL certificate that is valid for 3 years from the date it
was issued. The certificate makes it possible to give users secure access to the server.
When users access it through this secure https port, the traffic between their browser and
the recorder is automatically encrypted.
However, Internet Explorer will warn your users that the name on the certificate does not
match the name of the server using it. You can either advise your users that this is
acceptable and should be ignored or, for greater security, you may acquire and install your
own SSL certificate as explained in Installing a Signed SSL Certificate on page 303.
164 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Windows Domain Authentication
Tip:
Tip: If users are prompted for their domain passwords when they access the web
interface, make sure that the recorder is either part of the intranet zone, or
make it a trusted site and configure Internet Explorer to automatically log on
to trusted sites.
166 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Changing Passwords
Changing Passwords
The recorder and related applications use a number of user account settings that are
installed with a hard-coded default. You can change these as follows:
168 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Encrypted File Storage
PCI Compliance
To make your system compliant with PCI recommendations, you should adopt all of the
above features. In addition:
1. Do not store sensitive data in the User Defined Fields of recordings.
2. Use the PAUSE and RESUME recorder control features to avoid recording sensitive
information. This will require integration with your other systems.
3. Do not reduce the default 13 months for which audit records are kept.
4. Use encrypted audio to and from Avaya Communication Manager (setting on System
Settings > Communication Manager page).
5. Force users to use Viewer rather than replaying calls from the recorder.
6. If using Quality recording, use Version 7.8 or higher. Version 5.x does not support
encryption.
7. Ensure all other components of your system (Viewer, Archive etc.) are configured in
accordance with the Enterprise Security Administration Guide.
8. PCI dictates a session timeout of 15 minutes. When using Windows Domain
Authentication (as required to meet other PCI requirements) the recorder will accept a
valid Windows logon (on an appropriate account) as sufficient to gain access to the
recorder's administration pages. You should therefore ensure that all users' PCs are
configured to launch a screen saver after 15 minutes of idle time and have Password
Protection on Resume enabled. To ensure this, domain administrators should lock
down these settings in the group policies of the domain controller.
9. Review and adjust your Windows Domain policies for user accounts if required. For
instance, the PCI specification mandates the following rules:
z Immediately revoke access for terminated users.
z Remove inactive user accounts every 90 days.
z Do not use group, shared or generic accounts and passwords.
z Change user passwords at least every 90 days.
z Passwords should be at least 7 characters long and should include both numeric
and alphabetic characters.
z Do not allow individuals to submit a new password that is the same as any of the
last 6 they have used.
z Lock out the user account after not more than six unsuccessful access attempts
(have a lockout duration of 30 minutes or until admin enables the account).
10. To ensure no recorded data is stored anywhere in an unencrypted format, including on
the supervisor's PCs, Internet Explorer's Advanced Security Do not save encrypted
pages to disk and Empty Temporary Internet Files folder when browser is closed
170 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
PCI Compliance
settings on the supervisors' PC must be enabled and locked down. (Internet Options
> Advanced > Security).
11. To ensure proper authentication when SSL is enabled in a recording system, the
following advanced Internet Explorer security settings on Supervisor PCs must be
enabled
z Check for the publisher's certificate revocation.
z Check for server certificate revocation.
z Warn about invalid site certificates.
z Use SSL 2.0.
z Use SSL 3.0.
z Use TLS 1.0
172 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Chapter 7: Advanced Configuration
This chapter provides an overview of the more complex and rarely used options for a
Verint ContactStore for Communication Manager system.
The main sections in this chapter are:
z Properties File on page 174
z Standby Server on page 182
z Central Replay Server on page 183
z User Defined Fields on page 184
z Customizing Search and Replay on page 186
z Usage Report on page 191
z Selective Record Barring on page 193
Properties File
A number of system settings can be changed from their default values by placing entries in
the properties file as described below:
z this is a plain text file, located in the installation path and with filename:
/opt/witness/properties/cscm.properties
z you should edit this file using the vi text editor when logged on as witness - NOT root.
z the Verint ContactStore for Communication Manager service reads this file as it starts,
so any changes made to the file will not take effect until you next restart the service.
z the file is normally empty as all settings default as shown in the table below.
Most of these entries are discussed elsewhere in this manual, in the appropriate context.
The table below provides a summary of the available settings.
174 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Properties File
176 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Properties File
178 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Properties File
180 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Properties File
Standby Server
First, determine the number and type of standby servers required using the Topology
tables in Standby Recorder Options on page 254
Standby servers are installed in the same way as a standalone recorder (seeInstalling
Verint ContactStore for Communication Manager on page 86 - steps 1-7). The license key
determines that the server will act as a standby.
Follow the configuration guidance given in the appropriate table:
z Where a Standby is to copy the configuration of the Master recorder (the default) then
you need to configure very few other details. Work through the Configuration chapter of
this manual configuring just those fields with "Edit" links next to them.
z Where specific standby recorders need to be specified, ensure you have set the
Standby Recorder Serial Number for each set of softphones and each set of stations on
the Station Bulk or Conferenced Mode settings page.
z Where a standby recorder is to be locally configured,
1. Add the following line to the properties file (See Properties File on page 174 for
detailed instructions)
standby.localconfig=true
2. Restart the Verint ContactStore for Communication Manager service
3. Configure all settings as you would on a standalone recorder.
182 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Central Replay Server
Installation
Install a Central Replay server in the same way as the Master recorder (see Installing
Verint ContactStore for Communication Manager on page 86 - steps 1-7). The license key
determines that the server will act as a Central Replay Server.
Configuration
Work through Chapter 4: Configuration configuring just those fields with "Edit" links next to
them. Then configure the user accounts and replay rights for those entitled to use the
application.
Storing UDFs
Use an external controller to TAG calls using the interface described in Appendix
D: External Control Interface. The database automatically notes new UDFs and stores the
call's details.
184 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
User Defined Fields
z Better support for sparsely populated data sets in which there are more user-defined
fields, but not every call has every field present.
Viewer Compatibility
If you name your user defined fields spare1 through spare8 you can upload them to a
Viewer database as well as have them in the local database. The name by which the users
see these fields can be set in the template files.
! WARNING:
WARNING: lcscm.xml and idefault.xml must not be modified. They are overwritten
during upgrades. You will make your changes in files with different filenames
(of your choice).
Note:
Note: The web server picks up changes that result from additional files being
placed in this folder within a minute. There is no need to restart. However, it
makes sense to make these changes when there are no users on the
system.
186 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Customizing Search and Replay
The outer tag is <layout>, within which the internal name of the layout is given by the
name parameter and the display name token is given by the display parameter.
It makes sense to name the file linternalname.xml but this is not mandatory.
The web application presents the layouts in alphabetical order by internal name in the
layout name drop list box.
There are 3 inner tags:
z View: The name of the query on the database
z Filters: The filters for the left panel
z Columns: The columns for the grid display
Inside the outer filters tag, there are many filter tags. Each must have the following:
z a type, which can be date, string, duration, ucid or callset
z a column name matching one of those in the specified database view
z a display token which is looked up in the internationalization file.
Inside the outer columns tag there are many column tags. These must have a column
name, width, format and display. They may optionally have an enablelikesearch flag. See
the default above for all valid display types.
Widths may be valid HTML table widths (that is, nnnpx for pixels or mm% for percentages).
However, it is better to leave these blank and let the browser decide.
If enablelikesearch is true the application displays this field as a hyperlink that, when
clicked, executes a search for all calls (+/- one day) which have exactly the same data in
this column as the call clicked upon.
(The example use of this is for universal call id - which you can click on to find all recorded
segments of this call).
Internationalization
The file idefault.xml contains translation strings that allow you to format the output in any
language. The current default is shown below.
188 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Customizing Search and Replay
It has an outer tag <tokenset> with inner tags <language>, which in turn have inner tags
<token>.
Note:
Note: The naming convention adopted is as follows: the display tokens for layouts
begin "l", for filters "f" and for columns "c". This is only a convention.
When the application wants to display the name of a layout, it looks up its display token in
the internationalization maps by name, according to the user's language preferences set in
the browser.
For example, lcscm.xml has the display token ldefault, the string for which (in
English) is "Default Layout".
To change/add strings you can supply a file called icustom.xml.This file must contain a
tokenset, as described above. It is merged with the tokenset in idefault.xml. Because
the file icustom.xml is read after idefault.xml, any duplicates will use your values
rather than supplied defaults.
For example, if your French users dislike the default translation of call ID (ID d'appel) and
would prefer "ID", then supply an icustom.xml with the following:
This text provides the override of the original value, and the column displaying call id is
now labelled ID.
If you are designing additional layouts, you may use any or all of the supplied token ids and
these will be translated from the default file.
If you wish to label things differently, you may think of additional token ids, use those in
your layouts and provide translations for them in your icustom.xml. You only need to
provide translations for your own languages.
However, if you wish to override the default layout, you may create an lsomething.xml
file with a valid layout in it, and give that layout the name "cscm". This file replaces the
default layout.
Note:
Note: Do not call your file lcscm.xml. If you do, your file will be overwritten during
upgrades.
Examples
190 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Usage Report
Usage Report
The recorder is occasionally sold to service providers with a "per use" license. Charges are
levied based on the actual usage made of a recorder each month. This report can be
enabled in such cases to provide the necessary billing information.
Content
The Usage Report page shows a summary of the recording modes that have been used
over a specific period. The default reporting period is the previous calendar month.
To generate a report for a different period, enter the date range in the calendar controls,
and click Refresh.
Usage of most modes is reported straightforwardly but the Bulk recording row is a count of
those stations that have been
z Configured for Station Bulk Recording
and/or
z Recorded using a Verint Quality Recording port at any time during the reporting period
The number in the Usage column shows:
z the maximum size of the pool for On Demand, Meeting, Telephone Replay, Live
Monitoring, Conferenced, and Unify/External using single-step conference.
z the total number of different stations that have been recorded in Station Bulk, Station
Executive, Unify/External modes during the reporting period.
The Stations Recorded column shows the individual stations and/or station ranges that
were targeted.
Configuration records are retained for 13 months. Each night after that period has elapsed,
a background job deletes any records older than 13 months.
192 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Selective Record Barring
Configuration
It is possible to bar recording of calls to or from certain numbers. To configure such a
“recording bar”, add the property file entry:
recording.barred=<regular expression>
Where <regular expression> is a regular expression that will match the digit strings to be
barred from recording.
Tip:
Tip: See http://java.sun.com/docs/books/tutorial/essential/regex/index.html for
instructions on how to form a regular expression.
Example
The following example shows how to bar calls to or from area codes 234, 567 and 890 –
where the recorder is situated in area code 234 (which therefore does not have a 1 in front
of it, unlike the others which may or may not). The trailing periods (there are seven of
them) are important – as this forces the pattern to match only numbers with 7 digits
following the area code.
recording.barred=((234)|(1?567)|1?890)).......
Any recording that is barred due to matching the digit pattern specified will cause an INFO
level message to appear in the log file.
Limitations
1. This feature applies to Station Bulk, Station Executive, Unify/External Control (Station
Bulk) and Conferenced modes only (On Demand, Meeting and Externally controlled
Conference mode are not affected).
2. To bar incoming only or outgoing only, first determine the digit patterns that are used.
You may be able to change the outbound dial plan to always prefix with a ’1’. The "1?"
matches calls with or without a preceding ’1’. Remove the ’?’ to require a ’1’ before the
pattern is matched.
3. Behavior differs slightly between the Conferenced and Service Observe modes. The
former break each recording into separate segments whenever the parties on a call
change e.g. consultation call becomes 3-way conference call. The record/bar decision
can therefore be applied on each segment and an internal consult call will therefore be
recorded even though the resultant conference call (involving a barred party) will not.
Service Observe, however, does not break the media stream at this point and hence a
single recording segment containing the consult call and the three-way call is the norm.
In this case, if a barred party is present at all (i.e. would appear in the list of parties
tagged on the recording) then the entire segment – in this case including the consult
call – is deleted rather than stored.
4. Note that the Service Observe modes may record calls (as Station Executive mode
does for all calls) that are in progress but then delete the recording and associated
data file at the end of the call.
194 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Appendix A: Technical Reference
This appendix provides technical details about the Verint ContactStore for Communication
Manager system.
The main sections in this appendix are:
● Recording files on page 196
● Internal Database on page 197
● Recorder Interfaces on page 199
Recording files
Call segments are stored in an industry standard wav file. When each call is completed
and as each recorded call segment becomes available, the recorder updates its local
database with a record of the call segment. These files are stored in a hierarchy of folders
beneath /calls.
Every recording results in one or more:
● wav file
● xml file
WAV files
The wav files contain the actual audio of the recording. You can double-click some wav
files to play them directly. Others are in audio formats that are not directly supported by
Microsoft's Media Player. This applies to most recordings made by this recorder. These
must be converted into a supported format before they can be played. Since the recorder's
Search and Replay application does this conversion automatically, you do not need to
access these files directly.
XML files
The xml files contain details about the recorded call segments. Although most users
typically search against the recorder's database of calls, you can view these files directly in
a browser if required.
Within each xml file there is:
● All the details known about this recording. Most of the information, but not all, is inserted
into the calls database. Some of the information is only of interest for diagnostic and
maintenance purposes.
● Start and end time in ISO format giving local time and offset from GMT.
196 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Internal Database
Internal Database
If you have retained all of the xml and wav files as described above, then you have kept all
of the details about the recordings you have made. However, the system uses an industry
standard database (PostgreSQL) to hold this information in more readily accessible forms.
This database is located on the recorder itself. The database stores details of the
recordings as well as details of the recorder's configuration.
Recording details
The call details database uses approximately 1KB per call (in the absence of user defined
fields).
To allow you to search for calls easily, the details of recordings (except those made for and
copied off to a Quality monitoring server) are inserted into this database. It contains one
record for each call segment recorded and additional records for each party on the call and
each owner of the call. The information stored for each call is:
● A unique reference for the recording
● The start date and time
● The duration of the recording
● The recording mode that was used to make the recording
● The Communication Manager's Universal Call Identifier (UCID)
● The name and number of the parties on the call-where this was available to the
Communication Manager (through ANI or CLI) at the time of the call
● The agent number and name of an agent involved in the recording if one was logged on
at the station being recorded
● The direction of the call (incoming or outgoing)
● The owner(s) of the recording
● The service or vector directory number (VDN) name where available
● Additional fields provided by external controllers
● The DNIS if present (Conferenced mode only). Stored as user defined field "spare2"
Configuration details
Several tables hold details of system configuration, such as port assignments, file paths,
timeouts and user authorization rights.
198 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Recorder Interfaces
Recorder Interfaces
The interfaces supported by the recorder are described below (working clockwise round
the diagram, starting at top left).
Administration Interface
This provides administrators with access to configuration and status monitoring pages.
Search Interface
End users access this to search for call recordings that match specific criteria.
AudioServer Interface
If at least one port on the recorder is licensed for and assigned to the Telephony Replay
pool, then the recorder supports the AudioServer Interface.
The login page for users entitled to replay allows entry of a telephone number on which
they can be reached. If they do not enter a number, the browser replays through the
soundcard. You can also use separate Replay applications. Applications that can use this
interface include:
● Viewer and eWare
● Vision
Communication Manager
The recorder interfaces to the Avaya components via several mechanisms:
DMCC
DMCC runs on an AE Server and provides softphone registration and signalling services.
200 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Recorder Interfaces
eQConnect Interface
The recorder can use an HTTP interface to communicate with eQConnect if this is installed
on an eQuality Balance (V7) server. (This defaults to port 3020). This is used to advise the
Balance server of agent logon/logoff and recording details.
Replay Interface
eQuality Balance uses Viewer to replay calls made on this recorder.
Other Recorders
Recorders establish links with each other when acting in Master/Slave and
Primary/Standby topologies. These are TCP/IP socket interfaces.
202 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Recorder Interfaces
To Viewer database
When deploying Viewer, the recorder uploads call details to a central Microsoft SQL Server
database over this link. The recorder acts as a standard Microsoft SQL Server client
application. It uses the TDS protocol, which uses TCP/IP port 1433 by default. This can be
overridden with a properties file setting.
Summary
Interface Protocol Local Remote Direction
204 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Appendix B: Troubleshooting
This appendix covers two areas: general troubleshooting tips and some specific common
issues:
The main sections in this appendix are:
● Hints and Tips on page 206
● Specific Problems on page 208
Application Logs
The Verint ContactStore for Communication Manager writes log files to /opt/witness/logs.
The current day's log file is called cscm.log. At midnight the current log file is closed,
renamed to cscm.log.<date>, and a new log file opened. These log files are
automatically purged after 30 days by default but this can be overriden with a properties file
entry.
206 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Hints and Tips
Temporarily, immediately
To change the level temporarily, without restarting the service, simply use a browser to
request the URL:
http://myrecorder:8080/log?level=DEBUG
using the name of your server.
Alternatively, if you do not have access to the web administration screens, but do have
access via secure shell, execute the following command:
perl /opt/witness/bin/loglevel.pl DEBUG
You do not have to stop recording in order to change the logging level. To set it back again,
enter the same URL, replacing DEBUG with INFO. The command is case-sensitive. Using
this method changes the log level temporarily. It will revert to normal the next time that the
system is rebooted.
Tomcat Logs
Verint ContactStore for Communication Manager uses the Tomcat web servlet container,
which writes log files to /opt/witness/tomcat5525/logs.
Remote Access
You are strongly advised to provide remote access to the server to aid fault-finding.
Specific Problems
Cannot log in
If you have trouble logging in, double-check the state of Caps Lock and ensure the
password is being entered with the correct case.
If you can log in under another account, reset the password of the account having
problems.
If nothing happens when you click the OK button, check that your Internet Explorer settings
allow javascript to run. See ActiveX Control Download on page 138.
These symptoms have also been seen when trying to access a server with an underbar in
its node name. Note that this is not a valid IP name and should be changed.
208 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Specific Problems
Connectivity
Email alarm problems
Invalid entries in any one of the parameters used to define the email settings will result in
errors. To check this:
● Try the settings you are using in a standard mail client, such as Outlook. Send a
message using the account specified to prove that the settings are valid.
● If email messages have been working and then stop without any of the settings
changing, verify that nothing has changed on the mail server. This problem occurs, for
example, if your password has been reset or changed on the mail server.
● If the recorder is not sending email messages, it may be because it is not able to access
the SMTP server. Check the network connections to the recorder.
210 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Specific Problems
Cannot log in
If you see the login page but cannot get past it:
1. Verify that Caps Lock is off and that you are entering the password with the correct
case.
2. Log in as a different user
3. Confirm the spelling of your log in name with the system administrator and check that
your account is still configured in the administration pages.
4. Ask the system administrator to reset your password. Log in with a blank password
and change your password when redirected to the Change Password page.
No Audio "graph"
This means that the call has not been retrieved from the recorder or DVD disk or has not
reached the client PC.
1. Check the server logs for errors.
2. Note the call's 15 digit reference number (shown if you hold the mouse pointer just to
the right of the radio button that you click to retrieve the recording. Search for that wav
file in the calls path to confirm that the recorded file exists.
3. Check connectivity and available bandwidth to the client PC.
212 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Specific Problems
If the C-LAN, MedPro and/or recorder ports are failing to auto-sense full/half-duplex
properly, you can force each port to either full or half duplex so as to reduce the error count
to zero.
Note:
Note: Even though a port may show an error rate of less than 1 in 100 packets, the
error counts are deceptive. A single packet error can trigger a full/half duplex
negotiation during which all packets are lost in the servers, but none of these
show as errors on the switch.
If your error counts are zero on all ports, then we must also consider overload of the
recorder as a possible cause. You should monitor the CPU load of the recorder during
busy hours. Replay and live monitor are very sensitive to overload. Recording may be
unaffected but if the CPU load is too high, audio quality on replay can suffer.
Similar problems have also been seen on multi-CPU AMD Opteron servers. This is caused
by an unstable system clock, which is addressed in RedHat Versions 4 and 5.
Recording Problems
Partial recording problems
Since no hardware component in the system is dedicated to specific ports, any hardware
problem is likely to affect all recordings equally. Therefore, if some calls are being recorded
and are playable but others are not, the problem is probably in the configuration.
1. Recording Mode versus Recording Channel? Determine whether your problems relate
to all channels of one or more recording modes or just to certain ports.
2. Check the configuration pages for the affected recording mode(s).
3. Calculate the range of stations carefully. For example, 11000 to 11010 is a range of 11
addresses, not 10.
4. Use the Status > Port Status page to observe the ports on the recorder during your
test calls. The ports go should go from idle to active and back again.
Quality Recording
Check that the Quality recording ports are set to use the same codec as any bulk recording
you are doing on the same phones.
214 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Specific Problems
Meeting Recording
Live Monitor
Cannot monitor
1. Check that you have created the appropriate numerical user account so that the
station/phone dialling in is recognized as an authorized user.
2. Check that the live monitor ports are set to use the same codec as the ports you are
trying to monitor.
3. The recorder requires rtp-payload signalling as described in Configuring tone
detection on page 75 in order to interpret dialled digits. Check that both IP phones and
Digital phones are configured for this signalling mode as IP phones will default to it
whereas digital phones may not.
216 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Appendix C: Alarms
This appendix provides details of the alarms that can be raised by the system..
The main sections in this appendix are:
● Alarms on page 218
● Alarms Table on page 219
Alarms
The recorder may generate the following Alarm or Event notification messages. These
events are:
● shown on the Status > Alarms/Events page
● sent in email messages as specified on the System Settings > Server page
● reported via SNMP
● logged to the recorder's log file cscm.log
218 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Alarms Table
Alarms Table
Within messages, the strings XXX and YYY represent a specific parameter such as a
station number, an IP address etc. The table shows both the English text of the message
(that appears on the Alarms page) and the underlying resource string that appears in the
log file.
Entries within the table are sorted according to the text of the message.
Warning alarms.binaryuui One or more User to Only text fields are Change to text
User Information fields supported. fields or stop
are in binary format. attempting to store
This is not supported. UUI
See call XXX for
example.
Major alarms.callspath.invalid Call storage path is Separate partition Set this to a valid
invalid. Please change preferred. path.
it under Settings >
Server.
Major alarms.cmapi.up Device, Media AND DMCC services are No action required.
Call Control API restored.
running on XXX.
Major alarms.disk.full Disk full on partition 'Check log files. If Delete some files to
'XXX calls partition, make space.
check for files that
cannot be purged.
Warning alarms.disknearlyfull Disk nearly full on Check log files. If Delete some files to
partition 'XXX'. Only calls partition, make space.
YYY MB free. check for files that
cannot be purged.
220 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Alarms Table
222 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Alarms Table
Major alarms.queue.copy Failed to copy to XXX. Will cache files until Determine why
Reason:YYY. NOTE: problem is resolved recorder cannot
Further errors with the then copy all write to the share.
same root cause on the outstanding.
same path will only
show here once every
24 hours. Check the
log file if in doubt.
Minor alarms.rtp.packetloss Unacceptable packet Reported once per Check network path
loss from XXX. day per IP address to recorder. If
but could be several different
occurring on all addresses report
recordings from that problems at the
address. same time, identify
common path. If
many addresses
report at same time,
could be CPU
overload at
recorder.
Major alarms.softphone.callstopped Port XXX. Call dropped Recording port has Consider setting
as it exceeded been active for recording mode to
maximum permitted several hours. release call on
duration. dropping to one
other party.
Major alarms.softphone.endrecfaile Port XXX. Error ending Internal error Report Problem
d recording. Reason:
YYY.
Major alarms.softphone.hookswitch Port XXX. Error setting Internal error Report Problem
hook switch. Reason:
YYY.
Minor alarms.softphone.invalidtarge Port XXX - Invalid Quality app asked Check Quality
t target for recording: to record invalid server
YYY station. configuration.
Major alarms.softphone.nullpointer Port XXX. DMCC event Internal DMCC Report occurrences
'YYY' fired with null error related to a with a copy of your
pointer. particular recorder log files.
port.
224 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Alarms Table
Warning alarms.softphone.shortpacke Port XXX. VoIP packet Default settings of Configure codec set
t interval of YYYms less 20 or 30ms are not and network region
than recommended efficient for as per installation
60ms. recording. instructions.
Warning alarms.softphone.userreset Port XXX. User 'YYY' Also logged to audit No action required.
reset the port. trail.
226 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Alarms Table
Major alarms.standby.notviable Recorder fatal error. Recorder will See next error
request that message.
standby takes over
if one is present.
228 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Alarms Table
Major err.eqb.1000 Licensed port count Quality server tried Reconfigure Quality
exceeded: requested to access more server or increase
XXX, available YYY ports than are license.
licensed.
Major err.eqb.1001 Insufficient ports Quality server tried Reduce port count
allocated: requested to access more on quality server or
XXX, allocated YYY ports than have allocate more ports
been allocated to it. on recorder.
230 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Alarms Table
Info info.archive.rightdisk Correct archive disk Now able to write to No action required.
now inserted. disk in drive
232 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Appendix D: External Control Interface
This appendix provides details of the external control protocol and Java class library.
The main sections in this appendix are:
● Introduction on page 234
● Java API Toolkit on page 237
● TCP/IP Protocol Overview on page 238
● Examples on page 242
● TCP/IP Message Sequences on page 245
Introduction
External applications can control or influence recording by using the Recorder Control
Protocol. You may integrate directly to a TCP/IP socket interface using the protocol
described or by using the Java package provided for this purpose. An example application
that uses the Java interface is also provided for reference.
Additional Tagging
If you need to "tag" recordings with details that are not normally provided by the recorder.
Hybrid Systems
If your telephone system is controlled by another application (e.g. Genesys) then it may be
appropriate to control recording as a result of the events occurring on a CTI feed from that
application. In such cases, you may need not only the external control protocol but also
Verint's Integration Framework or Unify server. These can interpret a wide range of CTI
feeds. This is beyond the scope of this document.
This Appendix
The remaining sections of this appendix provide:
● a brief overview of the Java interface classes. For detailed information refer to the
JavaDocs for this package.
● an Overview of the underlying TCP/IP control protocol
234 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Introduction
● a reference guide for the message sequences exchanged between recorder and
controller
Port Allocations
The Unify/External Control recording modes are provided for backwards compatibility with
existing deployments only. New deployments should NOT allocate ports to these modes.
Instead, use the external controller with ports in the following modes:
● Station Bulk - for all service observe based recording.
● Conferenced - for single-step conference recording where the external controller needs
to provide additional tagging or is splitting long recordings into segments (as needed
with many auto-diallers). Do NOT use ports in this mode if you want to initiate
recordings from the external controller. You must allow the CSCM to establish
conferences before sending TAG, STOP (and then subsequent START) commands. Do
NOT send "START SSC:nnnn:" commands as these will conflict with the recorders
allocation of ports to calls.
● On Demand - for single-step conference recording where the external controller is
determining which calls are to be recorded. It can either instruct the recorder to
establish a single-step conference; do so itself or support manual conferencing.
! Important:
Important: For backwards compatibility with existing deployments (in which Unify does
not send the FALLBACK OFF command), the recorder automatically takes
FALLBACK off those ports that are assigned to the Unify/External control
(Service Observe) mode. In this case, these ports only revert to FALLBACK
mode when ALL external controllers have disconnected. You can override
this behaviour by setting unify.defaultrecord=true in the properties file but for
new deployments should be using Station Bulk ports instead.
Connect Unify/External controller to the Master (and Standby if present) only. Do NOT
connect Unify to the Slaves. All ports on the slaves will be configured in On Demand Mode
and the slave recorders will already be configured to consider the Master (and Standby if
present) to be their "external controllers". There should be no need for the Unify/External
controller to be aware that ports are on slave recorders as it communicates with the master
(and standby) exactly as if the ports were on the master (or standby).
The only exception to the above is that when using Quality Monitoring in "CSCM Plus"
mode with external tagging, the following limitations apply to post-call tagging:
● Calls made before the most recent restart of the active recorder cannot be post-call
tagged
● Only the most recent 1000 calls can be post-call tagged. (Change this default value with
eqconnect.guidcache=nnnn in the properties file).
● Following a switchover from master to standby or vice versa, only calls started by the
currently active recorder can be post-call tagged.
These limitations are not normally of any concern to most applications as these tag calls
very shortly after the call ends. They may affect batch mode tagging - such as overnight
processing. In such cases, consider using additional table(s) in the eWare database
instead and updating these directly rather than tagging the recording itself.
236 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Java API Toolkit
Packages
JavaDoc for these classes is available on request. To view the JavaDoc without a Java
IDE, unzip the contents and double-click index.html for a top-down view. For a
comprehensive reference index, double-click indexall.html.
Connection Method
An external controller can drive the recorder via a TCP/IP socket using the protocol
described below.
You configure the Master recorder with the IP address and socket number of the
controller(s) to which it should connect. Connection defaults to port 1414 but you can
specify an alternate port. For example, you must specify port 1415 to connect to the PDS
controller and port 1416 to connect a Slave recorder to a Master recorder.
Note:
Note: This setting was previously on the administration page for Unify/External
Control ports but has been moved to the main server settings page as it now
applies to all recording modes.
The recorder creates a socket and attempts to connect to each specified address. If it fails
to connect, it will try again every 60s.
You can use multiple, independent controllers connected to a single recorder.
The controlling application should open and bind a server socket and accept incoming
connection requests.
238 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
TCP/IP Protocol Overview
6. Apart from HELLO messages (see below) and responses, all messages must be
responded to in the form:
<protocol version number> <error code> <channel identifier>
<error qualifier> <additional info> '\x1b'
Where
<error qualifier> is typically "DESC:xxxxxxx:"
and
<additional info> may be 0 or more instances of
"PARAM:pppppp:"
The response to a successful command is therefore:
1 0 STN:nnn: \x1b
and a typical error response is
1 -1 STN:1234: DESC:"Invalid Parameter": PARAM:STN \x1b
7. Ignore unexpected or malformed responses.
8. Send commands in uppercase, but test for them case insensitively.
Channel Identification
In most messages below, the recorder's channels are identified by Station Number
STN:nnnnn:.
Where nnnnn can be 1 to 9 digits long and may include leading zeroes.
The use of this station number varies according to the type of recording port being referred
to:
● Ports using a Service Observe mode (Station Bulk and Station Executive mode) are
referred to by the station number that they are observing.
● Ports using conferencing are referred to by the station number of the softphone that the
recorder is using.
XML Tagging
All tagging information is passed straight through the recorder into the XML file associated
with the recording. The recorder only looks for an escape character to delimit each
command. The intention is that the controlling application will pass through valid XML tags
which the recorder will insert into the body of the call's XML file. These may include valid
expansions of control and other characters (e.g. %20 etc). The entire xml string will be
inserted between opening and closing "taglist" tags. For example, the command
1 TAG STN:1234: INUM:800369000000009: <spare1>some
data</spare1><spare4>John Doe</spare4>\x1b
will result in call reference 800369000000009, which is currently being recorded on STN
1234 being tagged with the additional fields:
<taglist><spare1>some data</spare1><spare4>John
Doe</spare4></taglist>
If you intend to use Contact Viewer as your search and replay tool (rather than the integral
search and replay within the recorder) you should only use the eight special user-defined
fields, labelled "spare1" to "spare8". These can be relabelled for end user viewing as part
of the query design using Contact Viewer. You may use other fields but the recorder only
uploads these eight "spare" fields automatically to the Viewer database.
240 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
TCP/IP Protocol Overview
If the recorder is collecting call details itself, the external controller can ask to be advised
whenever these change. Use the REQUEST ACTIVITY ON command to do so.
Fallback Mode
When a recorder starts, it automatically runs in locally controlled mode - where call events
it detects cause it to start/stop recording. This is also known as "fallback" mode.
If the external controller only wishes to TAG calls with additional data, it may be happy to
leave the ports in this mode. On the other hand, if it wishes to take control of the recording
decisions then it must instruct the recorder to relinquish control of the ports it wants to use.
It does this with the FALLBACK OFF command - either for a specific STN or for all ports.
If the heartbeat to the external controller that turned FALLBACK off is subsequently lost,
the channel(s) will revert to fallback mode and recording will continue as if the controller
had never been present.
Use the station specific command to take control of specific stations if you want to allow
other stations to continue to be controlled by the recorder or if you are using multiple
controllers, each of which manages its own set of stations.
Examples
Typical examples of how to use an external controller are given below. You should read
these in order as later examples refer back to earlier ones.
242 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Examples
2. The controller establishes contact with the recorder (exchanges HELLO messages)
3. The controller notes the pool of ports that are ONLINE (and may alarm if there are too
few)
4. When a call is to be recorded, the controller picks an available port and sends it a
START message with SSC parameter specifying the station that is already on that
call..
5. When recording is no longer required, the controller sends that port a HANGUP
message,
6. On hanging up (whether instructed to by the controller or if the call ends) the recorder
sends a HUNGUP message to the controller. Only then can the port be reused for
another call.
7. The recorder performs basic tagging itself but the controller sends Genesys user data
through as TAG commands.
Should the controller fail, no recording will happen. For fault tolerance, use a pair of
controllers and have one or the other send messages to the recorder.
For large systems or to make the system tolerant to recorder failure, use a pool of N+1
independent recorders.
For a system that is tolerant of recorder failure, use a Standby recorder. This will contact
the controller as and when it takes over from the primary.
244 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
TCP/IP Message Sequences
246 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
TCP/IP Message Sequences
248 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
TCP/IP Message Sequences
250 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Appendix E: Fault Tolerant Systems
Redundant SAN
If you already have a fault tolerant storage network in place, you can assign the calls
storage path to an area of this storage system. This is supported for locally connected
drives - NOT for Network Attached Storage (NAS).
You are then reliant on the mirroring or other redundancy and standby mechanisms
associated with the storage network. These mechanisms typically include a tape library
backup and might include hierarchical file storage (HFS), in which older files are replaced
by small tokens that allow the system to retrieve the original content from the tape library.
The recorder runs successfully with Tivoli Storage Manager and might also support other
similar systems. However, Verint does not proactively test against these systems. Connect
to them at your own risk. If you want to use such a system, turn the recorder's own disk
management function off. To do this, add the line disk.manager=false to the properties file.
This stops the recorder from deleting the oldest files as the available disk capacity falls to
1GB. You must then ensure that the available space on the /calls partition does not fall
below 1GB.
252 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Duplicated recording
Duplicated recording
Where recording is controlled by an external application (such as Unify) establishing
conference calls onto the recorder's ports, a fault tolerant system can be deployed by using
two totally independent recorders and establishing 4-way, instead of 3-way conferences.
By conferencing in one port from each of the two recorders, a fully redundant recording
system can be delivered.
! WARNING:
WARNING: Although the recorders are running in parallel, you must also ensure that the
mechanism that is establishing the conferences is, itself, fault tolerant. This
may imply duplicated Unify servers and/or duplicated CTI feeds. The default
behavior of recorders is to fall back into basic recording mode (where
possible) should connectivity to Unify be broken. This often suffices as an
acceptable failure mode.
You must ensure that the mechanism that establishes the conferences can handle the
error condition that occurs when one of the recorders fails. It must establish the other
conference party to the remaining, good recorder rather than fail totally.
Note:
Note: A parallel recording system inevitably requires twice the resources on the
Communication Manager, both in terms of IP_API_A licenses and VoIP
resources. This option is, therefore, an expensive one.
! WARNING:
WARNING: The overall maximum of 6 parties on a conference might become a
constraint if two of these are recording ports. Call scenarios in which two
calls merge (transfer and conferencing) - and where each of these is already
a 4 party call due to duplicated recording can exceed these limits and are
not supported. To avoid this, recording ports are removed from a call as
soon as it goes on hold. In this way there are less parties present on the call
when it later merges with a consultation call.
254 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Standby Recorder Options
Off-site archive
It is also assumed that, where DVD+RW disks are written, that these will be stored away
from the recorders, ideally in a separate building for maximum protection. Should these be
needed for regular access, a copy should be made and kept off-site. Unless the fault
tolerant disk system is spread across multiple buildings, off-site storage of archive media is
essential.
Location of recorders
Where possible, you should locate the standby recorder(s) in a different building from the
primary recorders. You should also provide diverse network routing between the recorders
and the Avaya switch components that they interact with (AE Services, C-LAN and
MedPros).
256 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Standby Recorder Options
Known limitations
Deploying standby recorders:
● Does not guarantee access to recordings made by the failed server. See Centralized
database and replay above.
● Does not guarantee "no loss" of recording on failure. See Mode of operation below.
● Requires that the standby recorder can contact the primary recorder when it is first
configured so that its configuration can be copied.
● Does not allow configuration changes to configuration while a standby recorder is active
(unless the standby is configured for local configuration). You must restore the primary
recorder before making any changes to the configuration.
● Does not support the use of Telephone Replay ports on the primary and standby
recorder (unless you force local configuration). Place these on a central replay server
(or pair of servers if fault tolerant replay is required).
Distributed Systems
The primary and standby operations are designed to work well in distributed systems
where loss of connectivity between sites would otherwise case recording to fail. The
following Avaya failover modes are supported:
● Locally Survivable Processors (LSP)
● Enterprise Survivable Servers (ESS)
and uses a copy of the configuration from the central switch server. Because the copied
switch configuration (from the central site) cannot show the S8300 itself offering a DAPI
connection, the switch will not allow the recorder to establish a DAPI link to it under
fallback conditions. Therefore, recordings that are made under these conditions have
limited call details - that is, they do not have data in the agent, VDN, or UCID fields.
You must:
● specify the S8300 on the LSP site as the backup C-LAN for the recorder ports that you
wish to use when in LSP failover mode
● specify the appropriate remote Verint Contact Recorder as the Standby recorder for the
stations to be recorded there in LSP mode.
Three options are supported for LSP:
a. Standalone Recorder(s) on LSP Site(s) - In this enterprise configuration, the
recorders and AE servers are based on the satellite site(s) only. There are no
standby recorders. Each Verint Contact Recorder is configured to register its
softphones through a C-LAN at the central site. The backup C-LAN address for the
softphones is the S8300 on the same site as the recorder. In normal operation, the
recorder uses the C-LAN on the S8700. However, when LSP mode is invoked, the
recorder will reregister softphones on the backup C-LAN - in this case, the S8300 on
the remote site.
All calls which are taking place at the time will be lost but all new calls will be
recorded by the standby.
b. Automatic Standby Recorder(s) on LSP Site(s) - In this enterprise configuration,
the primary recorders are based at a central site and the standby recorders are
based at the satellite sites. The recording ports on the primary recorder are split into
groups. Each group of ports reflects the ports on a standby recorder that will take
over in failure mode.
A group of ports is configured with:
- The serial number of the standby Recorder that is to back these up in failover
mode
- Their C-LAN setting configured to point first to a C-LAN at the central site
(primary) and secondly, at a C-LAN on the satellite site (backup).
The port allocations made on the primary recorder are similarly marked with the
serial number of the standby recorder. The standby takes over this part of the total
recording load in failover mode.
The configuration of the primary recorder is copied periodically to all the standby
recorders on the remote sites as normal. When a failure occurs, the standby
recorder connects only those ports marked with its serial number to the standby
C-LAN and allocate them to the recording tasks that are marked for this recorder to
perform in failover mode.
c. Manually Configured Standby Recorder(s) on LSP site(s) - The system topology
is the same as in b) above, with the primary recorder(s) based at a central site and
258 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Standby Recorder Options
the standby recorders based at the local sites. However, the standby recorders are
setup for manual configuration (by means of a property file entry) and are typically
configured to perform station bulk recording of the stations at the LSP site. To set
this up, the primary recorder is configured without the backup or standby settings.
Then, each standby recorder is configured manually to operate as required when
LSP mode is invoked.
260 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Standby Recorder Options
Master/Standby Topology A
Master/Standby Topology A
262 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Standby Recorder Options
Master/Standby Topology B
Master/Standby Topology B
264 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Standby Recorder Options
Master/Standby Topology B
In the event of a When If the master recorder has failed, it may take
failure switchover a few minutes for the switch to release
occurs existing softphone registrations and
associated service observes.
Calls in progress will be recorded as soon as
the softphones on the standby can be
registered and service observe is allowed.
Until problem is Standby will record only those stations
resolved marked with its serial number as their
standby recorder (OR if using the localconfig
option above, it will record whatever it has
been configured to record).
When problem Master will attempt to take control as soon as
is resolved it recovers. This is to ensure that any stations
without a remote standby assigned are
recorded. Remote sites that are in ESS
mode will remain in ESS mode until manually
reset so will not be affected by this.
Standby will continue to record until reset.
You must therefore reset the standby at the
same time as you restore the Avaya system
from ESS mode to centralized control.
Do this out of hours as there will be a brief
interruption to recording as the system
switches back.
Master/Standby Topology C
Master/Standby Topology C
266 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Standby Recorder Options
Master/Standby Topology C
Master/Standby Topology C
Master/Standby Topology D
268 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Standby Recorder Options
Master/Standby Topology D
Master/Standby Topology E
270 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Standby Recorder Options
Master/Standby Topology E
Master/Standby Topology F
Master/Standby Topology F
272 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Standby Recorder Options
Master/Standby Topology G
Master/Standby Topology G
274 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Standby Recorder Options
Master/Standby Topology G
Mode of operation
This section describes how the standby recorder is configured and how it monitors the
health of its primary recorder. It also explains how it takes over when needed and returns
to standby mode when appropriate.
Power-On
A common case is that all recorders are powered on within a second or two of each other.
To avoid destabilizing the system, the standby unit will always wait for a pre-defined period
after it starts trying to contact the primary recorder before it assumes that it is dead. This
period allows for slight variations in boot time and manual power-on of one unit after
another.
The time-period is determined by the standby.connecttimeout=xxx property in the
properties file. (xxx is in seconds).
Standby mode
Once configured, the standby unit attempts to establish TCP/IP socket connections to the
primary recorder(s) over the one or more IP addresses it has been configured with. If it
succeeds, it downloads the configuration details of the primary recorder that are necessary
276 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Mode of operation
for it to take over in the event of the primary failing. It continues to refresh these details
every minute, thus keeping up to date with configuration changes.
Heartbeat messages are exchanged every second. If the standby unit detects a critical
error - such as failure to connect to AES - it will shut down its link(s) to the Master so as to
avoid any danger of the Master relying on it for fallback when in fact it is unable to function.
Failure Detection
The standby recorder will attempt to take over from the primary recorder in the following
circumstances:
● The primary requests that the standby unit take over because it has detected a fatal
error such as hard disk full, switch connectivity lost completely.
● On startup, if connection cannot be established with primary after 120 seconds (default -
and accurate only to within one minute).
● All TCP/IP sockets to the master(s) failing and attempts to re-establish them every
second are still failing after 30 seconds.
● Either or both TCP/IP sockets to the Master are still active but the primary does not
respond to repeated heartbeat polls for 30 seconds.
The three timeout settings above may be overridden by setting the property values
standby.connecttimeout, standby.reconnecttimeout and
standby.inactivitytimeout respectively in the properties file. Times are specified in
seconds.
These same parameters are also used by the primary recorder to report corresponding
failures of the standby although it will not do anything other than raise an alarm if this
occurs. The default values for these timeouts can be overridden on the primary using the
same property settings.
A primary recorder is not aware of standby recorder(s) until it has established contact with
a standby for the first time. Thereafter it will expect to establish contact with that standby
recorder always. (This can only be reversed by editing the underlying configuration
database).
Active mode
On inferring failure of or being instructed to by the primary, the Standby unit will adopt the
appropriate port allocations and attempt to register softphones as per the automatically
copied configuration or its local configuration.
It will configure the softphones in the same way that the failed recorder had been using
them prior to failure (unless you have forced local configuration). Where softphones are
marked with specific standby recorder numbers, only those marked for a given standby will
be registered.
Recordings will be made and uploaded to the eWare database or Central Replay Server (if
present).
Switchover Implications
It takes a few seconds to detect most of the failure modes. Although configurable using the
properties file, this interval is a compromise between rapid detection of true failure versus
risk of false alarms and/or "yo-yoing," a condition where the system goes unstable. The
system defaults aim to detect failures within 10 seconds and should not normally be
altered.
When a failure occurs and the standby recorder becomes active:
● Recordings in progress are interrupted. The partially completed .wav files for the
recordings in progress might be manually recoverable (professional services
chargeable). In G.729A mode, up to 1 minute of audio is buffered in memory and hence
will not have been appended to the file. In G.711 mode, files are appended to every 30
seconds.
278 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Mode of operation
280 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Standby Recorder Configuration
Configuration Differences
The following Administration pages differ on a Standby recorder:
● System Settings > License - Check that the license shows as a "Standby" server type.
The number of channels is equal to that on the primary recorder that this one is to
shadow.
Note:
Note: If you do not invoke local configuration in the properties file, the standby
recorder automatically copies license details from the primary.
● System Settings > Server - If using a DVD+RW drive for archive, set the path as usual
and set the volume label root to a string that is unique to this standby recorder. This will
let you distinguish DVDs written on the standby unit from those written on the primaries.
- The timeout and purge settings should be kept identical to those on the primary
recorder.
- An additional setting shows and allows you to enter the IP addresses of the primary
recorder that this recorder is to shadow. A primary recorder should have two NIC
cards, each with its own IP address. Both addresses should be configured on the
standby to enhance the reliability of the network link between them. The default IP
port number will be 1414 but you may override this by adding the port number to the
IP address, separated by a colon, for example, 192.134.34.45:1419. If you enter
a port number, this must match the configuration of the primary recorder, which also
defaults to 1414. You can override this default by setting the primary.localport
property in the cscm.properties file. Unless you are confident that your DNS
server is fault tolerant, you should specify numeric IP addresses to ensure that
connectivity does not fail because of address translation problems.
- You are strongly advised to create a separate email account, using a separate
SMTP server from that used by the primary. This way, failure of an SMTP server will
be noticed as you continue to receive e-mails from the standby unit but not the daily
heartbeats from the primary - or vice versa. It is critical that you ensure that the
standby unit is ready to take over at any time.
- The IP Station Security Code should be entered the same as for the primary.
! Important:
Important: Do not use the Advanced settings in the port entry form for the standby
recorder.
● Security > Users - This page is identical to that on the primary recorder. However,
since a central database and replay are nearly always used in systems with standby
units, there is little point in entering "replay only" users. Simply use this page to maintain
the administrators' account(s).
● Port Allocations - These pages are provided but their contents are not editable as
these are copied from the primary recorder (once contact has been established with it).
● Status > Alarms and Events - This page is identical to that on the primary recorder
though some different alarms will be generated - when the standby establishes contact
with the primary and should it ever try to take over from the failed primary. You should
use the email settings on the System Settings > Server page to ensure that you are
advised of these alarms within 10 minutes of one occurring.
● Status > System Overview - In addition to the normal fields that show on primary
recorders, a line will be added to the top table showing the status of the two links to the
primary recorder that the standby is configured to shadow.
● Status > Port States - When the recorder is in standby mode, no ports are visible.
When it takes over from the failed primary, this page should be the same as it would
have been on the primary had it still been running.
● Status > Peak Activity - This page is identical to that on the primary recorder but has
an added use on the standby recorder. Click on the Restart Peak Activity Count link at
the bottom left of this page to zero the counters. When you next view this page, if any of
these counts are non-zero you can infer that the standby unit has gone active since you
reset the count. This is a quicker check than looking through many pages of alarms and
events.
282 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Upgrade Process for Primary/Standby
284 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Appendix F: AIC Connector
This appendix describes the AIC connector. This is a ready-to-use client of the External
Control Interface for Avaya Interaction Center. It covers the following topics:
● Overview on page 286
● Installation on page 289
● Programmer’s Guide on page 290
Overview
The Verint AIC connector is an AIC server process that allows AIC clients and servers to
control the the recorder. It provides the following features to client developers and
scriptwriters:
● Start recording a station
● Stop recording a station
● Tag a particular recording with user defined data
● Enable recording of all calls at a station with automatic tagging
● Disable recording of that station
All these features are made available as simple AIC calls, without the need for complex
integration projects.
“Tagging” is a feature of the connector and the recorder that allows clients to associate
arbitrary information with each recording. These User-Defined Fields (UDFs), or ‘tags’, are
stored in the calls details database and can be included in searches and viewed in the
search and replay web applications. UDFs are tag-value pairs. (All calls will automatically
have the standard set of tag fields.)
The connector seamlessly supports:
● Multiple recorders (if more than one is needed to provide the total number of recording
channels)
● The recorder’s primary/standby high-availability mode
When there are multiple AIC servers for resilience, the connector can be installed on
multiple AIC servers and it will allow recording control of all recorders from either AIC
server.
The connector itself requires no configuration; it determines its configuration from the
recorder’s configuration. The recorder is basically configured in the same way that it would
be for Station Bulk recording, but with a few minor changes.
The AIC connector requires Version 7.7 (or higher) of the recorder. It works in Service
Observe mode only.
Modes of Operation
There are two basic modes of operations:
● Finer, event driven control
● Coarser, connector-managed control
286 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Overview
In the finer mode, clients of the connector are sent events whenever a call segment starts,
and are able to send tagging information via the connector to the recorder for each specific
call segment. To operate in this mode a client must register with the connector server for
events. It calls the start recording method of the connector. For each call segment that is
recorded, the client is sent an event containing the unique recording file serial number. The
client can tag each call segment differently if required. The client must stop recording when
it is no longer required.
In the coarser mode, clients do not need to register for, or handle, events. The connector
deals with event handling. In this mode the client enables recording for a particular
station and supplies a list of user-defined fields. The connector automatically tags each
subsequent call segment for that station with the tags supplied when recording was
enabled. The client need take no action, but loses the ability to tag each call segment
differently. The client should disable recording when it is no longer required.
Principles of Operation
The connector is an AIC server process, and runs on the AIC server. It is available for
Solaris and Windows. The connector is started and managed by AIC like any server
process.
The recorders are configured to contact the connector, which listens on a well-known
TCP/IP port number. If there is more than one connector, each recorder is configured with
all addresses and connects to all of them.
The recorders are administered in the usual way for Station Bulk mode, except that they
accept external control. The recorder will establish service observe on each target station
using one of its recording channels. The target stations can be split across multiple
recorders as required.
As the recorders connect to the switch and establish Service Observe on the target
stations, they announce their ability to record the target stations to the connector. When a
client requests recording of a particular station the connector forwards the request to the
relevant recorder. At the start of each call segment the recorder sends an event to the
connector with the unique serial number of the recording file. The connector sends events
to any registered clients and sends tagging information to the recorder as required.
High Availability
The connector integrates seamlessly with the recorder’s primary / standby high-availability
arrangement. If the primary recorder fails, it disconnects from the connector, and the
secondary connects instead. The connector proceeds to send recording commands to the
secondary recorder.
The recorder can connect to more than one external controller. This allows two connectors
to be installed on separate AIC servers. Either connector can be used to route messages
to the recorder.
288 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Installation
Installation
Before the connector can be installed its IDL must be appended to the AIC server’s master
IDL file, which must then be re-compiled. The resulting ‘pk’ file must be distributed. The
connector’s IDL is in the file cscm.idl on the distribution CD.
The connector consists of a single executable file that must be copied to the AIC server’s
directory. It is typically installed in the same directory as the rest of the AIC server
executables.
Use the AIC admin screens to add an entry for the Verint connector. There are no
parameters required. Start the connector on the AIC server(s) where it will run.
Configuration
Use the ContactStore administration screens to configure the recordable stations. If there
is more than one ContactStore, spread the recorded stations evenly across the recorders.
Specify the stations or ranges of stations on the Unify page (rather than the Station Bulk
page); this allows the connector to stop and start recording.
The recorder needs to know that it should continue to request the parties, VDN and UCID
information from the switch. Edit the properties file and add the following line:
unify.ocpneeded=true
Configure the address of the AIC server(s) in the URL field of the Unify page. If there are
two AIC servers specify both separated by a semicolon.
Check the status of the ‘Unify’ link(s) on the Status page and correct any alarms.
Programmer’s Guide
The interface to the server is described by its IDL, which is shown below.
interface CSCM : GeneralS {
ORBStatus Enable(in string station, in SeqCouple tags);
ORBStatus Disable(in string station);
ORBStatus Start(in string station);
ORBStatus Stop(in string station);
ORBStatus Tag(in string station, in string inum, in SeqCouple
tags);
ORBStatus Assign();
};
The first two methods (Enable and Disable) are used in the coarser-grained mode of
operation; the other four (Start, Stop, Tag and Assign) are used in the finer-grained mode.
Note:
Note: It is entirely possible to use any names for the tags sent to the recorder, but
you should stick to certain conventions. The normal choices for the tag
names are ‘spare1’ through ‘spare8’. If you use these tag names the rest of
the Verint infrastructure will make them available throughout the suite of
applications. If you use other tag names these will only be accessible
through the recorder’s own search and replay application. For example, you
may wish to tag calls with customer account number and zip code. You
should pass a Sequence containing two Couples: spare1=12345,
spare2=10010. Even though zip codes can be numbers they should be
passed as a string. The Viewer search and replay application allows you to
change the names of these fields to more convenient, human-readable
names when you design page layouts later.
290 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Programmer’s Guide
Assign()
Registers with the connector to receive recording start and stop events. It is these events
that contain the inum required for the call-specific tagging.
! WARNING:
WARNING: Note that the two modes of operation must not be mixed. Clients must either
choose the Enable/Disable method, or the Start/Stop/Tag method. Clients
may assign a session in either mode in order to receive events. Creating a
session is optional with the first method and required with the second.
292 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Appendix G: PDS/PCS Connector
This appendix describes the PDS/PCS connector. This is a ready-to-use client of the
External Control Interface for Avaya Predictive Dialler / Proactive Contact. It covers the
following topics:
● Overview on page 294
● Installation on page 295
Overview
The Verint PDS/PCS connector is an optional server process that runs on the same server
as the recorder. It uses events from the dialler to:
● Split the otherwise long, single recording of a dialler session into separate recordings,
one for each interaction.
● Tag each of the separate recordings with the dialler Job Name.
The PDS/PCS connector requires Version 7.7 (or higher) of the recorder. It works in Station
Bulk and Conferenced modes. The connector works with PDS v12, PCS 3.0 and PCS 4.0.
When working with PCS 4.0, security can be enabled with a property file entry.
Principles of Operation
The connector is an optional process that runs on the same server as the recorder..
The recorder is configured to contact the connector, which listens on a well-known TCP/IP
port number. A recorder always connects to the connector running on the same server.
The recorders are administered in the usual way for Station Bulk or Conferenced mode,
except that they accept external control.
The connector is automatically informed by the recorder which stations are being recorded.
The connector monitors recordings and makes a note of any Agent information. It is able to
build a map of which agents are logged on at which station (it does not have access to CTI
to determine this in more conventional ways).
The connector monitors dialler events for Logon events. If the ’terminal’ ID matches either
a recorded station or an agent ID that has been seen at a recorded station, the connector
notes the recorder port associated with this dialler session.
The connector disables recording on that port. When the dialler agent is on a call,
recording is re-enabled, and the dialler call information is sent to the recorder. When the
dialler agent is between calls recording is again disabled. When the dialler agent logs off,
recording control is returned to the recorder.
The dialler job name is shown in the Service column of the search and replay screen.
294 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Installation
Installation
The PDS/PCS connector is part of the recorder installation kit. No additional installation
steps are needed.
Configuration
Use the recorder administration screens to configure the recordable stations. Specify the
stations or ranges of stations on the Station Bulk page; this allows the connector to stop
and start recording.
Add the address of the PDS connector in the URL(s) of Unify/External control port(s) to
connect to setting on the System Settings > Server administration page. Specify
localhost as the address.
The PDS/PCS connector has its own properties file (pdscon.properties). A sample
properties file is supplied but must be edited before the connector will work.
Edit it and insert site specific data.
The following keys are mandatory:
● PDS.UserName - the PDS client username
● PDS.Password - the PDS client password
● PDS.DialerHost - the name of the PDS dialer
● OAIAddr - the IP address of the recorder’s NIC card to be used for communication with
the PDS
● license.key - the license key
The following setting is optional:
● PDS.NSIOR - the Name Service IOR
Note:
Note: If the IOR is not provided the connector attempts to look up the Name
Service using corbaloc (and must be able to resolve the IP address of the
dialler by name - make sure it is in DNS)
● PDS.Secure - true to enable PCS4 security.
Automatic restart
If the PDS shuts down nightly, consider adding cron entries to stop and start the connector.
Shut down the connector after all agents have left and restart the next day before agents
begin to log on.
296 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Appendix H: Non-standard Hardware
This appendix discusses considerations for non-standard hardware such as blade servers.
It covers the following topics:
● Overview on page 298
Overview
This manual and the automated installation processes assume a "typical" rack-mounted
server as the server hardware. However, ContactStore has been installed on other
hardware sucessfully, including blade servers. This appendix covers the considerations for
such non-standard hardware.
Disks
SAN
Blade servers are normally equipped with locally attached SAN which is ideal for
ContactStore. See Storage at Each Recorder on page 43 for further details.
Partitioning
The standard installation assumes either one or two physical disks, or one RAID array. In a
more complex environment there could be separate arrays for different partitions. For
example, a RAID 0 mirror for everything except call storage and a RAID 5 array for call
storage. Edit the kickstart script to specify the appropriate disk device for each partition by
changing the "on" parameter. See Expert kickstart options on page 84.
NICS
Blade servers often have redundant network configurations. It is therefore more likely that
ContactStore should be installed with just one IP address (eth0) instead of two (eth0 and
eth1).
DVD
Local archive will typically be unavailable since a blade will not have dedicated access to a
DVD recorder. Contact Archive is the prefered solution in this environment.
298 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Overview
Soundcard
The optional local soundcard will likely be unavailable. This is not a problem as a desktop
machine can be used to test replay.
Kickstart
If no floppy disk is available for kickstart installation, use the network-based kickstart
instructions in Performing a kickstart install without a floppy on page 83.
300 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Appendix I: Advanced Security Settings
This appendix discusses some features and prerequisites for advanced security. It
includes:
● Installing Unlimited Strength Encryption on page 302
● Installing a Signed SSL Certificate on page 303
● Changing Tomcat Port Numbers on page 307
● Encrypting Properties File entries on page 308
● Configuring Viewer and Archive to use HTTPS on page 309
● Configuring Archive for a Key Management Server on page 313
302 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Installing a Signed SSL Certificate
Tip:
Tip: If you do get a warning that the certificate does not match, check that the
Common Name matches the URL. Double click the padlock, select the
details tab, and click the Subject line. This displays the Common Name.
304 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Installing a Signed SSL Certificate
306 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Changing Tomcat Port Numbers
308 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Configuring Viewer and Archive to use HTTPS
310 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Configuring Viewer and Archive to use HTTPS
312 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Configuring Archive for a Key Management Server
Configuring Archive
1. Navigate to the \CAUtility folder on the CA's PC and generate a certificate for the
Archive server by typing the following command line at a DOS prompt: genCert
<ServerName> <CA's Organization Name> where ServerName is the full server name
or just the host name of the server.
You will be prompted for:
● The password of the CA's key file (cakey.pem)
● An export password to protect the output svr_cert_key.p12 file
Successful execution of the above command generates a svr_cert_key.p12 file
containing the signed server certificate, its matching private key, and the CA's
certificate in PKCS#12 format in the \CAUtility\signed_certs\ServerName folder of the
CA's PC. NOTE: The signed server certificate is valid for two years.
2. Deliver the generated file to the C:\Program Files\Witness Systems\conf\Security
folder on the Archive server. To ensure security, the export password should not be
transported along with the PKCS#12 file.
for all recorder and JAVA components and must be executed before any other certificate
installation procedures. This procedure is required for encryption of data at rest and/or
encryption of data in transit.
1. After delivering the svr_cert_key.p12 certificate file to the server, navigate to the
C:\Program Files\Witness Systems \conf\security folder and run the following
command at a DOS prompt:
installCerts export_password
where export_password is the entered password when the certificate was signed by
the CA. Running the script does the following:
● Extracts the certificate chain (cert.pem), the server private key (key.pem), and a
single server certificate (rsa_app_cert.pem) from the svr_cert_key.p12 file. The
rsa_app_cert.pem file needs to be loaded into RSA KMS to identify the key
management client (KMC) used by recorder applications on this server if At Rest
data encryption with RSA Key Management needs to be enabled.
● Creates a cacert.pem in the INSTALL_DIR\conf\security\trustedCA directory.
● Adds the CA certificate (cacert.pem) to the trusted CA certificate keystore
(JAVA_HOME\jre\lib\security\cacerts) of the running JRE with Impact360 as the
alias.
● Creates a svr_cert_key_dp.p12 file with the same content as svr_cert_key.p12
except with a new password changeit, which is the default password for the JAVA
keystore.
Note:
Note: Run the above script as often as necessary in case errors occur, such as an
incorrect password.
2. Load the file svr_cert_key.p12 into the Windows Personal certificate store of the
Computer Account of the server with the export password using the Certificate snap-in
of MMC (Start > Run > MMC). See Importing Certificates and Keys on page 65. Make
sure that the option Automatically select the certificate store based on the type of
certificate is selected. This option adds the server certificate to the Personal certificate
store and the CA's certificate to the Trusted Root Certificate Authority certificate store.
You may need to refresh the view to see the certificates.
3. Restart Tomcat if applicable
314 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
Glossary
AGENT Logon ID An unique identification number assigned to a particular agent. The agent
uses this number when logging on. The agent ID is not associated with any
particular phoneset
Avaya CT Avaya Computer Telephony is the CTI link running on the AE Services
platform that the recorder uses to observe activity on the Communication
Manager and to establish single-step conferences in Conferenced recording
mode. It is also used by eQuality Balance (V5). Avaya CT implements the
TSAPI standard and is often referred to as such.
BHCA Busy Hour Call Attempts. The number of calls that are attempted during the
switches busy hour. Typically slightly higher than, but often used
interchangeably with BHCC
BHCC Busy Hour Call Completions. The number of calls that are completed during
the switches busy hour. Typically slightly lower than, but often used
interchangeably with BHCA
Device, Media and Call A software platform (part of AE Services, previously known as
Control (DMCC) Communciation Manager API or CMAPI) that applications such as the
recorder use to create softphones that can participate in calls made on
Avaya Communication Manager-based systems.
DID Direct Inward Dialing. An attribute of a trunk. The CO passes the extension
number of the called party over a DID trunk to the PBX when offering a call to
the PBX. The PBX is then able to automatically route the call to that
extension without requiring operator/attendant assistance. In this way, a
single trunk can terminate calls for many different extensions (but not
simultaneously).
DVD+RW Digital Versatile Disk + Read/Write. One of several competing optical storage
standards, supported by a wide range of manufacturers.
HFS Hierarchical File Storage system. Typically a combination of hard disk and
tape drives plus controlling software that automatically migrates little used
files to cheaper storage media.
NAS Network Attached Storage. A term used for RAID, tape and other mass
storage systems which have an integral network connection such as
Ethernet or fibre-channel.
NIC Network Interface Card. An expansion board that you insert into a computer
so the computer can connect to a network. Most NICs are designed for a
particular type of network, protocol, and media, although some can serve
multiple networks.
316 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide
TSAPI
Primary Controller A Verint Contact Recorder that is being shadowed by one or more Standby
Controllers. The Primary will default to "Active" on startup but will ask a
Standby to take over its role if it determines that it cannot record e.g. a disk
fills.
RAID Redundant Array of Inexpensive Disks. RAID controllers use two or more
hard disk drives together for fault tolerance and enhanced performance.
RAID disk drives are used frequently on servers.
Skill Hunt Group A telephone number that is used to route calls to agents on the basis of the
skills needed to handle the call. Agents are assigned to one or more such
skill groups according to their expertise and appropriate calls are routed to
them when they are available.
Slave Recorder A Verint Contact Recorder being controlled by the active Controlling
Recorder. i.e. recording what it is told to record.
Standby Controller A Verint Contact Recorder that shadows a Primary Controller and takes over
its role ("goes active") should the primary fail or appear to fail (e.g. the
standby loses contact with it).
Tagging Adding details to the database of call recordings so that recordings can later
be retrieved by searching through the available data fields.
Trunk A communications link between a PBX and the public central office (CO), or
between PBXs, or between COs.
UTC Universal Time Coordinated. A time scale that couples Greenwich Mean
Time, which is based solely on the Earth's inconsistent rotation rate, with
highly accurate atomic time. When atomic time and Earth time approach a
one second difference, a leap second is calculated into UTC. UTC, like
Greenwich Mean Time, is set at 0 degrees longitude on the prime meridian.
Vector A list of steps that processes calls in a user-defined manner. The steps in a
vector can send calls to splits, play announcements and music, disconnect
calls, give calls a busy signal, or route calls to other destinations. (See also
VDN.)
VoIP Voice over Internet Protocol. A means of transmitting telephone calls over
the packet-switched IP network - as distinct from TDM.
VRU Voice Response Unit. A device that plays voice menus to a caller and
responds to caller instructions entered on a touch tone phone. Also known as
Interactive Voice Response (IVR).
318 Witness ContactStore for Communication Manager Planning, Installation and Administration Guide