Table Of Contents
Configuring the Bulk Administration Tool (BAT) Release 3.0(2)
New and Changed Information in Release 3.0(2)
Using BAT.xls to Create CSV Files
Creating the CSV File for Phones
Using the Phone Tab in BAT.xls
Creating an Optional Phones CSV Text File
Adding Phones to Cisco CallManager
Creating the CSV File for Users
Creating an Optional Users CSV Text File
Adding Users to Cisco CallManager
Adding Phone and User Combinations
Creating the CSV File for Phone and User Combinations
Using the Phone-User Tab in BAT.xls
CSV String Formats for Phone and User Combinations
Creating an Optional Phones-Users CSV Text File
Adding Phone and User Combinations to Cisco CallManager
Viewing Insert Phones/Users Results
Configuring the Bulk Administration Tool (BAT) Release 3.0(2)
This document describes the Bulk Administration Tool (BAT) for Release 3.0(2) and includes the following sections:
•
New and Changed Information in Release 3.0(2)
•
BAT Overview
The Bulk Administration Tool (BAT) is a plug-in application to the Cisco CallManager. BAT enables you to add up to 10,000 phones and users to the Cisco CallManager application. Using BAT, you can also perform bulk modifications to phones and delete several phones at one time.
This document provides you with information about using the BAT application.
Audience
This document is written for network administrators and engineers responsible for managing the Cisco CallManager system. A knowledge of telephony and IP networking technology is required.
Related Documents
Refer to the following documents for more information on Cisco CallManager and related applications:
•
•
BAT Specifications
The following specifications apply to BAT Release 3.0(2):
•
•
•
•
•
New and Changed Information in Release 3.0(2)
BAT Release 3.0(2) for Cisco CallManager 3.0(2) includes the following additions from the BAT 3.07 EFT load:
•
–
–
–
–
•
•
•
•
Start > Programs > Cisco CallManager 3.0 > Bulk Admin Tool > Stop BAT
User Interface
BAT is accessible through Cisco CallManager Administration using Internet Explorer 4.01 Service Pack 2 or later, or Netscape 4.5. The look and feel of BAT is similar to the Cisco CallManager Administration window.
From the BAT Application menu, you can go to the Cisco CallManager Administration window.
Launching BAT
Procedure
Step 1
The Cisco CallManager Administration main window displays.
Step 2
The Cisco CallManager Bulk Administration Tool window displays.
Obtaining Online Help
You can access the BAT online Help system from any of the BAT pages by selecting:
Help > Contents and Index
Using BAT
As shown in Figure 1, BAT has three main menu options:
•
–
–
–
–
•
•
–
–
Figure 1 BAT Window and Menu Options
From the BAT window, the administrator can add, update, and delete devices, add users, and view online documentation.
Caution
BAT provides statistical data on the time it takes to complete a bulk transaction. The statistics are approximations for a standard recommended configuration.
Creating CSV Files
The Comma Separated Values (CSV) file is a common textual way of providing tabular information. You can create a data file using any file format, such as Microsoft Notepad, Microsoft Windows, and so on. Save the CSV file anywhere on the network.
It is recommended that you use the BAT.xls file to create CSV files because data validation is performed on the file.
Using BAT.xls to Create CSV Files
BAT includes a Microsoft Excel file (BAT.xls) that provides data files templates with macros, support for multiple phone lines, and exports the values into CSV files for phones, users, and phone/user combinations.
Complete the required fields, specify the number of lines to export (when adding phones), and click Export to BAT Format to export the BAT Excel spreadsheet to a text file, which is a Comma Separated Values (CSV) file.
The file is saved in C:\XLSDataFiles (or your choice of another existing folder) as:
phones#timestamp.txt
From the BAT user interfaces, click View Sample File for the data value requirements when adding:
•
•
•
Click View File to view the CSV file that you created.
Related Topics
•
•
•
Caveats
The following caveats apply to BAT CSV files for Release 3.0(2):
•
•
•
•
•
•
•
•
•
Adding Phones
You can use BAT to add hardware-based Cisco IP Phones to the Cisco CallManager database in batches, rather than adding each phone individually.
To add phones to Cisco CallManager, you must:
•
•
Related Topics
•
•
Creating a Phone Template
The phone template and Comma Separated Values (CSV) files work together in bulk transactions. Based on the type of phone you want to add in batch, you can create a template that has the common features for all the phones in a batch, such as the Model, Device Pool, and so on. These templates are stored and are reusable for other phone batches. For example, you can configure a template for the Cisco IP Phone 7960 with only two lines configured and another with four lines configured.
The CSV file stores the details for all the phones that are individual to that phone, such as its Name, Description, and so on. See "Creating the CSV File for Phones" section for more details about the CSV file.
To create a phone template, you must first enter the required phone settings and then add the appropriate number of lines to the phone.
Related Topics
Entering Phone Settings
The phone settings required for the phone template are similar to the phone settings required when adding a phone to Cisco CallManager.
Procedure
Step 1
Figure 2 displays the Phone Template window.
Figure 2 Phone Template Window
Step 2
These settings are not available for all phone types. Only the settings appropriate to the model selected appear on your screen.
Step 3
Step 4
Adding Line Information
For each template, add only the number of lines you want to define for all phones. Figure 3 illustrates the template for a Cisco IP Phone 7960.
Figure 3 Add Line Window
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
After setting up the lines for the template, use the template to add phones with CSV files.
Creating the CSV File for Phones
The CSV file for phones contains information about each phone as a record. All phones in a CSV file should be of the same model and number of configured lines. For example, you might create a CSV file for all the Cisco IP Phone 7960 two-line phones and another for all the Cisco IP Phone 30 VIP ten-line phones.
The CSV file for phones can contain multiple directory numbers depending on whether the phone template in question supports multiple lines. The number of directory numbers entered in the CSV file must be equal to the number of lines configured in the phone template.
Using the Phone Tab in BAT.xls
Follow this procedure for fast bulk input of phones.
Procedure
Step 1
Step 2
Step 3
Note
Step 4
Step 5
You must enter the MAC address or use the dummy MAC address option (the MAC address updates when a phone is plugged in).Step 6
CSV String Formats for Phones
The following shows the field length and string types followed by an example of a CSV file for phones.
Note
However, default values set on the template will use those values on a CSV file that contains blank values for Location, Display, Forward Busy Destination, or Call Pickup Group. For example, if FwdBusy Destination is 3001 on a template, then all records in a CSV file that have no value for FwdBusy Destination will use 3001.MAC Address (String[12]MANDATORY),Description (String[50] OPTIONAL),Location (String[50] OPTIONAL),Directory Number (String[15] OPTIONAL),Display (String[30] OPTIONAL),Forward Busy Destination (String[15] OPTIONAL),Call Pickup Group (String[15/50] OPTIONAL)
Example
1231123245AB,SEP1231123245AB,Dallas,9728437154,9728437154,9728437172,9728437121/TollByPassThe actual file will not contain field names (displayed in the first line). Delimiters have to be specified even if a field is blank. Call Pickup Group can either be specified as a Directory Number or as Directory Number/Route Partition Name, if the access to the call pickup group is restricted by a Route Partition.
Refer to the following examples and sample CSV records when creating CSV files.
Examples
If the description for a phone is blank:
1231123245AB,,Dallas,9728437154,9728437154,9728437172,9728437121/TollByPassIf the selected phone template supports a maximum of six lines and no active line is required:
1231123245AB,SEP1231123245AB,DallasNo active line is required and the location is also blank:
1231123245AB,SEP1231123245AB,Two active lines are required:
1231123245AB,SEP1231123245AB,Dallas,9728437154,9728437154,9728437172,9728437121/TollByPas s,9728437155,9728437155,9728437133,9728437112/TollByPass
Note
If the option is checked for a dummy MAC address:
,SEP1231123245AB,,Dallas,9728437154,9728437154,9728437172,9728437121/TollByPassCreating an Optional Phones CSV Text File
If you don't use the BAT.xls for data input, follow this optional procedure to create lines of ASCII text for phones with values separated by commas.
Note
Procedure
Step 1
Step 2
MAC Address,Description,Location,Directory Number,Display,Forward Busy Destination,CallPickup GroupYou must enter the MAC address or use the dummy MAC address option on the Insert Phones page (the MAC address updates when a phone is plugged in). You can leave the other fields empty, but you must include the comma separators.
Note
Step 3
Adding Phones to Cisco CallManager
Follow this procedure to add several phones to Cisco CallManager.
Before You Begin
You must create a phone template and CSV file before you add phones to Cisco CallManager.
Procedure
Step 1
The Insert Phones window displays as shown in Figure 4.
Figure 4 Insert Phones Window
Step 2
Step 3
Step 4
The fields are described in Table 3.
Table 3 Insert Phones Settings
File Name
Indicates the CSV file that includes the phones to be added.
•
•
Phone Template Name
Indicates the phone template to be used for this set of phones.
•
•
•
•
Create Dummy MAC Addresses
Automatically generates fake MAC addresses in this format:
XXXXXXXXXXXX
where X is any 12-character hexadecimal (0-9 and A-F) number.
•
•
•
–
–
–
Note
–
–
Step 5
Note
Step 6
Related Topics
•
•
Viewing Insert Phones Results
Figure 5 shows a sample of the Insert Phones confirmation window.
Figure 5 Sample Insert Phones Confirmation Window
After the phones are added, the BAT application generates a log file indicating the number of records added and the number of records failed, including an error code. For more information on log files, see the "Troubleshooting" section.
Modifying Phones
You can update and delete several phone records from the Cisco CallManager database in bulk.
Related Topics
Updating Phone Records
The administrator can create a query to update a set of records. To create a query, a filter must be defined. The administrator can also create multiple queries by clicking either the AND or OR button.
Figure 6 shows the Update Phones window.
Figure 6 Update Phones Window
Procedure
Step 1
Step 2
Step 3
a.
b.
c.
d.
Caution
e.
f.
Step 4
a.
b.
c.
d.
Note
Step 5
Deleting Phone Records
You can delete multiple phone records from the Cisco CallManager database using the following procedure. Figure 7 shows the Delete Phones window.
Note
Figure 7 Delete Phones Window
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Caution
Step 7
Step 8
Step 9
Viewing Update Phones Results
After the phones are updated in Cisco CallManager, the application generates a log file indicating the number of records updated and the number of records failed, including an error code. For more information on log files, see the "Troubleshooting" section.
Adding Users
You can add multiple users to the Cisco CallManager database using the following procedures. Figure 8 shows the Insert Users window.
Note
Figure 8 Insert Users Window
Related Topics
•
•
Creating the CSV File for Users
To add users into the Cisco CallManager, you must create a CSV file.
Using the User Tab in BAT.xls
Follow this procedure for fast bulk input of users.
Procedure
Step 1
Step 2
Step 3
Note
Step 4
CSV String Formats for Users
The following shows the field length and string types followed by an example of a CSV file for users.
First Name (String[50] MANDATORY),Last Name (String[50] MANDATORY),User Id (String[30] MANDATORY),Manager (String[30] OPTIONAL), MAC Address (String[12] OPTIONAL),Directory Number (String[15] OPTIONAL)
Example
John,Smith,johns,Daviss,1231123245AB,9728437154The actual file will not contain field names (displayed in the first line). Delimiters have to be specified even if a field is blank. Refer to the following example and sample CSV record when creating a CSV file.
Example
If the Manager for a user is blank:
John,Smith,johns,,1231123245AB,,9728437154The Manager is the UserID of an existing user in the USER Directory.
Creating an Optional Users CSV Text File
If you don't use the BAT.xls for data input, follow this optional procedure to create lines of ASCII text for users with values separated by commas.
Note
Procedure
Step 1
Step 2
First Name,Last Name,User ID,Manager,MAC Address,Directory NumberYou must enter the Name, User ID, and MAC Address or use the dummy MAC address option on the Insert Users page (the MAC address updates when a phone is plugged in). You can leave other fields empty, but you must include the comma separators.
Step 3
Adding Users to Cisco CallManager
Follow this procedure to add several users to Cisco CallManager.
Before You Begin
You must create a CSV file before you add phones to Cisco CallManager.
Procedure
Step 1
Step 2
Step 3
Step 4
Viewing Insert Users Results
After the users are added to Cisco CallManager, the application generates a log file indicating the number of records added and the number of records failed, including an error code. For more information on log files, see the "Troubleshooting" section.
Adding Phone and User Combinations
You can add combinations of multiple phones and users to the Cisco CallManager database using the following procedures. Figure 9 shows the Insert Phones/Users window.
Figure 9 Insert Phones/Users Window
Related Topics
•
•
•
•
Creating the CSV File for Phone and User Combinations
To add phone and user combinations into the Cisco CallManager, you must create a CSV file.
Using the Phone-User Tab in BAT.xls
Follow this procedure for fast bulk input of phone and user combinations.
Procedure
Step 1
Step 2
Step 3
Note
Step 4
Step 5
You must enter the MAC address or use the dummy MAC address option (the MAC address updates when a phone is plugged in).Step 6
CSV String Formats for Phone and User Combinations
The following shows the field length and string types followed by an example of a CSV file for phones and users.
First Name (String[50] MANDATORY),Last Name (String[50] MANDATORY),User ID (String[30] MANDATORY),Manager (String[30] OPTIONAL),MAC Address (String[12] MANDATORY),Description (String[50] OPTIONAL),Location (String[50] OPTIONAL),Directory Number (String[15] MANDATORY),Display (String[30] OPTIONAL),Forward Busy Destination (String[15] OPTIONAL),Call Pickup Group (String[15/50] OPTIONAL)
Example
John,Smith,johns,Daviss,1231123245AB,SEP1231123245AB,Dallas,9728437154,9728437154,9728437 172,9728437121/TollByPassThe actual file will not contain field names (displayed in the first line). Delimiters have to be specified even if a field is blank. Call Pickup Group can either be specified as a Directory Number or as Directory Number/Route Partition Name, if the access to the call pickup group is restricted by a Route Partition.
Refer to the following examples and sample CSV records when creating CSV files.
Examples
If the description for a phone is blank:
John,Smith,johns,Daviss,1231123245AB,,Dallas,9728437154,9728437154,9728437172,9728437121/ TollByPassThe Manager is the UserID of an existing user in the USER Directory.
If the selected phone template supports a maximum of six lines and no active line is required:
John,Smith,johns,Daviss,1231123245AB,SEP1231123245AB,DallasNo active line is required and the description is also blank:
John,Smith,johns,Daviss,1231123245AB,SEP1231123245AB,Two active lines are required:
John,Smith,johns,Daviss,1231123245AB,SEP1231123245AB,Dallas,9728437154,9728437154,9728437 172,9728437121/TollByPass,9728437155,9728437155,9728437133,9728437112/TollByPass
Note
If the option for a dummy MAC address is checked:
John,Smith,johns,Daviss,1231123245AB,,Dallas,9728437154,9728437154,9728437172,9728437121/ TollByPassCreating an Optional Phones-Users CSV Text File
If you don't use the BAT.xls for data input, follow this optional procedure to create lines of ASCII text for phones and users with values separated by commas.
Note
Procedure
Step 1
Step 2
First Name,Last Name,User ID,Manager,MAC Address,Description,Directory NumberYou must enter the Name, User ID, and MAC address or use the dummy MAC address option on the Insert Phones/Users page (the MAC address updates when a phone is plugged in). Other fields may remain empty, but you must include the comma separators.
If the dummy MAC address option is checked, the following shows a sample CSV record:
John,Smith,johns,Daviss,,SEP1231123245AB,9728437154Step 3
Adding Phone and User Combinations to Cisco CallManager
Follow this procedure to add several phone and user combinations to Cisco CallManager.
Before You Begin
You must create a CSV file before you add phones and users to Cisco CallManager.
Procedure
Step 1
Step 2
Step 3
Step 4
Viewing Insert Phones/Users Results
After the users are added to Cisco CallManager, the application generates a log file indicating the number of records added and the number of records failed, including an error code. For more information on log files, see the "Troubleshooting" section.
Important Notes
The latest documentation and release notes for Cisco CallManager are available on Cisco Connection Online (CCO) at:
http://www.cisco.com/kobayashi/sw-center/internet/callmgr/callmgr.html
Cisco Year 2000 product compliance information can be found at:
http://www.cisco.com/warp/public/752/2000/
A local copy of the Help is installed with Cisco CallManager and is available by clicking Start > Programs > Cisco CallManager > Cisco Help > System Guide. However, the most current Cisco CallManager documentation can be found on the Web at:
http://www.cisco.com/documentation/ccm/v24/index.htm
Troubleshooting
Log files are generated for each bulk transaction and stored in a log file folder for viewing.
The log file will also show the key value of a record so the administrator may re-examine the record. The key value when adding, updating, or modifying phones is the MAC address of the phone. When adding users, the key value is the User ID.
A confirmation screen occurs after each bulk transaction. The confirmation screen shows the summary view for the bulk transaction as well as the detail view for the failures.
Note
If the administrator performs several mouse clicks while waiting for the bulk transaction to complete, the BAT application concludes with the last mouse click and you lose the ability to view the confirmation message.
To view the log file for the bulk operation, go to the following location:
C:\CiscoWebs\BAT\LogFile
Note
The time-stamp format for the log file name is "mmddyyyyhhmmss".
Table 4 shows examples of commands and LogFiles names.
Failure Details on LogFileExplanation Shows the MAC address (Phones)/UserID (for Users) or, in case of a Dummy MAC address, shows the Dummy MAC address generated.
Action Go to CiscoWebs > BAT > LogFiles > ModifiedDataFileName#TimeStamp.dat and view the file for an erroneous record.
This page cannot be displayedExplanation Can occur because of an unexpected termination of IIS Administrative service.
Action A display problem only. The process continues in the background. You can refer to the log file for transaction details.
Service and Support
Service and support is provided by the Cisco Technical Assistance Center (TAC) at:
http://www.cisco.com/warp/public/687/Directory/DirTAC.shtml
Cisco Connection Online
Cisco Connection Online (CCO) is Cisco Systems' primary, real-time support channel. Maintenance customers and partners can self-register on CCO to obtain additional information and services.
Available 24 hours a day, 7 days a week, CCO provides a wealth of standard and value-added services to Cisco customers and business partners. CCO services include product information, product documentation, software updates, release notes, technical tips, the Bug Navigator, configuration notes, brochures, descriptions of service offerings, and download access to public and authorized files.
CCO serves a wide variety of users through two interfaces that are updated and enhanced simultaneously: a character-based version and a multimedia version that resides on the World Wide Web (WWW). The character-based CCO supports Zmodem, Kermit, Xmodem, FTP, and Internet e-mail, and it is excellent for quick access to information over lower bandwidths. The WWW version of CCO provides richly formatted documents with photographs, figures, graphics, and video, as well as hyperlinks to related information.
You can access CCO in the following ways:
•
•
•
•
•
For a copy of CCO's Frequently Asked Questions (FAQ), contact cco-help@cisco.com.
For additional information, contact cco-team@cisco.com.
Note
Documentation CD-ROM
Cisco documentation and additional literature are available in a CD-ROM package, which ships with your product. The Documentation CD-ROM, a member of the Cisco Connection Family, is updated monthly. Therefore, it might be more current than printed documentation. To order additional copies of the Documentation CD-ROM, contact your local sales representative or call customer service. The CD-ROM package is available as a single package or as an annual subscription. You can also access Cisco documentation on the World Wide Web at http://www.cisco.com, http://www-china.cisco.com, or http://www-europe.cisco.com. If you are reading Cisco product documentation on the World Wide Web, you can submit comments electronically. Click Feedback in the toolbar and select Documentation. After you complete the form, click Submit to send it to Cisco. We appreciate your comments.
Guest
