Bulk Administration Tool User Guide, Release 5.1(4)
Working with Phones and IP Telephony Devices
Downloads: This chapterpdf (PDF - 673.0KB) The complete bookPDF (PDF - 2.97MB) | Feedback

Working with Phones and IP Telephony Devices

Table Of Contents

Working with Phones and IP Telephony Devices

Adding Phones

Using BAT Phone Templates

Creating a New BAT Phone Template

Viewing or Modifying BAT Phone Templates

Copying a BAT Phone Template

Deleting Templates

Field Descriptions for a BAT Phone Template

Field Descriptions for Adding a Line to a BAT Template

Using the BAT Spreadsheet to Create a CSV Data File for Phones

Field Descriptions for Phones in the BAT Spreadsheet

Using a Text Editor to Create the CSV Data File for Phones

Creating a File Format

Copying a File Format

Modifying a File Format

Deleting a File Format

Associating the File Format with the CSV Data File

Validating Phone Records

Inserting Phones into Cisco CallManager

Updating Phones

Using Query to Update Phones

Using a Custom File to Update Phones

Choosing the Update Parameters

Field Descriptions for Updating Phones

Updating Lines

Field Descriptions for Updating Lines

Adding Lines to Existing Phones and UDPs

Using the BAT Spreadsheet to Add Lines to Existing Phones

Field Descriptions for Adding Lines By Using the BAT Spreadsheet

Deleting Phones

Using Query to Delete Phones

Using a Custom File to Delete Phones

Resetting or Restarting Phones

Using Query to Reset or Restart Phones

Using a Custom File to Reset or Restart Phones

Configuring CAPF

Upgrading LSC


Working with Phones and IP Telephony Devices


BAT gives the administrator a fast and efficient way to add, update, or delete large numbers of phones in batches, rather than performing individual updates through Cisco CallManager Administration. You can use BAT to work with the following types of phones:

Cisco IP Phones (all models)

CTI ports

H.323 clients

Cisco VGC virtual phones and Cisco VGC phones

The following topics provide information about using BAT to work with phones and other IP telephony devices:

Adding Phones

Updating Phones

Deleting Phones

Using Phone Export

Updating Lines

Adding Lines to Existing Phones and UDPs

Resetting or Restarting Phones

Adding New Phones with Users, page 4-22

Generating Reports for Phones

Configuring CAPF

Adding Phones

When you use BAT to add phones and other IP telephony devices to the Cisco CallManager database, you can add multiple lines, services, and speed dials for each phone. You can also add CTI ports and H.323 clients.

You have two options for creating a CSV data file for phones:

Use the BAT spreadsheet (BAT.xlt) and export the data to the CSV format.

Use a text editor to create a text file in CSV format (for experienced users).

Use the following steps to add phones and IP telephony devices in bulk.


Step 1 Choose Configure > Phones. The Phones Options window displays.

Step 2 Choose Insert Phones and click Next. The Steps to Insert Phones window displays.

Step 3 Choose Add, view, or modify phone templates and click Next.

The Phone Template Configuration window displays. See the "Using BAT Phone Templates" section for information about configuring phone templates.

Step 4 Choose Create the CSV data file and click Next.

Step 5 Choose the option that you will use to create the CSV data file and use the steps for that option.

BAT Spreadsheet for Phones, CTI Ports and H.323 Clients

Open the BAT spreadsheet and create the CSV data file. See "Using the BAT Spreadsheet to Create a CSV Data File for Phones" section

Text Editor to Create the CSV Data File

a. Choose Add, view, or modify file formats and click Next.

The File Format Configuration window displays. See the "Using a Text Editor to Create the CSV Data File for Phones" section for information about configuring file formats for CSV data file.

b. Use a text editor and create the CSV data file for phones that follows the file format that you want to use. For more information about creating a text-based CSV file, see "Creating a Text-Based CSV File for Phones" section on page A-2

c. Choose Associate file format with the CSV data file and click Next.

The Add File to Format window displays. See the "Associating the File Format with the CSV Data File" section for information about associating file formats.

Step 6 Choose Validate phone records and click Next.

The Validate Phones window displays. See the "Validating Phone Records" section for information about validating phone records.

Step 7 Choose Insert Phones and click Next.

The Insert Phones window displays. See the "Inserting Phones into Cisco CallManager" section for information about inserting phone records into the Cisco CallManager database.


Related Topics

Using BAT Phone Templates

Using the BAT Spreadsheet to Create a CSV Data File for Phones

Using a Text Editor to Create the CSV Data File for Phones

Validating Phone Records

Inserting Phones into Cisco CallManager

Using BAT Phone Templates

Use BAT phone templates to define the common phone attributes to add a group of new phones. Prior to creating the template, make sure phone settings such as device pool, location, calling search space, button template and softkey templates have already been configured in Cisco CallManager Administration. You cannot create new settings in BAT.

Use these topics to work with BAT Phone Templates:

Creating a New BAT Phone Template

Adding or Updating Lines in a BAT Template

Copying a BAT Phone Template

Deleting Templates

Field Descriptions for a BAT Phone Template

Creating a New BAT Phone Template

Use this procedure to create the phone template. After you create a phone template, you can add lines, services, and speed dials. Use the following procedure to create a phone template.

Procedure


Step 1 In the Phone Templates Configuration window, click Add a new Phone Template.

Step 2 In the Phone Template Name field, enter a name for the template. The name can contain up to 50 alphanumeric characters. Example: Sales_7960.

Step 3 From the Device Type drop-down list, choose the phone model, Cisco IP Phones, Cisco VGC virtual phones and Cisco VGC phones, CTI port, or H.323 client for which you are creating the template.

After you choose the device, the Phone Templates Configuration window refreshes with fields and default entries for the chosen device type.

Step 4 In the Device Information area, enter the phone settings that this batch has in common. See Table 3-1 for field descriptions. Some phone models and device types do not have all the attributes that the table lists.

Step 5 After you have entered all the settings for this BAT phone template, click Insert.

Step 6 When the status indicates that the transaction has completed, scroll down to the Line Details area to add line attributes.


Adding or Updating Lines in a BAT Template

To add one or more lines to the BAT template or to update existing lines, follow this procedure. The button template in use for this BAT template determines the number of lines that you can add or update. You can create a master phone template that has multiple lines. Then, you can use the master template to add phones with a single line or up to the number of lines in the master template. See the "Master Phone Templates" section on page 1-6 for more information.

Procedure


Step 1 In the Phone or User Device Profile Template Configuration window, choose the template for which you want to add line(s).

Step 2 Scroll down to the bottom of the template and click Add Line.

A popup window displays.


Note The maximum number of lines that display for a BAT template depends on model and button template that you chose when you created the BAT phone template.


Step 3 Enter or choose the appropriate values for the line settings that are described in Table 3-2. Keep in mind that all phones or user device profiles in this batch will use the settings that you choose for this line. Treat all fields as optional.

Step 4 Click Insert and Close.

BAT adds the line to the phone template configuration, and the popup window closes.

Step 5 Repeat Step 2 through Step 4 to add settings for any additional lines.

Step 6 For some Cisco IP Phone models, you can add Cisco IP Phone services and speed dials to the template. See these topics for the procedures:

Adding or Updating IP Services in a BAT Template

Adding or Updating Speed Dials in a BAT Template


Adding or Updating IP Services in a BAT Template

You can subscribe Cisco IP Phone services to the Cisco IP Phone models that include this feature.


Note You can bulk subscribe users or phones to IP services with common service parameters but not to IP services with unique service parameters.


Procedure


Step 1 In Phone or User Device Profile Template Configuration window, choose the template for which you want to add service(s).

Step 2 Click Subscribe/Unsubscribe Services in upper, right corner of the window.

A popup window displays. In this window, you can subscribe to Cisco IP Phone services that are available.

Step 3 In the Select a Service box, choose a service to which you want all phones to be subscribed. The Service Description box displays details about the service that you choose.

Step 4 Click Continue.

Step 5 In the Service Name field, modify the name of the service if required.

Step 6 To associate these phone services to the phone template, click Subscribe .

Step 7 To add more services, repeat Step 3 through Step 6.

Step 8 To add all the services to the template, click Update.

Step 9 Close the popup window.

Step 10 You can add speed dials to the template by continuing to the "Adding or Updating Speed Dials in a BAT Template" section.


Adding or Updating Speed Dials in a BAT Template

You can add and update speed dials in the BAT template.

You can designate speed dials for phones and Cisco VGC phones if the Phone Button Template provides speed-dial buttons

Procedure


Step 1 In the Phone or User Device Profile Template Configuration window, choose the template for which you want to add speed dial(s)

Step 2 Click Add/Update Speed Dials in the upper, right corner of the window.

A popup window displays. In this window, you can designate speed-dial buttons for Cisco IP Phones and expansion modules. The phone button template in use for this BAT template determines the number of available speed-dial buttons.

Step 3 In the Speed Dial Settings for Phone area, enter the phone number, including any access or long-distance codes, in the Speed Dial Number field.

Step 4 In the Label field, enter a label that corresponds to the speed-dial number.

Step 5 In the Speed Dial Settings not associated with a button area, you can set abbreviated speed dials for applicable IP phone models by repeating Step 3 and Step 4.

Step 6 Click Update and Close.

BAT inserts the speed-dial settings in the template, and the popup window closes.


Related Topics

Field Descriptions for a BAT Phone Template

Viewing or Modifying BAT Phone Templates

Copying a BAT Phone Template

Deleting Templates

Adding Phones

Viewing or Modifying BAT Phone Templates

Use this procedure to view or modify an existing phone or user device profile template. You can add or update lines, services, and speed dials.

Procedure


Step 1 In the Phone Template Configuration window, choose an existing template from the list of templates. The template details display in the template fields.

Step 2 Add, change, or remove settings in the template. See "Field Descriptions for a Phone Template" section for more information.

Step 3 After you have modified the settings to update the template, click Update.

Step 4 If you want to update other attributes, choose one of the following procedures:

Adding or Updating Lines in a BAT Template

Adding or Updating IP Services in a BAT Template

Adding or Updating Speed Dials in a BAT Template


Copying a BAT Phone Template

You can copy the properties of a phone template into a new phone template when you want to change only a few fields.


Note The new template that you create must be the same device type as the original template, such as Cisco IP Phone model 7960.


Use the following procedure to copy an existing BAT phone template.

Procedure


Step 1 In Phone Template Configuration window, choose the template that you want to copy from the Phone Templates column. The chosen template details display in the Phone Template Configuration window.

Step 2 Verify that this is the template that you want to copy and click Copy.

The template reproduces and creates a copy. The copy duplicates all the values that were specified in the original template.

Step 3 In the Phone Template Name field, enter a new template name, up to 50 alphanumeric characters.

Step 4 Update the fields as needed for the new template. See "Field Descriptions for a Phone Template" section for information.

Step 5 Click Insert. The template that is added to BAT displays in the Phone Templates column on the left.

Step 6 Click Add Line to set line attributes, if applicable. See the "Adding or Updating Lines in a BAT Template" section for more information. You can also define services and speed-dial buttons.


Related Topics

Field Descriptions for a BAT Phone Template

Adding or Updating Lines in a BAT Template

Adding or Updating IP Services in a BAT Template

Adding or Updating Speed Dials in a BAT Template

Adding or Updating Lines in a BAT Template

Adding Phones

Deleting Templates

You can delete BAT templates when you no longer require them. Use this procedure to delete a template.

Procedure


Step 1 In the The Steps to Insert Phones window, choose Add, view, or modify phone templates and click Next. The Phone Templates Configuration window displays.

Step 2 In the Phone Templates column on the left, click the template that you want to delete. The details for the chosen template display in the Template Configuration window.

Step 3 Verify that this is the template that you want to delete and click Delete.

A message displays that asks you to confirm the delete operation.

Step 4 To delete the template, click OK. The template name disappears from the list of phone templates.


Related Topics

Creating a New BAT Phone Template

Viewing or Modifying BAT Phone Templates

Copying a BAT Phone Template

Field Descriptions for a BAT Phone Template

Table 3-1 provides descriptions of all possible fields that display when you are adding a BAT phone template for all IP telephony devices. Some device types do not require all the phone settings.

Some fields display the values that were configured in Cisco CallManager Administration.

In the BAT user interface, field names that have an asterisk require an entry. Treat fields that do not have an asterisk as optional.

