Cisco Unified TAPI Developers Guide for Cisco Unified Communications Manager Release 7.1(3)
Cisco Unified TAPI Installation
Downloads: This chapterpdf (PDF - 676.0KB) The complete bookPDF (PDF - 9.75MB) | Feedback

Cisco Unified TAPI Installation

Table Of Contents

Cisco Unified TAPI Installation

Required Software

Supported Windows Platforms

Installing the Cisco Unified TSP

Silent Installation

Activating the Cisco Unified TSP

Configuring the Cisco Unified TSP

Cisco Unified TSP Configuration Settings

General

User

CTI Manager

Wave

Trace

Advanced

Language

Installing the Wave Driver

Saving Wave Driver Information

Verifying the Wave Driver Exists

Verifying the Cisco Unified TSP Installation

Setting Up Client-Server Configuration

Uninstalling the Wave Driver

Removing the Cisco Unified TSP

Managing the Cisco Unified TSP

Reinstalling the Cisco Unified TSP

Upgrading the Cisco Unified TSP

Auto Update for Cisco Unified TSP Upgrades

Auto Update Behavior

Uninstalling the Cisco Unified TSP


Cisco Unified TAPI Installation


This chapter describes how to install and configure the Cisco Unified Telephony Application Programming Interface (TAPI) client software for Cisco Unified Communications Manager. It contains the following sections:

Required Software

Supported Windows Platforms

Installing the Cisco Unified TSP

Silent Installation

Activating the Cisco Unified TSP

Configuring the Cisco Unified TSP

Cisco Unified TSP Configuration Settings

Installing the Wave Driver

Saving Wave Driver Information

Verifying the Wave Driver Exists

Verifying the Cisco Unified TSP Installation

Setting Up Client-Server Configuration

Uninstalling the Wave Driver

Removing the Cisco Unified TSP

Managing the Cisco Unified TSP


Note The upgraded TAPI client software does not work with previous releases of Cisco Unified Communications Manager.


Required Software

Cisco TSP requires the following software:

Cisco CallManager Version 4.0(1) or later on the Cisco CallManager server

Microsoft Internet Explorer Version 4.01 or later

Supported Windows Platforms

All Windows operating systems support Cisco TAPI. Depending on the type and version of your operating system, you may need to install a service pack.

Windows 2000

Windows 2000 includes TAPI 2.1.

Windows 2003

Windows XP

Windows XP includes TAPI 2.1.

Windows Vista


Note Check%SystemRoot%\system32 for these dynamically loaded library (.dll) files
and versions:
msvcrt.dll version: 6.00.8397.0
msvcp60.dll version: 6.00.8168.0
mfc42.dll version: 6.00.8447.0


Installing the Cisco Unified TSP

Install the Cisco Unified TSP software either directly from the Cisco Unified Communications Manager CD-ROM or from Cisco Unified Communications Manager Administration. For information on installing plug-ins from the Cisco Unified Communications Manager, see the Cisco Unified Communications Manager Administration Guide. The installation wizard varies depending on whether you have a previous version of Cisco Unified TSP installed.


Note If you are installing multiple TSPs, multiple copies of CiscoTSPXXX.tsp and CiscoTUISPXXX.dll files will exist in the same Windows system directory.


To install the Cisco Unified TSP from the Cisco Unified Communications Manager Administration CD-ROM, perform the following steps:

Procedure


Step 1 Insert the Cisco Unified Communications Manager CD-ROM.

Step 2 Double-click My Computer.

Step 3 Double-click the CD-ROM drive.

Step 4 Double-click the Installs folder.

Step 5 Double-click Cisco TSP.exe.

Step 6 Follow the online instructions.


Next Step

Install the Cisco Wave Driver if you plan to use first-party call control. Perform this step even if you are performing your own media termination. For more information, see the "Installing the Wave Driver" section.

Silent Installation

You can silently install, upgrade, or reinstall Cisco TSP. Use the following commands on the Windows command line:

Installation

CiscoTSP.exe /s /v"/qn"

Upgrade

CiscoTSP.exe /s /v"/qn"

Reinstallation

CiscoTSP.exe /s /v"/qn REINSTALL=\"ALL\" REBOOT=\"ReallySuppress\""

Activating the Cisco Unified TSP

