Avaya 1 3 Users Manual 1c_install

1.3 to the manual f1a19aa4-047a-4290-8e69-68c5bd42743c

2014-12-13

: Avaya Avaya-1-3-Users-Manual-122046 avaya-1-3-users-manual-122046 avaya pdf

Open the PDF directly: View PDF .
Page Count: 256

Download
Open PDF In Browser	View PDF

Avaya Computer Telephony
Release 1.3
Installation Guide

Issue 1
October 2003

© 2003 Avaya Inc.
All Rights Reserved.
Notice
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 support telephone numbers, see the Avaya Web
site:
http://www.avaya.com
Select Support, then select Escalation Lists. This Web site includes
telephone numbers for escalation within the United States. For escalation
telephone numbers outside the United States, select Global Escalation
List.
Providing telecommunications security
Telecommunications security (of voice, data, and video communications)
is the prevention of any type of intrusion to (that is, either unauthorized or
malicious access to or use of) your company's telecommunications
equipment by some party.
Your company's "telecommunications equipment" includes both this
Avaya product and any other voice/data/video equipment that could be
accessed via this Avaya product (that is, "networked equipment").
An "outside party" is anyone who is not a corporate employee, agent,
subcontractor, or person working on your company's behalf. Whereas, a
"malicious party" is anyone (including someone who may be otherwise
authorized) who accesses your telecommunications equipment with
either malicious or mischievous intent.
Such intrusions may be either to/through synchronous (time-multiplexed
and/or circuit-based) or asynchronous (character-, message-, or
packet-based) equipment or interfaces for reasons of:
•
Use (of capabilities special to the accessed equipment)
•
Theft (such as, of intellectual property, financial assets, or
toll-facility access)
•
Eavesdropping (privacy invasions to humans)
•
Mischief (troubling, but apparently innocuous, tampering)
•
Harm (such as harmful tampering, data loss or alteration,
regardless of motive or intent)
Be aware that there may be a risk of unauthorized intrusions associated
with your system and/or its networked equipment. Also realize that, if
such an intrusion should occur, it could result in a variety of losses to your
company (including, but not limited to, human and data privacy,
intellectual property, material assets, financial resources, labor costs, and
legal costs).
Your responsibility for your company's telecommunications
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:
•
Installation documents
•
System administration documents
•
Security documents
•
Hardware-/software-based security tools
•
Shared information between you and your peers
•
Telecommunications security experts
To prevent intrusions to your telecommunications equipment, you and
your peers should carefully program and configure:
•
Your Avaya-provided telecommunications systems and their
interfaces
•
Your Avaya-provided software applications, as well as their
underlying hardware/software platforms and interfaces
•
Any other equipment networked to your Avaya products.

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.

Avaya Computer Telephony
Release 1.3
Installation Guide

Contents
Preface - About This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reason for Reissue . . . . . . . . . . . . . . . . . . .
Intended Audience . . . . . . . . . . . . . . . . . . . .
Document Organization . . . . . . . . . . . . . . . . .
Conventions Used in This Document . . . . . . . . . . .
Product Terminology . . . . . . . . . . . . . . . . . . .
Related Documents . . . . . . . . . . . . . . . . . . .
For More Information About Avaya Products and Service .
Switch Oriented Documents . . . . . . . . . . . . . . .
Switch Specific Documents . . . . . . . . . . . . . .
Switch Interface Documents. . . . . . . . . . . . . .
Avaya Computer Telephony Documents . . . . . . . . .
Readme files . . . . . . . . . . . . . . . . . . . . .
Online Documents . . . . . . . . . . . . . . . . . .
Document Designations -- Icons, Titles, and File Names
Using the Avaya Computer Telephony Documents . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
Customer Support . . . . . . . . . . . . . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

11
12
12
14
14
15
15
15
15
16
16
16
17
18
19
21

Chapter 1: Learning About Avaya Computer Telephony . . . . . . . . . . . . . . . .

What is CTI? . . . . . . . . . . . . . . . . . . . . .
What is Avaya Computer Telephony? . . . . . . . .
What Does Avaya Computer Telephony Do? . . . . .
What APIs Does Avaya Computer Telephony Support?
TSAPI . . . . . . . . . . . . . . . . . . . . . .
JTAPI . . . . . . . . . . . . . . . . . . . . . .
CallVisor PC . . . . . . . . . . . . . . . . . . .

.
.
.
.
.
.
.
The Essential Components of a CTI System . . . . . . .
A Typical Avaya Computer Telephony Configuration . . .

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
Hardware Components in a Typical Implementation of Avaya Computer Telephony .
Avaya Computer Telephony Components . . . . . . . . . . . . . . . . . . . . .
A Closer Look at the Essential Avaya Computer Telephony Components . . . . . .
Security Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

Security — DEFINITY Servers CSI, SI, R
and S8700 Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Isolating the DEFINITY LAN Gateway . . . . . . . . . . . . . . . . . . . . . . . .
Security — DEFINITY ONE/IP600and Avaya MultiVantage S8100 Configurations . . . .
Implementing a Firewall Strategy . . . . . . . . . . . . . . . . . . . . . . . . . . . .

24
24
24
24
24
25
25
26
27
27
29
30
31
31
31
33
34

Issue 1 October 2003

Contents
Private Data and Client Applications . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 2: Administering the Switch. . . . . . . . . . . . . . . . . . . . . . . . . . .

Scope of this Chapter . . . . . . . . . . . . . . . .
Hardware and Software Components . . . . . . . . .
Using the Information in this Chapter . . . . . . . . .
Activating Software Features — RFA and License Files
License Files . . . . . . . . . . . . . . . . . . . .
License File and Optional Features Forms . . . . . .

.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
Administrative Tasks for Avaya Platforms That Use the MAPD
.
Setting Up Your LAN for Avaya Computer Telephony . . . .
.
Server LAN Segment (connectivity to the switch) . . . . .
.
IP Addresses. . . . . . . . . . . . . . . . . . . . . .
.
Client LAN Segment . . . . . . . . . . . . . . . . . .
.
Guidelines for Setting Up a Private LAN . . . . . . . . .
.
If You Intend to Use Host Names . . . . . . . . . . . .
.
Task 1: Administering a Link . . . . . . . . . . . . . . . .
.
Task 2: DLG Administration . . . . . . . . . . . . . . . .
.
Administrative Tasks for Avaya Platforms That Use the Co-Resident DLG .
CTI Link Administration on Configurations with Processor Connectivity .
CTI Link Administration on Configurations with CLAN Connectivity . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

37
38
39
40
40
40
41
42
42
42
43
43
43
44
47
53
54
56

Chapter 3: Installing Avaya Computer Telephony Server Software . . . . . . . . . .

Planning Your Installation . . . . . . . . . . . . . . . . . . . . . . .
Gather the Necessary Information . . . . . . . . . . . . . . . . .
Determine the Requirements of Your Configuration . . . . . . . . .
Determine the Type of Installation -- Initial Installation or Upgrade . .
Make Sure Your Platform Can Support Avaya Computer Telephony .
Avaya Computer Telephony Hardware and Software Requirements . .
Guidelines for Upgrading Avaya Computer Telephony . . . . . . . . .
Other Things to Consider for an Upgrade . . . . . . . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

Specialized Installations . . . . . . . . . . . . . . . . . . . . . . .
Before You Install the Avaya Computer Telephony Server Software . . .
Avaya Computer Telephony Installation Guidelines . . . . . . . . . . .
Procedure for Initial, Default Installation of Avaya Computer Telephony Server Software
Perform Initial Restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Desktop Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Basic Maintenance Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Starting and Stopping the Telephony Services Software . . . . . . . . . . . . . . .
Starting Telephony Services . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enabling Automatic Startup and Recovery . . . . . . . . . . . . . . . . . . . .
Manually Stopping Telephony Services
. . . . . . . . . . . . . . . . . . . .
Removing Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Procedure to Remove Programs . . . . . . . . . . . . . . . . . . . . . . . .
Reinstalling Telephony Services
Server Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4 Installation Guide

60
61
61
61
61
62
64
65
66
67
68
70
85
86
87
87
88
89
89
90
90
90

Contents

Chapter 4: Installing Avaya Computer Telephony TSAPI Client Software . . . . . . .

. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .

94
94
96

. . . . . . . . . . . . . .

. . . . . . . . . . . . . .
. . . . . . . . . . . . . .

97
97

Avaya Computer Telephony Clients and Private Data Versions
Planning Your Installation . . . . . . . . . . . . . . . . . .
TSAPI Client Hardware and Software Requirements . . . . .
Avaya Computer Telephony Client Hardware and
Software Requirements
. . . . . . . . . . . . . . . .
UnixWare Client Hardware and
Software Requirements
. . . . . . . . . . . . . . . .
HP-UX Client Hardware and Software Requirements . . . .
TSAPI Solaris Client Hardware and
Software Requirements
. . . . . . . . . . . . . . . .
Telephony Services Client Software
. . . . . . . . . . .
Telephony Services Client Platforms
. . . . . . . . . .
Client Administration Software Components
. . . . . . .
Client Administration Workstation . . . . . . . . . . . .

.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

97
98
98
99
99
100
101
108
108
109
110
111
112
112
112
114
116
116
118
119
119
119
120
120

Chapter 5: Using CVLAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

121

Before You Install the Avaya Computer Telephony TSAPI Client Software
Installing the Windows Client Software
. . . . . . . . . . . . . .
Installing the Windows Client Software from a Network Drive . . . . .
Setting Up Multiple Clients . . . . . . . . . . . . . . . . . . . .
Verifying 32-bit Client Software Installation . . . . . . . . . . . .
Installing TSAPI Solaris Sparc Client Software . . . . . . . . . . . . .
Verifying TSAPI Solaris SPARC Client Software Installation . . . . .

.
.
.
.
About Installing HP-UX Client Software
.
Installing HP-UX Client Software
. . . .
Editing the Template File -- tslibrc . . . .

.
.
.
.
.
.
.
Removing Telephony Services Client Software .
Removing Windows 32-Bit Client Software . .
Removing TSAPI Solaris Client Software . .
Removing UnixWare Client Software . . . .
Removing HP-UX Client Software . . . . .
Installing UnixWare Client Software
Installing from Command Line .
Installing from the CD . . . . .
Installing from Diskette
. . . .

.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

Overview . . . . . . . . . . . . . . . . . . . .
Implementing CVLAN and Telephony Services . . .
The CVLAN Server . . . . . . . . . . . . . . . .
CVLAN Administration Guidelines for Sharing Links
Before You Administer CVLAN Clients . . . . . . .
Basic CVLAN Client Administration . . . . . . . .
Adding a CVLAN Client . . . . . . . . . . . . .
Removing a CVLAN Client. . . . . . . . . . . .
Editing a Client . . . . . . . . . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

122
123
125
126
127
127
128
130
131

Issue 1 October 2003

Contents
Starting the CVLAN Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Starting the CVLAN Server with the
Telephony Services Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Starting the CVLAN Server from the Windows Operating System . . . . . . . . . . . .

132

.
.
.
.

132
133
135
135
136
136
136
137
138
138
141
141

.
.
.
.
.
.
.
.
.
.
.
.
.
.

142
142
143
144
144
144
144
146
146
146
147
147
147
147

Chapter 6: Installing JTAPI Client Software . . . . . . . . . . . . . . . . . . . . . . .

149

Stopping the CVLAN Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Stopping CVLAN with the Telephony Services Controller . . . . . . . . . . . . . . . .
Stopping the CVLAN Service from the Windows Operating System . . . . . . . . . . .
CVLAN Client Hardware and Software Requirements . . . . . . . . . . . . . . . . . .
CVLAN Client Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CVLAN Client Platforms
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installing CVLAN Client Software . . . . . . . .
Installing Windows Client Software . . . . . .
Verifying Windows Client Software Installation
Installing Solaris SPARC Client Software . . .
Verifying Solaris SPARC
Client Software Installation . . . . . . . . .
Installing Solaris x86 Client Software . . . . . .
Verifying Solaris x86 Client Software Installation
Installing AIX CVLAN Client Software . . . . .
Installing UnixWare Client Software
. . . . .
Installing from the Command Line . . . . . .
Installing from the CD . . . . . . . . . . .
Verifying UnixWare Client Software Installation
Removing CVLAN Client Software . . . .
Uninstalling Windows Client Software
.
Removing Solaris SPARC Client Software
Removing AIX Client Software
. . . .
Removing UnixWare Client Software . . .

. . .
. . .
. .
. . .
. . .
CVLAN Software Development Kit . . . . . . .

JTAPI Client Packaging .
SET 1 . . . . . . . .
SET 2 . . . . . . . .
SET 3 . . . . . . . .

.
.
.
.

.
.
.
.
Installing the JTAPI Client Software in the Windows Environment .

.
.
.
.
.

Manually Installing the
JTAPI Client Software (Special Cases) . . . . . . . . . . . . . . . . . . . . . . . . .
Setup for Running JTAPI
Applets or Applications on a Client . . . . . . . . . . . . . . . . . . . . . . . . . .
Setup for Running JTAPI Applets
in a Browser from a Web Server
. . . . . . . . . . . . . . . . . . . . . . . . . .

149
149
150
150
151
157
157
157

Chapter 7: Using the JTAPI SDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

159

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Components of the JTAPI SDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

159
160

6 Installation Guide

Contents
Installing the JTAPI SDK . . . . . . . . . . . . .
Private Data Versions Supported . . . . . . . . .
Java Client Hardware and Software Requirements
Application Development Basics . . . . . . . . .
Running JTAPI Applets . . . . . . . . . . . . . .
Running Applets in Netscape Communicator . . .
Running Applets in Internet Explorer . . . . . . .

.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

161
167
168
168
169
169
170
171
172
172
173
173
175
175
176
176

Chapter 8: Using the TSAPI SDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

177

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SDK Online Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Avaya Computer Telephony Installation Instructions for Using the SDK on Windows
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . .

177
178
178
178
179
180
180
184
185
185
186
186
186
186
186
187
187
187
187
187
187
188
188
188
189
189
191
191

JTAPI Sample Applications (SDK\Jtapi\OS_Independent\Samples)
ACD Applet . . . . . . . . . . . . . . . . . . . . . . . . . .
CallLog Application . . . . . . . . . . . . . . . . . . . . . .
TSTest Applet/Application (in the TSTest directory) . . . . . . .
Route Applet . . . . . . . . . . . . . . . . . . . . . . . . .
The JTAPI Exerciser Application . . . . . . . . . . . . . . . .
Manually Installing and Running the JTAPI Exerciser . . . . . .
Obtaining Version Information . . . . . . . . . . . . . . . . . .
JTAPI Online Support . . . . . . . . . . . . . . . . . . . . . .

High Level View of the TSAPI SDK . .
Installing the TSAPI SDK . . . . . . .
Installing in the Windows Environment
Installing in the Unixware Environment
Installing in the Solaris Environment .
Installing in the HP-UX Environment .

.
.
.
.
.
.
TSAPI Programming Environment . . . .
"Hdrs" Directory (SDKs\TSAPI\HDRS) .
About the Private Data Version Files .
Libs (SDKs\TSAPI\LIBS) . . . . . . .
Samples (SDKs\TSAPI\SAMPLES) . .
Tools (SDKs\TSAPI\TOOLS) . . . . . .
Win32 (SDKs\TSAPI\Windows) . . . .
TSAPI Programming Notes . . . . . . .
Closing Streams Before Exit . . . . . .
acsCloseStream() . . . . . . . . . . .
DEFINITY Private Data Name Change .
Version Negotiation . . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

Windows NT, Windows 2000 and Windows XP PBX Driver Development Information
Linkage Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PBX Driver Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sample Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CSTA Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Driver Debugging Strategies . . . . . . . . . . . . . . . . . . . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

Issue 1 October 2003

Contents
TSAPI Sample Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
For More Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

192
194

Appendix A: Avaya Computer Telephony Installed Files . . . . . . . . . . . . . . . .

195

Avaya CT Server . .
G3PBX Driver Files.
Win32 Client Files
UnixWare Client
.
HP-UX Client . . .
JTAPI Client . . . .
JTAPI SDK . . . . .
TSAPI SDK . . . .

.
.
.
.
.
.
.
.

196
198
200
201
202
203
205
209

Appendix B: Administering CTI Links for Definity G3PD . . . . . . . . . . . . . . . .

213

CTI Link Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
214
DEFINITY LAN Gateway Multi- Function Board (MFB) and Multi-Application for DEFINITY Board
(MAPD)
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
215

Appendix C: Migrating your Security Database . . . . . . . . . . . . . . . . . . . . .
Migrating from a NetWare Server to a Windows NT, Windows 2000 or Windows XP Server
Converting the Security Database
. . . . . . . . . . . . . . . . . . . . . . . . .

Appendix D: Pre-Release 11 Link Administration Instructions. . . . . . . . . . . . .
Introduction . . . . . . . . . . . . . . . . . . . . .
Scope of this appendix . . . . . . . . . . . . . . . .
Using the Information in this appendix . . . . . . . . .
DEFINITY ECS and DEFINITY
PROLOGIX Administration . . . . . . . . . . . . .
DEFINITY ECS and DEFINITY PROLOGIX
Administration — Setting Up Your LAN for Avaya CT
Server LAN Segment (connectivity to the switch) . .
IP Addresses. . . . . . . . . . . . . . . . . . .
Client LAN Segment . . . . . . . . . . . . . . .
Guidelines for Setting Up a Private LAN . . . . . .
If You Intend to Use Host Names . . . . . . . . .
Task 1: DEFINITY ECS and
DEFINITY PROLOGIX — Administering a Link . . .
Task 2: DLG Administration . . . . . . . . . . . . .
Checklist for DEFINITY ECS and
DEFINITY PROLOGIX with DLG/MAPD
— Before You Install Avaya CT . . . . . . . . . . .

217
217
218
223

. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .

223
223
224

. . . . . . . . . . . . . . . . .

224

.
.
.
.
.
.

225
225
226
226
226
226

. . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . .

227
230

. . . . . . . . . . . . . . . . .
DEFINITY ONE Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

236
237

DEFINITY ONE Pre-Administration
— Setting Up Your Avaya CT Configuration . . . . . . . . . . . . . . . . . . . . . .
Basic Switch Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connectivity — Switch to Avaya CT Server . . . . . . . . . . . . . . . . . . . . . . .

238
238
238

8 Installation Guide

.
.
.
.
.
.

Contents
Configuration Option 1: PROCR/DLG . . . . . . . . . . . . .
Configuration Option 2: PROCR/DLG, C-LAN and Data Module .
IP Address of DEFINITY G3 PBX Driver on
Avaya CT Server (Applies to Either Configuration
Option) . . . . . . . . . . . . . . . . . . . . . . . . . . .
Procedure for Setting Up TN795 PROCR
to DEFINITY ONE (Option 1) . . . . . . . . . . . . . . . .
Procedure for Setting Up TN799 C-LAN
to DEFINITY ONE (Option 2) . . . . . . . . . . . . . . . .
Checklists for DEFINITY ONE
— Before You Install Avaya CT . . . . . . . . . . . . . . .
Checklist for DEFINITY ONE
with TN795 PROCR (Option 1). . . . . . . . . . . . . . . .
Checklist for DEFINITY ONE
with TN799 C-LAN (Option 2) . . . . . . . . . . . . . . . .
Configuring DEFINITY ONE and Avaya CT . . . . . . . . . .

Index

. . . . . . . . . . .
. . . . . . . . . . .

238
238

. . . . . . . . . . .

239

. . . . . . . . . . .

239

. . . . . . . . . . .

243

. . . . . . . . . . .

246

. . . . . . . . . . .

246

. . . . . . . . . . .
. . . . . . . . . . .

247
248

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

251

Issue 1 October 2003

Contents

10 Installation Guide

Preface - About This Document
This document focuses on installing Avaya Computer Telephony software and provides
you with:
●

Guidelines for using the online Avaya 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: Administering the
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 tools that Avaya Computer Telephony provides for
developing CTI based applications (Chapter 5: Using CVLAN, Chapter 6: Installing
JTAPI Client Software, Chapter 7: Using the JTAPI SDK, and Chapter 8: Using the
TSAPI SDK

Reason for Reissue
This document is reissued to reflect changes associated with configuring Avaya Computer
Telephony in firewall environments that use Network Address Translation or port
redirection.

Issue 1 October 2003

Preface - About This Document

Intended Audience
This document is intended for anyone who is responsible for installing and maintaining 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 switch, 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 Application 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 currently reading provides you with an orientation to the rest of the
information in this document as well as an introduction 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 familiarize yourself 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 software) 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 the Avaya
Computer Telephony server software.

12 Installation Guide

Document Organization

●

Chapter 4: Installing Avaya Computer Telephony TSAPI Client 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 to use a CVLAN (CallVisor PC Local Area Network)
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.

●

Appendix A: Avaya Computer Telephony Installed Files
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 information 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 2003

Preface - About This Document

Conventions Used in This Document
The following conventions are used throughout this document.
Convention

Example

Usage

bold monospace

add station

characters that you type exactly
as depicted

italic monospace

modname

characters or variables that you
substitute

plain monospace

Port:

a non-graphic user interface
(GUI) element such as a field
name.

bold sans-serif

Start

