Cybertech Cisco Active IP Integration Manual 2.0
Cybertech Cisco Active IP Integration Manual 2.0
Cybertech Cisco Active IP Integration Manual 2.0
Active IP Recording
INTEGRATION MANUAL
Version: 2.0
Date: 16-12-2009
Reference: CT-R5-CTI-CIS-LB
Copyright © 2009 by CyberTech International
All rights reserved. No part of this publication may be reproduced or
transmitted in any form or by any means, electronic or mechanical,
including photocopy, recording, or any information storage and retrieval
system, without prior written consent of CyberTech International.
Trademark Acknowledgements
Cisco Systems, the Cisco logo, and the Cisco Systems logo are trademarks
or registered trademarks of Cisco Systems, Inc. and/or its affiliates in the
United States and certain other countries.
AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks
or registered trademarks of Advanced Micro Devices.
1 Introduction .............................................................................................7
1.1 About this Manual........................................................................................ 7
1.2 Scope ............................................................................................................. 7
1.2.1 Recording Methods..................................................................... 7
1.2.2 CyberTech Recording System ................................................... 7
1.2.3 Cisco Software ............................................................................. 7
1.2.4 Cisco Active IP Installer Kit.......................................................... 8
1.3 Intended Audience ..................................................................................... 8
1.4 Assumptions .................................................................................................. 8
1.5 Conditions for Installation ........................................................................... 8
1.6 Reference Manuals ..................................................................................... 8
1.7 Conventions and Symbols.......................................................................... 9
2 Safety .....................................................................................................11
2.1 General Safety Rules ................................................................................. 11
2.2 ESD Precautions.......................................................................................... 11
5 Prerequisites ..........................................................................................27
5.1 Customer Prerequisites.............................................................................. 28
5.2 Cisco Prerequisites ..................................................................................... 28
5.3 CyberTech Prerequisites ........................................................................... 28
5.3.1 Preconditions.............................................................................. 29
5.3.2 Preparatory Steps ...................................................................... 29
5.4 Installing Parrot-DSC Firmware ................................................................. 30
5.5 Licensing ...................................................................................................... 32
5.5.1 Cisco Licensing .......................................................................... 32
5.5.2 CyberTech Licensing................................................................. 32
5.5.3 Loading License Information ................................................... 32
5.6 Adding Cisco Call Data (Extrafields) ...................................................... 35
5.7 Updating the File CTI_receiver.exe ......................................................... 36
6 Installation .............................................................................................41
6.1 Installing the CT Cisco CTI Integration Software ................................... 41
6.1.1 Configuration with Dedicated CTI Server ............................. 42
6.1.2 Stand-alone Installation............................................................ 46
6.2 Post Installation Copying .......................................................................... 48
6.3 Setting Up the Secure SIP Trunk ............................................................... 48
6.3.1 Download Certificate ............................................................... 49
6.3.2 Generate Certificates............................................................... 49
6.3.3 Load Certificate in CUCM........................................................ 50
7 Configuration ........................................................................................65
7.1 Linking Targets to Users.............................................................................. 65
7.2 Logging On to the CT Web GUI............................................................... 65
7.3 Defining Channel Groups......................................................................... 67
7.4 Configuring the Cisco Link Controllers ................................................... 69
7.5 Defining Targets.......................................................................................... 73
7.5.1 Adding a New Target ............................................................... 73
7.5.2 Monitoring Target States........................................................... 75
7.6 Specifying Cisco Call Data ...................................................................... 76
In the Cisco Active IP recording system, calls are duplicated from the
extension and streamed via the Cisco PBX to the recording system. These
duplicated audio stream sessions are initiated by Cisco 3rd generation
phones with ‘Built-in-Bridge’ (BIB).
Call details are read from the Cisco JTAPI interface which is used for the
Cisco recording facility. The JTAPI interface also initiates recording start.
1.2 Scope
The Cisco/CTI integration as described in this manual is restricted to
specific recording methods and software versions. They are described
below.
Please verify the correct versions (and the applicable Service Repair) of
the CT Recording System with your CT contact person (consult Appendix D
‘Troubleshooting’ for contact details).
When you want to upgrade from installer kit 3.1.x, contact your CT contact
person about the specific procedure to follow (consult Appendix D
‘Troubleshooting’ for contact details).
1.4 Assumptions
It is assumed that the reader has knowledge about the following:
● CyberTech Recording System:
● Version 5.4 or higher
● Version 5.3 with Service Repair 5.3.2
● CyberTech CTI Integration
The manual version shown in the Version column is the version minimally
required. Higher versions may also be applicable.
This chapter describes the general safety rules and specific ESD
precautions to be taken into account.
When handling printed circuit boards always take the following preventive
measures:
● Keep printed circuit boards as long as possible in their protective
bags.
● Use an anti-ESD bracelet. The sign on the left of this block of text
indicates when ESD-protective measures are required.
3.2.2 Workstation
The client’s workstation requires the following to run the CyberTech Web
GUI (see chapter 7 ‘Configuration’ for details):
● Microsoft Internet Explorer 6.0 with JavaScript enabled
● Minimum screen resolution of 1024x768 for correct display
Call data is transferred to the CTI server via the Cisco JTAPI Server.
3.4.1 Features
The following features are supported:
Feature Supported Not Remarks
supported
Ad hoc Recording
(Application Invoked
Recording)
Automatic Recording
CUCM Cluster
CUCM Fail-over
Encryption (SRTP) Under development (for
CUCM 8)
Device Mobility
Extension Mobility For all phones to which a
user can log on, the
following preconditions
apply:
‘Built-in-Bridge’ support
CTI controlled device
Device ID in Controlled
Devices list of application
user (see Appendix C
‘Cisco Configuration
Settings’)
Record on Demand
Recording Warning Tone Configurable
SCCP (Skinny)
3.4.6 Codecs
The following codecs are supported:
Codec Supported Not Remarks
supported
G711
G729
G722* Default Cisco codec
Supported by CUCM 6.1.2 (or higher)
Supported by Cisco Active IP installer kit 3.2
(or higher)
G723.1 Not supported by Cisco
Other Not supported
codecs
Table 7: Supported codecs
This integrated recording system is built around the Cisco Unified Call
Manager and the CyberTech CTI Server-based Recording System.
The CUCM recording features are invoked through CTI using JTAPI and the
Session Initiation Protocol (SIP).
CTI Server
● Software: CT Cisco CTI Integration Software
Core Server/Recording Channels (max. 168 recording channels)
● Software: CT recording software 5.3 (or higher)
● Parrot-DSC Cards: See section 4.3.2
CTI Server
● Software: CT Cisco CTI Integration Software
Core Server
● Software: CT 5.3 (or higher) recording software
● Parrot-DSC Cards: See section 4.3.3
Satellite(s) (1 satellite serves up to 480 recording channels)
● Software: CT 5.3 (or higher) recording software
● Parrot-DSC Cards: See section 4.3.3
Server hardware
A distinction is made between configurations in which up to 64 and 128
channels can be monitored.
Up to 64 channels:
● Processor:
● Intel Xeon Dual Core 2.0 GHz
● AMD Opteron 2.2 GHz
● RAM: 2 GB
Up to 128 channels:
● 2 Processors:
● Intel Xeon Dual Core 2.0 GHz
● AMD Opteron 2.2 GHz
● RAM: 2 GB
Server hardware
● Processor:
● Intel Xeon Quad Core 2.0 GHz
● AMD Opteron 2.4 GHz
● RAM: 2 GB
Server hardware
A distinction is made between configurations in which up to 240 and 480
channels can be monitored.
Up to 480 channels:
● 2 Processors:
● 2 x Intel Xeon Quad Core 2.0 GHz
● 2 x AMD Opteron 2.4 GHz
● RAM: 4 GB
4.4.3 Satellite
● CT Recording Software 5.3 (or higher)
● Parrot-DSC Card firmware: CTI_VOX_VoIP_16 or higher
(Consult the firmware history for details.)
Before you install the Parrot-DSC firmware (see below), do the following:
● For all Parrot-DSC cards, verify that you have firmware version
CTI_VOX_VoIP_16 available (see previous section). If not, download
the firmware from www.cybertech-int.com.
● Consult the CT Recording Solutions R5 - Installation Manual and Parrot-
DSC Installation Manual for details about Parrot-DSC Cards and the
associated firmware.
Instructions
1. First, verify that you are using the latest firmware (see notes above).
2. If the firmware version on the website is more recent than the one
installed, download it to a specified location on your local system.
3. Start the Monitor Tool by clicking the shortcut on your desktop. The
following window appears:
Instructions
1. Start the Monitor Tool by clicking the shortcut on your desktop. The
following window appears:
6. Verify that the field Data12 starts with the string “8019” to indicate a
SIP Server Link Controller license:
And the field Data12 starts with the string “8015” to indicate a JTAPI
Link Controller license:
To accomplish this, you have to copy the files ‘extrafields.ini’ from the CD
to the folder ‘C:\Program Files\cybertech\INI_files’.
The new version is delivered with version 3.2 of the ‘Cisco Active IP’ installer
kit (see section 5.3.1 ‘Preconditions’).
Instructions
1. Open the command window.
2. Go to the folder where the file 'cti_receiver.exe' resides. (The default
location is: ‘C:\Program Files\cybertech\cti_receiver’.)
3. Execute the following command to uninstall the current version:
cti_receiver2.exe –u
(Use all lower case characters.)
4. Rename this current version to ‘cti_receiver2.exe.old’.
5. Copy the new ‘CTI_receiver.exe’ (and all other files that are located
in the same directory as this file) to the directory ‘C:\Program
Files\cybertech\CTI_receiver’.
(Consult section 5.3.1 ‘Preconditions’ for version information.)
6. Execute the following command to install the new version:
cti_receiver.exe –I
(Use the upper case version of the character 'I' (= "Install").)
7. Restart the pc.
8. After a system restart, activate the Monitor Tool by clicking the
shortcut on your desktop. The following window appears:
9. Verify that the CTI receiver service has been started automatically. It
should have the suffix “(auto)” and the value “Service running” as
shown below:
Instructions
1. Run the 'Cisco Active IP' installation kit from a local drive or CD. The
Setup Wizard appears:
The Secure SIP Trunk feature is supported for CUCM 7 and higher.
The procedure is subdivided into six main steps. Some of these steps are
performed by a CyberTech installation engineer, others by a Cisco-
certified engineer. These main steps comprise:
1. Download certificate from CUCM (by Cisco-certified engineer)
2. Generate certificates (by CyberTech engineer)
3. Load certificate in CUTM (by Cisco-certified engineer)
4. Install certificate on SIP Server system (by CyberTech engineer)
5. Configure SIP Server (by CyberTech engineer)
6. Configure CUCM (by Cisco-certified engineer)
Prerequisite
The Cisco Active IP installation kit (see previous section) has placed the so
called ‘security kit’ in the folder 'C:\Program
Files\cybertech\CTI\SipServer\security':
7. Click Browse, and browse to the security folder of the Sip Server.
6. Click Browse, and browse to the security folder of the Sip Server.
7. In the drop down box next to the field Files of type:, select the file type
"Personal Information Exchange (*.pfx, *.p12)":
13. The correct destination should already be selected, so click Next. The
following window is displayed:
14. Click Finish to start the import process. After successful import, the
following message is displayed:
Before starting with the configuration, verify that the CTI Receiver is
enabled on the Core Server.
Consult the CTI Manual for details about the necessary steps to link targets
to users.
The CT Web GUI contains various options (grouped into tabbed menus, or
‘tabs’ for short) to configure and use the Cisco/CTI recording solution.
In the configuration examples, the Web GUI of CyberTech PRO version 5.3
is used. The Web GUI of CyberTech MYRACLE is similar.
Instructions
1. In the browser window's address bar, type the IP address of the
recorder or – when accessing from the recorder itself – type
'http://localhost'.
2. Type the user name and password. (Both with Administrator rights.)
3. Click the > button to the right of the Password field. The main window
of the Web GUI appears.
Instructions
1. In the Web GUI, click the tabs system configuration > channel groups.
The window Overview of all channel groups appears:
* When using more than one PBX system, specify the channel numbers
you want to include in the group. Otherwise, include all channels.
5. Click the Add record button to save the channel group and close the
entry window.
6. Note that the newly created channel group is added to the list:
Instructions
1. Click the cti integration > devices tabs to display a list of all currently
installed link controllers:
2. Verify that the names of the Cisco link controller and SIP Server link
controller are displayed in the device overview.
3. Click the Cisco link controller. A window with corresponding device
and connection settings appears:
6. Click the Save changes button to return to the Device overview. Note
that the Cisco link controller is now enabled.
10. If you use Secure SIP Trunk, select the checkbox SSL enabled. The
other fields remain empty.
11. Click the Save changes button to return to the Device overview. Note
that the SIP Server link controller is enabled as well.
Instructions
1. Click the cti integration > targets tabs to display a list of all currently
defined targets (if any).
2. Click the + button to add a new target in the Add target window.
2. Select the value “All” in both fields Devices and Target types.
3. Verify that the actual monitoring state for the newly created targets is
shown in the Target state column (see red rectangle in the figure
above).
The applicable target state values have the following meanings:
● None: The target has not (yet) been passed to the link controller.
● Selecting: The link controller is registering the target at the PBX.
● Selected: The target is registered and monitored.
In the Web GUI, you specify which call data you want to use in your
recordings.
Instructions
1. From the main window, click the recorded calls > column selection
tabs. The selection overview window opens:
A.1 Abbreviations
Item Description
BIB Built-in-Bridge
CCLC Call Controller Link Controller protocol
CN Common Name
CSTA Computer Supported Telephony Applications. Standardised link protocol,
used to transfer CTI information
CTI Computer Telephony Integration
CTRS CyberTech Recording System
DLU Device License Unit
DSC Digital Selective Calling
ESD Electrostatic Discharges
GUI Graphical User Interface. A user interface based on graphics (icons and
pictures and menus) instead of text.
IP Internet Protocol
JTAPI Java Telephony Application Interface
PBX Private Branch eXchange. Telephone system in an organisation.
PSTN Public Switched Telephone Network
SCCP Skinny Client Control Protocol (Cisco proprietary protocol)
SIP Session Initiation protocol
SRST Survivable Remote Site Telephony
SSL Secure Socket Layer
TCP Transmission Control Protocol
TLS Transport Layer Security
UDP User Datagram Protocol
VoIP Voice over Internet Protocol
Table 11: Abbreviations
Each step refers to the associated section in this manual where you can
find additional information.
The CyberTech contact person must make sure that the CyberTech
installation engineer has a copy of the required installation or upgrade
data on a CD.
No Step Section
Installation
1. Install Parrot-DSC Cards 5.3
2. Install Parrot-DSC firmware 5.4
3. Load license information 5.5
4. Add Cisco-specific call data 5.6
5. Update CTI_Receiver .exe 5.7
6. Install CT Cisco CTI Integration Software 6.1
7. Perform post-installation copying 6.2
8. Setting up Secure SIP Trunk 6.3
Configuration
9. Link users to targets 7.1
10. Define a channel group in the recorder 7.3
11. Configure the Cisco Link Controllers 7.4
12. Define targets 7.5
Table 13: Quick Install Reference
Consult the 'CTI OS Hardening Manual' for details about port configuration.
FAQs
Consult www.cybertech-int.com for an overview of frequently asked
questions.
Contact information
When encountering any problems during system installation/configuration
and/or testing, please refer to:
1. Your local installation partner
2. CyberTech International – Global Support:
[email protected] or +44 203 147 4997