You can install up to 10 TSPs on a computer. Use the following procedure to activate each of these TSPs. When you install a Cisco Unified TSP, you add it to the set of active TAPI service providers. The TSP displays as CiscoTSPXXX, where X ranges between 001 and 010. If a TSP has been removed or if some problem has occurred, you can manually add it to this set.

To manually add the Cisco Unified TSP to the list of telephony drivers, perform the following steps.

Procedure for Windows 2000 and Windows XP


Step 1 Open the Control Panel.

Step 2 Double-click Phone and Modem Options.

Step 3 On the Phone and Modem Options dialog box, click the Advanced tab.


Note If the Cisco Unified TSP is either not there or you removed it previously and want to add it now, you can do so from this window.


Step 4 Click Add.

Step 5 On the Add Provider dialog box, choose the appropriate TSP. Labels identify the TSPs in the Telephony providers window as CiscoTSPXXX, where XXX ranges between 001 and 010.

Step 6 Click Add.

The TSP that you chose displays in the provider list in the Phone and Modem Options window.

Step 7 Configure the Cisco Unified TSP as described in "Configuring the Cisco Unified TSP" or click Close to complete the setup.


Procedure for Windows NT, Windows 98, and Windows 95


Step 1 Open the Control Panel.

Step 2 Double-click Telephony.

Step 3 Click the Telephony Drivers tab.


Note If the Cisco Unified TSP is either not there or you removed it previously and want to add it now, you can do so from this window.


Step 4 Click Add.

Step 5 On the Add Provider dialog box, choose the appropriate TSP. Labels identify the TSPs in the Telephony providers window as CiscoTSPXXX, where XXX ranges between 001 and 010.

Step 6 Click Add.

The Provider list in the Telephony Drivers window now includes the CiscoTSPXXX range 001 - 010.

Step 7 Configure Cisco Unified TSP as described in "Configuring the Cisco Unified TSP" or click Close to complete the setup.


Configuring the Cisco Unified TSP

You configure the Cisco Unified TSP by setting parameters in the Cisco IP-PBX Service Provider configuration window. Perform the following steps to configure Cisco Unified TSP.

Procedure for Windows 2000 and Windows XP


Step 1 Open the Control Panel.

Step 2 Double-click Phone and Modem Options.

Step 3 Choose the Cisco Unified TSP that you want to configure.

Step 4 Click Configure.

The system displays the Cisco IP PBX Service Provider dialog box.

Step 5 Enter the appropriate settings as described in the "Cisco Unified TSP Configuration Settings" section.

Step 6 To save changes, click OK.


Note After the TSP is configured, you must restart the telephony service before an application can run and connect with its devices.



Procedure for Windows NT, Windows 98, and Windows 95


Step 1 Open the Control Panel.

Step 2 Double-click Telephony.

Step 3 Choose the Cisco Unified TSP that you want to configure.

Step 4 Click Configure.

The system displays the Cisco IP PBX Service Provider dialog box.

Step 5 Enter the appropriate settings as described in the "Cisco Unified TSP Configuration Settings" section.

Step 6 Click OK to save changes.


Note After configuring the TSP, you must restart the telephony service before an application can run and connect with its devices.



Cisco Unified TSP Configuration Settings

The following sections describe the tabs in the Cisco-IP PBX Service Provider dialog box:

General

User

CTI Manager

Wave

Trace

Advanced

Language

General

The General Tab displays TSP and TSPUI version information, as illustrated in Figure 4-1.

Figure 4-1 Cisco IP PBX Service Provider General Tab

Table 4-1 contains a list of the General tab fields that must be set and their descriptions.

Table 4-1 Auto Update Information Fields

Field
Description

Ask Before Update

Enables the user to control the auto update process. This check box is disabled by default.

Never AutoUpdate

Figure 4-1 shows the default value. Choosing this radio button does not perform an auto update even after an upgradeable plug-in version is detected on the Cisco Unified Communications Manager.

Always AutoUpdate

Choose this radio button to allow the Cisco TSP to auto update after it detects an upgradeable plug-in version on the Cisco Unified Communications Manager.

AutoUpdate on Incompatible QBEProtocolVersion

Choose this radio button to allow the Cisco TSP to auto update only when the local TSP version is incompatible with the Cisco Unified Communications Manager, and upgrading the TSP to the plug-in version represents the only choice to continue.


User

The User tab allows you to configure security information, as illustrated in Figure 4-2.

Figure 4-2 Cisco IP PBX Service Provider User Tab

Table 4-2 contains a list of the fields for the User tab that must be set and their descriptions.