a mouse selection

Product Terminology
Throughout this document the terms "Definity" and “MultiVantage” are used synonymously.

14 Installation Guide

Related Documents

Avaya Computer Telephony Document Icons, Titles and File Names (continued)
Icon

Title

File Name

Avaya
MultiVantage
CallVisor ASAI
Technical Ref

Avaya MultiVantage CallVisor
ASAI Technical Reference

ASAITECH.PDF

Avaya
MultiVantage
CallVisor ASAI
Protocol Ref

Avaya MultiVantage CallVisor
ASAI Protocol Reference

ASAIPROT.PDF

JTAPI
Programmer’s
Reference

Avaya Computer Telephony 1.3
Java Telephony API (JTAPI) Programmer’s
Reference

JTAPI.PDF

JTAPI Client
Programmer’s
Guide

Avaya Computer Telephony 1.3
Java Telephony API (JTAPI) for Avaya
MultiVantage
Programmer’s Reference

JCLI.PDF

Using the Avaya Computer Telephony Documents
This section presents a few possible usage scenarios to help you determine which
documents apply to your particular needs.

If You are Implementing or Maintaining a DEFINITY Based TSAPI Solution
If you are using Avaya Computer Telephony to implement a DEFINITY-based TSAPI
solution, use the following Avaya Computer Telephony documents.
●

Avaya Computer Telephony Installation Guide (INSTALL.PDF)

●

Avaya Computer Telephony, Telephony Services Administration and Maintenance
Guide (NETMANGD.PDF)

●

Avaya Computer Telephony G3 PBX Driver and CVLAN Administration and
Maintenance (DEFNETM.PDF)

If You are Developing a TSAPI Based Application
If you are developing a TSAPI based application, use the following documents.
●

Avaya Computer Telephony Installation Guide (INSTALL.PDF)

●

Avaya Computer Telephony, Avaya MultiVantage Simulator User’s Guide
(SIMGUIDE.PDF)

●

Avaya Computer Telephony, Telephony Services Administration and Maintenance
(NETMANGD.PDF)

Issue 1 October 2003

Preface - About This Document

●

Avaya Computer Telephony G3 PBX Driver and CVLAN Administration and
Maintenance (DEFNETM.PDF)

●

Avaya Computer Telephony, Telephony Services Application Programming Interface
(TSAPI) for Avaya MulitVantage (DEFPROG.PDF)

●

Avaya Computer Telephony, Telephony Services Application Programming Interface
(TSAPI) (TSAPI.PDF)

If You Are Developing your own PBX Driver for Avaya Computer Telephony
If you are using the Telephony Services server and are developing your own PBX driver,
use the following documents.
●

Avaya Computer Telephony Installation Guide(INSTALL.PDF)

●

Avaya Computer Telephony CSTA Server Driver Interface (CSDI.PDF)

●

Avaya Computer Telephony, Telephony Services Application Programming Interface
(TSAPI.PDF)

●

Avaya Computer Telephony, Telephony Services PBX Driver Interface (TSDI.PDF)

If You Use CVLAN (CallVisor PC LAN) Based Applications
If you use a CVLAN based application, use the following documents.
●

Avaya Computer Telephony Installation Guide (INSTALL.PDF)

●

Avaya Computer Telephony CVLAN Programmer’s Reference (CALLVISR.PDF)

●

Avaya MultiVantage CallVisor ASAI Technical Reference (ASAITECH.PDF)

●

Avaya Computer Telephony, Telephony Services Administration and Maintenance
(NETMANGD.PDF).

●

Avaya Computer Telephony G3 PBX Driver and CVLAN Administration and
Maintenance (DEFNETM.PDF)

If you are Developing JTAPI based Applications
If you are working with JTAPI based applications, use the following documents.
●

Avaya Computer Telephony Installation Guide (INSTALL.PDF)

●

Avaya Computer Telephony, Telephony Services Application Programming Interface
(TSAPI) for Avaya MulitVantage (DEFPROG.PDF)

●

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

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

Issue 1 October 2003

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 2003

Learning About Avaya Computer Telephony

What is CTI?
In simplest terms, CTI refers to the integration of your telephone (voice) and PC application
(data) for intelligent and effective call processing. This integration is achieved logically, and
no physical connection is required 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 enabler of CTI applications. It provides applications
with the ability to monitor and control resources in a telephone network, via a set of library
routines and function calls. Avaya Computer Telephony presents a programmatic interface
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)

●

Java Telephony Application Programming Interface (JTAPI)

●

CallVisor PC

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

What is CTI?

JTAPI
JTAPI is a portable, object oriented API for Java-based computer telephony applications.
Through JTAPI, Java applications can access and control 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: Using CVLAN for more information about CallVisor PC
and CVLAN (CallVisor PC LAN).

Issue 1 October 2003

Learning About Avaya Computer Telephony

The Essential Components of a CTI System
Although a CTI implementation can take many forms, Figure 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

Server

Switch

Avaya CT Server
DEFINITY
ECS
Telephony
Services
Software

ASAI

Phone Line

26 Installation Guide

Client

TSAPI
Client

Agent
Workstation

Agent
Telephone

A Typical Avaya Computer Telephony Configuration

A Typical Avaya Computer Telephony Configuration
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 typical Avaya Computer Telephony configuration are
as follows.
●

