While reasonable efforts were made to ensure that the information in this
document was complete and accurate at the time of printing, Avaya Inc.
can assume no liability for any errors. Changes and corrections to the
information in this document may be incorporated in future releases.
Preventing toll fraud
"Toll fraud" is the unauthorized use of your telecommunications system
by an unauthorized party (for example, anyone who is not a corporate
employee, agent, subcontractor, or person working on your company's
behalf). Be aware that there may be a risk of toll fraud associated with
your system and that, if toll fraud occurs, it can result in substantial
additional charges for your telecommunications services.
Avaya fraud intervention
If you suspect that you are being victimized by toll fraud and you need
technical assistance or support, call Technical Service Center Toll Fraud
Intervention Hotline at +1-800-643-2353 for the United States and
Canada. For additional suppo rt telep ho ne num bers, see the Avaya Web
site:
http://www.avaya.com
Select Support, then select Escalation Lists. This Web site includes
telephone numbers for escalation within the United States. For escalation
telephone numbers outside the United States, select Global Escalation
List.
Providing telecommu n ica tio ns secu rit y
T elecommunications security (of voice, data, and video communications)
is the prevention of any type of intrusion to (that is, either unauthorized or
malicious access to or use of) your company's telecommunications
equipment by some party.
Your company's "telecommunications equipment" includes both this
Avaya product and any other voice/data/video equipment that could be
accessed via this Avaya product (that is, "networked equipment").
An "outside party" is anyone who is not a corporate employee, agent,
subcontractor, or person working on your company's behalf. Whereas, a
"malicious party" is anyone (including someone who may be otherwise
authorized) who accesses your telecommunications equipment with
either malicious or mischievous intent.
Such intrusions may be either to/through synchronous (time-multiplexed
and/or circuit-based) or asynchronous (character-, message-, or
packet- based) equipment or interfaces for reasons of:
•Use (of capabilities special to the accessed equipm ent )
•Theft (such as, of intellectual property, financial assets, or
toll-facility access)
•Eavesdropping (privacy invasions to humans)
•Mischief (troubling, but apparently innocuous, tampering)
•Harm (such as harmful tampering, data loss or alteration,
Be aware that there may be a risk of unauthorized intrusions associated
with your system and/or its networked equipment. Also realize that, if
such an intrusion should occur, it could result in a variety of losses to your
company (including, but not limited to, human and data privacy,
intellectual property, material assets, financial resources, labor costs, and
legal costs).
Your responsibility for your company's telecommunications
security
The final responsibility for securing both this system and its networked
equipment rests with you, an Avaya customer's system administrator,
your telecommunications peers, and your managers. Base the fulfillment
of your responsibility on acquired knowledge and resources from a
variety of sources, including, but not limited to:
To prevent intrusions to your telecommunications equipment, you and
your peers should carefully program and configure:
regardless of motive or intent)
•Installation documents
•System administration documents
•Security documents
•Hardware-/software-based security tools
•Shared information between you and your peers
•Telecommunications security experts
•Your Avaya-provided telecommunications systems and their
interfaces
•Your Avaya-provided software applications, as well as their
underlying hardware/software platforms and interfaces
•Any other equipment networked to your Avaya products.
Warranty
Avaya Inc. provides a limited warranty on this product. Refer to your
sales agreement to establish the terms of the limited warranty. In
addition, Avaya’s standard warranty language, as well as information
regarding support for this product, while under warranty, is available
through the following Web site:
http://www.avaya.com/support
Link 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
availability of the linked pages.
Trademarks
Adobe, Adobe Acrobat, and the Adobe logo are registered trademarks of
Adobe Systems, Inc.
Avaya and MultiVantage are trademarks of Avaya, Inc.
CallVisor, DEFINITY, and the Avaya logotype are registered trademarks
of Avaya, Inc.
Internet Explorer is a trademark of SyNet, Inc.
Microsoft, DOS, Windows, Windows NT, Windows 2000, Windows XP,
Win32, and the Microsoft logo are registered trademarks and Windows
for WorkGroups, Windows 95, and Windows 98 are trademarks of
Microsoft.
HP is the registered trademark of the Hewlett-Packard Company.
Netscape Navigator is a registered trademark of Netscape
Communications.
Pentium is a registered trademark of Intel Corporation.
Sun, Sun Microsystems and the Sun logo are registered trademarks and
Java, Solaris, and Solaris SPARC are trademarks of Sun Microsystems,
Inc. in the USA and other countries.
UNIX is a registered trademark in the USA and other countries, licensed
exclusively through X/Open Company Limited.
UnixWare is a registered trademark of the Santa Cruz Operation, Inc. in
the USA and other countries.
All products and company names are trademarks or registered
trademarks of their respective holders.
Avaya support
Avaya provides a telephone number for you to use to report problems or
to ask questions about your contact center. The support telephone
number is 1-800-242-2121 in the United States. For additional support
telephone numbers, see the Avaya Web site:
http://www.avaya.com
Select Support, then select Escalation Lists. This Web site includes
telephone numbers for escalation within the United States. For escalation
telephone numbers outside the United States, select Global Escalation
List.
Comments
To comment on this document, send e-mail to crminfodev@avaya.com
Acknowledgment
This document was written by the CRM Information Development group.
This document focuses on installing Avaya Computer Telephony software and provides
you with:
● Guidelines for using the online A vaya Computer Telephony documents (Preface, see
"Using the Avaya Computer Telephony Documents" on page -19)
● An overview of Avaya Computer Telephony (Chapter 1: Learning About Avaya
Computer Telephony)
● Procedures for implementing Avaya Computer Telephony by administering the switch
and installing the Avaya Computer Telephony software (Chapter 2:
Switch, Chapter 3: Installing Avaya Computer Telephony Server Software, and Chapter
4: Installing Avaya Computer Telephony TSAPI Client Software)
● A description of the software and tool s that Avaya Computer Telephony provides for
developing CTI based applications ( Chapter 5:
JTAPI Client Software, Chapter 7: Using the JTAPI SDK, and Chapter 8: Using the
TSAPI SDK
Using CVLAN, Chapter 6: Installing
Administering the
Reason for Reissue
This document is reissued to ref lect c hanges ass ociated wit h configur ing A v aya Compute r
Telephony in firewall environments that use Network Address Translation or port
redirection.
Issue 1 October 200311
Preface - About This Document
Intended Audience
This document is intended for anyone who is responsib le for i nst al ling and ma int ain ing the
Avaya Computer Telephony software. Additionally, this document assumes that the reader
has the following knowledge or skills.
● A basic understanding of CTI, such as the roles of the swi tch, the server, and client
workstations
● Familiarity with Telecommunications Protocol/Internet Protocol (TCP/IP) addressing
● A working knowledge of Windows NT, Windows 2000 or Windows XP.
● Basic administrative skills on DEFINITY and Multi Appli cation Platform for DEFINITY
(MAPD)
Document Organization
This guide consists of high level conceptual information, task-oriented procedures, and
basic information about Avaya Computer Telephony in general, as summarized in the
following list.
● Preface — “About This Document”
The section you are curren tly reading p rovides you with an orient atio n to the r est of th e
information in this document as well as an introduc tion to online Avaya Computer
Telephony documents that are included on the Avaya Computer Telephony CD ROM
(be sure to read “Avaya Computer Telephony Documents” and familiariz e yoursel f with
the documents).
● Chapter 1: Learning About Avaya Computer Telephony
Use this chapter as a CTI refresher. It provides a conceptual description of the
components (hardware and softwar e) that a Avaya Computer Telephony
implementation comprises.
● Chapter 2: Administering the Switch
Use this chapter for carrying out the switch based administrative tasks that form the
prerequisites for installing the Avaya Computer Telephony software.
● Chapter 3: Installing Avaya Computer Telephony Server Software
Use this chapter for carrying out the tasks associated with installing t he Avaya
Computer Telephony server software.
Use this chapter for both planning and completing the tasks associated with installing
the Avaya Computer Telephony client software. The planning tasks in this chapter
involve determining an effective method for loading multiple clients.
● Chapter 5: Using CVLAN
Use this chapter only if you intend t o use a CVLAN (CallV i sor PC Local Ar ea Networ k)
application.
● Chapter 6: Installing JTAPI Client Software
Use this chapter completing the tasks associated with installing the JTAPI Client
software.
● Chapter 7: Using the JTAPI SDK
Use this chapter to become familiar with the Java Telephony Application Programing
Interface (JTAPI) toolkit that is provided on the Avaya Computer Telephony CD ROM.
● Chapter 8: Using the TSAPI SDK
Use this chapter to become familiar with the Telephony Services Application
Programing Interface (TSAPI) toolkit that is provided on the Avaya Computer
Telephony CD ROM.
Use this appendix to determine the locations of files installed by Avaya Computer
Telephony.
● Appendix B: Administering CTI Links for Definity G3PD
Use this appendix as supplementary info rmation for Chapter 2 (in the context of the
DEFINITY G3 PBX Driver or “G3PD”).
● Appendix D: Pre-Release 11 Link Administration Instructions
Use this appendix only if you are migrating from a NetWare Telephony Server to a
Windows NT, Windows 2000, or Windows XP based server.
Issue 1 October 200313
Preface - About This Document
Conventions Used in This Document
The following conventions are used throughout thi s document.
ConventionExampleUsage
bold monospaceadd stationcharacters that you type exactly
italic monospacemodnamecharacters or variables that you
plain monospacePort:a non-graphic user interface
bold sans-serifStarta mouse selection
as depicted
substitute
(GUI) element such as a field
name.
Product Terminology
Throughout this document the terms "Def init y" and “ Multi Vantage” are used synonymously.
14 Installation Guide
Related Documents
Related Documents
Because Avaya Computer Telephony is a software solution that represe nts the bridge
between switching resources and computing resources, this document assumes that you
already have the components (hardware and sof tware) that Avaya Computer Telephony
joins together or integrates. For this reason, “Related Documents” refer s to both switch
oriented documents as well as the Avaya Computer Telephony documents that
complement this installation guide.
For More Information About Avaya Products and Service
Use the following URLs for more information.
● For information about Avaya products and service, go to http://www.avaya.com
● For product documentation for all Avaya products and relat ed documentation, go to
http://www.avaya.com/support
Switch Oriented Documents
This section describes both “switch specific documents” (for the switch itself) and “switch
interface documents” (for the communications interface between the switch and the
server).
Switch Specific Documents
In the context of this document, the switching element is MultiVantage. The primary
resources for information about MultiVantage are the follo wing CD-ROM libraries.
● Avaya MultiVantage Software on a DEFINITY Server and S8100 Library CD, 555-233-
823
● Avaya MultiVantage S8700 Media Server Library CD, 555-233-824
Issue 1 October 200315
Preface - About This Document
Switch Interface Documents
The communications interface between the switch and the serv er is the DEFINITY LAN
Gateway (which resides in the switch).
● If you use a DEFINITY ECS or Avaya MultiVantage on a DEFINITY Server CSI, the
primary resource for the DEFINITY LAN Gateway running on a Multi Appl ication
Platform for DEFINTY (MAPD) is: DEFINITY ECS and CallVisor ASAI Appl ications over MAPD, 555-230-136 (this document is included on the ASAI Documents CD (585-246-
801).
● If you use a DEFINITY ONE/IP600, the primary resource f or DLG administrati ve tasks is
this document. See "DEFINITY ONE Pre-Administration — Setting Up Your Avaya CT
Configuration" on page -238.
Avaya Computer Telephony Documents
The Avaya Computer Telephony CD ROM provides a comprehensive set of documents
that spans multiple audiences. To give you a better sense of what these documents are
named, where they are located and what purposes they serve, thi s section is further
divided into the following sections.
● Readme Files
● Online Documents
● Document Designations — Icons, Titles, and File Names
● Using the Avaya Computer Telephony Documents
Readme files
The Avaya Computer Telephony CD-ROM includes a set of Readme fi les that supplement
the Avaya Computer Telephony documents. The following list identifies each Readme file
and its location on the Avaya Computer Telephony CD-ROM (The examples below use D:\
as the drive; substitute as appropriate).
Avaya Computer Telephony Documents on Your Desktop depicts a desktop view of the
Avaya Computer Telephony documents that are provided on the Avaya Computer
Telephony CD ROM. If you elected to install the documents on your PC, you can view the
Avaya Computer Telephony document icons from your desktop (click Start, point to
Programs, Avaya Computer Telephony, Documents).
Avaya Computer Telephony Documents on Your Desktop
Related Documents
Issue 1 October 200317
Preface - About This Document
Document Designations -- Icons, Titles, and File Names
The purpose of this section is to famili arize you wit h the var ious designat ions that are used
for the Avaya Computer Telephony documents. The previous section identi fies the desktop
icons for each document. This section associates those icons with the formal document
title, and the document file name. The document file name is a convenient document
handle that appears in the footer of most of the Avaya Computer Telephony documents.
Avaya Computer Telephony Document Icons, Titles and File Names
IconTitleFile Name
Installation
Guide
Telephony
Services
Admin. and
Maintenance
G3PBX Driver
and CVLAN
Admin. and
Maintenance
Guide
DEFINITY
ECS
Programmer’s
Guide
Avaya
MultiVantage
Simulator
User’s Gu ide
CSDI
Programmer’s
Reference
Avaya Computer Telephony 1.3
Installation Guide
Avaya Computer Telephony 1.3
Telephony Services Administration and
Maintenance Guide
Avaya Computer Telephony 1.3
G3 PBX Driver and CVLAN Administration
and Maintenance Guide
Avaya Computer Telephony 1.3
Telephony Services Appli cation
Programming Interface (TSAPI) for
Avaya
● Avaya Computer Telephony Java Telephony API (JTAPI) Programmer’s Reference
(JTAPI.PDF)
● Avaya Computer Telephony Java Telephony API (JTAPI) for Avaya MultiVantage
Programmer’s Reference (JCLI.PDF)
20 Installation Guide
Customer Support
For questions about Telephony Services, Tserver operation, or the DEFINITY G3 PBX
Driver, customers can call the National Customer Care Center at:
1 800 344 9670
Customer Support
Issue 1 October 200321
Preface - About This Document
22 Installation Guide
Chapter 1:Learning About Avaya Computer
Telephony
Use this chapter to familiarize yourself with basic Computer Telephony Integration (CTI)
concepts and the capabilities of Avaya Computer Telephony as an implementation of CTI.
This chapter contains the following sections:
● What is CTI? on page 24
● The Essential Components of a CTI System on page 26
● A Typical Avaya Computer Telephony Configuration on page 27
● Avaya Computer Telephony Components on page 29
● A Closer Look at the Essential Avaya Computer Telephony Components on page 30
● Security Issues on page 31
● Private Data and Client Applications on page 35
● Implementing a Firewall Strategy
Issue 1 October 200323
Learning About Avaya Computer Telephony
What is CTI?
In simplest terms, CTI r efers to the integrati on of your tel ephone (voice) and PC application
(data) for intelligent and effec tive call processing. This integration is achieved logically, and
no physical connection is requi red between your telephone and the PC — the CTI software
performs the integration.
What is Avaya Computer Telephony?
Avaya Computer Telephony is call-center oriented Computer Telephony Integration (CTI)
software that runs on Microsoft Windows NT, Windows 2000, or Windows XP.
What Does Avaya Computer Telephony Do?
Avaya Computer Telephony acts as an enabl er of CTI applications. It pro vides appli cation s
with the ability to monitor and control resources in a telephone network, via a set of library
routines and function calls. A vay a Computer Telephony presents a pro grammatic in terfac e
that provides a common ground for computing resources to interact with switching
resources. More specifically, Avaya Computer Telephony is a telephony server that
supports multiple telephony APIs.
What APIs Does Avaya Computer Telephony Support?
Avaya Computer Telephony supports the following APIs
● Telephony Services Application Program Interface (TSAPI)
The next three sections provide more information about each API.
TSAPI
TSAPI is a telephony services API based on the ECMA (European Computer
Manufacturers Association) CSTA (Computer-Supported Telecommunication Applications)
standard.
24 Installation Guide
JTAPI
JTAPI is a portable, object oriented API for Java-based computer telephony applications.
Through JTAPI, Java applications can access and contr o l switch resources. See Chapter
7: Using the JTAPI SDK for more information about JTAPI.
CallVisor PC
CallVisor PC is a proprietary API for applications that use the Adjunct/Switch Application
Interface (ASAI). See Chapter 5:
and CVLAN (CallVisor PC LAN).
What is CTI?
Using CVLAN for more information about CallVisor PC
Issue 1 October 200325
Learning About Avaya Computer Telephony
The Essential Components of a CTI System
Although a CTI implementation c an t ake many f or ms, Figur e 1-1 depicts a simple model of
CTI in terms of Avaya Computer Telephony components. This model depicts a DEFINITY
switch that relies on the Adjunct Switch Application Interface (ASAI) to effect
communications with adjuncts ( such as the Avaya Computer Telephony server).
Figure 1-1: Essential Components of Avaya Computer Telephony — A High Level
View
Switch
DEFINITY
ECS
ASAI
Phone Line
Server
Avaya CT Server
Telephony
Services
Software
Client
TSAPI
Client
Agent
Workstation
Agent
Telephone
26 Installation Guide
A Typical Avaya Computer Telephony Configuration
A Typical Avaya Computer Telephony Configu r ation
This section provides a high-level description of the hardware and software components
used in a typical Avaya Computer Telephony configuration.
Hardware Components in a Typical Implementation of Avaya
Computer Telephony
The basic hardware components in a typic al Avaya Computer Telephony configuration are
as follows.
● DEFINITY Switch configured with ASAI
The DEFINITY switch is a device that processes calls (in coming, outgoing, and
internal) and connects them to the proper destinations.
In the context of Avaya Computer Telephony, the role of the DEFINITY switch
changes. In a Avaya Computer Telephony implementation, the DEFINITY switch
“hands off” call monit oring and c all cont rol f uncti ons to the Avaya Computer Telephony
server (or the adjunct processor). The means of effecting this handoff is the Adjunct
Switch Application Interface — ASAI.
To support Avaya Computer Telephony, the DEFINITY switch must be configured with
Adjunct Links or an ASAI Interface. DEFINITY switches that support CTI are as
follows.
- DEFINITY CSI, Si, and R (running software release G3V4 or later), Avaya
MultiVantage on a DEFI NITY Server CSI, SI, and R, and Avaya Mul tiVantage S8700
configurations
Note:
Note:G3V4 requires a field maintenance release.
- DEFINITY ONE/IP600 Release 2 (R2), or later, and Avaya MultiVantage S8100
configurations
● DEFINITY LAN Gateway
The DEFINITY LAN Gateway, or DLG, is software that acts as a transport mechanism
that allows the DEFINITY switch to co mmunicate with the Avaya Computer Telephony
server. It is required for all Avaya Computer Telephony implementations.
- DEFINITY CSI, Si, and R (running software release G3V4 or later), Avaya
MultiVantage on a DEFI NITY Server CSI, SI, and R, and Avaya Mul tiVantage S8700
configurations use a Multi-Application Platform for DEFINTY (MAPD) based DLG.
Issue 1 October 200327
Learning About Avaya Computer Telephony
- DEFINITY ONE/IP600 and Avaya MultiVantage S8100 configurations use the CoResident DLG (without a MAPD board).
● Avaya Computer Telephony Server
The adjunct processor that performs call monitoring and control functions, security
database functions, and link management. Avaya Computer Telephony runs on
Windows NT, Windows 2000, or Windows XP.
● Avaya Computer Telephony Client Workstations
Client workstations run the applications that interact with the Avaya Computer
Telephony server.
28 Installation Guide
Avaya Computer Telephony Components
Avaya Computer Telephony Components
The Avaya Computer Telephony CD ROM contains the following software components:
● Security Database for Telephony Services (Used by Telephony Services for client
authentication; it is not used by CVLAN.)
● Telephony Services Server (Tserver) Software
● Telephony Services Client Software
- Windows NT, Windows 2000, or Windows XP
- UnixWare
- Solaris S parc
- HP-UX
● CVLAN Server
● CVLAN Clients
- UNIX
- Solaris x86
- Solaris S parc
- Windows NT, Windows 2000 or Windows XP
- IBM Advanced Interactive Executive (AIX)
● DEFINITY Driver (G3 PBX Driver)
● TSAPI Software Development Kit (SDK)
● JTAPI SDK
● CVLAN SDK
● Online Avaya Computer Telephony documents and Adobe Acrobat Reader
Issue 1 October 200329
Learning About Avaya Computer Telephony
A Closer Look at the Essential Avaya Computer
Telephony Components
The view of Avaya Computer Telephony depicted by Figure 1-2 includes the some of the
major components described in ‘‘A Typical Avaya Computer Telephony Configuration’’ on
page 27, to give you a better sense of wher e the component s are and how they operat e at
a schematic level.