Table 4-2 User Tab Configuration Fields 

Field
Description

User Name

Enter the user name of the user that you want to access devices. This TSP can access devices and lines that are associated with this user. Make sure that this user is also configured in the Cisco Unified Communications Manager, so TSP can connect.

The TSP configuration registry keys store the user name and password that you enter.

Note You can designate only one user name and password to be active at any time for a TSP.

Password

Enter the password that is associated with the user that you entered in the User Name field. The computer encrypts the password and stores it in the registry.

Verify Password

Reenter the user password.


CTI Manager

The CTI Manager tab allows you to configure primary and secondary CTI Manager information, as illustrated in Figure 4-3.

Figure 4-3 Cisco-IP PBX Service Provider CTI Manager Tab

Table 4-3 contains a list of the CTI Manager tab fields that must be set and their descriptions.

Table 4-3 CTI Manager Configuration Fields 

Field
Description

Primary CTI Manager Location

Use this field to specify the CTI Manager to which the TSP attempts to connect first.

If the TSP is on the same computer as the primary CTI Manager, choose the Local Host radio button.

If the primary CTI Manager is on a different computer, choose the IP Address radio button and enter the IP address of primary CTI Manager or choose the Host Name radio button and enter the host name of primary CTI Manager.

Backup CTI Manager Location

Use this field to specify the CTI Manager to which the TSP attempts to connect if a connection to the primary CTI Manager fails.

If the TSP is on the same computer as the backup CTI Manager, choose the Local Host radio button.

If the backup CTI Manager is on a different computer, choose the IP Address radio button and enter the IP address of backup CTI Manager or choose the Host Name radio button and enter the host name of backup CTI Manager.


Wave

The Wave tab allows you to configure settings for your wave devices, as illustrated in Figure 4-4.

Figure 4-4 Cisco IP PBX Service Provider Wave Tab

Table 4-4 contains a list of the Wave tab fields that must be set and their descriptions.

Table 4-4 Wave Tab Configuration Fields 

Field
Description

Automated Voice Calls

The number of Cisco wave devices that you are using determines the possible number of automated voice lines. (The default value is 5.) You can open as many CTI ports as the number of Cisco wave devices that are configured. For example, if you enter "5," you need to create five CTI port devices in Cisco Unified Communications Manager. If you change this number, you need to remove and then reinstall any Cisco wave devices that you installed.

You can only configure a maximum of 255 wave devices for all installed TSPs because Microsoft limits the number of wave devices per wave driver to 255.

When you configure 256 or more wave devices (including Cisco or other wave devices), Windows displays the following message when you access the Sounds and Multimedia control panel: "An Error occurred while Windows was working with the Control Panel file C:\Winnt\System32\MMSYS.CPL." TSP can still handle the installed Cisco wave devices as long as you have not configured more than 255 Cisco devices.

The current number of possible automated voice lines designates the maximum number of lines that can be simultaneously opened by using both LINEMEDIAMODE_AUTOMATEDVOICE and LINEMEDIAMODE_INTERACTIVEVOICE.

If you are not developing a third-party call control application, check the Enumerate only lines that support automated voice check box, so the Cisco Unified TSP detects only lines that are associated with a CTI port device.

Silence Detection

If you use silence detection, this check box notifies the wave driver of method to use to detect silence on lines that support automated voice calls that are using the Cisco Wave Driver. If the check box is checked (default), the wave driver searches for the absence of audio-stream RTP packets. Because all devices on the network suppress silence and stop sending packets, this method provides a very efficient way for the wave driver to detect silence.

However, if some phones or gateways do not perform silence suppression, the wave driver must analyze the content of the media stream and, at some threshold, declare that silence is in effect. This CPU-intensive method handles media streams from any type of device.

If some phones or gateways on your network do not perform silence suppression, you must specify the energy level at which the wave driver declares that silence is in effect. This value of the 16-bit linear energy level ranges from 0 to 32767, and the default value is 200. If all phones and gateways perform silence suppression, the system ignores this value.


Trace

The Trace tab allows you to configure various trace settings, as illustrated in Figure 4-5. Changes to trace parameters take effect immediately, even if TSP is running.

Figure 4-5 Cisco IP PBX Service Provider Trace Tab

Table 4-5 contains a list of the Trace tab fields that must be set and their descriptions.

Table 4-5 Trace Tab Configuration Fields 