DEFINITY Switch configured with ASAI
The DEFINITY switch is a device that processes calls (incoming, 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 monitoring and call control functions 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 DEFINITY Server CSI, SI, and R, and Avaya MultiVantage 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 communicate 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 DEFINITY Server CSI, SI, and R, and Avaya MultiVantage S8700
configurations use a Multi-Application Platform for DEFINTY (MAPD) based DLG.

Issue 1 October 2003

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 Sparc
- HP-UX

●

CVLAN Server

●

CVLAN Clients
- UNIX
- Solaris x86
- Solaris Sparc
- 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 2003

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 where the components are and how they operate at
a schematic level.
Figure 1-2: Essential Avaya Computer Telephony Components — A Closer Look

Server

Switch

Client

TSLIB

TSAPI
Client

DEFINITY ECS
SDB

MAPD

Phone

Avaya CT Server

Tserver

DLG
JTAPI
Client

NIC

Phone

G3PD

NIC

ASAI

CVLANCLI.DLL

CVLAN
Server

Phone Line

30 Installation Guide

CVLAN
Client

Phone

ASAI.DLL

Security Issues

Security Issues
The term security has broad connotations. In the context of Avaya Computer Telephony,
security refers to toll fraud issues only. The next two sections provide some basic
guidelines for effecting secure, isolated LAN arrangements for DEFINITY. For more
information about security-related issues, see Chapter 2 of Avaya Computer Telephony 1.3
G3 PBX Driver and CVLAN Administration and Maintenance (DEFNETM.PDF).

Security — DEFINITY Servers CSI, SI, R
and S8700 Configurations
If your Avaya Computer Telephony configuration relies on a platform that uses the MAPD
(DEFINITY Server CSI, SI, R and S8700 Configurations) refer to Figure 1-3 as you read
this section.

Isolating the DEFINITY LAN Gateway
The DEFINITY LAN Gateway system assembly should be on its own separate segment
and will consequently require its own separate LAN card. This means you will need two
network interface cards (NICs) in your Telephony Server, one for client access and one for
the connection between the DEFINITY G3 PBX Driver and the DEFINITY LAN Gateway
system assembly.
Follow these guidelines to ensure that the DEFINITY LAN Gateway system is not
accessible from the rest of the network.
●

Use a separate secure link connecting the Telephony Server to the DEFINITY LAN
Gateway system.

●

You will administer the IP address of the DEFINITY G3 PBX Driver during the
installation of the DEFINITY G3 PBX Driver. Do not administer the same IP address for
the DEFINITY G3 PBX Driver that your Telephony Server is using. If you do administer
the same IP address for both, you will leave your system open for possible toll fraud and
may receive a toll fraud warning.

●

Make sure that IP forwarding (formerly referred to as IP routing) is turned off between
the DEFINITY G3 PBX Driver NIC and the NIC on the Avaya Computer Telephony
Server. After installing the NIC on your Avaya Computer Telephony server, configure the
connection with no IP forwarding. See “Configuring the Tserver for a Secure LAN
Gateway Connection” in Chapter 2 of Avaya Computer Telephony 1.3 G3 PBX Driver
and CVLAN Administration and Maintenance (DEFNETM.PDF).

Issue 1 October 2003

Learning About Avaya Computer Telephony

!
WARNING:

WARNING:
Customers who do not follow this recommendation may be subject to a
person or persons gaining illegal access to the DEFINITY LAN Gateway
application to commit toll fraud and/or tamper with the real-time aspects of
Computer Telephony Integration (CTI) applications. (Toll fraud is the
unauthorized use of your telecommunications system. Under applicable law,
the customer is responsible for paying for such unauthorized usage.)

Figure 1-3: DEFINITY ECS/DEFINITY Server CSI Security Guidelines

Avaya CT
Server

DEFINITY ECS
Ethernet
DEFINITY
LAN
Gateway

Switch access

Separate LAN segment

NIC
192.168.25.20

G3PBX
Driver

192.168.25.10

Separate LAN segment

Telephony
Server
(TSRV)
NIC
176.108.25.20

Client access

Keep the DEFINITY LAN Gateway
connections isolated from the
rest of the network.
Prohibit any routing between
the NIC used for the DEFINITY LAN
Gateway and any other NIC.

Clients

32 Installation Guide

Security Issues

Security — DEFINITY ONE/IP600and Avaya MultiVantage
S8100 Configurations
Figure 1-4 depicts two optional connection methods, a non-isolated link on the same LAN
segment and an isolated, secure link on a separate LAN segment. Be sure to review
Figure 1-4 and note the security issues and toll fraud implications. Use a separate, secure
link connecting to DEFINITY ONE/IP600 or S8100 Media Server configuration.
Figure 1-4: Connectivity Options
Connectivity via TN2314 PROCR — Non-Isolated or Same LAN segment
With this connection option,
DEFINITY ONE is not
isolated from the
rest of the network.
The client and the switch use
the same LAN segment.

Avaya CT
Server
Switch access

DEFINITY ONE

G3PBX
Driver

TN2314
PROCR

NIC

DLG

Clients

Telephony
Server

(TSRV)

Client access

Connectivity via TN799 CLAN — Isolated or Separate LAN segment
With this connection option,
the DEFINITY ONE-to-server
connection is isolated from
the rest of the network.
Clients are not on the same
LAN segment as the switch.

Avaya CT
Server

DEFINITY ONE

Switch access
TN2314
PROCR

DLG

TN799
C-LAN

NIC
HUB

G3PBX
Driver

Clients

Telephony
Server
(TSRV)
NIC
Client access

Issue 1 October 2003

Learning About Avaya Computer Telephony

Implementing a Firewall Strategy
Avaya Computer Telephony supports a variety of configuration methods and addressing
techniques that are used in a firewall environment. The documentation presents the
information in terms of where you are setting up your firewall.
●

If you are setting up a firewall between the Avaya Computer Telephony client and the
Avaya Computer Telephony Server (Tserver), see Chapter 6 of the Telephony Services
Administration and Maintenance Guide (NETMANGD.PDF).

●

If you are setting up a firewall between the G3PBX driver (located on the Avaya
Computer Telephony Server) and the switch, see Chapter 2 of the G3PBX Driver and
CVLAN Administration and Maintenance Guide (DEFNETM.PDF).

Note:

Note:
While Avaya Computer Telephony can support a firewall on either side of the
Tserver, it is recommended that the firewall be placed between the Tserver
and the client rather than the Tserver and the switch.

34 Installation Guide

Private Data and Client Applications

Private Data and Client Applications
Private Data allows Avaya Computer Telephony to take advantage of DEFINITY features.
A complete description of private data is beyond the scope of this document, but a simple
overview will help you understand how if affects your applications. At a conceptual level the
main points are as follows.
●

Private data is a switch-specific software implementation that provides value added
services. Your applications can take advantage of the private data services that are
included in the Telephony Services API.

●

An application that is based on “Private Data Version 5,” for example, can run on a
switch that is running “Private Data Version 6,” but the application is restricted to the
capabilities of Private Data Version 5. In this sense, private data version control is
transparent, or backward compatible.

●

If you want your Private Data Version 5 based applications to take advantage of Private
Data Version 6 capabilities, you must upgrade all the services your application uses to
Private Data Version 6.

For more information about private data services, see Avaya Computer Telephony,
Telephony Services Application Programming Interface (TSAPI) for Avaya MultiVantage
(DEFPROG.PDF). Table 1-1 summarizes application client platforms and private data
version compatibility.
Table 1-1: Avaya Computer Telephony Client Platforms - Private Data Version
Compatibility
Win32®

Windows 95

All versions

Windows 98
Windows NT 3.5.1 workstation or server
Windows NT 4.0 workstation or server
Windows 2000 Professional or Server
Windows XP
Solaris Sparc

Solaris Sparc

All versions

UnixWare

UnixWare 1.x, UnixWare 2.0x, UnixWare 7

All versions

HP-UX

HP-UX Version 10

V5 and earlier

Java (JTAPI)

Java VM1

All versions

Netscape Navigator® 3.x + or Internet Explorer™
4.x +
1. Any Java Virtual Machine (VM) compatible with the Sun Microsystems Java specification, Version
1.02 or later.

Issue 1 October 2003

Learning About Avaya Computer Telephony

36 Installation Guide

Chapter 2: Administering the Switch
This chapter describes DEFINITY-based tasks that must be performed to implement
communications between the DEFINITY switch and the Avaya Computer Telephony
server.
This chapter contains the following sections:
●

Scope of this Chapter on page 37

●

Hardware and Software Components on page 38

●

Using the Information in this Chapter on page 39

●

Activating Software Features — RFA and License Files on page 40

●

License Files on page 40

●

License File and Optional Features Forms on page 40

●

Administrative Tasks for Avaya Platforms That Use the MAPD on page 41

●

Administrative Tasks for Avaya Platforms That Use the Co-Resident DLG on page 53

Scope of this Chapter
Refer to Figure 2-1 as you read this section. The scope of this chapter includes activities
associated with setting up the DEFINITY switch, administering the communications
interface to the Avaya Computer Telephony server, and establishing a link. The next
sections describes the components that are affected.

Issue 1 October 2003

Administering the Switch

Hardware and Software Components
The hardware and software components relevant in this chapter are described in this list.
●

Avaya MultiVantageTM software — the call processing software that resides on all
Avaya call processing configurations. From the viewpoint of product names, it is part of
the name of each call processing platform.

●

The DEFINITY Server, the Media Server, or the Media Gateway (such as DEFINITY
Server CSI, DEFINITY Server SI, and DEFINITY Server R, Avaya S8100 Media Server
configurations, Avaya S8300 with Avaya Media Gateway, and Avaya MultiVantage
S8700 Media Server configurations)

●

DEFINITY LAN Gateway (DLG), software which can reside on the Multi-Application
Platform for DEFINITY (MAPD) or can be Co-Resident with call MultiVantage Processor
Card. The following list describes the platforms that rely on the MAPD DLG and the
platforms that rely on the Co-Resident DLG.

●

Platforms that use the TN800 series MAPD

●

DEFINITY Servers (CSI, SI, and R), and Avaya MultiVantage S8700 Media Server
configurations.

●

Platforms that use the Co-Resident DLG (the DLG software co-resides with
MultiVantage call processing on the processor card.
- Avaya S8100 Media Server configurations (formerly DEFINITY ONE and IP 600)
- Avaya S8300 Media Gateway with G700 Media Server (with an Internal Call
Controller)

Note:

Note:
In some configurations, the TN2314 card (with Co-Resident DLG) relies on
the TN799 Control LAN (C-LAN) card for LAN isolation.

38 Installation Guide

Using the Information in this Chapter

Using the Information in this Chapter
This chapter makes two basic assumptions — that you have a DEFINITY switch, with the
DEFINITY LAN Gateway (DLG) system already installed, and that you have a TCP/IP
based LAN that is capable of isolating your server-based functions from your client-based
functions.
The type of DEFINITY switch you have determines how you use this chapter.
●

If you use a DEFINITY Server (CSI, SI or R) or an Avaya MultiVantage S8700 Media
Server configuration, complete the tasks described in ‘‘Administrative Tasks for Avaya
Platforms That Use the MAPD’’ on page -41.

●

If you use an Avaya MultiVantage S8100 Server (formerly DEFINITY ONE/IP600) or an
Avaya MultiVantage S8300 Media Server with a G700 Media Gateway, complete the
tasks described in ‘‘CTI Link Administration on Configurations with Processor
Connectivity’’ on page -54

●

If you use an Avaya S8100 Media Server (DEFINITY ONE/IP600) configuration with a
processor and C-LAN, see ‘‘CTI Link Administration on Configurations with CLAN
Connectivity’’ on page -56

Issue 1 October 2003

Administering the Switch

Activating Software Features — RFA and License
Files
With Release 10, Avaya implemented a new approach to activating software features. This
new approach relies on the Remote Feature Activation (RFA) process and the creation of a
License file. All activities associated with RFA and the generation of license files are
carried out by Avaya support. To change software features, you will need to contact your
Account Executive and have a new license file generated via the RFA process.

License Files
All DEFINITY R10, and subsequent MultiVantage systems require a valid license to
operate as a switch.The License File controls following switch settings:
●

software release

●

offer category

●

features

●

capacities

Without a license file, the switch does not provide normal call processing.

License File and Optional Features Forms
Because the license file determines features and capabilities, the ASAI Optional features
that appear on the OPTIONAL FEATURES form are pre-set, or inherited from the license
file, and switch administrators cannot change them.
For example, if you type display system parameters and go to the page that lists
optional features for ASAI (typically page 2) you would see the settings that were effected
by the license file.
If your form lists ASAI Link Plus Capabilities? n, it means that your system has
not been set up with ASAI Link Plus Capabilities. You can not change the "n" to a "y" on
this form. To do so you would have to contact your AE and make arrangements to have the
change implemented through RFA.

40 Installation Guide

Administrative Tasks for Avaya Platforms That Use the MAPD

Administrative Tasks for Avaya Platforms That Use
the MAPD
This section describes administrative tasks you must complete before you can install
Avaya Computer Telephony in a configuration that uses a MAPD, such as DEFINTY
Servers (CSI, SI, and R), Avaya MultiVantage S8700 Media Server for Multi-Connect
Configurations, and Avaya MultiVantage S8700 Media Server for IP-Connect
Configurations.
●

Task 1: Administration on a DEFINITY System Administration Terminal (SAT)

●

Task 2: MAPD and DLG Administration via a MAPD Administration Terminal

Once you complete these tasks, proceed with Chapter 3: Installing Avaya Computer
Telephony Server Software.
Figure 2-1: DEFINTY Server and MAPD/DLG Administration at a Glance

DEFINITY ECS and DEFINITY
Server CSI Administration
via SAT terminal

Task
1

Verify software version
Verify ASAI features
List configuration
Administer station

DLG Administration
via MAPD Administration terminal
(MAPD in “ASAI” state)

Task
2

Add a client — TCP/IP ADMINISTRATION
LOCAL HOST TABLE
Administer a link — PORT ADMINISTRATION
DLG ADMINISTRATION
Verify connectivity — DLG PORT/STATUS
CONTROL

Clients
DEFINITY ECS

Avaya CT Server

MAPD

NIC

DLG

192.168.25.20

192.168.25.10

Issue 1 October 2003

Administering the Switch

Setting Up Your LAN for Avaya Computer Telephony
This section applies to the following platforms, which rely on the MAPD-based DLG and
rely on a Telephony Server with two Network Interface Cards (NICs). If you are configuring
Avaya Computer Telephony in a NAT or a firewall environment, see Implementing a
Firewall Strategy on page 34.
●

DEFINITY Servers CSI, SI, and R

●

Avaya MultiVantage S8700 Media Server for Multi-Connect Configurations

●

Avaya MultiVantage S8700 Media Server for IP-Connect Configurations

Before you administer the DEFINITY switch (including the DLG), make sure that you have
determined how your LAN is set up.

Server LAN Segment (connectivity to the switch)
Server LAN segment functions are in the DLG administrative domain. For server-to-switch
functions follow these guidelines.
●

The DLG must be connected to the LAN that the Avaya Computer Telephony server
uses (the Avaya Computer Telephony server communicates with the switch via the
DEFINITY G3 PBX Driver).

●

The DLG should be on its own separate LAN segment. To effect this, you will need two
Network Interface Cards (NICs) in the Avaya Computer Telephony Server, one for client
access and one for the connection between the DLG and the DEFINITY G3 PBX Driver.

IP Addresses
It is strongly recommended that you use at least two IP addresses.
●

IP address for the DLG
Make certain that you have the IP address or the DLG or its host name (if host
names are used instead of IP addresses). See the DEFINITY switch administrator.
If you are using a separate LAN for your DLG (recommended) and all links go to a
single switch, then you can use the default IP address, which is 192.168.25.10.

●

IP Address for the DEFINITY G3 PBX Driver
Verify that you have a local IP address for the DEFINITY G3 PBX Driver on your
Telephony Server. You will need this IP address for installing the DEFINITY G3 PBX
Driver. You may obtain this address from the network administrator or you may use
the default address provided in the installation program (192.168.25.20) if you have
a private LAN (as recommended) between the Telephony Server and the DEFINITY
ECS switch. This local IP address should be different from the IP address used for
the Avaya Computer Telephony server, as recommended.

42 Installation Guide

Administrative Tasks for Avaya Platforms That Use the MAPD

Client LAN Segment
See Chapter 4: Installing Avaya Computer Telephony TSAPI Client Software for more
information about client-based Avaya Computer Telephony requirements.

Guidelines for Setting Up a Private LAN
Follow these guidelines for implementing a private LAN for Avaya Computer Telephony.
Use IP addresses within the following ranges:
●

10.0.0.0 — 10.255.255.255

●

172.16.0.0 — 172.31.255.255

●

192.168.0.0 — 192.168.255.255

If You Intend to Use Host Names
You have the option of using host names, instead of IP addresses, when administering the
DEFINITY LAN Gateway and the DEFINITY G3 PBX Driver. If you use host names instead
of IP addresses, each entry in the HOSTS file provides information about one host on the
IP network. The DEFINITY LAN Gateway link connection is considered a host.

Note:

Note:
The DLG has a default set of administered parameters that correspond to
the defaults provided in the Avaya Computer Telephony DEFINITY G3 PBX
Driver installation. If you implement private addressing you will have to
change these settings on the G3PBX Driver Configuration Dialog Box (see
Chapter 3: Installing Avaya Computer Telephony Server Software .)

Issue 1 October 2003

Administering the Switch

Task 1: Administering a Link
This section applies to the following platforms, which rely on the MAPD-based DLG.
●

DEFINITY Servers CSI, SI, and R

●

Avaya MultiVantage S8700 Media Server for Multi-Connect Configurations

●

Avaya MultiVantage S8700 Media Server for IP-Connect Configurations

The objective of Task 1 is administering a link. From the DEFINITY SAT, follow these steps
to complete Task 1.

Note:

Note:
Whenever you use the change form of a DEFINITY SAT command, you
must log out for the changes to take effect.
1. Log in to the DEFINITY switch.
2. Type display system-parameters customer-options
The OPTIONAL FEATURES screen appears.

3. Check Computer Telephony Adjunct Links? and make sure it is set to y, (page
2 of the OPTIONAL FEATURES screen in the example above). This setting indicates
that DEFINITY is capable of communicating with an adjunct.

Note:

Note:
If this field is not set to "y" then contact your Avaya Account Representative.

44 Installation Guide

Administrative Tasks for Avaya Platforms That Use the MAPD

4. Type list configuration software-versions
The SOFTWARE VERSIONS screen appears.

5. Check the SOFTWARE VERSION to verify that the correct DEFINITY software version
is running on the switch. The following versions are appropriate: G3V4, or later.

Note:

Note:
G3V4 requires a field maintenance release.
6. Type list config all to determine what ports are available on the MAPD for
adding a station.
The SYSTEM CONFIGURATION screen appears.
Under Assigned Ports, each u represents an available or unassigned port.

list configuration all
Page 1
---------------------------------------------------------------------SYSTEM CONFIGURATION
Board
Number
1A01

Board Type
EXPANSION INTF

Code
TN776

Vintage
000001

Assigned Ports

1A02

EXPANSION INTF

TN776

000001

1A04

RESERVED LGATE

TN801

MAPD

u u

1A05

RESERVED LGATE

TN801

MAPD

u u

1A06

MAPD BOARD

TN801

000001

u u

1A03

7. Choose a port associated with the MAPD board to add a station to the DLG (on the
MAPD).
8. Type add cti-link (where n represents the link number)
The LINK screen appears.

Issue 1 October 2003

Administering the Switch

9. Follow Steps a through i to add an ASAI-enabled station. Completing the LINK screen
administers an adjunct IP link between DEFINITY and a Avaya Computer Telephony
server.
a. In the Extension: type any valid extension on the dial plan (for example, 1008).
b. In the Type: field, type ADJLK
c. In the Port: field, type an available port number
d. In the Name: field, type the name of the Avaya Computer Telephony server
e. In the XID: field, accept the default (n)
f. In the Fixed TEI: field, type y
g. In the MIM Support: field, accept the default (n)
h. In the CRV Length: field, type 2
i. In the Event Minimization: field, accept the default (n)
All other fields on the Link screen use the default values.
This completes Task 1: DEFINITY Administration. Proceed to Task 2: DLG Administration.

46 Installation Guide

Administrative Tasks for Avaya Platforms That Use the MAPD

Task 2: DLG Administration
The objective of Task 2 is to establish connectivity between DEFINITY and your Avaya
Computer Telephony server, by way of the DLG. Task 2 assumes that the DLG is already
installed and administered. For more information see DEFINITY ECS and CallVisor ASAI
Applications over MAPD (555-230-136).
From the MAPD administrative terminal, follow these steps to complete Task 2.
1. Log in to the MAPD system
The Main Menu appears.

Main Menu
1.

TCP/IP Administration...

Port Administration...

Maintenance...

DLG Port Status/Control

CV/LAN Port Status/Control

Exit
1.

If both the DLG and CVLAN
applications are on the MAPD
this Main Menu appears.
3. Port Administration... is
for access to DLG and CVLAN)

Main Menu

If only the DLG application
is on the MAPD
this Main Menu appears.
3.

DLG Administration

for currently
access to DLG.
This line is used to provide abbreviated help on the
selected field.
2. TCP/IP Administration...
3. DLGREFRESH
Administration
EXIT
ENTER
4.

Maintenance...

DLG Port Status/Control

Exit

HELP

This line is used to provide abbreviated help on the currently selected field.
EXIT

REFRESH

ENTER

HELP

2. From the Main Menu, select 2. TCP/IP Administration.

Issue 1 October 2003

Administering the Switch

3. From the TCP/IP Administration screen select 1. This Host
The TCP/IP Administration This Host screen appears (This Host refers to the MAPD
itself).
4. Verify (or make a note of) the Host Name and IP address of the MAPD.
●

The Host Name is the name that you assign to the MAPD.

●

The Host IP Address is the IP address required when you perform G3 PBX Driver
link administration on the Avaya Computer Telephony Server. See Chapter
3: Installing Avaya Computer Telephony Server Software.

5. Once you have noted this information, select CANCEL to return to the Main Menu.

48 Installation Guide

Administrative Tasks for Avaya Platforms That Use the MAPD

6. From the Main Menu, select 2. TCP/IP Administration.
The TCP/IP Administration screen appears.

TCP/IP Administration

1. This Host
2. Local Host Table
3. Network Routing Information...
4. Exit

This line is used to provide abbreviated help on the currently selected field.
EXIT

REFRESH

ENTER

HELP

7. From the TCP/IP Administration screen select 2. Local Host Table, which
enables you to view, add, or delete hosts. The host, in this case, is the Avaya
Computer Telephony Server.
The TCP/IP Administration Local Host Table screen appears.

Issue 1 October 2003

Administering the Switch

Note:

Note:
If the MAPD/DLG has already been administered to accept the default IP
address of the Avaya Computer Telephony server (192.168.25.20), and you
want to implement a default Avaya Computer Telephony configuration, skip
Step 8a and 8b; go to Step 8c.

TCP/IP Administration
Local Host Table

Page
X of X

Host Name
Aliases
IP Address
__________________________________________________________________
___________________________________________________________________________
___________________________________________________________________________
___________________________________________________________________________
___________________________________________________________________________
___________________________________________________________________________
___________________________________________________________________________
___________________________________________________________________________
___________________________________________________________________________
___________________________________________________________________________
___________________________________________________________________________
___________________________________________________________________________
___________________________________________________________________________
___________________________________________________________________________
___________________________________________________________________________
This line is used to provide abbreviated help on the currently selected field.
CANCEL

REFRESH

ADD

DELETE

HELP

NXTPG

PRVPG

8. Follow Steps a through e to complete the Local Host Table

Note:

Note:
The addressing information you use in steps 8a and 8b must be used (in the
DEFINITY G3PBX Driver dialog box) when you install Avaya Computer
Telephony.
a. In the IP Address field, type the IP address of the G3PBX Driver on the Avaya
Computer Telephony server. (You can accept the default, 192.168.25.20, if you want
to effect a "default" Avaya Computer Telephony installation).
b. In the Host Name field, type the name that is assigned to the Avaya Computer
Telephony server.
c. Select ADD to save your settings.
d. Select CANCEL to return to the TCP/IP Administration Screen.
e. From the TCP/IP Administration Screen, select EXIT to return to the MAIN MENU.

50 Installation Guide

Administrative Tasks for Avaya Platforms That Use the MAPD

9. From the Main Menu, select 3. Port Administration...
The Port Administration screen appears.

Port Administration

Application Port Assignment

DLG Administration

CV/LAN Administration

Exit

This line is used to provide abbreviated help on the currently selected field.
EXIT

REFRESH

ENTER

HELP

10. From the Port Administration screen, select 2. DLG Administration
The DLG Administration screen appears.
11. Follow steps a through c to complete the DLG Administration screen.
DLG Administration
Port
__
__
__
__
__
__
__
__

Client Name or IP Address
_________________________
_________________________
_________________________
_________________________
_________________________
_________________________
_________________________
_________________________

Client Link
__
__
__
__
__
__
__
__

Client Status
___________
___________
___________
___________
___________
___________
___________
___________

This line is used to provide abbreviated help on the currently selected field.
CANCEL

REFRESH

ADD

DELETE

HELP

UPDATE

Issue 1 October 2003

Administering the Switch

a. In the Port field, type the port number of the DEFINITY station administered for the
link to the Avaya Computer Telephony server (see Task 1, Step 8a)
b. In the Client Name or IP Address field, type the IP address or name assigned
to the G3PBX Driver on the Avaya Computer Telephony server. This Client Name or
IP Address refers to the IP address you used in Step 8b.
(The default is 192.168.25.20).
c. In the Client Link field, type a number from 1 to 8 for the link assigned to the
Avaya Computer Telephony server.
12. Return to the Main Menu, and from the Main Menu, select
5. DLG Port/Status Control.
The DLG Port/Status Control screen appears.
13. From the DLG Port Status/Control screen follow these steps.

Port

DEFINITY
Port
State

TCP/IP
Connection
State

DLG
Service
State

M essages
to
DEFINITY

M essages
from
DEFINITY

Message
Period
(minutes)

__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________

This line is used to provide abbreviated help on the currently selected field.
CANCEL

REFRESH

MSGPER

HELP

STATE

UPDATE

DROP

a. Verify that the port number you administered in Step 11a appears under Port.
b. Verify that REACHABLE appears under TCP/IP Connection State.
This completes the DLG/MAPD administrative tasks.

52 Installation Guide

Administrative Tasks for Avaya Platforms That Use the Co-Resident DLG

Administrative Tasks for Avaya Platforms That Use
the Co-Resident DLG
This section applies to the following platforms, which can use the Co-Resident DEFINTY
LAN Gateway (DLG).
●

DEFINITY ONE/IP 600

●

Avaya MultiVantage S8100 Media Server configurations

●

Avaya MultiVantage S8300 Media Server with G700 Media Gateway

Because these platforms do not use the MAPD based DLG, there is no MAPD
Administration. Based on your configuration, use one of the following procedures to
administer a CTI link
●
●

CTI Link Administration on Configurations with Processor Connectivity on page 54
CTI Link Administration on Configurations with CLAN Connectivity on page 56 (NOTE:
This procedure is not applicable to the S8300 Media Server configuration).

Issue 1 October 2003

Administering the Switch

CTI Link Administration on Configurations with Processor
Connectivity
This procedure assumes that you are running the appropriate level of software. Follow
these steps from the system access terminal (SAT) to administer a CTI link (Link Type:
ADJ-IP) in a configuration that supports a Co-Resident DLG, such as DEFINITY ONE/
IP600, Avaya S8100 Media Server configurations, or an Avaya S8300 Media Server with
G700 Media Gateway.

Note:

Note:
Italicized terms in angle brackets denote variables, for example
<123.213.123.111>. Substitute the appropriate value for your system.
1. Type list configuration software-versions and verify that the appropriate level of
software is running (R11.00.059 or later)
2. Type display system-parameters customer-options, and go to Page 4 of 101 of the
OPTIONAL FEATURES form.
Verify that the Processor Ethernet? option field, is set to y.
3. Type display system-parameters customer-options and go to Page 2 of 10 of the
OPTIONAL FEATURES form.
Verify that the Co-Res DEFINITY LAN Gateway? option field, is set to y.
4. Type display system-parameters customer-options and go to page 2 of 10 of the
OPTIONAL FEATURES form.
Verify that Computer Telephony Adjunct Link is set to y.
5. Type change ip-interfaces and go to Page 1 of 6 of the IP INTERFACES form. Follow
Steps a thorough f.
a. In the Enable Eth Pt option field, type y
b. In the Type option field, type procr
c. In the Net Rgn option field, type 1 or the appropriate Network region
d. In the Node Name option field, type the Processor’s IP address; for example:
<123.213.123.111>
e. In the Subnet Mask option field, type the Processor’s subnet mask, for example:
<255.255.255.0>
f. In the Gateway option field, type the router’s IP address, for example
<123.213.321.110>
6. Type change node-names. (You are on Page 1 of 1 on the IP NODE NAMES form.)
a. In the Name option field, type
1 Page numbering is relative on the OPTIONS form. The total page count is affected by the options your
system is configured with. For example, if you have ASAI Core but neither ASAI Plus nor Computer
Telephony Adjunct Links, your total page count diminishes by one (4 of 9 instead of 4 of 10).

54 Installation Guide

Administrative Tasks for Avaya Platforms That Use the Co-Resident DLG

b. In the IP Address option field, type
7. type add cti link (substitute with the appropriate link number)
a. In the Extension field, type
b. In the Type field, type ADJ-IP
c. In the Name field, type
8. type change ip-services
a. In the Service Type field, type DLG
b. In the Enabled field, type y
c. In the Local Node field, type procr
d. In the Local Port field, type 5678
9. After completing the IP-Services Form (Step 9), continue on to the DLG Administration
form.
a. In the CTI Link field, type (substitute with the appropriate link number)
b. In the Enabled field, type y
c. In the Client Name field, type
d. In the Client Link field, type
10. Type status dlg cti-link, and on the DLG CTI LINK STATUS form, verify that the
Service State field displays established.

Issue 1 October 2003

Administering the Switch

CTI Link Administration on Configurations with CLAN
Connectivity
This procedure assumes that you are running the appropriate level of software. Follow
these steps from the system access terminal (SAT) to administer a CTI link (Link Type:
ADJ-IP) in a configuration that supports a Co-Resident DLG.

Note:

Note:
This procedure applies only to DEFINITY ONE/IP600 and Avaya S8100
Media Server configurations. It does not apply to S8300 Media Server
configurations.
1. Type list configuration software-versions and verify that the appropriate level of
software is running (R11.00.059 or later)
2. Type display system-parameters customer-options, and go to Page 4 of 101 of the
OPTIONAL FEATURES form.
Verify that the Processor Ethernet? option field, is set to y.
3. Type display system-parameters customer-options and go to Page 2 of 10 of the
OPTIONAL FEATURES form.
Verify that the Co-Res DEFINITY LAN Gateway? option field, is set to y.
4. Type display system-parameters customer-options and go to page 2 of 10 of the
OPTIONAL FEATURES form.
Verify that Computer Telephony Adjunct Link is set to y.
5. Type change ip-interfaces and go to Page 1 of 6 of the IP INTERFACES form. Follow
Steps a thorough f.
a. In the Enable Eth Pt option field, type y
b. In the Type option field, type c-lan
c. In the Net Rgn option field, type 1 or the appropriate Network region
d. In the Node Name option field, type the
e. In the Subnet Mask option field, type the
f. In the Gateway option field, type the
6. Type change node-names. (You are on Page 1 of 1 on the IP NODE NAMES form.)
a. In the Name option field, type
b. In the IP Address option field, type
7. Type add data-module (substitute with the appropriate extension number)
a. In the Type field, type ethernet
1 Page numbering is relative on the OPTIONS form. The total page count is affected by the options your
system is configured with. For example, if you have ASAI Core but neither ASAI Plus nor Computer
Telephony Adjunct Links, your total page count diminishes by one (4 of 9 instead of 4 of 10).

56 Installation Guide

Administrative Tasks for Avaya Platforms That Use the Co-Resident DLG

b. In the Port field, type
(Example: 01a0317)
c. In the Link option field, type 1
d. In the Name field, type
a. In the Extension field, type
b. In the Type field, type ADJ-IP
c. In the Name field, type
9. type change ip-services
a. In the Service Type field, type DLG
b. In the Enabled field, type y
c. In the Local Node field, type clan
d. In the Local Port field, type 5678
10. After completing the IP-Services Form (Step 9), continue on to the DLG Administration
form.
a. In the CTI Link field, type (substitute with the appropriate link number)
b. In the Enabled field, type y
c. In the Client Name field, type
d. In the Client Link field, type
11. Type status dlg cti-link, and on the DLG CTI LINK STATUS form, verify that the
Service State field displays established.

Issue 1 October 2003

Administering the Switch

58 Installation Guide

Chapter 3: Installing Avaya Computer
Telephony Server Software
This chapter includes the following sections and focuses on the activities associated with
installing the Avaya Computer Telephony Server software components.
●

Planning Your Installation on page 60

●

Guidelines for Upgrading Avaya Computer Telephony on page 64

●

Specialized Installations on page 66

●

Before You Install the Avaya Computer Telephony Server Software on page 67

●

Avaya Computer Telephony Installation Guidelines on page 68

●

Procedure for Initial, Default Installation of Avaya Computer Telephony Server
Software on page 70

●

Perform Initial Restart on page 85

●

Basic Maintenance Tasks on page 87

Issue 1 October 2003

Installing Avaya Computer Telephony Server Software

Planning Your Installation
Installing the Avaya Computer Telephony software represents a continuation of the switchspecific activities described in Chapter 2. Planning your installation represents the
transition from Phase 1 to Phase 2 (see Figure 3-1). During this stage, the activities are as
follows:
●

Gather the necessary information

●

Determine the requirements of your configuration
- If you are installing Avaya Computer Telephony in a NAT or a Firewall environment,
see Implementing a Firewall Strategy on page 34

●

Determine the type of installation — initial Installation or upgrade

●

Make sure your platform can support Avaya Computer Telephony

Each of these activities is described in the next part of this chapter.
Figure 3-1: “CTI — Planning Your Server Installation”

Computer Telephony Integration
Phase 1
TASK 1
Administer
DEFINITY

TASK 2
Administer
DLG

Phase 3

Phase 2
Install
Avaya CT
Server
Software
S

Install
Client
Software

Phase 2 involves gathering host names or IP addresses:
the DLG (on the MAPD)
the NIC on the Avaya CT Server that communicates with the DLG
the NIC on the Avaya CT Server that communicates with clients
DEFINITY

MAPD
DLG

Avaya CT Server

NIC

Clients

192.168.25.20

192.168.25.10

NIC
176.108.25.20

60 Installation Guide

Planning Your Installation

Gather the Necessary Information
The TCP/IP addressing information that is administered during DLG administration is
particularly relevant to installing the Telephony Services software (see Task 2: DLG
Administration on page 47). Make sure you have the following addressing information
before you start the Avaya Computer Telephony server software installation procedure.
●

The IP address of the DLG. The default is 192.168.25.10, but it is highly likely that this
has been changed to conform to your network addressing requirements.

●

The IP address that the DLG administrator assigned to the Avaya Computer Telephony
server. The default is 192.168.25.20. Again, it is highly likely that this IP address has
been changed to conform to your network addressing requirements. This IP address
refers to the Network Interface Card, on the Avaya Computer Telephony Server, that
communicates with the DLG. It is not the IP address of the NIC, on the Avaya Computer
Telephony server, that communicates with clients.

●

The host name or IP address that was assigned to the Avaya Computer Telephony
server.

Determine the Requirements of Your Configuration
Determining the requirements of your configuration involves identifying the Avaya
Computer Telephony software components you are going to implement. Basically this
comes down to one question: “does this configuration support both the Tserver (Telephony
Services Server) and the CVLAN (CallVisor PC Local Area Network) applications?" See
Chapter 5: Using CVLAN for information about CVLAN.

Determine the Type of Installation -- Initial Installation or Upgrade
If you are upgrading an earlier release of Avaya Computer Telephony, see Guidelines for
Upgrading Avaya Computer Telephony on page 64.

Make Sure Your Platform Can Support Avaya Computer Telephony
See Table 3-1: Server Hardware on page 62 and Table 3-2: Server Software on page 63
to make sure that you have the appropriate hardware and software.

Issue 1 October 2003

Installing Avaya Computer Telephony Server Software

Avaya Computer Telephony Hardware and Software
Requirements
Table 3-1 lists the server hardware requirements for Telephony Services and CVLAN
server which is based on Contact Center size (i.e number of Agents).
Table 3-1: Server Hardware
Low to Low MidEnd Contact
Center (10-200
Agents)

Mid-End Contact
Center (200-500
Agents)

High-End Contact
Center (500-2500
Agents)

CPU

Pentium III 350MHZ
or higher

Pentium® III
500MHZ or higher

Pentium® III
700MHZ or higher

RAM

256MB or higher

512MB or higher

Network
Connections

For a standard
installation, 2
network interface
card(s) are
recommended:
● one for the G3PD
● one for client
access
If your configuration
uses NAT or a
Firewall, see
Implementing a
Firewall Strategy on
page 34

Drives

CD-ROM drive: 3.5inch floppy drive (for
license and
authorization disks)

Disk Space1

300MB Hard Drive

1. Each disk space requirement is an approximation. The amount of disk space required also depends
on other factors such as, the number of users, types of activity performed, and number and/or size
of the trace files.

62 Installation Guide

Planning Your Installation

Table 3-2 lists the server software requirements for Telephony Services and CVLAN
Table 3-2: Server Software
Software

Description

Operating System

Any of the following:
● Windows NT 4.0 (Server is
recommended)
● Windows NT Service Pack 6a or
later, available from Microsoft
● Windows 2000 with Service Pack 2
● Windows XP
● Windows 2003

Network Software

TCP/IP protocol stack

Issue 1 October 2003

Installing Avaya Computer Telephony Server Software

Guidelines for Upgrading Avaya Computer
Telephony
Although the installation procedure in this chapter depicts an initial installation, you follow
the same basic procedure to upgrade. If you are upgrading, however, be sure to review
this section before you upgrade your Avaya Computer Telephony software.
●

If you install any Service Packs or if you upgrade Windows NT, Windows 2000,
Windows XP software on a machine that already has Telephony Services software
installed, you must reinstall all of the Telephony Services software components,
including the Telephony Services Security Database (SDB).

●

If you are upgrading (or migrating) from a NetWare Telephony Server to a Windows NT,
Windows 2000, Windows XP Telephony Server, see Appendix C: Migrating your
Security Database.

●

Uninstalling the Telephony Server software is not recommended when upgrading from
an earlier release unless the new software will be installed in a different directory on the
server. (Information about the Telephony Server is stored in the Windows NT, Windows
2000, Windows XP Registry. These registry settings are removed when the software is
uninstalled.)

●

Stop Telephony Services and the Logging Service before you attempt to install the new
software. See Manually Stopping Telephony Services on page 89.

●

Overwrite your previous installation of Avaya Computer Telephony. If the previous
installation did not use the default destination folders (C:\Program Files\Avaya\CT) for
these components, be sure to specify the destination folders that were used during the
initial installation. Steps 7 and 8 provide a Destination Directory dialog box that enables
you to browse to, and specify another destination for Avaya Computer Telephony server
files.

64 Installation Guide

Guidelines for Upgrading Avaya Computer Telephony

●

Do not re-install the Security Database for Telephony services. If you are upgrading, the
checkbox for “Security Database for Telephony Services” is not checked on the Server
Setup dialog box (Step 3). Setup detects the previous installation of the Telephony
Services Security Database (also referred to as Btrieve).
If you select this checkbox during an upgrade, Setup detects the previous installation
of Btrieve and displays a warning box indicating that you have Btrieve Workstation
v6.15 installed on this machine. In this case, you can continue with the installation —
you do not need to exit.

Other Things to Consider for an Upgrade
You can take advantage of current settings or provisions that were effected in a prior
installation.
●

userIDs/accounts with administrative permissions
At Step 12, on the Select Tserver Administrator dialog box, you can use the pulldown menu to see a list of all the user IDs/accounts with administrative permissions
on the Telephony Server.
- Select the default user ID/account that the Telephony Server should use when it
starts. Then click Next.
The Telephony Server administrative user ID/account that you choose here
becomes the default user ID/account for first time use of administration software
tools (i.e., Telephony Services Administrator [TSA32] and Telephony Services
Maintenance [TSM32]).

Issue 1 October 2003

Installing Avaya Computer Telephony Server Software

Specialized Installations
The term specialized installations refers to effecting Avaya Computer Telephony
installations that do not require all of the Avaya Computer Telephony software
components. This section describes two kinds of specialized installations.
●

Avaya Computer Telephony without the Telephony Services Security Database
You can elect not to install the Telephony Services Security database if you already
have a database that serves your applications’ needs. To install Avaya Computer
Telephony without the Telephony Services Security Database, make sure that the
checkbox for "Telephony Services Security Database" is unchecked (at Step 5 of the
installation procedure). If you implement an installation of Avaya Computer Telephony
without the Telephony Services security database, you do not have access to the
Telephony Services Administration capabilities.

●

Avaya Computer Telephony without the G3PBX Driver
If you are developing software applications and you do not have access to a DEFINITY
switch (and you are using the DEFINITY simulator, for example) be sure that the
checkbox for "DEFINITY G3 PBX Driver and CVLAN" is unchecked (at Step 4).

66 Installation Guide

Before You Install the Avaya Computer Telephony Server Software

Before You Install the Avaya Computer Telephony
Server Software
Here are some tips for effecting a smooth, uninterrupted installation.
●

Determine the IP address of the Telephony Server.
In the Enter Information dialog box (Step 11), the Setup program asks you to specify
the IP address of the server. This IP address refers to the NIC that the Tserver uses for
communicating with its clients (as opposed to the IP address for the NIC designated for
the G3 PBX Driver). To locate this IP address, use this procedure.
Click Start, point to Settings, click Control Panel, double-click Network, click
Protocols (tab), select TCP/IP Protocol, and click Properties.

●

Know the locations of the installation-specific readme files.
Readme file notifications are embedded in the installation procedure. To avoid
disruption during installation, you can clear the checkboxes for viewing the readme
files. Review the readme files after installation.
- Security Database Readme file
From the Windows NT, Windows 2000 or Windows XP desktop, click Start, point to
Programs, click Btrieve Technologies Database, and double-click Btrieve
Workstation Engine Readme
- Tserver Readme file.
From the Windows NT, Windows 2000 or Windows XP desktop, click Start, point to
Programs, Avaya Computer Telephony, TS Readme
- G3PBX Driver Readme
From the Windows NT, Windows 2000 or Windows XP desktop, click Start, point to
Programs, Avaya Computer Telephony, DEFINITY G3 PBX, and click G3PBX
Driver Readme

●

Have license disks (or authorization disks) for Telephony Services and the
G3PBX Driver handy. Setup prompts you for them during the installation procedure.

●

Unless you are an experienced administrator, effect a default installation.
If you are an experienced administrator and you want to override the defaults, these
capabilities are available.
- The Destination Directory dialog boxes allow you to customize your directory
settings. Unless you are able to effect a customized installation, accept the defaults.
- The G3PBX Driver Configuration dialog box allows you to carry out administrative
tasks.
●

You can specify the DEFINITY G3PBX Driver IP address and add links.

Issue 1 October 2003

Installing Avaya Computer Telephony Server Software

●

If you are setting up CVLAN, you can click the ADMIN button and add CVLAN
clients. See ‘‘Adding a CVLAN Client’’ on page -128 of this document.

Alternatively, you can make G3PD changes after completing the installation procedure.
Use either G3 PBX Driver Configuration Utility or the G3 PBX Link Change Utility. See
Chapter 2 of the Avaya Computer Telephony 1.3 G3 PBX Driver and CVLAN
Administration and Maintenance Guide (DEFNETM.PDF).

Avaya Computer Telephony Installation Guidelines
When installed in an NT Domain, Avaya Computer Telephony should be installed as an
Application Member Server. Although Avaya Computer Telephony can be installed on a
Domain Controller it is not recommended.
Avaya Computer Telephony should not be installed on a server that performs any of the
following functions;
●

Print Server

●

Web Server

●

FTP Server

●

Fax Server

●

RAS Server

●

Router

●

Voice/Screen Call Recorder Server

●

Intelligent Voice Response Server

Avaya Computer Telephony should not be installed on a server that is running applications
that use a Java Virtual Machine (Microsoft, Sun, or IBM).
Avaya Computer Telephony should not be installed on a server that is running Microsoft
SQL or any other database.
Avaya Computer Telephony can be Co-Resident with the following Avaya Applications/
Platforms.
●

BCMSVu

●

Avaya Computer Telephony Internet Solutions

●

Avaya Call Service

●

Avaya Interaction Center

●

Avaya Enterprise Manager

●

DEFINITY Anywhere

68 Installation Guide

Avaya Computer Telephony Installation Guidelines

●

Avaya Web Collaboration

●

Avaya Messaging

●

Avaya Unified Communication Center

Issue 1 October 2003

Installing Avaya Computer Telephony Server Software

Procedure for Initial, Default Installation of Avaya
Computer Telephony Server Software
Follow these steps for an initial installation Avaya Computer Telephony Server Software.
You can click Cancel or Exit at any time to exit from the Setup program.

Note:

Note:
This procedure depicts the CD-ROM drive ID as D:\. Substitute D with the
appropriate letter as necessary.
1. Log on to the Windows NT, Windows 2000 or Windows XP server as a user with
administrator-equivalent permissions.
2. Insert the CD into the CD-ROM drive.
(When Windows NT, Windows 2000 or Windows XP is using the Explorer shell, the
Setup program runs automatically if you have not disabled the AutoRun feature).
3. (Applies only if AutoRun is disabled) Click Start, then click Run. In the Run dialog box,
enter D:\WININST\SETUP.EXE (or Browse to it on the CD) to start the Setup
program.
Setup displays the Telephony Services Setup dialog box.

70 Installation Guide

Procedure for Initial, Default Installation of Avaya Computer Telephony Server Software

4. Click the button for Avaya Computer Telephony Software.
Setup displays the Server Setup dialog box. For an initial installation, all server
components are selected by default.

Issue 1 October 2003

Installing Avaya Computer Telephony Server Software

5. click Next to accept the default settings and continue with the installation.
Setup displays the message, “Installation in progress, please wait...”, followed by the
Welcome dialog box for the Telephony Services Security Database (Btrieve
Workstation Engine v6.15).

72 Installation Guide

Procedure for Initial, Default Installation of Avaya Computer Telephony Server Software

6. Click Next to continue with the installation.
Setup displays a dialog box indicating that Setup will install Btrieve Workstation Engine
v6.15 in the default destination folder, C:\Program Files\BTI\Win32\.

7. Click Next to accept the default destination folder and continue with the installation.

Issue 1 October 2003

Installing Avaya Computer Telephony Server Software

Setup displays the Installation Complete dialog box, indicating that Setup has finished
installing Btrieve on your computer.

8. Click Finish (you have finished installing Btrieve) and continue with the installation to
install Telephony Services on your computer.

74 Installation Guide

Procedure for Initial, Default Installation of Avaya Computer Telephony Server Software

Setup displays the message, “Installation in progress, please wait...”, followed by the
Welcome dialog box for the Telephony Services Setup program.

9. Click Next to continue with the installation.

Issue 1 October 2003

Installing Avaya Computer Telephony Server Software

Setup displays the Choose Destination Location dialog box indicating that Setup will
install the Telephony Services files in the default destination folder, C:\Program
Files\Avaya\CT\tsrv.

10. Click Next to accept the default destination folder and continue with the installation.

76 Installation Guide

Procedure for Initial, Default Installation of Avaya Computer Telephony Server Software

Setup displays the IP Address Required dialog box.

11. Enter the IP address for this Telephony Server (which is the IP address of the NIC that
the Telephony Server uses for communicating with TSAPI clients), and click Next.

Note:

Note:
If you are configuring the Telephony Server in a firewall environment, see
one of the following documents, based on the location of your firewall.
●

If your firewall is between the client and the Avaya Computer Telephony
server, see Chapter 6 of the Telephony Services Administration and
Maintenance Guide (NETMANGD.PDF).

●

f your firewall is between the Avaya Computer Telephony server and
MultiVantage, see Chapter 2 of the G3PBX Driver and CVLAN Administration
and Maintenance Guide (DEFNETM.PDF).

Issue 1 October 2003

Installing Avaya Computer Telephony Server Software

Setup displays the Select Tserver Administrator dialog box with the list box displaying
Administrator.

Administrator

12. Click Next to continue with the installation.
Setup copies the files and installs the Telephony Server software (as Windows NT,
Windows 2000 or Windows XP services) and prompts you to insert the license disk.

78 Installation Guide

Procedure for Initial, Default Installation of Avaya Computer Telephony Server Software

13. Insert the disk in the appropriate drive on the server PC, and click OK.
After copying the license file, Setup displays the InstallShield Wizard Complete dialog
box, indicating that Setup finished installing Telephony Services on your computer.

14. Click Finish (you have finished installing Telephony Services software) and continue
with the installation to install the DEFINITY G3PBX Driver on your computer.

Issue 1 October 2003

Installing Avaya Computer Telephony Server Software

Setup displays the message, “Installation in progress, please wait...” followed by the
Welcome dialog box for the DEFINITY G3 PBX Driver Setup. (Setup installs the
CVLAN Server during this phase of installation).

15. Click Next to continue with the installation.

80 Installation Guide

Procedure for Initial, Default Installation of Avaya Computer Telephony Server Software

Setup displays the Choose Destination Location dialog box indicating that Setup will
install the G3PBX Driver in the default location, C:\Program Files\Avaya\CT\G3PD\.

16. click Next to accept the default destination folder and continue with the installation.

Issue 1 October 2003

Installing Avaya Computer Telephony Server Software

Setup displays the DEFINITY G3 PBX Driver Configuration dialog box.

17. Complete the G3PBX Driver configuration box as follows,

Note:

●

in the DEFINITY G3 PBX Driver IP Address field, enter the IP address of the NIC
used for communicating with the switch.

●

In the Advertised Switch Name field, enter the appropriate name for the switch you
are connecting to (the default name is Avaya_ECS).

●

in the IP Address or Host Name field, enter the appropriate IP address for the
switch you are connecting to (this the IP address of the Ethernet interface for the
DEFINTY LAN Gateway).

Note:
If you are installing Avaya Computer Telephony in a firewall environment,
where the firewall is between MultiVantage and the Avaya Computer
Telephony Server, see Chapter 2 of the G3PBX Driver and CVLAN
Administration and Maintenance Guide (DEFNETM.PDF).

82 Installation Guide

Procedure for Initial, Default Installation of Avaya Computer Telephony Server Software

Setup displays the Review Settings dialog box with the current settings for the
installation.

18. Click Next to continue with the installation.
Setup displays the License Disk Required dialog box.

Issue 1 October 2003

Installing Avaya Computer Telephony Server Software

19. Insert the DEFINITY Driver Authorization [G3PDAUTH] disk in the appropriate drive on
the server PC, and click OK.
After copying the G3PDAUTH file, Setup displays the following Information box,
indicating that Setup is complete.

20. Click OK to continue with the installation.
Setup displays the InstallShield Wizard Complete dialog box.

21. Click Finish to complete the Installation of the Avaya Computer Telephony Server
software (This step stops the Setup program).

Note:

Note:
Make sure you review each of the readme files associated with the
installation. See Before You Install the Avaya Computer Telephony Server
Software on page 67 for locations of the readme files.

84 Installation Guide

Perform Initial Restart

Perform Initial Restart
After installing the Avaya Computer Telephony software you do not have to reboot the PC.
To start using Avaya Computer Telephony server software follow these steps.
1. Click Start point to Programs, Avaya Computer Telephony, and click TS Controller.
2. From the TS Controller dialog box, click Start.

Issue 1 October 2003

Installing Avaya Computer Telephony Server Software

Desktop Components
Figure 3-2 depicts the desktop icons provided by Avaya Computer Telephony software.
Figure 3-2: Avaya Computer Telephony Components on Your Desktop

86 Installation Guide

Basic Maintenance Tasks

Basic Maintenance Tasks
This section describes the following basic maintenance tasks for Telephony Services:
●

Starting and Stopping the Telephony Services Software

●

Manually Stopping Telephony Services

●

Removing Software

Starting and Stopping the Telephony Services Software
This section describes the following tasks.
●

starting Telephony Services
- enabling automatic startup and recovery of telephony services

●

performing manual start and enabling automatic startup and recovery

●

manually stopping Telephony Services

Issue 1 October 2003

Installing Avaya Computer Telephony Server Software

Starting Telephony Services
You have already encountered this procedure in the context of the installation (‘‘Perform
Initial Restart’’ on page -85). Recall that when the Telephony Services server software (the
Telephony Server, or Tserver and the CVLAN server) is initially installed, it is in the
“STOPPED” state and must be manually started.
Follow these steps to start the Telephony Services server.
1. Click Start, point to Programs, Avaya Computer Telephony, and click TS Controller.

2. Click Start to start Telephony Services.
Telephony Services starts the Tserver and the CVLAN server and Information box
displays.
3. Click OK to dismiss the information box and return to the Telephony Services
Controller dialog box.
On the Telephony Services controller dialog box, under “Status,” the Telephony
Services state is listed as “RUNNING.”
4. Click Close to exit the Telephony Services Controller dialog box.
This completes the procedure to manually start Telephony Services software.

88 Installation Guide

Basic Maintenance Tasks

Enabling Automatic Startup and Recovery
This procedure is an extension of the previous procedure, ‘‘Starting Telephony Services’’
on page -88, with steps for enabling automatic Startup and Recovery. You are
recommended to effect automatic startup and recovery.
1. Click Start, point to Programs, Avaya Computer Telephony, and click TS Controller.
The Tserver displays the TS Controller dialog box.
2. Under Startup, click the checkbox next to “Automatically Start Telephony Services On
Server Boot.”
3. Under Recovery, click the checkbox next to “Automatically Restart Telephony
Services.”
4. Click Close to exit the Telephony Services Controller dialog box.
This completes the procedure for enabling automatic startup and recovery.

Manually Stopping Telephony Services
Follow this procedure to manually or explicitly stop Telephony Services and the CVLAN
server.
1. Click Start, point to Programs, Avaya Computer Telephony, and click TS Controller.
2. From the Telephony Services Controller dialog box, click Stop.
The Telephony Services and CVLAN server are stopped, and an Information box
displays.
3. Click OK
The operating system displays a message box that prompts you to stop the Logging
Service.

4. Click Yes to stop the logging service.
5. From the Telephony Services Controller dialog box, click Close to exit the Telephony
Services Controller.

Issue 1 October 2003

Installing Avaya Computer Telephony Server Software

Removing Software
Use the standard Windows procedure described below to remove the following server
components.
●

Btrieve Workstation Engine v6.15.

●

Telephony Services

Note:

●

Note:
Before you can remove the Telephony Services server software (Tserver
and CVLAN server) you must unregister telephony services. Follow the
procedure in ‘‘Reinstalling Telephony Services Server Software’’ on page 90 (which includes the standard Windows procedure for removing
Telephony Services).
DEFINITY G3 PBX Driver

Procedure to Remove Programs
1. From the desktop click Start, point to Settings and click Control Panel.
2. From the Control Panel, click Add/Remove Programs.
3. Windows displays the Add/Remove Programs Properties dialog box.
4. Select the appropriate module you wish to uninstall (Avaya Computer Telephony
Services, Btrieve, or Avaya Computer Telephony ECS Driver), and click Add/Remove.
5. Windows displays the Confirm File Deletion box, asking you to confirm that you want to
completely remove the software program and all of its components.
6. Click Yes.
The uninstall program removes the software and displays an Information box indicating
that the program and all of its components have been removed.
7. Click OK.
This completes the procedure to remove a software program.

Reinstalling Telephony Services
Server Software
If you need to reinstall the Telephony Services software, it is recommended that you do not
uninstall the currently installed Telephony Services software before performing the
reinstallation. This is because many of the parameters used by Telephony Services are
stored in the Windows NT, Windows 2000 or Windows XP registry. When the software is
uninstalled, these parameters are also removed.

90 Installation Guide

Basic Maintenance Tasks

Note:

Note:
Although Windows NT, Windows 2000 or Windows XP registry information is
removed when you uninstall the Telephony Services software, the log files
(error log file, message trace file, performance log, traffic log, and SDB log
file) are not removed. When the Telephony Server is restarted after
reinstallation, new log file information starts at the top of the files. Any
information previously contained in the files is overwritten with the new
information.

To reinstall the Telephony Service software, follow the steps in Procedure for Initial, Default
Installation of Avaya Computer Telephony Server Software.

Issue 1 October 2003

Installing Avaya Computer Telephony Server Software

92 Installation Guide

Chapter 4: Installing Avaya Computer
Telephony TSAPI Client Software
This chapter describes installation related procedures for Avaya Computer Telephony,
Telephony Services Application Programming Interface (TSAPI) clients. It includes the
following topics:
●

Avaya Computer Telephony Clients and Private Data Versions on page 94

●

Planning Your Installation on page 94

●

TSAPI Client Hardware and Software Requirements on page 96

●

Before You Install the Avaya Computer Telephony TSAPI Client Software on page 100

●

Installing the Windows Client Software on page 101

●

Installing TSAPI Solaris Sparc Client Software on page 110

●

Installing UnixWare Client Software on page 112

●

Installing HP-UX Client Software on page 116

●

Removing Telephony Services Client Software on page 119

Issue 1 October 2003

Installing Avaya Computer Telephony TSAPI Client Software

Avaya Computer Telephony Clients and Private Data
Versions
In the context of general information about Avaya Computer Telephony, Chapter
1: Learning About Avaya Computer Telephony provides Table 1-1 on page -35, which
associates Avaya Computer Telephony, Client Application platform operating systems with
the level of DEFINITY Private Data Versions that they support.
Briefly summarized, Table 1-1 on page -35 states that the Avaya Computer Telephony
Windows 32-bit client platform and the Avaya Computer Telephony UnixWare client
platform supports all versions of DEFINITY Private Data up to Private Data Version 6.

Planning Your Installation
Installing the Avaya Computer Telephony TSAPI client software represents a continuation
of the server-specific activities described in Chapter 3. Planning your installation
represents the transition from Phase 2 to Phase 3 (see Figure 4-1). During this transitional
state, the activities are as follows.
●

Make sure that your client workstations can support Avaya Computer Telephony (see
‘‘Avaya Computer Telephony Client Hardware and Software Requirements’’ on page 96)

●

Determine if this is an upgrade or an initial installation

●

Determine how you intend to distribute the software
- CD-ROM
- Network Drive

Each of these activities is described in the next part of this chapter.

94 Installation Guide

Planning Your Installation

Figure 4-1: The CTI Continuum — Planning Your Client Installation

Computer Telephony Integration
Phase 1
TASK 1
Administer
DEFINITY

TASK 2
Administer
DLG

DEFINITY

MAPD
DLG

Phase 2
Install
Avaya CT Server
Software

Phase 3
Install
Client
Software

Avaya CT Server

NIC
192.168.25.20

192.168.25.10

Client
Administrative
Workstation
Client
Basic
Workstation

NIC
176.108.25.20

Client
Basic
Workstation

Issue 1 October 2003

Installing Avaya Computer Telephony TSAPI Client Software

TSAPI Client Hardware and Software Requirements
Tables 4-1 and 4-2 list the TSAPI client hardware and software requirements.

Avaya Computer Telephony Client Hardware and
Software Requirements
Table 4-1: Windows-Based Client Hardware and Software Requirements
CPU

486 or Pentium recommended

RAM

Windows 95
8 MB required; 16 MB recommended
Windows NT, Windows 2000, Windows XP or
Windows 98
16 MB required; 24-32 MB recommended

Free Memory

Installing and running Telephony Services and
CVLAN on a Windows client requires 500 KB of
free memory.

Disk Space

500 KB of disk space is required, or 1.5 MB if the
Telephony Services Administration software is
also installed.

Win32 Client
Platform
Operating
Systems

Win32 clients:
Windows 95
Microsoft TCP/IP or equivalent 32-bit Winsock
TCP/IP transport provider
Windows 98
Microsoft TCP/IP or equivalent 32-bit Winsock
TCP/IP transport provider
Windows NT
Windows NT 3.51 or 4.0 (Workstation or Server);
Microsoft TCP/IP or equivalent 32-bit Winsock
TCP/IP transport provider
Windows 2000
Windows XP

(The Win32 client
platform operating
systems (i.e.,
Windows 95,
Windows 98,
Windows NT,

Windows 2000,
Windows XP)

96 Installation Guide

TSAPI Client Hardware and Software Requirements

UnixWare Client Hardware and
Software Requirements
Table 4-2: UnixWare Client Hardware and Software Requirements
CPU

386 or higher required; 486 or Pentium
recommended

RAM

UnixWare Personal Edition
8 MB required
UnixWare Application Server
12 MB required

Disk Space

300 KB

Operating
Systems

UnixWare 1.x
UnixWare 2.0x

HP-UX Client Hardware and Software Requirements
Table 4-3: HP-UX Client Hardware and Software Requirements
CPU

HP 9000 Series 700 or Series 800 machine

RAM

32 Mbytes required

Disk Space

1 Mbyte

Operating
System

HP-UX

TSAPI Solaris Client Hardware and
Software Requirements
Table 4-4: TSAPI Solaris Client Hardware and Software Requirements
Disk Space

1.2 MB

Processor

SPARC

Operating
Systems

Solaris 2.5.1, Solaris 8

Issue 1 October 2003

Installing Avaya Computer Telephony TSAPI Client Software

Telephony Services Client Software
Telephony Services client software for Windows consists of the following components. (For
information about CVLAN clients, see Chapter 5: Using CVLAN.)
●

Telephony Services client software — allows TSAPI applications to communicate with
the Telephony Server.

●

Client administration software — enables the system administrator to perform specific
tasks. The Win32 client software includes administration and maintenance software for
the Telephony Server. The Win32 software also includes operation, administration, and
maintenance software for the DEFINITY G3 PBX Driver.

●

DEFINITY G3 private data support libraries — allow TSAPI applications to take
advantage of DEFINITY G3-specific driver features that are available through private
data and escape services. This software is installed automatically as part of the client
installation procedure.

Once you have installed Telephony Services software on your client, you can easily access
the Telephony Services applications by creating a shortcut icon for each application. (Use
the “Create Shortcut icon” feature of Windows NT, Windows 2000, Windows XP, Windows
95, or Windows 98 to create the icons. Refer to your Windows documentation for details.)

Telephony Services Client Platforms
The Telephony Services client software can be installed on the following client platforms:
●

Windows NT 3.51 workstation or server, Windows NT 4.0 workstation or server,
Windows 2000, Windows XP, Windows 95 or Windows 98.
- 32-bit (Win32) TSAPI applications use the 32-bit Telephony Services client software.

●

UnixWare — The UnixWare client software comes in single-threaded (UnixWare 1.x)
and multi-threaded (UnixWare 2.0x) versions. For details on using the Link Status
command, see the “Link Status Command” section in Chapter 3 of Avaya Computer
Telephony 1.3 G3 PBX Driver and CVLAN Administration and Maintenance
(DEFNETM.PDF).

●

Solaris Sparc - The Solaris client software can be installed on a Solaris SPARC client
workstation.

●

HP-UX - The HP-UX client software can be installed on a client PC.

98 Installation Guide

TSAPI Client Hardware and Software Requirements

Client Administration Software Components
The Telephony Services client software includes Windows based administrative software
that allows the system administrator to maintain and operate the system. Follow these
guidelines before you install the client software:
●

Identify the system administrator’s workstation. You will need to install the Windowsbased administrative software on an appropriate client workstation.

●

Determine how you intend to distribute and install the client software (CD-ROM, disk,
and, if applicable, from the network server).

Client Administration Workstation
You can assign the PC designated as the Telephony Services server as the Administrative
Client workstation, or you can use a separate workstation on your LAN.
The client software includes the following applications that enable the system administrator
to perform specific tasks:
●

Telephony Services Administrator (TSA32) is the client-based 32-bit Windows NT,
Windows 2000, Windows XP, Windows 95 or Windows 98 application that allows the
system administrator to enter information for the SDB. The 32-bit Tserver maintenance
and status operations are accessed through the TSM32.

●

Telephony Services Maintenance (TSM32) is the client-based 32-bit Windows NT,
Windows 2000, Windows XP, Windows 95, or Windows 98 application that allows the
system administrator to view and modify maintenance and status parameters (such as
Error Logging, Message Tracing, or Tlink Information).

●

DEFINITY G3 PBX Driver Administrator utility is a client-based 32-bit Windows NT,
Windows 2000, Windows XP application that provides maintenance commands that are
particularly useful if there are communications problems between the server and the
DEFINITY LAN Gateway. This utility can be used to perform G3PD OA&M tasks for the
Tserver. It does not apply to CVLAN.

Issue 1 October 2003

Installing Avaya Computer Telephony TSAPI Client Software

Before You Install the Avaya Computer Telephony
TSAPI Client Software
Be sure to read this section before you run the Setup program to install the Avaya
Computer Telephony TSAPI Client Software.
●

Obtain the IP address or Host Name of the Telephony Server
In the TCP/IP Name Server dialog box, the Setup program asks you to specify the IP
address of the server.

●

Review the Readme file
The Client Readme file contains information you may need before installing Telephony
Services on your client. It is located on the Avaya Computer Telephony CD-ROM as
follows: :\Readmes\Client Readme.txt

Note:

Note:
The Setup program installs the Client Readme file as follows:
C:\Program Files\Avaya\CT\TS Win32\Client Readme.txt

100 Installation Guide

Installing the Windows Client Software

Installing the Windows Client Software
Follow these steps for an initial installation of Telephony Services software on the Windows
client workstation designated as the Administrative Client Workstation. You can click
Cancel or Exit at any time to exit from the Setup program.
1. Log on to the PC as a user with administrator-equivalent permissions.
2. Insert the CD into the CD-ROM drive.
(When Windows NT, Windows 2000, Windows XP is using the Explorer shell, the
Setup program runs automatically if you have not disabled the AutoRun feature).
3. (Applies only if AutoRun is disabled) Click Start, then click Run. In the Run dialog box,
enter D:\WININST\SETUP.EXE (or Browse to it on the CD) to start the Setup
program.
The Telephony Services Setup screen displays:

Issue 1 October 2003

101

Installing Avaya Computer Telephony TSAPI Client Software

4. Click on the Client Software button.
Setup displays the Client Setup dialog box.

102 Installation Guide

Installing the Windows Client Software

5. Click the button for Telephony Services 32-bit Windows Client.
Setup displays the Welcome dialog box.

Issue 1 October 2003

103

Installing Avaya Computer Telephony TSAPI Client Software

6. Click Next to continue with the installation.
Setup displays the Telephony Services Setup Options dialog box.
T

7. If applicable, under Components, click the checkbox to select Administration Utilities,
and click Next.

104 Installation Guide

Installing the Windows Client Software

Note:

Note:
Select Administration Utilities only if you are responsible for administering
and maintaining the Avaya Computer Telephony Server.
Setup displays the TCP/IP Name Server Configuration dialog box.

8. (See the Note below for firewall installations.) In the Host Name or IP Address field
enter the IP address of the Telephony Server, and in the TCP Port field, enter 450. If
your installation uses more than one Telephony Server, click Add to List.

Note:

Note:
If you are installing the client software in a firewall environment, see For
more information about NAT and Firewall environments, see Implementing
a Firewall Strategy on page 34.
9. (Skip this step if you used IP addresses in Step 8) In the Host Name or IP Address
follow these guidelines for your host name entry.
●

If you are not using DNS, enter the host name of the Tserver.

●

If you using DNS, type the fully qualified domain name, such as
tserver.company.com

Issue 1 October 2003

105

Installing Avaya Computer Telephony TSAPI Client Software

Note:

Note:
If you enter the wrong Host Name or mistype the name, a warning message
displays stating that the name appears to be invalid. The name will be added
to the list but you should contact your administrator to verify that you have
entered the address correctly.
Note:
Setup saves the information from the TCP/IP Name Server Configuration
dialog box in a tslib.ini file in the Windows directory. You can use a copy of
the tslib.ini file to streamline subsequent client installations. See Setting Up
Multiple Clients on page 108.
Setup searches your system for old Telephony Services software and issues a
message as it performs each search.
If the Setup program finds copies of CSTA32.DLL and ATTPRV32.DLL, it will
request confirmation to delete the old software.

106 Installation Guide

Installing the Windows Client Software

Note:

Note:
It is recommended that you allow Setup to remove these files. (Setup does
not make copies.) If you do not remove these files, Telephony Services
applications may not operate correctly.
After completing the search, Setup copies the appropriate files and creates the TS
Win32 Client program group (Windows NT 3.51) or program folder in the “Start”
menu (Windows 95, Windows 98, Windows NT, Windows 2000 or Windows XP).

10. Click Finish.
This completes the Telephony Services 32-bit Windows client installation and setup.

Issue 1 October 2003

107

Installing Avaya Computer Telephony TSAPI Client Software

Installing the Windows Client Software from a Network Drive
This section describes how to install Windows 32-bit client software from a network drive.
In addition, it includes information on how to verify the installation. You can use this
procedure to set up additional administrative clients or multiple basic clients (basic clients
are client workstations without the administrative software).
To install the Windows client software from a network drive, you must first transfer the
WIN32 directory from the CD to the network drive. Then you can install from the file server.
1. Create or locate the directory \CSTA\CLIENT\TSAPI\Windows on a network drive.
2. Change to the \CLIENT\TSAPI\Windows directory on the CD-ROM.
3. Copy all files from the \CLIENT\TSAPI\Windows directory on the CD-ROM to the
\CSTA\CLIENT\TSAPI\WIN32 directory on the network drive. Use the Windows File
Manager, the Windows Explorer, or the following DOS command:
XCOPY source_directory destination_directory /s /e

! CAUTION:
Do not use the COPY command for this procedure. It is important to
maintain the directory structure within each subdirectory.

CAUTION:

Note:

Note:
Use an ASCII text editor such as Windows Notepad to read the
README.TXT file (located in \CLIENT\TSAPI\Windows\README.TXT).
This file contains information you may need before installing Telephony
Services on your client.
4. From the \CSTA\CLIENT\TSAPI\Windows directory on the network drive, run
SETUP.EXE.

Setting Up Multiple Clients
If multiple clients are to use the same Telephony Server, you can simplify subsequent client
installations. You must install from a network drive to perform this procedure.
●

Install the Telephony Services Client on a client workstation. Then, do either of the
following:

●

Copy the tslib.ini file that you created on the client (located in the Windows directory)
back to the Windows directory on the network file server. Any subsequent installations
will then have the new tslib.ini provided as the default, and each client will not have to
enter TCP/IP information.

●

Or, copy the tslib.ini file that you created on the client (located in the Windows directory)
to a file server. This file must be accessible to all the TCP/IP Telephony Services clients.
Then, using a text editor, modify the tslib.ini file on the client and put the following line in

108 Installation Guide

Installing the Windows Client Software

the [Shared Admin] section: tslib.ini=n:\csta\tslib.ini (where "n:\csta\"
specifies the network drive and path to the tslib.ini file on your server). Remove the
[Telephony Servers] section. Copy the tslib.ini file from your client back to the Windows
directory on the network file server for use in subsequent installations.

Verifying 32-bit Client Software Installation
1. Run the "TS Test" (TSTEST.EXE) application. Click Start, point to Programs, Avaya
Computer Telephony, TS Win32 Client, and click TS Test.
2. Select the Tserver CSTA service you want to test by using the "Server" field.
3. Enter login information.
4. Enter the phone numbers that are properly administered in DEFINITY and the Avaya
Computer Telephony server in the "From" and "To" fields and select "Dial."
5. If you experience trouble, run "TS Spy" (TSSPY32.EXE), reexecute steps 1 through 4
and monitor the activity between the Tserver and TS Test.

Issue 1 October 2003

109

Installing Avaya Computer Telephony TSAPI Client Software

Installing TSAPI Solaris Sparc Client Software
The Solaris client software can be installed on a Solaris SPARC client workstation.

Note:

Note:
In order to perform the installation, the Solaris Volume Manager must be
running. Solaris runs the Volume Manager by default; however, if the
Volume Manager has been shut off, the installation will fail.)
1. Become super-user (root): su
2. Enter the root password when prompted.
3. Insert the Telephony Services CD-ROM into your Solaris SPARC system CD-ROM
drive.

Note:

Note:
Solaris File Manager users may find it more convenient to access the CDROM by double-clicking on the tsapicl icon in the File Manager’s /cdrom
folder.
4. At the command prompt, enter the pkgadd command.
The pkgadd command format is as follows:
pkgadd -d /cdrom/cdrom0/client/TSAPI/sparc/tsapicl.spl

Note:

Note:
For a detailed description of the pkgadd command, refer to your Solaris
SPARC documentation.
The system now displays a list of the packages.
5. Select the tsapicl package.
6. Once the installation is complete a message is displayed, "Installation of tsapicl was
successful."
7. Type eject to eject the CD from the CD-ROM drive.

After installation has completed, asaidll.lib, asaidll.dll, libcsta.sl, libattpriv.sl, readme.txt,
tslibrc, tstest, header files, and some utilities will have been installed.

110 Installation Guide

Installing TSAPI Solaris Sparc Client Software

Verifying TSAPI Solaris SPARC Client Software Installation
1. Edit the tslibrc file (see Editing the Template File -- tslibrc on page 118).
2. Execute the TS Test and make a call.

Issue 1 October 2003

111

Installing Avaya Computer Telephony TSAPI Client Software

Installing UnixWare Client Software
The Telephony Services client software for UnixWare can be installed from a command
line, from a CD, or from diskettes.

Installing from Command Line
The Telephony Services software is installed from the command line via the UnixWare
pkgadd command. To do this, you must be logged on as root. Desktop users should open
a "Terminal" window.

Note:

Note:
For a detailed description of the pkgadd command, refer to your UnixWare
documentation.

Installing from the CD
Follow these steps to install the UnixWare client from the CD.
1. Become super-user (root): su
2. Enter the root password when prompted.
3. Insert the Telephony Services CD-ROM into your workstation CD-ROM drive.
4. At the command prompt, mount the CD-ROM.
The mount command format is as follows:
mount -F cdfs -r /dev/cdrom/device /mountpoint
Note: For UnixWare 7.x, use this format
mount -F cdfs -r -onoextend /dev/cdrom/device /mountpoint
where device specifies the CD-ROM drive that contains the Telephony Services
installation disk and mountpoint is the name of an existing directory
(such as /cdrom1 or /CD-ROM_1) on which to mount the CD-ROM. You can use the
ls command to find the appropriate names for your system.

Note:

Note:
Desktop users may find it easier to mount the CD-ROM by double-clicking
on the CD-ROM icon in the "Disks-etc" folder.

112 Installation Guide

Installing UnixWare Client Software

5. At the command prompt, enter the pkgadd command.
The pkgadd command format is as follows:
pkgadd -d /mountpoint/client/tsapi/unixware/nwtslib.spl
where mountpoint is the name of an existing directory (such as /cdrom1 or
/CD-ROM_1) on which to mount the CD-ROM. (Note that the full pathname, beginning
with a ’/’, is required.)
6. The system now displays a list of the packages in the spool file. Press to
select the nwtslib package.
7. Specify the transport type.
UnixWare clients can use either IPX/SPX or TCP/IP as their network transport. The
system displays a list of transports and the following message:
Please specify a transport type for the Telephony Services
library. (To access Windows NT, Windows 2000 or Windows XP
Telephony Servers, you must select "tcp.")
spxIPX/SPX Protocol
tcpTCP/IP Protocol
Select a transport type [?,??]
Type "s" for IPX/SPX or "t" for TCP/IP; then press .

Note:

Note:
This release of Telephony Services for Windows NT, Windows 2000,
Windows XP only supports TCP/IP as a network protocol; you must select
TCP/IP even though both options appear on the screen.
8. The pg command displays the Telephony Services "readme" file, tslib.readme.
This file contains information about changes that were made after the manuals were
completed.
9. The installation is complete. Unmount the CD-ROM.
The umount command format is as follows:
umount /dev/cdrom/device
where device specifies the CD-ROM drive that contains the Telephony Services
installation disk. You may now remove the CD-ROM.

Note:

Note:
If TCP/IP is selected for the transport type, a template file called /usr/lib/
tslibrc is created during installation. For more information, see Editing the
Template File -- tslibrc on page 118.

Issue 1 October 2003

113

Installing Avaya Computer Telephony TSAPI Client Software

Installing from Diskette
To install a UnixWare client using a diskette, you must first create the installation diskette,
then follow the installation procedure using the files on the diskette. You will need one
formatted high-density diskette.
1. Become super-user (root): su
Enter the root password when prompted.
2. Insert the Telephony Services CD-ROM into your workstation CD-ROM drive.
3. At the command prompt, mount the CD-ROM.
The mount command format is as follows:
mount -F cdfs -r /dev/cdrom/device /mountpoint
where device specifies the CD-ROM drive that contains the Telephony Services
installation disk and mountpoint is the name of an existing directory (such as /
cdrom1 or /CD-ROM_1) on which to mount the CD-ROM. You can use the ls
command to find the appropriate names for your system.

Note:

Note:
Desktop users may find it easier to mount the CD-ROM by double-clicking
on the CD-ROM icon in the "Disks-etc" folder.
4. Change to the UnixWare client software directory.
cd /mountpoint/client/tsapi/unixware
5. Insert an empty formatted diskette into the drive. Copy the package file using the
following command:
cat nwtslib.spl >/dev/fd0
6. Leave the unixware directory.
cd /
7. Unmount the CD-ROM.
The umount command format is as follows:
umount /dev/cdrom/device
where device specifies the CD-ROM drive that contains the Telephony Services
installation disk. You may now remove the CD-ROM.
8. Remove the diskette from the drive. Attach a label to the diskette and write the
following information on it:

114 Installation Guide

Installing UnixWare Client Software

Telephony Services UnixWare Client Disk 1 of 1
9. From the client where you wish to install the software, enter the pkgadd command.
The pkgadd command format is as follows:
pkgadd -d diskette [n]
where n specifies the number of the disk drive containing the installation diskette.
Follow the procedure, "Installing from the CD," beginning with step 6.

Issue 1 October 2003

115

Installing Avaya Computer Telephony TSAPI Client Software

About Installing HP-UX Client Software
The Avaya Computer Telephony HP-UX client software is distributed on CD-ROM in tar
(tape archive) format. The Avaya Computer Telephony HP-UX client software comes in a
multi-threaded version (HP-UX 10).

Note:

Note:
HP-UX clients require a CD-ROM drive. You can not install the HP-UX client
from floppy disks or from a network drive.

There are two methods for installing the software.
●

●

As an alternative to logging in as root, Use the HP System Administration Manager
(SAM) to perform the installation.
For more information about the swinstall command or SAM, refer to your HP-UX
documentation.

Installing HP-UX Client Software
Follow this procedure to install HP-UX Client Software.
1. From the computer where you are installing the HP-UX client software,
type su - root to log in as root.
The system prompts you for the root password.
2. Type the root password.
3. Set and export the DISPLAY environment variable by typing the following command
sequence.
DISPLAY=:0.0
export DISPLAY
4. Insert the Avaya Computer Telephony CD-ROM into your computer’s CD-ROM drive.
5. Use the mount command to mount the CD-ROM drive. For example, type:
mount -F cdfs /dev/dsk/device/mountpoint
where device specifies the CD-ROM drive that contains the Telephony Services
installation disk and mountpoint is the name of an existing directory

116 Installation Guide

Installing HP-UX Client Software

(such as /cdrom1 or /CD-ROM_1) on which to mount the CD-ROM. You can use the
ls command to find the appropriate names for your system.
6. Use the swinstall command to start the software installation. From the command
line, type:
swinstall -s /mountpoint/CLIENT/TSAPI/HPUX/TSLIB.TAR\;1
The system displays the SD Install - Target Selection dialog box.
7. Follow a, b, and c to select installation targets.
a. From the Targets list, highlight the targets on which you want to install the software.
b. From the Actions menu, choose Mark for Install.
c. Again, from the Actions menu, choose Show Software For Selection.
The system displays the SD Install - Software Selection dialog box.
8. Select tslib.
9. From the Actions menu, choose Mark for Install.
10. Before continuing to Step 11, it is recommended that you follow these steps to review
the "Readme" file that accompanies the software.
a. Highlight Avaya Computer Telephony
b. Select Actions, Show Description of Software...., Readme
c. Review the Readme file.
11. Select Actions, and click Install (analysis)....
12. When the analysis is complete, click OK to proceed with the installation.
13. When the installation is complete, click Done to close the Install window.
14. Click File from the menu bar and then click Exit.
15. Remove the CD-ROM using the umount command.
The umount command format is as follows:
umount /dev/dsk/device
where:
device specifies the CD-ROM drive that contains the Avaya Computer Telephony
installation disk.
16. Remove the CD-ROM.
This completes the procedure to install the Avaya Computer Telephony HP-UX client
software. Keep in mind that you must edit the "tslibrc" file for each client. See the next
section, Editing the Template File -- tslibrc on page 118.

Issue 1 October 2003

117

Installing Avaya Computer Telephony TSAPI Client Software

Editing the Template File -- tslibrc
This information applies to HP-UX, Solaris, and UnixWare clients only.
If you select TCP for the transport type during client installation, Avaya Computer
Telephony creates a template file called /usr/lib/tslibrc.
The tslibrc file contains sample names and addresses and you must change the sample
addressing information to the actual addressing and port information for the server your
clients need to access. Follow these guidelines to edit the tslibrc file.
●

If you are using IP addresses
- In a non-firewall environment, enter the IP address of the NIC for the Telephony
Server (as opposed to the NIC for the G3PD), followed by a space and 450, for
example: 122.222.000 450
- If you are setting up Avaya Computer Telephony in a firewall environment, see
Implementing a Firewall Strategy.

●

If you are using a host name
- Enter a valid host name and 450, for example: telserver 450. The host name must
resolve to a routable IP address.

118 Installation Guide

Removing Telephony Services Client Software

Removing Telephony Services Client Software
This section contains procedures for removing Windows client software.

Removing Windows 32-Bit Client Software
Use the standard Windows removal procedure to uninstall the Windows 32-bit client
software.
1. From the desktop, click Start, point to Settings and click Control Panel.
2. From the Control Panel, click Add/Remove Programs.
3. Windows displays the Add/Remove Programs Properties dialog box.
4. Select Avaya Computer Telephony TS Win32 client, and click Add/Remove.

Note:

Note:
You will not receive a confirmation message once you click on the Add/
Remove button.
The uninstall program removes the software and displays an Information box indicating
that the program and all of its components have been removed.
5. Click Finish.

This completes the procedure to remove a software program.

Removing TSAPI Solaris Client Software
Follow these steps to remove the TSAPI Solaris client software:
1. Use the pkgrm command.
2. The system displays a list of installed packages.
3. Enter the number or the name of the package you want to remove. In this case the
name of the package is:
tsapicl
4. Select "Yes" to remove the package.
The software is uninstalled.
5. Type "q" to quit the pkgrm command.

Issue 1 October 2003

119

Installing Avaya Computer Telephony TSAPI Client Software

Removing UnixWare Client Software
Follow these steps to remove the UnixWare client software:
1. Use the pkgrm command.
The system displays a list of installed packages.
2. Enter the number corresponding to the nwtslib package.
3. Select Yes to remove the package.
The software is uninstalled.
4. Type q to quit the pkgrm command.

Removing HP-UX Client Software
Follow this procedure to remove the HP-UX client software.
1. From the computer where you are removing the HP-UX client software, type su root to log in as root
2. Type swremove -i
3. Choose tslib from the list of packages to be removed.
This completes the procedure to remove the HP-UX client software.

120 Installation Guide

Chapter 5: Using CVLAN
This chapter includes the following sections which provide information about using CVLAN
(CallVisor PC Local Area Network) software in the Windows environment.
●

Overview on page 122

●

Implementing CVLAN and Telephony Services on page 123

●

The CVLAN Server on page 125

●

CVLAN Administration Guidelines for Sharing Links on page 126

●

Before You Administer CVLAN Clients on page 127

●

Basic CVLAN Client Administration on page 127

●

Starting the CVLAN Server on page 132

●

Stopping the CVLAN Server on page 135

●

CVLAN Client Hardware and Software Requirements on page 136

●

Installing CVLAN Client Software on page 138

●

Removing CVLAN Client Software on page 146

●

CVLAN Software Development Kit on page 147

Issue 1 October 2003

121

Using CVLAN

Overview
CVLAN is a client/server implementation of the Call Visor PC API. (CallVisor PC is a
proprietary Application Program Interface that supports the Adjunct/Switch Application
Interface -- ASAI).
CVLAN consists of a client component and a server component.
●

The CVLAN server is installed on the Avaya Computer Telephony server (which must be
running Windows NT, Windows 2000 or Windows XP), and it provides LAN connectivity
to remote workstations that require access to CallVisor PC.

●

The CVLAN client, which can be installed on the Avaya Computer Telephony server or a
client workstation, provides client PCs with remote access to the switch (by way of the
CVLAN server).
Avaya Computer Telephony provides CVLAN client packages for the following
platforms:
●

UnixWare

●

Solaris x86

●

Solaris Sparc

●

IBM Advanced Interactive Executive (AIX)

●

Windows

122 Installation Guide

Implementing CVLAN and Telephony Services

Implementing CVLAN and Telephony Services
Avaya Computer Telephony is an integrated software offer that includes two servers,
Telephony Services Server (Tserver) and the CVLAN Server. By bundling the two software
components, Avaya Computer Telephony enables you to effect an integrated installation of
both applications. Keep these points in mind if you are implementing both applications.
●

Up to eight CTI logical links can be shared between Telephony Services and CVLAN
applications.

●

Telephony Services and CVLAN rely on a common user interface, the G3 PBX DRIVER
configuration utility, to administer links.

●

Telephony Services and CVLAN applications can operate simultaneously on the same
Windows-based server (Windows NT, Windows 2000 or Windows XP).

●

CVLAN does not rely on the Telephony Services security database for client
authentication. Instead, it authenticates clients based on the client IP address or the
host name. See ‘‘Basic CVLAN Client Administration’’ on page -127.

Figure 5-1 depicts a coresident implementation of Telephony Services and CVLAN.

Issue 1 October 2003

123

Using CVLAN

Figure 5-1: CVLAN and Telephony Services — Coresidency at a Glance

Up to 8 logical links can be shared by CVLAN and
Telephony Services

TSLIB

TSAPI
Client

DEFINITY ECS
SDB

MAPD

Phone

Avaya CT Server

Tserver

DLG
JTAPI
Client

NIC

Phone

G3PD

NIC

ASAI

CVLANCLI.DLL

CVLAN
Server

Phone Line

124 Installation Guide

CVLAN
Client

Phone

ASAI.DLL

The CVLAN Server

The CVLAN Server
If you follow the procedure Procedure for Initial, Default Installation of Avaya Computer
Telephony Server Software on page 70 , the CVLAN server is installed when the checkbox
for "DEFINITY G3PBX Driver and CVLAN" is selected (it is selected by default).

Issue 1 October 2003

125

Using CVLAN

CVLAN Administration Guidelines for Sharing Links
Keep the following information in mind if your CTI implementation supports both CVLAN
and Tserver (Telephony Services Server) applications.
●

Link sharing. CVLAN server and Telephony Services applications running concurrently
can access switch CTI functionality via the same Tserver-to-Switch links.

●

Routing requests. Tserver-to-Switch links are not sharable by CVLAN server and
Telephony Services applications for receiving routing requests from the switch. That is,
a CVLAN server application that handles route requests from the switch should not use
a link that is shared with a Telephony Services application that also expects to receive
its own routing requests.

●

Load balancing. Consideration of load balancing by CVLAN server applications may
be required for optimal link usage when CVLAN server and Telephony Services
applications share Tserver-to-Switch links.

●

Link versions. The first application to access a link will set that link’s version level.
Other applications that may share the link will not be able to negotiate a different link
version. This may cause an application that requires particular link versions to fail to run
because no available links offer an acceptable version. Avoid this problem by ensuring
that the applications do not share a link.

For additional information about link sharing, handling routing requests, adjunct routing,
load balancing, and checking link versions, see Chapter 2 of Avaya Computer Telephony
CVLAN Programmer’s Reference (CALLVISR.PDF).

126 Installation Guide

Before You Administer CVLAN Clients

Before You Administer CVLAN Clients
Before you administer CVLAN take the following precautions:
●

Make sure that the G3PD is not loaded.
Refer to "Loading and Unloading PBX Drivers" (describes how you can load or unload
the dynamic link libraries (DLLs) for the Tserver) in Chapter 8 of Avaya Computer
Telephony, Telephony Services Administration and Maintenance (NETMANGD.PDF on
the Avaya Computer Telephony CD ROM).

●

Make sure the CVLAN service is stopped — See ‘‘Stopping CVLAN with the Telephony
Services Controller’’ on page -135.

Basic CVLAN Client Administration
Use this section to familiarize yourself with a few basic tasks associated with administering
CVLAN clients.
●

adding a client

●

editing a client

●

removing a client

Issue 1 October 2003

127

Using CVLAN

Adding a CVLAN Client
When you establish a link for communications between the Avaya Computer Telephony
server and the switch you establish a communications path for CVLAN clients (links are
shared between the CVLAN server and the Tserver).
Follow this procedure for adding a CVLAN client.
1. Click Start, point to Programs, Avaya Computer Telephony, DEFINITY G3 PBX
Driver, and click on G3 PBX Driver Configuration.

Note:

Note:
If the G3PD or CVLAN client is running, the system displays a Warning box,
with the following message, "Either the DEFINITY G3 PBX Driver or a
CVLAN Client is running. Changes made to the configuration will not take
effect until the next time the DEFINITY G3 PBX Driver is loaded. If you
receive this warning message, click OK.
The system displays the G3PX Driver Configuration dialog box.

128 Installation Guide

Basic CVLAN Client Administration

2. For each link click Admin to add a CVLAN client.
The system displays the CVLAN client dialog box.

3. Click Add to add a client.
The system displays the CVLAN Client name dialog box.

4. Enter the IP address of your CVLAN client, based your configuration requirements and
click OK.

Note:

Note:
You must enter an IP address in this dialog box. Client names (also referred
to as Host Names) are not permitted.
For guidelines about IP addresses, see Implementing a Firewall Strategy on page 34.

Issue 1 October 2003

129

Using CVLAN

This completes the procedure to add a client.

Removing a CVLAN Client
1. Follow Steps 1 through 5 of the procedure for Adding a CVLAN Client.
The system displays the CVLAN client dialog box.

2. Enter a new client name or IP address and click Remove.
The system displays the Warning dialog box.

3. Verify that this is IP address of the client you want to delete, and click Yes.
4. This completes the procedure to remove a client.

130 Installation Guide

Basic CVLAN Client Administration

Editing a Client
1. Follow Steps 1 through 5 of the procedure for Adding a CVLAN Client.
The system displays the CVLAN client dialog box.

2. Enter the IP address of the CVLAN Client and click Edit

Note:

Note:
Recall from the Note on page -129 that CVLAN clients are specified by IP
addresses only.
The system displays the CVLAN Client Name dialog box.

Issue 1 October 2003

131

Using CVLAN

3. Select the current IP address (135.20.70.6), and overwrite it with the IP address you
want to use. Click OK.
The system displays the Warning dialog box (overwriting deletes the previous client).

4. Verify that this IP address of the client that you want to edit and click Yes.
This completes the procedure to edit (and remove) a client.

Starting the CVLAN Server
This section describes the following methods for starting the CVLAN server:
●

Starting CVLAN with the Telephony Services Controller — this procedure starts both the
Telephony Services server (Tserver) and the CVLAN server. This is the recommended
method.

●

Starting CVLAN from the Windows operating system — this procedure starts the
CVLAN server only. Use this method to start the CVLAN server independently of the
Tserver.

Starting the CVLAN Server with the
Telephony Services Controller
Follow these steps to start the CVLAN server from the Telephony Services controller (this
procedure starts both the Tserver and the CVLAN server).

132 Installation Guide

Starting the CVLAN Server

1. Click Start, point to Programs, Avaya Computer Telephony, and click TS Controller.

2. Click Start to start Telephony Services.
Telephony Services starts the Tserver and the CVLAN.
3. Click OK to dismiss the information box and return to the "Telephony Services
Controller" dialog box.
On the Telephony Services controller dialog box, under "Status," the Telephony
Services state is listed as "RUNNING."
4. Click Close to exit the Telephony Services Controller dialog box.
This completes the procedure to manually start Telephony Services software.

Starting the CVLAN Server from the Windows Operating
System
Use this method to restart the CVLAN server independently of the Tserver.
1. Follow a or b depending on your Windows operating system.
a. Windows NT — Click Start, point to Settings, then click
Control Panel. Double-click Services.

Issue 1 October 2003

133

Using CVLAN

b. Windows 2000 and Windows XP — Click Start, point to Settings, then click
Control Panel. Double-click Administrative Tools, and then double-click
Services.
The system displays the Services dialog box.

2. From the Service list box, select AVAYA CVLAN Server and click Startup.

134 Installation Guide

Stopping the CVLAN Server

Stopping the CVLAN Server
This section describes the following methods for stopping the CVLAN server:
●

Stopping the CVLAN server with the Telephony Services Controller— this procedure
stops both the Telephony Services server (Tserver) and the CVLAN server. This is the
recommended method.

●

Stopping the CVLAN server from the Windows operating system — this procedure stops
the CVLAN server only. Use this method if your Tserver is running and the CVLAN
server does not seem to be operating.

Stopping CVLAN with the Telephony Services Controller
Follow this procedure to stop Telephony Services and the CVLAN server.
1. Click Start, point to Programs, Avaya Computer Telephony, and click TS Controller.
2. From the Telephony Services Controller dialog box, click Stop.
3. Select "Stop".
The Telephony Services and CVLAN server are stopped, and an Information box
displays.
4. Click OK
The operating system displays a message box that prompts you to stop the Logging
Service.

5. If you want to stop the Logging Service, Click Yes; otherwise, click No.
6. From the Telephony Services Controller dialog box, click Close to exit the Telephony
Services Controller.

Issue 1 October 2003

135

Using CVLAN

Stopping the CVLAN Service from the Windows Operating
System
Use this method if your Telephony Server (Tserver) is running and the CVLAN server does
not seem to be operating.
Follow this procedure to stop the CVLAN server from the Windows operating system.
1. Follow a or b, depending on your Windows operating system.
a. Windows NT — Click Start, point to Settings, then click Control Panel. Doubleclick Services.
b. Windows 2000 and Windows XP — Click Start, point to Settings, then click
Control Panel. Double-click Administrative Tools, and then double-click
Services.
2. From the Services dialog, select CVLAN Server and Click Stop.

CVLAN Client Hardware and Software
Requirements
As a general guideline, if the operating system will load and run on an approved hardware
platform, CVLAN client software will also. Our suggestion is to first choose a software
platform and work with the Hardware Certification list provided with the Operating System.

CVLAN Client Software
CVLAN client software allows CallVisor PC applications to communicate with DEFINITY by
way of the CVLAN Server.

136 Installation Guide

CVLAN Client Hardware and Software Requirements

CVLAN Client Platforms
The CallVisor PC Local Area Network (CVLAN) client software can be installed on the
following client platforms:
Table 5-1: CVLAN Client Application Platforms
Client Platform

Operating System

Server Version

Windows

Windows NT 4.0 or
Windows 2000

CVLAN 8.2

UnixWare

SCO UnixWare 2.1.3

CVLAN 8.2

SCO UnixWare 2.1.2 (with
UnixWare patch 32801)
UnixWare 7
Solaris
SPARC™

Solaris SPARC 2.4, 2.5,
2.5.1,and 2.6

CVLAN 8.2

Solaris™ x86

Solaris x86 2.4, 2.5, and
2.51

CVLAN 8.2

IBM® AIX

AIX 4.3 or 5.1

CVLAN 8.2

Issue 1 October 2003

137

Using CVLAN

Installing CVLAN Client Software
This section contains instructions for installing CVLAN client software on Windows NT,
Windows 2000, Solaris SPARC, Solaris x86, and UnixWare client workstations.

Note:

Note:
See Table 5-1 on page -137 in for the list of supported CVLAN client
platforms.

Installing Windows Client Software
The CVLAN client software can be installed on a Windows NT or Windows 2000 client
workstation.
1. Insert the Avaya Computer Telephony CD into the CD-ROM drive (the Setup program
runs automatically if you have not disabled the AutoRun feature).
Setup displays the Telephony Services Setup dialog box.
2. Click the Client Software button.

138 Installation Guide

Installing CVLAN Client Software

Setup displays the Client Setup dialog box

3. Click the CVLAN button.

Issue 1 October 2003

139

Using CVLAN

Setup displays the Setup Status Screen

4. When you CVLAN Setup has finished executing, you will be asked if you want to view
the Readme file now. Click Yes or No.
5. This installation is now complete.
Once you have completed the CVLAN installation, refer to the Avaya Computer Telephony
CVLAN Programmer’s Reference (CALLVISR.PDF) for more information, as follows.
●

The utilities (itt, asai_test, and perf) are described in Chapter 10.

●

Instructions for developing CVLAN applications are provided in Chapter 6.

140 Installation Guide

Installing CVLAN Client Software

Verifying Windows Client Software Installation
1. At the MS-DOS prompt, run "asai_test -m " where is
the name or IP address of the CVLAN server and
is the number of the link on that server.
2. It should respond with a "successful" message.
If it fails, check the TCP connectivity with ping, and the server link status by using the
DEFINITY G3PD Administrator utility.
For details on using the Link Status command, see the "Link Status Command" section
in Chapter 3 of Avaya Computer Telephony G3 PBX Driver and CVLAN Administration
and Maintenance (DEFNETM.PDF).

Installing Solaris SPARC Client Software
The CVLAN client software can be installed on a Solaris SPARC client workstation.

Note:

Note:
Solaris File Manager users may find it more convenient to access the CDROM by double-clicking on the cvlanxcl icon in the File Manager’s /
cdrom folder.
4. At the command prompt, enter the pkgadd command.
The pkgadd command format is as follows:
pkgadd -d /cdrom/cdrom0/client/cvlan/sparc/cvlanxcl.spl

Note:

Note:
For a detailed description of the pkgadd command, refer to your Solaris
SPARC documentation.
The system now displays a list of the packages.

Issue 1 October 2003

141

Using CVLAN

5. Select the cvlanxcl package.
6. Type eject to eject the CD from the CD-ROM drive.
After installation has completed, asaidll.lib, asaidll.dll, header files, and some utilities
will have been installed.
Once you have completed the CVLAN installation, refer to the Avaya Computer Telephony
CVLAN Programmer’s Reference (CALLVISR.PDF) for more information, as follows.
●

The utilities (itt, asai_test, and perf) are described in Chapter 10.

●

Instructions for developing CVLAN applications are provided in Chapter 6.

Verifying Solaris SPARC
Client Software Installation
1. At the command prompt, run "asai_test -m " where is
the name or IP address of the CVLAN server and
is the number of the link on that server.
2. It should respond with a "successful" message.
If it fails, check the TCP connectivity with ping, and the server link status by using the
DEFINITY G3PD Administrator utility.
For information about using the Link Status command, see "Link Status Command" in
Chapter 3 of Avaya Computer Telephony G3 PBX Driver and CVLAN Administration
and Maintenance (DEFNETM.PDF).

Installing Solaris x86 Client Software
The CVLAN client software can be installed on a Solaris x86 client workstation.

Note:

142 Installation Guide

Installing CVLAN Client Software

Note:

Note:
Solaris File Manager users may find it more convenient to access the CDROM by double-clicking on the cvlanxl icon in the File Manager’s /cdrom
folder.
4. At the command prompt, enter the pkgadd command.
The pkgadd command format is as follows:
pkgadd -d /cdrom/cdrom0/client/cvlan/solx86/cvlanxcl.spl

Note:

Note:
For a detailed description of the pkgadd command, refer to your Solaris x86
documentation.
The system now displays a list of the packages.
5. Select the cvlanxcl package.
6. Type q to quit the pkgadd command.
The installation is complete.
7. Type eject to eject the CD-ROM from the CD-ROM drive.
After installation has been completed, asaidll.lib, header files and some utilities will
have been installed.

Once you have completed the CVLAN installation, refer to the Avaya Computer Telephony
CVLAN Programmer’s Reference (CALLVISR.PDF) for more information, as follows:
●

The utilities (itt, asai_test and perf) are described in Chapter 10

●

Instructions for developing CVLAN applications are provided in Chapter 6

Verifying Solaris x86 Client Software Installation
1. At the command prompt, run "asai_test -m " where is
the name or IP address of the CVLAN server and is the number of the
link on that server.
2. It should respond with a "successful" message.
If it fails, check the TCP connectivity with ping, and the server link status by using the
DEFINITY G3PD Administrator utility.
For information about using the Link Status command, see "Link Status Command" in
chapter 3 of the Avaya Computer Telephony G3 PBX Driver and CVLAN
Administration and Maintenance (DEFNETM.PDF).

Issue 1 October 2003

143

Using CVLAN

Installing AIX CVLAN Client Software
The CVLAN client software can be installed on an AIX client workstation.
1. At the command prompt, enter su to have the system grant you super-user status. The
system prompts you for the root password.
2. Enter the root password.
3. Insert the Avaya Computer Telephony CD-ROM into your AIX system CD-ROM drive.
4. Mount the CD-ROM.
5. At the command prompt, use the installp command to install the software (see
Command Syntax).
Command Syntax
installp -ca -d /mntdir/client/cvlan/aix/cvlan_~1.bff cvlan_client

Substitute mntdir with the directory where you mounted the CD-ROM.
6. The system will perform the installation.

Installing UnixWare Client Software
The CVLAN client software for the UnixWare client workstation can be installed from the
command line or from the CD.

Installing from the Command Line
The CVLAN client software for the UnixWare client workstation is installed from the
command line via the UnixWare pkgadd command. To do this, you must be logged on as
root. Desktop users should open a "Terminal" window.

Note:

Note:
For a detailed description of the pkgadd command, refer to your UnixWare
documentation.

Installing from the CD
1. Become super-user (root): su
2. Enter the root password when prompted.
3. Insert the Telephony Services CD-ROM into your UnixWare system CD-ROM drive.
4. At the command prompt, mount the CD-ROM.

144 Installation Guide

Installing CVLAN Client Software

The mount command format is as follows:
mount -F cdfs -r /dev/cdrom/device/mountpoint
where device specifies the CD-ROM drive that contains the Telephony Services
installation disk and mountpoint is the name of an existing directory
(such as /cdrom1 or /CD-ROM_1) on which to mount the CD-ROM. You can use the
ls command to find the appropriate names for your system.

Note:

Note:
Desktop users may find it easier to mount the CD-ROM by double-clicking
on the CD-ROM icon in the "Disks-etc." folder.
5. At the command prompt, enter the pkgadd command.
The pkgadd command format is as follows:
pkgadd -d /mountpoint/client/cvlan/unixware/cvlanxcl.spl

where mountpoint is the name of an existing directory
(such as /cdrom1 or /CD-ROM_1) on which to mount the CD-ROM. (Note that the full
pathname, beginning with a ’/’, is required.)
6. The system now displays a list of the packages in the spool file. Press to
select the cvlanxcl package.
7. Unmount the CD-ROM.
The umount command format is as follows:
umount /dev/cdrom/device
where device specifies the CD-ROM drive that contains the Telephony Services
installation disk. You may now remove the CD-ROM.
After installation has completed, asaidll.lib, asaidll.dll, header files, and some utilities
will have been installed.
Once you have completed the CVLAN installation, refer to the Avaya Computer Telephony
CVLAN Programmer’s Reference (CALLVISR.PDF) for more information, as follows.
●

The utilities (itt, asai_test, and perf) are described in Chapter 10.

●

Instructions for developing CVLAN applications are provided in Chapter 6.

Issue 1 October 2003

145

Using CVLAN

Verifying UnixWare Client Software Installation
1. At the command prompt, run "asai_test -m " where is
the name or IP address of the CVLAN server and
is the number of the link on that server.
2. It should respond with a "successful" message.
If it fails, check the TCP connectivity with ping, and the server link status by using the
DEFINITY G3PD Administrator utility.
For information about using the Link Status command, see "Link Status Command" in
Chapter 3 of Avaya Computer Telephony G3 PBX Driver and CVLAN Administration
and Maintenance (DEFNETM.PDF).

Removing CVLAN Client Software
This section contains instructions for removing CVLAN client software from Windows NT,
Windows 2000, Solaris SPARC and UnixWare client workstations.

Uninstalling Windows Client Software
Use the standard Windows removal procedure to uninstall the CVLAN client software.
1. From the desktop click Start, point to Settings and click Control Panel.
2. From the Control Panel, click Add/Remove Programs.
Windows displays the Add/Remove Programs Properties dialog box.
3. Select Avaya Computer Telephony CVLAN client, and click Add/Remove.
The uninstall program removes the software and displays an Information box indicating
that the program and all of its components have been removed.
4. Click Finish.
This completes the procedure to remove a software program from a Windows machine.

146 Installation Guide

CVLAN Software Development Kit

Removing Solaris SPARC Client Software
If you want to remove the CVLAN client software from the Solaris SPARC client
workstation:
1. Use the pkgrm command.
A list of installed packages is displayed.
2. Enter the number corresponding to the cvlanxcl package.
3. Select "Yes" to remove the package.
The software is uninstalled.
4. Type q to quit the pkgrm command.

Removing AIX Client Software
If you want to remove the AIX client software from the client workstation, type the
command:
installp -u cvlan_client

Removing UnixWare Client Software
If you want to remove the UnixWare client software from the client workstation, as root type
the command:
pkgrm cvlanxcl

CVLAN Software Development Kit
The CVLAN Software Development Kit (SDK) provides a software development
environment for developing CVLAN applications for the adjunct (see Figure 5-2). The
following documents, which are included on the Avaya Computer Telephony CD,
supplement the tools in the SDK.
●

Avaya Computer Telephony CVLAN Programmer’s Reference (CALLVISR.pdf)

●

Avaya MultiVantage CallVisor ASAI Technical Reference (Asaitech.pdf)

●

Avaya MultiVantage CallVisor ASAI Protocol Reference (Asaiprot.pdf)

Issue 1 October 2003

147

Using CVLAN

Figure 5-2: CVLAN SDK at a Glance

CVLAN SDK Components
Related
documents

CVLAN

ASAI

INCLUDE

ASAI

148 Installation Guide

INCLUDE

SAMPLE

SCRIPTS

UTILS

Chapter 6: Installing JTAPI Client Software
This chapter contains the following sections that describe the installation procedure for the
JTAPI Client software.
●

JTAPI Client Packaging on page 149

●

Installing the JTAPI Client Software in the Windows Environment on page 151

●

Manually Installing the JTAPI Client Software (Special Cases) on page 157

JTAPI Client Packaging
The JTAPI Client software is delivered as a collection of JAVA classes.
JTAPI comprises three software sets:
●

SET 1, located in directory \client\Jtapi\OS_Independent, consists of the Avaya
implementation of the JTAPI specification.

●

SET 2, located in directory \client\Jtapi\OS_Independent\all, consists of the Avaya
Computer Telephony implementation of JTAPI interfaces, bundled with Sun JTAPI 1.2
Early Access interfaces.

●

SET 3, similar to SET 2 but also contains a special debug package located in
\client\Jtapi\OS_Independent\Debug.

Use the guidelines provided in each section to determine which set is appropriate for your
environment.

SET 1
Use this set of software only if Sun JTAPI interface classes are already in your client’s
CLASSPATH and you are concerned about download time from a web site:
●

ECSJTAPI.ZIP — software in zip format for use by Netscape 3.x and other browsers, as
well as Java applications.

Issue 1 October 2003

149

Installing JTAPI Client Software

●

ECSJTAPI.JAR — software in a signed jar format for use by Netscape 4.x and newer
browsers as well as Java applications.

●

ECSJTAPI.CAB — software in a signed cab format for use by Internet Explorer 4.x
browsers.
The CLASSID is: {DDBB0340-3036-11d1-B2F7-006097B5344A}.

SET 2
This software set contains the Avaya JTAPI implementation bundled with the JTAPI
interfaces. Use this set of software if you do not already have the JTAPI interface classes
in your CLASSPATH:
●

ECSJTAPIA.ZIP — software in zip format for use by Netscape 3.x and other browsers,
as well as Java applications.

●

ECSJTAPIA.JAR — software in a signed jar format for use by Netscape 4.x and newer
browsers as well as Java applications.

●

ECSJTAPIA.CAB — software in a signed cab format for use by Internet Explorer 4.x and
newer browsers.
The CLASSID is: {5DC537F1-39BE-11d1-B301-006097B5325A}.

SET 3
This software set also has the Avaya JTAPI implementation bundled with the JTAPI
interfaces. Additionally, it provides debugging capability. Use this set of software for
developing an application or applet. Do not use this software in production mode; but
instead use either Set 1 or 2.
●

ECSJTAPID.ZIP — software in zip format for use by Netscape 3.x and other browsers.

●

ECSJTAPID.JAR — software in a signed jar format for use by Netscape 4.x and newer
browsers as well as Java applications.

●

ECSJTAPID.CAB — software in a signed cab format for use by Internet Explorer 4.x
browsers. The CLASSID for this is {278E9392-39B9-11d1-B301-006097B5325A}.

150 Installation Guide

Installing the JTAPI Client Software in the Windows Environment

Installing the JTAPI Client Software in the Windows
Environment
This section provides procedures for installing JTAPI Client software from the CD.

Note:

Note:
The Windows installation will create Windows Start Menu shortcuts using
the Sun Microsystems Java Virtual Machine (JVM) if it is found. If Sun's
JVM is not found it will use the Microsoft JVM (If not found, it will default to
Sun’s in the shortcut). If you wish to utilize another JVM and use the
Windows Start Menu shortcuts for TSTest and ECSJtapiVersion you will
have to change the shortcut properties to invoke the desired JVM.
Note:
The Windows installation will make an addition to your CLASSPATH system
variable. CLASSPATH will contain the necessary files and paths to utilize the
JTAPI client components. You may modify CLASSPATH to switch between
the different JTAPI packaging provided.
1. Insert the CD into the CD-ROM drive (the Setup program runs automatically if you
have not disabled the AutoRun feature).
Setup displays the Telephony Services Setup dialog box.

Issue 1 October 2003

151

Installing JTAPI Client Software

2. Click on the Client Software button.
Setup displays the Client Setup dialog box.

152 Installation Guide

Installing the JTAPI Client Software in the Windows Environment

3. Click on the Telephony Services JTAPI Client button.
Setup displays the Welcome Dialog for the Jtapi Client Install.

4. Click Next.

Issue 1 October 2003

153

Installing JTAPI Client Software

Note:

Note:
At this time a search for previous versions/components is conducted so
processing may take a few minutes. If a previous version is found, a window
displays asking you if you would like to continue with the installation. Having
multiple versions installed is allowed and you may continue without
uninstalling. It is recommended that you uninstall the previous version to
avoid confusion. Uninstall directions are displayed.
If you continue with the installation procedure the Destination Location screen
displays.

5. You can accept the default destination folder or browse to select another destination
folder. Click Next to continue.

154 Installation Guide

Installing the JTAPI Client Software in the Windows Environment

Setup displays the JTAPI class files dialog box.

6. Select the appropriate packaging and click Next.
A message is displayed asking if the packaging selected should be added to the user’s
classpath. Select Yes or No.

Issue 1 October 2003

155

Installing JTAPI Client Software

Setup displays the TCP/IP Server Configuration dialog box.

7. Enter the appropriate Host Name or IP Address of your Telephony Server (or Avaya
Computer Telephony Server) and click Next.
Once the appropriate files are copied, the installation is complete.
Test your JTAPI Client installation by making a call with the TSTest application from the
Avaya Computer Telephony JTAPI Client section of the Windows Start Menu.

156 Installation Guide

Manually Installing the JTAPI Client Software (Special Cases)

Manually Installing the
JTAPI Client Software (Special Cases)
For Non-Windows operating systems and some special cases on a Windows
Operating System a manual install may be necessary. Follow these directions as
applicable to the specific situation. The required files should be copied manually and
can be found on the Avaya Computer Telephony CD-ROM under this path:
\client\jtapi\os_independent\

Setup for Running JTAPI
Applets or Applications on a Client
You must have a Java Virtual Machine (VM) that supports Java Development Kit (JDK)
1.02 or later on your client.
1. Copy the software from SET 2 and TSAPI.PRO files to the same
directory:.
(For example, C:\JTAPI.)
2. Set the CLASSPATH to include : and the files from SET 2. (For
example, CLASSPATH=.;C:\JTAPI;C:\JTAPI\ECSJTAPIA.ZIP.) On a Windows NT,
Windows 2000 or Windows XP machine you can do this from the Control Panel,
System, Environment dialog.
3. Edit the TSAPI.PRO file to include the TCP/IP addresses or hostnames of the Tservers
that you will be using. The default port number is 450.

Setup for Running JTAPI Applets
in a Browser from a Web Server
In this configuration, the clients that will access the web server do not need to install the
JTAPI software.
1. Copy the software from SET 2 to the directory on your web site that will host your web
page.

Note:

Note:
If SET 1 is used, it is assumed that clients already have the Sun JTAPI
classes on their system and the path to them exists in the client’s class path
variable.

Issue 1 October 2003

157

Installing JTAPI Client Software

2. Placement options for the TSAPI.PRO file for access in Netscape Communicator are
as follows:
a. Copy the TSAPI.PRO file to the directory on your web site that will host your web
page.
b. If the clients use different Tservers, then the information in the TSAPI.PRO file will
be different for each client. Install a TSAPI.PRO file on each client and set the
CLASSPATH to include the directory that contains the TSAPI.PRO file.
3. Placement options for the TSAPI.PRO file for access in Internet Explorer are as
follows:
a. If the web page is using signed cabinets, such as ecsjtapia.cab, the files in the cab
are extracted to the java library directory on the client and used from there. In this
case the TSAPI.PRO file must be installed in the client’s java library directory. (On a
Windows NT, Windows 2000 or Windows XP machine this is the java\lib directory.)
4. Edit the TSAPI.PRO file to include the TCP/IP addresses or hostnames of the Tservers
that you will be using. The default port number is 450.

158 Installation Guide

Chapter 7: Using the JTAPI SDK
In addition to the Telephony Services software, the Avaya Computer Telephony CD ROM
also includes a Java Telephony API (JTAPI) Software Development Kit (SDK), for
developing Java-based computer-telephony applications.
This chapter contains the following sections which provides information for using the JTAPI
SDK.
●

Related
documents
SDK

TSAPI

UNIXWARE

SOLARIS SPARC

WINDOWS

Issue 1 October 2003

179

Using the TSAPI SDK

Installing the TSAPI SDK
Installing in the Windows Environment
1. Insert the CD into the CD-ROM drive (the Setup program runs automatically if you
have not disabled the AutoRun feature).
2. Setup displays the Telephony Services Setup dialog box.
Figure 8-2: Telephony Services Setup Screen

3. Click on the Software Development Kit (SDK) button.

180 Installation Guide

Installing the TSAPI SDK

Figure 8-3: Telephony Services SDK Setup Screen

4. Click on the TSAPI Software Development Kit (SDK) button.
Figure 8-4: Welcome Screen

5. Click Next.

Issue 1 October 2003

181

Using the TSAPI SDK

Note:

Note:
At this time a search for previous versions/components is conducted so
processing may take a few minutes. If a previous version is found, a
message displays asking you if you would like to continue with the
installation. Having multiple versions installed is allowed and you may
continue without uninstalling. It is recommended that you uninstall the
previous version to avoid confusion. Uninstall directions are displayed.
If you continue with the installation procedure the following screen displays.

Figure 8-5: TSAPI SDK Setup Screen

6. Check the appropriate components to install then click Next.

Note:

Note:
If the Telephony Services 32-bit Windows client was selected to be installed,
the Setup screen displays. Refer to ‘‘Installing the Windows Client Software’’
on page -101 for more information.
If the Definity PBX Simulator was selected to be installed, the Setup screen displays.
Refer to Specialized Installations in Chapter 3 for more information about installing the
Definity PBX Simulator.
The installation of the TSAPI SDK continues.

182 Installation Guide

Installing the TSAPI SDK

Figure 8-6: Destination Location Screen

7. Accept the default destination location and click Next to continue.
Figure 8-7: Destination Folder Structure Screen

8. Review settings and click Next.
The Installation is now complete.

Issue 1 October 2003

183

Using the TSAPI SDK

Installing in the Unixware Environment
Installing from the CD:
1. Become super-user (root): su
2. Enter the root password when prompted.
3. Insert the Telephony Services CD-ROM into your workstation CD-ROM drive.
4. At the command prompt, mount the CD-ROM as follows:
mount -F cdfs -r /dev/cdrom/device /mountpoint
where device specifies the CD-ROM drive that contains the Telephony Services
installation disk and mountpoint is the name of an existing directory (such as /cdrom1
or /CD-ROM_1) on which to mount the CD-ROM. You can use the ls command to find
the appropriate name for your system.
Desktop users may find it easier to mount the CD-ROM by double-clicking on the CDROM icon in the "Disks-etc" folder.
5. At the command prompt, enter the pkgadd command as follows:
pkgadd -d /mountpoint/sdk/tsapi/unixware/nwtssdk.spl
where mountpoint is as described above. (Note: the full pathname, beginning with a ‘/
’, is required.)
6. Select package to install.
The system now displays a list of the packages on the CD-ROM.
Press to select the nwtssdk package.
7. Read the Telephony Services SDK "readme" file.
The pg command displays the Telephony Services SDK "readme" file, tslib.readme.
This file contains information about changes that were made after the manuals were
completed. Read this information until you reach the end of the file.
8. The installation is complete. Unmount the CD-ROM as follows:
umount /dev/cdrom/device
where device is the same as in Step 3.
You may now remove the CD-ROM.

184 Installation Guide

Installing the TSAPI SDK

Installing in the Solaris Environment
1. At the command prompt, enter the pkgadd command as follows:
pkgadd -d /cdrom/cdrom0/SDK/tsapi/sparc/tsapisdk.spl
2. At the enter path to package base directory prompt, enter
/usr/include/nts (or the directory of your choice)

Installing in the HP-UX Environment
3. Become super-user (root): su
4. Enter the root password when prompted.
5. Insert the Telephony Services CD-ROM into your workstation CD-ROM drive.
6. At the command prompt, mount the CD-ROM as follows:
mount -F cdfs -r /dev/cdrom/device /mountpoint
where device specifies the CD-ROM drive that contains the Telephony Services
installation disk and mountpoint is the name of an existing directory (such as /cdrom1
or /CD-ROM_1) on which to mount the CD-ROM. You can use the ls command to find
the appropriate name for your system.
7. Desktop users may find it easier to mount the CD-ROM by double-clicking on the CDROM icon in the "Disks-etc" folder.
8. At the command prompt, enter the swinstall command as follows:
swinstall -s//SDK/TSAPI/HPUX/TSSDK.TAR\;1

Issue 1 October 2003

185

Using the TSAPI SDK

TSAPI Programming Environment
This section summarizes the contents of the SDK\TSAPI subdirectories.

"Hdrs" Directory (SDKs\TSAPI\HDRS)
This directory contains header files for the TSAPI SDK.Two files are of particular
importance, "attpriv.h" and "attpdefs.h," which are for the DEFINITY G3(ATT)private data
version 6 SDK.

About the Private Data Version Files
If your current TSAPI applications were written against earlier versions of the SDK they will
not handle DEFINITY G3 private data correctly if they are simply recompiled with this
version of the SDK. Here are some guidelines for upgrading your application.
●

If you want to recompile your existing applications using this version of the SDK, search
in attprivs.h and attpdefs.h for the string "ATTV5."

●

Typedefs and constants that have been changed in support of private data version 6
have been preserved with the preface "ATTV5."

●

Your application will have to be upgraded if you wish to continue to use these typedefs
and constants.

Libs (SDKs\TSAPI\LIBS)
This directory contains the CSTA32.LIB and ATTPRIV32.LIB import libraries. These are
private data version 6 files.

Samples (SDKs\TSAPI\SAMPLES)
This directory contains samples of complete applications that demonstrate how to program
to TSAPI.

186 Installation Guide

TSAPI Programming Notes

Tools (SDKs\TSAPI\TOOLS)
This directory contains the Tsapi Exerciser program.

Win32 (SDKs\TSAPI\Windows)
This directory contains the CSTA32.LIB and ATTPRIV32.LIB import libraries. These are
private data version 6 files.

TSAPI Programming Notes
Closing Streams Before Exit
Your application must close all open streams -- preferably by calling acsAbortStream() -before exiting.

acsCloseStream()
You must retrieve the ACSCloseStreamConfEvent by calling acsGetEventBlock() or
acsGetEventPoll() if you use acsCloseStream(). Unless your application needs to see the
ACSCloseStreamConfEvent, e.g. the PBX driver sends private data with the close
confirmation in which you are interested, you should use acsAbortStream() instead.

DEFINITY Private Data Name Change
DEFINITY Private Data is the name of the software formerly called AT&T Private Data. All
functions formerly contained in AT&T Private Data are provided by DEFINITY Private Data
and the file names are the same.

Issue 1 October 2003

187

Using the TSAPI SDK

Version Negotiation
When opening a stream, an application may negotiate with a PBX driver to agree upon the
version of private data protocol to be used (as described in "Private Data Version Control"
in the TSAPI for Avaya MultiVantage Programmer's Guide It is also important that the
DEFINITY private data library can support this protocol. To ensure this and to assist in the
construction of a proper version string, the attMakeVersionString() API may be used.
This function accepts a string containing the numerical range of versions supported by the
application, e.g., "1-3", and returns (in a caller-supplied buffer) a "filtered" string to be
passed in the version negotiation, e.g., "AT&T Definity G3#2".
This string includes the vendor name, and represents the intersection of those versions
supported by both the application and the DEFINITY private data library. Upon success,
the function returns the length of the output string (not including terminating NULL). The
function may fail with return value ACSERR_BADPARAMETER if the input string is illformed, or, if no requested version is supported by the library, may return
ACSERR_APIVERDENIED.

Windows NT, Windows 2000 and Windows XP PBX
Driver Development Information
This section contains important information for developers creating TSAPI client
applications and Telephony Services PBX drivers.

Linkage Notes
●

The TDI.LIB import library was generated by Microsoft Visual C++. If your development
system does not support the Microsoft library format, you must consult its
documentation to determine how to create an equivalent import library from TDI.DLL.
Alternatively, you can dynamically import the TSDI via LoadLibrary () and
GetProcAddress () or use some other symbol import method.

●

We recommend Microsoft Visual C++ for developing PBX Drivers.
Avaya Computer Telephony R11.1 V1 requires that you use Microsoft Visual C++ 6.0
for developing PBX drivers and Windows .EXE applications.

188 Installation Guide

Windows NT, Windows 2000 and Windows XP PBX Driver Development Information

PBX Driver Installation
Telephony Services for NT installs INSTTSDR.DLL, a utility library for PBX driver
installation.
INSTTSDR.DLL exports a function called installTelephonyServicesDriver(). Your PBX
driver's installation routine may call this function in order to add the driver's name to the
Tserver's list of drivers.
The INSTTSDR.H header file specifies the C-language interface to the functions in
INSTTSDR.DLL.
installTelephonyServicesDriver() is a convenience routine so that the user does not have to
manually add the driver to the Tserver's list of administered drivers via TSA.
You may not include INSTTSDR.DLL with your PBX driver; rely on the Telephony Server to
provide this file.

Sample Code
Figure 8-8: Sample Code on page 190 provides sample code for using the
installTelephonyServicesDriver() function with a popular installer, InstallShield3.

Issue 1 October 2003

189

Using the TSAPI SDK

Figure 8-8: Sample Code
prototype INSTTSDR.installTelephonyServicesDriver
(BYREF STRING, NUMBER);
InstallAsTserverDriver:
// Add the driver.dll to the tservers registry entry
// as a driver and have it auto loaded when
// Tserver restarts.
nRc = UseDLL(WINSYSDIR^"INSTTSDR.DLL");
if (nRc < 0) then
// Couldn't load the insttsdr dll...
// Tserver probably wasn't installed...
SprintfBox(WARNING, "Install Problem",
"Installation was unable to enter the driver.dll "+
"in the Telephony Services list of drivers "+
"(Possibly because the Telephony Services "+
"product is not installed yet). "+
"You will have to perform this function manually "+
"through the Telephony Services Administrator "+
"application.");
else
svDriverName = "driver.dll";
nRc = installTelephonyServicesDriver
(svDriverName,TSDR_AUTOLOAD);
// Only put up the warning if it wasn't success
// and it wasn't a duplicate entry.
if (nRc < TSDR_DUPLICATE) then
SprintfBox( WARNING, "Install Problem",
"Installation was unable to enter the driver.dll "+
"in the Telephony Services list of drivers "+
"(Possibly because the Telephony Services product"+
"is not installed yet). "+
"You will have to perform this function "+
"manually through the Telephony Services "+
"Administrator application.");
endif;
UnUseDLL(WINSYSDIR^"INSTTSDR.DLL");
endif;

190 Installation Guide

Windows NT, Windows 2000 and Windows XP PBX Driver Development Information

CSTA Server
The CSTA Server DLL provides an alternate PBX driver interface, called the CSTA
Services [PBX] Driver Interface (CSDI), for use in passing CSTA request, response, and
event messages between a PBX Driver and the Telephony Server.
The CSTA Server is always loaded by the Telephony Server. CSDI compliant drivers do
not need to load any additional software to load their drivers.

Driver Debugging Strategies
The Tserver runs as an NT Service which makes debugging PBX drivers difficult. This SDK
includes an executable version of the Tserver (TSRVSDK.EXE) which may be useful in
developing and debugging your PBX Driver. This executable still requires all of the
supporting DLLs as does the Service version of the Tserver (TSRV.EXE). A good way to
install TSRVSDK.EXE is to place it in the same directory as TSRV.EXE.

Note:

Note:
TSRVSDK.EXE does not call tdiStopDriver(), the Driver's unload function.
You must test your PBX driver with TSRV.EXE running as a service to test
your unload routine.

To test PBX driver unload, stop the TSAPI Telephony Services Service from the Services
control panel. If an error occurs indicating that the Tserver did not respond to the stop
request, verify that nothing in the Driver's tdiStopDriver() function is hanging. Look in the
Tserver Error Log for an entry "UNLDDRV: Freeing the library ". This entry
indicates that the Tserver called the Driver's tdiStopDriver() function and received a
successful result (TRUE) from the Driver. If this message is not in the Error Log then the
Driver is hung somewhere in its unload function. The Tserver will not finish unloading until
the Driver does.

Note:

Note:
The Driver must not return from the tdiStopDriver() function until it has
completely stopped all of its threads and cleaned up all of its resources. If
the Driver still has something running after it returns from tdiStopDriver(),
TSRV.EXE will abnormally terminate because the Tserver frees the driver
library upon a successful return from tdiStopDriver(). If the Driver tries to
access memory after it has been freed, abnormal termination will occur.

Issue 1 October 2003

191

Using the TSAPI SDK

TSAPI Sample Code
In a Windows installation, the sample code can be located through the Avaya Computer
Telephony TSAPI SDK entry in the Start menu. The TSAPI samples provided are complete
applications that demonstrate how to program to TSAPI. Each of these samples builds on
the next, with each one implementing more TSAPI functionality than the previous one.
These samples were all written in C++ and built using the Microsoft Developer Studio and
the Microsoft Foundation Classes (MFC). The makefiles (*.MDP and *.MAK) provided with
this sample are specific to that development environment. However, no complex C++ or
MFC techniques were used and there are comments explaining the MFC code to non-MFC
folks.
Porting this code to other platforms will require modifications to event notification.
These samples build on each other in the following order:
1. TSAPIOUT - TSAPI Outgoing Call Handling
1 device, 1 call Shows basic outgoing call handling for a single device and a single call
with no redirection, conferencing, transferring, etc. Includes making a call and hanging
up the call.
2. TSAPIIN - TSAPI Incoming Call Handling
1 device, 1 call Adds incoming call handling to sample 1. Still no redirection,
conferencing, etc. It demonstrates differentiating between incoming calls and outgoing
calls. Includes answering calls.
3. TSAPIMUL - TSAPI Multiple Call Handling
1 device, many calls Adds multiple call handling to sample 2. It demonstrates how to
keep track of multiple calls at the same device. Includes holding and retrieving calls.
Also includes redirection as a bonus.
4. TSAPICNF - TSAPI Conference Call Handling
1 device, many calls Adds conference/transfer handling to sample 3. Includes tracking
of many connections on a single call.
The following files are common to all of the samples:
TSAPI.CPP
TSAPI.H
helper classes for tracking devices and calls and routines for retrieving TSAPI events
from the CSTA DLL
OPENTSRV.CPP
OPENTSRV.H
supports the Open Tserver dialog; authorizes the user, opens the TSAPI stream and
registers the selected device with the TSAPI helper classes.

192 Installation Guide

TSAPI Sample Code

SAMPLDLG.CPP
SAMPLDLG.H
supports the main application dialog; all call-related control is here: making calls,
answering calls, call event handling, etc.
STDAFX.CPP
STDAFX.H
MFC files that do not contain any interesting code for the purposes of TSAPI-code
demonstration
RESOURCE.H
resource IDs for the application
The following files contain similar functionality in each sample, but are named unique to
each sample:
TSAPIOUT.CPP
TSAPIOUT.H
TSAPIOUT.RC
initialization and resources for sample 1
TSAPIIN.CPP
TSAPIIN.H
TSAPIIN.RC
initialization and resources for sample 2
TSAPIMUL.CPP
TSAPIMUL.H
TSAPIMUL.RC
initialization and resources for sample 3
TSAPICNF.CPP
TSAPICNF.H
TSAPICNF.RC
initialization and resources for sample 4

Issue 1 October 2003

193

Using the TSAPI SDK

For More Information
For more information about the TSAPI SDK, see the TSAPI SDK Readme file (SDK
Readme (:\Readmes\TSAPI SDK Readme.txt)

194 Installation Guide

Appendix A: Avaya Computer Telephony
Installed Files
This appendix lists the files that Avaya Computer Telephony installs. It list files associated
with the following components.
●

Avaya CT Server

●

G3PBX Driver

●

Win 32 Client

●

UnixWare Client

●

HP-UX Client

Drive designations in the Tables A-1 through A-4 are depicted as "C:\" by convention. This
drive designation can vary according to the requirements of your system.

Issue 1 October 2003

195

Avaya Computer Telephony Installed Files

Avaya CT Server
When Avaya CT server software is installed, the files listed in Table A-1 are copied to your
server’s hard drive.
Table A-1: Telephony Server Files

196 Installation Guide

File Name

Destination Directory

Uninstsrvc.dll

C:\Program Files\Avaya\CT\tsrv\Program

Tsconfig.exe

C:\Program Files\Avaya\CT\tsrv\Program

Tsctrl.exe

C:\Program Files\Avaya\CT\tsrv\Program

Cserver.dll

C:\Program Files\Avaya\CT\tsrv\Program

Migrate.exe

C:\Program Files\Avaya\CT\tsrv\Program

Server
Readme.txt

C:\Program Files\Avaya\CT\tsrv

Tsstart.exe

C:\Program Files\Avaya\CT\tsrv\Program

Tssdb.dll

C:\Program Files\Avaya\CT\tsrv\Program

Tsrvbtrv.dll

C:\Program Files\Avaya\CT\tsrv\Program

Tslogin.exe

C:\Program Files\Avaya\CT\tsrv\Program

Tslogsrv.exe

C:\Program Files\Avaya\CT\tsrv\Program

Tsrv.exe

C:\Program Files\Avaya\CT\tsrv\Program

Trafcop.exe

C:\Program Files\Avaya\CT\tsrv\Program

TSTraf.dll

C:\Program Files\Avaya\CT\tsrv\Program

Tsusr.dll

C:\Program Files\Avaya\CT\tsrv\Program

Tsvl.dll

C:\Program Files\Avaya\CT\tsrv\Program

Tsauth.dll

C:\Program Files\Avaya\CT\tsrv\Program

Tsadv.dll

C:\Program Files\Avaya\CT\tsrv\Program

Tsevtlog.dll

C:\Program Files\Avaya\CT\tsrv\Program

Tsconfig.hlp

C:\Program Files\Avaya\CT \tsrv\Program

Tsmapd.dll

C:\Winnt\system32

Tapiinst.dll

C:\Winnt\system32

Tdi.dll

C:\Winnt\system32

Avaya CT Server

Table A-1: Telephony Server Files
File Name

Destination Directory

Tslog.dll

C:\Winnt\system32

Insttsdr.dll

C:\Winnt\system32

Tsmi.dll

C:\Winnt\system32

Issue 1 October 2003

197

Avaya Computer Telephony Installed Files

G3PBX Driver Files
When G3PBX Driver is installed, the files listed in Table A-2 and Table A-3 are copied to
your server’s hard drive.
Table A-2: G3PBX Driver Files

198 Installation Guide

File Name

Destination Directory

attprv32.dll

C:\Winnt\system32

Used by CVLAN
and G3PBX
Driver

asaidll.dll

C:\Winnt\system32

The private data
encoding/
decoding library
needed for the
G3PD to run.

g3pd.dll

C:\Winnt\system32

The G3 PBX
Driver (G3PD)

g3instal.dll

C:\Program Files\Avaya\CT\G3PD

G3lc.exe

C:\Program Files\Avaya\CT\G3PD

g3trace.exe

C:\Program Files\Avaya\CT\G3PD

g3peek.exe

C:\Program Files\Avaya\CT\G3PD

cvlan.exe

C:\Program Files\Avaya\CT\G3PD

esai_trace.exe

C:\Program Files\Avaya\CT\G3PD

asai_trace.exe

C:\Program Files\Avaya\CT\G3PD

ASAISRVC.exe

C:\Program Files\Avaya\CT\G3PD

api.msg

C:\Program Files\Avaya\CT\G3PD

G3pd.lic

C:\Program Files\Avaya\CT\G3PD

Server
Readme.txt

C:\Program Files\Avaya\CT\G3PD

G3pdlic is
created when
you install the
license.

G3PBX Driver Files

Table A-3: G3PBX Driver Configuration Files
File Name

Destination Directory

data1.cab

C:\Program Files\Avaya\CT\G3PD\g3config

data1.hdr

C:\Program Files\Avaya\CT\G3PD\g3config

data2.cab

C:\Program Files\Avaya\CT\G3PD\g3config

ikernel.ex

C:\Program Files\Avaya\CT\G3PD\g3config

layout.bin

C:\Program Files\Avaya\CT\G3PD\g3config

Setup.exe

C:\Program Files\Avaya\CT\G3PD\g3config

Setup.ini

C:\Program Files\Avaya\CT\G3PD\g3config

setup.inx

C:\Program Files\Avaya\CT\G3PD\g3config

tools.ico

C:\Program Files\Avaya\CT\G3PD\g3config

Issue 1 October 2003

199

Avaya Computer Telephony Installed Files

Win32 Client Files
When Win32 Telephony Services Client is installed, the files listed in Table A-4 are copied
to your client’s hard drive.
Table A-4: Files Copied to Win32 Client

200 Installation Guide

File Name

Destination Directory

Installation
Conditions

ATTPRV32.DLL

Windows System directory

CSTA32.DLL

Windows System directory

TSINST32.DLL

C:\Program Files\Avaya\CT \TS
Win32\Program

TSSPY32.EXE

C:\Program Files\ Avaya\CT\TS
Win32\Program

TSA32.EXE

C:\Program Files\Avaya\CT\TS
Win32\Program

Administrator
only

TSA32.HLP

C:\Program Files\Avaya\CT\TS
Win32\Program

Administrator
only

TSM32.HLP

C:\Program Files\Avaya\CT\TS
Win32\Program

Administrator
only

TSM32.EXE

C:\Program Files\Avaya\CT\TS Win
32\Program

Administrator
only

TSTEST32.EXE

C:\Program Files\Avaya\CT\TS Win
32\Program

WG3OAM.EXE

C:\Program Files\Avaya\CT\TS Win
32\Program

Administrator
only

WG3OAM.HLP

C:\Program Files\Avaya\CT\TS Win
32\Program

Administrator
only

TSLIB.INI

Windows directory

Client Readme.txt

C:\Program Files\Avaya\CT\TS Win
32\Program

UnixWare Client

UnixWare Client
When Telephony Services is installed on a UnixWare client, the files listed in Table A-5 are
copied to your client’s hard drive.
Table A-5: Files Copied to UnixWare Client
File Name

Destination

/usr/lib/attpriv.so

Client hard
drive

/usr/lib/libcsta.so

Client hard
drive

/usr/lib/tslibrc

Client hard
drive

/usr/lib/tstest

Client hard
drive

/usr/lib/
tslib.readme

Client hard
drive

Issue 1 October 2003

201

Avaya Computer Telephony Installed Files

HP-UX Client
When Telephony Services is installed on a HP-UX client, the files listed in Table A-6 are
copied to your client’s hard drive.

Table A-6: Files Copied to HP-UX Client

202 Installation Guide

File Name

Destination

/usr/lib/attpriv.sl

Client hard
drive

/usr/lib/libcsta.sl

Client hard
drive

/usr/lib/tstest

Client hard
drive

/usr/lib/tslibrc

Client hard
drive

JTAPI Client

JTAPI Client
When the JTAPI Client software is installed, the files in the following table are copied to the
client’s hard drive.
File Name

Destination Directory

Ecsjtapi.zip

C:\Program Files\Avaya\CT\Jtapi

Ecsjtapi.cab

C:\Program Files\Avaya\CT\Jtapi

Ecsjtapi.jar

C:\Program Files\Avaya\CT\Jtapi

Jtapi Client Readme.txt

C:\Program Files\Avaya\CT\Jtapi

Simsdb.txt

C:\Program Files\Avaya\CT\Jtapi

Ecsjtapi.zip

C:\Program Files\Avaya\CT\Jtapi\All

Ecsjtapi.cab

C:\Program Files\Avaya\CT\Jtapi\All

Ecsjtapi.jar

C:\Program Files\Avaya\CT\Jtapi\All

Ecsjtapi.zip

C:\Program Files\Avaya\CT\Jtapi\Debug

Ecsjtapi.cab

C:\Program Files\Avaya\CT\Jtapi\Debug

Ecsjtapi.jar

C:\Program Files\Avaya\CT\Jtapi\Debug

tstest.cab

C:\Program Files\Avaya\CT\Jtapi\Tools\Tstest

tstext.html

C:\Program Files\Avaya\CT\Jtapi\Tools\Tstest

AppletFrame$SymWindow.class

C:\Program
Files\Avaya\CT\Jtapi\Tools\Tstest\jtest

AppletFrame.class

C:\Program
Files\Avaya\CT\Jtapi\Tools\Tstest\jtest

TraceFrame$SymComponent.class

C:\Program
Files\Avaya\CT\Jtapi\Tools\Tstest\jtest

TraceFrame$SymWindow.class

C:\Program
Files\Avaya\CT\Jtapi\Tools\Tstest\jtest

TraceFrame.class

C:\Program
Files\Avaya\CT\Jtapi\Tools\Tstest\jtest

TSTest$SymAction.class

C:\Program
Files\Avaya\CT\Jtapi\Tools\Tstest\jtest

TSTest$SymFocus.class

C:\Program
Files\Avaya\CT\Jtapi\Tools\Tstest\jtest

Issue 1 October 2003

203

Avaya Computer Telephony Installed Files

File Name

Destination Directory

TSTest$SymItem.class

C:\Program
Files\Avaya\CT\Jtapi\Tools\Tstest\jtest

TSTest$SymKey.class

C:\Program
Files\Avaya\CT\Jtapi\Tools\Tstest\jtest

TSTest.class

C:\Program
Files\Avaya\CT\Jtapi\Tools\Tstest\jtest

204 Installation Guide

JTAPI SDK

JTAPI SDK
When the JTAPI SDK software is installed, the files in the following table are copied to the
client’s hard drive.

File Name

Destination Directory

Jtapi SDK Reame.txt

C:\Program Files\Avaya\CT\SDKs\Jtapi

jtapiex.jar

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Jtapiex

AppletFrame.java

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Samples\TSTest

TraceFrame.java

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Samples\TSTest

tstest.html

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Samples\TSTest

TSTest.java

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Samples\TSTest

MyRouteCallback.class

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Samples\Route

MyTextArea.class

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Samples\Route

MyTextArea.java

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Samples\Route

Route$SymComponent.class

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Samples\Route

Route.class

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Samples\Route

route.html

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Samples\Route

Route.java

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Samples\Route

RoutetoDialog$SymAction.class

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Samples\Route

RoutetoDialog$SymComponent.class

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Samples\Route

RoutetoDialog$SymFocust.class

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Samples\Route

Issue 1 October 2003

205

Avaya Computer Telephony Installed Files

File Name

Destination Directory

RoutetoDialog$SymKey.class

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Samples\Route

RoutetoDialog$SymWindow.class

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Samples\Route

RoutetoDialog.class

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Samples\Route

RoutetoDialog.java

C:\Program
Files\Avaya\CT\SDKs\Jtapi\Samples\Route

CallLog$SymAction.class