Cisco Unified Communications Manager (CallManager)

Device Configuration with TAPS and BAT in Cisco CallManager Administration

Document ID: 46472

Updated: May 04, 2007



The Tool for Auto-Registered Phones Support (TAPS) works in conjunction with the Bulk Administration Tool (BAT). After the BAT is used to bulk add phones with dummy MAC addresses to Cisco CallManager Administration, you can plug the phones into the network. The administrator or the phones’ users can then dial a TAPS directory number that causes the phone to download its configuration. At the same time, the phone gets updated in the Cisco CallManager database with the correct MAC address of the phone. For the TAPS to function, you must make sure that Auto-registration is enabled in Cisco CallManager Administration (select System > Cisco CallManager). This document specifically refers to the installation and configuration of the TAPS. Refer to Configuring the Bulk Administration Tool (BAT) if you are not familiar with the BAT.



This document assumes that the administrator is familiar with the BAT and that Auto-registration is enabled on the Cisco CallManager. The administrator should also be familiar with Cisco Customer Response Application (CRA) or Cisco Extended Services configuration.

Components Used

The information in this document is based on these software versions:

  • Cisco CallManager 3.3(x)

  • Cisco CallManager Extended Services 3.1(x)

  • Cisco Customer Response Application 3.x

Note: These specifications apply to BAT Release 5.1(x):

  • BAT Release 5.1(x) is compatible with Cisco CallManager Release 4.1(1) and Customer Response Solutions (CRS) Version 3.5(2) for use with TAPS.

  • BAT Release 5.1(4) implements Secure HyperText Transfer Protocol (HTTPS) for BAT/TAPS pages to ensure that the configuration changes that are made through them are secure. The BAT installation process sets the security setting on the BAT virtual directory.

    Refer to the Bulk Administration Tool User Guide, Release 5.1(4) for more information about BAT 5.1(x).

The information in this document was created from the devices in a specific lab environment. All of the devices used in this document started with a cleared (default) configuration. If your network is live, make sure that you understand the potential impact of any command.


Refer to Cisco Technical Tips Conventions for more information on document conventions.

TAPS Configuration and Use

The TAPS is configured by adding a computer telephony integration (CTI) route point, CTI ports, and users in Cisco CallManager Administration. The CRA and the BAT are applications used in conjunction with the TAPS. Refer to the Bulk Administration Tool Guide for Cisco CallManager.

You need only one CTI route point for the TAPS. You also need at least one CTI port, but you can configure as many CTI ports you would like to make available for users of the TAPS.

Complete these steps to configure the TAPS in Cisco CallManager Administration:

Note: The configuration of TAPS is simplified in these steps. Make sure that you understand how to properly configure Partitions and Calling Search Space, so that phones that auto-register are not able to call unwanted telephone numbers (for example, 900 numbers, International Calls, and so forth).

  1. Configure Auto-registration.

    1. Select Server > CiscoCallManager from CallManager Administration.

    2. Uncheck Auto-registration Disabled on this Cisco CallManager to enable auto-registration.

    3. Set the Starting Directory Number and Ending Directory Number to a range that does not conflict with your current dialing plan.


  2. Create a CTI route point and assign a unique directory number to it.

    1. From CallManager Administration, click Device > CTI Route Point.

    2. Click Add a New CTI Route Point.

    3. Set the Device Name to a value that is unique to the application for which you are creating the route point.

    4. Click Insert to add the route point.


    You are asked to create a Directory Number for the newly inserted route point.

  3. Set Forward Busy, Forward No Answer, and Forward On Failure to Operator in the Call Forward and Pickup Settings area.


  4. Create one or more CTI ports with consecutive directory numbers.

    Note: The CTI Ports are associated to the TAPS Route Point. For Extended Services, only four ports are available for configuration. Earlier versions of Cisco CallManager required sequential directory numbers. In the current versions, the directory numbers do not need to be consecutive. In the examples in this document, consecutive numbers are used, which is the recommended configuration.

    1. Select Device > Phones from Cisco CallManager Administration.

    2. Click Add a New Phone.


    3. Set the Phone type drop-down box to CTIPort and click Next.


      The Phone Configuration page appears.

    4. Configure the device as you would any other type of phone.

    5. Click Insert to add the phone to the database.


    6. Enter a unique Directory Number for the CTI port and click Insert.


    7. Set Call Forward Busy, Call Forward No Answer, and Forward on Failure to the next sequential directory number, depending upon how many CTI ports are created.

    8. Click Update to complete the changes.


  5. Create a user using Cisco CallManager Administration and associate this user with the CTI route point and CTI ports.

    Note: If Certificate Request Syntax (CRS) has not already been set up for other applications (such as IP-Auto Attendant) create a user that CRS/ES can use to control the Route Points and CTI Ports. If CRS/ES has already been set up with CallManager, you can skip this step: the same user is administered in CRS to control all “ports.” If this user has not already set up CRS/ES ports, then—because this user is not specific to the TAPS application—this user should create a user with a more generic name, such as “crsjtapi” or the like.

    1. Select User > Add a New User from CallManager Administration.

      The user that needs to be added is the TAPS user. The user should reflect the name of the application that you intend to use.

      In this case, a user ID of tapsuser is created.

    2. Click Insert to add the user.

    3. Check the Enable CTI Application Use checkbox for this user.


    4. Click Device Association.

      This allows you to select devices that need to be associated to the TAPS user.


    5. Enter CTI and click Select Devices to list all the CTI route ports and the CTI route point that will be used for the TAPS application.


    6. Check all of the CTI ports and the CTI route point.


    7. Change the radio button under Ext by selecting the Route Point Extension.


    8. Click Update Selected.

      You will be redirected to the User Configuration page. Notice the Controlled Devices: all CTI devices should now be associated with the tapsuser.


  6. Install Cisco CallManager Extended Services or CRA and reboot.

    This document describes installing Cisco CallManager Extended Services 3.1(x).

    1. Download and launch the Cisco CallManager Extended Services installer (registered customers only) .


    2. Enter the Administrator password that you use to log in to the Cisco CallManager Server.


    3. Click Yes to continue with the installation.

    4. Click Next on the Ready to Install Cisco Extended Services dialog box.

    5. Enter, twice, the SA password that was used during the Cisco CallManager installation and click OK.


    6. Click OK on the confirmation message box.

    7. Click Yes to reboot the server.

  7. Install the BAT plugin on the Cisco CallManager Publisher.

    Note: Make sure that you select Yes to install the TAPS, when prompted.

    1. Select Application > Install Plugins from Cisco CallManager Administration.

    2. Click the Cisco Bulk Administration Tool icon.


    3. When prompted, click Open to begin installing the BulkAdministrationTool.


    4. Click Yes to install the TAPS.


    5. Click Next on the welcome dialog box.

    6. Click OK on the message box that appears.


    7. Click Finish to complete the installation of the BAT with the TAPS on the Cisco CallManager Publisher.

  8. Download the TAPS plugin to the Cisco CallManager Publisher or CRA server, save it to disk, and run it.

    1. Select Application > Install Plugins from Cisco CallManager Administration.

    2. Click the TAPS icon.

    3. On the File Download dialog box, click Open to start the TAPS installer.


    4. Enter the IP address of the Cisco CallManager Publisher and click Next to complete the installation of the TAPS Support Setup.


  9. Complete the TAPS configuration.

    1. Select Start > Programs > Cisco CallManager 3.3 > Bulk Admin Tool > Configure TAPS.

    2. Click the Allow Auto-Registered phones to be reset with a profile that has 'BAT' prefix in the device name radio button and click Set.


    3. Click Yes on the confirmation dialog box.

    4. Click OK to complete the configuration on the message box that appears.

  10. Log in to CRA Administration at http://IP_address/Appadmin, where IP_address is the IP address of the Cisco CallManager or Apps server.

    1. Click Setup.


    2. Enter Administrator for the User Identification, with the Password ciscocisco, and click Log On.

      Note: The log in entries are case sensitive.


  11. When you log in to CRA Administration for the first time, you are prompted to configure the Directory Setup.

    1. Create a Profile Name for the TAPS.

      Click Edit to bring up the Explorer User Prompt dialog box, enter a Profile Name, and click OK.


    2. Select the Profile Name that you created in step 11a and click Next.


    3. Click the Use the default Repository profile radio button and click Next.


    4. Complete the fields in the next window as detailed here.

      Note: This configuration represents using DC Directory for LDAP services.

      Directory Host Name—The IP address of the Cisco CallManager Publisher.

      Directory Password—The DC Directory password entered during the Cisco CallManager installation.


  12. Select the users that you want to be able to log into CRA Administration.

    During the initial configuration, you are prompted to select a user that you would like to be able to access TAPS.

    This document uses the tapsuser that was created earlier in this procedure.

    1. Highlight the user and then click the Left Arrow button to move that user over to the CRA Administrator / Supervisor box.


    2. Select Administrator in the drop down box and click Finish.


      You are notified that the setup is complete and the Directory Setup page appears.


    3. Close the web browser and then log back into AppAdmin using the tapsuser ID and password.

      Access the AppAdmin page at http://ip-address/AppAdmin, where ip-address is the CallManager or Apps server.

  13. Configure the TAPS application.

    1. Select Applications > Configure Applications on the CRA Administration menu.

    2. Click Add a New Application.


    3. Set Application Type to Cisco Script Application and click Next.


    4. Complete the fields in the next window as detailed here.

      Name—Enter a name for the new application. (In this example, Taps_App is used.)

      ID field—Leave the default value of 0. (If you have multiple applications, then this number is incremented by 1 for each new application.)

      Maximum Number of Sessions—Enter the number of sessions you would like to have for the TAPS application. (This value is the number of simultaneous calls allowed at one time, which is equivalent to the number of CTI ports that you created for the use of TAPS.)

      Script—Select the TAPS.aef script.

      Note: For IPCC version 4.0(x) and later, TAPS installs the TAPS AAR.aar file on the server, and not the TAPS.aef file. After you install TAPS, go to the AAR Management page in CRS Administration to upload the .aar file. After the upload, TAPS.aef is copied and a new application called TAPS is created. Then, the TAPS.aef file has to be selected in the TAPS application. In other words, TAPS.aef is a part of the .aar file now.


    5. Click Add.

      Note: If the TAPS prompt does not use the same codec as in the CallManager prompt, you might get dead air while the CTI route point is called. As a solution to this problem, the Music on Hold (MoH) Audio Translator that runs in Cisco CallManager can be used to convert the TAPS .wav file into the required audio file supported by the codec.

      Note: The Cisco MoH Audio Translator service converts audio source files into various coder-decoders so that the MoH feature can use them. Cisco CallManager automatically installs this service when you install the Cisco IP Voice Media Streaming application. The MoH Audio Translator service automatically translates audio files that you place in the input directory. The installation program creates the directory C:\Cisco\DropMOHAudioSourceFilesHere during installation. After the MoH Audio Translator adds an audio file in the input directory, this file is converted to five .wav files and an XML file. The files go in the directory C:\ProgramFiles\Cisco\TFTPPath\MOH.

  14. Configure the Cisco Media Termination Dialog Group.

    The Cisco Media Subsystem is a subsystem of the CRA Engine which monitors the media termination. This media resource collects the Dual Tone Multi-Frequency (DTMF) input from callers.

    1. Select Subsystems > Cisco Media on the CRA Administration menu.

    2. Click Add a New CMT Dialog Control Group.


    3. Complete the fields in the next window as detailed here.

      Group ID—Leave the default value of 0. (If you have multiple applications, then this number is incremented by 1 for each new application.)

      Number of Licensed IVR Ports—Enter the number of CTI ports (created earlier) that you want handling calls for the TAPS application.


    4. Click Add.

    5. Confirm that the new CMT dialog control group has been created.


  15. Configure the JTAPI subsystem.

    1. Select Subsystems > JTAPI on the CRA Administration menu.

    2. Complete the fields in the next window as detailed here.

      JTAPI Provider(s)—Enter the IP address of the Cisco CallManager Publisher.

      User ID—Enter the TAPS user that you created earlier.

      Password—Enter the password that you associated with the TAPS user.


    3. Click Update.

    4. Click OK.

  16. Create CTI Port Groups to associate the CTI ports to the JTAPI subsystem.

    1. Click CTI Port Groups in CRA Administration.

    2. Click Add a New JTAPI Call Control Group.


    3. Complete the fields in the next window as detailed here.

      Group ID—Leave the default value of 0. (If you have multiple applications, then this number is incremented by 1 for each new application.)

      Description—Modify this field to reflect the TAPS JTAPI Group.


    4. Click Associate CTI Ports.

    5. Check the checkboxes for the CTI ports that were previously configured in Cisco CallManager for the TAPS application.


    6. In the Calling Search Space for Redirect drop-down list, select Redirecting Party.

      Redirecting Party indicates that the redirect uses the search space of the address of the redirect controller (in other words, the calling search space [CSS] assigned to the CTI port).


    7. Click Add.

  17. Configure a JTAPI Trigger.

    1. Click JTAPI Triggers in CRA Administration.

    2. Click Add a New JTAPI Trigger.


    3. Complete the fields in the next window, as detailed here, to associate the CTI Route Point that was created in Cisco CallManager.

      CTI Route Point Directory Number—Select the Route Point that you configured in Cisco CallManager for use with TAPS.

      Application Name—Select the Taps_App that was created for the TAPS Application.

      Maximum Number Of sessions—Enter 4.

      Call Control Group—Select the TAPS JTAPI Group that was created for this application.

      Primary Dialog Group—Select the TAPS Media Group that was created for this application.

      Secondary Dialog Group—Select the same TAPS Media Group that you did for Primary Dialog Group.


    4. Click Add.

  18. Confirm that the Engine for the Apps server is running.

    1. Select System > Engine on the CRA Administration menu.

    2. Check that the Status for the Engine System is Running.

  19. Install Cisco JTAPI.

    1. Log in to Cisco CallManager.

    2. Select Application > Install Plugins on the Cisco CallManager Administration menu.

    3. Click the Cisco JTAPI icon.

      This client needs to be installed on any server that accesses Cisco CallManager through JTAPI.


    4. Click Open to run the CiscoJTAPIClient.exe installer.


    5. Click Finish to complete the installation.

  20. Confirm that the CRA Engine and Subsystems are running.

    1. Log in to CRA Administration again and choose Applications > Refresh Applications.

    2. Check that the Status for the Engine System is Running and that the Status for all the Subsystems is IN_SERVICE.

  21. Confirm that the Cisco TAPS service is running.

    1. Select Start > Programs > Administrative Tools > Services.

    2. Right-click the Cisco TAPS service and choose Start.


At this time, the Cisco TAPS service should start. If it does not, refer Cisco bug ID CSCeb20345 (registered customers only) and perform the steps in the Workaround section.

Refer to Working with TAPS and Configuring TAPS and Troubleshooting BAT and TAPS for more information regarding the BAT and the TAPS.

Related Information

Updated: May 04, 2007
Document ID: 46472