Field
Description

On

This setting allows you to enable Global Cisco TSP trace.

Select the check box to enable Cisco TSP trace. When you enable trace, you can modify other trace parameters in the dialog box. The Cisco TSP trace depends on the values that you enter in these fields.

Clear the check box to disable Cisco TSP trace. When you disable trace, you cannot choose any trace parameters in the dialog box, and TSP ignores the values that are entered in these fields.

Max lines/file

Use this field to specify the maximum number of lines that the trace file can contain. The default value is 10,000. After the file contains the maximum number of lines, trace opens the next file and writes to that file.

No. of files

Use this field to specify the maximum number of trace files. The default value is 10. File numbering occurs in a rotating sequence starting at 0. The counter restarts at 0 after it reaches the maximum number of files minus one.

Directory

Use this field to specify the location in which trace files for all Cisco Unified TSPs are stored. Make sure that the specified directory exists.

The system creates a subdirectory for each Cisco Unified TSP. For example, the CiscoTSP001Log directory stores Cisco Unified TSP 1 log files. The system creates trace files with filename TSP001Debug000xxx.txt for each TSP in its respective subdirectory.

TSP Trace

This setting activates internal TSP tracing. When you activate TSP tracing, Cisco Unified TSP logs internal debug information that you can use for debugging purposes. You can choose one of the following levels:

Error—Logs only TSP errors.

Detailed—Logs all TSP details (such as log function calls in the order that they are called).

The system checks the TSP Trace check box and chooses the Error radio button by default.

CTI Trace

This setting traces messages that flow between Cisco Unified TSP and CTI. Cisco Unified TSP communicates with the CTI Manager. By default, the system leaves the check box unchecked.

TSPI Trace

This setting traces all messages and function calls between TAPI and Cisco Unified TSP. The system leaves this check box unchecked by default.

If you check the check box, TSP traces all the function calls that TAPI makes to Cisco Unified TSP with parameters and messages (events) from Cisco Unified TSP to TAPI.


Advanced

The Advanced tab allows you to configure timer settings, as illustrated in Figure 4-6.


Note These timer settings that are meant for advanced users only rarely change.


Figure 4-6 Cisco IP PBX Service Provider Advanced Tab

Table 4-6 contains a list of the Advanced tab fields that must be set and their descriptions.

Table 4-6 Advanced Configuration Fields 

Field
Description

Synchronous Message Timeout (secs)

Use this field to designate the time that the TSP waits to receive a response to a synchronous message. The value displays in seconds, and the default value is 15. Range goes from 5 to 60 seconds.

Requested Heartbeat Interval (secs)

Use this field to designate the interval at which the heartbeat messages are sent from TSP to detect whether the CTI Manager connection is still alive. TSP sends heartbeats when no traffic exists between the TSP and CTI Manager for 30 seconds or more. The default interval is 30 seconds. Range goes from 30 to 300 seconds.

Connect Retry Interval (secs)

Use this field to designate the interval between reconnection attempts after a CTI Manager connection failure. The default value is 30 seconds. Range goes from 15 to 300 seconds.

Provider Open Completed Timeout (secs)

Use this field to designate the time that Cisco Unified TSP waits for a Provider Open Completed Event, which indicates the CTI Manager is initialized and ready to serve TSP requests. Be aware that CTI initialization time is directly proportional to the number of devices that are configured in the system. The default value is 50 seconds. Range goes from 5 to 900 seconds.


Language

The Language tab allows you to choose one of the installed languages to view the configuration settings in that language, as illustrated in Figure 4-7.

Figure 4-7 Cisco IP PBX Service Provider Language Tab

Choose a language and click Change Language to reload the tabs with the text in that language.

Installing the Wave Driver

You can use the Cisco Wave Driver with Windows 2000 and Windows NT only. Windows 98 and Windows 95 do not support the Cisco Wave Driver.

You should install Cisco Wave Driver if you plan to use first-party call control. (Do this even if you are performing your own media termination.)


Caution Because of a restriction in Windows NT, the software may overwrite or remove existing wave drivers from the system when you install or remove the Cisco wave driver on a Windows NT system. The procedures in this section for installing and uninstalling the Cisco wave driver on Windows NT include instructions on how to prevent existing wave drivers from being overwritten or removed.

To install the Cisco Wave Driver, perform the following steps.

Procedure for Windows XP


Step 1 Open the Control Panel.

