Cisco Systems OL-5385-01 User Manual

CHA PT ER

Working with Users

BAT allows you to add users to Cisco CallManager and to associate users to phones and other IP Telephony devices, and BAT allows you to bulk-update and bulk-delete users.

This chapter describes working with users only. For information about working with user combinations, such as phones and users or CTI ports and users, see

Chapter 3, “Working with Phones, IP Telephony Devices, and User Combinations.”

Use the following sections to add users, update users, and delete users:

• Creating the CSV File for Users, page 4-2

• Adding Users to Cisco CallManager, page 4-8

• Creating the CSV File for Updating Users, page 4-12

• Updating Users to Cisco CallManager, page 4-18

• Deleting Users from Cisco CallManager, page 4-21

Adding Users

You can use BAT to add users to the Lightweight Directory Access Protocol (LDAP) Directory on a Cisco CallManager server in batches, rather than individually.

OL-5385-01

Bulk Administration Tool User Guide

4-1

Adding Users

Chapter 4 Working with Users

BAT can also associate CTI ports to existing users. This ability proves useful if you are adding users who will have applications that require a CTI port, such as Cisco IP SoftPhone. See Adding Phones and Other IP Telephony Devices,

page 3-2, for more information.

To add users to the Cisco CallManager database/LDAP Directory in bulk, you must perform these steps:

1. Create a comma separated values (CSV) file to define individual values for

each user or CTI port/user combination that you want to add. Cisco recommends that you create the CSV file by using the Excel file, BAT.xlt.

2. Use BAT to insert the CSV file to add the users to the Cisco CallManager

database.

Creating the CSV File for Users

To add users to Cisco CallManager, you must create a comma separated values (CSV) file. Three ways exist to create a CSV file. You can use the export utility to extract existing records from the directory into a CSV file. You can use the Microsoft Excel template called BAT.xlt or create the CSV by using the sample text file. Each CSV file type, such as phones, phones and users combined, and so on, provides a sample text file. However, If you are creating new records, Cisco recommends that you use the BAT.xlt template because the data is validated automatically when you export to CSV format.

The BAT.xlt file provides data file templates with macros to support multiple phone lines and error checking. It exports the values into a CSV files for phones, users, CTI ports, phone/user combinations, CTI port/user combinations, Cisco VG200 gateways, and FXS ports on Cisco Catalyst 6000 analog interface modules.

Bulk Administration Tool User Guide

4-2

OL-5385-01

Chapter 4 Working with Users

For instructions on creating the CSV file, see

• Creating a CSV File for Users Using BAT.xlt, page 4-3 (recommended

method)

• Creating a Text-Based CSV File for Users, page 4-5

Creating a CSV File for Users Using BAT.xlt

Follow this procedure to create the CSV file for bulk-adding users. BAT uses the information that you provide here to add the users to the Cisco CallManager database.

Procedure

Step 1 The BAT.xlt file resides on the publisher database server. However, you normally

would not have Microsoft Excel installed on the publisher database server. In that case, you must copy the file from the publisher database server and move it to the local machine, which must have Microsoft Excel installed.

Using a floppy disk or a mapped network drive, open the path C:\CiscoWebs\BAT\ExcelTemplate on the publisher database server and copy the file BAT.xlt to a local machine where Microsoft Excel is installed.

Step 2 Double-click BAT.xlt.

Step 3 When prompted, click the Enable Macros button.

Adding Users

OL-5385-01

Step 4 Click the Users tab at the bottom of the spreadsheet to add users.

Step 5 Complete all mandatory fields and any relevant optional fields. Each column

heading specifies the length of the field and whether it is required or optional.

Caution The system treats blank rows in the spreadsheet as “End of File” and

discards subsequent records.

In each row, provide the following information. If you have multiple devices, several fields will appear multiple times, once for each device.

• In the First Name field, enter the first name of the user to whom this phone

will be issued, up to 50 characters.

Bulk Administration Tool User Guide

4-3

Adding Users

Chapter 4 Working with Users

• In the Last Name field, enter the last name of the user to whom this phone

will be issued, up to 50 characters.

• In the User ID field, enter the user ID for the user to whom this phone will be

issued, from 1 to 30 characters.

• In the Password field, enter the password that the user needs to access the

Cisco IP Phone Configuration window, up to 20 characters.

Although it is considered optional in the CSV file, you must enter a password. You can specify the Password either on the CSV file or during file insertion in BAT. If you want to apply individual passwords for each user or groups of users, specify the password information in the CSV file. If you want to use a default password that all users can use, do not specify the password in the CSV and instead provide this information when you insert the CSV file in BAT.

• In the Manager field, enter manager user ID for the user to whom this phone

will be issued, up to 30 characters.

• In the Department field, enter the department number for the user to whom

this phone will be issued, up to 50 characters.

• In the PIN field, enter the personal identification number (PIN) to be used for

extension mobility, up to 20 numerals.

• Although considered optional in the CSV file, you must enter a PIN. You can

specify the PIN either on the CSV file or during file insertion in BAT. If you want to apply individual PINs for each user or groups of users, specify the PIN in the CSV file. If you want to use a default PIN that all users can use, do not specify the PIN in the CSV and instead provide this information when you insert the CSV file in BAT.

• In the User Device Profile field, enter the user device profile for this user and