Table 3-1 Field Descriptions for a Phone Template 

Field
Description

Owner User ID

Enter a user ID for the primary phone user.

Device Pool

Choose the device pool for this group of phones/ports.

For devices, a device pool defines sets of common characteristics, such as region, date/time group, Cisco CallManager group, and calling search space for auto-registration.

Calling Search Space

Choose the calling search space for this group of phones/ports.

A calling search space specifies the collection of Route Partitions that are searched to determine how a dialed number should be routed.

AAR Calling Search Space

Choose the appropriate calling search space for the device to use when it performs automated alternate routing (AAR). The AAR calling search space specifies the collection of route partitions that are searched to determine how to route a collected (originating) number that is otherwise blocked due to insufficient bandwidth.

Media Resource Group List

Choose the media resource group list (MRGL) for this group of phones/ports.

An MRGL specifies a list of prioritized media resource groups. An application can choose required media resources from the available ones according to the order that is defined in the MRGL.

User Hold Audio Source

Choose the user hold audio source for this group of phones/ports.

The user hold audio source identifies the audio source from which music is played when a user places a call on hold.

Network Hold Audio Source

Choose the network hold audio source for this group of IP phones or ports.

The network hold audio source identifies the audio source from which music is played when the system places a call on hold, such as when the user transfers or parks a call.

Location

Choose the appropriate location for this group of IP phones or ports.

The location specifies the total bandwidth that is available for calls to and from this location. A location setting of None means that the locations feature does not keep track of the bandwidth that this Cisco IP Phone consumes.

User Locale

Choose the country and language set that you want to associate with this group of IP phones.

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

Network Locale

Choose the network locale that you want to associate with this group of phones.

The Network Locale comprises a set of tones and cadences that Cisco gateways and phones use when communicating with the PSTN and other networks in a specific geographical area.

Device Security Mode

From the drop-down list box, choose the mode that you want to set for the device:

Use System Default—The phone uses the value that you specified for the enterprise parameter, Device Security Mode.

Non-secure—No security features exist for the phone. A TCP connection opens to Cisco CallManager.

Authenticated—Cisco CallManager provides integrity and authentication for the phone. A TLS connection using NULL/SHA opens.

Encrypted—Cisco CallManager provides integrity, authentication, and encryption for the phone. A TLS connection using AES128/SHA opens

Note This field displays only if the phone model supports authentication or encryption.

Signal Packet Capture Mode

From the drop-down list box, choose the mode that you want to set for signal packet capture:

None—Choose None if you do not want to specify a mode.

Real-Time Mode—Use this mode for real-time signal packet capture.

Batch Processing Mode—Use this mode for batch processing signal packet capture mode.

Packet Capture Duration

Enter the time for packet capture in minutes. You can enter a maximum duration of 300 minutes. The default duration specifies 60 minutes.

Built In Bridge

Enable or disable the built-in conference bridge for the barge feature by using the Built In Bridge drop-down list box (choose On, Off, or Default).

For more configuration information, refer to the Barge and Privacy Features in the Cisco CallManager Features and Services Guide.

Privacy

For each phone that wants Privacy, choose On in the Privacy drop-down list box.

For more configuration information, refer to Barge and Privacy Features in the Cisco CallManager Features and Services Guide.

Retry Video Call as Audio

Check this check box to retry a video call as an audio call.

Ignore Presentation Indicators (Internal Calls Only)

Check this check box to ignore presentation indicators in an internal call.

Phone Button Template and Expansion Module Template Information

Phone Button Template

Choose the button template for all phones in this group. Button templates determine the button identity (line, speed dial) and the button location on the phone. Button templates include the expansion modules.

Softkey Template Information

Softkey Template

Choose the softkey template to be used for all phones in this group.

Expansion Module Information

Module 1

Choose the expansion module if installed in the phone.

Module 2

Choose the expansion module if installed in the phone.

Firmware Load Information

Phone Load Name

Enter the custom phone load, if applicable.

Note Any value that is entered in this field overrides the default value for the chosen model.

Module 1 Load Name

Enter the firmware load for the first Cisco IP Phone Expansion Module, if applicable. Leave this field blank to use the default load.

Module 2 Load Name

Enter the firmware load for the second Cisco IP Phone Expansion Module, if applicable. Leave this field blank to use the default load.

Cisco IP Phone - External Data Locations

Information

Enter the help text URL for the information button for Cisco IP Phones.

Directory

Enter the URL of the directory server for Cisco IP Phones.

Messages

Enter the voice-messaging access pilot number for Cisco IP Phones.

Services

Enter the URL for the services menu for Cisco IP Phones.

Authentication Server

Enter the URL that the phone uses to validate requests that are made to the phones web server. If you do not provide an authentication URL, the advanced features on the Cisco IP Phone models that require authentication will not function. Leave this field blank to accept the default setting.

By default, this URL accesses a Cisco IP Phone User Options window that was configured during installation.

Proxy Server

Enter the host and port (for example, proxy.cisco.com:80) that are used to proxy HTTP requests for access to non-local host addresses from the phones HTTP client.

If the phone receives a URL such as www.cisco.com in a service and the phone is not configured in the cisco.com domain, the phone uses the proxy server to access the URL. If the phone is configured in the cisco.com domain, the phone accesses the URL without using the proxy because it is in the same domain as the URL.

Leave this field blank to accept the default setting.

Idle

Enter the URL of the XML service that will appear as the idle display on the Cisco IP Phone LCD screen when the phone has not been used for the time that is specified in the Idle Time field. For example, you can display a logo on the LCD screen when the phone has not been used for 5 minutes. Leave this field blank to use the default value.

Idle Timer

Enter the seconds that you want to elapse before the phone displays the URL that is specified in the Idle field. Leave this field blank to use the default value.

MultiLevel Precedence and Preemption (MLPP) Information

MLPP Indication

If available, this setting specifies whether a device capable of playing precedence tones will use the capability when it places an MLPP precedence call.

From the drop-down list box, choose a setting to assign to this device from the following options:

Default—This device inherits its MLPP indication setting from its device pool.

Off—This device does not send indication of an MLPP precedence call.

On—This device does send indication of an MLPP precedence call.

Note Do not configure a device with the following combination of settings: MLPP Indication is set to Off while MLPP Preemption is set to Forceful.

MLPP Preemption

If available, this setting specifies whether a device that is capable of preempting calls in progress will use the capability when it places an MLPP precedence call.

From the drop-down list box, choose a setting to assign to this device from the following options:

Default—This device inherits its MLPP preemption setting from its device pool.

Disabled—This device does not preempt calls in progress when it places an MLPP precedence call.

Forceful—This device preempts calls in progress when it places an MLPP precedence call.

Note Do not configure a device with the following combination of settings: MLPP Indication is set to Off while MLPP Preemption is set to Forceful.

MLPP Domain (e.g., "0000FF")

Enter a hexadecimal value for the MLPP domain associated with this device. Must be blank or a value between 0 and FFFFFF.

Certification Authority Proxy Function (CAPF) Information ( These parameters display only for devices with the capability to support authentication or encryption.)

Certificate Operation

From the drop-down list box, choose the Certification Operation that you want to perform from the following options:

No Pending Operation—No pending Certification Operation lists for this device. Choosing this option disables the remaining CAPF fields.

Install/Upgrade—Install or upgrade a Certification Operation.

Delete—Delete a Certification Operation

Troubleshoot—Troubleshoot a Certification Operation.

Authentication Mode

From the drop-down list box choose the Authentication Mode for this device from the following options:

By Authentication String—You can enter the authentication string in the Authentication string text box or get a system-generated string

By Null String—This mode uses a null string

By Existing LSC—This mode Uses the (Local Significant Certificate) LSC setting

By Manufacture Installed Certificate—This mode uses the manufacture-installed certificate.

Authentication String

If Authentication Mode is By Authentication String, enter the Authentication String. Alternately, to get a system-generated string, click Generate String.

Key Size (Bits)

From the drop-down list box, choose the authentication key size for the device. The default key size specifies 1024 bits.

Operation Completes By

Enter the date by which the Certification Operation will complete. The date format specifies YYYY: MM: DD: HH. The default completion date specifies 10 days from the current system date.

Extension Mobility (Device Profile) Information

Enable Extension Mobility Feature

Check this check box to enable the extension mobility feature. Extension mobility allows a user to log in and out of a Cisco IP Phone. Refer to the Cisco CallManager Features and Services Guide for more information about extension mobility.

Log Out Profile

Choose the profile that a phone should load when an extension mobility user logs out. You must configure logout profiles in Cisco CallManager Administration.

Use Current Device Setting—This choice creates an autogenerated device profile as the default device profile.

Select a User Device Profile—This choice assigns a user device profile, which has already been defined, that becomes the default device profile for this device.

The chosen user device profile gets loaded onto the device when no user is logged in.

Product-Specific Configuration

Disable Speakerphone

Check this check box to disable the speakerphone for all phones that are added by using this BAT template.

Disable Speakerphone and Headset

Check this check box to disable the speakerphone and headset for all phones that are added by using this BAT template.

Forwarding Delay

Choose Enabled if you want the port to wait a few seconds prior to forwarding a call. The default specifies to Disabled.

PC Port

Choose Enabled or Disabled to control the PC port on phones that have internal switches. Use the port labeled "10/100 PC" on the back of the phone to connect a PC or workstation to the phone, and share a single network connection.

Settings Access

Choose Enabled or Disabled to control whether the user has access to phone settings or not.

Gratuitous ARP

Choose Enabled or Disabled to control gratuitous ARP.

PC Voice VLAN Access

Choose Enabled or Disabled to control access to a PC voice VLAN.

Video Capabilities

Choose Enabled or Disabled to control video capabilities access.

Auto Line Select

Choose Enabled or Disabled to allow automatic line selection on the phone.

H.323 Device Information

Signaling Port

The value designates the H.225 signaling port that this device uses.

The default value specifies 1720. Valid values include 1 through 65535.

Retry Video Call as Audio

This check box applies only to video endpoints that receive a call. If this phone receives a call that does not connect as video, the call tries to connect as an audio call.

By default, the system checks this check box to specify that the sending device should immediately retry a video call that does not connect as an audio call prior to sending the call to call control for rerouting.

If you uncheck this check box, a video call that fails to connect as video fails to call control. At this point, call control reroutes the call within the route list. If Automatic Alternate Routing (AAR) is configured and enabled, call control also reroutes the call between route lists.

Wait for Far End H.245 Terminal Capability Set

By default, the system keeps this check box checked to specify that Cisco CallManager should initiate capabilities exchange. This check box specifies that the Cisco CallManager needs to receive the far-end H.245 Terminal Capability Set before it sends its H.245 Terminal Capability Set.

H.323 Information

Outgoing Caller ID Pattern

For incoming calls to the phone, enter the pattern, from 0 to 24 digits, that you want to use for caller ID.

Calling Party Selection

Choose one of the following options to specify which directory number is sent:

Originator—Send the directory number of the calling device.

First Redirect Number-—Send the directory number of the redirecting device.

Last Redirect Number—Send the directory number of the last device to redirect the call.

First Redirect Number(external)—Send the directory number of the redirecting device.

Last Redirect Number(external)—Send the directory number of the last device to redirect the call.

Calling Party Presentation

Choose whether the central office transmits or blocks caller ID:

Choose Allowed if you want the central office to send caller ID.

Choose Restricted if you do not want the central office to send caller ID.

Default displays the caller ID unless the caller ID was restricted in a previous level in the call stream.

Display IE Delivery

Check the check box to deliver the display information element (IE) in SETUP and CONNECT messages for the calling and called party name delivery service.

Redirecting Number IE Delivery—Outbound

Check this check box to include the Redirecting Number IE in the outgoing SETUP message from the Cisco CallManager to indicate the first redirecting number and the redirecting reason of the call when the call is forwarded.

Uncheck the check box to exclude the first redirecting number and the redirecting reason from the outgoing SETUP message.

Use Redirecting Number IE for voice-messaging integration only. If your configured voice-messaging system supports Redirecting Number IE, check the check box.

Redirecting Number IE delivery—Inbound

Use Redirecting Number IE when you are integrating a voice-messaging system that supports Redirecting Number IE.

Check this check box to accept the Redirecting Number IE in the incoming SETUP message to the Cisco CallManager.

Uncheck the check box to exclude the Redirecting Number IE in the incoming SETUP message to the Cisco CallManager.