Step 2 Open Add/Remove Hardware.

Step 3 Click Next.

Step 4 Select Yes, I have already connected the hardware.

Step 5 Select Add a New Hardware Device.

Step 6 Click Next.

Step 7 Select Install the Hardware that I manually select from a list.

Step 8 Click Next.

Step 9 For the hardware type, choose Sound, video and game controller.

Step 10 Click Next.

Step 11 Click Have Disk.

Step 12 Click Browse and navigate to the Wave Drivers folder in the folder where the Cisco Unified TSP is installed.

Step 13 Choose OEMSETUP.INF and click Open.

Step 14 In the Install From Disk window, click OK.

Step 15 In the Select a Device Driver window, select the Cisco Unified TAPI Wave Driver and click Next.

Step 16 In the Start Hardware Installation window, click Next.

Step 17 If Prompted for Digital signature Not Found, click Continue Anyway.

Step 18 The installation may issue the following prompt:

The file avaudio32.dll on Windows NT Setup Disk #1 is needed,
Type the path where the file is located and then click ok.

If so, navigate to the same location where you chose OEMSETUP.INF, select avaudio32.dll, and click OK.

Step 19 Click Yes.

Step 20 Click Finish.

Step 21 To restart to restart the computer, click Yes.


Procedure for Windows 2000


Step 1 Open the Control Panel.

Step 2 Double-click Add/Remove Hardware.

Step 3 Click Next.

Step 4 Click Add/Troubleshoot a Device and click Next.

Step 5 Click Add a New Device and click Next.

Step 6 Click No, I want to select the hardware from a list.

Step 7 Choose Sound, video and game controllers and click Next.

Step 8 Click Have Disk.

Step 9 Click Browse and change to the Wave Drivers folder in the folder where the Cisco Unified TSP is installed.

Step 10 Choose OEMSETUP.INF and click Open.

Step 11 In the Install From Disk window, click OK.

Step 12 The Cisco Unified TAPI Wave Driver displays. Click Next.

Step 13 Click Next.

Step 14 The installation may issue the following prompt:

Digital Signature Not Found

Step 15 Click Yes.

Step 16 The installation may issue the following prompt:

The file avaudio32.dll on Windows NT Setup Disk #1 is needed,
Type the path where the file is located and then click ok.

If so, enter the same location as where you chose OEMSETUP.INF and click OK.

Step 17 Click Yes.

Step 18 Click Finish.

Step 19 To restart, click Yes.


Procedure for Windows NT


Step 1 Before you add the Cisco Wave Driver, you must save the wave driver information from the registry in a separate file as described in the "Saving Wave Driver Information" section.

Step 2 Open the Control Panel.

Step 3 Double-click Multimedia.

Step 4 Click Next.

Step 5 Click Add.

Step 6 Click Unlisted or Updated Driver.

Step 7 Click OK.

Step 8 Click Browse and change to the Wave Drivers folder in the folder where the Cisco Unified TSP is installed.

Step 9 Click OK. Follow the online instruction, but do not restart the system when prompted.

Step 10 Examine the contents of the registry to verify the new driver was installed and the old drivers still exist, as described in the "Verifying the Wave Driver Exists" section.

Step 11 Restart the computer.


Saving Wave Driver Information

Use the following steps to save wave driver information from the registry in a separate file. You must perform this procedure when installing or uninstalling the Cisco Wave Driver on a Windows NT computer.

Procedure


Step 1 Click Start > Run.

Step 2 In the text box, enter regedit.

Step 3 Click OK.

Step 4 Choose the Drivers32 key that is located in the following path:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\ CurrentVersion

Step 5 Choose Registry > Export Registry File.

Step 6 Enter a filename and choose the location to save.

Step 7 Click Save.

The file receives a .reg extension.


Verifying the Wave Driver Exists

When you install or uninstall the Cisco Wave Driver, you must verify whether it exists on your system. Use these steps to verify whether the wave driver exists.

Procedure


Step 1 Click Start > Run.

Step 2 In the text box, enter regedit.

Step 3 Click OK.

Step 4 Choose the Drivers32 key that is located in the following path:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\ CurrentVersion

Step 5 If you are installing the wave driver, make sure that the driver "avaudio32.dll" displays in the data column. If you are uninstalling the wave driver, make sure that the driver "avaudio32.dll" does not display in the data column. This designates the Cisco Wave Driver.

