Computer Accessories User Manual

ManualsBrandsAvaya ManualsComputer Accessories1.3

Avaya Computer Telephony

Release 1.3

Installation Guide

Issue 1

October 2003

Summary of content (256 pages)

PAGE 1
Avaya Computer Telephony Release 1.
PAGE 2
© 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.
PAGE 3
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 . . . . . . . . . . . . . . . . . . .
PAGE 4
Contents Private Data and Client Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Chapter 2: Administering the Switch. . . . . . . . . . . . . . . . . . . . . . . . . . . 37 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 . .
PAGE 5
Contents Chapter 4: Installing Avaya Computer Telephony TSAPI Client Software . . . . . . . 93 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 94 96 . . . . . . . . . . . . . . 96 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 97 Avaya Computer Telephony Clients and Private Data Versions Planning Your Installation . . . . . . . . . . . . . . . . . . TSAPI Client Hardware and Software Requirements . . . . .
PAGE 6
Contents Starting the CVLAN Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Starting the CVLAN Server with the Telephony Services Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . Starting the CVLAN Server from the Windows Operating System . . . . . . . . . . . . 132 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 7
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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 8
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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 9
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) . . . . . . . . . . . . . . . .
PAGE 10
Contents 10 Installation Guide
PAGE 11
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
PAGE 12
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.
PAGE 13
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.
PAGE 14
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.
PAGE 15
Related Documents Related Documents Because Avaya Computer Telephony is a software solution that represents the bridge between switching resources and computing resources, this document assumes that you already have the components (hardware and software) that Avaya Computer Telephony joins together or integrates. For this reason, “Related Documents” refers to both switch oriented documents as well as the Avaya Computer Telephony documents that complement this installation guide.
PAGE 16
Preface - About This Document Switch Interface Documents The communications interface between the switch and the server is the DEFINITY LAN Gateway (which resides in the switch). ● If you use a DEFINITY ECS or Avaya MultiVantage on a DEFINITY Server CSI, the primary resource for the DEFINITY LAN Gateway running on a Multi Application Platform for DEFINTY (MAPD) is: DEFINITY ECS and CallVisor ASAI Applications over MAPD, 555-230-136 (this document is included on the ASAI Documents CD (585-246801).
PAGE 17
Related Documents Online Documents Avaya Computer Telephony Documents on Your Desktop depicts a desktop view of the Avaya Computer Telephony documents that are provided on the Avaya Computer Telephony CD ROM. If you elected to install the documents on your PC, you can view the Avaya Computer Telephony document icons from your desktop (click Start, point to Programs, Avaya Computer Telephony, Documents).
PAGE 18
Preface - About This Document Document Designations -- Icons, Titles, and File Names The purpose of this section is to familiarize you with the various designations that are used for the Avaya Computer Telephony documents. The previous section identifies the desktop icons for each document. This section associates those icons with the formal document title, and the document file name.
PAGE 19
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.
PAGE 20
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.
PAGE 21
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 21
PAGE 22
Preface - About This Document 22 Installation Guide
PAGE 23
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.
PAGE 24
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.
PAGE 25
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).
PAGE 26
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).
PAGE 27
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.
PAGE 28
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.
PAGE 29
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.
PAGE 30
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.
PAGE 31
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).
PAGE 32
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.
PAGE 33
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.
PAGE 34
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.
PAGE 35
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.
PAGE 36
Learning About Avaya Computer Telephony 36 Installation Guide
PAGE 37
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.
PAGE 38
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.
PAGE 39
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.
PAGE 40
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.
PAGE 41
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.
PAGE 42
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.
PAGE 43
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.
PAGE 44
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.
PAGE 45
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.
PAGE 46
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.
PAGE 47
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.
PAGE 48
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.
PAGE 49
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.
PAGE 50
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.
PAGE 51
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 1. Application Port Assignment 2. DLG Administration 3. CV/LAN Administration 4. 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.
PAGE 52
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.
PAGE 53
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.
PAGE 54
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.
PAGE 55
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.
PAGE 56
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.
PAGE 57
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.
PAGE 58
Administering the Switch 58 Installation Guide
PAGE 59
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.
PAGE 60
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).
PAGE 61
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.
PAGE 62
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).
PAGE 63
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.
PAGE 64
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.
PAGE 65
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).
PAGE 66
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.
PAGE 67
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.
PAGE 68
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).
PAGE 69
Avaya Computer Telephony Installation Guidelines ● Avaya Web Collaboration ● Avaya Messaging ● Avaya Unified Communication Center Issue 1 October 2003 69
PAGE 70
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.
PAGE 71
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.
PAGE 72
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).
PAGE 73
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.
PAGE 74
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.
PAGE 75
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.
PAGE 76
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.
PAGE 77
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.
PAGE 78
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.
PAGE 79
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.
PAGE 80
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.
PAGE 81
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.
PAGE 82
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).
PAGE 83
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.
PAGE 84
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.
PAGE 85
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.
PAGE 86
Installing Avaya Computer Telephony Server Software Desktop Components Figure 3-2 depicts the desktop icons provided by Avaya Computer Telephony software.
PAGE 87
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.
PAGE 88
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.
PAGE 89
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.
PAGE 90
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.
PAGE 91
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.
PAGE 92
Installing Avaya Computer Telephony Server Software 92 Installation Guide
PAGE 93
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.
PAGE 94
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.
PAGE 95
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.
PAGE 96
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.
PAGE 97
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.
PAGE 98
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.
PAGE 99
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.
PAGE 100
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.
PAGE 101
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.
PAGE 102
Installing Avaya Computer Telephony TSAPI Client Software 4. Click on the Client Software button. Setup displays the Client Setup dialog box.
PAGE 103
Installing the Windows Client Software 5. Click the button for Telephony Services 32-bit Windows Client. Setup displays the Welcome dialog box.
PAGE 104
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.
PAGE 105
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.
PAGE 106
Installing Avaya Computer Telephony TSAPI Client Software Note: 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.
PAGE 107
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.
PAGE 108
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).
PAGE 109
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.
PAGE 110
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.
PAGE 111
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.
PAGE 112
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.
PAGE 113
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.
PAGE 114
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.
PAGE 115
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.
PAGE 116
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.
PAGE 117
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.
PAGE 118
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.
PAGE 119
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.
PAGE 120
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.
PAGE 121
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.
PAGE 122
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.
PAGE 123
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.
PAGE 124
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.
PAGE 125
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).
PAGE 126
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.
PAGE 127
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).
PAGE 128
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.
PAGE 129
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.
PAGE 130
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.
PAGE 131
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.
PAGE 132
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.
PAGE 133
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.
PAGE 134
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.
PAGE 135
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.
PAGE 136
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.
PAGE 137
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.
PAGE 138
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.
PAGE 139
Installing CVLAN Client Software Setup displays the Client Setup dialog box 3. Click the CVLAN button.
PAGE 140
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.
PAGE 141
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.
PAGE 142
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.
PAGE 143
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.
PAGE 144
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).
PAGE 145
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.
PAGE 146
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.
PAGE 147
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.
PAGE 148
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
PAGE 149
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.
PAGE 150
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.
PAGE 151
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: 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).
PAGE 152
Installing JTAPI Client Software 2. Click on the Client Software button. Setup displays the Client Setup dialog box.
PAGE 153
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.
PAGE 154
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.
PAGE 155
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.
PAGE 156
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.
PAGE 157
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.
PAGE 158
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.
PAGE 159
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.
PAGE 160
Using the JTAPI SDK Components of the JTAPI SDK The JTAPI SDK is the Avaya Computer Telephony implementation of the JAVA Telephony API. With the JTAPI SDK you can develop JTAPI applications that access the DEFINITY system using Avaya Computer Telephony. Figure 7-1 depicts the following components of the JTAPI SDK. JTAPI Client - These are the JTAPI JAVA classes that you will need to build and execute your application. Several different packagings are provided.
PAGE 161
Installing the JTAPI SDK Installing the JTAPI SDK 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 7-2: Telephony Services Setup Screen 3. Click on the Software Development Kit (SDK) button.
PAGE 162
Using the JTAPI SDK The Telephony Services SDK Setup screen displays 162 Installation Guide
PAGE 163
Installing the JTAPI SDK 4. Click on the JTAPI Software Development Kit button. The Welcome screen displays.
PAGE 164
Using the JTAPI SDK 5. Click Next to continue with the installation. The JTAPI SDK Setup screen displays. 6. Check the appropriate components to install then click Next. If you have selected the JTAPI Client then the JTAPI Client Welcome Dialog displays. Refer to ‘‘Installing the JTAPI Client Software in the Windows Environment’’ on page 151 for more information.
PAGE 165
Installing the JTAPI SDK The Choose Destination Location screen displays. 7. Accept the default destination folder or use the browse button to select a different destination location. Click Next.
PAGE 166
Using the JTAPI SDK The Destination Folder Structure screen displays. 8. Click Next.
PAGE 167
Private Data Versions Supported The Installation Status screen displays. The installation is complete. Private Data Versions Supported The Avaya Computer Telephony JTAPI client platform supports DEFINITY Private Data Version up to Private Data Version 6. For more information see, Table 1-1: Avaya Computer Telephony Client Platforms Private Data Version Compatibility.
PAGE 168
Using the JTAPI SDK Java Client Hardware and Software Requirements See Table 7-1 for the Java Client Hardware and Software requirements. Table 7-1: Java Client Hardware and Software Requirements CPU Any platform that supports Java Virtual Machine (VM) RAM Platform-dependent Disk Space 2 MB Operating System Java VM1 Netscape Navigator 3.x or later or Internet Explorer 4.x or later 1. Any Java Virtual Machine (VM) compatible with the Sun Microsystem Java specification, Version 1.02 or later.
PAGE 169
Running JTAPI Applets Note: Note: The Simulator TLINK name will be "avaya#cstaserv#csta#" where is the name of the Windows NT, Windows 2000 or Windows XP server that the Tserver is installed on. The login and passwd are the user's Windows NT, Windows 2000 or Windows XP login and password. 4.
PAGE 170
Using the JTAPI SDK Running Applets in Internet Explorer Follow these guidelines when running appplets in Internet Explorer. 1. Make sure the ECSJTAPID.CAB file is in the same directory as your HTML web page. 2. Make sure there are lines in the web page for your java applet to access ECSJTAPID.CAB, as in Additionally, if your applet is in a signed cab such as TSTEST.
PAGE 171
JTAPI Sample Applications (SDK\Jtapi\OS_Independent\Samples) JTAPI Sample Applications (SDK\Jtapi\OS_Independent\Samples) With this product, four sample JTAPI applications/applets have been included to help you get started. ● ACD Applet ● CallLog Application ● TSTest Applet/Application ● Route Applet Each directory contains both the source and the executable files. Examine the source files -- *.java and *.html -- for details on the JTAPI interfaces used.
PAGE 172
Using the JTAPI SDK ACD Applet This applet demonstrates the use of the JTAPI Call Center package. It gets the ACDAddresses known to the provider, and the agents logged-in at those ACD splits. It tries to log-in two agents specified as parameters in the acd.html file. To run: 1. CLASSPATH must be modified to include ecsjtapid.jar, and the directory containing the tsapi.pro file. 2. Modify the tsapi.pro file to include the IP address or hostname of your Tserver.
PAGE 173
JTAPI Sample Applications (SDK\Jtapi\OS_Independent\Samples) ● The ability to disconnect active call To run: 1. CLASSPATH must be modified to include ecsjtapid.jar, and the directory containing the tsapi.pro file. 2. Modify the tsapi.pro file to include the IP address or hostname of your Tserver. 3. From the command prompt, type start java CallLog TSTest Applet/Application (in the TSTest directory) Use TSTest to make a call in order to test the installation of the JTAPI client software.
PAGE 174
Using the JTAPI SDK To run: 1. CLASSPATH must be modified to include ecsjtapid.jar, and the directory containing the tsapi.pro file. 2. Modify the tsapi.pro file to include the IP address or hostname of your Tserver. 3. Modify the route.html file to customize it for your environment.
PAGE 175
The JTAPI Exerciser Application The JTAPI Exerciser Application The JTAPI Exerciser is a Java application that allows you to create JTAPI objects and invoke their methods interactively. Manually Installing and Running the JTAPI Exerciser For Non-Windows operating systems and some special cases on a Windows operating system a manual install may be necessary. The required files should be copied manually and can be found on the CD-ROM under this path: \sdks\jtapi\os_independent\.
PAGE 176
Using the JTAPI SDK Obtaining Version Information To obtain version information of the JTAPI client software, execute the following command from the command prompt: java ECSJtapiVersion Or in the Windows environment run the application from the JTAPI SDK start menu shortcut. JTAPI Online Support Up to date information, including patches and Frequently Asked Questions are available at the following URL: http://www.avaya.
PAGE 177
Chapter 8: Using the TSAPI SDK This chapter contains the following sections which provide information for using Telephony Services Application Programming Interface (TSAPI) Software Development Kit (SDK), which is included on the Avaya Computer Telephony CD-ROM.
PAGE 178
Using the TSAPI SDK SDK Online Support Up to date information, including patches and Frequently Asked Questions are available at the following URL: http://support.avaya.com/ Under "CTI", select "Avaya Computer Telephony SDK Support". Avaya Computer Telephony Installation Instructions for Using the SDK on Windows From the master Avaya Computer Telephony Installer install the product documentation and the Avaya Computer Telephony Software. Do not install the DEFINITY G3 PBX Driver and CallVisor PC software.
PAGE 179
High Level View of the TSAPI SDK High Level View of the TSAPI SDK The TSAPI SDK provides a development environment for programming TSAPI applications and developing PBX drivers. Figure 8-1 shows the components included in the TSAPI SDK.
PAGE 180
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.
PAGE 181
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.
PAGE 182
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.
PAGE 183
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.
PAGE 184
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.
PAGE 185
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.
PAGE 186
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.
PAGE 187
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.
PAGE 188
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.
PAGE 189
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.
PAGE 190
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.
PAGE 191
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.
PAGE 192
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).
PAGE 193
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.
PAGE 194
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.
PAGE 195
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.
PAGE 196
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.
PAGE 197
Avaya CT Server Table A-1: Telephony Server Files File Name Destination Directory Tslog.dll C:\Winnt\system32 Insttsdr.dll C:\Winnt\system32 Tsmi.
PAGE 198
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.
PAGE 199
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.
PAGE 200
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.
PAGE 201
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.
PAGE 202
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.
PAGE 203
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.
PAGE 204
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.
PAGE 205
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.
PAGE 206
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 C:\Program Files\Avaya\CT\SDKs\Jtapi\Samples\CallLog CallLog$SymComponent.
PAGE 207
JTAPI SDK File Name Destination Directory LoginDialog$SymWindow.class C:\Program Files\Avaya\CT\SDKs\Jtapi\Samples\CallLog LoginDialog.class C:\Program Files\Avaya\CT\SDKs\Jtapi\Samples\CallLog LoginDialog.java C:\Program Files\Avaya\CT\SDKs\Jtapi\Samples\CallLog MakeCallDialog$SymAction.class C:\Program Files\Avaya\CT\SDKs\Jtapi\Samples\CallLog MakeCallDialog$SymFocus.class C:\Program Files\Avaya\CT\SDKs\Jtapi\Samples\CallLog MakeCallDialog$SymKey.
PAGE 208
Avaya Computer Telephony Installed Files File Name Destination Directory MyACDObserver.class C:\Program Files\Avaya\CT\SDKs\Jtapi\Samples\Acd MyTextArea.class C:\Program Files\Avaya\CT\SDKs\Jtapi\Samples\Acd MyTextArea.
PAGE 209
TSAPI SDK TSAPI SDK When the TSAPI SDK software is installed, the files in the following table are copied to the client’s hard drive. File Name Destination Directory TSAPI SDK Readme.txt C:\Program Files\Avaya\CT\SDKs\TSAPI Acs.h C:\Program Files\Avaya\CT\SDKs\TSAPI\Hdrs Acsdefs.h C:\Program Files\Avaya\CT\SDKs\TSAPI\Hdrs Acslimit.h C:\Program Files\Avaya\CT\SDKs\TSAPI\Hdrs Attpdefs.h C:\Program Files\Avaya\CT\SDKs\TSAPI\Hdrs Attpriv.h C:\Program Files\Avaya\CT\SDKs\TSAPI\Hdrs Cdi.
PAGE 210
Avaya Computer Telephony Installed Files 210 Installation Guide File Name Destination Directory Sampldlg.h C:\Program Files\Avaya\CT\SDKs\TSAPI\Samples\Tsapicnf Stdafx.cpp C:\Program Files\Avaya\CT\SDKs\TSAPI\Samples\Tsapicnf Stdafx.h C:\Program Files\Avaya\CT\SDKs\TSAPI\Samples\Tsapicnf Tsapi.cpp C:\Program Files\Avaya\CT\SDKs\TSAPI\Samples\Tsapicnf Tsapi.h C:\Program Files\Avaya\CT\SDKs\TSAPI\Samples\Tsapicnf Tsapicnf.cpp C:\Program Files\Avaya\CT\SDKs\TSAPI\Samples\Tsapicnf Tsapicnf.
PAGE 211
TSAPI SDK File Name Destination Directory Stdafx.h C:\Program Files\Avaya\CT\SDKs\TSAPI\Samples\Tsapiin Tsapi.cpp C:\Program Files\Avaya\CT\SDKs\TSAPI\Samples\Tsapiin Tsapi.h C:\Program Files\Avaya\CT\SDKs\TSAPI\Samples\Tsapiin Tsapicnf.cpp C:\Program Files\Avaya\CT\SDKs\TSAPI\Samples\Tsapiin Tsapiin.exe C:\Program Files\Avaya\CT\SDKs\TSAPI\Samples\Tsapiin\De bug Tsapiin.ico C:\Program Files\Avaya\CT\SDKs\TSAPI\Samples\Tsapiin\Re s Tsapiin.
PAGE 212
Avaya Computer Telephony Installed Files 212 Installation Guide File Name Destination Directory Tsapimul.ico C:\Program Files\Avaya\CT\SDKs\TSAPI\Samples\Tsapimul\ Res Tsapimul.rc2 C:\Program Files\Avaya\CT\SDKs\TSAPI\Samples\Tsapimul\ Res Opentsrv.cpp C:\Program Files\Avaya\CT\SDKs\TSAPI\Samples\Tsapiout Opentsrv.h C:\Program Files\Avaya\CT\SDKs\TSAPI\Samples\Tsapiout Resource.h C:\Program Files\Avaya\CT\SDKs\TSAPI\Samples\Tsapiout Sampldlg.
PAGE 213
Appendix B: Administering CTI Links for Definity G3PD Each Basic Rate Interface (BRI) line that connects the DEFINITY G3 switch to a LAN card installed in the Telephony file server must be properly administered. The ports on the DEFINITY LAN Gateway are BRI ports, which is why ASAI terminals can be assigned to them. Use the add station or change station command to administer each ASAI link.
PAGE 214
Administering CTI Links for Definity G3PD CTI Link Settings The following table summarizes the correct DEFINITY G3 settings for DEFINITY LAN Gateway connections. Table B-1: CTI Link Station Administration 214 Installation Guide Field Name Required/Optional Contents Extension: Required Whatever fits your dial plan Type: Required ADJLK Port: Required Port that connects ASAI line Name: Optional Whatever you like, room #, etc.
PAGE 215
DEFINITY LAN Gateway Multi- Function Board (MFB) and Multi-Application for DEFINITY Board (MAPD) DEFINITY LAN Gateway Multi- Function Board (MFB) and Multi-Application for DEFINITY Board (MAPD) The DEFINITY LAN Gateway system is composed of a system assembly and a software application. The system assembly is a DEFINITY Multi-Function Board (MFB) (TN2208) and an Alarm Board (TN2170) inserted into a DEFINITY carrier.
PAGE 216
Administering CTI Links for Definity G3PD 216 Installation Guide
PAGE 217
Appendix C: Migrating your Security Database This appendix describes the procedure for migrating your Security Database from a Netware Server to a Windows Server. Migrating from a NetWare Server to a Windows NT, Windows 2000 or Windows XP Server To migrate from a NetWare telephony server to a Windows NT, Windows 2000 or Windows XP telephony server, you need to convert the Telephony Services Security Database (SDB) to a format understood by the Windows NT, Windows 2000 or Windows XP server.
PAGE 218
Migrating your Security Database Converting the Security Database To convert the Telephony Services Security Database to a Windows NT, Windows 2000 or Windows XP compatible format, follow these steps: Back up the NetWare Security Database and create the flat file using one of the following methods: Using TSA32: 1. From the "Admin" menu of the TSA32, select "Bulk Admin," then select "Back Up SDB.
PAGE 219
Converting the Security Database Table C-1: Security Database Conversion File Example INFORM1 4 300 301 302 303 INFORM2 device Device ID Device type Tlist Location ADD 4 401.sales.ny.ac me PHONE ANY PBX NYC ADD 4 402.sales.ny.ac me PHONE ANY PBX NYC ADD 4 403.svc.ny.acm e PHONE ANY PBX NYC ADD 4 404.svc.ny.acm e PHONE ANY PBX NYC INFORM1 workt op 200 201 202 203 INFORM2 2 Worktop Name Device ID IPX address IP address ADD 2 W401.sales.ny.a cme 401.sales.ny.
PAGE 220
Migrating your Security Database The SDB backup file can be found in the "SYS:\SYSTEM\TSRV\SDB\BULK_ADD" directory on your NetWare telephony server. You must put the file in the "\Program Files\Telephony Services\tsrv\sdb\bulk_add" directory on your Windows NT, Windows 2000 or Windows XP telephony server. Some changes need to be made to the data in your conversion file. MIGRATE.EXE makes most of these changes for you. MIGRATE.EXE: Removes existing Tlink objects.
PAGE 221
Converting the Security Database ● If your NetWare SDB contained Tlink groups or Admin Access Groups, these group objects remain, but they will no longer contain any Tlinks. You will need to add the new Tlink names to these groups. ● You may add Tlink members to your Tlink groups and Admin Access Groups by editing the conversion file. However, it will probably be easier to make these changes using the TSA or TSA32 applications after you have loaded the conversion file into your SDB. b.
PAGE 222
Migrating your Security Database (LAN addresses are only necessary if you are using the "Extended Worktop Access" feature.) 8. Start Telephony Services on your Windows NT, Windows 2000 or Windows XP server and bring up TSA32. a. Select the "Bulk Admin" option from the "Admin" menu. This time, select the "Upgrade SDB" option. b. In the "Flat File Name" field, enter the name of the conversion file you created in step 5. Click "OK.
PAGE 223
Appendix D: Pre-Release 11 Link Administration Instructions The following instructions apply to a Release 10 or earlier switch. Introduction This appendix describes DEFINITY-based tasks that must be performed to implement communications between the DEFINITY switch and the Avaya Computer Telephony server. Scope of this appendix Refer to Figure D-1 as you read this section. The scope of this appendix includes the DEFINITY switch and the communications interface to the Avaya CT server.
PAGE 224
Pre-Release 11 Link Administration Instructions Using the Information in this appendix This appendix 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 appendix.
PAGE 225
DEFINITY ECS and DEFINITY PROLOGIX Administration Figure D-1: DEFINTY ECS/DEFINITY PROLOGIX and MAPD/DLG Administration at a Glance DEFINITY ECS and DEFINITY PROLOGIX 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 —
PAGE 226
Pre-Release 11 Link Administration Instructions ● The DLG should be on its own separate LAN segment. To effect this, you will need two Network Interface Cards (NICs) in the Avaya CT 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.
PAGE 227
DEFINITY ECS and DEFINITY PROLOGIX Administration The DLG has a default set of administered parameters that correspond to the defaults provided in the Avaya CT 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 Procedure for Initial, Default Installation of Avaya Computer Telephony Server Software, in Chapter 3.
PAGE 228
Pre-Release 11 Link Administration Instructions 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.
PAGE 229
DEFINITY ECS and DEFINITY PROLOGIX Administration Note: Note: For newer versions of the switch, the STATION screen may contain more options. Only the options in Steps a through i are relevant to Avaya CT.
PAGE 230
Pre-Release 11 Link Administration Instructions Task 2: DLG Administration The objective of Task 2 is to establish connectivity between DEFINITY and your Avaya CT 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.
PAGE 231
DEFINITY ECS and DEFINITY PROLOGIX Administration 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 CT Server. 5.
PAGE 232
Pre-Release 11 Link Administration Instructions 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.
PAGE 233
DEFINITY ECS and DEFINITY PROLOGIX Administration Note: Note: If the MAPD/DLG has already been administered to accept the default IP address of the Avaya CT server (192.168.25.20), and you want to implement a default Avaya CT configuration, skip Step 8a and 8b; go to Step 8c.
PAGE 234
Pre-Release 11 Link Administration Instructions 9. From the Main Menu, select 3. Port Administration... The Port Administration screen appears. Port Administration 1. Application Port Assignment 2. DLG Administration 3. CV/LAN Administration 4. 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.
PAGE 235
DEFINITY ECS and DEFINITY PROLOGIX Administration a. In the Port field, type the port number of the DEFINITY station administered for the link to the Avaya CT 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 CT 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.
PAGE 236
Pre-Release 11 Link Administration Instructions Checklist for DEFINITY ECS and DEFINITY PROLOGIX with DLG/MAPD — Before You Install Avaya CT Use this checklist to make sure you have completed these tasks before you attempt to install the Avaya CT software. Table D-1: Checklist — DEFINITY ECS and DEFINITY PROLOGIX 236 Installation Guide Task Administrative Interface See...
PAGE 237
DEFINITY ONE Administration DEFINITY ONE Administration DEFINITY ONE administrative tasks are done from the DEFINITY SAT (see Figure D-1). DEFINITY ONE administration refers to administering DEFINTY for Avaya CT, as opposed to DEFINTY site administration.
PAGE 238
Pre-Release 11 Link Administration Instructions DEFINITY ONE Pre-Administration — Setting Up Your Avaya CT Configuration Use this section to ensure that you know the requirements of your configuration before you administer DEFINITY ONE for Avaya CT. Basic Switch Requirements These are the basic switch requirements. ● The CTI interface requires DEFINITY ONE R2, or later. ● The ASAI Proprietary Adjunct Link option must be enabled on the switch (systemparameters customer-options screen).
PAGE 239
DEFINITY ONE Pre-Administration — Setting Up Your Avaya CT Configuration IP Address of DEFINITY G3 PBX Driver on Avaya CT Server (Applies to Either Configuration Option) 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.
PAGE 240
Pre-Release 11 Link Administration Instructions 4. Type display system-parameters customer-options The OPTIONAL FEATURES screen appears. 5. Check ASAI Proprietary Adjunct Links? and make sure it is set to y, (page 2 of the OPTIONAL FEATURES screen in the example above). If it is set to n, use the change system-parameters customer-options command and set the following feature: ASAI Proprietary Adjunct Links? y 6. Type display system-parameters customer-options The OPTIONAL FEATURES screen appears. 7.
PAGE 241
DEFINITY ONE Pre-Administration — Setting Up Your Avaya CT Configuration 8. Type add station The STATION screen appears. 9. Follow steps a through i to complete the STATION screen and administer the IP Link endpoint. a. In the Extension: field, type any valid extension on the dial plan (for example, 3000). 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 CT server e. In the XID: field, accept the default (n) f.
PAGE 242
Pre-Release 11 Link Administration Instructions 10. Type change node-names The NODE NAMES screen appears. 11. Follow steps a and b to complete the NODE NAMES screen and define the Avaya CT server’s name and address. a. In the Name: field, type the name you want to assign to the Avaya CT server (freeform field) b. In the IP Address: field, type the IP address of the G3PBX Driver (default is 192.128.25.20) 12. Type change ip-services The IP SERVICES screen appears. 13.
PAGE 243
DEFINITY ONE Pre-Administration — Setting Up Your Avaya CT Configuration Procedure for Setting Up TN799 C-LAN to DEFINITY ONE (Option 2) If you are connecting to a DEFINITY via a C-LAN (running the DLG), a PROCR, and Data Module follow this procedure. Note: Note: Whenever you use the change form of a DEFINITY ONE SAT command, you must log out for the changes to take effect. 1. Log in to the DEFINITY ONE switch. 2. Type list configuration software-versions The SOFTWARE VERSIONS screen appears. 3.
PAGE 244
Pre-Release 11 Link Administration Instructions 6. Type add station The STATION screen appears. 7. Follow steps a through i to complete the STATION screen and administer the IP Link endpoint. a. In the Extension: field, type any valid extension on the dial plan (for example, 3000). 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 CT server e. In the XID: field, accept the default (n) f.
PAGE 245
DEFINITY ONE Pre-Administration — Setting Up Your Avaya CT Configuration 8. Type change node-names The NODE NAMES screen appears. 9. Follow steps a and b to complete the NODE NAMES screen and define the Avaya CT server’s name and address. a. In the Name: field, type the name you want to assign to the Avaya CT server (freeform field) b. In the IP Address: field, type the IP address of the G3PBX Driver (default is 192.128.25.20) 10.
PAGE 246
Pre-Release 11 Link Administration Instructions 12. Type change ip-services The IP SERVICES screen appears. 13. Follow steps a through e to complete the IP SERVICES screen, and administer the DLG link as a DEFINITY ONE system. a. In the Service Type: field, type ADJLK1 (DEFINITY ONE uses link 1 only) b. In the Local node: field, type clan1 c. In the Local port: field, type 5678 d. In the Remote node: field type the name you assigned to the Avaya CT server in Step 8a (NODE NAMES screen). e.
PAGE 247
DEFINITY ONE Pre-Administration — Setting Up Your Avaya CT Configuration Table D-2: Checklist — DEFINITY ONE with TN795 PRCR — Option 1 Task See.... Verify that DEFINITY ECS switch software supports the CTI interface. Steps 2 and 3 in "Procedure for Setting Up PROCR Connectivity to DEFINITY ONE" Verify that ASAI Proprietary Adjunct Link option is installed and enabled on the switch (system-parameters customeroptions screen).
PAGE 248
Pre-Release 11 Link Administration Instructions Task See.... Define the Avaya CT server name and IP address Steps 8 and 9 in "Procedure for Setting Up C-LAN Connectivity to DEFINITY ONE" Make sure the Data Module has been administered. Steps 10 and 11 in "Procedure for Setting Up C-LAN Connectivity to DEFINITY ONE" Make sure the DLG link is administered as a DEFINITY ONE system.
PAGE 249
DEFINITY ONE Pre-Administration — Setting Up Your Avaya CT Configuration Figure D-3: DEFINITY ONE Administration v. Avaya CT Server Administration D EFIN IT Y ONE Administr ation On the IP SERVICES screen, Local Node is either “procr” or the name you assign to the C-LAN (for example, avayatsrv).
PAGE 250
Pre-Release 11 Link Administration Instructions 250 Installation Guide
PAGE 251
Index Bulk administration feature . . . . . . . . . . . . 217 bulk_add directory . . . . . . . . . . . . . . . . 222 Numerical 10Base-T Ethernet . . . . . . 32-bit client installing files copied to hard drive verifying . . . . . . . . uninstalling . . . . . . . . . . . . . . . . . . 215 . . . . . . . . . . 200 . . . . . . . . . . 109 . . . . . . . 119, 146 A add station command . . . . . . . . . . . . Adding tlink names . . . . . . . . . . . . . ADJLK feature, . . . . . . . . . . . . . . .
PAGE 252
for Tserver operation . . . . . CV/LAN client hardware requirements . . . . installing on Solaris SPARC . . installing on UnixWare . . . . installing on Windows NT . . . platform . . . . . . . . . . . software requirements . . . . . supported platforms . . . . . . uninstalling on Solaris SPARC . uninstalling on Windows NT . . CV/LAN server handling routing requests . . . link sharing . . . . . . . . . . manually stopping. . . . . . . need for load balancing . . . . post-installation tasks . . . . .
PAGE 253
client software, preliminary . . . . CV/LAN client on Solaris SPARC . . . . . . on Windows NT . . . . . . . . on CV/LAN UnixWare client . . . . . . . . Solaris SPARC client verifying . . . . . . . . . . . UnixWare client files copied to hard drive . . . from command line . . . . . . from diskettes . . . . . . . . from the CD . . . . . . . . . verifying . . . . . . . . . . . Windows NT client verifying . . . . . . . . . . . Internet Explorer . . . . . . . . . . .
PAGE 254
for UnixWare clients . . . . . . . . . . . . . . . 35 for Win32 clients . . . . . . . . . . . . . . . . 35 Processor card (PROCR), TN795 . . . . . . . . . 238 R Reinstalling CV/LAN server . . . . . . . . . . . . . . . . . 90 Telephony Services . . . . . . . . . . . . . . . 90 Requirements hardware for CV/LAN clients . . . . . . . . . . 136 hardware for Java clients . . . . . . . . . . . 168 hardware for UnixWare clients . . . . . . . . . . 97 hardware for Windows-based clients . . . . . . .
PAGE 255
installing on CV/LAN server . . . . platform . . . . . . . . . . . . . private data versions . . . . . . . software requirements . . . . . . supported for CV/LAN server . . . supported for Telephony Services . supported server versions . . . . uninstalling . . . . . . . . . . . UnixWare client, installing . . . . . . Updating admin access groups . . . . . . . tlink groups . . . . . . . . . . . User IDs, for administrative software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 256
Installation Guide