Media Termination Point Required

Use this field to indicate whether a media termination point (MTP) is used to implement features that H.323 does not support (such as hold and transfer).

Check the Media Termination Point Required check box if you want to use a media termination point to implement features. Uncheck the Media Termination Point Required check box if you do not want to use a media termination point to implement features.

Use this check box only for H.323 clients and those H.323 devices that do not support the H.245 empty capabilities set or if you want media streaming to terminate through a single source.

If you check this check box to require an MTP and this device becomes the endpoint of a video call, the call works as audio only.

Gatekeeper Information

Gatekeeper Name

Choose the gatekeeper for the gatekeeper-controlled H.323 device from the drop-down list box.

Note If you do not choose the device, the system disables the E.164, Technology Prefix, and Zone fields.

Note You cannot change the device to a gatekeeper-controlled phone if more than one directory number is configured for the device.

Technology Prefix

Enter the technology prefix to eliminate the need for entering the IP address for every Cisco CallManager system when configuring the gw-type-prefix command. For example, you can enter 1#* in this field if you can use the following gw-type-prefix command on the gatekeeper:

gw-type-prefix 1#* default-technology.

Note You must enter a value in this field for a gatekeeper-controlled H.323 client. You can enter only numbers (0-9) and special characters # and * in this field.

Zone

On the Gatekeeper, enter the specific zone with which Cisco CallManager will register. The zone specifies the total bandwidth that is available for calls between this zone and another zone.

Note You must enter a value in this field for a gatekeeper-controlled phone. You can enter only letters, numbers, spaces, dashes, dots, and underscores in this field.

Gatekeeper Controlled H.323 Client

Check this check box to configure the H.323 client gatekeeper as a controlled gatekeeper.



Note To continue configuring the BAT phone template, go to the "Creating a New BAT Phone Template" section


Field Descriptions for Adding a Line to a BAT Template

Table 3-2 provides descriptions of all possible fields that display when you are adding a line in a BAT phone template. Some device types do not require all the phone settings.

Some fields display the values that were configured in Cisco CallManager Administration.

In the BAT user interface, field names that have an asterisk require an entry. Treat fields that do not have asterisk as optional.

Table 3-2 Field Descriptions for Adding a Line to a BAT Template 

Field
Description
Directory Number

Partition

Choose a route partition to which the directory number belongs.

Note The directory number can appear in more than one partition.

Directory Number Settings

Voice Mail Profile

Choose this parameter to make the pilot number the same as the directory number for this line. This action proves useful if you do not have a voice-messaging server that is configured for this phone.

Calling Search Space

Choose partitions that are searched for numbers that are called from this directory number.

Note Changes cause an update of Pickup Group Names that are listed in the Call Pickup Group field. The setting applies to all devices that are using this directory number.

AAR Group

Choose the automated alternate routing (AAR) group for this device. The AAR group provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth.

Set AAR Group to <None> to prevent rerouting blocked calls.

User Hold Audio Source

Choose the music on hold audio source to be played when the user presses HOLD to place a call on hold.

Network Hold Audio Source

Choose the music on hold audio source to be played when the system places a call on hold while the user transfers a call or initiates a conference or call park.

Auto Answer

Choose one of the following options to activate the Auto Answer feature for this directory number:

Auto Answer Off <Default>

Auto Answer with Headset

Auto Answer with Speakerphone (Intercom)

Note Make sure that the headset or speakerphone is not disabled when you choose Auto Answer with Headset or Auto Answer with Speakerphone.

Call Forward and Pickup Settings

Forward All Voice Mail

Check this check box if you want calls to forward to the number that you chose in the voice-mail profile.

Checking this check box makes the Forward All Destination field and Forward All Calling Search Space check box not relevant.

Forward All Destination

Enter the directory number to which all calls are forwarded.

Note The setting applies to any dialable phone number, including an outside destination unless restricted, and to all devices that are using this directory number.

Forward All Calling Search Space

Choose the calling search space to use when calls are forwarded to the specified destination.

Note This setting applies to all devices that are using this directory number.

Forward Busy Internal Voice Mail

Check this check box if you want calls from an internal number forwarded to a number that you chose in the voice-mail profile.

Checking this check box makes the Forward Busy Internal Destination field and Calling Search Space check box not relevant.

Forward Busy Internal Destination

Enter the directory number to which an internal call is forwarded when the line is in use.

Note This setting applies to any internal dialable phone number and to all devices that are using this directory number.

Forward Busy Internal Calling Search Space

Choose the calling search space to use when internal calls are forwarded to the specified destination.

Note This setting applies to all devices that are using this directory number.

Forward Busy External Voice Mail

Check this check box if you want calls from an external number forwarded to a number that you chose in the voice-mail profile.

Checking this check box makes the Forward Busy External Destination field and Calling Search Space check box not relevant.

Forward Busy External Destination

Enter the directory number to which an external call is forwarded when the line is in use.

Note This setting applies to any dialable external phone number, including an outside destination unless restricted, and to all devices that are using this directory number.

Forward Busy External Calling Search Space

Choose the calling search space to use when external calls are forwarded to the specified destination.

Note This setting applies to all devices that are using this directory number.

Forward No Answer Internal Voice Mail

Check this check box if you want calls from an internal number forwarded to the number that you chose in the voice-mail profile.

Checking this check box makes the Forward No Answer Internal Destination field and Calling Search Space check box not relevant.

Forward No Answer Internal Destination

Enter a directory number to which an internal call is forwarded when the phone is not answered.

Note This setting applies to any internal dialable phone number and to all devices that are using this directory number.

Forward No Answer Internal Calling Search Space

Choose the calling search space to use when internal calls are forwarding to the specified destination. The setting displays only if it is configured in the system.

Note This setting applies to all devices that are using this directory number.

Forward No Answer External Voice Mail

Check this check box if you want calls to forward to an external number that you chose in the voice-mail profile.

Checking this check box makes the Forward No Answer Externally Destination field and External Calling Search Space check box are not relevant.

Forward No Answer External Destination

Enter a directory number to which an external call is forwarded when the phone is not answered.

Note This setting applies to any external dialable phone number, including an outside destination unless restricted, and to all devices that are using this directory number.

Forward No Answer External Calling Search Space

Choose the calling search space to use when external calls are forwarding to the specified destination. The setting displays only if it is configured in the system.

Note This setting applies to all devices that are using this directory number.

Forward No Coverage Internal Voice Mail

Check this check box if you want calls from an internal number forwarded to the number that you chose in the voice-mail profile.

Checking this check box makes the Forward No Answer Destination field and Calling Search Space check box not relevant.

Forward No Coverage Internal Destination

Enter an directory number to which an internal call is forwarded when the phone has no coverage.

Note This setting applies to any internal dialable phone number and to all devices that are using this directory number.

Forward No Coverage Internal Calling Search Space

Choose the calling search space to use when internal calls are forwarding to the specified destination. The setting displays only if it is configured in the system.

Note This setting applies to all devices that are using this directory number.

Forward No Coverage External Voice Mail

Check this check box if you want calls from external number forwarded to the number that you chose in the voice-mail profile.

Checking this check box makes the Forward No Answer Destination field and Calling Search Space check box not relevant.

Forward No Coverage External Destination

Enter a directory number to which an external call is forwarded when the phone has no coverage.

Note This setting applies to any dialable phone number, including an outside destination unless restricted, and to all devices that are using this directory number.

Forward No Coverage External Calling Search Space

Choose the calling search space to use when external calls are forwarding to the specified destination. The setting displays only if it is configured in the system.

Note This setting applies to all devices that are using this directory number.

No Answer Ring Duration

Enter the number of seconds to allow the call to ring before forwarding the call to the Forward No Answer Destination.

Call Pickup Group

Choose a Pickup Group Name to specify the call pickup group, which can answer incoming calls to this directory number by dialing the appropriate pickup group number.

Multilevel Precedence and Preemption Alternate Party Settings

Target (Destination)

Enter the number to which MLPP precedence calls should be directed if this directory number receives a precedence call and neither this number nor its call forward destination answers the precedence call.