Step 6 Verify that the previously existing wave values appear in the data column for wave1, wave2, wave3, and so on. You can compare this registry list to the contents of the .reg file that you saved in the "Saving Wave Driver Information" procedure by opening the .reg file in a text editor and viewing it and the registry window side by side.

Step 7 If necessary, add the appropriate waveX string values for any missing wave values that should be installed on the system. For each missing wave value, choose Edit > New > String Value and enter a value name. Then, choose Edit > Modify, enter the value data, and click OK.

Step 8 Close the registry by choosing Registry > Exit.


Verifying the Cisco Unified TSP Installation

You can use the Microsoft Windows Phone Dialer Application to verify that the Cisco Unified TSP is operational. For Windows NT and Windows 2000, locate the dialer application in C:\Program Files\Windows NT\dialer.exe

For Windows 95 and Windows 98, locate the dialer application in C:\Windows\dialer.exe

Procedure For Windows 2000 and Windows XP


Step 1 Open the Dialer application by locating it in Windows Explorer and double-clicking it.

Step 2 Choose Edit > Options.

Step 3 Choose Phone as the Preferred Line for Calling.

Step 4 In the Line Used For area, choose one Cisco Line in the Phone Calls drop-down menu.

Step 5 Click OK.

Step 6 Click Dial.

Step 7 Enter a number to dial, choose Phone Call in the Dial as box, and then click Place Call.


Procedure for Windows NT, Windows 98, and Windows 95


Step 1 Open the Dialer application by locating it in Windows Explorer and double-clicking it:

A dialog box displays that requests the line and address that you want to use. If no lines are listed in the Line drop-down list box, a problem may exist between the Cisco Unified TSP and the Cisco Unified Communications Manager.

Step 2 Choose a line from the Line drop-down menu. Make sure Address is set to Address 0.

Step 3 Click OK.

Step 4 Enter a number to dial.


If the call is successful, you have verified that the Cisco Unified TSP is operational on the machine where the Cisco Unified TSP is installed.

If you encounter problems during this procedure, or if no lines appear in the line drop-down list on the dialer application, check the following items:

Make sure that the Cisco Unified TSP is configured properly.

Test the network link between the Cisco Unified TSP and the Cisco Unified Communications Manager by using the ping command to check connectivity.

Make sure that the Cisco Unified Communications Manager server is functioning.

Setting Up Client-Server Configuration

For information on setting up a client-server configuration (Remote TSP) in Windows 2000, refer to the Microsoft Windows Help feature. For information on client-server configuration in Windows NT, refer to Microsoft White Papers.

Uninstalling the Wave Driver

To remove the Cisco Wave Driver, perform the following steps.

Procedure for Windows XP


Step 1 Open the Control Panel.

Step 2 Select Sound and Audio Devices.

Step 3 Click the Hardware tab.

Step 4 Select Cisco TAPI Wave Driver.

Step 5 Click Properties.

Step 6 Click the Driver tab.

Step 7 Click Uninstall and OK to remove.

Step 8 If the Cisco TAPI Wave Driver entry is still displayed, close and open the window again to verify that it has been removed.

Step 9 Restart the computer.


Procedure for Windows 2000


Step 1 Open the Control Panel.

Step 2 Double-click Add/Remove Hardware.

Step 3 Click Next.

Step 4 Choose Uninstall/Unplug a device and click Next.

Step 5 Choose Uninstall a device and click Next.

Step 6 Choose Cisco TAPI Wave Driver and click Next.

Step 7 Choose Yes, I want to uninstall this device and click Next.

Step 8 Click Finish.

Step 9 Restart the computer.


Procedure for Windows NT


Step 1 Before you uninstall the Cisco Wave Driver, you must save the wave driver information from the registry in a separate file. For information on how to save the wave drive information to a separate file, see the "Saving Wave Driver Information" section.

Step 2 After the registry information is saved, open the Control Panel.

Step 3 Double-click Multimedia.

Step 4 Click the Devices tab.

