Guest

Cisco Unified Communications Manager (CallManager)

Associate Existing Users to IP Phones with BAT

Document ID: 110967

Updated: Oct 13, 2011

   Print

Introduction

The Bulk Administration Tool (BAT) is mainly used to insert users, phones, gateways, Forced Authorization Code (FAC), Client Matter Code (CMC), and others, but it can also be used to update devices, users, phones, etc. BAT is usually used to bulk import certain devices, such as phones and users, especially during big phone deployments.

Prerequisites

Requirements

Cisco recommends that you have knowledge of these topics:

  • How to insert phones with Bulk Administration Tool

  • Cisco CallManager Administration

Components Used

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

  • Cisco CallManager 5.x and later

  • Bulk Administration Tool

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.

Conventions

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

Associate User to the Phones.csv File

You can modify the owner user ID in the CSV data file in order to associate existing users to the existing IP phones in the Cisco Unified CallManager database. Complete these steps:

  1. From Cisco Unified CallManager Administration main page, choose Bulk Administration > Phones > Export Phones > All Details.

    bat-01.gif

    The Export Phone Configuration window appears.

  2. In the Export Phone Configuration window, complete these steps:

    1. Choose the All Phone Types option in the Select the Device Type drop-down list.

    2. Enter the name of the file to be exported in the File Name text box and a job description in the Job Information area.

    3. Click the Run Immediately radio button in order to export phone records.

    4. Click Submit in order to create a job to export phone records.

    bat-02.gif

  3. Use the Job Scheduler option in the Bulk Administration main menu to activate this job.

  4. You can now search and download the exported file with the Upload/Download Files option in the Bulk Administration menu.

  5. Open the downloaded phones.csv file with Microsoft Excel.

  6. Modify the Owner User ID column with the user that you want to associate to that particular IP phone.

  7. Choose the Upload/Download Files option in the Bulk Administration menu.

  8. Click the Add New button, which opens the File Upload Configuration window.

  9. In the File Upload Configuration window, complete these steps:

    1. Browse to the phones.csv file that you updated.

    2. Choose Phones as the Target and Insert Phones - All Details as the Transaction Type from the drop down menu.

    3. Choose the Overwrite File if it exists option, and click the Save button.

    bat-03.gif

  10. Now, choose Bulk Administration > Phones > Insert Phones. The Insert Phone Configuration window appears.

  11. In the Insert Phone Configuration window, complete these steps:

    1. Click the Insert Phones All Details radio button for the Insert Phone section.

    2. Choose the File Name from the drop down menu.

    3. Choose the Override the existing Configuration option, and click Submit.

    4. Click the Run Immediately radio button to update the user records immediately.

    bat-04.gif

  12. You can now use the Job Scheduler option in the Bulk Administration main menu in order to verify the status.

Associate the Phone to the users.csv File

Update Users in Cisco CallManager