Values can include numeric characters, pound (#), and asterisk (*).

Calling Search Space

From the drop-down list box, choose the calling search space to associate with the alternate party target (destination) number.

No Answer Ring Duration

Enter the number of seconds (between 4 and 30) after which an MLPP precedence call will be directed to the alternate party of this directory number if this directory number and its call forwarding destination have not answered the precedence call.

Leave this setting blank to use the value that is set in the Cisco CallManager enterprise parameter, Precedence Alternate Party Timeout.

Line Settings for This Phone

Line Text Label

Use this field only if you do not want the directory number to show on the line appearance. Enter text that identifies this directory number for a line/phone combination.

Suggested entries include boss's name, department's name, or other appropriate information to identify multiple directory numbers to secretary/assistant who monitors multiple directory numbers.

External Phone Number Mask

Enter the phone number (or mask) that is sent for Caller ID information when a call is placed from this line.

You can enter a maximum of 24 numbers and "X" characters. The Xs represent the directory number and must appear at the end of the pattern. For example, if you specify a mask of 972813XXXX, an external call from extension 1234 displays a caller ID number of 9728131234.

Maximum Number of Calls

You can configure up to 184 calls for a line on a device in a cluster, with the limiting factor being the device. As you configure the number of calls for one line, the calls available for another line decrease.

The default specifies 4. If the phone does not allow multiple calls for each line, the default specifies 2.

For CTI route points, you can configure up to 10,000 calls for each port. The default specifies 5000 calls.

Use this field in conjunction with the Busy Trigger field.

Busy Trigger

This setting, which works in conjunction with Maximum Number of Calls and Call Forward Busy, determines the maximum number of calls to be presented at the line. If maximum number of calls is set for 50 and the busy trigger is set to 40, then incoming call 41 gets rejected with a busy cause (and will get forwarded if Call Forward Busy is set). If this line is shared, all the lines must be busy before incoming calls get rejected.

Use this field in conjunction with Maximum Number of Calls for CTI route points. The default specifies 4500 calls.

Message Waiting Lamp Policy

Use this field to configure the handset lamp illumination policy. Choose one of the following options:

Use System Policy (The directory number refers to the service parameter "Message Waiting Lamp Policy" setting.)

Light and Prompt

Prompt Only

Light Only

None

Setting applies only to the current device unless you check the check box at right (called Update Shared Device Settings) and click the Propagate selected button. (The check box at right displays only if other devices share this directory number.)

Ring Setting (Phone Idle)

Choose the ring setting for the line appearance when an incoming call is received and no other active calls exist on that device. Choose one of the following options:

Use system default

Disable

Flash only

Ring once

Ring

Ring Setting (Phone Active)

Choose the ring setting that is used when this phone has another active call on a different line. Choose one of the following options:

Use system default

Disable

Flash only

Ring once

Ring

Beep only

Forwarded Call Information Display for this Device

Caller Name

Check this check box to include the caller's name in the display when a forwarded call is received. Default leaves this check box checked.

Redirected Number

Check this check box to include the redirected number in the display when receiving a forwarded call.

Caller Number

Check this check box to include the caller's number in the display when receiving a forwarded call.

Dialed Number

Check this check box to include the dialed number in the display when a forwarded call is received. The default setting leaves this check box checked.



Note To complete the procedure, go to the "Adding or Updating Lines in a BAT Template" section


Related Topics

Adding or Updating IP Services in a BAT Template

Adding or Updating Speed Dials in a BAT Template

Adding Phones

Using the BAT Spreadsheet to Create a CSV Data File for Phones

When you are adding new phones or IP telephony devices to the system, you can use the Microsoft Excel spreadsheet that was designed to use with BAT. The spreadsheet has macros that automatically adjust the options for the selected devices. You can define the file format within the spreadsheet, and the BAT spreadsheet uses the data file formats to display the fields for the CSV data file.

Use the following procedure to create the CSV data file by using the BAT spreadsheet for adding new phones and other IP telephony devices.

For information about installing and using the BAT spreadsheet, see the "Using the BAT Spreadsheet for Gathering Data" section on page 1-11.

Procedure


Step 1 To open the BAT spreadsheet, locate and double-click the BAT.xlt file

Step 2 When prompted, click Enable Macros to use the spreadsheet capabilities.

Step 3 To display the phones options, click the Phones tab at the bottom of the spreadsheet.

Step 4 Choose a radio button for one of the following device types:

Phones

CTI Port

H.323 Client

VGC Virtual Phone

VGC Phone

The spreadsheet displays options that are available for the chosen device. For example, when you choose Phones, fields for the number of phone lines and the number of speed dials display.


Note The device type that you select determines the validation criteria for data in the BAT spreadsheet.


Step 5 To choose the device and line fields that you can define for each phone, click Create File Format. The Field Selection popup window displays.

Step 6 To choose the device fields, click a device field name in the Device Field box, and then click the arrow to move the field to the Selected Device Fields box.

A CSV data file must include Number of Lines as the first field, MAC Address/Device Name, and Description; therefore, these fields always remain selected.


Tip You can select a range of items in the list by holding down the Shift key. To select random field names, hold down the Ctrl key and click field names.


Step 7 Click a line field name in the Line Field box and click the arrow to move the field to the Selected Line Fields box.


Tip You can change the order of the items except the first field, Number of Lines, in the Selected Line and Device boxes. Choose an item and use the up arrow to move the field closer to the beginning of the list, or the down arrow to move the item to the end of the list.


Step 8 Click Create to modify the CSV data file format. A message asks whether you want to overwrite the existing CSV format.

Step 9 Click OK. New columns for the selected fields display in the BAT spreadsheet in the order that you specified.

Step 10 Scroll to the right to locate the Number of Phone Lines box. The number of lines that you specify here must not exceed the number of lines that are configured in the BAT template.


Note When you insert a CSV data file, the number of lines on phones must not exceed the number of lines in the BAT phone template, or you receive an error.


Step 11 For phones, VGC phones, and VGC virtual phones, you must enter the number of speed-dial buttons in the Number of Speed Dials box. After you enter the number, columns display for each speed-dial number.


Note When you insert the data records, do not exceed the number of speed dials that are configured in the BAT template, or an error will result when the CSV data file and BAT phone template are inserted.


Step 12 Enter data for an individual phone on each line in the spreadsheet. 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. Table 3-3 describes all the phone fields in the BAT spreadsheet.

Step 13 If you did not enter the MAC address for each phone, check the Create Dummy MAC Address check box.

When you choose the dummy MAC address option, you can update the phones later with the correct MAC address by manually entering this information into Cisco CallManager Administration or by using the TAPS tool. See the "Introducing TAPS" section on page 12-2 for more information about TAPS.


Note If you are adding CTI ports, the dummy MAC address option gives a unique device name to each CTI port in the form of the dummy MAC addresses.
Do not use the dummy MAC address option for H.323 clients, VGC phones, or VGC virtual phones.


Step 14 To transfer the data from the BAT Excel spreadsheet into a CSV formatted data file, click Export to BAT Format.

The system saves the file to C:\XLSDataFiles\ or to your choice of another existing folder on your local workstation under the following filename:

<tabname><timestamp>.txt

where <tabname> represents the type of input file that you created, such as phones, and <timestamp> represents the precise date and time that the file was created.


Note If you enter a comma in one of the fields, BAT.xlt encloses that field entry in double quotes when you export to BAT format.
If you enter a blank row in the spreadsheet, the system treats the empty row as the end of the file. The system does not convert data that is entered after a blank line to the BAT format.



Note A CSV filename with a comma (for example, abcd,e.txt) does not get created. Instead the file will exist separately as abcd.txt and e.txt and, because both do not exist, BAT will fail to insert the files. To avoid this problem, ensure the CSV file names do not contain commas.


You must copy the CSV data file to the Cisco CallManager publisher database server, so BAT can access the CSV data file. By using a floppy disk or a mapped network drive, copy the CSV data file from C:\XLSDataFiles\ (or the folder where you chose to store the file) to the C:\BATFiles\Phones\Insert\ folder on the publisher database server.



Note For information on how to read the exported CSV data file, click the link to View Sample File in the Insert Phones window in BAT.


Related Topics

Field Descriptions for Phones in the BAT Spreadsheet

Using a Text Editor to Create the CSV Data File for Phones

Inserting Phones into Cisco CallManager

Field Descriptions for Phones in the BAT Spreadsheet

Table 3-3 provides descriptions of the phone fields that are available for adding device and line details in a CSV data file.

Table 3-3 Phone Field Descriptions for the BAT Spreadsheet 

Field
Description
Device Fields (Mandatory Fields)

Number of Lines

Enter the number of lines for this phone. The number can be fewer than the number of lines in the BAT template, but it cannot exceed the specified number of lines.

MAC Address/Device Name

Enter the MAC address for phones, VGC virtual phones, and VGC phones. Enter a unique identifier (Device Name) for the CTI port or H.323 client. You can check the Create Dummy MAC Addresses check box to automatically generate unique device identifiers.

Description

Enter a description such as "Conference Room A" or "John Smith" that identifies the phone or device.

Device Fields (Optional Fields)

Location

Enter the appropriate location for this group of IP phones or ports.

The location specifies the total bandwidth that is available for calls to and from this location. A location setting of None means that the locations feature does not keep track of the bandwidth that this Cisco IP Phone consumes. Leave this field empty if you provided a location in the BAT phone template.

Device Pool

Enter the device pool for this group of phones/ports.

A device pool defines sets of common characteristics for devices, such as region, date/time group, Cisco CallManager group, and calling search space for auto-registration.

Calling Search Space

Enter the calling search space for this group of phones/ports.

A calling search space specifies the collection of Route Partitions that are searched to determine how a dialed number should be routed.

AAR Calling Search Space

Enter the appropriate calling search space for the device to use when it performs automated alternate routing (AAR). The AAR calling search space specifies the collection of route partitions that are searched to determine how to route a collected (originating) number that is otherwise blocked due to insufficient bandwidth.

Media Resource Group List

Enter the media resource group list (MRGL) for this group of phones/ports.

An MRGL specifies a list of prioritized media resource groups. An application can choose required media resources from the available ones according to the order that is defined in the MRGL.

User Hold Audio Source

Enter the user hold audio source that this group of IP phones or CTI ports should use.

The user hold audio source identifies the audio source from which music is played when a user places a call on hold.

Network Hold Audio Source

Enter the network hold audio source that this group of IP phones or CTI ports should use.

The network hold audio source identifies the audio source from which music is played when the system places a call on hold, such as when the user transfers or parks a call.

User Locale

Enter the country and language set that you want to associate with this group of IP phones.

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

Network Locale

Enter the network locale that you want to associate with this group of phones.

The Network Locale comprises a set of tones and cadences that Cisco gateways and phones use when communicating with the PSTN and other networks in a specific geographical area.

Softkey Template

Enter the softkey template to be used for all phones in this group.

Phone Load Name

Enter the custom phone load, if applicable.

Note Any value that is entered in this field overrides the default value for the chosen model.

Value does not apply for CTI ports.

E.164

Choose the E.164 address that is registered with the gatekeeper.

Note Ensure the H.323 client is configured as a gatekeeper-controlled device.

Note You must enter a value in this field for a gatekeeper-controlled H.323 client. You can enter only numbers (0-9) and special characters # and * in this field.

User ID

Enter the user ID for the phone user.

Line Fields (Optional)

Directory Number

Enter the directory number, up to 24 digits and special characters, for the phone.

Partition

Enter a route partition to which the directory number belongs.

Note The directory number can appear in more than one partition.

Line Text Label

Enter text that identifies this directory number for a line/phone combination.

Note The default language specifies English

Voice Mail Profile

Enter this parameter to make the pilot number the same as the directory number for this line. This action proves useful if you do not have a voice-messaging server that is configured for this phone.

Line Calling Search Space

Enter partitions that are searched for numbers that are called from this directory number.

Note Changes cause an update of Pickup Group Names that are listed in the Call Pickup Group field. The setting applies to all devices that use this directory number.

AAR Group

Enter the automated alternate routing (AAR) group for this device. The AAR group provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth.

Set AAR Group to <None> to prevent rerouting blocked calls.

Line User Hold Audio Source

Enter the music on hold audio source to be played when the user presses Hold and places a call on hold.

Line Network Hold Audio Source

Enter the music on hold audio source to be played when the system places a call on hold while the user transfers a call or initiates a conference or call park.

Forward All

Enter the directory number to which all calls should be forwarded. To use the BAT phone template entry, leave this field blank.

Forward Busy External

Enter the directory number to which calls coming from an external number should be forwarded when the phone is busy. To use the BAT phone template entry, leave this field blank.

Forward No Answer External

Enter the directory number to which calls coming from an external number should be forwarded when the phone is not answered. To use the BAT phone template entry, leave this field blank.

Forward No Coverage External

Enter the directory number to which calls coming from an external number should be forwarded when the phone does not have coverage. To use the BAT phone template entry, leave this field blank.

Forward Busy Internal

Enter the directory number to which calls coming from an internal number should be forwarded when the phone is busy. To use the BAT phone template entry, leave this field blank.

Forward No Answer Internal

Enter the directory number to which calls coming from an internal number should be forwarded when the phone is not answered. To use the BAT phone template entry, leave this field blank.

Forward No Coverage Internal

Enter the directory number to which calls coming from an internal number should be forwarded when the phone does not have coverage. To use the BAT phone template entry, leave this field blank.

Display

Enter the text that you want to display on the called party's phone display, such as the user name (John Smith) or phone location (Conference Room 1).

Note If this filed is left blank the system uses the value that is entered in the Directory Number field.

Note The default language specifies English.

Call Pickup Group

Choose a Pickup Group Name to specify the call pickup group, which can answer incoming calls to this directory number by dialing the appropriate pickup group number.

External Phone Number Mask

Enter the phone number (or mask) that is sent for Caller ID information when a call is placed from this line.

You can enter a maximum of 24 numbers and "X" characters. The Xs represent the directory number and must appear at the end of the pattern. For example, if you specify a mask of 972813XXXX, an external call from extension 1234 displays a caller ID number of 9728131234.

No Answer Ring Duration (CFNA)

Enter the number of seconds to allow the call to ring before forwarding the call to the Forward No Answer Destination.

Target Destination (MLPP)

Enter the number to which MLPP precedence calls should be directed if this directory number receives a precedence call and neither this number nor its call forward destination answers the precedence call.

Values can include numeric characters, pound (#) ,and asterisk (*).

Calling Search Space (MLPP)

From the drop-down list box, choose the calling search space to associate with the alternate party target (destination) number.

No Answer Ring Duration (MLPP)

Enter the number of seconds (between 4 and 30) after which an MLPP precedence call will be directed to this directory number's alternate party if this directory number and its call forwarding destination have not answered the precedence call.

Leave this setting blank to use the value that is set in the Cisco CallManager enterprise parameter, Precedence Alternate Party Timeout.

Maximum Number of Calls

You can configure up to 200 calls for a line on a device in a cluster, with the limiting factor being the device. As you configure the number of calls for one line, the calls available for another line decrease.

The default specifies 4. If the phone does not allow multiple calls for each line, the default specifies 2.

For CTI route points, you can configure up to 10,000 calls for each port. The default specifies 5000 calls. Use this field in conjunction with the Busy Trigger field.

Busy Trigger

This setting, which works in conjunction with Maximum Number of Calls and Call Forward Busy, determines the maximum number of calls to be presented at the line. If maximum number of calls is set for 50 and the busy trigger is set to 40, then incoming call 41 gets rejected with a busy cause (and will get forwarded if Call Forward Busy is set). If this line is shared, all the lines must be busy before incoming calls get rejected.

Use this field in conjunction with Maximum Number of Calls for CTI route points. The default specifies 4500 calls.

Alerting Name

This name represents the name that displays during an alert to a shared directory number. For non-shared directory numbers, during alerts, the system uses the name that is entered in the Display field.



Note To complete the procedure, go to the "Using the BAT Spreadsheet to Create a CSV Data File for Phones" section.


Using a Text Editor to Create the CSV Data File for Phones

You can create the CSV data file by using lines of ASCII text with values separated by commas. The comma separated values (CSV) file provides textual information in tabular form. For more information about text-based CSV files for phones, see the "Creating a Text-Based CSV File for Phones" section on page A-2.

Use one of these file format options to identify the device and line fields within the CSV data file:

Default Phone—Contains a predetermined set of phone device and line fields.

Simple Phone—Contains basic device and line fields for phones.

Custom—Contains device and line fields that you choose and order yourself.

You cannot modify or delete the Simple Phone or Default Phone file formats.

The following topics provide information about configuring file formats for CSV data files that are created by using a text editor.

Creating a File Format

Copying a File Format

Modifying a File Format

Deleting a File Format

Associating the File Format with the CSV Data File

Creating a Text-Based CSV File for Phones, page A-2


Note When you use the BAT spreadsheet to create the CSV data file, you can create the file format within the spreadsheet. When you use a text editor to create the CSV data file, you need to create a file format or use the simple or default file format. You enter the values in the text-based file in the same order as specified in the file format.


Creating a File Format

To create your file format for the text-based CSV data file, use the following procedure.

Procedure


Step 1 In the Create CSV data file window, below the Text Editor area, choose Add, view, or modify file formats and click Next. The File Format Configuration window displays.

Step 2 Click Add a new File Format. The File Format Information fields clear.

Step 3 In the File Format Name field, enter a name for this custom format.

Step 4 Under Device Fields, choose the device field names that you want to define for each phone. In the Device Field box, click a device field name and click the arrow to move the field to the Selected Device Fields box.

A CSV data file must include Number of Lines, MAC Address/Device Name, and Description; therefore, these fields are always selected.


Tip You can select several random field names in the list by holding down the Ctrl key, and then clicking the arrow to select them together. You can select a range of items by using the Shift key.


Step 5 Click line field names in the Line Field box and click the arrow to move the fields to the Selected Line Fields box.


Tip You can change the order of the items in the Selected Line Fields and Selected Device Fields boxes. Select an item and then use the up arrow to move the field closer to the beginning of the list or the down arrow to move it to the end of the list.


Step 6 If you want to include the fields for the speed-dial details, check the Include Speed Dials in the CSV Format check box

Step 7 To save your custom file format, click Insert. The name of the file format displays in the File Format Names list on the left.


Related Topics

Copying a File Format

Modifying a File Format

Deleting a File Format

Copying a File Format

To copy an existing format for the CSV data file, use the following procedure.

Procedure


Step 1 In the Create CSV data file window, below the Text Editor area, choose Add, view, or modify file formats and click Next. The File Format Configuration window displays.

Step 2 In the File Format Name list, choose a file format that you want to copy. The file format details display in the fields.

Step 3 To make a copy of the chosen file format, click Copy.

Step 4 In the File Format Name field, enter a new name for the copied format.

Step 5 Modify the copied format by using one of these methods:

Add new fields by choosing them from the Device Fields or Line Fields box, and then clicking the arrow to move the chosen fields into the Selected Device Field or Selected Line Fields box.

Remove selected fields by choosing them from the Selected Device Fields or Selected Line Fields box, and then clicking the arrow to move the chosen fields into the Device Field or Line Fields box.

Change the order of the fields by choosing a field name in the Selected Device Field or Selected Line Fields box and using the up or down arrow to change its location.

Step 6 After making your changes, click Insert to save the copied file format with changes in the list.


Related Topics

Creating a File Format

Modifying a File Format

Deleting a File Format

Modifying a File Format

To modify an existing file format for the CSV data file, use the following procedure. You can modify custom formats only.

Procedure


Step 1 In the Create CSV data file window, below the Text Editor area, choose Add, view, or modify file formats and click Next. The File Format Configuration window displays.

Step 2 In the File Format Name list, choose a file format that you want to modify. The file format details display in the fields.

Step 3 Modify the copied format by using one of these methods:

Add new fields by choosing them from the Device Fields or Line Fields box, then clicking the arrow to move the chosen fields into the Selected Device Field or Selected Line Fields box.

Remove fields by choosing them from the Selected Device Fields or Selected Line Fields box, then clicking the arrow to move the selected fields into the Device Field or Line Fields box. You cannot remove the required fields: Number of lines, MAC address, and description.

Change the order of the fields by choosing a field name in the Selected Device Field or Selected Line Fields box and using the up or down arrow to change its location.

Step 4 After making your changes, click Update to save the changes to the file format.


Related Topics

Creating a File Format

Copying a File Format

Deleting a File Format

Deleting a File Format

To delete an existing file format for the CSV data file, use the following procedure.You can delete only custom formats.

Procedure


Step 1 In the Create CSV data file window, below the Text Editor area, choose Add, view, or modify file formats and click Next. The File Format Configuration window displays.

Step 2 In the File Format Name list, choose a file format that you want to delete. The file format details display in the fields. Verify that this is the file that you want to delete.

Step 3 To remove the file format from the File Format Name list, click Delete. A message asks you to confirm that you want to delete the file format. Click OK to continue. The system removes the file format name from the list.


Related Topics

Creating a File Format

Copying a File Format

Modifying a File Format

Associating the File Format with the CSV Data File

When you used a text editor to create the CSV data file, you created a file format for entering values in the text-based file. You entered values in the text file in the order that the file format specified

After the CSV data file is completed, you need to associate the file format with the text-based CSV data file. After associating the file format with the CSV file, the names for each field display as the first record in the CSV data file. You can use this information to verify that you entered the values for each field in the correct order.

To add the file format with the text-based CSV data file, use the following procedure.

Procedure


Step 1 In the Create CSV data file window, below the Text Editor area, choose Associate file format with the CSV data file and click Next. The Add File Format window displays.

Step 2 In the File Name field, choose the text-based CSV file that you created for this transaction.

Step 3 In the File Format Name field, choose the file format that you created for this type of bulk transaction.

Step 4 To associate the matching file format with the CSV data file, click Add.

Step 5 To view the CSV data file with the file format as the first record, click the View File link. Check that the entered values correspond to the field names in your CSV data file.


Related Topics

Validating Phone Records

Inserting Phones into Cisco CallManager

Using a Text Editor to Create the CSV Data File for Phones

Phone CSV Data File Formats, page A-3

Validating Phone Records

When you choose Validate Phones, the system runs a validation routine to check that the CSV data file and BAT phone template have populated all required fields, such as device pool and locations. The validation also checks for discrepancies with the publisher database.

Before You Begin

You must have a BAT phone template for the devices that you are adding. You can use a master phone template with multiple lines to add phones that have a single line or several lines. See the "Master Phone Templates" section on page 1-6 for more information.

You must have a data file in comma separated variable (CSV) format that contains the unique details for the phones or other IP telephony devices.

To validate your CSV data file phone records, use the following procedure .

Procedure


Step 1 In the Steps to Insert Phones window, choose Validate Phone Records and click Next. The Validate Phones window displays.

Step 2 In the File Name field, choose the CSV data file that you created for this specific bulk transaction.

Step 3 Choose the Insert option that corresponds to your CSV data file:

Specific Details—If you are validating phone records that use a customized file format.

All Details—If you are validating phone records from an exported phones file that was generated by using the All Details option. Skip to Step 5.

Step 4 In the Phone Template Name field, choose the BAT phone template that you created for this type of bulk transaction.

Step 5 For the All Details option, you must choose the Model of IP telephony device. BAT displays only the models that are currently in the Cisco CallManager database.

Step 6 To verify the chosen CSV data file with the publisher database, click Validate. The validation routine records errors in a log file.

Step 7 When validation completes, click View Latest Log File to see a log file that lists the devices with discrepancies and the error code. For more information on log files, see the "BAT Log Files" section on page 13-1.


Related Topics

Inserting Phones into Cisco CallManager

Using BAT Phone Templates

Using the BAT Spreadsheet to Create a CSV Data File for Phones

Using a Text Editor to Create the CSV Data File for Phones

Inserting Phones into Cisco CallManager

To add phones, Cisco VGC phones, CTI ports, or H.323 clients into the Cisco CallManager database, use the following procedure.

Before You Begin

You must have a BAT phone template for the devices that you are adding.

You must have a data file in comma separated value (CSV) format that contains the unique details for the phones or other IP telephony devices.

Before you insert phones, validate the phone records.

Procedure


Step 1 In the Steps to Insert Phones window, choose Insert Phones and click Next. The Insert Phones window displays.

Step 2 In the File Name field, choose the CSV data file that you created for this specific bulk transaction.

Step 3 To enable the use of applications such as Cisco IP SoftPhone, check the Enable CTI Application Use check box (for CTI ports only).

Step 4 Choose the Insert option that corresponds to your CSV data file:

Specific Details—If you are inserting phone records that use a customized file format.

All Details—If you are inserting phone records from an exported phone file that was generated by using the All Details option. Skip to Step 6.

Step 5 In the Phone Template Name field, choose the BAT phone template that you created for this type of bulk transaction.


Note When you are inserting a file that was generated with the export utility, use the appended suffixes to guide you in choosing a phone template with the correct line configuration. The export utility appends a numerical suffix_n for each line that is configured on a phone. For example, an export file with the name "sales_7960_1_3.txt" indicates that all phone records in this file have lines 1 and 3 configured.


If you did not enter individual MAC addresses in the CSV data file, you must check the Create Dummy MAC Address check box. If you are adding CTI ports, the dummy MAC address option provides a unique device name for each CTI port in the form of dummy MAC addresses.

This field automatically generates dummy MAC addresses in the following format: XXXXXXXXXXXX
where X represents any 12-character, hexadecimal (0-9 and A-F) number.

If you do not know the MAC address of the phone that will be assigned to the user, choose this option. When the phone is plugged in, a MAC address registers for that device.

If you supplied MAC addresses or device names in the data input file, do not choose this option.

You can update the phones or devices later with the correct MAC address by manually entering this information into Cisco CallManager Administration or by using TAPS. See the "Introducing TAPS" section on page 12-2 for more information about TAPS. Skip to Step 7.

Step 6 For the All Details option, you must choose the Model of IP telephony device. BAT displays all the phone models that are currently supported in Cisco CallManager.

Step 7 Click Insert to insert phone records.

A message displays that tells you the approximate time that is required to insert the records into the Cisco CallManager database. You can cancel if the transaction might cause performance degradation.

Step 8 To insert the phones, click OK or to cancel the transaction, click Cancel.

If you clicked OK, a Transaction Status window displays. To see the transaction in progress, click the Show Latest Status button.


Note If any line information for a phone record fails, BAT does not insert that phone record.


Step 9 When the transaction completes, click View Latest Log File to see a log file that shows the number of records that were added and the number of records that failed, including an error code. For more information on log files, see "BAT Log Files" section on page 13-1.


Related Topics

Using BAT Phone Templates

Using the BAT Spreadsheet to Create a CSV Data File for Phones

Validating Phone Records

Using Phone Export

Introducing TAPS, page 12-2

Updating Phones

To update phone settings, such as changing or adding the device pool or calling search space for a group of similar phones, use the Update Phones option. You can locate the existing phone records by these two methods:

Using Query to Update Phones

Using a Custom File to Update Phones

Using Query to Update Phones

To create a query to locate phones to update, use the following procedure.

Procedure


Step 1 Choose Update Phones and click Next. The Update Phones Options window displays.

Step 2 Choose Use query and click Next. The Update Phones (Step 1 of 2) window displays.


Note You can update all phones by not specifying a query. Skip to the "Choosing the Update Parameters" section.


Step 3 In Select Phones to Query drop-down list box, choose the field to query, such as Model or Directory Number.

Step 4 In the second drop-down list box, choose the search criteria, such as begins with, contains, or is empty.

Step 5 In the search field list box, choose or enter the value that you want to locate. For example, you can choose the model name from the list, or enter a range of directory numbers.

Step 6 To add the defined filter to the query, click Add To Query.

Step 7 You can click AND or OR to add multiple filters and repeat Step 3 through Step 6 to further define your query.


Note You cannot perform multiple queries when Directory Number is used in the first drop-down list box; that is, AND or OR do not act as valid operators with Directory Number.


Step 8 Click View Query Results to check that the query includes the information that you need.

If you make a mistake, click the Clear Query button to remove the query; then, return to Step 3 and restart.


To complete the procedure for updating phones, continue to the "Choosing the Update Parameters" section.

Using a Custom File to Update Phones

To create a custom file to search for phones to update, use the following procedure.

Before You Begin

1. Identify the devices that you need to update.

2. Create a text file that lists one of these options on a separate line

MAC addresses and device names

Directory numbers


Note You can have MAC addresses and device names in the same custom file, but directory numbers must be in a separate custom file.


3. Save the text file in the C:\BATfiles\Phones\Query\Update\ folder with a unique name.

To update phones by using a list of phones in a custom file, use the following procedure.

Procedure


Step 1 Choose Update Phones and click Next. The Update Phones Options window displays.

Step 2 Choose Use a custom file and click Next. The Update Phones (Step 1 of 2) window displays.

Step 3 In the Select phones where drop down list box, choose the type of custom file that you have created: Device Name (includes MAC addresses) or Directory Number.

Step 4 In the list of custom files, choose the filename of the custom file for this update. The type of custom file displays with the file name under View Query Result.

Step 5 To test the custom file. A message displays the query results from using this custom file, you can click View Query Result.

If the query results are not what you expected, you can change the custom file selections.


To complete the procedure for updating phones, continue to the "Choosing the Update Parameters" section.

Choosing the Update Parameters

After you have defined the query or custom file to search for phones, use this procedure to choose parameters and define values for updating phones.

Procedure


Step 1 In the Update Phones window, click Next. The Update Phones (Step 2 of 2) window displays and shows the type of query that you chose. If you want to change the type of query, click Back.

Step 2 Specify the setting that you want to update for all the records that you have defined in your query or custom file. You can choose multiple parameters to update. See the "Field Descriptions for Updating Phones" section for descriptions of parameters.

Step 3 In the Value field for the checked parameter, enter the new value or choose a value from the list box.

Step 4 In the Reset/Restart Phones area, check one of the following choices:

Don't Reset/Restart devices—To reset/restart devices at a later time.

Reset devices—To reset (power-cycle) the phones

Restart devices—To reset phones without power-cycling

Step 5 To apply the updates to the records, click Update.

A message displays that tells you the approximate time required to update the records in the Cisco CallManager database. You can cancel if the transaction might cause performance degradation.

Step 6 To update the phones, click OK or to cancel the transaction, click Cancel.

If you clicked OK, a Transaction Status window displays. To see the transaction in progress, click the Show Latest Status button .


Note If any line information for a phone record fails, BAT does not update that phone record.


Step 7 When the transaction completes, click View Latest Log File to see a log file that shows the number of records that were changed and the number of records that failed, including an error code. For more information on log files, see "BAT Log Files" section on page 13-1


Related Topics

Adding Lines to Existing Phones and UDPs

Updating Lines

Adding Phones

Deleting Phones

Resetting or Restarting Phones

Field Descriptions for Updating Phones

Table 3-4 provides descriptions for all possible fields that display when you are updating phones. Some device types do not require all the phone settings.

Values that appear in some fields display from Cisco CallManager. You must configure these values by using Cisco CallManager Administration.

Table 3-4 Field Descriptions for Update Phones 

Field
Description

Description

Enter a description that makes the device easy to recognize.

Phone Load Name

Enter the custom phone load, if applicable.

Note Any value that is entered in this field overrides the default value for the chosen model and specifies the custom software for a Cisco IP Phone.

Device Pool

Choose the device pool to which this group of phones/ports should belong.

A device pool defines sets of common characteristics for devices, such as region, date/time group, Cisco CallManager group, and calling search space for auto-registration.

Calling Search Space

Choose the calling search space to which this group of phones/ports should belong.

A calling search space specifies the collection of route partitions that are searched to determine how a dialed number should be routed.

Location

Choose the location to which this group of phones/ports should belong.

A location indicates the remote location that is accessed by using restricted bandwidth connections.

Information

Enter the help text URL for the information button .

Directory

Enter the URL of the directory server.

Messages

Enter the voice-messaging access pilot number.

Services

Enter the URL for the services menu.

Authentication Server

Enter the URL that the phone uses to validate requests that are made to the phones web server. If you do not provide an authentication URL, the advanced features on Cisco IP Phones that require authentication will not function. Leave this field blank to accept the default setting.

By default, this URL accesses a Cisco IP Phone User Options window that was configured during installation.

Proxy Server

Enter the host and port (for example, proxy.cisco.com:80) that are used to proxy HTTP requests for access to non-local host addresses from the phones HTTP client.

If the phone receives a URL such as www.cisco.com in a service and the phone is not configured in the cisco.com domain, the phone uses the proxy server to access the URL. If the phone is configured in the cisco.com domain, the phone accesses the URL without using the proxy because it is in the same domain as the URL.

Leave this field blank to accept the default setting.

Idle

Enter the URL to display on the Cisco IP Phone window when the phone has not been used for the time that is specified in the Idle Time field. For example, you can display a logo on the window when the phone has not been used for 5 minutes. Leave this field blank to use the default value.

Idle Timer

Enter the seconds that you want to elapse before the phone displays the URL that is specified in the Idle field. Leave this field blank to use the default value.

User Hold Audio Source

Choose the user-hold audio source for this group of phones or ports.

The user-hold audio source plays music when a user places a call on hold.

Network Hold Audio Source

Choose the network hold audio source that this group of IP phones or CTI ports should use.

The network-hold audio source plays music when the system places a call on hold, such as when the user transfers or parks a call.

Media Resource Group List

Choose the media resource group list (MRGL) to which this group of phones/ports should belong.

An MRGL specifies a list of prioritized media resource groups. An application can choose required media resources among the available ones according to the priority order that is defined in the MRGL.

Extension Mobility

Choose 0-Off if you want to disable this feature or choose 1-On to enable this feature.

Extension mobility allows a user to log in and out of a Cisco IP Phone. Refer to the Cisco CallManager Features and Services Guide for more information about extension mobility.

User Locale

Choose the country and language set that you want to associate with this user.

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

Network Locale

Choose the network locale that you want to associate with this user.

The Network Locale comprises a set of tones and cadences that Cisco gateways and phones use when they are communicating with the PSTN and other networks in a specific geographical area.

IP Services1

Use Cisco CallManager Administration to choose any services that have been configured.

IP Services2

Use Cisco CallManager Administration to choose any services that have been configured.

Note Using BAT, you cannot update more than 2 IP services in one transaction.

MLPP Indication

If available, this setting specifies whether a device that is capable of playing precedence tones will use the capability when it places an MLPP precedence call.

From the drop-down list box, choose a setting to assign to this device from the following options:

Default—This device inherits its MLPP indication setting from its device pool.

Off—This device does not send indication of an MLPP precedence call.

On—This device does send indication of an MLPP precedence call.

Note Do not configure a device with the following combination of settings: MLPP Indication is set to Off while MLPP Preemption is set to Forceful.

MLPP Preemption

If available, this setting specifies whether a device that is capable of preempting calls in progress will use the capability when it places an MLPP precedence call.

From the drop-down list box, choose a setting to assign to this device from the following options:

Default—This device inherits its MLPP preemption setting from its device pool.

Disabled—This device does not preempt calls in progress when it places an MLPP precedence call.

Forceful—This device preempts calls in progress when it places an MLPP precedence call.

Note Do not configure a device with the following combination of settings: MLPP Indication is set to Off while MLPP Preemption is set to Forceful.

MLPP Domain (e.g., "0000FF")

Enter a hexadecimal value for the MLPP domain associated with this device. Must be blank or a value between 0 and FFFFFF.

AAR Calling Search Space

Choose the appropriate calling search space for the device to use when it performs automated alternate routing (AAR). The AAR calling search space specifies the collection of route partitions that are searched to determine how to route a collected (originating) number that is otherwise blocked due to insufficient bandwidth.

Device Security Mode

From the drop-down list box, choose the mode that you want to set for the device:

Use System Default—The phone uses the value that you specified for the enterprise parameter, Device Security Mode.

Non-secure—No security features exist for the phone. A TCP connection opens to Cisco CallManager.

Authenticated—Cisco CallManager provides integrity and authentication for the phone. A TLS connection that uses NULL/SHA opens.

Encrypted—Cisco CallManager provides integrity, authentication, and encryption for the phone. A TLS connection that uses AES128/SHA opens

Note This field applies only if the phone model supports authentication or encryption.

Ignore Presentation Indicators

Check this check box if the system must ignore presentation indicators.

Remove Duplicate IP Services from all Phones and Device Profiles

Check this check box to remove duplicate IP Phone Services. If you check this check box, the system removes the duplicate service subscriptions from phones and User Device Profiles. The IP system deletes Services based on the IP Service name.

Disable Speakerphone

Check this check box to disable the speakerphone.

Disable Speakerphone and Headset

Check this check box to disable the speakerphone and headset

Forwarding Delay

Use this field to enable or disable forwarding delay. Choose enable when you want the port to wait a few seconds before forwarding a call.

PC Port

Use this field to enable or disable the PC port on phones that have internal switches. Users can connect a PC or workstation to the phone by using the port labeled "10/100 PC" on the back of the phone.

Setting Access

Use this field to choose whether the user has access to phone settings. The options include Enabled and Disable.

Gratuitous ARP

Choose Enabled or Disabled to control gratuitous ARP.

PC Voice VLAN Access

Choose Enabled or Disabled to control access to a PC voice VLAN.

Video Capabilities

Choose Enabled or Disabled to control video capabilities access.

Auto Line Select

Choose Enabled or Disabled to allow automatic line selection on the phone.

Web Access

Choose Enabled or Disabled to allow web access on the phone.



Note To complete the procedure, go to "Choosing the Update Parameters" section.


Updating Lines

To update line attributes for a specific group of devices or user device profiles, use the Update Lines option. Lines for a phone and a user device profile get updated at the same time when both are part of the query result.


Note When a phone is deleted from the Cisco CallManager database, the directory number remains in the database. To manage these orphan directory numbers, you can use the Update Lines option to search for unassigned directory numbers and delete or update these directory numbers.


To update lines, use the following procedure.

Procedure


Step 1 Choose Update Lines and click Next. The Update Lines (Step 1 of 2) window displays.


Note You can update all lines by not specifying a query. Skip to the "Field Descriptions for Updating Lines" section.


Step 2 In the Select lines where drop-down list box, choose the field to query such as Directory Number, Line Partition, or Unassigned DN.


Note To locate and delete orphaned directory numbers, use "unassigned DN."


Step 3 In the second drop-down list box, choose the search criteria such as begins with, contains, or is empty.

Step 4 In the search field list box, choose or enter the value that you want to locate. For example, you can choose the Line Partition from the list or enter a range of directory numbers.

Step 5 To add the defined filter to the query, click Add To Query.

Step 6 To further define your query, you can click AND or OR to add multiple filters and repeat Step 2 through Step 5.


Note You cannot perform multiple queries when Directory Number is used in the first drop-down list box, because AND or OR do not act as valid operators with Directory Number.


Step 7 To display the records that are going to be affected, click View Query Result.

Step 8 Click Next. The Update Lines (Step 2 of 2) window displays and shows the type of query that you chose at the top. If you want to change the type of query, click Back.

Step 9 Specify the setting that you want to update for all the records that you have defined in your query. You can choose multiple parameters to update. See the "Field Descriptions for Updating Lines" section for descriptions of the parameters.

Step 10 In the Value field for the checked parameter, enter the new value or choose a value from the list box.

Step 11 To apply the updates to the records, click Update.

A message displays that tells you the approximate time that is required to update the records in the Cisco CallManager database. You can cancel if the transaction might cause performance degradation.

Step 12 To update the phones, click OK or to cancel the transaction, click Cancel.

If you clicked OK, a Transaction Status window displays. To see the transaction in progress, click the Show Latest Status button.


Note If any information for a line record fails, BAT does not update that line record.


Step 13 When the transaction completes, Click View Latest Log File to see a log file that shows the number of records that were changed and the number of records that failed, including an error code. For more information on log files, see the "BAT Log Files" section on page 13-1.


Related Topics

Field Descriptions for Updating Lines

Adding Phones, page 3-2

Updating Phones

Deleting Phones

Resetting or Restarting Phones

Field Descriptions for Updating Lines

Table 3-5 provides the field descriptions for updating line details.

Values that display in some fields display from Cisco CallManager. You must configure these values by using Cisco CallManager Administration.

Table 3-5 Field Descriptions for Updating Line Details 

Field
Description

Line Partition

Choose a partition. A partition indicates the route partition to which the directory number belongs.

Note The directory number can appear in more than one partition.

Calling Search Space (Line)

Choose the partitions that are searched for numbers that are called from this directory number.

Note Changes cause an update of the Pickup Group Names that are listed in the Call Pickup Group field. The setting applies to all devices that are using this directory number.

Calling Search Space Forward All

Choose the calling search space to use when a call is forwarded to the specified destination.

Note This setting applies to all devices that are using this directory number.

Forward All Destination

Enter the directory number to which all calls are forwarded.

Note This setting applies to any dialable phone number, including an outside destination unless restricted, and to all devices that are using this directory number.

Forward All to Voice Mail

Check this check box to forward all calls to the number that you chose in the voice-messaging profile.

Checking this check box makes the values in the Forward All Destination field and Calling Search Space check box not relevant.

Calling Search Space Forward Busy External

Choose the calling search space to use when a call from an external number is forwarded to the specified destination.

Note This setting applies to all devices that are using this directory number.

Calling Search Space Forward Busy Internal

Choose the calling search space to use when a call from an internal number is forwarded to the specified destination.

Note This setting applies to all devices that are using this directory number.

Forward Busy Destination External

Enter the directory number to which a call that is coming from an external number is forwarded when the line is in use.

Note This setting applies to any dialable phone number, including an outside destination unless restricted, and to all devices that are using this directory number.

Forward Busy Destination Internal

Enter the directory number to which a call that is coming from an internal number is forwarded when the line is in use.

Note This setting applies to any dialable phone number, including an outside destination unless restricted, and to all devices that are using this directory number.

Forward Busy to Voice Mail External

Check this check box to forward calls from an external number to the number that you chose in the voice-messaging profile when the line is in use.

Checking this check box makes the values in the Forward Busy Destination field and Calling Search Space check box not relevant.

Forward Busy to Voice Mail Internal

Check this check box to forward calls from an internal number to the number that you chose in the voice-messaging profile when the line is in use.

Checking this check box makes the values in the Forward Busy Destination field and Calling Search Space check box are not relevant.

Calling Search Space Forward No Answer External

Choose the calling search space to use when a call from an external number is forwarded to the specified destination. The setting displays only if it is configured in the system.

Note This setting applies to all devices that are using this directory number.

Calling Search Space Forward No Answer Internal

Choose the calling search space to use a call from an internal number is forwarded to the specified destination. The setting displays only if it is configured in the system.

Note This setting applies to all devices that are using this directory number.

Forward No Answer Destination External

Enter the directory number to which a call that is coming from an external number is forwarded when the phone is not answered.

Note This setting applies to any dialable phone number, including an outside destination unless restricted, and to all devices that are using this directory number.

Forward No Answer Destination Internal

Enter the directory number to which a call that is coming from an internal number is forwarded when the phone is not answered.

Note This setting applies to any dialable phone number, including an outside destination unless restricted, and to all devices that are using this directory number.

Forward No Answer to Voice Mail External

Check this check box to forward unanswered calls from an external number to the number that you chose in the voice-messaging profile.

Checking this check box makes the values in the Forward No Answer Destination field and Calling Search Space check box are not relevant.

Forward No Answer to Voice Mail Internal

Check this check box to forward unanswered calls from an internal number to the number that you chose in the voice-messaging profile.

Checking this check box makes the values in the Forward No Answer Destination field and Calling Search Space check box are not relevant.

Calling Search Space Forward No Coverage External

Choose the calling search space to use when a call from an external number is forwarded to the specified destination. The setting displays only if it is configured in the system.

Note This setting applies to all devices that are using this directory number.

Calling Search Space Forward No Coverage Internal

Choose the calling search space to use when a call from an internal number is forwarded to the specified destination. The setting displays only if it is configured in the system.

Note This setting applies to all devices that are using this directory number.

Forward No Coverage Destination External

Enter the directory number to which a call that is coming from an external number is forwarded when the phone does not have coverage.

Note This setting applies to any dialable phone number, including an outside destination unless restricted, and to all devices that are using this directory number.

Forward No Coverage Destination Internal

Enter the directory number to which a call that is coming from an internal number is forwarded when the phone does not have coverage.

Note This setting applies to any dialable phone number, including an outside destination unless restricted, and to all devices that are using this directory number.

Forward No Coverage to Voice Mail External

Check this check box to forward calls from an external number to the number that you chose in the voice-messaging profile when the phone does not have coverage.

Checking this check box makes the values in the Forward No Answer Destination field and Calling Search Space check box are not relevant.

Forward No Coverage to Voice Mail Internal

Check this check box to forward calls from an external number to the number that you chose in the voice-messaging profile when the phone does not have coverage.

Checking this check box makes the values in the Forward No Answer Destination field and Calling Search Space check box are not relevant.

Calling Search Space Forward on Failure External/Internal

(CTI ports only) Choose the calling search space to use when a call from an internal or external call is forwarded to the specified destination. The setting appears only if it is configured in the system.

Note This setting applies to all devices that are using this directory number.

Forward on Failure Destination External/Internal

(CTI ports only) Enter the directory number to which a call coming from an internal or an external number should be forwarded when a phone or CTI application fails.

Forward on Failure to Voice Mail External/Internal

(CTI ports only) Check this check box to forward failed calls from external or internal numbers to the number that you chose in the voice-messaging profile.

Call Forward No Answer Ring Duration

Enter the number of seconds (between 1 and 300) to allow the call to ring, before forwarding the call to the destination number entered in the Forward No Answer Destination field.

Note Leave this field blank to use the value that is set in the Cisco CallManager service parameter, Forward No Answer Timer.

User Hold Audio Source

Choose the music on hold audio source that plays when the user presses the Hold button or softkey to put a call on hold.

Network Hold Audio Source

Choose the music on hold audio source that plays when the system places a call on hold such as when user transfers a call or initiates a conference or call park.

Auto Answer

Choose this parameter if you want all lines that are updated here to use the auto answer feature. With auto answer, Cisco CallManager automatically answers calls when a headset is in use. A zip tone plays to alert the user that an incoming call connected.

Voice Mail Profile

Choose this parameter to make the pilot number the same as the directory number for this line. This choice proves useful if you do not have a voice-messaging server that is configured for this phone.

Ring Setting When Idle

Choose the type of ring for an incoming call on a phone.

Ring Setting when Active

Choose the type of ring for an incoming call on a phone, which is used when this phone has another active call on a different line.

Call Pickup Group Name

Choose a Pickup Group Name to specify the call pickup group, which can answer incoming calls to this directory number by dialing the appropriate pickup group number.

AAR Group

Choose the automated alternate routing (AAR) group for this device. The AAR group provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth.

Set AAR Group to <None> to prevent rerouting blocked calls.

Target (Destination) MLPP

Enter the number to which MLPP precedence calls should be directed if this directory number receives a precedence call and neither this number nor its call forward destination answers the precedence call.

Values can include numeric characters, pound(#), and asterisk (*).

MLPP Calling Search Space

From the drop-down list box, choose the calling search space to associate with the alternate party target (destination) number.

MLPP No Answer Ring Duration

Enter the number of seconds (between 4 and 30) after which an MLPP precedence call will be directed to this directory number's alternate party if this directory number and its call forwarding destination have not answered the precedence call.

Leave this setting blank to use the value that is set in the Cisco CallManager enterprise parameter, Precedence Alternate Party Timeout.

External Phone Number Mask

Enter the phone number (or mask) that is sent for Caller ID information when a call is placed from this line.

You can enter a maximum of 30 numbers and "X" characters. The Xs represent the directory number and must appear at the end of the pattern. For example, if you specify a mask of 972813XXXX, an external call from extension 1234 displays a caller ID number of 9728131234.

Maximum Number of Calls

You can configure up to 184 calls for a line on a device in a cluster, with the limiting factor being the device. As you configure the number of calls for one line, the calls available for another line decrease.

The default specifies 4. If the phone does not allow multiple calls for each line, the default specifies 2.

For CTI route points, you can configure up to 10,000 calls for each port. The default specifies 5000 calls.

Use this field in conjunction with the Busy Trigger field.

Busy Trigger

This setting, which works in conjunction with Maximum Number of Calls and Call Forward Busy, determines the maximum number of calls to be presented at the line. If maximum number of calls is set for 50 and the busy trigger is set to 40, then incoming call 41 gets rejected with a busy cause (and will get forwarded if Call Forward Busy is set). If this line is shared, all the lines must be busy before incoming calls get rejected.

Use this field in conjunction with Maximum Number of Calls for CTI route points. The default specifies 4500 calls.



Note To complete the procedure, go to the "Updating Lines" section.


Adding Lines to Existing Phones and UDPs

You can add lines to a group of existing phones or user device profiles in the Cisco CallManager database. When you use the template to add new lines, you cannot change phone services or speed dials. BAT ignores those fields on the template when you add lines to existing devices.

To add lines to existing phones or user device profiles, use the following procedure.

Before You Begin

You must have a BAT template for this transaction. See the "Adding or Updating Lines in a BAT Template" section.

You must have a CSV data file for this transaction. See the "Using the BAT Spreadsheet to Add Lines to Existing Phones" section for information.

Procedure


Step 1 Choose Add Lines and click Next. The Steps to Add Lines window displays.

Step 2 If you need to create a new template or modify an existing one for this transaction, choose Add, View, or Modify Phone Template.

Step 3 Choose Add Lines to existing phones or device profiles. The Add Lines window displays.

Step 4 In the File Name field, choose the CSV data file that you created for this bulk transaction.

Step 5 If you are changing the phone settings for existing phones in the template, check the Override the existing configuration check box. The user device profile information also gets updated when this check box is checked.

Step 6 In the Select Templates area, choose one of the following options:

To add lines to phones, choose Phone Template.

In the Template Name field, choose the BAT phone template to use for this bulk transaction.

To add lines to a User Device Profile, choose User Device Profile Template.

In the Template Name field, choose the User Device Profile template to use for this bulk transaction.

Step 7 Click Add. A message displays that advises you of approximately how long it will take to add the records to the Cisco CallManager database. You can cancel the transaction if you feel that it may cause performance degradation.

Step 8 When the transaction completes, check the Status message. BAT displays a status completed or failed message.

Step 9 To display the log file that BAT generated, you can click the View Latest Log File link. The log file displays the number of lines that were successfully added. For more information on log files, see the "BAT Log Files" section on page 13-1.


Related Topics

Using the BAT Spreadsheet to Add Lines to Existing Phones

Field Descriptions for Adding Lines By Using the BAT Spreadsheet

Updating Lines

Using the BAT Spreadsheet to Add Lines to Existing Phones

To create the CSV data file by using the BAT spreadsheet for adding lines to existing phones, use the following procedure.

For information about installing and using the BAT spreadsheet, see the "Using the BAT Spreadsheet for Gathering Data" section on page 1-11.

Procedure


Step 1 To open the BAT Spreadsheet, locate and double-click the BAT.xlt file.

Step 2 When prompted, click Enable Macros to use the spreadsheet capabilities.

Step 3 To display the fields, click the Add Lines tab at the bottom of the spreadsheet.

Step 4 Enter data for an individual phone on each line in the spreadsheet. 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. Table 3-6 describes the fields for adding lines in the BAT spreadsheet.

Step 5 To transfer the data from the BAT Excel spreadsheet into a CSV formatted data file, click Export to BAT Format.

The system saves the file to C:\XLSDataFiles\ or you can use Browse to save your file in another existing folder on your local workstation. The filename is

<tabname>#<timestamp>.txt

where <tabname> represents the type of input file that you created, such as phones, and <timestamp> represents the precise date and time that the file was created.


Note If you enter a comma in one of the fields, BAT.xlt encloses that field entry in double quotes when you export to BAT format.

If you enter a blank row in the spreadsheet, the system treats the empty row as the end of the file. The system does not convert data that is entered after a blank line to the BAT format.


You must copy the CSV data file to the Cisco CallManager publisher database server so BAT can access the CSV data file

Step 6 Using a floppy disk or a mapped network drive, copy the CSV data file from C:\XLSDataFiles\ (or the folder that you chose to store the file) to the C:\BATFiles\AddLines folder on the publisher database server:



Note For information on how to read the exported CSV data file, click the link to View Sample File in the Insert Phones window in BAT.


Related Topics

Using BAT Phone Templates

Updating Lines

Updating Phones

Field Descriptions for Adding Lines By Using the BAT Spreadsheet

Table 3-6 provides the field descriptions when you are adding lines by using the BAT spreadsheet.

Table 3-6 Field Descriptions for Adding Lines by Using the BAT Spreadsheet

Field
Description

MAC Address

Enter the MAC address for phones, VGC virtual phones, and VGC phones. Enter a unique identifier for CTI ports and H.323 clients.

Line Index

Enter a number between 1 and 34 for the line index of a phone.

Directory Number

Enter a directory number, up to 24 numerals and special characters, for this line.

Display

Enter the text that you want to display on the called party's phone display, such as the user name (John Smith) or phone location (Conference Room 1).

Note If this filed is left blank the system uses the value that is entered in the Directory Number field.

Note The default language specifies English.

Line Text Label

Enter text that identifies this directory number for a line/phone combination.

Note The default language specifies English

Forward Busy External

Enter the directory number to which a call that is coming from an external number is forwarded when the line is in use.

Note This setting applies to any dialable phone number, including an outside destination unless restricted, and to all devices that are using this directory number.

Forward No Answer External

Enter the directory number to which a call that is coming from an external number is forwarded when the phone is not answered.

Note This setting applies to any dialable phone number, including an outside destination unless restricted, and to all devices that are using this directory number.

Forward No Coverage External

Enter the directory number to which a call that is coming from an external number is forwarded when the phone does not have coverage.

Note This setting applies to any dialable phone number, including an outside destination unless restricted, and to all devices that are using this directory number.

Forward Busy Internal

Enter the directory number to which a call that is coming from an internal number is forwarded when the line is in use.

Note This setting applies to any dialable phone number, including an outside destination unless restricted, and to all devices that are using this directory number.

Forward No Answer Internal

Enter the directory number to which a call that is coming from an internal number is forwarded when the phone is not answered.

Note This setting applies to any dialable phone number, including an outside destination unless restricted, and to all devices that are using this directory number.

Forward No Coverage Internal

Enter the directory number to which a call that is coming from an internal number is forwarded when the phone does not have coverage.

Note This setting applies to any dialable phone number, including an outside destination unless restricted, and to all devices that are using this directory number.

Call Pickup Group

Enter a Pickup Group Name to specify the call pickup group, which can answer incoming calls to this line by dialing the appropriate pickup group number.


Deleting Phones

To delete a group of phones or other IP telephony devices from the Cisco CallManager database, use these procedures.

To access the Delete option, choose Configure > Phones. In the Phone Options window, choose Delete Phones and click Next. You can locate existing phone records by these two methods:

Using Query to Delete Phones.

Using a Custom File to Delete Phones

Using Query to Delete Phones

To delete phones by creating a query to locate the phone records, use the following procedure.

Procedure


Step 1 In the Delete Phones Options window, choose Use query and click Next. The Delete Phones window displays.


Caution If you do not specify a query, you will delete all phones.

Step 2 In Select Phones to Query drop-down list box, choose the field to query such as Model or Directory Number.


Note If you choose Unasssigned DN in the Select Phones to Query drop-down list box, then the selected unassigned Directory Numbers will be deleted.


Step 3 In the second drop-down list box, choose the search criteria such as begins with, contains, or is empty.

Step 4 In the search field list box, choose or enter the value that you want to locate, such as the model name from the list or directory number range.

Step 5 To add the defined filter to the query, click Add To Query.

Step 6 To add multiple filters, you can click AND or OR and to further define your query, repeat Step 2 through Step 5.


Note You cannot perform multiple queries when Directory Number or Unassigned DN is used in the first drop-down list box; that is, AND or OR do not act as valid operators with Directory Number.


Step 7 To check that the query gives the results that you need, click View Query Results.


Note Ensure that you have located the correct phones to delete. Because the delete action is final, you cannot retrieve deleted records.


If you make a mistake, click the Clear Query button to remove the query; then, return to Step 2 and restart.


Caution If you do not enter any information in the query text box, the system deletes all phone records. Because the delete action is final, you cannot retrieve deleted records.

Step 8 To delete the records, click Delete.

Step 9 A message displays that advises you of approximately how long it will take to delete the records from the Cisco CallManager database. You can cancel the transaction or click OK to continue.

Step 10 To display the log file that BAT generated, you can click the View Latest Log File link. The log file displays the number of phones that were deleted and the number of records that failed, including an error code. For more information on log files, see the "BAT Log Files" section on page 13-1.


Related Topics

Using a Custom File to Delete Phones

Adding Phones

Updating Phones

Updating Lines

Using a Custom File to Delete Phones

You can create a custom file of phones that you want to delete by using a text editor. You can have MAC addresses and device names in the same custom file, but you cannot have directory numbers in the same file. You need to create separate files—one file that contains the device names and MAC addresses and another file that contains the directory numbers.


Note You cannot delete phones with shared lines by using a custom file.


Before You Begin

1. Create a text file that lists one of these details for the phones that you want to delete:

Device names and MAC addresses

Directory numbers

2. Put each item on a separate line in the text file.

3. Save the custom file with a <filename.txt> to this folder: C:\BATfiles\Phones\Query\Delete\

To delete phones that are listed in a custom file, use the following procedure.

Procedure


Step 1 In the Delete Phones Options window, choose Use a custom file and click Next. The Delete Phones window displays.

Step 2 In Select Phones where drop-down list box, choose the field that you used in the custom file, either Device Name or Directory Number.

Step 3 In the Custom file where drop-down list box, choose the filename for the custom file.

Step 4 To check that the query includes the information that you need, click View Query Results.


Caution If no information is entered into the query text box, the system deletes all phone records.

Step 5 To delete the records, click Delete.

Step 6 A message displays that advises you of approximately how long it will take to delete the records from the Cisco CallManager database. You can cancel the transaction or click OK to continue.

Step 7 To display the log file that BAT generated, you can click the View Latest Log File link. The log file displays the number of phones that were deleted and the number of records that failed, including an error code. For more information on log files, see "BAT Log Files" section on page 13-1.


Related Topics

Using Query to Delete Phones

Adding Phones

Updating Phones

Updating Lines

Resetting or Restarting Phones

You can reset or restart devices without updating any attributes. Use this procedure if a problem arises, and you must reset or restart the phones with a bulk transaction.

To access the Reset/Restart option, choose Configure > Phones. In the Phones Options window, choose Reset/Restart Phones and click Next. You can choose between two methods to locate phones:

Using Query to Reset or Restart Phones

Using a Custom File to Reset or Restart Phones

Using Query to Reset or Restart Phones

To reset or restart phones by creating a query to locate the phones, use the following procedure.

Procedure


Step 1 In the Reset/Restart Phones Options window, choose Use query and click Next. The Reset/Restart Phones window displays.


Note To reset or restart all phones, do not specify a query filter. Skip to Step 8.


Step 2 In Select Phones to Query drop-down list box, choose the field to query such as Model or Directory Number.

Step 3 In the second drop-down list box, choose the search criteria such as begins with, contains, or is empty.

Step 4 In the search field list box, choose or enter the value that you want to locate, such as the model name from the list or directory number range.

Step 5 To add the defined filter to the query, click Add To Query .

Step 6 To add multiple filters, you can click AND or OR and to further define your query, repeat Step 4 through Step 7.


Note You cannot perform multiple queries when Directory Number is used in the first drop-down list box; that is, AND or OR do not act as valid operators with Directory Number.


Step 7 Click View Query Results to check that the query includes the information that you need.

If you make a mistake, click the Clear Query button to remove the query; then, return to Step 4 and restart.


Caution If no information is entered into the query text box, the system resets or restarts all phones.

Step 8 Click one of the following options:

Reset—To reset (power-cycle) the phones

Restart—To reset phones without power-cycling

A message displays that advises you of approximately how long it will take to reset or restart the phones. You can cancel the transaction or click OK to continue.

Step 9 To display the log file that BAT generated, you can click the View Latest Log File link. The log file displays the number of phones that were reset or restarted. For more information on log files, see the "BAT Log Files" section on page 13-1.


Related Topics

Using a Custom File to Reset or Restart Phones

Adding Phones

Updating Phones

Updating Lines

Using a Custom File to Reset or Restart Phones

You can create a custom file of phones that you want to reset or restart by using a text editor. You can use either device names or directory numbers in the custom file.

Before You Begin

1. Create a text file that lists one of these details for the phones that you want to reset or restart:

Device names

Directory numbers

2. Put each item on a separate line in the text file.

3. Save the custom file with a <filename.txt> to this folder: C:\BATfiles\Phones\Query\Update\

To reset or restart phones by using a custom file, use the following procedure.

Procedure


Step 1 In the Reset/Restart Phones Options window, choose Use a custom file and click Next. The Reset/Restart Phones window displays.

Step 2 In Select Phones where drop-down list box, choose the item that you used in the custom file, either Device Name, or Directory Number.

Step 3 In the Custom file where drop-down list box, choose the filename for the custom file that you created.

Step 4 Click View Query Results to check that the query includes the information that you need.


Caution If no information is entered into the query text box, the system resets or restarts all phones.

Step 5 Click one of the following:

Reset—To reset (power-cycle) the phones

Restart—To reset phones without power-cycling

A message displays that advises you of approximately how long it will take to reset or restart the phones. You can cancel the transaction or click OK to continue.

Step 6 You can click the View Latest Log File link to display the log file that BAT generated. The log file displays the number of phones that were reset or restarted. For more information on log files, see the "BAT Log Files" section on page 13-1.


Related Topics

Using Query to Reset or Restart Phones

Adding Phones

Updating Phones

Updating Lines

Configuring CAPF

Certification Authority Proxy Function (CAPF) identifies a Windows NT service that is used to issue new certificates to individual devices when a new request is received. You can upgrade or delete the Locally Significant Certificate (LSC). You can also upgrade certificates for supported CAPF devices in bulk.

Use the following procedure to access the CAPF Configuration option.

Procedure


Step 1 In the Bulk Administration Tool (BAT), choose Configure > Phones. The Phone Options window displays.

Step 2 In the Phone Options window, choose CAPF Configuration and click Next.


Related Topics

Upgrading LSC

Upgrading LSC

You can upgrade or delete the Locally Significant Certificate (LSC) by creating a query to search for phones that have common attributes. Use the following procedure to upgrade or delete LSCs.

Procedure


Step 1 In the CAPF Configuration Options window, choose Upgrade LSC and click Next. The Upgrade LSC (Step 1 of 2) window displays.


Note To upgrade or delete LSC for all phones, do not specify a query filter. Skip to Step 8.


Step 2 In Select Phones Where drop-down list box, choose the field to query such as Device Type, Device Security Mode or LSC Status.

Step 3 From the second drop-down list box, choose the search criteria such as begins with, contains, or is empty.

Step 4 In the search field list box, choose or enter the value that you want to locate, such as the device name from the list or LSC status.

Step 5 To add the defined filter to the query, click Add To Query.

Step 6 To add multiple filters, you can click AND or OR and to further define your query, repeat Step 2 through Step 5.

Step 7 Click View Query Results to check that the query includes the information that you need.

If you make a mistake, click the Clear Query button to remove the query, return to Step 2, and redo the procedure.


Caution If no information is entered into the query text box, the system updates LSC for all phones.

Step 8 Click Next. The Upgrade LSC (Step 2 of 2) window displays.

Step 9 From the Certificate Operation drop-down list box, choose Upgrade LSC or Delete LSC.

Step 10 Specify the setting that you want to update or delete for all the records that you have defined in your query or custom file. You can choose multiple parameters to update or delete.

Step 11 In the Select parameters to Update area, choose the Authentication Mode from the drop-down list box, from the following options:

By Authentication String

By Null String

By Existing Certificate (Precedence to LSC (Locally Significant Certificate)

By Existing Certificate (Precedence to MIC (Manufactured Installed Certificate)

Step 12 If you chose By Authentication String in Step 11, you can choose to generate a unique authentication string for each device by checking the check box.

Step 13 If you do not check the Generate unique authentication string for each device check box, enter the authentication string in the text box or click Generate String to let the system generate an authentication string.


Note If authentication string is entered or generated through Step 12, the system applies to all the devices that are chosen through the query.


Step 14 From the Key Size drop-down list box, choose the key size. The default key size specifies 1024 bits.

Step 15 In the Operation Completes By field, enter the date by which the Certification Operation is expected to complete. The date format for this field specifies YYYY: MM: DD: HH

Step 16 Click one of the following options:

Reset Phones—To reset (power-cycle) the phones (Default)

Restart Phones—To reset phones without power-cycling

Do not Reset/Restart Phones—To not to reset or restart phones

Step 17 Click Update.

A message that advises you of the approximate time that is required to update or delete LSC for the phones displays. Cancel the transaction or click OK to continue.


Related Topics

Configuring CAPF

Adding Phones

Updating Phones

Updating Lines