Step 5 To view all the audio devices, click the `+' symbol next to Audio Devices.

Step 6 Click Audio for Cisco Sound System.

Step 7 Click Remove.

Step 8 Click Finish. Do not restart the system.

Step 9 Verify that the Cisco Wave Driver was removed and the old drivers still exist. For information on how to do this, see the "Verifying the Wave Driver Exists" section.


Note When you verify the removal of the driver, make sure that Cisco Wave Driver "avaudio32.dll" does not appear in the data column.


Step 10 Restart the computer.


Removing the Cisco Unified TSP

This process removes the Cisco Unified TSP from the provider list but does not uninstall the TSP. To make these changes, perform the following steps.

Procedure for Windows 2000


Step 1 Open the Control Panel.

Step 2 Double-click the Phone and Modem icon.

Step 3 Click the Advanced tab.

Step 4 Choose the Cisco Unified TSP that you want to remove.

Step 5 To delete the Cisco Unified TSP from the list, click Remove.


Procedure for Windows NT, Windows 98, and Windows 95


Step 1 Open the Control Panel.

Step 2 Double-click the Telephony icon.

Step 3 Click the Advanced tab.

Step 4 Choose the Cisco Unified TSP that you want to remove.

Step 5 To delete the Cisco Unified TSP from the list, click Remove.


Managing the Cisco Unified TSP

You can perform the following actions on all installed TSPs:

Reinstall the existing Cisco Unified TSP version.

Upgrade to the newer version of the Cisco Unified TSP.

Uninstall the Cisco Unified TSP.

You cannot change the number of installed Cisco Unified TSPs when you reinstall or upgrade the Cisco Unified TSPs.

Related Topics

Reinstalling the Cisco Unified TSP

Upgrading the Cisco Unified TSP

Auto Update for Cisco Unified TSP Upgrades

Uninstalling the Cisco Unified TSP

Reinstalling the Cisco Unified TSP

Use the following procedure to reinstall the Cisco Unified TSP on all supported platforms.

Procedure


Step 1 Open the Control Panel and double-click Add/Remove Programs.

Step 2 Choose Cisco Unified TSP and click Add/Remove.

The Cisco Unified TSP maintenance install dialog box displays.

Step 3 Click Reinstall TSP 4.1(X.X) radio button and click Next.

Step 4 Follow the online instructions.


Note If TSP files are already locked, the installation program prompts you to restart the computer.



Upgrading the Cisco Unified TSP

Use the following procedure to upgrade the Cisco Unified TSP on all supported platforms.

Procedure


Step 1 Choose the type of installation for Cisco Unified Communications Manager TSP 4.1(X.X).

Step 2 Choose Upgrade from TSP X.X(X.X) option radio button and click Next.

Step 3 Follow the online instructions.


Note If TSP files are already locked, the installation program prompts you to restart the computer.


Step 4 The Cisco TSP maintenance install dialog box displays.

If CiscoTSP.exe contains different version of Cisco Unified TSP than you have installed, the installation program displays one of the following prompts, depending upon the previous Cisco Unified TSP version:

Choose the type of installation for TSP Version 4.1(X.X).

If the previous installed version is Cisco Unified TSP 3.1(X.X), the following prompt displays:

Upgrade from TSP 3.1(X.X)

If the previous installed version is Cisco Unified TSP 3.2(X.X), the following prompt displays:

Upgrade from TSP 3.2(X.X)

If the previous installed version is Cisco Unified TSP 3.3(X.X), the following prompt displays:

Upgrade from 3.3(X.X)

If the previous installed version is Cisco Unified TSP 4.1(X.X), the following prompt displays:

Upgrade from TSP 4.1(X.X)


Auto Update for Cisco Unified TSP Upgrades

Cisco TSP supports auto update functionality, so you can download the latest plug-in and install it on the client machine. When the Cisco Unified Communications Manager is upgraded to a higher version, and Cisco TSP auto update functionality is enabled, this means that the latest compatible Cisco TSP is available, which is compatible with the upgraded Unified CM. This ensures that the applications work as expected with the new release (provided the new call manager interface is backward compatible with the TAPI interface). The Cisco TSP that is installed locally on the client server allows the application to set the auto update options as part of the Cisco TSP configuration. You can opt for updating the Cisco TSP in the following different ways.

Update Cisco TSP whenever a different (has to be higher version than existing one) version is available on the Cisco Unified Communications Manager server.

Update Cisco TSP whenever a QBE protocol version mismatch occurs between the existing Cisco TSP and the Cisco Unified Communications Manager version.

Do not update Cisco TSP by using the auto update functionality.

Auto Update Behavior

As part of initialization of Cisco TSP, when the application does lineInitializeEx, Cisco TSP queries the current TSP plug-in version information that is available on Cisco Unified Communications Manager server. After this information is available, Cisco TSP compares the installed Cisco TSP version with the plug-in version. If user chose an option for Auto Update, Cisco TSP triggers the update process. As part of Auto Update, Cisco TSP behaves in the following ways on different platforms.

Windows 95, Windows 98, Windows ME

Because Cisco TSP is in use and locked when the application does lineInitializeEx, the auto update process requests that you close all the running applications to install the new TSP version on the client setup. When all the running applications get closed, Cisco TSP auto update process can continue, and you will be informed about the upgrade success. If the running applications do not get closed and the installation continues, the new version of Cisco TSP will not get installed, and a corresponding error gets reported to the applications.

Windows NT

After Cisco TSP detects that an upgradeable version is available on the Cisco Unified Communications Manager server and Auto Update gets chosen, Cisco TSP reports 0 lines to the application and removes the Cisco TSP provider from the provider list. It will then try to stop the telephony service to avoid any locked files during Auto Update. If the telephony service can be stopped, Cisco TSP gets silently auto updated, and the service gets restarted. Applications must be reinitialized to start using Cisco TSP. If the telephony service could not be stopped, Cisco TSP installs the new version and displays a message to restart the system. You must restart the system to use the new Cisco TSP.

Windows 2000 or XP

After Cisco TSP detects that an upgradeable version is available on the Cisco Unified Communications Manager server and Auto Update option gets chosen, Cisco TSP reports 0 lines to the application and removes the Cisco TSP provider from the provider list. If a new TSP version is detected during the reconnect time, the running applications receive LINE_REMOVE on all the lines, which are already initialized and are in OutOfService state. Cisco TSP silently upgrades to the new version that was downloaded from the Cisco Unified Communications Manager and puts the Cisco TSP provider back on the provider list. All the running applications receive LINE_CREATE messages.

WinXP supports multiple user logon sessions (fast user switching); however, the system supports Auto Update only for the first logon user. If multiple active logon sessions exist, Cisco TSP only supports the Auto Update functionality for the first logged-on user.


Note If a user has multiple Cisco TSPs installed on the client machine, the system enables only the first Cisco TSP instance to set up the Auto Update configuration. All Cisco TSPs get upgraded to a common version upon version mismatch. From "Control Panel/Phone & Modem Options/Advanced/CiscoTSP001," the General window displays the options for Auto Update.


Because it is a CTI service parameter, which can be configured, you can change the plug-in location to a different machine than the Cisco Unified Communications Manager server. The default location is "//<CMServer>//ccmpluginsserver".

If Silent upgrade fails on any listed platforms for any reason (such as locked files that are encountered during upgrade on Win95/98/ME), the old Cisco TSP provider(s) do not get put back on the provider list to avoid any looping of the Auto Update process. Ensure that the update options get cleared and the providers get added to provider list manually. Update the Cisco TSP manually or by fixing the problem(s) that are encountered during Auto Update and reinitializing Cisco Unified TAPI to trigger the Auto Update process.


Note TSPAutoinstall.exe, which has user interface windows, can proceed to display these windows only when the telephony service enables the LocalSystem logon option with "Allow Service to interact with Desktop." If the logon option is not set as LocalSystem or logon option is LocalSystem but "Allow Service to interact with Desktop" is disabled, Cisco TSP cannot launch the AutoInstall UI windows and will not continue with AutoInstall.


Ensure that the following logon options are set for the telephony service.


Step 1 Logon as: LocalSystem.

Step 2 Enable the check box: "Allow Service to interact with Desktop."

These telephony service settings, when changed, require manual restart of the service to take effect.

Step 3 If, after changing the settings to the preceding values, the service does not restart, Cisco TSP checks for "Allow Service to interact with user" to be positive (as the configuration is updated for the service in the database), but AutoInstall UI cannot display. Cisco TSP continues to put the entry for TSPAutoInstall.exe under Registry key RUNONCE. This will help autoinstall to run when the machine reboots the next time.


Uninstalling the Cisco Unified TSP

Use the following procedure to uninstall the Cisco Unified TSP on all supported platforms.

Procedure


Step 1 Open the Control Panel and double-click Add/Remove Programs.

Step 2 Choose Cisco Unified TSP and click Add/Remove.

The Cisco Unified TSP maintenance install dialog box displays.

Step 3 Choose Uninstall: Remove the installed TSP radio button and click Next.

Step 4 Follow the online instructions.


Note If TSP files are already locked, the installation program prompts you to restart the computer.