In order to export the CSV data file and update CONTROLLED DEVICES of existing users, complete these steps:

  1. From Cisco Unified Call Manager Administration main page, choose Bulk Administration > Users > Export Users.

    The Export Users Query window displays.

    bat-05.gif

  2. Click Find but do not enter any search text in order to find all the users that are registered in the database.

  3. Click Next.

  4. Configure these settings in the Export Users Configuration window:

    • In the File Name text box, enter users as the file name.

    • Choose All User Format from the File Format drop-down list.

    • In the Job Information area, enter Export Users as the job description.

    • Click the Run Immediately radio button to export user records immediately

    • Click Submit in order to create a job to export user records.

    bat-06.gif

  5. Use the Job Scheduler option in the Bulk Administration main menu in order to activate this job.

  6. You can now search and download the exported file with the Upload/Download Files option in the Bulk Administration menu.

  7. Open the downloaded users.csv file with Microsoft Excel. The exported users.csv file has these columns:

    FIRST NAME,MIDDLE NAME,LAST NAME,USER ID,PASSWORD,MANAGER USER ID,DEPARTMENT,PIN,DEFAULT PROFILE,USER LOCALE,TELEPHONE NUMBER,PRIMARY EXTENSION,ASSOCIATED PC,IPCC EXTENSION,MAIL ID,PRESENCE GROUP,SUBSCRIBE CALLING SEARCH SPACE,ALLOW CONTROL OF DEVICE FROM CTI,DIGEST CREDENTIALS,USER GROUP,CONTROLLED PROFILE,CONTROLLED DEVICE,PASSWORD LOCKED BY ADMIN,PASSWORD CANT CHANGE,PASSWORD MUST CHANGE AT NEXT LOGIN,PASSWORD DOES NOT EXPIRE,PASSWORD AUTHENTICATION RULE,PIN LOCKED BY ADMIN,PIN CANT CHANGE,PIN MUST CHANGE AT NEXT LOGIN,PIN DOES NOT EXPIRE,PIN AUTHENTICATION RULE,ENABLE MOBILITY,ENABLE MOBILE VOICE ACCESS,REMOTE DESTINATION LIMIT,MAXIMUM WAIT TIME FOR DESK PICKUP,PASSWORD IMSINFO,PIN IMSINFO,USER PKID
  8. Modify the CONTROLLED DEVICE column, and add the phone that must be related to the user.

    Note: When you update user records, you can keep values or settings for a user that were previously stored in the Cisco CallManager directory. You can use a symbol such as “#” for fields where the value must be retained. In the example users.csv file, under the DIGEST CREDENTIALS, PIN, PASSWORD use the # sign, which tells BAT to keep these fields the same as entered in the DC directory.

  9. Choose Bulk Administrator > Users > Update Users. The User Update Configuration window displays.

  10. In the User Update Configuration window, complete these steps:

    1. From the File Name drop-down list, choose the users.csv file.

    2. From the User Template Name drop-down list, choose the Bat-user template you created for this bulk transaction.

    3. In the Value for fields to be ignored box, enter the # symbol. This symbol is used to retain the values stored in the DC directory.

    4. In the Job Information area, enter the job description.

    5. Click the Run Immediately radio button to update the user records immediately.

      bat-07.gif

    6. Click Submit in order to create a job to update the user records.

  11. You can now use the Job Scheduler option in the Bulk Administration main menu in order to verify the status.

Associate Users with Line Appearance with BAT

Complete these steps in order to associate users with the line with BAT:

  1. Open the Cisco Unified Communications Manager Administration page.

  2. Choose BAT > Users > Line Appearance > Export line appearance.

  3. Select any user and export the file.

    The file is available for download from BAT > upload/download files.

  4. Download the file.

    This file has four fields:

    1. User ID

    2. Device

    3. Directory Number

    4. Partition

  5. Add the user ID, device (mac address of the phone), directory number (line DN), and partition. Save the file.

  6. Upload this file to Cisco Unified Communications Manager from BAT > upload/download files > Add New.

  7. Browse and select this file.

  8. Choose User Line appearance as the Target, and choose Transaction Type > Update line appearance > Custom file.

  9. Click Save.

  10. Choose BAT > Users > Line Appearance > Update line appearance.

  11. For the file name, select the .txt file, choose Run Immediately/Run Later, and click Save.

Update an Existing End User

Complete these steps in order to update the user for associating with an IP phone:

  1. Open the Cisco Unified Communications Manager Administration page.

  2. Navigate to Bulk Administration > upload/download files.

  3. Click the check box near bat.xlt, then click Download Selected.

  4. Open the bat.xlt file using Microsoft Excel by enabling the macros.

  5. Navigate to the Update Users tab below.

  6. Enter the user id of the users you want to associate with the end device.

  7. Scroll all the way to the right side of the Excel sheet and enter 1 in the text box next to Number of Controlled Devices.

  8. You should see a column get added (Controlled Device 1).

  9. Enter the SEP<MAC> in that column based on the order of user ID in the first column to which MAC address the user will be associated.

  10. Click Export to BAT Format and save the file.

  11. Open the Cisco Unified Communications Manager Administration page.

  12. Navigate to Bulk Administration > upload/download files.

  13. Click Add New.

  14. Click Browse and select the file you saved from step 10.

  15. Select the Target as Users.

  16. Select the Transaction Type as Update Users.

  17. Choose the Overwrite File if it exists option, then click Save.

  18. Navigate to Bulk Administration > Users > Update users.

  19. Select the file you uploaded from step 14 and the user template that you have been using.

  20. Click Run Immediately in order to export user records immediately.

  21. Click Submit in order to create a job to export user records.

  22. Use the Job Scheduler option in the Bulk Administration main menu in order to activate this job.

  23. Navigate to Bulk administration > job status > check to see if the job was successful.

  24. Check the user page to make sure the device got associated.

Note: Here is a link to a video on the Cisco Support Community leavingcisco.com that explains the procedure to associate an existing user with an existing IP phone:

Note:  Associate Existing End Users to IP Phones with BAT leavingcisco.com

bat-08.gif

Related Information

Updated: Oct 13, 2011
Document ID: 110967