device, up to 50 characters. This profile must exist in Cisco CallManager Administration for this record to be successfully inserted to the Cisco CallManager database. You can choose the user device profile from the BAT user interface.

• In the User Locale field, enter the language and country set that you want to

associate with this user. Your choice determines which cultural-dependent attributes exist for this user and which language displays in the Cisco CallManager user windows and phones.

4-4

• In the Controlled Device MAC Address field, enter the MAC address for the

phone that you want to associate with this user, 12 characters.

Bulk Administration Tool User Guide

OL-5385-01

Chapter 4 Working with Users

• In the Directory Number field, enter the directory number for the primary

• In the Controlled Device MAC Address2 field, enter the MAC address for any

Step 6 Click the Add More Devices button to enter additional MAC addresses that will

be associated to a new user.

Step 7 Click Export to BAT Format button to transfer the data from the BAT Excel

spreadsheet into a CSV file.

The system saves the file to C:\XLSDataFiles\ (or to your choice of another existing folder) as

users#timestamp.txt (or to your choice of filename)

where “timestamp” represents the precise date and time that the file was created.

Adding Users

Note Do not specify new phones, CTI ports, or phones that were added

using BAT with the “BAT” prefix (meaning, they have not been updated in the Cisco CallManager database with the MAC address yet) in this field.

extension (usually Line 1) for the phone, up to 50 numerals.

additional phone that you want to associate with this user, 12 characters.

Step 8 To be accessed by BAT, the CSV file must reside on the publisher database server.

However, you normally would not have Microsoft Excel running on the publisher database server. This step assumes that you have saved the CSV file to the local machine (not the publisher database server). In that case, you must copy the file to publisher database server.

Using a floppy disk or a mapped network drive, copy the CSV file from C:\XLSDataFiles\ to the C:\BATFiles\Users folder on the server that is running the publisher database for Cisco CallManager.

For information on how to read the exported CSV file, click the link to View Sample File in the Insert Users window in BAT (Configure > Users).

Creating a Text-Based CSV File for Users

If you do not use the BAT.xlt file for data input when adding users, you must create the comma separated values (CSV) file by using lines of ASCII text with values separated by commas.

OL-5385-01

Bulk Administration Tool User Guide

4-5

Adding Users

Chapter 4 Working with Users

If you created the CSV file by using the BAT.xlt file, you can skip the following procedures in this section.

Note If you use comma or double quotes as part of string in one of the fields, you must

enclose the entire text string with double quotes.

Tips Use BAT.xlt to input data because data validation is performed on that file.

The CSV file provides a common textual way of providing tabular information. You can create a data file by using any file format, such as Microsoft Notepad, Microsoft Word, and so on. Save the CSV file to C:\BATFiles\Users\Insert Users\ on the server that is running the publisher database for Cisco CallManager.

Use this procedure to create a CSV text file for users.

Procedure

4-6

Step 1 Open a text editor (such as Microsoft Notepad) or any application that allows you

to export or create a CSV file.

Step 2 Using a separate line for each user, enter the values for each user that you want to

add to Cisco CallManager. See Tips for Creating a Text-Based CSV File,

page 4-7, for detailed information about the formatting that you must use in the

text-based CSV file.

Caution Do not leave blank rows in the spreadsheet. BAT interprets a blank line

as the end of the file and discards any subsequent information.

You can associate any number of existing devices to a new user by entering the MAC address of all the devices separated by a comma at the end of the record.

You can associate a directory number to a user, even if that user does not control any device.

Step 3 Save the file C:\BATFiles\Users\Insert Users on the publisher server.

Bulk Administration Tool User Guide

OL-5385-01

Chapter 4 Working with Users

Note For BAT inserts, you cannot use CSV files for users that are saved

anywhere but C:\BATFiles\Users\Insert Users\ on the server that is running the publisher database for Cisco CallManager.

Tips for Creating a Text-Based CSV File

The following example format shows the field length and string types followed by an example of a CSV file for users.

First Name(Mandatory, 1 to 50 characters),Last Name(Mandatory, 1 to 50 characters),User ID(Mandatory, up to 30 characters),Password(Optional, up to 20 characters),Manager(Optional, up to 30 characters),Department(Optional, up to 50 characters),PIN(Optional, up to 20 numerals),User Device Profile(Optional, up to 50 characters),User Locale(Optional, up to 50 characters),Controlled Device MAC Address1(optional, 12 characters),Directory Number (Optional, (Optional, up to 24 numerals and special characters)),Controlled Device MAC Address2(Optional, 12 characters)

Adding Users

OL-5385-01

Tip You must specify PIN and Password values, either on the CSV file or during file

insertion in BAT. If you want to apply individual PINs or passwords for each user or groups of users, specify the PIN and password information in the CSV file. If you want to use a default PIN and password that all users can use, do not specify PIN or password values in the CSV and instead provide this information when you insert the CSV file in BAT.

Note You cannot enter values for MAC Address2 without entering values for MAC

Address1.

Example

John,Smith,johns,abc123de,karend,0012055,9989,johns profile,English United States,1231123245AB,1231123245AB,9725557154,0010EB001234

You must specify delimiters even if a field is blank. Refer to the following examples and sample CSV records when you are creating CSV files.

Bulk Administration Tool User Guide

4-7

+ 15 hidden pages