Cisco Unified Communications Manager (CallManager) Guide

Validate CSV Data File Phone Records , on page 119

, on page 15

Validate BAT Data Input File

The system runs a validation routine to check for errors in the CSV data file and the BAT template against the first node database. These checks include the following items:

• Fields, such as description, display text, and speed-dial label that do not have a dependency on a database table, use valid characters.

• BAT Validate transaction only validates data type, length and relational dependency.

Consider the following example:

MAC ADDRESS,DESCRIPTION,PARTITION

AABBCC112233,Lab Phone,Dallas

If the Partition does not exist, Validate displays an error saying “Dallas is not an existing PARTITION.”

• Number of lines that are configured on a device matches the device template. (Only for Specific Details)

Validation does not check for the existence of a user or for mandatory/optional fields that are BAT defined, such as the dummy MAC address.

Procedure

Step 1

Step 2

Select the Validate File option and choose the name of the CSV data input file, the BAT template for the device, and the model, if applicable.

The CSV data file should contain all details.

Select the validation method.

a) Choose Specific Details for validating records that follow the Default or Custom file format.

b) Choose All Details for validating records from a file that was generated from the export utility using the

All Details option.

After the transaction completes, click the Log File Name link in the Job configuration window to see a log file that displays the devices that could not be validated successfully and the error code.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Overview

Insert BAT Data Input File Records Into Database

When the data input file has passed validation, you are ready to use the Insert window to add the device records into the Unified Communications Manager first node database.

Before you begin

The CSV data input file must be valid. If any line information for a phone record fails, BAT does not insert that phone record.

Procedure

Step 1

Step 2

Step 3

In the Insert window choose the name of the CSV data input file, the BAT template for the device, and the model, if applicable.

The CSV data file should contain all details and be valid.

Select the insert method.

a) Choose Specific Details to insert records that use a customized file format.

b) Choose All Details to insert records from a file that was generated from the export utility using the All

Details option.

Enter Job Information details and click Submit .

This creates a job that can be accessed using the Job Scheduler option in the Bulk Administration menu.

Use the Job Configuration window to view the status and to schedule and activate the job.

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

After the transaction completes, click the Log File Name link in the Job configuration window to see a log file that displays the number of records that were added and the number of records that failed, including an error code.

Related Topics

Manage Troubleshooting BAT and TAPS

, on page 637

Validate BAT Data Input File , on page 10

BAT Application Web Browser Considerations

The BAT is a web-based application that requires the use of a web browser. A web browser is a resource-intensive application that can consume large amounts of system memory and CPU cycles. When a web browser takes resources away from Unified Communications Manager, it adversely affects call processing.

Caution Possible consequences of using the browser on the same machine as the web server and Unified

Communications Manager include delayed dial tone and dropped calls.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Overview

Access BAT Online Help

Access BAT Online Help

Online help provides a multivolume system that allows you to access several different help systems, all from the same window. You can also access a comprehensive search engine and index.

Procedure

Step 1

Step 2

Select the Help menu to access BAT online help.

Choose a help feature.

a) Choose Contents and Index to open the BAT help file that you can browse for information or search the index.

b) Choose For This Page to open the help directly for the window that you are currently viewing.

You can still browse the remainder of the help or use the index.

Verify Cisco Unified Communications Manager Version

Procedure

Select Help > About to find the current version of Unified Communications Manager

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

P A R T

File Upload and Download

•

Find Downloadable File on Server, on page 15

C H A P T E R

Upload and Download Files

This chapter provides information to upload files to the Cisco Unified Communications Manager first node and download files to a local machine.

•

•

Download File Off Server, on page 16

•

Delete File From Server, on page 17

•

Find Downloadable File on Server

Use the following procedure to find files that you can download from the Unified Communications Manager server.

Procedure

Step 1

Step 2

Step 3

Choose Bulk Administration > Upload/Download Files .

From the first Find File where drop-down list box, choose one of the following options:

• Name

• Type

In the second Find Job where drop-down list, do one of the following: a) If you chose Name in

Step 2, on page 15

, choose one of the following options and continue with

Step 4, on page 16 :

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

File Upload and Download

Download File Off Server

Step 4

Step 5

Step 6

Step 7 b) If you chose Type in

Step 2, on page 15 , continue with

Step 4, on page 16

Specify the appropriate search text, if applicable.

Tip To find all files that are registered in the database, click Find without entering any search text.

To further define your query and to add multiple filters, check the Search Within Results check box, choose

AND or OR from the drop-down box, and repeat

Step 2, on page 15

through

Step 4, on page 16

If you chose Type in

Step 2, on page 15 , from the

Select item or enter search text drop-down list box, choose one of the following options:

• Insert Files

• Export Files

• Report Files

• Custom Files

• Log Files

• BAT Excel Template

Click Find .

A list of discovered files displays by the following:

• File Name

• Function Type

If you chose Type in

Step 2, on page 15 , the list of discovered files displays by the following:

• File Name

• Launch Date and Time

What to do next

You can download a file(s) that you chose.

Related Topics

Download File Off Server

, on page 16

Download File Off Server

Use the following procedure to download a file from the Unified Communications Manager server.

Procedure

Step 1

Step 2

Find the files that you want to download.

Tip To find files on the server, see

Find Downloadable File on Server, on page 15 .

Check the check boxes corresponding to the files that you want to download and click Download Selected .

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

File Upload and Download

Upload File to Server

Step 3

Step 4

Step 5

If you select more than one file to download at a time, the files will be downloaded to a common zip file.

Tip You can download all the files by clicking Select All and then clicking Download Selected .

The File Download pop-up window displays. Click Save .

In the Save As pop-up window, choose the location where you want to save the file and click Save .

The Download Complete pop-up window displays. To open the downloaded file, click Open , or click Close to open it at a later time.

Upload File to Server

Use the following procedure to upload a file to the Unified Communications Manager server.

Note The upload file format must always be using alphanumeric (a-z, A-Z and 0-9) characters. Valid characters include hyphens (-), dot (.), and underscore (_). Also, the file name should not begin with a dot nor contain double dots.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

Choose Bulk Administration > Upload/Download Files .

Click Add New .

In the File text box, enter the full path of the file that you want to upload or click Browse , and locate the file.

From the Select the Target drop-down list, choose the target for which you want to use the file.

From the Transaction Type drop-down list, choose the transaction type that the file defines.

If you want to overwrite an existing file with the same name, check the Overwrite File if it Exists check box.

Click Save . The status displays that the upload is successful.

Delete File From Server

Use the following procedure to delete files from the Unified Communications Manager server. If you choose files to delete that are actively being used to execute jobs, those files will not get deleted.

Attention Do not delete the BAT.xlt file.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

File Upload and Download

Delete File From Server

Procedure

Step 1

Step 2

Step 3

Step 4

Find the files that you want to delete.

In the Search Results area, check the check box that corresponds to the files that you want to delete.

Click Delete Selected .

Note To delete all files that display in the Search Results area, click Select All and Delete Selected .

To continue, click OK .

The files are now deleted from the server.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

P A R T

III

Phones

•

Phone Template, on page 21

•

Phone File Formats, on page 113

•

Phone Record Validation, on page 119

•

Phone Insertions, on page 121

•

Phone Updates, on page 125

•

Phone Deletions, on page 149

•

Phone Exports, on page 155

•

Phone Line Addition and Updates, on page 161

•

Phone Resets and Restarts, on page 179

•

Phone Reports, on page 185

•

Phone Migrations, on page 193

•

Intercom Additions and Updates, on page 197

C H A P T E R

Phone Template

Cisco Unified Communications Manager Bulk Administration (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 Unified Communications Manager Administration. You can use BAT to work with the following types of phones:

• CiscoUnifiedIPPhones (all models)

• CTI ports

• H.323 clients

This chapter provides information about how to use BAT to work with phone templates and other IP telephony devices.

•

Add Phones to Database, on page 21

•

BAT Phone Templates, on page 22

Add Phones to Database

When you use BAT to add phones and other IP telephony devices in bulk to the Unified Communications

Manager 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)

Procedure

Step 1

Step 2

Choose Bulk Administration > Phones > Phone Template .

The Find and List Phone Templates window displays.

Create a CSV data file to insert the phone templates.

Perform one of the following options: a) Create a CSV data file using the BAT spreadsheet.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

BAT Phone Templates

Step 3

Step 4 b) Create a CSV data file using a text editor as follows:

Choose Bulk Administration > Phones > Phone File Format > Create File Format .

Use a text editor and create the CSV data file for phones that follows the file format that you want to use.

Choose Bulk Administration > Phones > Phone File Format > Add File Format to associate the text-based file format with the CSV data file.

Choose Bulk Administration > Phones > Validate Phones .

Choose Bulk Administration > phones > Insert phones to insert phone records into the Unified

Communications Manager database.

BAT Phone Templates

, on page 22

Create Phone CSV Data File Using BAT Spreadsheet , on page 83

Create Text-Based CSV File for Phones , on page 660

Find Phone File Formats

, on page 113

Insert Phones Into Unified Communications Manager

, on page 121

Phone Record Validation

, on page 119

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 Unified Communications Manager

Administration. You cannot create new settings in BAT.

Find BAT Phone Template

Because you might have several phone templates, Unified Communications Manager lets you locate specific phone templates on the basis of criteria that you define.

Note During your work in a browser session, your find/list search preferences are stored in the cookies on the client machine. If you navigate to other menu items and return to this menu item, or if you close the browser and then reopen a new browser window, your Unified Communications Manager search preferences are retained until you modify your search.

Procedure

Step 1 Choose Bulk Administration > Phones > Phone Template .

The Find and List Phone Templates window displays. Use the two drop-down list boxes to search for a template.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Create New BAT Phone Template

Step 2

Step 3

Step 4

Step 5

From the first Find Phone Templates where drop-down list box, choose one of the following criteria:

• Device Name

• Description

• Directory Number

• Directory URI

• Calling Search Space

• Device Pool

• Device Type

• Call Pickup Group

• LSC Status

• Authentication String

• Device Protocol

• Security Profile

• Common Device Configuration

From the second Find Phone Template where drop-down list box, choose one of the following criteria:

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty

Specify the appropriate search text, if applicable, and click Find .

Tip To find all Phone Templates that are registered in the database, click search text.

Find without entering any

A list of discovered templates displays.

From the list of records, click the device name that matches your search criteria.

The window displays the phone template that you choose.

Create New BAT Phone Template

You can create new BAT phone templates. After you create a phone template, you can add lines, services, and speed dials.

Procedure

Step 1

Step 2

Step 3

Step 4

Choose Bulk Administration > Phones > Phone Template .

Click Add New . The Add a New Phone Template window displays.

From the Phone Type drop-down list, choose the phone model for which you are creating the template. Click

Next .

From the Select the Device Protocol drop-down list, choose the device protocol. Click Next .

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Add or Update Phone Lines in BAT Template

Step 5

Step 6

Step 7

The Phone Template Configuration window displays with fields and default entries for the chosen device type.

In the Template Name field, enter a name for the template.

The name can contain up to 50 alphanumeric characters.

In the Device Information area, enter the phone settings that this batch has in common.

Some phone models and device types do not have all the attributes that the table lists. See, the phone model documentation for information on all the attributes.

After you have entered all the settings for this BAT phone template, click Save .

When the status indicates that the transaction has completed, you can add line attributes.

Add or Update Phone Lines in BAT Template

You can add one or more lines to the BAT template or to update existing lines. The button template in use for the BAT template determines the number of lines that you can add or update. You can create a primary phone template that has multiple lines. Then, you can use the standard template to add phones with a single line or up to the number of lines in the standard template. All phones or user device profiles in this batch will use the settings that you choose.

Cisco recommends that you use alphanumeric characters for the line template value, so if numbers are given, a chance exists of this conflicting with an actual directory number. This would also avoid conflicts with features such as Call Pickup group number and Call Park number.

The maximum number of lines that display for a BAT template depends on the model and button template that you chose when you created the BAT phone template. For some CiscoUnifiedIPPhone models, you can also add CiscoUnifiedIPPhone services and speed dials to the template.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Find the Phone Template to which you want to add the line.

In the Phone Template Configuration window, click Line [1] Add a new DN , in the Associated Information area.

The Line Template Configuration window displays.

Enter or choose the appropriate values for the line settings.

Click Save .

To add settings for any additional lines, repeat

Step 2, on page 24

through

Step 4, on page 24 .

If you choose Back to Find/List from the Related Links drop-down list box in the upper, right, corner of the

Line Template Configuration window, the Find and List Line Template window displays.

a) To find existing line template, enter the appropriate search criteria and click Find .

b) To add a new line template, click Add New .

Add or Update Speed Dials in BAT Template , on page 25

Standard Phone Templates , on page 5

, on page 22

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Add or Update IP Services in BAT Template

Add or Update IP Services in BAT Template

You can subscribe CiscoUnifiedIPPhone services to the CiscoUnifiedIPPhone models that include this feature directly in the BAT template. To bulk subscribe users or phones to IP services, the IP services must have common service parameters and be subscribed through a phone template. You can not bulk subscribe IP services that have unique service parameters. For services with unique parameters, use the CSV file.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

Find the Phone Template to which you want add an IP service.

From the Phone Template Configuration window, click Add a new SURL in the Associated Information area.

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

In the Select a Service drop-down list 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.

Click Next .

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

Associate the selected services or add more services to the template.

a) To associate these phone services to the phone template, click Save .

b) To add more services, repeat

Step 3, on page 25

through

Step 6, on page 25 .

c) To add all the services to the template, click Update .

After you are done adding or updating services for the selected template, proceed to the next step.

Close the popup window.

, on page 22

Add or Update Speed Dials in BAT Template

You can add and update speed dials in the BAT template for phones and Cisco VGC phones if the Phone

Button Template provides speed-dial buttons. The Phone Button Template in use for the BAT template determines the number of available speed-dial buttons.

Procedure

Step 1

Step 2

Find the Phone Template to which you want to add speed dials.

From the Phone Template Configuration window, do one of the following: a) Click Add a new SD in the Associated Information area.

b) Choose Add/Update Speed Dials from the Related Links drop-down list box in the upper, right-hand corner of the window.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Add or Update Busy Lamp Field in BAT Template

Step 3

Step 4

Step 5

Step 6

A popup window displays. In this window, you can designate speed-dial buttons for CiscoUnifiedIPPhones and expansion modules.

In the Speed Dial Settings area, enter the phone number, including any access or long-distance codes, in the

Number field.

Note When you enter the phone number, it can be followed by Forced Authorized Code (FAC)/Client

Matter Code (CMC) if applicable. You can enter the Phone number, FAC, CMC either in sequence or separated by a comma (,). The Speed dial may include any PIN, Password or any other digits to be sent as DTMF digits after the call is connected. If you require a pause while connecting through speed dial, you can enter one or more comma (,) where each comma represents a pause of 2 seconds.

DTMF digits will be sent after the call is connected and the appropriate pause duration corresponding to the number of commas is entered.

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

In the Abbreviated Dial Settings area, you can set abbreviated speed dials for applicable IP phone models.

Repeat

Step 3, on page 26 .

Click Save .

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

Related Topics

, on page 22

Add or Update Busy Lamp Field in BAT Template

You can add and update busy lamp filed speed dials in the BAT template for phones and Cisco VGC phones if the Phone Button Template provides speed-dial buttons. The Phone Button Template in use for the BAT template determines the number of available BLF SD buttons.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Find the Phone Template to which you want to add speed dials.

In the Phone Template Configuration window, do one of the following: a) Click Add a new BLF SD in the Associated Information area.

b) Choose Add/Update Busy Lamp Field Speed Dials from the Related Links drop-down list in the upper, right-hand corner of the window.

A popup window displays. In this window, you can designate busy lamp field speed-dial (BLF SD) buttons for CiscoUnifiedIPPhones and expansion modules.

In the Speed Dial Settings area, enter the destination, including any access or long-distance codes, in the

Destination field.

Choose the directory number from the drop-down list. You can click Find to search for directory numbers.

In the Label field, enter a label that corresponds to the BLF SD number.

Click Save .

BAT inserts the BLF SD settings in the template, and the popup window closes.

Related Topics

, on page 22

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Add or Update Busy Lamp Field Directed Call Park in BAT Template

You can add and update busy lamp field (BLF) directed call park in the BAT template for phones and Cisco

VGC phones if the Phone Button Template provides speed-dial buttons. The Phone Button Template in use for this BAT template determines the number of available BLF Directed Call Park buttons.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Find the Phone Template to which you want to add BLF speed directed call park.

In the Phone Template Configuration window, do one of the following: a) Click Add a new BLF Directed Call Park in the Associated Information area.

b) Choose Add/Update BLF Directed Call Park from the Related Links drop-down list box in the upper, right-hand corner of the window.

A popup window displays. In this window, you can designate BLF Directed Call Park buttons for

CiscoUnifiedIPPhones and expansion modules.

In the Unassigned Busy Lamp Field/Directed Call Park Settings area, choose the directory number from the drop-down list. You can click Find to search for directory numbers.

In the Label field, enter a label that corresponds to the BLF Directed Call Park number.

Click Save .

BAT inserts the BLF Directed Call Park settings in the template, and the popup window closes.

Related Topics

, on page 22

Add or Update Intercom Template in BAT Template

You can add one or more Intercom templates to the BAT template, or update existing Intercom templates in the BAT template The button template in use for the BAT template determines the number of lines that you can add or update. You can create a standard phone template that has multiple lines. Then, you can use the standard template to add phones with a single line or up to the number of lines in the standard template. All phones or user device profiles in this batch will use the settings that you choose for the intercom template.

We recommend that you use alphanumeric characters for intercom template, so if numbers are given, a chance exists of this conflicting with an actual directory number. This would also avoid conflicts with features such as Call Pickup group number and Call Park number.

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. For some CiscoUnifiedIPPhone models, you can also add CiscoUnifiedIPPhone services and speed dials to the template.

Procedure

Step 1

Step 2

Step 3

Find the Phone Template to which you want to add the intercom template.

In the Phone Template Configuration window, click Intercom [1] - Add a new Intercom in the Associated

Information area.

The Intercom Template Configuration window displays.

Enter or choose the appropriate values for the intercom template settings.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Modify BAT Phone Templates

Step 4

Step 5

Click Save .

BAT adds the intercom template to the phone template configuration.

To add settings for any additional intercom templates, repeat

Step 2, on page 27

through

Step 4, on page 28 .

If you choose Back to Find/List from the Related Links drop-down list box in the upper, right, corner of the

Intercom Template Configuration window, the Find and List Intercom Directory Number window displays.

Note If you choose Back to Find/List from the Related Links drop-down list box in the upper, right, corner of the Intercom Template Configuration window, the Find and List Intercom Directory

Number window displays.

a) Click Find and enter the appropriate search criteria and to find existing Intercom directory numbers.

b) In the Find and List Intercom Directory Number window, click Add New to add a new intercom directory number.

Add or Update Speed Dials in BAT Template , on page 25

, on page 24

2: Field Descriptions for Adding a Line to a BAT Template, on page 61

, on page 22

Standard Phone Templates

, on page 5

Modify BAT Phone Templates

Procedure

Step 1

Step 2

Step 3

Find the Phone Template that you want to modify.

In the phone Template Configuration window, add, change, or remove settings in the template. See

Table

for more information.

After you have modified the settings to update the template, click Save .

What to do next

You can proceed to add or update lines, IP services, or speed dials for the BAT template.

Add or Update Speed Dials in BAT Template , on page 25

, on page 24

Table 2: Field Descriptions for Adding a Line to a BAT Template, on page 61

, on page 22

Copy BAT Phone Template

You can copy the properties of an existing phone template into a new phone template when you want to change only a few fields. The copy duplicates all the values that were specified in the original template.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Delete BAT Phone Template

Note Ensure that the new template that you create is the same device type as the original template, such as

CiscoIPPhone 7975.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Find the Phone Template that you want to copy.

Copy the Phone Template. Do one of the following: a) In the Phone Template Configuration window, verify that this is the template that you want to copy and click Copy .

b) In the Find and List Phone Templates window, click the icon in the Copy column that corresponds to the phone template that you want to copy.

c) To copy a template and all the lines associated with that template, in the Find and List Phone Templates window, click the icon in the Super Copy column that corresponds to the phone template with the lines that you want to copy.

In the Template Name field, enter a name for the template.

The name can contain up to 50 alphanumeric characters.

Example:

Sales_7975.

Update the fields as needed for the new template.

See

for more information.

Click Save .

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

What to do next

You can continue to add or update phone lines, IP services, and speed dials to the template.

, on page 25

Add or Update Speed Dials in BAT Template , on page 25

, on page 24

, on page 22

Delete BAT Phone Template

You can delete BAT phone templates.

Caution If you submit a job that uses a particulate phone template and you delete that phone template, the job also gets deleted.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

BAT Phone Template Field Descriptions

Procedure

Step 1

Step 2

Step 3

Find the Phone Template that you want to delete.

Delete the Phone Template. Do one of the following: a) In the Phone Template Configuration window, verify that this is the template that you want to delete and click Delete .

b) In the Find and List Phone Templates window. check the check box next to the template that you want to delete and click Delete Selected .

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

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

Find and List Phone Templates window.

Related Topics

Text Editors for Phone CSV Data File Creation, on page 113

, on page 22

BAT Phone Template Field Descriptions

The following table provides descriptions of all possible fields that display when you add a BAT phone template for all IP telephony devices. Some device types do not require all the phone settings, and only some fields show the values that were configured in Unified Communications Manager Administration. Field names that have an asterisk in the BAT user interface require an entry. Treat fields that do not have an asterisk as optional.

Table 1: Field Descriptions for a Phone Template

Description Field

Device Information

Device Trust Mode

Template Name

Description

Requires Activation Code for Onboarding

Select whether the device is trusted or not trusted.

You can configure this setting for analog phones using

SCCP, and for some third-party endpoints.

Enter the name for the template.

Enter a description for the phone template that you want to create. The description can include up to 50 characters in any language, but it cannot include double-quotes ("), percentage sign (

), ampersand

(&), back-slash (

), or angle brackets (<>).

Check this check box if you want to use activation codes, rather than autoregistration, to onboard phones that use this template.

Note This option is available only for phones that support activation codes.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Field

DevicePool

Common Device Configuration

Phone Button Template

Softkey Template

Common Phone Profile

Calling Search Space

AAR Calling Search Space

Media Resource Group List

BAT Phone Template Field Descriptions

Description

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

For devices, a devicepool defines sets of common characteristics, such as region, date/time group,

Unified Communications Manager group, and calling search space for auto-registration.

Choose the common device configuration to which you want this phone assigned. The common device configuration includes the attributes (services or features) that are associated with a particular user.

You configure the Common device configurations in the Common Device Configuration window.

To see the common device configuration settings, click the View Details link.

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.

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

From the drop-down list, choose a common phone profile from the list of available common phone profiles.

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.

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.

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.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

BAT Phone Template Field Descriptions

Field

User Hold MOH Audio Source

Network Hold MOH Audio Source

Location

AAR Group

User Locale

Network Locale

Built In Bridge

Privacy

Description

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.

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.

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 CiscoIPPhone consumes.

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.

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 Unified Communications

Manager user windows and phones.

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 they communicate with the PSTN and other networks in a specific geographical area.

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

For each phone that wants Privacy, choose On in the

Privacy drop-down list.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Field

Device Mobility Mode

Owner User ID

Mobility User ID

(Dual-mode phones only)

BAT Phone Template Field Descriptions

Description

From the drop-down list, turn the device mobility feature on or off for this device or choose Default to use the default device mobility mode.

Click View Current Device Mobility Settings to display the current values of these device mobility parameters:

• Cisco Unified Communications Manager Group

• Roaming Device Pool

• Location

• Region

• Network Locale

• AAR Group

• AAR Calling Search Space

• Device Calling Search Space

• Media Resource Group List

• SRST

Enter a user ID for the primary phone user.

From the drop-down list, choose the user ID of the person to whom this dual-mode phone is assigned.

Note The Mobility User ID configuration gets used for the Cisco Unified Mobility and

Mobile Voice Access features for dual-mode phones.

Note The Owner User ID and Mobility User ID can differ.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

BAT Phone Template Field Descriptions

Field

Phone Personalization

Services Provisioning

Phone Load Name

Description

From the drop-down list, enable or disable the personalization settings on the phone, or choose

Default to use the phone personalization that is set in the Common Phone Profile. You can choose one of the following options:

• Disabled—None of the personalization settings on the phone get activated.

• Enabled—This setting accepts a personalized background image file, which is used for the phone screen; it accepts a preview image file for temporary display; and it accepts a personalized tone file, so the default ring tone can be personalized.

• Default—Use the phone personalization setting that is in the Common Phone Profile.

From the drop-down list, choose the Services

Provisioning setting that you want to use from the following values:

• Internal

• External URLs

• Both

• Default: Internal

This parameter controls whether the phone uses the services provisioned from the configuration file

(Internal), services received from the Services URLs

(External URLs), or both. The External URLs option provides backward compatibility with third party provisioning servers. The Both option allows users to subscribe to the services specified in the configuration file while also appending services from an external provisioning server.

This is a required field.

Enter the custom phone load, if applicable.

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

For more information about CiscoIPPhone software and configuration, refer to the CiscoIPPhone

Administration Guide for Unified Communications

Manager, which is specific to the phone model.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Field

Single Button Barge

Join Across Lines

BAT Phone Template Field Descriptions

Description

From the drop-down list, enable or disable the Single

Button Barge/cBarge feature for this device or choose

Default to use the service parameter setting.

• Off—This setting disables the Single Button

Barge/cBarge feature; however, the regular Barge or cBarge features will still work.

• Barge—This setting enables the Singe Button

Barge feature.

• cBarge—This setting enables the Single Button cBarge feature.

• Default—This setting uses the Single Button

Barge/cBarge setting that is in the service parameter.

From the drop-down list, enable or disable the Join

Across Lines feature for this device or choose Default to use the service parameter setting.

• Off—This setting disables the Join Across Lines feature.

• On—This setting enables the Join Across Lines feature.

• Default—Uses the Join Across Lines setting that is in the service parameter.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

BAT Phone Template Field Descriptions

Field

Use Trusted Relay Point

BLF Audible Alert Setting (Phone Idle)

Description

From the drop-down list, enable or disable whether

Unified Communications Manager inserts a trusted relay point (TRP) device with this media endpoint.

Choose one of the following values:

• Default—If you choose this value, the device uses the Use Trusted Relay Point setting from the common device configuration with which this device associates.

• Off—Choose this value to disable the use of a

TRP with this device. This setting overrides the

Use Trusted Relay Point setting in the common device configuration with which this device associates.

• On—Choose this value to enable the use of a

TRP with this device. This setting overrides the

Use Trusted Relay Point setting in the common device configuration with which this device associates.

A Trusted Relay Point (TRP) device designates an

MTP or transcoder device that is labeled as Trusted

Relay Point.

Unified Communications Manager places the TRP closest to the associated endpoint device if more than one resource is needed for the endpoint (for example, a transcoder or RSVPAgent).

If both TRP and MTP are required for the endpoint,

TRP gets used as the required MTP.

From the drop-down list, choose the BLF Audible

Alert setting that you want to use from the following values:

• On

• Off

• Default

This parameter provides an audible alert in addition to a visual alert on a phone that is currently idle when a call comes in to one of the lines that is monitored by way of a busy lamp field (BLF) button.

This is a required field.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Field

BLF Audible Alert Setting (Phone Busy)

Always Use Prime Line

BAT Phone Template Field Descriptions

Description

This parameter for this required field provides an audible alert in addition to a visual alert on a phone that is currently in use when a call comes in to one of the lines that is monitored by way of a busy lamp field

(BLF) button.

From the drop-down list, choose the BLF Audible

Alert setting that you want to use from the following values:

• On

• Off

• Default

From the drop-down list, choose one of the following options:

• Off—When the phone is idle and receives a call on any line, the phone user answers the call from the line on which the call is received.

• On—When the phone is idle (off-hook) and receives a call on any line, the primary line gets chosen for the call. Calls on other lines continue to ring, and the phone user must select those other lines to answer these calls.

• Default—Unified Communications Manager uses the configuration from the Always Use

Prime Line service parameter, which supports the Cisco CallManager service.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

BAT Phone Template Field Descriptions

Field

Always Use Prime Line for Voice Message

Geo Location

Feature Control Policy

Description

From the drop-down list, choose one of the following options:

• On—If the phone is idle, the primary line on the phone becomes the active line for retrieving voice messages when the phone user presses the

Messages button on the phone.

• Off—If the phone is idle, pressing the Messages button on the phone automatically dials the voice-messaging system from the line that has a voice message. Unified Communications

Manager always selects the first line that has a voice message. If no line has a voice message, the primary line gets used when the phone user presses the Messages button.

• Default—Unified Communications Manager uses the configuration from the Always Use

Prime Line for Voice Message service parameter, which supports the Cisco CallManager service.

From the drop-down list, choose a geo location.

You can choose the Unspecified geo location, which designates that this device does not associate with a geo location.

You can also choose a geolocation that has been configured with the System > Geolocation

Configuration menu option.

Choose the Feature Control Policy for this group of phones.

A feature control policy specifies the appearance of features and the associated softkeys that are displayed on the phone.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

BAT Phone Template Field Descriptions

Field

Device Security Mode

Retry Video Call as Audio

Description

From the drop-down list, 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 Unified Communications

Manager.

Authenticated—Unified Communications Manager provides integrity and authentication for the phone.

A TLS connection that uses NULL/SHA opens.

Encrypted—Unified Communications Manager provides integrity, authentication, and encryption for the phone. A TLS connection that uses AES128

SHA opens.

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

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 this device should immediately retry a video call as an audio call (if it cannot connect as a video 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 does not try to establish as an audio call. The call then fails to call control, and call control routes the call via Automatic Alternate

Routing (AAR) and

/ or route

/ hunt list.

Ignore Presentation Indicators (Internal Calls Only) Check this check box to configure call display restrictions on a call-by-call basis. When this check box is checked, Unified Communications Manager ignores any presentation restriction that is received for internal calls.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

BAT Phone Template Field Descriptions

Field

Allow Control of Device from CTI

Logged into Hunt Group

Remote Device

Protected Device

Phones

Description

Check this check box to allow control of all CTI controllable devices from CTI.

You can enable or disable this check box based on

CTI Controllable Device Type and Device Protocol.

Note Cisco dual-mode devices (Jabber) such as

Android, iPhone, and iPad operating in

WiFi mode are monitored through CTI and not controlled. However, devices operating in GSM mode cannot be monitored or controlled.

This check box, which gets checked by default for all phones, indicates that the phone is currently logged in to a hunt list (group). When the phone gets added to a hunt list, the administrator can log the user in or out by checking (and unchecking) this check box.

Users use the softkey on the phone to log their phone in or out of the hunt list.

If you are experiencing delayed connect times over

SCCP to remote sites, check the Remote Device check box in the Phone Configuration window. Checking this check box tells Unified Communications Manager to allocate a buffer for the phone device when it registers and to bundle SCCP messages to the phone.

Because this feature consumes resources, be sure to check this check box only when you are experiencing signaling delays for phones that are running SCCP.

Most users do not require this option.

Check this check box to designate a phone as

“protected.” This enables the phone to play a two-second tone notifying the user when a call is both encrypted and both phones are configured as protected devices. The tone plays for both parties when the call is answered. The tone does not play unless both phones are “protected” and the call occurs over encrypted media.

Tip For a detailed description of the secure-tone feature and the configuration requirements, see the Cisco Unity

Connection System Administration Guide .

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

BAT Phone Template Field Descriptions

Field

Hotline Device

Description

Check this check box to make this device a Hotline device. Hotline devices can only connect to other

Hotline devices. This feature is an extension of PLAR, which configures a phone to automatically dial one directory number when it goes off-hook. Hotline provides additional restrictions that you can apply to devices that use PLAR.

To implement Hotline, you must also create a softkey template without supplementary service softkeys, and apply it to the Hotline device.

Number Presentation Transformation

Caller ID for Calls from This Phone

Calling Party Transformation CSS From the drop-down list, choose the calling search space (CSS) that contains the calling party transformation pattern that you want to apply on the calling number when this phone initiates a call.

When this phone initiates a call, Unified

Communications Manager transforms the calling party using the digit transformations that are configured on the matching calling party transformation pattern.

This setting allows you to transform the calling party number before Unified Communications Manager routes the call. For example, a transformation pattern can change a phone extension to an E.164 number.

This setting is generally configured when users dial using a URI instead of digits. Unified

Communications Manager allows calling party transformations on various patterns when users dial using digits; this setting provides similar transformation provision even when users dial using a URI.

Use Device Pool Calling Party Transformation CSS

(Caller ID for Calls from This Phone)

Check this check box to use the Calling Party

Transformation CSS that is configured at the device pool to which this phone belongs for transforming the calling party for calls that are initiated from this phone. At the device pool, the Calling Party

Transformation CSS that is present under Phone

Settings is used to transform the calling party for calls initiated from this phone.

Leave this check box unchecked to apply the Calling

Party Transformation CSS setting that appears in this configuration window.

Remote Number Transformation

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

BAT Phone Template Field Descriptions

Field

Calling Party Transformation CSS

Description

From the drop-down list, choose the calling search space (CSS) that contains the calling party transformation pattern that you want to apply on the remote calling number for the calls that are received on this phone.

Unified Communications Manager transforms the remote calling number using the digit transformations that are configured on the matching calling party transformation pattern before presenting it to this device.

For example, a transformation pattern can change a remote number in E.164 format to a localized version.

Use this setting to transform the remote connected number for direct calls that are initiated from this phone. Use this setting also to transform a remote connected number after you invoke the feature irrespective of the direction of the call. The transformation of the remote connected number is controlled using the service parameter “Apply

Transformations on Remote Number,” present under the Advanced section of Cisco Call Manager service.

For more information, refer to the description for this parameter.

Use Device Pool Calling Party Transformation CSS

(Device Mobility Related Information)

Check this check box to apply the Calling Party

Transformation CSS that is configured at the device pool to which this phone belongs for transforming the remote calling and remote connected number. At the device pool, the Calling Party Transformation CSS present under Device Mobility Related Information section is used to transform the remote calling and remote connected number.

Leave this check box unchecked to apply the Calling

Party Transformation CSS setting that appears in this configuration window for transforming the remote number.

Associated Mobility Identity —These mobility fields are available only for Nokia S60 device and Cisco

Unified Mobile Communicator phones. Click the Add New Mobile Identity link to display the Mobile

Identity Configuration page.

Name Enter a name that identifies the mobile identity.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Field

Destination Number

Answer Too Soon Timer

Answer Too Late Timer

Delay Before Ringing Timer

Time of Day Access

Time Zone

Mobile Phone

BAT Phone Template Field Descriptions

Description

Enter the telephone number for the identity. Include the area code and any additional digits that are required to obtain an outside line. Maximum field length equals 24 characters; individual characters can take the values 0-9,

, and

. Cisco recommends that you configure the caller ID of the smart phone destination.

Add the necessary translation pattern or route patterns to route the destination number.

Enter the minimum time in milliseconds that must pass before the mobile phone can be answered.

Range: 0 - 10,000 milliseconds

Default: 1,500 milliseconds

Enter the maximum time in milliseconds that can pass before the mobile phone must be answered.

Range: 10,000 - 300,000 milliseconds

Default: 19,000 milliseconds

Enter the time that elapses before the mobile phone rings when a call is transferred from the desktop phone.

Range: 0 - 30,000 milliseconds

Default: 4,000 milliseconds

From the drop-down list, choose a time-of-day access record to associate with this destination.

From the drop-down list, choose a time zone to use for this remote destination.

Note The time zone that you use for this remote destination is used by the time-of-day access feature to allow or block calls to this destination.

Check the check box if you want calls that are answered by the desktop phone to be sent to your mobile phone as the remote destination.

Note You must check this check box for Cisco

Unified Mobility to work with this remote destination.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

BAT Phone Template Field Descriptions

Field

Enable Cisco Unified Mobility

Description

Check the check box to allow an incoming call to ring your desktop phone and remote destination at the same time.

Associated Remote Destinations— Click the Add a New Remote Destination link to display the Remote

Destination Configuration page

Name

Destination Number

Enter a name that identifies the remote destination.

Enter the telephone number for the destination.

Include the area code and any additional digits that are required to obtain an outside line. Maximum field length equals 24 characters; individual characters can take the values 0-9,

, and

. Cisco recommends that you configure the caller ID of the remote destination.

Add the necessary translation pattern or route patterns to route the destination number.

Answer Too Soon Timer Enter the minimum time in milliseconds that must pass before the mobile phone can be answered.

Range: 0 - 10,000 milliseconds

Default: 1,500 milliseconds

Answer Too Late Timer

Delay Before Ringing Timer

Time of Day Access

Time Zone

Enter the maximum time in milliseconds that can pass before the mobile phone must be answered.

Range: 10,000 - 300,000 milliseconds

Default: 19,000 milliseconds

Enter the time that elapses before the mobile phone rings when a call is transferred from the desktop phone.

Range: 0 - 30,000 milliseconds

Default: 4,000 milliseconds

From the drop-down list, choose a time-of-day access record to associate with this remote destination.

From the drop-down list, choose a time zone to use for this remote destination.

Note The time zone that you use for this remote destination is used by the time-of-day access feature to allow or block calls to this remote destination.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Field

Mobile Phone

Enable Cisco Unified Mobility

Protocol Specific Information

Packet Capture Mode

Packet Capture Duration

BLF Presence Group

BAT Phone Template Field Descriptions

Description

Check the check box if you want calls that are answered by the desktop phone to be sent to your mobile phone as the remote destination.

Note You must check this check box for Cisco

Unified Mobility to work with this remote destination.

Check the check box to allow an incoming call to ring your desktop phone and remote destination at the same time.

From the drop-down list, 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.

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

Used with the BLF Presence feature, the phone that is running SIP or SCCP serves as a watcher because it requests status about the presence entity; for example, directory number, that is configured as a

BLF speed dial button on the phone.

If you want the phone to receive the status of the presence entity, choose a BLF Presence group that is allowed to view the status of the Presence group that is applied to the directory number, as indicated in the

BLF Presence Group Configuration window.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

BAT Phone Template Field Descriptions

Field

SIP Dial Rules

Device Security Profile

MTP Preferred Originating Codec

Rerouting Calling Search Space

Out-of-Dialog Refer Calling Search Space

SUBSCRIBE Calling Search Space

Description

If required, choose the appropriate SIP dial rule. SIP dial rules provide local dial plans for Cisco IP phones

7940, and 7975 that are running SIP, so users do not have to press a key or wait for a timer before the call gets processed.

Leave the SIP Dial Rules field set to <None> if you do not want dial rules applied to the IP phone that is running SIP. This means the user will have to use the

Dial softkey or wait for the timer to expire before the call gets processed.

For phones that are running SCCP or SIP, choose the security profile that you want to apply to the device.

All phones require that you apply a security profile.

If the phone does not support security, choose a nonsecure profile.

From the drop-down list, choose the codec to use if a media termination point is required for SIP calls.

From the drop-down list, choose a calling search space to use for rerouting.

The rerouting calling search space of the referrer gets used to find the route to the refer-to target. When the

Refer fails due to the rerouting calling search space, the Refer Primitive rejects the request with the “405

Method Not Allowed” message.

The redirection (3xx) primitive and transfer feature also uses the rerouting calling search space to find the redirect-to or transfer-to target.

From the drop-down list, choose an out-of-dialog refer calling search space.

Unified Communications Manager uses the out-of-dialog (OOD) Refer Authorization calling search space (CSS) to authorize the SIP out-of-dialog

Refer. The administrator can restrict the use of out-of-dialog Refer by configuring the OOD CSS of the Referrer. Refer Primitive rejects the OOD Refer request with a “403 Forbidden” message.

Used with the Presence feature, the SUBSCRIBE

Calling Search Space determines how Unified

Communications Manager routes the subscription requests that come from the phone. From the drop-down list, choose the calling search space that you want to use for this purpose.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

BAT Phone Template Field Descriptions

Field

SIP Profile

Digest User

Media Termination Point Required

Unattended Port

Require DTMF Reception

Description

Choose the default SIP profile or a specific profile that was previously created. SIP profiles provide specific SIP information for the phone such as default telephony event payload type, registration and keepalive timers, media ports, Iris, and dynamic DNS server addresses.

Used with digest authentication (SIP security), choose an end user that you want to associate with the phone.

Ensure that you configured digest credentials for the user that you choose, as specified in the End User

Configuration window.

After you save the phone configuration and reset the phone, the digest credentials for the user get added to the phone configuration file.

For more information on digest authentication, refer to the Cisco Unified Communications Manager

Security Guide .

Use this field to indicate whether a media termination point 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 an MTP to implement features.

Uncheck the Media Termination Point Required check box if you do not want to use an MTP 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.

Check this check box to indicate an unattended port on this device.

For phones that are running SIP and SCCP, check this check box to require DTMF reception for this phone.

RFC2833 Disabled For phones that are running SCCP, check this check box to disable RFC2833 support.

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

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

BAT Phone Template Field Descriptions

Field

Certificate Operation

Phones

Description

From the drop-down list, choose the Certification

Operation that you want to perform from the following options:

• No Pending Operation—No pending

Certification Operation lists exist 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.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Field

Authentication Mode

Authentication String

BAT Phone Template Field Descriptions

Description

From the drop-down list, choose the Authentication

Mode by which you want the phone to authenticate with CAPF during the certificate operation from the following options:

• By Null String—Install/upgrade, delete, or troubleshoot a locally significant certificate without user intervention.

• <None>

Note This option prompts you to specify a value for the Authentication Mode.

• By Authentication String—Installs/upgrades, deletes, or troubleshoots a locally significant certificate only when the user enters the CAPF authentication string on the phone.

• By Existing Certificate (precedence to

LSC)—Installs or upgrades, deletes, or troubleshoots a locally significant certificate if a manufacture-installed certificate (MIC) or locally significant certificate (LSC) exists in the phone.

Note

• By Existing Certificate (precedence to

MIC)—Installs/upgrades, deletes, or troubleshoots a locally significant certificate if a LSC or MIC exists in the phone.

Note

Before you choose this option, verify that a certificate exists in the phone. If you choose this option and no certificate exists in the phone, the operation fails.

If you chose the By Authentication String option from the Authentication Mode drop-down list in the security profile, this setting applies. Manually enter a numeric string that contains 4 to 10 digits. To install, upgrade, or troubleshoot a locally significant certificate, the phone user or administrator must enter the authentication string on the phone.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

BAT Phone Template Field Descriptions

Field

Key Order

RSA Key Size (Bits)

EC Key Size (Bits)

Operation Completes By

Certificate Operation Status

Expansion Module Information

Module 1

Phones

Description

This field specifies the sequence of the key for CAPF.

Select one of the following values from the drop-down list:

• RSA Only

• EC Only

• EC Preferred, RSA Backup

Note When you add a phone based on the value in Key Order , RSA Key Size , and EC

Key Size fields, the device security profile is associated with the phone. If you select the EC Only value with the EC Key Size value of 256 bits then the device security profile appends with EC-256 value.

From the drop-down list, choose one of the these values— 512 , 1024 , 2048 , 3072 , or 4096 .

Note Some phone models may fail to register if the RSA key length selected for the

CallManager Certificate Purpose is greater than 2048. From the Unified CM

Phone Feature List Report on the Cisco

Unified Reporting Tool (CURT), you can check the 3072/4096 RSA key size support feature for the list of supported phone models.

From the drop-down list, choose one of the these values— 256 , 384 , or 521 .

This field, which supports the Install/Upgrade, Delete, and Troubleshoot Certificate Operation options, specifies the date and time in which you must complete the operation.

This field displays the progress of the certificate operation; for example, <operation type> pending, failed, or successful, where operating type equals the

Install/Upgrade, Delete, or Troubleshoot Certificate

Operation options. You cannot change the information that displays in this field.

Choose the expansion module if it is installed in the phone.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

BAT Phone Template Field Descriptions

Field

Module1 Load Name

Module 2

Module 2 Load Name

Description

Enter the firmware load for the first

CiscoUnifiedIPPhone Expansion Module, if applicable. Leave this field blank to use the default load.

Choose the expansion module if it is installed in the phone.

Enter the firmware load for the second

CiscoUnifiedIPPhone Expansion Module, if applicable. Leave this field blank to use the default load.

CiscoUnifiedIPPhone - External Data Locations

Information

Phone File Formats

This chapter provides information about configuring file formats for CSV data files that are created using a text editor.

•

•

Find Phone File Formats, on page 113

•

Configure Phone File Format for CSV Data File, on page 114

•

Associate Text-Based File Format with CSV Data File, on page 117

Text Editors for Phone CSV Data File Creation

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.

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.

Note When you use the Unified Communications Manager Bulk Administration (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.

Related Topics

, on page 660

Find Phone File Formats

You can use the BAT to find a phone file format.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

113

Phones

Configure Phone File Format for CSV Data File

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Choose Bulk Administration > Phones > Phone File Format > Create File Format .

The Find and List Phone File Formats window displays.

From the Find Phone File Format where Format Name drop-down list box, choose one of the following criteria:

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty

Specify the appropriate search text, if applicable, and click Find.

Tip To find all phone formats, click Find without entering any search text.

To further define your query and to add multiple filters, check the Search Within Results check box and choose AND or OR from the drop-down box, and repeat

Step 2, on page 114

and

Step 3, on page 114 .

Tip To clear the text specified, click Clear Filter .

From the list of records, click the file format name that matches your search criteria.

The Create Phone File Format Configuration window displays.

Configure Phone File Format for CSV Data File

You can create, copy, modify, and delete a phone file format for a CSV data file.

Create Custom Phone File Format Using Text Editor

You can use a text editor to create a custom phone file format for the text-based CSV data file.

Procedure

Step 1

Step 2

Step 3

Step 4

Choose Bulk Administration > Phones > Phone File Format > Create File Format .

Click Add New .

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

Choose the fields to appear in the custom file format. Do the following: a) 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.

114

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Copy Custom Phone File Format for CSV Data File

Step 5

Step 6

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

Tip To select a range of items in the list, hold down the hold down the Ctrl key and click field names.

Shift key. To select random field names, b) Click a line field name in the Line Field box and click the arrow to move the field to the Selected Line

Fields box.

c) Click the intercom DN field names in the Intercom DN Fields box and click the arrow to move the fields to the Selected Intercom DN Fields Order box.

Tip You can change the order of the items in the Selected Line Fields , Selected Device Fields , and

Selected Intercom DN Fields Order boxes. Choose an item and use the up and down arrows to move the field up or down in the list.

In the IP Phone Services Maximums area, enter the maximum values for the following fields:

• Maximum Number of Speed Dials

• Maximum Number of BLF Speed Dials

• Maximum Number of BLF Directed Call Parks

• Maximum Number of IP Phone Services

• Maximum Number of IP Phone Service Parameters

Click Save .

The name of the custom file format displays in the File Format Names list in the Find and List Phone File

Formats window.

Related Topics

Find Phone File Formats , on page 113

, on page 660

Copy Custom Phone File Format for CSV Data File

You can copy an existing custom phone file format for the text-based CSV data file.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Find the phone file format that you want to copy.

In the Search Results area, choose the file format that you want to copy.

The Phone File Format Configuration window displays.

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

Tip You can also click the corresponding Copy icon in the Find and List Phone File Formats window to copy the file format.

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

Modify the fields that appear in the copied file format. Do the following:

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

115

Phones

Modify Custom File Format for CSV Data File

Step 6 a) To add new fields to the file format, click the field name in the Device Fields , Line Fields , or Intercom

DN Fields box and then click the arrow to move the field to the Selected Device Field , Selected Line

Fields , or Selected Intercom DN Fields Order box.

b) To remove fields from the file format, click the field name in the Selected Device Fields , Selected Line

Fields , or Selected Intercom DN Fields Order box and then click the arrow to move the field to the

Device Fields , Line Fields , or Intercom DN Fields box.

Note You cannot remove the required fields: Number of lines, MAC address, and description.

c) To change the order of items in the Selected Device Fields , Selected Line Fields , and Selected Intercom

DN Fields Order boxes, choose an item and use the up and down arrows to move the field up or down in the list.

Click Save .

The edited copy of the file format is saved.

Related Topics

Find Phone File Formats

, on page 113

Modify Custom File Format for CSV Data File

You can modify an existing custom file format for the text-based CSV data file. You can modify custom formats only.

Procedure

Step 1

Step 2

Step 3

Step 4

Find the phone file format that you want to modify.

In the Search Results area, choose the file format that you want to modify.

The Phone File Format Configuration window displays.

To modify the fields that appear in the file format, do the following: a) To add new fields to the file format, click the field name in the Device Fields , Line Fields , or Intercom

DN Fields box and then click the arrow to move the field to the Selected Device Field , Selected Line

Fields , or Selected Intercom DN Fields Order box.

b) To remove fields from the file format, click the field name in the Selected Device Fields , Selected Line

Fields , or Selected Intercom DN Fields Order box and then click the arrow to move the field to the

Device Fields , Line Fields , or Intercom DN Fields box.

Note You cannot remove the required fields: Number of lines, MAC address, and description.

c) To change the order of items in the Selected Device Fields , Selected Line Fields , and Selected Intercom

DN Fields Order boxes, choose an item and use the up and down arrows to move the field up or down in the list.

Click Save .

The changes to the custom file format are saved.

116

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Delete Existing CSV Data File Format

Delete Existing CSV Data File Format

You can delete an existing custom file format for the CSV data file. You can delete only custom formats.

Procedure

Step 1

Step 2

Step 3

Find the phone file format that you want to edit.

In the Search Results area, verify that this is the file(s) that you want to delete.

To remove the file format(s) from the list, click Delete Selected.

A message asks you to confirm that you want to delete the file format(s). Click OK to continue.

Tip Make sure you browse the entire list of displayed results before you click Delete Selected .

The system removes the file format(s) name from the list.

Related Topics

Find Phone File Formats , on page 113

, on page 660

Associate Text-Based File Format with 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.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Choose Bulk Administration > Phones > Phone File Format > Add File Format . Add File Format window displays.

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

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

In the Job Information area, enter the job description.

To create a job for associating the matching file format with the CSV data file, click Submit .

Use the Job Scheduler option in the Bulk Administration main menu to schedule and

/ or activate this job.

Related Topics

, on page 660

Validate CSV Data File Phone Records, on page 119

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

117

Associate Text-Based File Format with CSV Data File

Phones

118

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Phone Record Validation

This chapter provides information to validate phone records. When you choose Validate Phones, the system runs a validation routine to check that the CSV data file and Unified Communications Manager Bulk

Administration (BAT) phone template have populated all required fields, such as device pool and locations.

The validation also checks for discrepancies with the first node database.

You must have a BAT phone template for the devices that you are adding. You can use a standard phone template with multiple lines to add phones that have a single line or several lines. You must also have a data file in comma separated variable (CSV) format that contains the unique details for the phones or other IP telephony devices.

•

•

Validate CSV Data File Phone Records

You can validate your CSV data file phone records.

Before you begin

• You must have a BAT phone template for the devices that you are adding. You can use a standard phone template with multiple lines to add phones that have a single line or several lines.

• 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.

Procedure

Step 1

Step 2

Step 3

Step 4

Choose Bulk Administration > Phones > Validate Phones .

The Validate Phones Configuration window displays.

To validate phone records that use a customized file format, click Validate Phones Specific Details radio button and continue with

Step 4, on page 119

and

Step 5, on page 120 .

To validate phone records from an exported phones file that was generated by using the All Details option, click Validate Phones All Details radio button.

In the File Name drop-down list, choose the CSV data file that you created for this specific bulk transaction.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

119

Phones

Phone Validation Limitations

Step 5

Step 6

For the Specific Details option, in the Phone Template Name drop-down list box, choose the BAT phone template that you created for this type of bulk transaction.

To verify the chosen CSV data file with the first node database, click Submit .

The job gets submitted and gets executed immediately.

Related Topics

Standard Phone Templates

, on page 5

Phone Template, on page 21

, on page 629

Phone Validation Limitations

The validation of phones has the following limitations:

• The validation process only checks for the number of lines that are configured on the template; it does not check the line numbers that are configured on the template. After running the Validate phones specific details job, the administrator sees the following message in the log when the CSV date file contains more lines than are supported by the phone template: “WARNING: CSV contains more number of lines than are supported by the phone template.” If blank Directory Numbers and/or blank Speed dials and/or blank Busy Lamp Field Speed Dials exist, this indicates that the warning message that is displayed in the summary log file may be inaccurate.

• The validate process does not check whether mandatory fields are specified in the CSV file.

• If IP phone service parameters are specified in the phone text file, the validate process only checks whether a parameter exists with a name that is specified in the CSV on Unified Communications Manager.

It does not check whether the parameter that is specified is configured on the IP phone service.

Topics Related to Phone Record Validation

•

120

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Phone Insertions

This chapter provides information to add phones, Cisco VGC Phones, CTI ports, or H.323 clients into the

Cisco Unified Communications Manager database.

You must have a Cisco Unified Communications Manager Bulk Administration (BAT) phone template for the devices that you are adding, and a data file in comma separated value (CSV) format that contains the unique details for the phones or other IP telephony devices. You can choose the target and method of the data file upload. Phone records must be validated before insertion.

•

Insert Phones Into Unified Communications Manager, on page 121

•

Insert Phones Into Unified Communications Manager

When you insert phone records into the Unified Communications Manager database, you define the target

CSV data file and how the phone records get inserted. Select any combination of the listed actions to overwrite the existing phone records, or you can choose to insert the records during upload:

• Delete all existing Speed Dials before adding new one

• Delete all existing BLF Speed Dials before adding new one

• Delete all existing BLF Directed Call Parks before adding new one

• Delete all existing Subscribed Services before adding new one

Note Phone records must be validated before insertion.

Note BAT expects Directory Number URI fields for directory numbers in the following format:

URI 1 on Directory Number 1, URI 1 Route Partition on Directory Number 1, URI 1 is Primary on Directory

Number 1.

You can use the dummy MAC address option. When adding CTI ports, this option gives a unique device name to each CTI port in the form of dummy MAC addresses that you can manually update later using the

Unified Communications Manager Administration or the UnifiedCM Auto-Register Phone Tool. Do not use the dummy MAC address option for H.323 clients, VGC phones, or VGC virtual phones.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

121

Phones

Insert Phones Into Unified Communications Manager

The dummy MAC address option automatically generates dummy MAC addresses in the following format:

XXXXXXXXXXXX where X represents any 12-character, hexadecimal (0-9 and A-F) number.

Before you begin

• You must have a Unified Communications Manager Bulk Administration (BAT) phone template for the devices that you are adding. You can choose the target and method of the data file upload. Phone records must be validated before insertion.

• 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.

Procedure

Step 1

Step 2

Step 3

Step 4

Choose Bulk Administration > Phones > Insert Phones .

Specify the file format type for the phone record that you are uploading.

a) To insert phone records that use a customized file format, click Insert Phones Specific Details radio button and continue with

Step 3, on page 122

and

Step 5, on page 122

b) To insert phone records from an exported phone's file that was generated using the All Details option, click Insert phones All Details radio button.

In the File Name drop-down list box, choose the CSV data file that you created for this specific bulk transaction.

Next, check the Allow Update Phone with Custom File check box to allow updating the phone with the chosen custom file.

Check the Override the existing configuration check box to overwrite the existing phone settings with the information that is contained in the file that you want to insert. Next, check the check boxes beside the upload action(s) to perform during the upload.

The following upload actions get enabled for selection after you have checked the Override the existing configuration check box.

• Delete all existing Speed Dials before adding new one.

• Delete all existing BLF Speed Dials before adding new one.

• Delete all existing BLF Directed Call Parks before adding new one.

• Delete all existing Subscribed Services before adding new one.

Note Leave the check boxes clear to append those records to the existing records in the CSV data file during the upload.

Step 5 For the Specific Details option, in the Phone Template Name drop-down list, choose the BAT phone template that you created for this type of bulk transaction.

Attention If you did not enter individual MAC addresses in the CSV data file, you must check the Create

Dummy MAC Address check box. You can update this information manually later. Skip to

Step 8, on page 123 . If you supplied MAC addresses or device names in the data input file, do not choose

this option.

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

122

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Topics Related to Inserting Phones

Step 6

Step 7

Step 8

In the Job Information area, enter the Job description.

Choose an insert method. Do one of the following: a) Click Run Immediately to insert the phone records immediately.

b) Click Run Later to insert the phone records later.

Click Submit to create a job for inserting the phone records.

Use the Job Configuration window to schedule or activate this job.

What to do next

If the phones inserted are of the type Cisco Unified Mobile Communicator, then you must reset the devices after the insert job is completed. You can reset the phones using the Bulk Administration > Phones >

Reset/Restart Phones option.

Related Topics

, on page 639

Phone Template, on page 21

TAPS Overview

, on page 613

Topics Related to Inserting Phones

•

•

Phone File Formats, on page 113

•

Phone Record Validation, on page 119

•

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

123

Topics Related to Inserting Phones

Phones

124

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Phone Updates

This chapter provides information about how to use the Update Phones option to update phone settings, such as changing or adding the device pool or calling search space for a group of similar phones. You can locate existing phone records that you want to update using either a query or a custom file. After locating the phone records, you can proceed to define the update parameters.

•

Update Phones Using Query, on page 125

•

Update Phones Using Custom File, on page 126

•

Choose Update Parameters, on page 128

•

Phone Update Field Descriptions, on page 128

Update Phones Using Query

Create a query to locate phones to update. After locating phones following this procedure, you must proceed to choose the update parameters.

Procedure

Step 1

Step 2

Choose Bulk Administration > Phones > Update Phones > Query .

The Update Phones Query window displays.

Note To update all phones, click Find and do not specify a query. Skip the rest of this procedure and proceed to choose the update parameters for the phones.

From the first Find Phone where drop-down list box, choose one of the following criteria:

• Device Name

• Description

• Directory Number

• Calling Search Space

• Device Pool

• Device Type

• Call Pickup Group

• LSC Status

• LSC Expires

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

125

Phones

Update Phones Using Custom File

Step 3

Step 4

Step 5

Note

• LSC Issued by

• LSC Issuer Expires by

• Authentication String

• Location

• Phone Load Name

• Device Protocol

• Security Profile

• Last Active

• Last Registered

The status of LSC Expires and LSC Issuer Expires by fields are set to “NA” when there is no

LSC issued on a new device.

The status of LSC Expires and LSC Issuer Expires by fields are set to “ Unknown” when the

LSC is issued to a device before the upgrade to Unified Communications Manager11.5(1).

From the second Find Phone where drop-down list box, choose one of the following criteria:

• is before

• is exactly

• is after

• begins with

• contains

• ends with

• is exactly

• is empty

• is not empty

Specify the appropriate search text, if applicable.

Tip To find all phones that are registered in the database, click Find without entering any search text.

To further define your query and to add multiple filters, check the Search Within Results check box, choose

AND or OR from the drop-down box, and repeat

Step 2, on page 125

and

Step 3, on page 126

Click Find .

A list of discovered phones displays. The Update Phones window displays the details of the phones that you choose.

What to do next

To complete the procedure for updating phones, continue to the

Choose Update Parameters, on page 128

Update Phones Using Custom File

Create a custom file to locate phones to update. After locating phones following this procedure, you must proceed to choose the update parameters.

126

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Update Phones Using Custom File

Note Do not use the insert or export transaction files that are created with bat.xlt for the update transaction. Instead, you must create a custom file with details of the phone records that need to be updated. Use only this file for the update transaction.

Before you begin

Identify the devices that you need to update.

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

• Device names

• Directory numbers

• Description

Note Enter values for device name, description, or directory number in the custom update file. You do not need to include a header in the custom update file.

Upload the text file to the Unified Communications Manager server. See

Upload File to Server, on page

Procedure

Step 1

Step 2

Step 3

Step 4

Choose Bulk Administration > Phones > Update Phones > Use Custom File .

The Update Phones Custom Configuration window displays.

In the Update Phones where drop-down list box, choose the type of custom file that you have created from the following criteria:

• Device Name

• Directory Number

• Description

In the list of custom files, choose the filename of the custom file for this update.

Click Find .

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

What to do next

To complete the procedure for updating phones, continue to the

Choose Update Parameters, on page 128

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

127

Phones

Choose Update Parameters

Choose Update Parameters

After you have located the phones to update, you can choose the parameters and define values for updating those phones.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

Step 8

In the Update Phones Query window, click Next .

The Update Phones shows the type of query that you chose. If you want to change the type of query, click

Back .

Choose the Logout Users before Update check box to log out the users prior to the update.

You can also use this option to bulk log out users if no fields are chosen.

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

Table 5: Field Descriptions for Update Phones, on page 129

for descriptions of parameters.

Select the update check box to the left of the field that you want to update.

This tells BAT to overwrite the existing value for the field.

Note Be aware that BAT updates only those fields for which you have selected the update check box.

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

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

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

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

• Restart phones—To reset phones without power-cycling

• Apply Config—To reset only the settings that have changed since the last reset

Update the required phone parameters. See

Table 5: Field Descriptions for Update Phones, on page 129

for field descriptions.

To create a job for updating the records, click Submit .

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

Related Topics

Delete Phones Using Query, on page 149

, on page 629

Phone Update Field Descriptions

The following table 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 Unified Communications Manager. You must configure these values by using Unified Communications Manager Administration.

128

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Phone Update Field Descriptions

Note Be aware that some fields have two check boxes. The first check box determines if you need to update the field; the second check box determines the value (checked or unchecked) to use for the field.

Tip Check the first check box if you need to update the field and the second check box to apply a checked value to the phones you select. For example, if you check the first check box for Do Not Disturb and leave the second one unchecked, you update phones with an unchecked value for Do Not Disturb.

Table 5: Field Descriptions for Update Phones

Field

Description

DevicePool

Common Device Configuration

Phone Button Template

Softkey Template

Common Phone Profile

Description

Enter a description that makes the device easy to recognize. The description can include up to 50 characters in any language, but it cannot include double-quotes ("), percentage sign (

), ampersand

(&), back-slash (

), or angle brackets (<>).

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

A devicepool defines sets of common characteristics for devices, such as region, date/time group, Unified

Communications Manager group, and calling search space for auto-registration.

To see the common device configuration settings, click the View Details link.

Choose the appropriate phone button template. The phone button template determines the configuration of buttons on a phone and identifies which feature

(line, speed dial, and so on) is used for each button.

Unified Communications Manager does not make this field available for H.323 clients or CTI ports.

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

From the drop-down list, choose a common phone profile from the list of available common phone profiles.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

129

Phone Update Field Descriptions

Field

Calling Search Space

AAR Calling Search Space

Media Resource Group List

User Hold MOH Audio Source

Network Hold MOH Audio Source

Location

AAR Group

Phones

Description

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.

(originating) number that is otherwise blocked due to insufficient bandwidth.

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.

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.

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.

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.

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. If no AAR group is specified, Unified Communications Manager uses the AAR group that is associated with Device

Pool or Line.

130

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Field

User Locale

Network Locale

Built in Bridge

Privacy

Device Mobility Mode

Phone Update Field Descriptions

Description

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 Unified Communications

Manager user windows and phones.

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.

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

For each phone that wants Privacy, choose On in the

Privacy drop-down list.

For more configuration information, refer to Barge and Privacy Features in the Feature Configuration

Guide for Cisco Unified Communications Manager .

From the drop-down list, turn the device mobility feature on or off for this device or choose Default to use the default device mobility mode.

Click View Current Device Mobility Settings to display the current values of these device mobility parameters:

• Cisco Unified Communications Manager Group

• Roaming Device Pool

• Location

• Region

• Network Locale

• AAR Group

• AAR Calling Search Space

• Device Calling Search Space

• Media Resource Group List

• SRST

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

131

Phone Update Field Descriptions

Field

Mobility User ID

Owner User ID

Phone Personalization

Phones

Description

From the drop-down list, choose the user ID of the person to whom this dual-mode phone is assigned.

Note Be aware that the Mobility User ID configuration is used for Mobile Connect and Mobile Voice Access for dual mode phones.

Note The Owner User ID and Mobility User ID can differ.

Enter a user ID for the primary phone user.

From the drop-down list, enable or disable the Cisco

Unified Phone Designer feature for this device or choose Default to use the phone personalization that is set in the Common Phone Profile.

• Disabled—None of the Cisco Unified Phone

Application Suite features get activated.

• Default—Use the phone personalization setting that is in the Common Phone Profile.

132

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Field

Services Provisioning

Phone Load Name

Single Button Barge

Phone Update Field Descriptions

Description

From the drop-down list, choose the Services

Provisioning setting that you want to use from the following values:

• Internal

• External URLs

• Both

• Default: Internal

This parameter controls whether the phone uses the services provisioned from the configuration file

(Internal), services received from the Services URLs

This is a required field.

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 CiscoUnifiedIPPhone.

From the drop-down list, enable or disable the Single

Button Barge/cBarge feature for this device or choose

Default to use the service parameter setting.

• Off—This setting disables the Single Button

Barge/cBarge feature; however, the regular Barge or cBarge features will still work.

• Barge—This setting enables the Singe Button

Barge feature.

• cBarge—This setting enables the Single Button cBarge feature.

• Default—This setting uses the Single Button

Barge/cBarge setting that is in the service parameter.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

133

Phone Update Field Descriptions

Field

Join Across Lines

Use Trusted Relay Point

Phones

Description

From the drop-down list, enable or disable the Join

Across Lines feature for this device or choose Default to use the service parameter setting.

• Off—This setting disables the Join Across Lines feature.

• On—This setting enables the Join Across Lines feature.

• Default—This setting uses the Join Across Lines setting that is in the service parameter.

From the drop-down list, enable or disable whether

Unified Communications Manager inserts a trusted relay point (TRP) device with this media endpoint.

Choose one of the following values:

• Default—If you choose this value, the device uses the Use Trusted Relay Point setting from the common device configuration with which this device associates.

• Off—Choose this value to disable the use of a

TRP with this device. This setting overrides the

Use Trusted Relay Point setting in the common device configuration with which this device associates.

• On—Choose this value to enable the use of a

TRP with this device. This setting overrides the

Use Trusted Relay Point setting in the common device configuration with which this device associates.

A Trusted Relay Point (TRP) device designates an

MTP or transcoder device that is labeled as Trusted

Relay Point.

Unified Communications Manager places the TRP closest to the associated endpoint device if more than one resource is needed for the endpoint (for example, a transcoder or RSVP Agent).

If both TRP and MTP are required for the endpoint,

TRP gets used as the required MTP.

134

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Field

Calling Party Transformation CSS

Geolocation

Emergency Location (ELIN) Group

Feature Control Policy

BLF Audible Alert Setting (Phone Idle)

Phone Update Field Descriptions

Description

This setting allows you to localize the calling party number on the device. Make sure that the Calling

Party Transformation CSS that you choose contains the calling party transformation pattern that you want to assign to this device.

The device takes on the attributes of the Calling Party

Transformation Pattern when you assign the pattern to a partition where the Calling Party Transformation

CSS exists.

From the drop-down list, choose a geolocation.

You can choose the Unspecified geolocation, which designates that this device does not associate with a geolocation.

You can also choose a geolocation that has been configured with the System > Geolocation

Configuration menu option.

Choose the Emergency Location (ELIN) group to which this group of phones should belong. An ELIN group identifies a location to which ELINs under this

ELIN group must be mapped in the ALI database.

Choose the Feature Control Policy for this group of phones.

A feature control policy specifies the appearance of features and the associated softkeys that display on the phone.

For this required field, from the drop-down list, choose the BLF Audible Alert setting that you want to use from the following values:

• On

• Off

• Default

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

135

Phones

Phone Update Field Descriptions

Field

BLF Audible Alert Setting (Phone Busy)

Always Use Prime Line

Description

For this required field, this parameter provides an audible alert in addition to a visual alert on a phone that is currently in use when a call comes in to one of the lines that is monitored by way of a busy lamp field

(BLF) button.

From the drop-down list, choose the BLF Audible

Alert setting that you want to use from the following values:

• On

• Off

• Default

From the drop-down list, choose the Always Use

Prime Line setting that you want to use from the following values:

• On

• Off

• Default

Always Use Prime Line for Voice Message From the drop-down list, choose the Always Use

Prime Line for Voice Message setting that you want to use from the following values:

• On

• Off

• Default

Use Device Pool Calling Party Transformation CSS To use the Calling Party Transformation CSS that is configured in the device pool that is assigned to this device, check this check box. If you do not check this check box, the device uses the Calling Party

Transformation CSS that you configured in the device configuration window.

Ignore Presentation Indicators

Retry Video Call as Audio

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

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

136

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Field

Allow Control of Device from CTI

Logged into Hunt Group

Remote Device

Protected Device

Phone Update Field Descriptions

Description

Check this check box to allow CTI to control and monitor this device.

If the associated directory number specifies a shared line, the check box should remain enabled as long as at least one associated device specifies a combination of device type and protocol that CTI supports.

Note Cisco dual-mode devices (Jabber) such as

Android, iPhone, and iPad operating in

WiFi mode are monitored through CTI and not controlled. However, devices operating in GSM mode cannot be monitored or controlled.

Users use the softkey on the phone to log their phone in or out of the hunt list.

If you are experiencing delayed connect times over

Note Because this feature consumes resources, be sure to check this check box only when you are experiencing signaling delays for phones that run SCCP. Most users do not require this option.

Check this check box to designate a phone as

Protocol Specific Information

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

137

Phone Update Field Descriptions

Field

Packet Capture Mode

Packet Capture Duration

Presence Group

Device Security Profile

SUBSCRIBE Calling Search Space

Phones

Description

From the drop-down list, 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.

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

Used with the Presence feature, the phones that is running SIP or SCCP serves as a watcher because it requests status about the presence entity, for example, directory number, that is configured as a BLF speed dial button on the phone.

If you want the phone to receive the status of the presence entity, choose a Presence Group that is allowed to view the status of the Presence Group that is applied to the directory number, as indicated in the

Presence Group Configuration window.

For phones that run SCCP and SIP, choose the security profile that you want to apply to the device.

All phones require that you apply a security profile.

If the phone does not support security, choose a nonsecure profile.

Tip The CAPF settings that are configured in the profile relate to the Certificate

Authority Proxy Function settings that display in the Phone Configuration window. If you want to manage manufacture-installed certificates (MICs) or locally significant certificates (LSC), you must configure the CAPF settings in the profile and in the Phone

Configuration window.

Used with the Presence feature, the SUBSCRIBE

Calling Search Space determines how Unified

Communications Manager routes the subscription requests that come from the phone. From the drop-down list, choose the calling search space that you want to use for this purpose.

138

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Field

Outbound Call Rollover

Unattended Port

Require DTMF Reception

External Data Locations Information

Information

Phone Deletions

This chapter provides information to delete a group of phones or other IP telephony devices from the Cisco

Unified Communications Manager database. You can locate existing phone records that you want to delete using either a query or a custom file. You can also search for and delete unassigned directory numbers.

•

•

Delete Phones Using Custom File, on page 151

•

Delete Unassigned Directory Numbers, on page 152

Delete Phones Using Query

Create a query to locate phone records for deletion.

Caution The delete action is final. You cannot retrieve deleted records.

Procedure

Step 1

Step 2

Choose Bulk Administration > Phones > Delete Phones > Query .

The Bulk Phones Delete Configuration window displays.

From the first Find Phone where drop-down list box, choose one of the following criteria:

• Device Name

• Description

• Directory Number

• Calling Search Space

• Device Pool

• Device Type

• Call Pickup Group

• LSC Status

• Authentication String

• Device Protocol

• Security Profile

• Unassigned DN

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

149

Phones

Delete Phones Using Query

Step 3

Step 4

Step 5

Step 6

Step 7

Step 8

• Last Registered

• Last Active

From the second Find Phone where drop-down list box, choose one of the following criteria:

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty

Specify the appropriate search text, if applicable.

Tip To find all phones that are registered in the database, click Find without entering any search text.

To further define your query and to add multiple filters, check the Search Within Results check box, choose

AND or OR from the drop-down box, repeat

Step 2, on page 149

and

Step 3, on page 150 .

Click Find .

A list of discovered phones displays by

• Device Name

• Description

• Device Pool

• Device Protocol

• Status

• Last Registered

• Last Active

• Unified CM

• IP Address

In the Job Information area, enter the Job description.

Choose a deletion method. Do one of the following: a) Click Run Immediately to delete phone records immediately b) Click Run Later to delete the phone records at a later time.

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

Click Submit to create a job for deleting the phone records.

Note Make sure you browse the entire list of displayed results before submitting the job.

To schedule and/or activate this job, use the Job Configuration window.

Related Topics

150

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Delete Phones Using Custom File

Delete Phones Using Custom File

You can create a custom file of phones that you want to delete 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 Do not use the insert or export transaction files that are created with bat.xlt for the delete transaction. Instead, you must create a custom file with details of the phone records that need to be deleted. Use only this file for the delete transaction.

Caution The delete action is final. You cannot retrieve deleted records.

Before you begin

Create a text file that lists one of these details on separate lines for each phone that you want to delete:

• Device names

• Description

• Directory numbers

Note Enter values for device name, description, or directory number in the custom delete file. You do not need to include a header in the custom delete file.

Upload the custom file to Unified Communications Manager server.

Procedure

Step 1

Step 2

Step 3

Step 4

Choose Bulk Administration > Phones > Delete Phones > Custom File .

The Bulk Phones Delete Configuration window displays.

In the Delete Phones where drop-down list box, choose the type of custom file that you have created from one of the following criteria:

• Device Name

• Directory Number

• Description

In the list of custom files, choose the filename of the custom file for this delete.

Click Find . A list of phones matching your search criteria display.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

151

Phones

Delete Unassigned Directory Numbers

Step 5

Step 6

Step 7

In the Job Information area, enter the Job description.

Choose a deletion method. Do one of the following: a) Click Run Immediately to delete phone records immediately b) Click Run Later to delete the phone records at a later time.

Caution The delete action is final. You cannot retrieve deleted records.

Click Submit to create a job for deleting the phone records.

To schedule and/or activate this job, use the Job Configuration window.

Related Topics

, on page 629

Delete Unassigned Directory Numbers

Delete unassigned directory numbers for phone records that you locate using query.

Caution The delete action is final. You cannot retrieve deleted unassigned directory numbers.

Procedure

Step 1

Step 2

Step 3

Step 4

Choose Bulk Administration > Phones > Delete Phones > Delete Unassigned DN .

The Delete Unassigned Directory Numbers window displays.

From the first Delete Bulk Unassigned Directory Number where drop-down list box, choose one of the following criteria:

• Pattern

• Description

• Route Partition

From the second Delete Bulk Unassigned Directory Number where drop-down list box, choose one of the following criteria:

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty

Specify the appropriate search text, if applicable.

Click Find .

152

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Delete Unassigned Directory Numbers

Step 5

Step 6

Step 7

A list of discovered phones displays by the following criteria:

Tip

• Pattern

• Description

• Partition

To find all unassigned directory numbers that are registered in the database, click Find without entering any search text.

In the Job Information area, enter the Job description.

The default description is Delete Unassigned DN - Query.

Choose a deletion method. Do one of the following: a) Click Run Immediately to delete the unassigned directory numbers immediately.

b) Click Run Later to delete the phone records at a later time.

Caution The delete action is final. You cannot retrieve deleted unassigned directory numbers.

Click Submit to create a job for deleting the phone records.

Note Make sure you browse the entire list of displayed results before submitting the job.

To schedule and/or activate this job, use the Job Configuration window.

Related Topics

, on page 639

Phone Record Exports, on page 155

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

153

Delete Unassigned Directory Numbers

Phones

154

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Phone Exports

This chapter provides information about using the export utility to merge records from multiple Cisco Unified

Communications Manager servers onto one Cisco Unified Communications Manager server.

•

•

Exported Phone Record Fields, on page 156

•

Export Phone Records, on page 158

•

Multiple User Phones to Export or Import, on page 160

•

Phone Record Exports

Use the phone record export option to move records from one Unified Communications Manager server to another. Only export the records that you are interested in moving. You can export the following:

• phone records

• user records

• user device profile records

Optionally, you can edit the CSV file with a text editor. The record format must follow the format that is specified for that file format. For example, records for phones need to follow the phone file format.

Caution Use extreme care when editing the CSV file. Phones might not work if you insert records that are in the wrong format.

You can choose between two file format options when you export phone records:

• Specific Details—For phones that have similar configurations

• All Details—For phones that have different line configurations, such as multiple partitions or calling search spaces

When you are ready to insert the exported records, the order in which the records are inserted is important.

You must insert user records first to ensure that devices properly associate with existing users.

Upload the CSV file to Unified Communications Manager server.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

155

Phones

Exported Phone Record Fields

Insert User Records.

Insert Phone Records.

Insert User Device Profile Records.

Check the log files for errors.

Related Topics

Export User Device Profile Records , on page 355

Export Phone Records

, on page 158

Export User Records

, on page 239

Table 6: Exported Fields in the Default Phone File Format, on page 156

Exported Phone Record Fields

Default Phone File Format Exported Fields

The export Default Phone file format option is useful when you want to export phone file formats for phones that have similar configurations. Default phone records are exported using a defined query.

The following table lists the fields that are exported when you choose the Default Phone file format.

Table 6: Exported Fields in the Default Phone File Format

Field types

Device Fields

Line Fields

Exported fields

MAC Address, Description, Location

Directory Number, Display, Line Text Label, Forward

Busy External, Forward Busy Internal, Forward No

Answer Internal, Forward No Answer External,

Forward No Coverage Internal, Forward No Coverage

External, Call Pickup Group

All Phone Details File Format Exported Fields

When you export phone records using All Phone Details option, you export phone records for a particular model of phone along with all the device field information, different line attributes, and services that are associated with the phone, or you can export all phone models in a single file. To export all phone types to a single file, you can choose All Phone Types from the Select the Device Type drop-down list box. You cannot use the query to limit the number of records.

The following table lists the fields that are exported when you choose the All Phone Details file format.

Note The device name, not the MAC Address, gets saved when you choose to export by using the All Phone Details file format.

156

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Exported Phone Record Fields

Table 7: Exported Fields in the All Phone Details File Format

Field types

Device Fields

Model Specific Device Fields

Exported fields

Device Name, Description, Owner User ID, Device

Pool, CSS, AAR CSS, Media Resource Group List,

User Hold Audio Source, Network Hold Audio

Source, Location, User Locale, Network Locale,

Phone Button Template, Expansion Module type I,

Expansion Module type II, Softkey Template, Phone

Load Name, Module 1 Load Name, Module 2 Load

Name, Login user ID, Built in Bridge, MLPP

Indication, MLPP Preemption, MLPP Domain, Retry

Video call as Audio, Privacy, Security Mode, Ignore

Presentation Indicators, Single Packet Capture mode,

Packet Capture Duration, Certificate Operation,

Authentication Mode, Authentication String, Key Size

(bits), Operation Completes By

Information, Directory, Messages, Services,

Authentication Server, Proxy Server, Idle, Idle Timer,

Enable Extension Mobility, Logout Profile, Login

User ID, Login Time, Logout Time, Product Specific

XML

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

157

Phones

Export Phone Records

Field types

Line Fields

User Fields

Speed Dials

Services

Exported fields

Directory Number, Partition, Voice Mail Profile, Line

CSS, AAR Group, Line User Hold Audio Source,

Line Network Hold Audio Source, Auto Answer,

Forward All to Voice Mail, Forward All Destination,

Forward All CSS, Forward Busy External to Voice

Mail, Forward Busy External Destination, Forward

Busy External CSS, Forward No Answer External to

Voice Mail, Forward No Answer External Destination,

Forward No Answer External CSS, Forward On

Failure to Voice Mail, Forward On Failure

Destination, Forward on Failure CSS, Call pickup group, Forward Busy Internal to Voice Mail, Forward

Busy Internal Destination, Forward Busy Internal

CSS, Forward No Answer Internal to Voice Mail,

Forward No Answer Internal Destination, Forward

No Answer Internal CSS, Forward No Call Coverage

External to Voice Mail, Forward No Call Coverage

External Destination, Forward No Call Coverage

External CSS, Forward No Call Coverage Internal to

Voice Mail, Forward No Call Coverage Internal

Destination, Forward No Call Coverage Internal CSS,

Display, External Phone Number Mask, Message

Waiting Lamp Policy, Ring Setting When Idle, Line

Text Label, Ring Setting When Active, No Answer

Ring Duration, MLPP Target Destination, MLPP

Calling Search Space, MLPP No Answer Ring

Duration, Max Num Calls, Busy Trigger, Call Info

Display Mask, Alerting Name

User ID

Speed Dial Number, Speed Dial Label

Service Name, Subscribed Service Name, Parameter

Name, Parameter Value

Export Phone Records

You can export phone records from the Cisco Unified Communications Manager database. After the phone records are exported, you can search and download the exported file using the Upload/Download Files option in the Bulk Administration menu.

Procedure

Step 1 Choose one of the following options:

158

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Export Phone Records

Step 2

Step 3

Step 4

Step 5

Step 6

• Bulk Administration > Phones > Export Phones > Specific Details . The Export Phones Query window displays.

• Bulk Administration > Phones > Export Phones > All Details . The Export Phone Configuration window displays.

For All Details option, choose the type of device or specific model in the Device Type drop-down list box.

Skip to

Step 4, on page 159

See

for the list of exported fields in this format.

For Specific Details , you can customize the export file by choosing which set of phones to export, but you cannot configure the phone details.

a) From the first Find Phone where , drop-down list box, choose from the following options:

• Device Name

• Description

• Directory Number

• Calling Search Space

• Device Pool

• Call Pickup Group

• LSC Status

• Authentication String

• Security Profile

• Last Registered

• Last Active b) In the second drop-down list box, choose from the following options:

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty c) In the search field

/ list box, either choose or enter the value that you want to locate, such as a device name.

d) You can click the Search Within Results check box and choose AND or OR to add multiple filters and repeat

3.a, on page 159

through

3.c, on page 159

to further define your query.

e) Click Find .

The search results display.

f) Click Next .

The Export Phones Configuration window displays.

g) From the File Format drop-down list box, choose a Phone file format.

Enter the export file name in the File Name text box.

In the Job Information area, enter the Job description.

Choose an export method. Do one of the following: a) Click Run Immediately to export phone records immediately.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

159

Phones

Multiple User Phones to Export or Import

Step 7 b) Click Run Later to export at a later time.

To create a job for exporting phone records, click Submit .

To schedule and

/ or activate this job, use the Job Scheduler option in the Bulk Administration main menu.

Related Topics

, on page 629

Export Phone Records, on page 158

, on page 15

Multiple User Phones to Export or Import

The exported file name gets suffixed with the timestamp. If a recurring job is scheduled for export phones, the information gets exported with same filename but different timestamps.

When you import the exported file that has phones with multiple users, all users get exported in the same record.

Topics Related to Phone Exports

•

•

Export User Records, on page 239

•

Export User Device Profile Records, on page 355

160

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Phone Line Addition and Updates

This chapter provides information to update line attributes for a specific group of devices or user device profiles using 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 Unified Communications Manager 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.

You can add lines to a group of existing phones or user device profiles in the Cisco Unified Communications

Manager database. When you use the template to add new lines, you cannot change phone services or speed dials. Cisco Unified Communications Manager Bulk Administration (BAT) ignores those fields on the template when you add lines to existing devices.

•

Update Phone Lines Using Query, on page 161

•

Phone Line Update Field Descriptions, on page 163

•

Add Phone Lines to Existing Phones and UDPs, on page 171

•

Add Phone Lines to Existing Phones Using BAT Spreadsheet, on page 172

•

Phone Line Field Descriptions for Line Additions Using BAT Spreadsheet, on page 173

Update Phone Lines Using Query

You can update phone lines using query.

Procedure

Step 1

Step 2

Choose Bulk Administration > Phones > Add/Update Lines > Update Lines or Bulk Administration >

User Device Profiles > Add/Update Lines > Update Lines .

The Update Lines Query window displays.

Note You can update all lines by not specifying a query. Skip to

on page 163

Phone Line Update Field Descriptions,

From the first Find Line where drop-down list box, choose one of the following criteria:

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

161

Phones

Update Phone Lines Using Query

Step 3

Step 4

Step 5

Step 6

Step 7

Step 8

Step 9

Step 10

• Directory Number

• Route Pattern

• Line Description

• Calling Search Space (Phone)

• Calling Search Space (Line)

• Device Pool

• Device Description

• Line Position

• Unassigned DN

• Call Pickup Group

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

From the second Find Line where drop-down list box, choose one of the following criteria:

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty

In the search field list box, choose or enter the value that you want to locate.

Example:

You can choose the Route Partition from the list or enter a range of directory numbers.

Tip To find all lines that are registered in the database, click Find without entering any search text.

To further define your query and to add multiple filters, check the Search Within Results check box, choose

AND or OR from the drop-down box, and repeat

Step 2

and

Step 3 .

To display the records that are going to be affected, click Find .

A list of discovered lines displays by

• Pattern/Directory Number

• Partition

• Description

Click Next .

The Update Lines window shows the type of query that you chose at the top.

Tip If you want to change the type of query, click Back .

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

Phone Line Update Field Descriptions, on page 163

for field descriptions.

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

In the Job Information area, enter the Job description.

Choose an insert method. Do one of the following:

162

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Phone Line Update Field Descriptions

Step 11 a) Click Run Immediately to insert lines immediately.

b) Click Run Later to insert at a later time.

To create a job for inserting the phone records, click Submit .

To schedule this job, activate this job, or both, use the Job Configuration window.

Related Topics

, on page 639

Phone Line Update Field Descriptions

The following table provides the field descriptions for updating line details.

Values that display in some fields display from Unified Communications Manager. You must configure these values by using Unified Communications Manager Administration.

Table 8: Field Descriptions for Updating Line Details

Field

Route Partition

Description

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)

Calling Search Space Forward All

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.

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.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

163

Phones

Phone Line Update Field Descriptions

Field

Forward All to Voice Mail

Calling Search Space Forward Busy External

Description

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.

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.

Park Monitoring Forward No Retrieve Destination

External

Park Monitoring Forward No Retrieve Destination

Internal

When the parkee is an external party, then the call will be forwarded to the specified destination in the parker'’s Park Monitoring Forward No Retrieve

Destination External parameter. If the Forward No

Retrieve Destination External field value is empty, the parkee will be redirected to the parker’s line.

When the parkee is an internal party, then the call will be forwarded to the specified destination in the parker’s Park Monitoring Forward No Retrieve

Destination Internal parameter. If the Forward No

Retrieve Destination Internal is empty, the parkee will be redirected to the parker’s line.

Park Monitoring Forward No Retrieve Internal Voice

Mail

Check this check box to use settings in the Voice Mail

Profile Configuration window.

When this check box is checked, Unified

Communications Manager ignores the settings in the

Destination box and Calling Search Space.

Park Monitoring Forward No Retrieve External Voice

Mail

Check this check box to use settings in the Voice Mail

Profile Configuration window.

When this check box is checked, Unified

Communications Manager ignores the settings in the

Destination box and Calling Search Space.

Park Monitoring Forward No Retrieve External CSS Choose the calling search space to apply to the directory number.

Park Monitoring Forward No Retrieve Internal CSS Choose the calling search space to apply to the directory number.

164

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Phone Line Update Field Descriptions

Field

Park Monitoring Reversion Timer

Log Missed Calls

Party Entrance Tone

Calling Search Space Forward Busy Internal

Description

This parameter determines the number of seconds that

Unified Communications Manager waits before prompting the user to retrieve a call that the user parked. This timer starts when the user presses the

Park softkey on the phone, and a reminder is issued when the timer expires.

Default: 60 seconds

If you configure a non-zero value, this value overrides the value of this parameter set in the Service

Parameters window. However, if you configure a value of 0 here, then the value in the Service

Parameters window will be used.

This check box allows you to turn this feature on or off. If the check box displays as checked (turned on), which is the default for this setting, Unified

Communications Manager logs missed calls in the call history for that directory number on the phone.

Choose one of the following options from the drop-down list box:

• Default—Use the value that you configured in the Party Entrance Tone service parameter.

Unified Communications Manager does not play the tone even if you choose On.

• Off—A tone does not play on the phone when a basic call changes to a multi-party call.

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.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

165

Phones

Phone Line Update Field Descriptions

Field

Forward Busy Destination External

Forward Busy Destination Internal

Description

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.

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

Forward Busy 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 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.

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 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 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.

166

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Phone Line Update Field Descriptions

Field

Forward No Answer Destination External

Forward No Answer Destination Internal

Description

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.

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

Forward No Answer to Voice Mail Internal

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 not relevant.

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 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.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

167

Phones

Phone Line Update Field Descriptions

Field

Forward No Coverage Destination External

Forward No Coverage Destination Internal

Forward No Coverage to Voice Mail External

Forward No Coverage to Voice Mail Internal

Calling Search Space Forward on Failure

External/Internal

Forward on Failure Destination External/Internal

Description

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.

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.

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 not relevant.

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 not relevant.

(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.

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

168

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Phone Line Update Field Descriptions

Field

Forward on Failure to Voice Mail External/Internal

Call Forward No Answer Ring Duration

Description

(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.

Enter the number of seconds (between 1 and 300) to allow the call to ring, before forwarding the call to the destination number that is entered in the Forward

No Answer Destination field.

Note Leave this field blank to use the value that is set in the Unified Communications

Manager service parameter, Forward No

Answer Timer.

User Hold Audio Source

Network Hold Audio Source

Auto Answer

Voice Mail Profile

Ring Setting When Idle

Ring Setting when Active

Call Pickup Group Name

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

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.

Choose this parameter if you want all lines that are updated here to use the auto answer feature. With auto answer, Unified Communications Manager automatically answers calls when a headset is in use.

A zip tone plays to alert the user that an incoming call connected.

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.

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

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.

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.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

169

Phones

Phone Line Update Field Descriptions

Field

AAR Group

Target (Destination)

MLPP Calling Search Space

MLPP No Answer Ring Duration

External Phone Number Mask

Maximum Number of Calls

Description

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.

To prevent rerouting blocked calls, set AAR Group to <None>.

Values can include numeric characters, pound(

), and asterisk (

From the drop-down list box, choose the calling search space to associate with the alternate party target

(destination) number.

Enter the number of seconds (between 4 and 30) after which an MLPP precedence call will be directed to the alternate party for 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 Unified Communications Manager enterprise parameter, Precedence Alternate Party Timeout.

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.

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.

170

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Add Phone Lines to Existing Phones and UDPs

Field

Busy Trigger

Description

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, incoming call 41 gets rejected with a busy cause (and will get forwarded if Call Forward Busy is set). If this line is shared, incoming calls do not get rejected unless all the lines are busy.

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

4500 calls.

Add Phone Lines to Existing Phones and UDPs

You can add lines to exiting phones and UDP templates.

Before you begin

• You must have a BAT template for this transaction.

• You must have a CSV data file for this transaction.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

Choose Bulk Administration > Phones > Add/Update Lines > Add Lines .

The Phone Add Lines window displays.

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

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

If you are changing the phone settings for existing phones in the template, check the Update the existing phone button template check box.

The user phone information also gets updated when this check box is checked.

In the Job Information area, enter the Job description.

Choose an insert method. Do one of the following: a) Click Run Immediately to insert the phone records immediately.

b) Click Run Later to insert the phone records at a later time.

To create a job for adding lines to existing phones and UDPs, click Submit .

To schedule, this job, activate this job, or both, use the Job Configuration window.

, on page 172

, on page 24

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

171

Phones

Add Phone Lines to Existing Phones Using BAT Spreadsheet

Table 9: Field Descriptions for Adding Lines Using the

, on page 629

Add Phone Lines to Existing Phones Using BAT Spreadsheet

You can create a CSV data file using the BAT spreadsheet to add phone lines to existing phones.

After you have finished adding lines in the BAT spreadsheet, you can export the content to a CSV formatted data file. A default filename is assigned to the exported CSV formatted data file:

<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.

The system saves the file to C:\XLSDataFiles\ , or you can save the file to another existing folder on your local workstation. You can rename the CSV formatted data file after you save the exported file to your local workstation. 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.

Note You cannot upload a CSV filename that contains a comma (for example, abcd,e.txt) to the Unified

Communications Manager server.

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

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

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

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

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

Select the Phones radio button to add lines to a phone.

Note You can choose to add lines to a User Device Profile by selecting the User Device Profile radio button.

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. See

BAT Spreadsheet, on page 173

for field descriptions.

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

Format .

Tip For information on how to read the exported CSV data file, click the link to the Insert phones window in BAT.

View Sample File in

172

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Phone Line Field Descriptions for Line Additions Using BAT Spreadsheet

The system saves the file to C:\XLSDataFiles\ with the default filename

<tabname>-<timestamp>.txt

, or you can use Browse to save the file to another existing folder on your local workstation.

, on page 8

Reset or Restart Phone Using Query, on page 179

, on page 17

Phone Line Field Descriptions for Line Additions Using BAT

Spreadsheet

The following table provides the field descriptions when you add lines using the BAT spreadsheet.

Table 9: Field Descriptions for Adding Lines Using the BAT Spreadsheet

Field

MAC Address

Line Index

Directory Number

Display

Description

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

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

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

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 field 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 or directory URI 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.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

173

Phones

Phone Line Field Descriptions for Line Additions Using BAT Spreadsheet

Field

Forward No Answer External

Forward No Coverage External

Forward Busy Internal

Forward No Answer Internal

Forward No Coverage Internal

Call Pickup Group

Description

Enter the directory number or directory URI 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.

Enter the directory number or directory URI 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.

Enter the directory number or directory URI 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.

Enter the directory number or directory URI 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.

Enter the directory number or directory URI 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.

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.

174

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Phone Line Field Descriptions for Line Additions Using BAT Spreadsheet

Field

Park Monitoring Forward No Retrieve Destination

External

Description

When the parkee is an external party, then the call will be forwarded to the specified destination in the parker’s Park Monitoring Forward No Retrieve

Destination External parameter. If the Forward No

Retrieve Destination External field value is empty, the parkee will be redirected to the parker’s line.

Park Monitoring Forward No Retrieve Destination

Internal

Park Monitoring Reversion Timer

When the parkee is an internal party, then the call will be forwarded to the specified destination in the parker’s Park Monitoring Forward No Retrieve

Destination Internal parameter. If the Forward No

Retrieve Destination Internal is empty, the parkee will be redirected to the parker’s line.

This parameter determines the number of seconds that

Unified Communications Manager waits before prompting the user to retrieve a call that the user parked. This timer starts when the user presses the

Park softkey on the phone, and a reminder is issued when the timer expires.

Default: 60 seconds

If you configure a non-zero value, this value overrides the value of this parameter set in the Service

Parameters window. However, if you configure a value of 0 here, then the value in the Service

Parameters window will be used.

Park Monitoring Forward No Retrieve Internal Voice

Mail

This setting uses the settings in the Voice Mail Profile

Configuration window.

When this check box is checked, Unified

Communications Manager ignores the settings in the

Destination box and Calling Search Space.

Park Monitoring Forward No Retrieve External Voice

Mail

This setting uses the settings in the Voice Mail Profile

Configuration window.

When this check box is checked, Unified

Communications Manager ignores the settings in the

Destination box and Calling Search Space.

Park Monitoring Forward No Retrieve External CSS Choose the calling search space to apply to the directory number.

Park Monitoring Forward No Retrieve Internal CSS Choose the calling search space to apply to the directory number.

Log Missed Calls This field allows you to turn this feature on or off.

Enter ‘T’ to enable Unified Communications Manager to log missed calls in the call history for that directory number on the phone. Enter

‘F’ to disable this feature.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

175

Phones

Phone Line Field Descriptions for Line Additions Using BAT Spreadsheet

Field

Party Entrance Tone

URI on Directory Number

URI Route Partition on Directory Number

URI Is Primary on Directory Number

Enterprise Add to Local Route Partition

Description

Enter one of the following Party Entrance Tone options:

• Default—Use the value that you configured in the Party Entrance Tone service parameter.

Unified Communications Manager does not play the tone even if you choose On.

• Off—A tone does not play on the phone when a basic call changes to a multi-party call.

Enter a directory URI that you want to associate with the directory number for this phone. Follow the username@host format. Enter a username of up to 47 alphanumeric characters. For the host address, enter an IPv4 address or fully qualified domain name.

Note You can associate up to five directory URIs to a single directory number, but you must select one primary directory URI.

Enter the partition on which the directory URI belongs. If you do not want to restrict access to the directory URI, leave the field blank.

Enter a ‘t’ (True) to indicate that this directory URI is the primary directory URI for this extension.

Otherwise, enter an ‘f’ (False) to indicate that this is not the primary directory URI for this extension.

Note You can associate up to five directory URIs to a single directory number, but you must select one primary directory URI.

Enter a 't' to add this enterprise alternate number to a local route partition. Enter 'f' to leave the E.164

number off of local routing.

176

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Field

Enterprise Advertise via globally

Enterprise Is Urgent

Enterprise Number Mask

Enterprise Route Partition

+E.164 Add to Local Route Partition

+E.164 Advertise via globally

Phone Line Field Descriptions for Line Additions Using BAT Spreadsheet

Description

Enter a 't' to enable ILS to advertise this alternate number to rest of the ILS network. Enter an 'f' if you don't want ILS to advertise this number.

Enter a 't' to classify routing for this alternate number as urgent.

By default, if the dial plan contains overlapping route patterns Unified Communications Manager does not route the call until the interdigit timer expires (even if a possible route exists for the dialed digits). This setting guards against learned numbers that overlap with statically configured directory numbers and number patterns by allowing Unified Communications

Manager to choose the best match of all available routes for the dial string.

When you mark the number as urgent priority, Unified

Communications Manager routes the call as soon as it finds a match between the dialed digits and an available route, without waiting for the interdigit timer to expire (for example, the T302 Timer service parameter).

Enter the number mask to apply to the directory number. Unified Communications Manager applies the mask to create an enterprise alternate number that is an alias of this directory number.

Enter the local route partition to which you want to assign this enterprise alternate number.

Enter a 't' to add this E.164 alternate number to a local route partition. Enter 'f' to leave the E.164 number off of local routing.

Enter a 't' to enable ILS to advertise this alternate number to rest of the ILS network. Enter an 'f' if you don't want ILS to advertise this number.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

177

Phones

Phone Line Field Descriptions for Line Additions Using BAT Spreadsheet

Field

+E.164 Is Urgent

+E.164 Number Mask

+E.164 Route Partition

Description

Enter a 't' to classify routing for this alternate number as urgent.

Manager to choose the best match of all available routes for the dial string.

When you mark the number as urgent priority, Unified

Enter the number mask to apply to the directory number. Unified Communications Manager applies the mask to create an +E.164 alternate number that is an alias of this directory number.

Enter the local route partition to which you want to assign this +E.164 alternate number.

178

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Phone Resets and Restarts

This chapter provides information to 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. You can locate phones that you want to reset using either a query or a custom file.

•

•

Reset or Restart Phone Using Custom File, on page 180

•

Wipe or Lock Phones Using Query, on page 182

•

Wipe or Lock Phones Using Custom File, on page 183

Reset or Restart Phone Using Query

You can create a query to locate phones that you want to reset or restart.

Procedure

Step 1

Step 2

Choose Bulk Administration > Phones > Reset/Restart Phones > Query .

The Reset/Restart Phones Configuration window displays.

From the first Find Phones where drop-down list box, choose one of the following criteria:

• Device Name

• Description

• Directory Number

• Calling Search Space

• Device Pool

• Device Type

• Call Pickup Group

• LSC Status

• Authentication String

• Device Protocol

• Security Profile

• Common Device Configuration

From the second Find Phone where drop-down list box, choose one of the following criteria:

• begins with

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

179

Phones

Reset or Restart Phone Using Custom File

Step 3

Step 4

Step 5

Step 6

Step 7

Step 8

Step 9

Step 10

• contains

• is exactly

• ends with

• is empty

• is not empty

Specify the appropriate search text, if applicable.

Tip To find all phones that are registered in the database, click Find without entering any search text.

To further define your query, you can choose AND or OR to add multiple filters and repeat

Step 2, on page

179

and

Step 3, on page 180 .

Click Find .

A list of discovered templates displays by

• Device Name

• Description

• Device Pool

• Device Protocol

• Status

• IP Address

From the list of records, click the device name that matches your search criteria.

Click one of the following options:

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

• Restart—To reset phones without power-cycling

• Apply Config—To reset only the settings that have changed since the last reset

In the Job Information area, enter the Job description.

Choose an insert method. Do one of the following: a) Click Run Immediately to insert phone records immediately.

b) Click Run Later to insert phone records at a later time.

To create a job for inserting the phone records, click Submit .

To schedule this job, activate this job, or both, use the Job Configuration window.

Related Topics

, on page 629

Reset or Restart Phone Using Custom File

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

180

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Reset or Restart Phone Using Custom File

Before you begin

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

• Device names

• Description

• Directory numbers

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

Upload the file to the first node of Unified Communications Manager.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

Choose Bulk Administration > Phones > Reset/Restart Phones > Custom File .

The Reset/Restart Phones Custom Configuration window displays.

In the Update Phones where drop-down list box, choose the type of custom file that you have created from one of the following criteria:

• Device Name

• Directory Number

• Description

In the list of custom files, choose the filename of the custom file for this update and then click Find .

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

Click one of the following

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

• Restart—To reset phones without power-cycling

• Apply Config—To reset only the settings that have changed since the last reset

In the Job Information area, enter the Job description.

Choose an insert method. Do one of the following: a) Click Run Immediately to insert phone records immediately.

b) Click Run Later to insert phone records at a later time.

To create a job for inserting the phone records, click Submit .

To schedule and

/ or activate this job, use the Job Configuration window.

Related Topics

, on page 639

Phone Report Generation, on page 185

, on page 17

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

181

Phones

Wipe or Lock Phones Using Query

Wipe or Lock Phones Using Query

You can create a query to locate phones that you want to wipe and/or lock.

Step 1

Step 2

Caution The wipe operation cannot be undone. You should only perform this operation when you are sure you want to reset the phone to its factory settings.

Procedure

Step 3

Step 4

Step 5

Choose Bulk Administration > Phones > Wipe and Lock Phones > Query .

The Wipe and Lock Phones Configuration window displays.

From the first Find Phones where drop-down list box, choose one of the following criteria:

• Device Name

• Description

• Directory Number

• Calling Search Space

• Device Pool

• Device Type

• Call Pickup Group

• LSC Status

• Authentication String

• Device Protocol

• Security Profile

• Common Device Configuration

From the second Find Phone where drop-down list box, choose one of the following criteria:

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty

Specify the appropriate search text, if applicable.

Tip To find all phones that are registered in the database, click Find without entering any search text.

To further define your query, you can choose AND or OR to add multiple filters and repeat

Step 2

and

Step 3 .

Click Find .

A list of discovered templates displays by

• Device Name

• Description

• Device Pool

182

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Wipe or Lock Phones Using Custom File

Step 6

Step 7

Step 8

Step 9

Step 10

• Device Protocol

• Status

• IP Address

From the list of records, click the device name that matches your search criteria.

Click one of the following options:

• Lock—To lock the phones

• Wipe—To wipe the phones

• Wipe and Lock—To wipe and lock the phones

Note If a phone does not support the functionality you have chosen, the transaction will fail for that phone.

It will also fail if the functionality has already been requested for the phone.

In the Job Information area, enter the Job description.

Choose an insert method. Do one of the following: a) Click Run Immediately to wipe or lock phones immediately.

b) Click Run Later to wipe or lock phones at a later time.

To create a job for locking and/or wiping the phones, click Submit .

To schedule and

/ or activate this job, use the Job Configuration window.

Wipe or Lock Phones Using Custom File

You can create a custom file of phones that you want to wipe and/or lock using a text editor. You can use either device names or directory numbers in the custom file.

Before you begin

Caution The wipe operation cannot be undone. You should only perform this operation when you are sure you want to reset the phone to its factory settings.

Create a text file that lists one of these details for the phones that you want to wipe and/or lock:

• Device names

• Description

• Directory numbers

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

Upload the file to the first node of Unified Communications Manager.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

183

Phones

Wipe or Lock Phones Using Custom File

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

Choose Bulk Administration > Phones > Wipe and Lock Phones > Custom File .

The Wipe and Lock Phones Configuration window displays.

In the Update Phones where drop-down list box, choose the type of custom file that you have created from one of the following criteria:

• Device Name

• Directory Number

• Description

In the list of custom files, choose the filename of the custom file for this update and then click Find .

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

Click one of the following:

Note

• Lock—To lock the phones

• Wipe—To wipe the phones

• Wipe and Lock—To wipe and lock the phones

If a phone does not support the functionality you have chosen, the transaction will fail for that phone.

It will also fail if the functionality has already been requested for the phone.

In the Job Information area, enter the Job description.

Choose an insert method. Do one of the following: a) Click Run Immediately to wipe or lock phones immediately.

b) Click Run Later to wipe or lock phones at a later time.

To create a job for locking and/or wiping the phones, click Submit .

To schedule and

/ or activate this job, use the Job Configuration window.

184

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Phone Reports

This chapter provides information about CSV file format BAT reports that you can generate. You can customize

BAT reports for phones and user device profiles but reports for users, managers, assistants, and gateways have a fixed format and can not be customized.

•

•

Generate Phone Reports, on page 185

Phone Report Generation

Unified Communications Manager Bulk Administration (BAT) provides reports to help you manage records effectively. You can create and save reports that provide information about phones, users, user device profiles, managers and assistants, and gateway records. You can save these reports with a filename and store them in a folder on the first node server to review and print.

You can customize BAT reports for phones and for user device profiles to meet your particular needs by choosing items from a list of device fields and line fields. You can also choose how to arrange the fields in the report. The system generates the report in the CSV file format. Because reports for users, managers, assistants, and gateways have a fixed format, you cannot customize them.

Example

You need to have a list of all the directory numbers with their forwarding destinations by phone model. You can generate a Phone Report for the Cisco Unified IP Phone 7960 and choose these query details: Device

Name, Directory Number, Forward Busy Destination, Forward No Answer Destination, and Label. You can arrange the report fields, so the Label field follows the Directory Number field and precedes the two forward destination numbers.

Generate Phone Reports

You can generate reports for phones and other IP telephony devices.

Procedure

Step 1 Choose Bulk Administration > Phones > Generate Phone Reports .

The Report Phone Query window appears.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

185

Phones

Generate Phone Reports

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

Step 8

Step 9

Step 10

Step 11

Step 12

Step 13

In the first Find Phone where drop-down list box, choose the field to query such as Device Name or Directory

Number .

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

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

Specify the appropriate search text, if applicable, and click Find .

Tip To generate a report for all phones that are registered in the database, click Find without entering any search text.

To further define your query and to add multiple filters, check the Search Within Results check box, choose

AND or OR from the drop-down box, and repeat Steps

Step 2, on page 186

through

Step 5, on page 186

A list of discovered phones appears.

To choose details for your type of report, click Next .

The Generate Phone Report Configuration window appears and shows the Query that you chose.

Tip If you want to change the type of query, click Back .

In the Report File Name field, enter your name for this report (required).

In the Available Device Fields drop-down list box, choose a device item and click the arrow to move the item into the Selected Fields for this Report list.

You must specify at least one device field to generate a report. You can choose multiple fields to include in your report. For a list of device and live fields, see the

Phone and IP Telephony Device Reports, on page 187 .

Tip To rearrange the order of the items in the Selected Device Fields for this Report list, choose an item and click the Up arrow or Down arrow to move the item to another position in the list.

In the Available Line Fields drop-down list box, choose a line item and click the arrow to move the item into the Selected Fields for this Report list.

You must specify at least one line field to generate a report. You can choose multiple fields to include in your report.

Tip To rearrange the order of the items in the Selected Line Fields for this Report list, choose an item and click the Up arrow or Down arrow to move the item to another position in the list.

If you want to include IP phone services fields in your report, check the check boxes for Speed Dial Services and/or IP Phone Services .

In the Job Information area, enter the Job description.

Choose when to generate the report. Do one of the following: a) Click Run Immediately to generate the report immediately.

b) Click Run Later to generate the report at a later time.

To create a job for inserting the phone records, click Submit .

Use the Job Configuration window to schedule this job, activate this job, or both.

186

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Phone and IP Telephony Device Reports

What to do next

You can search and download the report file using the Upload

Download Files option in the Bulk

Administration menu.

Related Topics

, on page 639

Generate Phone Reports, on page 185 .

Phone and IP Telephony Device Reports

You can produce phone reports for all phones and IP telephony devices or limit the report to one of these options:

• Device Name—Specify a filter or use exact name.

• Description—Specify a filter or use exact description.

• Phone Load Name—Specify a filter or use exact name.

• Device Pool—Choose one from a list of device pools that are configured in the cluster.

• Calling Search Space—Choose one from a list of CSS that are configured in the cluster.

• Location—Choose one from a list of locations that are configured in the cluster.

• Directory Number—Specify a filter or use exact number.

After choosing the phone report type, you can choose the device and line details to include in the report.

You can choose from these Device fields:

• AAR Calling Search Space

• AAR Neighborhood

• Authentication String

• Built In Bridge

• Calling Search Space

• Calling Search Space Reroute

• Certificate Operation

• Certificate Status

• Common Profile

• Country

• Description

• Device Name

• Device Pool

• Device Profile

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

187

Phone and IP Telephony Device Reports

• Device Protocol

• Device_Default Profile

• Dial Rules

• Last Login user ID

• Load Information

• Location

• Login Duration

• Login Time

• MLPP Domain

• MLPP Indication

• Media Resource List

• Network Hold MOH Audio Source

• Network Location

• Packet Capture Duration

• Packet Capture Mode

• Phone Template

• Preemption

• Privacy

• Product

• Public Key

• Qsig

• SIP Profile

• Secure Shell Password

• Secure Shell User ID

• Security Profile

• Softkey Template

• Upgrade Finish Time

• User ID

• Geo Location

• Always Use Prime Line

• Always Use Prime Line for Voice Message

You can choose from these Line fields:

188

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Phone and IP Telephony Device Reports

• Alerting Name

• Auto Answer

• CSS_Device Failure

• CSS_MWI

• Call Forward Duration

• Calling Line Presentation Bit

• Calling Name Presentation Bit

• Calling Party Prefix Digits

• Connected Line Presentation Bit

• Connected Name Presentation Bit

• Device Failure DN

• Directory Number

• Forward All CSS

• Forward All Destination

• Forward Busy External CSS

• Forward Busy External Destination

• Forward Busy Internal CSS

• Forward Busy Internal Destination

• Forward No Answer External CSS

• Forward No Answer External Destination

• Forward No Answer Internal CSS

• Forward No Answer Internal Destination

• Forward No Answer Ring Duration

• Forward No Coverage External CSS

• Forward No Coverage External Destination

• Forward No Coverage Internal CSS

• Forward No Coverage Internal Destination

• Forward Unregistered External CSS

• Forward Unregistered External Destination

• Forward Unregistered Internal CSS

• Forward Unregistered Internal Destination

• Forward on CTI Failure CSS

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

189

Generate List of Phones Having Dummy MAC Addresses

• Forward on CTI Failure Destination

• Line AAR Neighborhood

• Line Alerting Name ASCII

• Line Description

• Line Network Hold MOH Audio Source

• MLPP No Answer Ring Duration (Seconds)

• Route Partition

• Secondary Call Forward All CSS

• Target CSS

• Target Destination

• User Hold MOH Audio Source

• Party Entrance Tone

• Log Missed Calls

• Park Monitor Forward No Retrieve External Destination

• Park Monitor Forward No Retrieve Internal Destination

• Park Monitor Forward No Retrieve Internal Voice Mail

• Park Monitor Forward No Retrieve External Voice Mail

• Park Monitor Forward No Retrieve External CSS

• Park Monitor Forward No Retrieve Internal CSS

• Park Monitor Reversion Timer

• URI Is Primary on Directory Number (1-5)

• URI Route Partition on Directory Number (1-5)

• URI on Directory Number (1--5)

Generate List of Phones Having Dummy MAC Addresses

You can generate a list of phones that use dummy MAC addresses.

Procedure

Step 1

Step 2

Step 3

Choose Bulk Administration > Phones > Generate Phone Reports .

The Report Phone Query window displays.

In the first Find Phone(s) where drop-down list box, choose Device Name .

In the second drop-down list box, choose begins with .

190

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Generate List of Phones Having Dummy MAC Addresses

Step 4

Step 5

Step 6

In the text field, enter BAT . All phones that are added with a dummy MAC address have device names that begin with BAT.

Click Find . The text Device Name begins with 'BAT' and displays in the query text box.

Click Next . The Generate Phone Report Configuration window displays.

What to do next

Complete the report generation procedure. Go to

Refer to

Report Log Files, on page 301 .

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

191

Generate List of Phones Having Dummy MAC Addresses

Phones

192

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Phone Migrations

Using Cisco Unified Communications Manager Bulk Administration (BAT), you can migrate a group of phones from Skinny Client Control Protocol (SCCP) to Session Initiation Protocol (SIP).

•

Migrate Phone From SCCP to SIP, on page 193

•

Migrate Phone From SCCP to SIP

You can migrate phones from SCCP to SIP. During the SCCP to SIP migration, only SIP specific default values in the phone report get migrated. Other values in the template are not migrated.

Note Migrating a phone that is running SCCP to SIP does not require a manual reset because the migration itself handles the reset of phones.

Procedure

Step 1

Step 2

Choose Bulk Administration > Phones > Migrate Phones > SCCP to SIP .

The Migrate Phones—SCCP to SIP window displays.

From the first Find Phone where drop-down list box, choose one of the following criteria:

• Device Name

• Description

• Directory Number

• Calling Search Space

• Device Pool

• Device Type

• Call Pickup Group

• LSC Status

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

193

Phones

Migrate Phone From SCCP to SIP

Step 3

Step 4

Step 5

Step 6

Step 7

Step 8

Step 9

• Authentication String

• Location

• Phone Load Name

• Security Profile

From the second Find Phone where drop-down list box, choose one of the following criteria:

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty

Specify the appropriate search text, if applicable, then click Find .

To further define your query, check the check box corresponding to Search Within Results Using drop-down list box. You can choose AND or OR to add multiple filters. Repeat

Step 2, on page 193

through

Step 4, on page 194 .

Tip To find all phones that are registered in the database, click Find without entering any search text.

A list of discovered phones displays by:

• Device Name

• Description

• Device Pool

• Device Protocol

• Status

• IP Address

Click Next .

From the drop-down list box, choose the phone template.

Note SCCP to SIP migration will pick up only SIP specific default values from this template during migration. It will not pick any other value from the template.

In the Job Information area, enter the Job description.

Choose a migration method. Do one of the following: a) Click Run Immediately to migrate phone records immediately.

b) Click Run Later to migrate phone records at a later time.

To create a job for migrating the phone records, click Submit .

194

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Topics Related to Phone Migration

To schedule and/or activate this job, use the Job Scheduler option in the Bulk Administration main menu.

What to do next

After submitting a job for migrating phones from SCCP to SIP, make sure that you reset these phones. Reset phones by using BulkAdministration > Phones > Reset/Restart Phones > Query .

Related Topics

Reset or Restart Phone Using Query , on page 179

, on page 639

Migrate Phone From SCCP to SIP, on page 193

Topics Related to Phone Migration

•

•

Reset or Restart Phone Using Query, on page 179

•

Update Intercom DNs, on page 197

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

195

Topics Related to Phone Migration

Phones

196

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Intercom Additions and Updates

The Intercom feature allows one user to call another user, and that call automatically gets answered with one-way media from caller to called party, regardless of whether the called party is busy or idle.

You can use the Add

Update Intercom utility to add or update intercoms in bulk to Cisco Unified

Communications Manager server.

•

•

Add Intercom DNs, on page 198

•

Intercom DN Update Field Descriptions, on page 199

Update Intercom DNs

You can update Intercom DNs for phones or devices.

Procedure

Step 1

Step 2

Step 3

Choose which intercom DN to update. Do one of the following: a) Choose Bulk Administration > Phones > Add/Update Intercom > Update Intercom Directory

Numbers to update Phone intercom directory numbers.

b) Choose Bulk Administration > User Device Profiles > Add/Update Intercom > Update Intercom

Directory Numbers to update User Device Profile intercom directory numbers.

From the first Find and List Intercom Directory Numbers To Update where drop-down list, choose one of the following criteria:

• Intercom Directory Number

• Route Partition

• Description

From the second Find and List Intercom Directory Numbers To Update where drop-down list, choose one of the following criteria:

• begins with

• contains

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

197

Phones

Add Intercom DNs

Step 4

Step 5

Step 6

Step 7

Step 8

• ends with

• is exactly

• is empty

• is not empty

Specify the appropriate search text in the text field, if applicable.

Tip To find all Intercom DNs that are registered in the database, click Find without entering any search text.

To further define your query, you can choose AND or OR to add multiple filters and repeat

Step 2, on page

197

and

Step 3, on page 197 .

Click Find .

A list of discovered Intercom DNs displays by:

• Intercom DN Pattern

• Route Partition

• Description

Click Next .

Specify the settings that you want to update for all the records that you have defined in your query.

You can choose multiple parameters to update.

Add Intercom DNs

You can add Intercom DNs to a Unified Communications Manager server.

Before you begin

• 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.

• Upload the data files by choosing the relevant target and function for the transaction.

Procedure

Step 1

Step 2

Step 3

Choose Bulk Administration > Phones > Add/Update Intercom > Add Intercom Directory Numbers .

In the File Name drop-down list box, choose the CSV data file that you created for this specific bulk transaction.

In the Phone Template Name drop-down list, choose the BAT Phone template that you created for this type of bulk transaction.

198

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Phones

Intercom DN Update Field Descriptions

Step 4

Step 5

Step 6

Step 7

Check the Override Configuration Settings check box to update the existing phone button template settings with the information that is contained in the file that you want to insert.

Consider overriding the configuration settings as optional.

In the Job Information area, enter the Job description.

The default job description for this transaction specifies Insert Intercom DNs.

Choose a method to add Intercom DNs. Do one of the following: a) Click Run Immediately to add Intercom DNs immediately.

b) Click Run Later to add Intercom DNs at a later time.

To create a job for adding Intercom DNs, click Submit .

To schedule and

/ or activate this job, use the Job Configuration window.

Related Topics

, on page 639

User Additions, on page 203

Intercom DN Update Field Descriptions

The following table provides the field descriptions for updating line details.

Table 10: Field Description for Updating Intercom DN Details

Field

Intercom Directory Number Information

Route Partition

Description

Choose a route partition to which the directory number belongs.

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

Description

Alerting Name

ASCII Alerting Name

Enter a description that makes the device easy to recognize. The description can include up to 50 characters in any language, but it cannot include double-quotes ("), percentage sign (

), ampersand

(&), or angle brackets (<>).

This field provides the same information as the

Alerting Name field, but you must limit input to

ASCII characters. Devices that do not support Unicode

(internationalized) characters display the content of the Alerting Name ASCII field.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

199

Intercom DN Update Field Descriptions

Field

Intercom Directory Number Settings

Calling Search Space

Presence Group

Phones

Description

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.

Used with the Presence feature, the phone that is running SIP or SCCP serves as a watcher because it requests status about the presence entity, for example, directory number, that is configured as a BLF speed dial button on the phone.

Presence Group Configuration window.

200

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

P A R T

Users

•

•

User Templates, on page 211

•

User Insertions, on page 219

•

User Updates, on page 221

•

User Deletions, on page 235

•

User Record Exports, on page 239

•

Password and PIN Resets, on page 243

•

User Report Generation, on page 247

•

Line Appearance, on page 249

•

End User CAPF Profiles, on page 253

C H A P T E R

User Additions

This chapter describes how to manage user records and work with user combinations, such as phones and users or CTI ports and user records in the Cisco Unified Communications Manager LDAP database.

•

New User Group Additions and User Associations, on page 203

•

Add Users, on page 203

•

Create User CSV Data File From BAT Spreadsheet, on page 204

•

BAT Spreadsheet User Data Field Descriptions, on page 205

•

New User Group Additions and User Associations

You can use Unified Communications Manager Bulk Administration (BAT) to add a group of new users and to associate users to phones and other IP Telephony devices in the Unified Communications Manager database.

Note If you use your corporate directory and have Lightweight Directory Access Protocol (LDAP) synchronization enabled (in Cisco Unified Communications Manager Administration, choose System > LDAP >

LDAP System ), then you cannot use BAT to reset passwords, and insert/update or delete users.

Related Topics

Add Users , on page 203

Export User Records , on page 239

Generate User Reports , on page 247

Add Users

You must create a CSV data file to add new users in bulk to the Unified Communications Manager database using the BAT spreadsheet. For users who have applications that require a CTI port, such as CiscoIPSoftPhone,

BAT can associate CTI ports to existing users.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

203

Users

Create User CSV Data File From BAT Spreadsheet

Procedure

Step 1

Step 2

Create a comma separated values (CSV) data file to define individual values for each user that you want to add.

Use BAT to insert the users in the Unified Communications Manager database.

Related Topics

Create Text-Based CSV User File

, on page 665

Create User CSV Data File From BAT Spreadsheet , on page 204

Insert Users in Unified Communications Manager Database

, on page 219

Create User CSV Data File From BAT Spreadsheet

You can provide details for adding new users to the Unified Communications Manager database in the BAT spreadsheet and then convert it in to a CSV data file.

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

After you have finished editing the fields to add users in the BAT spreadsheet, you can export the content to a CSV formatted data file. A default filename is assigned to the exported CSV formatted data file:

<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.

You can rename the CSV formatted data file after you save the exported file to your local workstation. 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.

Note You cannot upload a CSV filename that contains a comma (for example, abcd,e.txt) to the Unified

Communications Manager server.

Procedure

Step 1

Step 2

Step 3

Step 4

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

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

To add users, click the Users tab at the bottom of 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.

204

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Users

BAT Spreadsheet User Data Field Descriptions

Step 5

Step 6

In each row, provide the information as described in the online help files.

• If a user has multiple devices, the device name field should be repeated, once for each device.

• To enter additional device names that will be associated to a new user, enter a value in the Number of

Controlled Devices text box.

Note You can associate all devices, including CTI ports, ATA ports, and H.323 clients, with a user.

To enter additional device names that will be associated to a new user, enter a value in the Number of

Controlled Devices text box.

Click Export to BAT Format to transfer the data from the BAT Excel spreadsheet into a CSV formatted data file.

The system saves the file to C:\XLSDataFiles with the default file name <tabname>-<timestamp>.txt , or uses

Browse to save the file to another existing folder.

Tip For information on how to read the exported CSV data file, click the link to the Insert Users window in BAT.

View Sample File in

What to do next

You must upload the CSV data file to the first node of Unified Communications Manager database server so that BAT can access the data file.

, on page 8

Export User Records, on page 239

BAT Spreadsheet User Data Field Descriptions

The following table provides the field descriptions for adding users details.

Table 11: Field Description in BAT Spreadsheet for Adding Users

Field

First Name

Middle Name

Last Name

User ID

Description

Enter the first name, up to 64 characters, of the phone user.

Enter the middle name, up to 64 characters, of the phone user.

Enter the last name, from 1 to 64 characters, of the phone user.

Enter the last name, from 1 to 128 characters, of the phone user.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

205

BAT Spreadsheet User Data Field Descriptions

Field

Password

Manager User ID

Department

Default Profile

User Locale

Controlled Device 1

Users

Description

Enter the password, up to 128 characters, that the user needs to access the CiscoIPPhone Configuration window.

You must specify the Password either in the CSV data file or by using the BAT user interface during the user template addition. If you want to apply individual passwords for each user or groups of users, specify the password information in the CSV data file. If you want to use a default password for all users, provide the default password when you insert the users in

BAT.

Enter manager user ID, up to 128 characters, for the user of this phone.

Enter the department number, up to 64 characters, for the user of this phone.

Enter the personal identification number (PIN), up to

128 numerals, to be used for extension mobility.

You must enter a PIN either in the CSV data file or by using the BAT user interface during the user template addition. If you want to apply individual

PINs for each user or groups of users, specify the PIN in the CSV data file. To use a default PIN that all users can use, provide default PIN when you insert the users in BAT.

Enter the default profile for this user and device, up to 50 characters. You can choose the user device profile from the list of existing UDPs in Cisco Unified

Communications Manager Administration that appears in BAT.

Enter the language and country set, up to 50 characters, that you want to associate with this user.

Your choice determines which cultural-dependent attributes exist for this user and which language displays in the Unified Communications Manager user windows and phones.

Enter the name, up to 50 characters, for the phone or device that you want to associate with this user.

Note The Controlled Device field(s) displays when the Number of Controlled Devices field, at the extreme right in the spreadsheet, is set to greater than Zero.

206

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Users

Field

Telephone Number

Primary Extension

Associated PC

IPCC Extension

Mail ID

Controlled Device 2

Presence Group

SUBSCRIBE Calling Search Space

BAT Spreadsheet User Data Field Descriptions

Description

Enter the telephone number, up to 64 numerals for the primary extension (usually Line 1) for the phone.

This field displays after the user is added and represents the primary database number for the user.

You choose no primary line when you associate devices to the user. Users can have multiple lines on their phones.

This field, which is required for Cisco SoftPhone and

Cisco Unified Communications Manager Attendant

Console users, displays after the user is added.

From the drop-down list box, choose an IPCC extension for this user.

Enter the user e-mail address up to 255 characters.

Enter the name, up to 50 characters, for any additional phones that you want to associate with this user.

Note The Controlled Device field(s) displays when the Number of Controlled Devices field, at the extreme right in the spreadsheet, is set to greater than zero.

Enter the presence group that watches the status of the database number, the presence entity.

All calling search spaces that you configure in Cisco

Unified Communications Manager Administration display in the SUBSCRIBE Calling Search Space drop-down list box.

The SUBSCRIBE Calling Search Space determines how Cisco Unified Communications Manager routes the Presence subscription requests that come from the user. To configure a calling search space specifically for this purpose, you configure a calling search space as you do all calling search spaces ( Call Routing >

Class Control > Calling Search Space ).

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

207

BAT Spreadsheet User Data Field Descriptions

Field

Digest Credentials

User Group

Directory URI

Self-Service User ID

User Profile

Users

Description

When you configure digest authentication for phones that are running SIP, Cisco Unified Communications

Manager challenges the identity of the phone every time the phone sends a SIP request to Cisco Unified

Communications Manager. The digest credentials that you enter in this field get associated with the phone when you choose a digest user in the Phone

Configuration window.

Enter a string of up to 128 alphanumeric characters.

For more information on digest authentication, refer to the Cisco Unified Communications Manager

Security Guide Security Guide .

Enter the user group to which the user belongs.

Note The User Group field(s) displays when the Number of User Groups field, at the extreme right in the spreadsheet, is set to greater than zero.

Enter the primary directory URI that you want to associate to this user’s primary extension. Follow the username@host format. Enter a username of up to 47 alphanumeric characters. For the host address, enter an IPv4 address or fully qualified domain name.

Note Within Cisco Unified CM Administration, you can enter directory URIs with embedded double quotes or commas.

However, when you use Bulk

directory URI must be input as

"Jared,""Jerry"",[email protected]" in the csv file.

The Self-Service User ID is a DTMF digit string that is used to identify a user (usually same as the user directory number).

The User Profile is a profile that collects settings to share across a group of users. This profile is used when you create new devices.

208

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Users

Field

EM MAX LOGIN TIME

Topics Related to User Additions

•

Add Users, on page 203

•

•

Generate User Reports, on page 247

•

BAT Log Files, on page 639 .

Topics Related to User Additions

Description

Enter the maximum login time for Extension Mobility and Extension Mobility Cross Cluster users. Enter the value in minutes. The range of the value is from 0 to

10080 minutes (7 days).

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

209

Topics Related to User Additions

Users

210

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

User Templates

This chapter provides information about using Cisco Unified Communications Manager Bulk Administration

(BAT) user templates to define the common user attributes to add a group of new users.

•

Find BAT User Template, on page 211

•

Create New BAT User Template, on page 212

•

Modify BAT User Template, on page 212

•

Copy BAT User Template, on page 213

•

Delete BAT User Template, on page 213

•

BAT User Template Field Descriptions, on page 214

Find BAT User Template

Unified Communications Manager lets you locate specific user templates on the basis of specific criteria, which is useful when you have more than one user template.

Note During your work in a browser session, your find/list search preferences get stored in the cookies on the client machine. If you navigate to other menu items and return to this menu item, or if you close the browser and then reopen a new browser window, the system retains your Unified Communications Manager search preferences until you modify your search.

Procedure

Step 1

Step 2

Choose Bulk Administration > Users > User Template .

The Find and List User Templates window displays. Use the two drop-down list boxes to search for a template.

From the first Find User Template where drop-down list box, choose one of the following criteria:

• User Template Name

• Department

From the second Find User Template where drop-down list box, choose one of the following criteria:

• begins with

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

211

Users

Create New BAT User Template

Step 3

Step 4

• contains

• is exactly

• ends with

• is empty

• is not empty

Specify the appropriate search text, if applicable, and click Find .

Tip To find all User Templates that are registered in the database, click Find without entering any search text.

A list of discovered templates displays by

• User Template

• Department

From the list of records, click the user template that matches your search criteria.

The window displays the user template that you choose.

Create New BAT User Template

You can create new user templates.

Procedure

Step 1

Step 2

Step 3

Step 4

Choose Bulk Administration > Users > User Template .

The Find and List User Templates window displays.

Click Add New .

The User Template Configuration window displays.

Enter the user settings that this group of users have in common.

See

BAT User Template Field Descriptions, on page 214

for field descriptions.

Click Save .

When the user template is added to the database, the status indicates that the transaction has completed.

Modify BAT User Template

You can view or modify an existing user template.

Procedure

Step 1

Step 2

Find the user template that you want to modify.

In the User Template Configuration window, add, change, or remove settings in the template.

212

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Users

Copy BAT User Template

Step 3

See

Table 12: Field Descriptions for a User Template in BAT, on page 214

for field descriptions.

After you have modified the settings to update the template, click Save .

Related Topics

Find BAT User Template , on page 211

Copy BAT User Template

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

Procedure

Step 1

Step 2

Step 3

Step 4

Find the user template that you want to copy.

In the User Template Configuration window, 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.

Update the fields as needed for the new template.

See

Table 12: Field Descriptions for a User Template in BAT, on page 214

for field descriptions.

Click Save .

Related Topics

Find BAT User Template , on page 211

Delete BAT User Template

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

Caution The delete action is final. You cannot retrieve deleted templates.

Procedure

Step 1

Step 2

Find the user template that you want to delete.

In the User Template Configuration window, verify that this is the template that you want to delete and click Delete .

Note You can also delete the user template from the Find and List User Templates window. Check the check box next to the template that you want to delete and click Delete Selected .

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

213

Users

BAT User Template Field Descriptions

Step 3

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

To delete the template, click OK . The template name disappears from the list of user templates list on the

Find and List User Templates window.

Caution If you submit a job with a particular user template, and if you delete that user template before the execution of the job, the job also gets deleted. You have to resubmit the job by creating another user template.

Related Topics

Find BAT User Template

, on page 211

BAT User Template Field Descriptions

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

The following table provides descriptions of all possible fields that appear after you add a BAT user template.

Table 12: Field Descriptions for a User Template in BAT

Field

User Template Name

Default Password to User ID

Default PIN to Telephone Number

Default Telephone Number to Primary Extension

Default Mail ID to User ID

Manager User ID

Department

User Locale

Description

Enter a unique name, up to 30 alphanumeric characters, for the user template.

Check this check box if you want to make the user ID the default password for all users.

Check this check box to make the telephone number the default PIN.

Check this check box to make the telephone number the primary extension.

Check this check box to make the mail ID to default for the user ID.

Enter manager user ID, up to 128 characters, for the user of this phone.

Enter the department number, up to 64 characters, for the user of this phone.

Choose the language and country set that you want to associate with this user from the drop-down list.

Your choice determines which cultural-dependent attributes exist for this user and which language displays in the Unified CM user windows and phones.

214

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Users

Field

Associated PC

Default Profile

BLF Presence Group

SUBSCRIBE Calling Search Space

Allow Control of Device from CTI

EMCC Enabled

User Rank

Access Control Group

BAT User Template Field Descriptions

Description

This field, which is required for Cisco SoftPhone and

Cisco Unified Communications Manager Attendant

Console users, displays after the user is added.

Choose the default profile for this user from the default Profile drop-down list.

From the drop-down list, choose the BLF presence group that watches the status of the directory number, the presence entity.

All calling search spaces that you configure in Unified

CM Administration appear in the SUBSCRIBE

Calling Search Space drop-down list.

Class Control > Calling Search Space ).

Check this check box to allow CTI to control and monitor this device.

If the associated directory number specifies a shared line, enable this check box as long as at least one associated device specifies a combination of device type and protocol that CTI supports.

Note Cisco dual-mode devices (Jabber) such as

Android, iPhone, and iPad operating in

WiFi mode are monitored through CTI and not controlled. However, devices operating in GSM mode cannot be monitored or controlled.

Check this check box to enable the EMCC service.

From the drop-down list box, select the rank that you want to assign to this user. The highest rank is 1, the lowest is 10.

From the drop-down list, choose the access control group to which the user belongs. Only those access control groups that are either the same or lower than the user's rank are available to select from.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

215

Users

BAT User Template Field Descriptions

Field

Digest Credentials

Confirm Digest Credentials

Home Cluster

Enable User for Unified CM IM and Presence

Include meeting information in Presence

Description

When you configure digest authentication for phones that are running SIP, Cisco Unified Communications

Manager challenges the identity of the phone every time that the phone sends a SIP request to Cisco

Unified Communications Manager. The digest credentials that you enter in this field get associated with the phone when you choose a digest user in the

Phone Configuration window.

Enter a string of up to 128 alphanumeric characters.

For information about digest authentication, see the

Cisco Unified Communications Manager Security

Guide .

To confirm that you entered the digest credentials correctly, reenter the credentials in this field.

Check this check box to home users in this user template to this cluster. The user must only be homed to one cluster within the enterprise.

Note IM and Presence does not function properly if a user is assigned to more than one home cluster.

Check this check box to enable users in this user template for IM and Presence. Configure IM and

Presence in the associated service profile.

Note You must install a Cisco Unified

Communications Manager IM and

Presence node along with this Cisco

Unified Communications Manager cluster.

Use the User Management > User

Settings > UC Services menu to configure the IM and Presence service.

Check this check box to enable the user to include meeting and calendar information in IM and Presence

Service.

The user must be on the home cluster and have IM and Presence enabled. Also ensure that an Exchange

Presence Gateway is configured on the Cisco Unified

Communications Manager IM and Presence Service server.

216

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Users

Field

Assigned Presence Server

UC Service Profile

Enable Mobility

Enable Mobile Voice Access

Maximum Wait Time for Desk Pickup

Maximum Login Time (HHH:MM)

Remote Destination Limit

BAT User Template Field Descriptions

Description

Assign a user to an IM and Presence Service server that is installed in the cluster if the system is nonbalanced. The server you specify using the Bulk

Administration Tool must be part of a Presence

Redundancy Group.

For clusters that have the user assignment mode for the IM and Presence server set to balanced or active-standby, user assignments that are made using the Bulk Administration Tool override the automatic user assignments.

Choose a UC service profile from the drop-down list.

Note Use the User Management > User

Settings > Service Profile menu to set up service profiles for the users.

Check this check box to activate Cisco Unified

Mobility, which allows a user to manage calls by using a single phone number and to pick up calls on the desk phone and mobile phone.

Check this check box to allow the user to access the

Mobile Voice Access integrated voice response (IVR) system to initiate Cisco Unified Mobility calls and activate or deactivate Cisco Unified Mobility capabilities.

Enter the maximum wait time, up to five numerals, for this user.

This value indicates the maximum time that is permitted to pass before the user pickup a call that is transferred from the mobile phone to the desk phone.

Enter the maximum login time in the HHH:MM format to configure maximum login time for the

Extension Mobility and Extension Mobility Cross

Cluster users.

The value ranges from 00:01 to 168:00 hours.

For example: 168:00, 25:16, 025:16, :30 or 00:30.

Enter the maximum number of phones, up to two numerals, to which the user is permitted to transfer calls from the desk phone.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

217

BAT User Template Field Descriptions

Users

218

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

User Insertions

This chapter provides information to use Cisco Unified Communications Manager Bulk Administration (BAT) to add a group of users to the Cisco Unified Communications Manager database.

Note This feature supports only custom files that are saved with the UTF-8 encoding format.

•

Insert Users in Unified Communications Manager Database, on page 219

•

Insert Users in Unified Communications Manager Database

You can add a group of users to the Unified Communications Manager database using a CSV data file. The field values that you enter in the CSV file for inserting users override the values provided in the user template.

Attention If the credential policy has “check for trivial password” enabled, and the password in the user template is the user ID, inserting users through BAT may fail if the user ID does not satisfy the necessary criteria for the trivial password.

Users can be inserted using BAT with primary extension configured without any devices selected for controlled devices. To do so, you must pre-populate the DN in Unified Communications Manager before inserting the users using BAT. The following steps outline the process of pre-populating the DN:

Create range of DNs to be associated for primary extension for users in the DN page.

Create a BAT template with primary extension configured (which should be the same DN's pre-populated).

Insert the users using BAT (as shown in the following procedure)

Before you begin

You must have a CSV data file that is saved in the UTF-8 encoding format and that contains the usernames, controlled device names, and directory numbers. You can create the CSV data file by using one of these methods:

• BAT spreadsheet that is converted to CSV format

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

219

Users

Topics Related to User Insertions

• Export utility that produces an export file of user data

Note When you are inserting users by using an exported BAT file, you might get errors stating “User ID already exists” for some users that were exported in more than one file. For example, a list of first line managers and a list of users might both include the same manager user ID.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

Choose Bulk Administration > Users > Insert Users .

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

If the CSV data file was created by using the export utility, check the File created with Export Users check box.

From the User Template Name drop-down list, choose the user template you want to use for this insert.

Note The User Profile, Controlled Device Name, and Directory Number should exist in the Unified

Communications Manager database. The controlled device name should be entered in full. If it contains only MAC Address, then BAT displays a non-existing device error.

In the Job Information area, enter the Job description.

Choose an insert method. Do one of the following: a) Click Run Immediately to insert the user records immediately.

b) Click Run Later to insert the user records at a later time.

To create a job for inserting the user records, click Submit .

To schedule and

/ or activate this job, use the Job Scheduler option in the Bulk Administration main menu.

Related Topics

Create New BAT User Template, on page 212

, on page 629

Topics Related to User Insertions

•

•

BAT User Template Field Descriptions, on page 214

•

Insert Users in Unified Communications Manager Database, on page 219

220

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

User Updates

This chapter provides information about updating existing user records in the Cisco Unified Communications

Manager database.

•

Update User Information Using CSV Data File, on page 221

•

Update User Information in Cisco Unified Communications Manager Directory, on page 227

•

User Update Settings, on page 228

•

Update User Information Using CSV Data File

You can update existing user information that is in the database using a comma-separated value (CSV) data file you create using the Bulk Administration (BAT) spreadsheet, or you can update a user file format using a custom text-based CSV file.

You can retain existing user information and settings that were previously stored in the Unified CM directory.

Note You do not require a user template for the update users transaction using a custom text-based CSV file. If you choose a user template, the system takes the fields that are not provided in the CSV from the template for the update or else these fields are ignored. Also, if you specify another value for fields to be ignored (for example,

#), then the fields with the value # are ignored, because blank is not a value to be ignored for such fields.

The Bulk Administration Tool (BAT) cannot be used to disassociate devices that are already associated to an end user. If you manually delete a controlled device from an exported end user record and then insert the modified user record back in to the Cisco Unified Communications Manager database as a custom CSV data file, the insertion appears as successful when you check the job results using Bulk Administration > Job

Scheduler . However, the controlled device is still listed on the end-user page.

Procedure

Step 1

Step 2

Create a CSV data file to define individual values for each user that you want to update.

Use BAT to insert the updated user records that are in the database.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

221

Users

Retain Existing User Information During Update

, on page 222

Retain Existing User Information During Update , on page 222

Update Users File Format , on page 667

Update User Information in Cisco Unified Communications Manager Directory

, on page 227

Retain Existing User Information During Update

When you update user records, you can keep values or settings for a user that were previously stored in the

Unified CM directory. You can use a symbol such as“#” for fields where the value must be retained. In the following example CSV data file, the # tells BAT to keep the Manager field the same as the one that was previously entered in the DC directory.

userid,#,department,,,123456789012,

To identify the value to use to retain a stored value, use the following procedure.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Choose Bulk Administration > Users > Update Users .

The User Update Configuration window appears.

Notice the Value for fields to be ignored field . When you insert the CSV data file with the updated user values, you must enter the symbol that you used to retain values in this box.

Decide the symbol that you want to use for retaining values.

Enter this value that is in the Value for fields to be ignored field into the BAT spreadsheet box.

Use this symbol in BAT spreadsheet fields for any values that you want to retain.

Create User Update CSV Data File Using BAT Spreadsheet

You can create a CSV data file using the BAT spreadsheet to update a group of existing users.

After you add lines in the BAT spreadsheet, you can export the content to a CSV formatted data file. A default filename is assigned to the exported CSV formatted update users data file:

Update_Users-timestamp.txt

where

<timestamp> represents the precise date and time that the file was created.

The system saves the file with a default filename to C:\XlsDataFiles\ , or you can save the file to another existing folder on your local workstation. You can rename the CSV formatted data file after you save the exported file to your local workstation. 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.

222

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Users

Create User Update CSV Data File Using BAT Spreadsheet

Note You cannot upload a CSV filename that contains a comma (for example, abcd,e.txt) to the server.

If you enter a blank row in the spreadsheet, the system treats the empty row as the end of the file. Data that you enter after a blank line is not converted to the BAT format.

The Bulk Administration Tool (BAT) cannot be used to disassociate devices that are already associated to an end user. If you manually delete a controlled device from an exported end-user record and then insert the modified user record back in to the Unified Communications Manager database as a custom CSV data file, the insertion appears successful when you check the job results using Bulk Administration > Job Scheduler .

However, the controlled device is still listed on the End User Configuration window in Cisco Unified

Communications Manager Administration.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Download and open the BAT.xlt file.

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

To add user information, click the Update Users tab at the bottom of 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. For field descriptions, see

Table 13: Field Description in BAT Spreadsheet for Updating Users, on page 224

In the Value for fields to be ignored field, enter the symbol that you will use to tell BAT that you want to keep the value that was previously stored in the DC directory. Enter the same value in the value of the field you want to retain.

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

The system saves the file to C:\XlsDataFiles\ with the default filename

Update_Users-timestamp.txt

or you can use Browse to save the file to another existing folder on your local workstation.

For information about how to read the CSV data file, click the View Sample File link in the Update Users window in BAT.

What to do next

You must upload the CSV data file to the first node of the Unified CM server, so BAT can access the CSV data file.

, on page 17

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

223

Users

BAT Spreadsheet Update User Data Field Descriptions

The following table provides the field descriptions for updating user details in the BAT spreadsheet.

Table 13: Field Description in BAT Spreadsheet for Updating Users

Field

User ID

Manager User ID

Password

Department

Default Profile

User Locale

Password

Description

Enter the last name, from 1 to 128 characters, of the phone user.

Enter manager user ID, up to 128 characters, for the user of this phone.

Enter the password, up to 128 characters, that the user needs to access the Cisco IP Phone Configuration window.

You must specify the Password either in the CSV data file or by using the BAT user interface when you add the user template. If you want to apply individual passwords for each user or groups of users, specify the password information in the CSV data file. If you want to use a default password for all users, provide the default password when you insert the users in

BAT.

Enter the department number, up to 64 characters, for the user of this phone.

Enter the default profile for this user and device, up to 50 characters. You can choose the user device profile from the list of existing UDPs in Unified CM

Administration that appears in BAT.

Enter the language and country set, up to 50 characters, that you want to associate with this user.

Your choice determines which cultural-dependent attributes exist for this user and which language displays in the Unified CM user windows and phones.

Enter the password, up to 128 characters, that the user needs to access the Cisco IP Phone Configuration window.

You must specify the password either in the CSV data file or by using the BAT user interface during user template addition. If you want to apply individual passwords for each user or groups of users, specify the password information in the CSV data file. If you want to use a default password for all users, provide the default password when you insert the users in

BAT.

224

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Users

Field

Telephone Number

Primary Extension

Associated PC

IPCC Extension

Mail ID

BLF Presence Group

SUBSCRIBE Calling Search Space

BAT Spreadsheet Update User Data Field Descriptions

Description

Enter the personal identification number (PIN), up to

128 numerals, to be used for extension mobility.

You must enter a PIN either in the CSV data file or by using the BAT user interface during user template addition. If you want to apply individual PINs for each user or groups of users, specify the PIN in the

CSV data file. To use a default PIN that all users can use, provide a default PIN when you insert the users in BAT.

Enter the telephone number, up to 64 numerals, for the primary extension (usually Line 1) for the phone.

This field appears after you add the user and represents the primary directory number for the user.

You choose no primary line when you associate devices to the user. Users can have multiple lines on their phones.

If you configure the system for Unity Integration, the

Create Voice Mailbox link appears.

This field, which is required for Cisco SoftPhone and

Unified CM Attendant Console users, displays after the user is added.

Enter an IPCC extension, up to 50 characters, for this user.

Enter the user e-mail address up to 255 characters.

Enter the BLF presence group that watches the status of the database number, the presence entity.

For information about the BLF Presence feature, see the Feature Configuration Guide for Cisco Unified

Communications Manager .

All calling search spaces that you configure in Unified

CM Administration appear in the SUBSCRIBE

Calling Search Space drop-down list box.

The SUBSCRIBE Calling Search Space determines how Unified CM routes the Presence subscription requests that come from the user. To configure a calling search space specifically for this purpose, you configure a calling search space as you do all calling search spaces ( Call Routing > Class Control >

Calling Search Space ).

To set up a calling search space, see the Cisco Unified

Communications Manager Online Help .

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

225

BAT Spreadsheet Update User Data Field Descriptions

Field

Digest Credentials

User Group

Directory URI

Self-Service User ID

User Profile

Users

Description

When you configure digest authentication for phones that are running SIP, Unified CM challenges the identity of the phone every time the phone sends a

SIP request to Unified Communications Manager.

The digest credentials that you enter in this field is associated with the phone when you choose a digest user in the Phone Configuration window.

Enter a string of up to 128 alphanumeric characters.

For more information about digest authentication, see the Cisco Unified Communications Manager Security

Guide .

Enter the user group to which the user belongs.

Note The User Group set the Number of User Groups field to greater than zero.

fields appear when you

Enter the primary directory URI that you want to associate to this user's primary extension. Follow the username@host format. Enter a username of up to 47 alphanumeric characters. For the host address, enter an IPv4 address or fully qualified domain name.

Note Within Unified CM Administration, you can enter directory URIs with embedded double quotes or commas. However, when you use Bulk Administration to import a

CSV file that contains directory URIs with embedded double quotes and commas, you must use enclose the entire directory URI in double quotes and escape the embedded double quotes with a double quote. For example, the Jared,

"Jerry",[email protected] directory URI must be input as

"Jared,""Jerry"",[email protected]" in the

CSV file.

The Self-Service User ID is a DTMF digit string that is used to identify a user (usually same as the user directory number).

The User Profile is a profile that collects settings to share across a group of users. This profile is used when you create new devices.

226

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Users

Update User Information in Cisco Unified Communications Manager Directory

Field

EM MAX LOGIN TIME

Description

Enter the maximum login time for Extension Mobility and Extension Mobility Cross Cluster users. Enter the value in minutes.The range of the value is from 0 to

10080 minutes (7 days).

Update User Information in Cisco Unified Communications

Manager Directory

You can update a group of user records in the Cisco Unified Communications Manager directory.

Before you begin

You must have a .csv data file with updated user information.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

Choose Bulk Administration > Users > Update Users > Custom File .

The User Update Configuration window appears.

From the File Name drop-down list box, choose the .csv data file that you created for this bulk transaction.

Note Click View File to view the uploaded .csv data file.

Click View Sample File to view a sample .csv data file.

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

In the Value for fields to be ignored field, enter the symbol that you want to tell Unified CM Bulk

Administration Tool to retain the value that was previously stored in the DC directory.

Note The value that you enter in the .csv file for updating users overrides the values that are provided in the user template.

In the Job Information area, enter the Job description.

Choose a method to update user records. Do one of the following:

• Select Run Immediately to update user records immediately.

• Select Run Later to insert the user records at a later time.

To create a job for updating the user records, click Submit .

To schedule or activate this job, use the Job Scheduler option in the Bulk Administration main menu.

Related Topics

Create User Update CSV Data File Using BAT Spreadsheet , on page 222

, on page 639

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

227

Users

User Update Settings

Retain Existing User Information During Update , on page 222

Update Users Using Query , on page 231

, on page 629

User Update Settings

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

Tip Check the first check box if you need to update the field and the second check box to apply a checked value to the users you select. For example, if you check the first box for Home Cluster and leave the second one unchecked, you update users with an unchecked value for Home Cluster.

The following table provides descriptions for all possible fields when you update users with the Query option.

Table 14: Field Descriptions for Update Users

Description Field

User Information

Manager User ID

Department

Associated PC

User Locale

Enter manager user ID, up to 128 characters, for the user of this phone.

Enter the department number, up to 64 characters, for the user of this phone.

This field, which is required for Cisco SoftPhone and Cisco Unified

Communications Manager Attendant Console users, displays after you add the user.

Choose the language and country set that you want to associate with this user from the drop-down list. Your choice determines which cultural-dependent attributes exist for this user and which language displays in the Cisco Unified Communications Manager user windows and phones.

228

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Users

User Update Settings

Field

Digest Credentials

Confirm Digest Credentials

Description

When you configure digest authentication for phones that are running,

Cisco Unified Communications Manager challenges the identity of the phone every time the phone sends a SIP request to Cisco Unified

Communications Manager. The digest credentials that you enter in this field get associated with the phone when you choose a digest user in the Phone Configuration window.

Enter a string of up to 128 alphanumeric characters.

For more information on digest authentication, see the Cisco Unified

Communications Manager Security Guide .

To confirm that you entered the digest credentials correctly, reenter the credentials in this field.

Service Setting

Home Cluster Check the check box if the end user is associated with this cluster.

The end user must be associated with one cluster within the enterprise.

Note IM and Presence feature does not function properly if an end user is associated with more than one home cluster.

Enable User for Unified CM IM and

Presence

Check the check box to enable the end user (on the home cluster) for

IM and Presence feature. Configure IM and Presence feature in the associated service profile.

Note You can only enable IM and Presence feature for users that have this Unified CM cluster marked as their home cluster.

Tip Use the User Management > User Settings > UC Service menu to configure the IM and Presence feature.

Assigned Presence Server

UC Service Profile

Assign the end user to an server that is installed in the cluster if the system is nonbalanced. The server you specify using the Bulk

Administration Tool must be part of a Presence Redundancy Group.

For clusters that have the user assignment mode for the IM and

Presence server set to balanced or active-standby, user assignments that are made using the Bulk Administration Tool override the automatic user assignments.

Select a UC service profile from the drop-down list box to associate with end users.

Note Use the User Management > User Settings > Service

Profile menu to set up service profiles for end users.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

229

Users

User Update Settings

Field Description

Include Meeting Information in

Presence (Requires Exchange Presence

Gateway to be configured on CUCM

IM and Presence server.)

Check this check box to create a sync between CUCM IM and

Presence server so that it can include the meeting information under the Presence feature.

Note You can only access this field if Home Cluster and Enable

User for Unified CM IM and Presence is enabled.

Extension Mobility

BLF Presence Group

SUBSCRIBE Calling Search Space

Maximum Login Time (HHH:MM)

Allow Control of Device from CTI

Enable Extension Mobility Cross

Cluster

From the drop-down list, choose the BLF presence group that watches the status of the directory number, the presence entity.

All calling search spaces that you configure in Cisco Unified

Communications Manager Administration display in the SUBSCRIBE

Calling Search Space drop-down list.

The SUBSCRIBE Calling Search Space determines how Cisco

Unified Communications Manager routes the Presence subscription requests that come from the end user. Use the Call Routing > Class

Control > Calling Search Space menu to configure a calling search space specifically for this purpose.

Enter the maximum login time in the HHH:MM format to configure maximum login time for Extension Mobility and Extension Mobility

Cross Cluster users.

The value ranges from 00:01 to 168:00 hours.

For example: 168:00, 25:16, 025:16, :30 or 00:30.

Check this check box to allow CTI to control and monitor this device.

If the associated directory number specifies a shared line, the check box should be checked as long as at least one associated device specifies a combination of device type and protocol that CTI supports.

Check this check box to enable the Extension Mobility Cross Cluster

CSS setting that gets used as the device CSS of the remote phone when the user selects this device profile during the EMCC login.

Mobility Information

Enable Mobility

Enable Mobile Voice Access

Check this check box to activate Mobile Connect, which allows the user to manage calls by using a single phone number and to pick up and manage calls on the desk phone and mobile phone.

Check this check box to allow the user to access the Mobile Voice

Access integrated voice response (IVR) system to initiate Mobile

Connect calls and activate or deactivate Mobile Connect capabilities.

230

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Users

Update Users Using Query

Field Description

Maximum Wait Time for Desk Pickup Enter the maximum wait time, up to 5 numerals, for this user.

This indicates the maximum time that is permitted to pass before the user pickup a call that is transferred from the mobile phone to the desktop phone.

Remote Destination Limit Enter the maximum number of phones, up to 2 numerals, to which the user is permitted to transfer calls from the desk phone.

Job Information

Job Description Enter the job description.

Run Immediately Click this radio button to schedule and immediately activate the update users job.

Run Later (To schedule and activate this job, use Job Scheduler page.)

Click this radio button to schedule and activate the update users job later.

Related Topics

Select Update Parameters for User Query

, on page 232

Update Users Using Query

Use this procedure to create a query to locate users to update. After locating users, you must select the update parameters.

Before you begin

To update all users, select Find and do not specify a query.

Procedure

Step 1

Step 2

Select Bulk Administration > Users > Update Users > Query

The Update Users Query window appears.

From the first Find Phone where drop-down list, select one of the following criteria:

• Last Name

• First Name

• User ID

• Manager

• Department

• Has Home Cluster Enabled

• Does not have Home Cluster Enabled

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

231

Users

Select Update Parameters for User Query

Step 3

Step 4

Step 5

• Has IM and Presence Enabled

• Does not have IM and Presence Enabled

From the second Find Users where drop-down list, select one of the following criteria:

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty

Specify the appropriate search text, if applicable.

Tip To find all users that are registered in the database, select Find without entering any search text.

Tip To further define your query and to add multiple filters, click the plus (+) button and repeat step 2 and step 3.

Select Find .

A list of discovered users appears. The Update Users window displays the details of the users that you select.

What to do next

Select update parameters for the user.

User Update Settings , on page 228

Select Update Parameters for User Query

After you locate the users to update, use this procedure to select the parameters and define values for updating those users.

Procedure

Step 1

Step 2

In the Update Users Query window, select Next .

If you want to change the type of query, select Back .

The Update Users shows the type of query that you select.

Check the check box to the left of the field that you want to update.

This selection tells BAT to overwrite the existing value for the field.

232

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Users

Topics Related to User Updates

Step 3

Step 4

Step 5

Step 6

Note BAT updates only those fields for which you check the update check box.

Update the required user parameters. See the “User update settings” topic.

In the Job Information area , enter the job description.

Select one of the following methods to update user records: a) Select Run Immediately to update users immediately.

b) Select Run Later to update users at a later time.

Select Submit .

This action creates a job for updating the records.

Note Use the Job Scheduler option in the Bulk Administration main menu to schedule and activate this job.

Related Topics

Update Users Using Query , on page 231

User Update Settings

, on page 228

Topics Related to User Updates

•

Update User Information Using CSV Data File, on page 221

•

Retain Existing User Information During Update, on page 222

•

Create User Update CSV Data File Using BAT Spreadsheet, on page 222

•

Update User Information in Cisco Unified Communications Manager Directory, on page 227

•

Delete Users Using Query, on page 235

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

233

Topics Related to User Updates

Users

234

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

User Deletions

This chapter provides information to delete a group of users from the Unified Communications Manager directory. You can locate existing user records to delete using either a query search or a custom file.

•

•

Delete Users Using Custom File, on page 236

Delete Users Using Query

You can create a query filter to locate the user records for the users that you want to delete.

Caution The delete action is final. You cannot retrieve deleted records.

Procedure

Step 1

Step 2

Choose Bulk Administration > Users > Delete Users > Query .

The Delete Users Configuration window displays.

From the first Find User where drop-down list box, choose one of the following criteria:

• User ID

• First Name

• Middle Name

• Last Name

• Manager

• Department Name

From the second Find User where drop-down list box, choose one of the following criteria:

• begins with

• contains

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

235

Users

Delete Users Using Custom File

Step 3

Step 4

Step 5

Step 6

Step 7

Step 8

• is exactly

• ends with

• is empty

• is not empty

Specify the appropriate search text, if applicable.

Tip To find all users that are registered in the database, click Find without entering any search text.

To further define your query and to add multiple filters, check the Search Within Results check box, choose

AND or OR from the drop-down box, and repeat

Step 2, on page 235

and

Step 3, on page 236

Click Find .

A list of discovered templates displays by:

• User ID

• First Name

• Middle Name

• Last Name

• Manager

• Department Name

• LDAP Sync Status

In the Job Information area, enter the Job description.

Choose a method to delete user records. Do one of the following: a) Click Run Immediately to delete user records immediately.

b) Click Run Later to delete the user records at a later time.

Caution The delete action is final. You cannot retrieve deleted records.

To create a job for deleting the user records, click Submit .

To schedule and

/ or activate this job, use the Job Scheduler option in the Bulk Administration main menu.

Related Topics

, on page 629

Delete Users Using Custom File

Create a text file that lists each user ID that you want to delete on a separate line.

Upload the custom file with the first node of the Unified Communications Manager server.

236

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Users

Delete Users Using Custom File

To locate and delete users, you can create a custom file of user IDs by using a text editor.

Note Do not use the insert or export transaction files that are created with bat.xlt for the delete transaction. Instead, you must create a custom file with details of the user records that need to be deleted. Use only this file for the delete transaction. In this custom delete file, you do not need a header, and you can enter values for user ID.

Caution The delete action is final. You cannot retrieve deleted records.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

Choose Bulk Administration > Users > Delete Users > Custom File .

The Find and List Users - Delete Users Based on Custom File window displays.

In Delete Users where drop-down list box, choose one of the following criteria:

• User ID

• First Name

• Middle Name

• Last Name

• Department

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

To check that the query includes the information that you need, click Find .

In the Job Information area, enter the Job description.

Choose a method to delete user records. Do one of the following: a) Click Run Immediately to delete user records immediately.

b) Click Run Later to delete the user records at a later time.

Caution The delete action is final. You cannot retrieve deleted records.

To create a job for deleting the user records, click Submit .

To schedule and

/ or activate this job, use the Job Scheduler option in the Bulk Administration main menu.

Related Topics

, on page 639

Export User Records, on page 239

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

237

Delete Users Using Custom File

Users

238

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

User Record Exports

When you use Unified Communications Manager Bulk Administration (BAT) to export user records, the export utility sorts users according to the organizational hierarchy in the database.

From the Exports Users Configuration window, if Default User Format is selected from the File Format drop-down list box. the export utility only exports the default user device profile that is associated with a user.

You must insert the other user device profiles for that user separately by using Cisco Unified Communications

Manager Administrator.

•

•

Export User Records

When you export user records using BAT, some users might have a blank PIN because these user records were created prior to Unified Communications Manager 3.1. If this is the case, you must specify a default

PIN before reinserting the user records in the BAT user interface.

Caution The user ID, PKID, password, pin, and digest credentials columns in the exported file should not be modified under any circumstances.

Procedure

Step 1

Step 2

Choose Bulk Administration > Users > Export Users .

The Find and List Users to Export window displays.

In the first Find User where drop-down list, choose a field to query from the following options:

• User ID

• First Name

• Middle Name

• Last Name

• Manager

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

239

Users

Export User Records

Step 3

Step 4

Step 5

Step 6

Step 7

Step 8

Step 9

Step 10

Step 11

Step 12

• Department

In the second drop-down list, choose from the following options:

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty

In the search field/list box, enter the value that you want to locate, such as a specific name or User ID.

Note To choose users from more than one department, enter multiple departments in this field. For example, to choose users from departments 12 and 34, enter 12, 34 in the third box instead of performing two operations.

You can click the Search Within Results check box and choose AND or OR to add multiple filters and repeat

Step 2, on page 239

through

Step 4, on page 240

to further define your query.

Click Find . The search results display.

Note To find all users that are registered in the database, click Find without entering any search text.

Click Next .

Enter the export users file name in the File Name text box.

Choose file format from the File Format drop-down list.

In the Job Information area, enter the Job description.

Choose a method to export user records. Do one of the following: a) Click Run Immediately to export user records immediately.

b) Click Run Later to export at a later time.

To create a job for exporting user records, click Submit .

To schedule and

/ or activate this job, use the Job Scheduler option in the Bulk Administration main menu.

What to do next

You can search and download the exported file using the Upload/Download Files option in the Bulk

Administration menu.

Caution The user ID, PKID, password, pin, and digest credentials columns in the exported file should not be modified under any circumstances.

Related Topics

240

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Users

Topics Related to User Record Exports

, on page 241

Topics Related to User Record Exports

•

•

Reset Passwords And PINs, on page 243

Topics Related to User Record Exports

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

241

Topics Related to User Record Exports

Users

242

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Password and PIN Resets

This chapter provides information about how to reset user passwords used to log on to the CiscoUnifiedIP

Phone Self Care Portal window and the extension mobility feature PINs used to log in to CiscoUnifiedIPPhones.

•

Reset Passwords And PINs

You can reset the password that users use when they log on to the CiscoUnifiedIPPhone Self Care Portal window. You can also reset the PINs for the extension mobility feature that users use when they log in to

CiscoUnifiedIPPhones. Use this action when you must reset a group of users to a default password or to a default PIN without updating any other attributes.

You can choose users for resetting passwords and PINs using either a query search or a custom file.

Note Be aware that the credential settings selected on the reset page apply to both the password and the pin.

Reset User Password and PIN Using Query

You can use a query to locate users and reset passwords and PINs to a default value.

Procedure

Step 1

Step 2

Step 3

Choose Bulk Administration > Users > Reset Password/PIN > Query .

To locate the users that you want to reset, define the query filter.

From the first Find User where drop-down list, choose one of the following criteria:

• User ID

• First Name

• Middle Name

• Last Name

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

243

Users

Reset User Password and PIN Using Query

Step 4

Step 5

Step 6

Step 7

Step 8

• Manager

• Department

From the second Find User where drop-down list box, choose one of the following criteria:

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty

Specify the appropriate search text, if applicable, and click Find .

Note To choose users from more than one department, enter multiple departments separated with a comma in this field. For example, to choose users from departments 12 and 14, enter 12, 14 in the third box instead of performing two operations.

Tip To find all users that are registered in the database, click Find without entering any search text.

To further define your query, you can choose AND or OR to add multiple filters and repeat

Step 3, on page

243

and

Step 4, on page 244 .

Click Find .

A list of discovered users displays by

• User ID

• First Name

• Middle Name

• Last Name

• Manager

• Department Name

• LDAP Sync Status

Click Next .

Enter the values that you want to update for all the records that you defined in your query.

• Password—Enter the default password that users use when they log on to the Cisco Unified IP Phone

Self Care Portal window.

• Confirm Password—Reenter the password.

• PIN—Enter the default PIN for the extension mobility feature that users should use when they log in to a Cisco Unified IP Phone.

• Confirm PIN—Reenter the PIN.

244

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Users

Reset User Password and PIN Using Custom File

Step 9

Step 10

Step 11

Step 12

Note If you want your end users to be able to use this PIN to access their Cisco Unity Connection

Voicemail, the Enable End User PIN Synchronization check box in the Application Server

Configuration window must be checked for the connection to the Cisco Unity Connection server.

The PIN in Cisco Unified Communications Manager gets updated only if the PIN in Cisco Unity

Connection gets updated successfully.

In the Job Information area, enter the Job description.

Choose a method to change passwords or PINs. Do one of the following: a) Click Run Immediately to change passwords or PINs immediately.

b) Click Run Later to change them at a later time.

To create a job for resetting passwords or PINs, click Submit .

To schedule and activate this job, use the Job Scheduler option in the Bulk Administration main menu.

To schedule and

/ or activate this job, use the Job Scheduler option in the Bulk Administration main menu.

Tip The log file displays the number of users that were updated and the number of records that failed, including an error code.

Related Topics

, on page 639

Reset User Password and PIN Using Custom File

To locate users and to reset passwords and PINs to default values, you can create a custom file of user IDs by using a text editor.

Before you begin

Create a text file that lists each user ID on a separate line for which you want to reset password or PIN.

Upload the custom file into first node.

Note Do not use the insert or export transaction files that are created with bat.xlt for the reset transaction. Instead, you must create a custom file with details of the user records that need to be reset. Use only this file for the reset transaction. In this custom reset file, you do not need a header, and you can enter values for user ID.

Procedure

Step 1

Step 2

Choose Bulk Administration > Users > Reset Password/PIN > Custom File .

In the Find and List Users window, choose the field that you used in the custom file from the following options:

• User ID

• First Name

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

245

Users

Reset User Password and PIN Using Custom File

Step 3

Step 4

Step 5

Step 6

Step 7

Step 8

Step 9

• Middle Name

• Last Name

• Department

In the In Custom File drop-down list box, choose the filename for the custom file.

Click Next .

In the Reset Password/PIN for Users window, enter the values that you want to update for all the records.

• Password—Enter the default password that users use when they log on to the Cisco Unified IP Phone

Self Care Portal window.

• Confirm Password—Reenter the password.

• PIN—Enter the default PIN for the extension mobility feature that users should use when they log in to a Cisco Unified IP Phone.

• Confirm PIN—Reenter the PIN.

Note If you want your end users to be able to use this PIN to access their Cisco Unity Connection

Voicemail, the Enable End User PIN Synchronization check box in the Application Server

Configuration window must be checked for the connection to the Cisco Unity Connection server.

The PIN in Cisco Unified Communications Manager gets updated only if the PIN in Cisco Unity

Connection gets updated successfully.

In the Job Information area , enter the Job description.

Choose a method to change passwords or PINs. Do one of the following: a) Click Run Immediately to change passwords or PINs immediately.

b) Click Run Later to change them at a later time.

To create a job for resetting passwords or PINs, click Submit .

To schedule and activate this job, use the Job Scheduler option in the Bulk Administration main menu.

To schedule and

/ or activate this job, use the Job Scheduler option in the Bulk Administration main menu.

Tip The log file displays the number of users that were updated and the number of records that failed, including an error code.

Related Topics

, on page 629

Generate User Reports, on page 247

246

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Report Generation

C H A P T E R

•

Generate User Reports

You can generate a report for all users by not specifying any query options, or you can specify a limited set of query options. The format of the reports for users can be customized.

Procedure

Step 1

Step 2

Step 3

Choose Bulk Administration > Users > Generate User Reports .

The Find and List Users window displays.

Note You can generate a report for all users by not specifying a query, or you can generate a report for specific users by using following steps:

In Select Users Where scroll box, choose from these query options: User ID, Department, First Name, Middle

Name, Last Name, Manager.

In the second drop-down list box, choose from the following search criteria.

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

247

Users

Generate User Reports

Step 4

Step 5

Step 6

Step 7

Step 8

Step 9

Step 10

Step 11

In the search field box, enter the value that you want to locate, such as the exact user ID or the last name of a user.

You can add multiple values to the search field box by separating them with a comma as shown in this example:

JohnJ, PaulP, SueS, JoeJ

Tip To generate a report for all users that are registered in the database, click search text.

Find without entering any

Click Find . A list of discovered user records displays.

To choose details for your type of report, click Next .

Note If you want to change the type of query, click Back .

In the File Name field, enter your name for this report (required).

In the Available Fields drop-down list box, choose an item and click the arrow to move the item into the

Selected Fields for this Report list. You can choose one or more fields to include in your report.

Tip You can rearrange the order of the items in the Selected Fields for this report list by choosing an item and clicking the Up arrow or Down arrow to move the item to another position in the list.

In the Job Information area, enter the Job description.

Choose a method to generate reports. Do one of the following: a) Click Run Immediately to generate reports immediately.

b) Click Run Later to generate reports at a later time.

To create a job for generating reports, click Submit .

Use the Job Scheduler option in the Bulk Administration main menu to schedule and

/ or activate this job.

What to do next

You can search and download the report file using the Upload

Download Files option in the Bulk

Administration menu.

Related Topics

Report Log Files , on page 301

, on page 629

View Line Appearances, on page 249

, on page 15

248

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Line Appearance

This chapter provides information to use the Line Appearance menu in BAT to view, export, and update line appearances.

A line appearance is the linkage of a line to a device. The end user is now linked to a line appearance rather than a line.

The system did not provide detailed presence information about relationships such as shared lines to Cisco

Unified Presencepreviously, which led to inaccurate or incomplete presence state. The Line Appearance feature provides detailed information are multiple line appearances associate with a user.

•

•

Export Line Appearances, on page 250

•

Update Line Appearances, on page 251

View Line Appearances

Because you might have several line appearance records, Unified Communications Manager lets you locate specific records on the basis of specific criteria.

Note During your work in a browser session, the cookies on the client machine store your find/list search preferences.

If you navigate to other menu items and return to this menu item, or if you close the browser and then reopen a new browser window, the system retains your Cisco Unified Communications Manager search preferences until you modify your search.

Procedure

Step 1

Step 2

Choose Bulk Administration > Users > Line Appearance > Export Line Appearance .

The Export Users Query window displays.

To find all records in the database, ensure the dialog box is empty; go to

Step 3, on page 250 .

To filter or search records

• From the first drop-down list box, select a search parameter.

• From the second drop-down list box, choose a search pattern.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

249

Users

Export Line Appearances

• Specify the appropriate search text, if applicable.

Note To add additional search criteria click the

+ button. When you add criteria, the system searches for a record that matches all criteria that you specify. To remove criteria, click the

– button to remove the last added criteria or click the Clear Filter button to remove all added search criteria.

Step 3

Step 4

Click Find .

All or matching records display. You can change the number of items that display on each page by choosing a different value from the Rows per Page drop-down list box.

Note You can delete multiple records from the database by checking the check boxes next to the appropriate record and clicking Delete Selected . You can delete all configurable records for this selection by clicking Select All and then clicking Delete Selected .

From the list of records that display, click the link for the record that you want to view.

Note To reverse the sort order, click the up or down arrow, if available, in the list header.

The window displays the item that you choose.

Export Line Appearances

Create a text file that lists details of the line appearance that you want to export.

Upload the custom file into Unified Communications Manager first node.

Find the line appearance records you want to export.

After you have selected line appearance items to export, you can proceed to export the selected line appearances.

Procedure

Step 1

Step 2

Step 3

Step 4

After you have located the items to export, click Next .

The Export Line Appearance Configuration window displays.

In the In Custom File field, enter the filename for the custom file.

In the File Format drop-down list box, choose the file format.

The Line Appearance Format is available by default.

Check one or more of the following check boxes:

• Export line appearances for Cisco Unified Presence users only—The export operation will only get performed on Cisco Unified Presenceusers.

• Export line appearances for all the primary extensions—Line appearances for all devices that share a line to which a user is associated will get exported.

• Export line appearances for the devices associated—Line appearances for all the lines that share a device to which a user is associated will be exported.

250

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Users

Update Line Appearances

Step 5

Step 6

Step 7

In the Job Information area, enter the Job description.

Choose an export method. Do one of the following: a) Click Run Immediately to export line appearances immediately.

b) Click Run Later to export line appearances at a later time.

To create a job for generate reports, click Submit .

To schedule and

/ or activate this job, use the Job Scheduler option in the Bulk Administration main menu.

What to do next

The log file displays the number of users that were updated and the number of records that failed, including an error code.

Related Topics

, on page 639

View Line Appearances , on page 249

, on page 17

Update Line Appearances

Create a text file that lists the following details for the line appearances that you want to update:

• User ID

• Device

• Directory numbers

• Partition (optional)

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

Upload the custom file to Unified Communications Manager server.

You can update line appearances that are listed in a custom file.

Attention The line must be associated to the end user for the Update Line Appearance transaction to be successful.

Procedure

Step 1

Step 2

Step 3

Choose Bulk Administration > Users > Line Appearance > Update Line Appearance .

The Update Line Appearance Configuration window displays.

From the File Name drop-down list box, choose the name of the custom file.

Check the following check boxes to select these options, or skip to

Step 4, on page 252

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

251

Users

Update Line Appearances

Step 4

Step 5

Step 6 a) If you want to update the line appearance for Cisco Unified Presenceusers only, check the Update line appearance for CUP users only check box.

b) If you want to disassociate the line appearance, check the Disassociate line appearances check box.

In the Job Information area, enter the Job description.

Choose a method to update line appearances. Do one of the following: a) Click Run Immediately to update line appearances immediately.

b) Click Run Later to update line appearances at a later time.

To create a job for updating line appearances, click Submit .

To schedule and

/ or activate this job, use the Job Scheduler option in the Bulk Administration main menu.

Related Topics

, on page 629

Insert End User CAPF Profile, on page 253

252

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

End User CAPF Profiles

C H A P T E R

This chapter provides information about using Unified Communications Manager Bulk Administration Tool to add CAPF Profiles to the existing end users in the Unified Communications Manager database.

•

•

Delete End User CAPF Profile, on page 254

•

Export End User CAPF Profile, on page 255

•

BAT Spreadsheet End User CAPF Profile Field Descriptions, on page 256

Insert End User CAPF Profile

You can use a CSV data file to insert CAPF profiles for existing end user records in the Unified

Communications Manager database.

Attention If any information for a record fails during insertion, BAT does not insert that CAPF profile record.

Before you begin

You must have a data file in comma-separated value (CSV) format that contains the unique details for the end user CAPF profiles.

You can create the CSV data file by using one of these methods:

• BAT spreadsheet that is converted to CSV format

• Export utility that produces an export file of End User CAPF Profile data

Procedure

Step 1

Step 2

Choose Bulk Administration > Users > End User CAPF Profile > Insert End User CAPF Profile .

The Insert End User CAPF Profile Configuration window displays.

From the File Name drop-down list box, choose the CSV data file that you created for this specific bulk transaction.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

253

Users

Delete End User CAPF Profile

Step 3

Step 4

Step 5

Step 6

To overwrite the existing CAPF Profile settings with the information that is contained in the file that you want to insert, select the Override the existing configuration check box.

In the Job Information area, enter the job description.

Choose an insert method. Do one of the following: a) Click Run Immediately to insert the CAPF profile immediately.

b) Click Run Later to insert the CAPF profile at a later time.

To create a job for inserting the CAPF profile, click Submit .

To schedule and

/ or activate this job, use the Job Scheduler option in the Bulk Administration main menu.

Attention If any information for a record fails during insertion, BAT does not insert that CAPF profile record.

Related Topics

, on page 629

Delete End User CAPF Profile

You can delete end user CAPF profiles from the Unified Communications Manager database using a custom file.

Before you begin

Before you can delete an end user CAPF profile from Cisco Unified Communications Manager Administration, you must perform the following tasks:

• Create a text file that lists each end user CAPF profile that you want to delete on a separate line.

• Upload the custom file with the first node of the Unified Communications Manager server.

Note Do not use the insert or export transaction files that are created with bat.xlt for the delete transaction. Instead, create a custom file with details of the end user CAPF profile records that need to be deleted. Use only this file for the delete transaction. The custom delete file does not require a header and you can enter values for the you can enter values for the Instance ID or End User ID.

Procedure

Step 1

Step 2

Step 3

Choose Bulk Administration > Users > End User CAPF Profile > Delete End User CAPF Profile .

The Delete End User CAPF Profile Configuration window displays.

From the Delete End User CAPF Profile where End User ID/ Instance ID in custom file drop-down list box, choose the file that you uploaded for deleting end user CAPF profile.

Click Find .

The Job Information section displays along with the selected end user CAPF profile.

254

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Users

Export End User CAPF Profile

Step 4

Step 5

Step 6

You can choose to run the job immediately or later by selecting the corresponding radio buttons.

Click Submit to create a job for deleting the End User CAPF Profile.

A message in the Status section lets you know that the job was submitted successfully.

Use the Job Scheduler option in the Bulk Administration main menu to schedule and/or activate this job.

Related Topics

BAT Spreadsheet End User CAPF Profile Field Descriptions, on page 256

Export End User CAPF Profile

You can export end user CAPF profiles by using BAT.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

Step 8

Choose Bulk Administration > Users > End User CAPF Profile > Export End User CAPF Profile .

The Find and List End User CAPF Profiles To Export window displays.

In the first Find End User CAPF Profile where drop-down list box, choose a field to query from the following options:

• Instance Id

• End User Id

In the second drop-down list box, choose from the following options:

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty

In the search field box, enter the value that you want to locate, such as a specific instance ID or end user ID.

You can choose AND or OR to add multiple filters and repeat

Step 2, on page 255

through

Step 4, on page

255

to further define your query.

Click Find .

All matching records display. You can change the number of items that display on each page by choosing a different value from the Rows per Page drop-down list box.

Tip To find all users that are registered in the database, click Find without entering any search text.

From the list of records that display, click the link for the record that you want to view.

The window displays the record that you choose.

Click Next .

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

255

Users

BAT Spreadsheet End User CAPF Profile Field Descriptions

Step 9

Step 10

Step 11

Step 12

Step 13

The Export End User CAPF Profile Configuration window displays.

In the File Name text box, enter the end user CAPF filename you intend to export.

From the File Format drop-down list box, choose the CAPF file format.

In the Job Information area, enter the job description.

Choose an export method. Do one of the following: a) Click Run Immediately to export the end user CAPF profiles immediately.

b) Click Run Later to export the end user CAPF profiles at a later time.

Click Submit to create a job for exporting the End User CAPF Profile.

Use the Job Scheduler option in the Bulk Administration main menu to schedule and/or activate this job.

Note See

for field descriptions.

Related Topics

Phones with Users, on page 261

, on page 629

BAT Spreadsheet End User CAPF Profile Field Descriptions

The following table describes the fields that display when you are inserting, deleting, or exporting an end user

CAPF profile.

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 15: Field Descriptions for an End User CAPF Profile in BAT

Field

End User ID

Instance ID

Certificate Operation

Description

Enter the end user User ID.

Enter 1-128 alphanumeric characters (a through z, A, through Z, and 0 through 9). The Instance ID identifies the user for the certificate operation.

Enter one of the following options:

• No Pending Operation—Displays when no certificate operation is occurring. This is the default setting for certificate operation.

• Install/Upgrade—Installs a new or upgrades an existing locally significant certificate for the application.

256

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Users

Field

Authentication Mode

Authentication String

Key Size (bits)

Operation Completes by

BAT Spreadsheet End User CAPF Profile Field Descriptions

Description

The authentication mode for the Install/Upgrade certificate operation specifies “By Authentication

String,” which means that CAPF installs, upgrades, or troubleshoots a locally significant certificate only when the user/administrator enters the CAPF authentication string in the JTAPI/TSP Preferences window.

Enter a numeric string that contains between 4 and

10 digits.

Enter the key size for the certificate. The default setting specifies 1024. Other options include 512 and

2048.

This field, which supports all certificate operations, specifies the date and time by which you must complete the operation.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

257

BAT Spreadsheet End User CAPF Profile Field Descriptions

Users

258

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

P A R T

Phones and Users

•

•

Phones and Users File Formats, on page 263

•

Phone and User Validations, on page 265

•

Phone and User Insertions, on page 267

C H A P T E R

Phones with Users

This chapter provides information about using Cisco Unified Communications Manager Bulk Administration to add a group of users and their phones on a Cisco Unified Communications Manager server in one bulk transaction. You have two options for creating a CSV data file for the 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).

You can access the Insert Phones with Users option by choosing Bulk Administration > Phones and Users from the Cisco Unified Communications Manager Administration main menu.

•

Add New Phones with Users, on page 261

•

Add Phones with Users Using the BAT Spreadsheet, on page 262

•

Add New Phones with Users

Use the following steps to insert phones with users.

Procedure

Step 1

Step 2

Step 3

Step 4

To define individual values for each phone/user record that you want to update, create a comma separated values (CSV) data file.

• See the

Add Phones with Users Using the BAT Spreadsheet, on page 262 .

• For a text-based CSV file, see the

Phones with Users Combinations File Format, on page 661 .

Associate file format with the CSV data file.

• See the

Add Phone and User File Format, on page 263 .

Validate phones with users records

• See the

Validate Phones and User Records, on page 265 .

Insert phones with users records.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

261

Phones and Users

Add Phones with Users Using the BAT Spreadsheet

• See the

Insert Phones with Users Into Unified Communications Manager, on page 267 .

Add Phones with Users Using the BAT Spreadsheet

Create a CSV data file for adding phones and users in bulk.

Procedure

Step 1

Step 2

Step 3

Step 4

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

You can download a BAT.xlt file.

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

At the bottom of the spreadsheet, click the Phones-Users tab.

Follow steps 4 through 10 in

Create Phone CSV Data File Using BAT Spreadsheet, on page 83 .

Topics Related to Phones with Users

, on page 262

Add New Phones with Users, on page 261

, on page 15

Topics Related to Phones with Users

•

•

Phones with Users Combinations File Format, on page 661

•

Add Phone and User File Format, on page 263

•

Validate Phones and User Records, on page 265

•

Insert Phones with Users Into Unified Communications Manager, on page 267

262

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Phones and Users File Formats

This chapter provides information to update phones and users file formats using a comma separated values

(CSV) data file.

•

Add Phone and User File Format, on page 263

•

Add Phone and User File Format

You can add the phone and user file format with a text-based CSV data file. After the CSV data file is created, 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.

Before you begin

You must create a CSV data file that defines individual values for each user that you want to update.

When you use a text editor to create the CSV data file, you create a file format for entering values in the text-based file. You enter values in the text file in the order that the file format specifies.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Choose Bulk Administration > Phones and Users > Phones & Users File Format > Assign File Format .

The Add File Format Configuration window displays.

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

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

To create a job for associating the matching file format with the CSV data file, click Submit .

To schedule and/or activate this job, use the Job Scheduler option in the Bulk Administration main menu.

Note The user fields get added automatically when you add the file format.

Related Topics

, on page 639

Add Phones with Users Using the BAT Spreadsheet, on page 262

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

263

Topics Related to Phone and User File Formats

Topics Related to Phone and User File Formats

•

•

Phones with Users Combinations File Format, on page 661

•

Validate Phones and User Records, on page 265

Phones and Users

264

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Phone and User Validations

You can use Cisco Unified Communications Manager Bulk Administration (BAT) to add a group of users and their phones on a Cisco Unified Communications Manager server in one bulk transaction. Two options exist for creating a CSV data file for the 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).

You can access the Insert Phones with Users option by choosing Bulk Administration > PhonesandUsers from the Cisco Unified Communications Manager Administration main menu.

•

•

Validate Phones and User Records

You can validate your CSV data file records for phones and users. When you choose Validate Phones

Users, 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 checks only the device fields and their dependencies.

Note The Primary Extension and Primary User Device of the user do not get validated.

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.

You must create a comma separated values (CSV) data file that defines individual values for each phone

/ user that you want to validate. You can create the CSV data file using the BAT spreadsheet

(BAT.xlt) and export data to the CSV format, or use a text editor to create a custom text file in CSV format.

Associate the file format with the CSV data file.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

265

Phones and Users

Topics Related to Phone and User Validation

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Choose Bulk Administration > Phones and Users > Validate Phones/Users .

The Validate Phones/Users Configuration window displays.

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

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

To create a job for validating users and phones, click Submit .

To schedule and/or activate this job, use the Job Scheduler option in the Bulk Administration main menu.

Phones with Users Combinations File Format , on page 661

Standard Phone Templates

, on page 5

Validate Phones and User Records , on page 265

, on page 629

, on page 266

Topics Related to Phone and User Validation

•

Phones with Users Combinations File Format, on page 661

•

Associate Text-Based File Format with CSV Data File, on page 117

•

•

Insert Phones with Users Into Unified Communications Manager, on page 267

266

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Phone and User Insertions

This chapter provides information to add a group of phones and users to the Unified Communications Manager database and directory.

•

•

InsertPhoneswithUsersIntoUnifiedCommunicationsManager

You can add a group of phones and users to the Unified Communications Manager database and directory.

Note Phone records must be validated before insertion.

Unified Communications Manager Administration or the UnifiedCM Auto-Register phone Tool. Do not use the dummy MAC address option for H.323 clients, VGC phones, or VGC virtual phones.

The dummy MAC address option automatically generates dummy MAC addresses in the following format:

XXXXXXXXXXXX where X represents any 12-character, hexadecimal (0-9 and A-F) number.

Before you begin

Create a comma-separated values (CSV) data file to define individual values for each phone with users that you want to insert. You can create the CSV data file using the BAT spreadsheet (BAT.xlt) to add phones with users, or create a custom text file in CSV format to add phones with users combinations.

Associate file format with the CSV data file.

Validate phones with users records.

Procedure

Step 1

Step 2

Choose Bulk Administration > Phones & Users > Insert Phones with Users .

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

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

267

Phones and Users

Topics Related to Phone and User Insertion

Step 3

Step 4

Step 5

Step 6

Step 7

In the Phone Template Name field, choose the BAT phone template that you used for this transaction.

Attention If you did not enter individual MAC addresses in the CSV data file, you must check the Create

Dummy MAC Address check box. You can update this information manually later. If you supplied

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

If you do not know the MAC address of the phone that is assigned to the user, choose this option.

When the phone is plugged in, a MAC address registers for that device.

In the User Template Name field, choose the BAT user template that you used for this transaction

In the Job Information area, enter the Job description.

Choose an insert method. Do one of the following: a) Click Run Immediately to insert the phones with users immediately.

b) Click Run Later to insert the phones with users at a later time.

To create a job for inserting the phones and user records, click Submit .

To schedule and activate this job, use the Job Scheduler option in the Bulk Administration main menu.

Related Topics

Add Phone and User File Format

, on page 263

Add Phones with Users Using the BAT Spreadsheet

, on page 262

Phones with Users Combinations File Format , on page 661

TAPS Overview , on page 613

, on page 629

Validate Phones and User Records , on page 265

Topics Related to Phone and User Insertion

•

Add Phones with Users Using the BAT Spreadsheet, on page 262

•

Phones with Users Combinations File Format, on page 661

•

Add Phone and User File Format, on page 263

•

Validate Phones and User Records, on page 265

•

TAPS Overview, on page 613

•

•

Cisco Unified Communications Manager Assistant, on page 271

268

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

P A R T

Managers and Assistants

•

•

Manager and Assistant Insertions, on page 285

•

Manager and Assistant Deletions, on page 289

•

Manager Deletions, on page 291

•

Assistant Deletions, on page 295

•

Manager and Assistant Report Generation, on page 299

C H A P T E R

Cisco Unified Communications Manager

Assistant

This chapter provides information about setting up manager and assistant phones with either shared lines or proxy lines for the Unified Communications Manager Assistant. Information is also provided for adding and updating manager-assistant associations using a BAT spreadsheet, and for creating default and custom CSV data files for manager-assistants.

You can use the Cisco Unified Communications Manager Bulk Administration (BAT) to manage the Cisco

Unified Communications Manager Assistant feature in Unified Communications Manager. You can add, update, and delete managers or assistants with their associations in bulk transactions.

For detailed tasks and information about Cisco Unified Communications Manager Assistant, see the Feature

Configuration Guide for Cisco Unified Communications Manager at http://www.cisco.com/c/en/us/support/ unified-communications/unified-communications-manager-callmanager/ products-installation-and-configuration-guides-list.html

•

Phones and Lines for Cisco Unified Communications Manager Assistant, on page 271

•

CSV Data File for Manager-Assistant Associations, on page 280

•

Phones and Lines for Cisco Unified Communications Manager

Assistant

The CiscoUnifiedCM Assistant feature works with several CiscoUnifiedIPPhone models and device profiles.

CiscoUnifiedCM Assistant provides two modes for configuring managers and assistants lines for use with

CiscoUnifiedCM Assistant features.

• Proxy mode—The primary manager line associates with a proxy line that has a different directory number on the assistant phone.

• Shared line mode—The manager and assistant have a shared line on their phones that uses the same directory number and partition.

Note You can associate users to devices/phones only if they support UnifiedCM Assistant.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

271

Managers and Assistants

Set Up Phones in Proxy Line Mode for Cisco Unified Communications Manager Assistant

You can use BAT to set up the manager and assistant phones with either proxy lines or shared lines.

Set Up Phones in Shared Line Mode for Cisco Unified Communications Manager Assistant

, on page 278

Insert Manager-Assistant Associations to Cisco Unified Communications Manager , on page 285

Set Up Phones in Proxy Line Mode for Cisco Unified Communications Manager

Assistant

To prepare for configuring manager and assistant phones with UnifiedCM Assistant proxy line support, you must complete the following tasks:

Procedure

Step 1

Step 2

Step 3

Step 4

Set up and configure UnifiedCM Assistant requirements for your system. Cisco recommends that you use the

CiscoUnifiedCM Assistant Configuration Wizard. The wizard automatically creates the phone templates for

UnifiedCM Assistant manager and assistant, route points, partitions, translation patterns, and calling search space for the CiscoUnifiedCM Assistant service. To run the CiscoUnifiedCM Assistant Configuration Wizard, ensure BAT and the wizard are on the same server.

See the Feature Configuration Guide for Cisco Unified Communications Manager Guide for information about running the CiscoUnifiedCM Assistant Configuration Wizard.

Note You can use the CiscoUnifiedCM Assistant Configuration Wizard only one time to set up the

UnifiedCM Assistant configuration requirements for your system. After running the configuration wizard, you can only view, but not change, your configuration with the wizard.

To add new phones and users for managers and assistants, use the UnifiedCM Assistant manager and UnifiedCM

Assistant assistant phone templates that the CiscoUnifiedCM Assistant Configuration Wizard produced on the BAT server. Use the BAT templates to configure phones for proxy mode only.

For existing manager and assistant phones, you can change the manager and assistant phones to correspond to the UnifiedCM Assistant phone templates by using either of these methods:

• You can use the Add Lines feature in BAT to modify existing phones to resemble the UnifiedCM Assistant phone templates.

• You can delete the original phones and add new phones by using the UnifiedCM Assistant phone templates for managers and assistants.

After you configure the phones and lines for managers and assistants, you associate the manager and assistant lines for UnifiedCM Assistant control.

273

Add Phone Lines to Existing Phones and UDPs , on page 171

Add Phones to Database

, on page 21

Manager and Assistant Proxy Line Configurations

, on page 273

272

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Managers and Assistants

Cisco Unified Communications Manager Assistant Manager Phone Template Default Settings

The following table lists the default settings for the UnifiedCM Assistant manager phone template.

Table 16: Default Settings for Manager Phone Templates for Proxy Lines

Field

Softkey Template

Phone Button Template

Line1

Line 2

Default Value

Softkey Template Standard Manager

Standard CiscoUnifiedIPPhone 7960 (2 lines)

Primary line

• CSS = Generated_CSS_I_E

• Partition = Generated_Managers

Incoming Intercom line

• CSS = Generated_CSS_I_E

• Partition = Generated_Everyone

• Also configure auto answer with headset option.

Assistant Primary Service Services

The following table lists the default settings for the UnifiedCM Assistant assistant phone template.

Table 17: Default Settings for Assistant Phone Template for Proxy Lines

Field

Softkey Template

Phone Button Template

Expansion Module 1

Default Value

Softkey Assistant

Standard CiscoUnifiedIPPhone 7960 Assistant

14-button expansion module

One line on base phone and five lines on expansion module

For proxy lines, one line on base phone and five lines on expansion module have the following default configuration:

• CSS = Generated_CSS_M_E

• Partition = Generated_Everyone

Line 7

(On Expansion Module)

Intercom line

• CSS = Generated_CSS_I_E

• Partition = Generated_Everyone

• Also configure auto answer with headset option.

Manager and Assistant Proxy Line Configurations

BAT assigns UnifiedCM Assistant line configurations by mapping the primary manager lines on the phone to proxy lines on the assistant phone. When you use the UnifiedCM Assistant manager and assistant default templates that the UnifiedCM Assistant wizard created, you can associate from one to five manager lines on

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

273

Managers and Assistants

Cisco Unified Communications Manager Assistant Manager Phone Line Configurations one assistant phone. For phones that are configured with the UnifiedCM Assistant templates, this example shows the line configurations when you associate two manager phones to an assistant phone.

Manager 1 Phone

• Line 1— Primary line

• Line 2— Intercom line

Manager 2 Phone

• Line 1— Primary line

• Line 2— Intercom line

Assistant Phone

• Line 1—Primary line

• Line 2—Proxy line for Manager 1

• Line 3—Proxy line for Manager 2

• Lines 4 through 6 are unassigned

• Line 7—Intercom line

Assistant Phone

Lines 4 through 6 remain available for other manager associations.

When you associate multiple managers to an assistant phone, BAT creates proxy lines based on the order in the CSV data file. BAT creates the first manager-assistant line by assigning all the primary manager lines as proxy lines to the unassigned lines on the assistant phone. BAT continues creating individual manager-assistant proxy lines based on the order of the CSV record until all lines on the assistant phone are assigned or all managers in the CSV record are associated.

When you associate multiple assistants to a manager primary line, BAT assigns assistants to the manager based on the order in the CSV data file. BAT assigns the primary manager lines based on the first assistant number of available lines. For example, a manager phone has two primary lines.

The first assistant, who is listed in the CSV data file, has only one available line. Consequently, BAT associates only one primary line for the manager and one proxy line on all the assistant phones that are listed in the CSV record.

Cisco Unified Communications Manager Assistant Manager Phone Line Configurations

The following table lists all possible line configurations for a manager phone that BAT can set up when you are using manager-assistant associations.

274

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Managers and Assistants

Unified CM Assistant Phone Line Configurations

Table 18: Manager Phone Line Configuration

Number of Available Lines

One line

Two lines

(Default UnifiedCM Assistant manager phone template)

More than two lines

Configuration

Line 1—Primary line (UnifiedCM Assistant controlled)

Intercom line (none)

Line 1—Primary line (UnifiedCM Assistant controlled)

Line 2—Intercom line (optional)

Last line gets configured as the intercom line.

The number of available lines on the assistant phone determines the number of manager lines that get associated with proxy lines.

Unified CM Assistant Phone Line Configurations

The following table lists the default line configurations for the assistant phones that BAT sets up during manager-assistant associations.

Table 19: Assistant Phone Line Configurations

Number of Available Lines

One line

Two lines

Three lines

More than three lines

Seven lines

(Default UnifiedCM Assistant assistant phone template)

Configuration

Line 1—Proxy line

Intercom line (none)

Line 1—Primary line

Line 2—Proxy line

Intercom line (none)

Line 1—Primary line

Line 2—Proxy line

Line 3—Intercom line

Line 1—Primary line

Line 2—Proxy line

Last line gets configured as the intercom line

All other lines get configured as proxy lines

Line 1—Primary line

Line 2 through line 6 can get configured as proxy lines to support up to five managers.

Line 7—Intercom line

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

275

Managers and Assistants

Proxy Line Example for Cisco Unified Communications Manager Assistant Manager and Assistant Phones

You associate two managers, each with three existing lines, to an assistant phone with six unassigned lines.

BAT sets the following line configurations on the manager and assistant phones.

Manager 1 Phone

• Line 1—Manager primary line (DN is 2355)

• Line 2—Manager primary line (DN is 2366)

• Line 3—Manager intercom line

Manager 2 Phone

• Line 1—Manager primary line (DN is 2656)

• Line 2—Manager primary line (DN is 2666)

• Line 3—Manager intercom line

Assistant Phone

• Line 1—Assistant primary line (DN is 3333)

• Line 2—Proxy line 1 for Manager 1 (DN is 3455)

• Line 3—Proxy line 1 for Manager 2 (DN is 3656))

• Line 4—Proxy line 2 for Manager 1 (DN is 3366)

• Line 5—Proxy line 2 for Manager 2 (DN is 3666)

• Line 6—Available

• Line 7—Assistant intercom line

Assistant Phone

When you associate a manager phone that has preexisting primary lines, you must ensure that the number of unassigned lines on the assistant phone equals or is greater than the number of primary lines on the manager phone. For instance, BAT does not allow you to create an association between a manager that has a phone with four configured primary lines and an assistant with only three available lines.

Set Up Proxy Lines on New Manager and Assistant Phones for Cisco Unified Communications

Manager Assistant

You can set up new UnifiedCM Assistant manager and assistant phones to use proxy lines.

276

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Managers and Assistants

Set Up Proxy Lines on Existing Manager and Assistant Phones for Cisco Unified Communications Manager Assistant

Before you begin

Run the UnifiedCM Assistant Configuration Wizard to create the UnifiedCM Assistant templates, partition, and calling search space.

If you want to associate more than five managers to an assistant, you must access the UnifiedCM Assistant

Template and make a copy with a new name. Add more lines to the template to accommodate the additional managers.

Procedure

Step 1

Step 2

Choose BAT Administration > Phones > Phones Template .

The Phone Template Configuration window displays.

Note Because BAT UnifiedCM Assistant templates are write protected, if you want to make changes to these templates, you must make a copy of the template and then edit the template with your changes.

See

Table 16: Default Settings for Manager Phone Templates for Proxy Lines, on page 273

for default manager phone template field descriptions. See

Table 17: Default Settings for Assistant

Phone Template for Proxy Lines, on page 273

for default assistant phone template field descriptions.

Create the CSV data file for manager phones and another file for assistant phones using these options: a) Use the BAT spreadsheet and choose the Phones tab.

b) Use a text editor and refer to the manager or assistant template fields as a guide.

What to do next

Follow the procedures in

Add Phones to Database, on page 21

to insert new phones.

Set Up Proxy Lines on Existing Manager and Assistant Phones for Cisco Unified Communications

Manager Assistant

You can set up existing UnifiedCM Assistant manager and assistant phones to use proxy lines.

Procedure

Step 1

Step 2

Step 3

Choose BAT Administration > Phones > Add Lines .

The Phone Add Lines window displays.

You may need to copy and modify the UnifiedCM Assistant templates for BAT.

See

Table 16: Default Settings for Manager Phone Templates for Proxy Lines, on page 273

for default manager phone template field descriptions, and see

Table 17: Default Settings for Assistant Phone Template for Proxy

Lines, on page 273

for default assistant phone template field descriptions.

Note If you changed any configuration information (for example, partition names) when you ran the

CiscoUnifiedCM Assistant Configuration Wizard, you must use the same configuration information for the fields when you edit the template.

Create the CSV data file for manager phones and another file for assistant phones using one of these options:

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

277

Managers and Assistants

Set Up Phones in Shared Line Mode for Cisco Unified Communications Manager Assistant a) Use the BAT spreadsheet and choose the Add Lines tab.

b) Use a text editor and use the manager or assistant template fields as a guide.

What to do next

You can set up manager and assistant lines on existing phones.

, on page 284

SetUpPhonesinSharedLineModeforCiscoUnifiedCommunicationsManager

Assistant

You can set up manager and assistant phones to use shared lines when you create a BAT template to add new phones in the CiscoUnified Communications Manager database. Use the procedures for setting up new phones using BAT.

Before you begin

You must set up the UnifiedCM Assistant service parameters for shared line support in CiscoUnified

Communications Manager.

Note If you have a CiscoUnifiedIPPhone model 7960, you need a phone button template with five or more lines.

Procedure

Create a BAT template to add new or update existing manager and assistant phones using the following guidelines: a) For manager phones, see

Manager Phone Settings for Shared Line Mode, on page 279

b) For assistant phones, see

Assistant Phone Settings for Shared Line Mode, on page 279 .

What to do next

You must associate the manager and assistant lines for UnifiedCM Assistant control. Follow the procedures in the

CSV Data File for Manager-Assistant Associations, on page 280

Related Topics

Add Phones to Database

, on page 21

Add Phone Lines to Existing Phones and UDPs , on page 171

278

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Managers and Assistants

Manager Phone Settings for Shared Line Mode

When you create the BAT template to add new or update existing manager phones with shared lines, use the following phone settings:

• Assign the Softkey template: Standard Shared Mode Manager.

• Add primary lines to share with assistants, if needed.

• Set up the voice-messaging profile on the primary line.

• Add an incoming intercom line (optional).

• Add speed-dial buttons for outgoing intercom targets (optional).

• Set the user locale.

Related Topics

Add Phones to Database , on page 21

Set Up Phones in Shared Line Mode for Cisco Unified Communications Manager Assistant , on page 278

Assistant Phone Settings for Shared Line Mode

When you create the BAT template to add new or update existing assistant phones with shared lines, use the following phone settings:

• Assign the Softkey template: Standard Assistant

• If you are using a Cisco 14-button expansion module (7914) for additional lines, specify the expansion module type in the BAT template.

Note CiscoUnifiedIPPhone 7960 phone button templates include expansion module lines.

• Add a personal primary line.

• Add shared lines for each associated manager. Use the same directory number and partition as the primary line on the manager phone.

• Add an incoming intercom line (optional)

• Add speed dials to the managers intercom lines (optional)

• Set the user locale

Related Topics

Add Phones to Database , on page 21

Set Up Phones in Shared Line Mode for Cisco Unified Communications Manager Assistant , on page 278

Manager and Assistant Shared Line Configurations

BAT associates CiscoUnifiedCM Assistant line configurations to shared lines that are assigned to the manager and the assistant phones. You set the shared line mode in the manager’s configuration when associating managers with assistants.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

279

Managers and Assistants

CSV Data File for Manager-Assistant Associations

In shared line mode, the manager line corresponds to a shared line on the assistant phone. For example, to associate two managers with an assistant, you add two lines to the assistant phone that have the same directory numbers and partitions as the primary lines on the manager phones.

Manager 1 Phone

• Line 1— Primary line (DN is 2355)

• Line 2— Intercom line (optional)

Manager 2 Phone

• Line 1— Primary line (DN is 2875)

• Line 2— Intercom line (optional)

Assistant Phone

• Line 1—Assistant primary line (DN is 3356)

• Line 2—Shared line with Manager 1 (DN is 2355)

• Line 3—Shared line with Manager 2 (DN is 2875)

• Lines 4 through 6 are available

• Line 7—Intercom line (optional)

You can add lines 4 through 6 as shared lines for other managers.

When you add multiple manager lines to an assistant phone, all lines on the assistant phone must use shared line mode. You cannot mix proxy and shared lines on the assistant phone. Likewise, when a manager has multiple assistants, all associations must use shared line mode.

When you associate multiple assistants to a manager who has shared line mode, BAT assigns UnifiedCM

Assistant associations only to those assistants that are also using shared line mode.

, on page 284

CSV Data File for Manager-Assistant Associations

When you use BAT to insert manager-assistant associations to the Unified Communications Manager database, you can add new associations or update existing associations.

You have two options for creating a CSV data file to add or update manager-assistant associations: using the

BAT spreadsheet or using a text editor to create a text file in CSV format.

When you create an association for a new manager, you need to enter a device name. When you update a manager with an existing UnifiedCM Assistant record, consider these fields optional. BAT does not allow you to assign the intercom line of a manager to a proxy line for an assistant if the number of manager lines is greater than or equal to three.

280

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Managers and Assistants

Add or Update Manager-Assistant Associations Using BAT Spreadsheet

Managers and Assistants File Formats , on page 672

Manager and Assistant Proxy Line Configurations , on page 273

Add or Update Manager-Assistant Associations Using BAT Spreadsheet

Use the BAT spreadsheet to add new or update existing UnifiedCM Assistant associations. The BAT spreadsheet includes data file templates with macros to make it easy to add, update, or delete manager-assistant associations.

Procedure

Add new UnifiedCM Assistant associations using the BAT spreadsheet.

a) To create manager-assistant associations with the default line configuration, see

Create Default

Manager-Assistant CSV Data Files, on page 281 .

See

Table 18: Manager Phone Line Configuration, on page 275

and

Table 19: Assistant Phone Line

Configurations, on page 275

for the default line configurations for the manager and assistant phones.

b) To assign proxy lines that do not follow the default line configuration, see

Create Custom Manager-Assistant

CSV Data Files, on page 283 .

, on page 8

Manager-assistantAssociationAdditionsandUpdatesUsingBATSpreadsheet

The BAT spreadsheet includes data file templates with macros to make it easy to add, update, or delete manager-assistant associations.

When you use the BAT spreadsheet to add new Unified CM Assistant associations, you can set up the manager-assistant configurations in two ways:

• Create manager-assistant associations with the default line configuration. For the default line configurations for the manager and assistant phones, see

Table 18: Manager Phone Line Configuration, on page 275

and

Table 19: Assistant Phone Line Configurations, on page 275

• Assign proxy lines that do not follow the default line configuration using a custom CSV data file.

, on page 8

Create Custom Manager-Assistant CSV Data Files

, on page 283

Create Default Manager-Assistant CSV Data Files , on page 281

Create Default Manager-Assistant CSV Data Files

Use the BAT spreadsheet to create a CSV data file for inserting, updating, or deleting default manager-assistant associations for both proxy and shared mode.

After you have finished editing all the fields in the BAT spreadsheet, you can export the content to a CSV formatted data file. The file is saved to C:\XLSDataFiles or to your choice of another existing folder on your local workstation and is assigned a default filename:

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

281

Managers and Assistants

Create Default Manager-Assistant CSV Data Files

<type of operation>ManagerAssistants-timestamp.txt

where

<type of operation> can be either insert or delete, and “ timestamp

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

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

Download and open the BAT.xlt file to open the BAT spreadsheet.

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

To display the manager-assistant association options, click the Default Managers-Assistants tab at the bottom of the spreadsheet.

Scroll to the right side of the template until you see the radio buttons and choose the type of associations for this transaction:

• One manager, multiple assistants

• One assistant, multiple managers

Complete all mandatory fields and any relevant, optional fields.

a) If you choose the One manager, multiple assistants radio button, enter the following information in each row:

• Manager ID—Enter the user ID, up to 30 characters, of the manager.

• Assistant ID

—Enter the user IDs, up to 30 characters, for the assistants to whom the manager will be associated, where the

# symbol represents the number of assistants assigned to a manager.

Tip To add more assistants, click Add more Assistants .

b) If you choose the One assistant, multiple managers radio button, enter the following information in each row:

• Assistant ID—Enter the user ID, up to 30 characters, of the assistant.

• Manager ID

—Enter the user IDs, up to 30 characters, for the managers to whom the assistant will be associated. where the

# symbol represents the number of managers assigned to an assistant.

Note To add more managers, click Add more Managers .

Choose the operation that you want to perform: a) To create new manager-assistant associations, click Insert .

b) To delete a manager or an assistant from a manager-assistant association, click Delete .

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

Tip For information on how to read the exported CSV data file, click the link to View Sample File in the Insert Managers/Assistants window in BAT.

The system saves the file using the default filename

<type of operation>ManagerAssistants-timestamp.txt

to C:\XLSDataFiles or to your choice of another existing folder on your local workstation.

282

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Managers and Assistants

Create Custom Manager-Assistant CSV Data Files

What to do next

You must upload the CSV data file to the Cisco Unified Communications Manager first node database server so BAT can access the CSV data file.

Related Topics

Download File Off Server , on page 16

, on page 17

Create Custom Manager-Assistant CSV Data Files

When you have existing phones that you want to set up with manager-assistant associations, you can use the

Custom Managers-Assistants tab in the BAT spreadsheet. Use the BAT spreadsheet to create a custom CSV data file for inserting or updating manager-assistant associations for proxy lines on the assistant phones.

After you have finished editing all the fields in the BAT spreadsheet, you can export the content to a CSV formatted data file. The system saves the file using the default filename

Custom

Manager-Assistants-timestamp.txt

to C:\XLSDataFiles or to your choice of another existing folder on your local workstation.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Download the BAT.xlt file from Cisco Unified Communications Manager server.

Open the BAT.xlt file. When prompted, click Enable Macros to use the spreadsheet capabilities.

To display the manager-assistant association options, click the Custom Managers-Assistants tab at the bottom of the spreadsheet.

Scroll to the right side of the template until you see Number of Proxy Lines box. In that box, enter the number of proxy lines that you are assigning to an assistant. The spreadsheet adds Proxy Line DN and Manager Line

DN Columns based on the number that you enter.

Complete all mandatory fields and any relevant, optional fields.

• Manager ID—Enter the user ID of the manager.

• Device Name—Enter the device name that are assigned to the manager phone.

• Intercom DN—Enter the directory number for the manager intercom line. (Optional)

• Assistant ID—Enter the user IDs for the assistants to whom the manager will be associated.

• Device Name—Enter the device name that are assigned to the assistant's phone.

• Intercom DN—Enter the directory number for the assistant intercom line. (Optional)

• Proxy Line DN

—Enter the directory number for the assistant proxy line.

• Manager Line DN

—Enter the directory number for the manager primary line.

The

# symbol represents the number of proxy lines that are associated to a manager.

To transfer the data from the BAT spreadsheet into a CSV data file, click

Export to BAT Format button.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

283

Managers and Assistants

Topics Related to CVS Data Files for Manager-Assistant

Tip For information on how to read the exported CSV data file, click the link to View Sample File in the Insert Managers/Assistants window in BAT.

The system saves the file using the default filename

Custom Manager-Assistants-timestamp.txt

C:\XLSDataFiles or to your choice of another existing folder on your local workstation.

What to do next

You must upload the CSV data file to the Unified Communications Manager first node database server so

BAT can access the CSV data file.

, on page 284

Phones and Lines for Cisco Unified Communications Manager Assistant, on page 271

Topics Related to CVS Data Files for Manager-Assistant

•

•

CSV Data File for Manager-Assistant Associations, on page 280

•

Insert Manager-Assistant Associations to Cisco Unified Communications Manager, on page 285

•

Set Up Phones in Proxy Line Mode for Cisco Unified Communications Manager Assistant, on page 272

•

Set Up Phones in Shared Line Mode for Cisco Unified Communications Manager Assistant, on page 278

•

Delete Specific Manager-Assistant Associations From Cisco Unified Communications Manager, on page

289

For more information related to CiscoUnifiedCM Assistant, refer to this documentation.

• Feature Configuration Guide for Cisco Unified Communications Manager

• Cisco Unified Communications Manager Assistant User Guide

284

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Manager and Assistant Insertions

This chapter provides information to use Cisco Unified Communications Manager Bulk Administration (BAT) to manage the Cisco Unified Communications Manager Assistant feature in Cisco Unified Communications

Manager. BAT allows you to add IP phones for managers and assistants with either proxy lines or shared lines.

The CiscoUnifiedCM Assistant feature works with several CiscoUnifiedIPPhone models and device profiles.

CiscoUnifiedCM Assistant provides two modes for configuring managers and assistants lines for use with

CiscoUnifiedCM Assistant features.

• Proxy mode—The manager primary line associates with a proxy line that has a different directory number on the assistant phone. See the

Set Up Phones in Proxy Line Mode for Cisco Unified Communications

Manager Assistant, on page 272

• Shared line mode—The manager and assistant have a shared line on their phones that uses the same directory number and partition. See the

Set Up Phones in Shared Line Mode for Cisco Unified

Communications Manager Assistant, on page 278 .

•

Insert Manager-Assistant Associations to Cisco Unified Communications Manager, on page 285

•

Insert Manager-Assistant Associations to Cisco Unified

Communications Manager

To insert new manager-assistant associations or update existing associations, you need a CSV data file.

When BAT updates manager-assistant associations, it does not change existing CiscoUnifiedCM Assistant line configurations for the intercom directory number or associated devices.

Caution The manager-assistant association fails when the assistant phone does not have enough lines to support the minimum CiscoUnifiedCM Assistant configuration.

Before you begin

Make sure that you have configured manager and assistant phones using one of the following two procedures:

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

285

Managers and Assistants

Insert Manager-Assistant Associations to Cisco Unified Communications Manager

•

Set Up Phones in Proxy Line Mode for Cisco Unified Communications Manager Assistant, on page

272

•

Set Up Phones in Shared Line Mode for Cisco Unified Communications Manager Assistant, on page

278

You must have a data file in comma separated value (CSV) format that contains the unique details for the new manager-assistant associations.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

Step 8

Choose Bulk Administration > Managers/Assistants > Insert Managers/Assistants .

The Manager/Assistant Options window displays.

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

If the managers use extension mobility to log in, check the Configure managers as mobile managers check box.

When all the phones have shared lines, check the Uses shared lines check box.

In the Insert Options area, choose the type of CSV data file that you created:

• Default—If you created a standard CSV data file, choose the type of associations for this transaction based on the data in the CSV file.

• Associate one or more assistants to a manager

• Associate one or more managers to an assistant

• Custom—If you created a custom CSV data file for proxy mode.

In the Job Information area, enter the Job description.

Choose an insert method. Do one of the following: a) Click Run Immediately to insert the manager-assistant associations immediately.

b) Click Run Later to insert the manager-assistant associations at a later time.

To create a job for inserting the manager-assistant records, click Submit .

To schedule and activate this job, use the Job Scheduler option in the Bulk Administration main menu.

Attention If there were not enough available lines when BAT performs an update to an assistant or manager configuration, the changes are only partially completed and the whole transaction record fails.

What to do next

For changes to take effect, you must restart CiscoUnifiedCM Assistant service.

Related Topics

CSV Data File for Manager-Assistant Associations

, on page 280

Set Up Phones in Proxy Line Mode for Cisco Unified Communications Manager Assistant, on page 272

, on page 629

286

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Managers and Assistants

Topics Related to Manager and Assistant Insertion

Topics Related to Manager and Assistant Insertion

•

•

Set Up Phones in Shared Line Mode for Cisco Unified Communications Manager Assistant, on page 278

•

CSV Data File for Manager-Assistant Associations, on page 280

•

•

Delete Specific Manager-Assistant Associations From Cisco Unified Communications Manager, on page

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

287

Topics Related to Manager and Assistant Insertion

Managers and Assistants

288

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Manager and Assistant Deletions

This chapter provides information to use Unified Communications Manager Bulk Administration (BAT) to delete a specific manager-assistant association from the Unified Communications Manager database.

•

289

Delete Specific Manager-Assistant Associations From Cisco

Unified Communications Manager

You can delete specific manager-assistant associations from Cisco Unified Communications Manager.

Before you begin

You must have a CSV data file that contains the user IDs for the specific managers and assistants associations that you want to delete.

For example, the assistant with the user ID, jmorgan, is assigned to two managers with user IDs, rcraig and dbaker. If you want to change the manager-assistant association, so the assistant, jmorgan is only assigned to rcraig, you can delete the jmorgan-dbaker association by creating a CSV data file with the following entry: jmorgan,dbaker

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Choose Bulk Administration > Managers/Assistants > Delete Managers/Assistants .

The Delete Managers/Assistants Configuration window displays.

In the File Name field, choose the CSV file that you created for this type of bulk transaction.

Choose the type of deletion:

• Delete associated assistants for one manager

• Delete associated managers for one assistant

In the Job Information area, enter the Job description.

Choose a delete method. Do one of the following: a) Click Run Immediately to delete the manager-assistant associations immediately.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

289

Delete Specific Manager-Assistant Associations From Cisco Unified Communications Manager

Step 6 b) Click Run Later to delete the manager-assistant associations at a later time.

Click Submit to create a job for deleting the required manager-assistant associations.

Use the Job Configuration window to schedule and

/ or activate this job.

Related Topics

Cisco Unified Communications Manager Assistant , on page 271

Manager Deletions From Cisco Unified Communications Manager, on page 291

, on page 629

Managers and Assistants

290

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Manager Deletions

This chapter provides information to delete managers with all their manager-assistant associations from the

Unified Communications Manager database and LDAP Directory. You can use either a query search or a custom file to locate existing records to delete.

•

•

Manager Deletions From Cisco Unified Communications

Manager

When you delete Unified CM Assistant managers with all their manager-assistant associations from the

Unified Communications Manager database and LDAP Directory, Cisco Unified Communications Manager maintains information on the manager as a user in the directory. For example, if a manager with the user ID, rmartinez, has two assistants with user IDs, dbell and jkent, you can disassociate rmartinez from both assistants by deleting rmartinez as a manager in the Cisco Unified Communications Manager database. The directory still shows rmartinez as a user.

You can use either a query search or a custom file to locate existing records to delete.

Delete Manager Associations Using Query

You can delete managers from their associations with assistants from Cisco Unified Communications Manager directory, use this procedure.

Procedure

Step 1

Step 2

Choose BATAdministration > Managers/Assistants > Delete Managers > Query .

From the first Find Managers where drop-down list box, choose one of the following criteria:

• User ID

• First Name

• Middle Name

• Last Name

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

291

Managers and Assistants

Delete Manager Associations Using Query

Step 3

Step 4

Step 5

Step 6

• Department

From the second Find Managers where drop-down list box, choose one of the following criteria:

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty

Specify the appropriate search text, if applicable, then click Find .

Tip To find all managers that are registered in the database, click Find without entering any search text.

a) To choose managers from more than one department, enter multiple departments in this field. For example, to choose managers from departments 12 and 24, enter 12, 24 in the third box instead of performing two operations.

b) To further define your query and to add multiple filters, check the Search Within Results check box, choose AND or OR from the drop-down box, and repeat

Step 2, on page 291

and

Step 3, on page 292 .

A list of discovered managers displays by

• User ID

• First Name

• Middle Name

• Last Name

• Department

In the Job Information area, enter the Job description.

Choose a delete method. Do one of the following: a) Click Run Immediately to delete managers immediately.

b) Click Run Later to delete managers at a later time.

Click Submit to create a job for deleting the chosen managers.

Use the Job Configuration window to schedule and

/ or activate this job.

Related Topics

Topics Related to Manager Deletions

, on page 629

, on page 294

292

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Managers and Assistants

Delete Manager Associations Using Custom File

You can delete managers associations from the Cisco Unified Communications Manager database using a custom file that you create using a text-editor. Use the custom file to locate manager associations that you want to delete.

Attention Do not use the insert or export transaction files that are created with bat.xlt for the delete transaction. Instead, you must create a custom file with details of the manager association records that need to be deleted. Use only this file for the delete transaction.

Before you begin

Create a custom text-based CSV data file that lists user IDs for managers that you want to delete. Make sure you put each user ID on a separate line.

Note The custom delete CSV data file does not need a header and you can enter values for manager association

IDs.

Upload the custom file to the first node of Cisco Unified Communications Manager server.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

Choose BATAdministration > Managers/Assistants > Delete Managers > Custom File .

In Select managers where field, keep the identifier, User ID.

In the second field, in Custom File drop-down list box, choose the name of the custom file that you created for this transaction.

Click Find .

The list of discovered managers displays.

In the Job Information area, enter the Job description.

Choose a delete method. Do one of the following: a) Click Run Immediately to delete managers immediately.

b) Click Run Later to delete manages at a later time.

Click Submit to create a job for deleting chosen managers.

Use the Job Configuration window to schedule and

/ or activate this job.

Related Topics

, on page 639

Delete Specific Manager-Assistant Associations From Cisco Unified Communications Manager, on page

, on page 17

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

293

Managers and Assistants

Topics Related to Manager Deletions

Topics Related to Manager Deletions

•

289

•

Assistant Deletions From Cisco Unified Communications Manager, on page 295

•

•

•

Assistant Deletions From Cisco Unified Communications Manager, on page 295

294

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Assistant Deletions

This chapter provides information to delete assistants from the Unified Communications Manager database and LDAP Directory. You can use either a query search or a custom file to locate existing records to delete.

•

Assistant Deletions From Cisco Unified Communications

Manager

When you delete Unified CM Assistant assistants from the Cisco Unified Communications Manager database and LDAP Directory, Cisco Unified Communications Manager maintains information on the assistant as a user in the directory. For example, Assistant thudson is assigned to two managers, hart and dstewart. You can disassociate thudson from both managers by deleting thudson as an assistant in the Cisco Unified

Communications Manager database. The directory still shows thudson as a user.

You can use either a query search or a custom file to locate existing records to delete.

Delete Assistants Associations Using Query

You can delete assistants from their associations with managers from the Cisco Unified Communications

Manager directory.

Procedure

Step 1

Step 2

Choose BATAdministration > Managers/Assistants > Delete Assistants > Query .

From the first Find Assistants where drop-down list, choose one of the following criteria:

• User ID

• First Name

• Middle Name

• Last Name

• Department

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

295

Managers and Assistants

Delete Assistant Associations Using Custom File

Step 3

Step 4

Step 5

Step 6

From the second Find Assistants where drop-down list box, choose one of the following criteria:

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty

Specify the appropriate search text, if applicable, then click Find .

Tip To find all assistants that are registered in the database, click Find without entering any search text.

a) To choose assistants from more than one department, enter multiple departments in this field. For example, to choose managers from departments 12 and 24, enter 12, 24 in the third box instead of performing two operations.

b) To further define your query and to add multiple filters, check the Search Within Results check box, choose AND or OR from the drop-down list, and repeat

Step 2, on page 295

and

Step 3, on page 296

A list of discovered assistants displays by:

• User ID

• First Name

• Middle Name

• Last Name

• Department

In the Job Information area, enter the Job description.

Choose a delete method. Do one of the following: a) Click Run Immediately to delete assistants immediately.

b) Click Run Later to delete assistants at a later time.

Click Submit to create a job for deleting the chosen assistants.

Use the Job Configuration window to schedule and

/ or activate this job.

Related Topics

, on page 629

Delete Assistant Associations Using Custom File

You can delete assistants associations from the Cisco Unified Communications Manager database using a custom file that you create using a text-editor. Use the custom file to locate assistant associations that you want to delete.

296

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Managers and Assistants

Delete Assistant Associations Using Custom File

Attention Do not use the insert or export transaction files that are created with bat.xlt for the delete transaction. Instead, you must create a custom file with details of the assistant association records that need to be deleted. Use only this file for the delete transaction.

Before you begin

Create a custom text-based CSV data file that lists user IDs for assistants that you want to delete. Make sure you put each user ID on a separate line.

Note The custom delete CSV data file does not need a header and you can enter values for assistants association

IDs.

Upload the custom file to the first node of Cisco Unified Communications Manager server.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

Choose BATAdministration > Managers/Assistants > Delete Assistants > Custom File .

In Select Assistants where field, keep the identifier, User ID.

In the second field, in Custom File drop-down list, choose the name of the custom file that you created for this transaction.

Click Find .

In the Job Information area, enter the Job description.

Choose a delete method. Do one of the following: a) Click Run Immediately to delete assistants immediately.

b) Click Run Later to delete assistants at a later time.

Click Submit to create a job for deleting chosen assistants.

Use the Job Configuration window to schedule and

/ or activate this job.

Related Topics

, on page 639

Generate Reports for Cisco Unified Communications Manager Assistant Managers and Assistants, on page 299

, on page 17

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

297

Delete Assistant Associations Using Custom File

Managers and Assistants

298

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Manager and Assistant Report Generation

This chapter provides information about generating reports for CiscoUnifiedCM Assistant managers and assistants. The reports follow a fixed format. You can generate a report by specifying a set of query options for either managers or assistants.

•

•

Report Log Files, on page 301

•

Generate Reports for Cisco Unified Communications Manager

Assistant Managers and Assistants

You can generate reports for managers or assistants.

Procedure

Step 1

Step 2

Choose one of these options: a) To generate a manager report, choose Bulk Administration > Managers/Assistants > Generate Manager

Reports .

b) To generate an assistant report, choose Bulk Administration > Managers/Assistants > Generate

Assistant Reports .

You can generate a report for all managers or assistants by not specifying a query, or you can generate a report for specific managers or assistants by using following steps: a) In Find Managers (or Assistants) where drop-down list, choose from these query options:

• User ID

• First Name

• Middle Name

• Last Name

• Department

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

299

Managers and Assistants

Generate Reports for Cisco Unified Communications Manager Assistant Managers and Assistants

Step 3

Step 4

Step 5

Step 6

Step 7

Step 8 b) In the second drop-down list, choose from the following options:

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty c) In the search field box, enter the value that you want to locate, such as the exact user ID or the last name of a user, and click Find .

You can add multiple values to the search field box by separating them with a comma as shown in this example: JohnJ, PaulP, SueS, JoeJ

Note To further define your query, you can choose AND or OR to add multiple filters and repeat steps

2.a, on page 299

through

2.c, on page 300 .

To choose details for your type of report, click Next .

Tip If you want to change the type of query, click Back .

In the File Name field, enter your name for this report (required).

In the File Format field, select a file format from the drop-down list box.

In the Job Information area, enter the Job description.

Choose a method to generate reports. Do one of the following: a) Click Run Immediately to generate reports immediately.

b) Click Run Later to generate reports at a later time.

To create a job for generating reports, click Submit .

Use the Job Scheduler option in the Bulk Administration main menu to schedule and

/ or activate this job.

Bulk Administration (BAT) saves the report file on the first node of the server.

What to do next

You can search and download the report file using the Upload

Download Files option in the Bulk

Administration menu.

Related Topics

, on page 629

, on page 15

300

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

Managers and Assistants

Report Log Files

Report Log Files

BAT generates log files for each report transaction and stores them on the first node of Cisco Unified

Communications Manager server. You can find a link to log files from the Job Configuration window for any job that generated a report. Click the link in the Log File Name column that corresponds to the job with the log file you want to view.

Related Topics

, on page 639

Generate Reports for Cisco Unified Communications Manager Assistant Managers and Assistants, on page 299

Topics Related to Manager Assistant Report Generation

•

•

•

Manage User Device Profiles, on page 305

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

301

Topics Related to Manager Assistant Report Generation

Managers and Assistants

302

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

P A R T

VII

User Device Profiles

•

•

User Device Profile Templates, on page 321

•

User Device Profile File Format, on page 329

•

User Device Profile File Format Addition, on page 333

•

User Device Profile Validation, on page 335

•

UDP Generation, on page 337

•

User Device Profile Updates, on page 341

•

User Device Profile Deletions, on page 349

•

User Device Profile Exports, on page 353

•

Line Attribute Updates for Devices and User Device Profiles, on page 357

•

UDP Line Additions, on page 361

•

UDP Report Generation, on page 369

•

Intercom DN Additions and Updates for UDPs, on page 373

C H A P T E R

Manage User Device Profiles

This chapter provides information about managing user device profiles. The User Device Profiles (UDP) option in Cisco Unified Communications Manager Bulk Administration (BAT) allows you to add or delete large numbers of user device profiles. In addition, you can add or update lines for user device profiles. The system uses UDPs in conjunction with the extension mobility feature.

•

Add User Device Profiles, on page 305

•

Add User Device Profiles

When you use BAT to add user device profiles to the Cisco Unified Communications Manager database, you can add multiple lines and other features.

Choose from two options for creating a CSV data file for user device profiles:

• 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).

Procedure

Step 1

Step 2

Choose Bulk Administration > User Device Profiles > User Device Profile Template .

The Find and List UDP Templates window displays.

Create the CSV data file by following the steps for one of these options.

a) BAT Spreadsheet option

Open the BAT spreadsheet and create the CSV data file.

b) Text Editor option

Choose Create UDP File Format . The UDP File Format Query window displays.

Use a text editor and create the CSV data file for user device profiles that follows the file format that you want to use.

Choose Add File Format . The Add File Format Configuration window displays.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

305

User Device Profiles

Create User Device Profile CSV Data Files Using BAT Spreadsheet

Step 3

Step 4

Choose Validate User Device Profiles .

The User Device Profiles Validation window displays.

Choose Insert User Device Profiles .

The User Device Profiles Insert Configuration window displays.

Related Topics

Add User Device Profile File Format

, on page 333

Create Bulk Administration Tool (BAT) Template for User Device Profiles , on page 322

Create Text-Based CSV File for User Device Profile

, on page 668

Create User Device Profile CSV Data Files Using BAT Spreadsheet , on page 306

Insert User Device Profiles for User Devices

, on page 337

User Device Profile File Format Setup

, on page 329

Validate User Device Profiles

, on page 335

Create User Device Profile CSV Data Files Using BAT Spreadsheet

You can create the CSV data file for adding new user device profiles using the BAT spreadsheet. When you use the BAT spreadsheet to add new user device profiles, you can define the file format within the spreadsheet.

The spreadsheet uses the data file formats to display the fields for the CSV data file.

<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.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Download the BAT.xlt file from the Cisco Unified Communications Manager server.

Open the BAT spreadsheet. When prompted, click Enable Macros to use the spreadsheet capabilities.

To display the User Device Profiles options, click the User Device Profile tab at the bottom of the spreadsheet.

To choose the device and line fields that you can define for each user device profile, click Create File Format .

The Field Selection popup window displays.

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 Device Profile Name and Description ; therefore, these fields always remain selected.

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

Shift key. To select random field

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

306

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

User Device Profile Fields Descriptions in BAT Spreadsheet

Step 7

Step 8

Step 9

Step 10

Step 11

Tip You can change the order of the items 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 chose the down arrow to move the item to the end of the list.

To modify the CSV data file format, click Create . A message asks whether you want to overwrite the existing

CSV format. Click OK .

New columns for the selected fields display in the BAT spreadsheet in the order that you specified.

To locate the Number of Phone Lines box, scroll to the right.

The number of lines that you specify here must not exceed the number of lines that are configured in the BAT template or an error will result when you insert the CSV data file and UDP template.

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 Do not exceed the number of speed dials that are configured in the User Device Profile template, or an error will result when you insert the CSV data file and UDP template.

Enter data for an individual user device profile 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. See

Table 20:

Field Descriptions for User Device Profile in the BAT Spreadsheet, on page 307

for field descriptions.

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 using the default filename

<tabname>-<timestamp>.txt

to C:\XLSDataFiles\ or to your choice of another existing folder on your local workstation.

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

What to do next

Upload the CSV file to Cisco Unified Communications Manager server.

, on page 8

Download File Off Server , on page 16

Topics Related to User Device Profiles

, on page 320

Add User Device Profiles, on page 305

, on page 17

User Device Profile Fields Descriptions in BAT Spreadsheet

The following table describes all the user device profile fields in the BAT spreadsheet.

Table 20: Field Descriptions for User Device Profile in the BAT Spreadsheet

Field

Device Fields (Mandatory Fields)

Description

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

307

User Device Profile Fields Descriptions in BAT Spreadsheet

Field

Device Profile Name

Description

Device Fields (Optional Fields)

User Locale

Softkey Template

User ID

User Hold Audio Source

Phone Template

MLPP Indication

MLPP Preemption

User Device Profiles

Description

Enter a unique identifier for the device profile name.

Enter a description such as “Conference Room A” or

“John Smith” to help identify the phone or device.

The description can include up to 50 characters in any language, but it cannot include double-quotes (

), percentage sign (

), ampersand (&), back-slash (

), or angle brackets (<>).

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 Unified

Communications Manager user windows and phones.

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

Enter the user ID for the phone user.

Enter the login user ID for a default profile.

If the user device profile is used as a logout profile, specify the login user ID that will be associated with the phone. After the user logs out from this user device profile, the phone will automatically log in to this login user ID.

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.

Enter the phone template name that you want to associate with this user device profile.

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

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.

308

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

User Device Profile Fields Descriptions in BAT Spreadsheet

Field

Always Use Prime Line

Always Use Prime Line for Voice Message

MLPP Domain

Feature Control Policy

Extension Mobility Cross Cluster CSS

Line Fields (Optional Fields)

Description

Enter one of the following options:

• Off—When the phone is idle and receives a call on any line, the phone user answers the call from the line on which the call is received.

• On—When the phone is idle (offhook) and receives a call on any line, the primary line gets chosen for the call. Calls on other lines continue to ring, and the phone user must select those other lines to answer these calls.

• Default—Cisco Unified Communications

Manager uses the configuration from the Always

Use Prime Line service parameter, which supports the Cisco CallManager service.

Enter one of the following options:

• On—If the phone is idle, the primary line on the phone becomes the active line for retrieving voice messages when the phone user presses the

Messages button on the phone.

• Off—If the phone is idle, pressing the Messages button on the phone automatically dials the voice-messaging system from the line that has a voice message. Cisco Unified Communications

Manager always selects the first line that has a voice message. If no line has a voice message, the primary line gets used when the phone user presses the Messages button.

• Default—Cisco Unified Communications

Manager uses the configuration from the Always

Use Prime Line for Voice Message service parameter, which supports the Cisco

CallManager service.

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

Choose the Feature Control Policy for this group of phones.

A feature control policy specifies the appearance of features and the associated softkeys that are displayed on the phone.

The Extension Mobility Cross Cluster CSS setting gets used as the device CSS of the remote phone when the user selects this device profile during EMCC login.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

309

User Device Profile Fields Descriptions in BAT Spreadsheet

Field

Directory Number

Route Partition

Display

Forward All CSS

Forward All Destination

Forward Busy External CSS

Forward Busy Internal CSS

Forward Busy Destination External

User Device Profiles

Description

Enter the directory number for the phone.

Choose a route partition to which the directory number belongs.

The directory number can appear in more than one partition.

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).

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

The default language specifies English.

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

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

Enter the directory number or directory URI to which all calls are forwarded.

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

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

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

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

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

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

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

310

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

User Device Profile Fields Descriptions in BAT Spreadsheet

Field

Forward Busy Destination Internal

Description

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

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

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

Forward No Answer Internal CSS

Forward No Answer External Destination

Forward No Answer Internal Destination

Forward No Coverage External CSS

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.

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

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

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

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

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

Enter 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.

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

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

311

User Device Profiles

User Device Profile Fields Descriptions in BAT Spreadsheet

Field

Forward No Coverage Internal CSS

Forward No Coverage External Destination

Forward No Coverage Internal Destination

Calling Search Space Forward on Failure

External/Internal

Forward on Failure Destination External/Internal

Call Forward No Answer Ring Duration

Description

Enter 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.

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

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

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

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

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

(CTI ports only) Enter 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.

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

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

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.

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

312

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

User Device Profile Fields Descriptions in BAT Spreadsheet

Field

Route Filter

Party Entrance Tone

Log Missed Calls

Park Monitoring Forward No Retrieve Destination

External

Description

Enter a name in the Route Filter Name field. The name can contain up to 50 alphanumeric characters and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (

). Ensure each route filter name is unique to the route plan.

Use concise and descriptive names for your route filters. The CompanynameLocationCalltype format usually provides a sufficient level of detail and is short enough to enable you to quickly and easily identify a route filter. For example, CiscoDallasMetro identifies a route filter for toll free, inter-local access and transport area (LATA) calls from the Cisco office in

Dallas.

Enter one of the following options:

• Default—Use the value that you configured in the Party Entrance Tone service parameter.

Unified Communications Manager does not play the tone even if you choose On.

• Off—A tone does not play on the phone when a basic call changes to a multi-party call.

This field allows you to turn this feature on or off.

Enter ‘T’ to enable Cisco Unified Communications

Manager to log missed calls in the call history for that directory number on the phone. Enter ‘F’ to disable this feature.

When the parkee is an external party, then the call will be forwarded to the specified destination in the parker’s Park Monitoring Forward No Retrieve

Destination External parameter. If the Forward No

Retrieve Destination External field value is empty, the parkee will be redirected to the parker’s line.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

313

User Device Profiles

User Device Profile Fields Descriptions in BAT Spreadsheet

Field

Park Monitoring Forward No Retrieve Destination

Internal

Description

When the parkee is an internal party, then the call will be forwarded to the specified destination in the parker’s Park Monitoring Forward No Retrieve

Destination Internal parameter. If the Forward No

Retrieve Destination Internal is empty, the parkee will be redirected to the parker’s line.

Park Monitoring Forward No Retrieve Internal Voice

Mail

This setting uses the settings in the Voice Mail Profile

Configuration window.

When this check box is checked, Cisco Unified

Communications Manager ignores the settings in the

Destination box and Calling Search Space.

Park Monitoring Forward No Retrieve External Voice

Mail

This setting uses the settings in the Voice Mail Profile

Configuration window.

When this check box is checked, Cisco Unified

Communications Manager ignores the settings in the

Destination box and Calling Search Space.

Park Monitoring Forward No Retrieve External CSS Choose the calling search space to apply to the directory number.

Park Monitoring Forward No Retrieve Internal CSS Choose the calling search space to apply to the directory number.

Park Monitoring Reversion Timer This parameter determines the number of seconds that

Cisco Unified Communications Manager waits before prompting the user to retrieve a call that the user parked. This timer starts when the user presses the

Park softkey on the phone, and a reminder is issued when the timer expires.

Default: 60 seconds

If you configure a non-zero value, this value overrides the value of this parameter set in the Service

Parameters window. However, if you configure a value of 0 here, then the value in the Service

Parameters window will be used.

E164 Always use a unique E.164 number. Do not use null value.

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 configured for this phone.

314

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

Field

Line Calling Search Space

AAR Group

Line User Hold Audio Source

Line Network Hold Audio Source

Auto Answer

No Answer Ring Duration (CFNA)

Call Pickup Group

User Device Profile Fields Descriptions in BAT Spreadsheet

Description

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

Note Changes cause an update of the call pickup names that are listed in the Call Pickup

Group field. The setting applies to all devices that are using this directory number.

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.

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

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.

Enter one of the following values 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.

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

Destination.

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

To use the BAT phone template entry, leave this field blank.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

315

User Device Profile Fields Descriptions in BAT Spreadsheet

Field

Target Destination (MLPP)

Target CSS (MLPP)

No Answer Ring Duration (MLPP)

Line Text Label

External Phone Number Mask

Maximum Number of Calls

User Device Profiles

Description

Values can include numeric characters, pound (

) ,and asterisk (

From the drop-down list box, choose the calling search space to associate with the alternate party target

(destination) number.

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 Unified Communications Manager enterprise parameter, Precedence Alternate Party

Timeout.

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

The default text specifies English

Enter the phone number (or mask) that is sent for

Caller ID information when a call is placed from this line.

9728131234.

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.

316

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

Field

Busy Trigger

Message Waiting Lamp Policy

Ring Setting (Phone Idle)

User Device Profile Fields Descriptions in BAT Spreadsheet

Description

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.

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

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

Note The “Disable ” or “Flash only” setting options apply only for the handset. The led light on the phone button line will still flash.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

317

User Device Profiles

User Device Profile Fields Descriptions in BAT Spreadsheet

Field

Ring Setting (Phone Active)

URI (1-5) on Directory Number

URI (1-5) on Route Partition

URI (1-5) Is Primary on Directory Number

Description

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

Note The “Disable ” or “Flash only” setting options apply only for the handset. The led light on the phone button line will still flash.

Note Within Cisco Unified CM Administration, you can enter directory URIs with embedded double quotes or commas.

However, when you use Bulk

directory URI must be input as

"Jared,""Jerry"",[email protected]" in the csv file.

Enter the partition on which the directory URI belongs. If you do not want to restrict access to the directory URI, leave the field blank

Enter a ' t ' (True) to indicate that this directory URI is the primary directory URI for this extension.

Otherwise, enter an ' f' (False) to indicate that this is not the primary directory URI for this extension.

Note You can associate up to five directory URIs to a single directory number, but you must select a single primary directory URI.

318

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

Field

Enterprise Add to Local Route Partition

Enterprise Advertise via globally

Enterprise Is Urgent

Enterprise Number Mask

Enterprise Route Partition

+E.164 Add to Local Route Partition

+E.164 Advertise via globally

User Device Profile Fields Descriptions in BAT Spreadsheet

Description

Enter a 't' to add this enterprise alternate number to a local route partition. Enter 'f' to leave the E.164

number off of local routing.

Enter a 't' to enable ILS to advertise this alternate number to rest of the ILS network. Enter an 'f' if you don't want ILS to advertise this number.

Enter a 't' to classify routing for this alternate number as urgent.

By default, if the dial plan contains overlapping route patterns Cisco Unified Communications Manager does not route the call until the interdigit timer expires

(even if a possible route exists for the dialed digits).

This setting guards against learned numbers that overlap with statically configured directory numbers and number patterns by allowing Cisco Unified

Communications Manager to choose the best match of all available routes for the dial string.

When you mark the number as urgent priority, Cisco

Unified Communications Manager routes the call as soon as it finds a match between the dialed digits and an available route, without waiting for the interdigit timer to expire (for example, the T302 Timer service parameter).

Enter the number mask to apply to the directory number. Cisco Unified Communications Manager applies the mask to create an enterprise alternate number that is an alias of this directory number.

Enter the local route partition to which you want to assign this enterprise alternate number.

Enter a 't' to add this E.164 alternate number to a local route partition. Enter 'f' to leave the E.164 number off of local routing.

Enter a 't' to enable ILS to advertise this alternate number to rest of the ILS network. Enter an 'f' if you don't want ILS to advertise this number.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

319

User Device Profiles

Topics Related to User Device Profiles

Field

+E.164 Is Urgent

+E.164 Number Mask

+E.164 Route Partition

Description

Enter a 't' to classify routing for this alternate number as urgent.

By default, if the dial plan contains overlapping route patterns Cisco Unified Communications Manager does not route the call until the interdigit timer expires

(even if a possible route exists for the dialed digits).

This setting guards against learned numbers that overlap with statically configured directory numbers and number patterns by allowing Cisco Unified

Communications Manager to choose the best match of all available routes for the dial string.

When you mark the number as urgent priority, Cisco

Enter the number mask to apply to the directory number. Cisco Unified Communications Manager applies the mask to create an +E.164 alternate number that is an alias of this directory number.

Enter the local route partition to which you want to assign this +E.164 alternate number.

Topics Related to User Device Profiles

•

•

Insert User Device Profiles for User Devices, on page 337

•

User Device Profile Deletions, on page 349

•

Export User Device Profile Records, on page 355

•

Add Phone Lines to Existing Phones and UDPs, on page 171

•

Generate User Device Profile Reports, on page 369

320

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

User Device Profile Templates

This chapter provides information to create and modify user device profiles.

•

Find User Device Profile Template, on page 321

•

Create Bulk Administration Tool (BAT) Template for User Device Profiles, on page 322

•

User Device Profile Template Fields Descriptions in BAT Spreadsheet, on page 323

•

Modify User Device Profile BAT Template, on page 326

Find User Device Profile Template

You can locate a specific user device profile (UDP) template in the Cisco Unified Communications Manager database on the basis of specific criteria because you can have several UDP templates.

Note During your work in a browser session, your find/list search preferences are stored in the cookies on the client machine. If you navigate to other menu items and return to this menu item, or if you close the browser and then reopen a new browser window, your Cisco Unified Communications Manager search preferences are retained until you modify your search.

Procedure

Step 1

Step 2

Choose Bulk Administration > User Device Profiles > User Device Profile Template .

The Find and List UDP Templates window displays. Use the two drop-down list boxes to search for a template.

From the first Find UDP Templates where drop-down list box, choose one of the following criteria:

• Profile Name

• Profile Description

• Device Type

From the second Find UDP Templates where drop-down list box, choose one of the following criteria:

• begins with

• contains

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

321

User Device Profiles

Create Bulk Administration Tool (BAT) Template for User Device Profiles

Step 3

Step 4

• is exactly

• ends with

• is empty

• is not empty

Specify the appropriate search text, if applicable, and click Find .

Tip To find all UDP templates that are registered in the database, click Find without entering any search text.

A list of discovered templates displays by:

• Name

• Description

• Device Type

• Profile Type

From the list of records, click the template name that matches your search criteria.

The UDP Template Configuration window displays.

Create Bulk Administration Tool (BAT) Template for User Device

Profiles

You can create a template to add user device profiles in bulk.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

Choose Bulk Administration > User Device Profiles > User Device Profile Template .

Click Add New .

From the Device Type drop-down list, choose the model of user device profile. Click Next .

Enter data for an individual user device profile template 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. See

Table 21:

Field Descriptions for User Device Profile Template in the BAT Spreadsheet, on page 323

for field descriptions.

Note

Tip

Depending on the model of device, some of the fields may not display.

You can obtain help in finding a valid login user ID by choosing the Select Login User ID link below the Login User ID field. A separate dialog box pops up. In the Login User ID field, enter the first few characters of the login user ID that you want to use, and all login user IDs that match the pattern that you entered will display in the Selected login user ID field. Choose the desired ID and click OK .

Check the Ignore Presentation Indicators (Internal Calls Only) check box, as needed.

Check the Do Not Disturb check box if you need the DND feature to be enabled.

Choose the DND option from the DND Option drop down list.

322

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

User Device Profile Template Fields Descriptions in BAT Spreadsheet

Step 8

Step 9

Step 10

Step 11

Step 12

Choose the DND incoming call alert option from the DND Incoming Call Alert drop down list.

• None—Choose this option to have no alert for incoming calls.

• Disable—Choose this option if you want to disable incoming call alerts while in the DND mode.

• Flash Only—Choose this option to have the device flash while in DND mode.

• Beep Only—Choose this option to have the device beep while in the DND mode.

Choose the Extension Mobility Cross Cluster CSS from the Extension Mobility Cross Cluster CSS drop-down list.

Choose the Feature Control Policy from the Feature Control Policy drop-down list.

Note This field displays for RoundTable phones only.

Click Save .

Depending on the phone button template that you chose, links display to add lines, speed dials settings, subscribed Cisco IP Phone service settings, and busy lamp field speed dial settings.

For some Cisco Unified IP Phone models, you can add Cisco Unified IP Phone services and Speed Dials to the template.

Related Topics

Phone Template , on page 21

User Device Profile Template Fields Descriptions in BAT

Spreadsheet

The following table describes all the user device profile template fields in the BAT spreadsheet.

Note Depending on the model of device, some of the fields may not be available.

Table 21: Field Descriptions for User Device Profile Template in the BAT Spreadsheet

Field

User Device Profile Template Name

Description

Description

Enter a unique identifier for the device profile name up to 50 characters.

Enter a description for the UDP template. The description can include up to 50 characters in any language, but it cannot include double-quotes (

), percentage sign (

), ampersand (&), back-slash (

), or angle brackets (<>).

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

323

User Device Profile Template Fields Descriptions in BAT Spreadsheet

Field

User Hold Audio Source

User Locale

Phone Button Template

Softkey Template

Privacy

Single Button Barge

Join Across Lines

User Device Profiles

Description

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.

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 Unified

Communications Manager user windows and phones.

Choose a phone button template for this profile.

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

Choose the appropriate privacy option for the profile.

For each Device that wants Privacy, choose On in the

Privacy drop-down list box.

Choose the appropriate option for the single button barge feature.

• Off—This setting disables the Single Button

Barge/cBarge feature; however, the regular Barge or cBarge features will still work.

• Barge—This setting enables the Singe Button

Barge feature.

• cBarge—This setting enables the Single Button cBarge feature.

• Default—This setting uses the Single Button

Barge/cBarge setting that is in the service parameter.

Choose the appropriate option to join across lines.

• Off— This setting disables the Join Across Lines feature.

• On—This setting enables the Join Across Lines feature.

• Default—Uses the Join Across Lines setting that is in the service parameter.

324

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

User Device Profile Template Fields Descriptions in BAT Spreadsheet

Field

Always Use Prime Line

Always Use Prime Line for Voice Message

MLPP Indication

MLPP Preemption

MLPP Domain

Expansion Module Information

Description

Enter the Always Use Prime Line setting that you want to use from the following values:

• On

• Off

• Default

Enter the Always Use Prime Line for Voice Message setting that you want to use from the following values:

• On

• Off

• Default

To specify whether the device can play precedence tones when a MLPP precedence call is placed, choose one of the following values:

• Default—To inherit the MLPP indication from the device pool.

• Off—Does not send MLPP indication tones.

• On—Sends indication of an MLPP precedence call.

To specify whether the device can preempt calls in progress when placing an MLPP precedence call, choose one of the following:

• Default—To inherit the MLPP preemption setting from the device pool.

• Disable—Does not preempt calls when it places an MLPP precedence call.

• Foreceful—preempts calls in progress when it places an MLPP precedence call.

Note Do not configure a device with MLPP

Indication set to Off while MLPP

Preemption is set to Foreceful.

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

Choose the type of expansion module if installed in the phone or choose <None> for Module 1 and

Module 2.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

325

User Device Profiles

Modify User Device Profile BAT Template

Field

Description

Enter the login user ID for a default profile. After the user logs out from using the user device profile, the user device profile will automatically log in to this login user ID and use the default profile.

Note You can obtain help in finding a valid login user ID by choosing the Select Login User

ID link below the Login User ID field. A separate dialog box pops up. In the Login

User ID field, enter the first few characters of the login user ID that you want to use, and all login user IDs that match the pattern that you entered will display in the Selected login user ID field. Choose the desired ID and click OK.

Modify User Device Profile BAT Template

You can modify the properties of an existing BAT template when you want to change only a few fields for the same device.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Find the UDP template you want to modify.

From the list of displayed templates, click the template name you want to modify.

The chosen template details display in the UDP Template Configuration window.

Verify that this is the template that you want to modify.

Modify the details in the template fields as needed.

Click Save to save the changes to the existing template.

Copy User Device Profile Template

You can copy the properties of a template into a new 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 CiscoIPUser

Device Profile model 7960.

Use the following procedure to copy an existing BAT template.

326

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

Delete User Device Profile Template

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Find the UDP template you want to copy.

From the list of displayed templates, click the template name you want to copy.

The chosen template details display in the UDP Template Configuration window.

Note You can also copy the template by clicking the icon in the template you want to copy.

Copy column corresponding to the

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.

In the User Device Profile Template Name field, enter a new template name, up to 50 alphanumeric characters.

Update the fields as needed for the new template.

Click Save . The template that is added to BAT displays in the Templates column on the left.

Delete User Device Profile Template

You can delete BAT user device profile templates when you no longer require them.

Procedure

Step 1

Step 2

Step 3

Step 4

Find the UDP template you want to delete.

From the list of displayed templates, click the template name you want to delete.

The chosen template details display in the UDP Template Configuration window.

Note You can also delete the template by checking the check box next to the template name and clicking

Delete Selected .

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.

Click OK to delete the template.

The template name disappears from the list of templates in the Find and List UDP Templates window.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

327

Delete User Device Profile Template

User Device Profiles

328

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

User Device Profile File Format

This chapter provides information about configuring user device profile file formats for CSV data files that you create using a text editor.

•

User Device Profile File Format Setup, on page 329

User Device Profile File Format Setup

You can copy, modify, and delete user device profile file formats for CSV data files that you create using a text editor.

When you use a text editor to create your CSV data file, you must use a file format to identify the device and line fields within the CSV data file. You have these options for the file format:

• Default User Device Profile—Contains a predetermined set of user device profile device and line fields.

• Simple User Device Profile—Contains basic device and line fields for user device profiles.

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

Before creating the CSV file in the text editor, you need to choose an existing file format or create a new file format. You can then enter the values as specified in the file format in the text-based CSV data file.

Find UDP File Format

Use BAT to locate a user device profile file format.

Procedure

Step 1

Step 2

Choose Bulk Administration > User Device Profiles > UDP File Format > Create UDP File Format .

The Find and List UDP File Formats window displays.

From the Find UDP File Format where Format Name drop-down list box, choose one of the following criteria:

• begins with

• contains

• is exactly

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

329

User Device Profiles

Create UDP File Format

Step 3

Step 4

• ends with

• is empty

• is not empty

Specify the appropriate search text, if applicable, and click Find .

Tip To find all UDP templates that are registered in the database, click text.

Find without entering any search

A list of discovered templates displays by name of the file format.

From the list of records, click the file format name that matches your search criteria.

The UDP File Format Configuration window displays.

Create UDP File Format

You can create a UDP file format for the text-based CSV data file.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

Choose Bulk Administration > User Device Profiles > Create UDP File Format .

The Create UDP File Format Configuration window displays.

Click Add new .

The Create UDP File Format Configuration window displays.

In the UDP File Format Name field, enter a name for this customized format.

Under Device Fields , choose the device field names that you want to define for each user device profile.

Click a device field name in the Device Field box and click the arrow to move the field to the Selected Device

Fields Order box.

Note A CSV data file must include remain selected.

Device Profile Name , and Description ; therefore, these fields always

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

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

Order box.

Note Directory Number is a mandatory field if you select line fields in the file format.

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 use the down arrow to move it to the end of the list.

Click Intercom DN field names in the Intercom DN Field box and click the arrow to move the fields to the

Selected Intercom DN Fields Order box.

Enter the maximum number of lines, speed dials, IP Phone Services, and IP Phone Service Parameters, you want to include in the CSV file, in their corresponding text boxes.

330

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

Copy UDP File Format

Step 8

Note You can enter zero for maximum number of speed dials, IP Phone Services, and IP Phone Service

Parameters, if you do not want to include them in the CSV file. But, the maximum number of lines should not be zero if line fields are chosen in the file format.

To save your customized file format, click Save .

The name of the file format displays in the UDP File Format Query window.

Copy UDP File Format

You can copy an existing user device profile file format for the CSV data file.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Find the UDP File Format you want to copy.

In the Search Results area, click the file format name that you want to copy.

The File Format Configuration window displays.

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

Note You can also copy a file format by clicking the icon in the Copy column corresponding to the format you want to copy, in the UDP File Format Query window.

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

Modify the copied format by using one of these methods: a) Add new fields by choosing them from the Device Fields, Line Fields or Intercom DN Fields box, and then clicking the arrow to move the chosen fields into the Selected Device Fields Order, Selected Line

Fields Order, or Selected Intercom DN Order box.

b) Remove chosen fields by choosing them from the Selected Device Fields Order, Selected Line Fields

Order, or Selected Intercom DN Fields Order box, and then clicking the arrow to move the chosen fields into the Device Fields, Line Fields, or Intercom DN Fields box.

c) Change the order of the fields by choosing a field name in the Selected Device Field Order, Selected Line

Fields Order, or Selected Intercom DN Field Order box and using the up or down arrow to change its location.

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

Related Topics

Find UDP File Format

, on page 329

Modify UDP File Format

You can modify an existing user device profile file format for the CSV data file.

Procedure

Step 1 Find the UDP File Format you want to update.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

331

User Device Profiles

Delete UDP File Format

Step 2

Step 3

Step 4

In the Search result area, click the file format name that you want to modify. The File Format Configuration window displays.

Modify the copied format by using one of these methods: a) Add new fields by choosing them from the Device Fields, Line Fields, or Intercom DN Fields box, and then clicking the arrow to move the chosen fields into the Selected Device Field Order, Selected Line

Fields Order, or Selected Intercom Fields Order box.

b) Remove the chosen fields by choosing them from the Selected Device Fields Order, Selected Line Fields

Order, or Selected Intercom Fields Order box, and then clicking the arrow to move the chosen fields into the Device Field or Line Fields box.

c) 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.

After making your changes, click Save to save the changes to the file format.

Related Topics

Find UDP File Format , on page 329

Delete UDP File Format

You can delete an existing user device profile file format for the CSV data file.

Procedure

Step 1

Step 2

Step 3

Find the UDP File Format you want to delete.

In the Search result area, click the file format name that you want to delete.

The File Format Configuration window displays. Verify that you want to delete this file.

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 file format name is removed from the list.

Tip You can also delete a file format by checking the corresponding check box and clicking Delete .

You can delete all the file formats by clicking Select All and then clicking Delete Selected .

Related Topics

Find UDP File Format , on page 329

332

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

User Device Profile File Format Addition

This chapter provides information to associate the user device file format with the text-based CSV data file.

After you have entered all the values into the text-based CSV data file in the order that the file format specified, you need to upload the text-based CSV data file to the first node in Cisco Unified Communications Manager.

You must then associate the file format with the text-based CSV data file.

•

Add User Device Profile File Format, on page 333

•

Add User Device Profile File Format

Use BAT to associate the file format with the text-based CSV data file.

Procedure

Step 1

Step 2

Step 3

Step 4

Choose Bulk Administration > User Device Profile > UDP File Format > Add File Format .

The Add File Format Configuration window displays.

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

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

To add the matching file format with the CSV data file, click Submit .

A job is created in the Job Scheduler option in the Bulk Administration menu. Use Job Configuration window to modify the job schedule.

Related Topics

, on page 639

Add User Device Profile File Format, on page 333

Topics Related to UDP File Format Creation

•

•

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

333

Topics Related to UDP File Format Creation

•

•

Validate User Device Profiles, on page 335

User Device Profiles

334

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

User Device Profile Validation

This chapter provides information to validate that the records in the user device profile CSV data file has all required fields, such as device profile name and directory number, and to check for discrepancies with the records in the first node database.

•

•

Validate User Device Profiles

You can use BAT to run a validation script to validate your CSV data file user device profile records. When you choose Validate User Device Profiles, the system runs a validation routine to check that the CSV data file has all required fields, such as device profile name and directory number, populated and checks for discrepancies with the records in the first node database.

Before you begin

• You must have a user device profile template for the devices that you are adding. You can use a user device profile template with multiple lines to add user device profiles that have a single line.

• You must have a CSV data file that contains the unique details for the user device profiles.

Procedure

Step 1

Step 2

Step 3

Step 4

Choose Bulk Administration > User Device Profiles > Validate User Device Profiles .

The User Device Profiles Validation window displays.

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

• Validate UDP Specific Details—If you are validating User Device Profile records that use a file format.

• Validate UDP All Details—If you are validating user device profile records from an export file that was generated by using the All Details option.

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

For Validate UDP Specific Details option, in the UDP Template Name field, choose the Cisco Unified

Communications Manager Bulk Administration (BAT) User Device Profile template that you created for this type of bulk transaction.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

335

User Device Profiles

User Device Profile Validation Limitations

Step 5 To verify the chosen CSV data file with the database, click Submit .

A job is created in the Job Scheduler option in the Bulk Administration menu. Use Job Configuration window to modify the job schedule.

Related Topics

Create Bulk Administration Tool (BAT) Template for User Device Profiles , on page 322

Create User Device Profile CSV Data Files Using BAT Spreadsheet , on page 306

Validate User Device Profiles

, on page 629

, on page 335

User Device Profile Validation Limitations

The validation of phones has the following limitations:

• The validation process only checks for the number of lines that are configured on the template; it does not check the line numbers that are configured on the template. After running the Validate UDP - specific details job, the administrator sees the following message in the log when the CSV date file contains more lines than are supported by the phone template: “WARNING: CSV contains more number of lines than are supported by the phone template.” If blank Directory Numbers and/or blank Speed dials and/or blank

Busy Lamp Field Speed Dials exist, this indicates that the warning message that is displayed in the summary log file may be inaccurate.

• The validate process does not check whether mandatory fields are specified in the CSV file.

• If IP phone service parameters are specified in the phone text file, the validate process only checks whether a parameter exists with a name that is specified in the CSV on Cisco Unified Communications

Manager. It does not check whether the parameter that is specified is configured on the IP phone service.

Topics Related to User Device Profile Validation

•

Create Bulk Administration Tool (BAT) Template for User Device Profiles, on page 322

•

User Device Profile Validation Limitations, on page 336

•

Create User Device Profile CSV Data Files Using BAT Spreadsheet, on page 306

•

•

Insert User Device Profiles for User Devices, on page 337

336

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

UDP Generation

This chapter provides information to use Cisco Unified Communications Manager Bulk Administration (BAT) to set up extension mobility quickly by generating and inserting profiles for all IP phone users. BAT generates user device profiles for all phones, regardless of the number of devices that the user controls. For example, if a user controls two devices, BAT generates two separate user device profiles, one for each device and associates them to the same user. BAT sets one of the generated user device profiles as the default user device profile for the user. BAT generates user device profiles for all IP phones based on the phone button template for each phone model.

Note You do not use a user device profile template or a CSV data file to perform this action. When BAT generates these user device profiles, they are associated with the user.

•

•

Insert User Device Profiles for User Devices

You can generate user device profiles for all users.

When you are inserting a file that was generated with the export utility, 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. Use the appended suffixes to guide you in choosing a phone template with the correct line configuration during the

UDP profile insertion.

Unified Communications Manager Administration or the UnifiedCM Auto-Register phone Tool.

The dummy MAC address option automatically generates dummy MAC addresses in the following format:

XXXXXXXXXXXX where X represents any 12-character, hexadecimal (0-9 and A-F) number.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

337

User Device Profiles

Insert User Device Profiles for User Devices

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

Step 8

Step 9

Choose Bulk Administration > User Device Profiles > Insert User Device Profiles .

The User Device Profiles Insert Configuration window displays.

Choose an insert method. Do one of the following: a) Click Insert User Device Profiles Specific Details radio button to insert UDP records that use a customized file format. Continue with

Step 3, on page 338

and

Step 4, on page 338

b) Click Insert User Device Profiles All Details radio button to insert UDP records from an exported UDP file that was generated by using the All Details option.

In the File Name drop-down list box, choose the CSV data file that you created for this specific bulk transaction.

For the Specific Details option, in the User Device Profiles Template Name drop-down list box, choose the

BAT phone template that you created for this type of bulk transaction.

If you did not enter individual MAC addresses in the CSV data file, you must check the Create Dummy

MAC Address check box. Skip to

Step 9, on page 338

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.

Select the following options if applicable:

• 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.

• If you want BAT to generate and insert user device profile records for all phones based on the user's current IP Phone, choose Based on devices controlled by users radio button.

• If you want the device to use the generated user device profile as the logout profile, check the Set User

Device Profile as Log Out Profile for the device check box.

In the Job Information area, enter the Job description.

Choose an insert method. Do one of the following: a) Click Run Immediately to insert the UDP records immediately.

b) Click Run Later to insert the UDP records at a later time.

Click Submit to create a job for inserting the phone records.

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

Note If any information for a record fails, BAT does not insert that user device profile record.

Related Topics

TAPS Overview , on page 613

, on page 629

, on page 339

338

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

Topics Related to User Device Profile Generation

Topics Related to User Device Profile Generation

•

Insert User Device Profiles for User Devices, on page 337

•

TAPS Overview, on page 613

•

•

Update UDPs Using Query, on page 341

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

339

Topics Related to User Device Profile Generation

User Device Profiles

340

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

User Device Profile Updates

This chapter provides information to update the user device profile (UDP) settings, such as changing or adding the device pool, or calling search space for a group of similar user device profiles. You can locate the existing

UDP records that you want to update using either a query search or a custom file.

•

•

Update UDPs Using Custom File, on page 342

•

Choose Update Parameters, on page 343

Update UDPs Using Query

You can create a query to locate UDPs to update.

Procedure

Step 1

Step 2

Step 3

Choose Bulk Administration > User Device Profiles > Update UDP > Query .

The Find and List User Device Profiles To Update window displays.

Note You can update all user device profiles by not specifying a query and clicking Find. Skip to the

Choose Update Parameters, on page 343

From the first Find User Device Profiles where drop-down list, choose one of the following criteria:

• Profile Name

• Profile Description

• Profile Type

• Profile Protocol

From the second Find User Device Profiles where drop-down list, choose one of the following criteria:

• begins with

• contains

• is exactly

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

341

User Device Profiles

Update UDPs Using Custom File

Step 4

Step 5

Step 6

• ends with

• is empty

• is not empty

Specify the appropriate search text, if applicable.

Tip To find all user device profiles that are registered in the database, click search text.

Find without entering any

To further define your query and to add multiple filters, check the Search Within Results check box, choose

AND or OR from the drop-down list, and repeat

Step 2, on page 341

and

Step 3, on page 341

Click Find .

The details of all the records that match the criteria display in the Find and List User Device Profiles To

Update window. You can change the number of items that display on each page by choosing a different value from the Rows per Page drop-down list.

What to do next

To complete the procedure for updating UDPs, proceed to choose the update parameters.

Related Topics

Choose Update Parameters , on page 343

Update UDPs Using Custom File

You can update UDPs using a list of UDPs in a custom file. Use the custom file to search for UDPs in the database that you want to update.

Before you begin

Before you can update a UDP from , you must perform the following tasks:

• Identify the UDPs that you need to update.

• Create a text file that lists one of these options on a separate line:

• Profile Name

• Description

• Profile Type

• Profile Protocol

• Upload the text file to the server.

342

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

Choose Update Parameters

Procedure

Step 1

Step 2

Step 3

Step 4

Choose Bulk Administration > User Device Profiles > Update UDP > Custom File .

The Find and List UDP window displays.

From the Update Bulk UDP where drop-down list box, choose the type of custom file that you have created from the following criteria:

• Profile Name

• Description

• Device Type

• Device Protocol

From the list of custom files, choose the filename of the custom file for this update.

Click Find .

Note Do not use the insert or export transaction files that are created with bat.xlt for the update transaction.

Instead, create a custom file with details of the UDP records that need to be updated. Use only this file for the update transaction. In this custom update file, you do not need a header, and you can enter values for profile name, description, profile type, or profile protocol.

What to do next

To complete the procedure for updating UDPs, proceed to choose the update parameters.

Related Topics

Choose Update Parameters

, on page 343

Table 22: Field Descriptions for Updating UDPs in BAT, on page

, on page 17

Choose Update Parameters

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

Procedure

Step 1 Do one of the following: a) Click Next in the Find and List User Device Profiles To Update window if you used the Query option to locate UDPs to update.

b) Click Next in the Find and List UDP window if you used the Custom File option to locate UDPs to update.

The Update UDP window shows the type of query that you chose. If you want to change the type of query, click Back .

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

343

User Device Profiles

Update UDP Field Descriptions

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7

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.

Update the required UDP parameters. See

344

for field descriptions.

Select the update check box to the left of the field that you want to update. This action tells BAT to overwrite the existing value for the field.

Note The BAT updates only those fields for which you have selected the update check box.

In the Job Information area, enter the job description.

Choose an activation method. Do one of the following: a) Click Run Immediately to schedule and activate user device profiles immediately.

b) Click Run Later to schedule and activate user device profiles at a later time.

Click Submit to create a job for updating the records.

Note On the Update UDPs of multiple types and protocols. Make sure that you have the UDPs of same type and protocol for all the fields to appear.

window, certain fields may not display if the search results include devices

Related Topics

Delete UDP Using Query, on page 349

, on page 629

Update UDP Field Descriptions

The following table describes the fields that display when you are updating a UDP.

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 22: Field Descriptions for Updating UDPs in BAT

Field

Description

User Hold MOH Audio Source

Description

Enter a description that makes the device easy to recognize. The description can include up to 50 characters in any language, but it cannot include double-quotes ("), percentage sign (%), ampersand

(&), backslash (\), or angle brackets (<>).

Choose the audio source for this group of UDPs or ports.

The user hold audio source plays music when the user puts a call on hold.

344

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

Field

User Locale

Phone Button Template

Softkey Template

Privacy

SUBSCRIBE Calling Search Space

Presence Group

Update UDP Field Descriptions

Description

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

This choice determines which culture-dependent attributes exist for this user and which language displays for the user in the Cisco Unified

Communications Manager user windows and phones.

Choose an appropriate phone button template for this profile.

The phone button template determines the configuration of buttons on a phone and identifies which feature (line, speed dial, and so on) is used for each button.

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

Choose the appropriate privacy option for the profile from the drop-down list box:

• Off—Enables privacy for each device.

• On—Disables privacy for each device.

• Default—Applies the default privacy settings to the device.

Used with the Presence feature, the SUBSCRIBE

Calling Search Space determines how Cisco Unified

Communications Manager routes the subscription requests that come from the phone. From the drop-down list box, choose the calling search space that you want to use for this purpose.

From the drop-down list box, choose a presence group for this group of UDPs. The selected group specifies the devices, end users, and application users that can monitor this directory number.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

345

User Device Profiles

Update UDP Field Descriptions

Field

Single Button Barge

Join Across Lines

Always Use Prime Line

Always Use Prime Line for Voice Message

Feature Control Policy

Ignore Presentation Indicators (internal calls only)

Description

From the drop-down list box, enable or disable the

Single Button Barge/cBarge feature for this device or choose Default to use the service parameter setting.

• Off—This setting disables the Single Button

Barge/cBarge feature; however, the regular Barge or cBarge features will still work.

• Barge—This setting enables the Singe Button

Barge feature.

• cBarge—This setting enables the Single Button cBarge feature.

• Default—This setting uses the Single Button

Barge/cBarge setting that the service parameter specifies.

From the drop-down list box, enable or disable the

Join Across Lines feature for this device or choose

Default to use the service parameter setting.

• Off—This setting disables the Join Across Lines feature.

• On—This setting enables the Join Across Lines feature.

• Default—This setting uses the Join Across Lines setting that the service parameter specifies.

From the drop-down list box, choose the Always Use

Prime Line setting that you want to use from the following values:

• On

• Off

• Default

From the drop-down list box, choose the Always Use

Prime Line for Voice Message setting that you want to use from the following values:

• On

• Off

• Default

From the drop-down list box, choose the Feature

Control Policy for this group of UDPs.

A feature control policy specifies the appearance of features and the associated softkeys that display on the UDP.

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

346

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

Update UDP Field Descriptions

Field

Do Not Disturb

DND Option

DND Incoming Call Alert

Extension Mobility Cross Cluster CSS

Description

If you want to enable the DND feature, check this check box.

From the drop-down list box, choose a DND option from the following options:

• None

• Ringer Off

• Call Reject

• Use Common Phone Profile Setting

From the drop-down list box, choose one of the following options:

• None

• Disable

• Flash Only

• Beep Only

From the drop-down list box, choose the appropriate setting for this group of UDPs.

The Extension Mobility Cross Cluster CSS setting gets used as the device CSS of the remote phone when the user selects this device profile during EMCC login.

Multilevel Precedence and Preemption (MLPP) Information

MLPP Domain Enter a hexadecimal value for the MLPP domain that is associated with this device. Ensure that this value specifies blank or a value between 0 and FFFFFF.

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.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

347

User Device Profiles

Update UDP Field Descriptions

Field

MLPP Preemption

Logged Out (Default) Profile Information

Assign IP Phone Services

Add All Services From This Template

Remove Duplicate

Job Information

Job Description

Run Immediately

Run Later

Description

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.

From the drop-down list box, choose the user ID to be logged out before updating the UDP.

From the drop-down list box, choose the template that contains the list of services with which you want to update the UDPs.

You can click the Edit IP Phone Service link to update the subscribed Cisco Unified IP Phones services on the template.

Enter an appropriate job description.

Click this radio button to schedule and activate the update user device profiles job immediately.

Click this radio button to schedule and activate the update user device profiles job at a later time.

348

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

User Device Profile Deletions

This chapter provides information to delete a group of user device profiles (UDPs) from the Cisco Unified

Communications Manager database. You can locate existing phone records that you want to delete using either a query search or a custom file.

•

•

Delete UDP Using Custom File, on page 350

•

Delete UDP Using Query

To locate the UDP records that you want to delete from the Cisco Unified Communications Manager database, you can define a query filter.

Procedure

Step 1

Step 2

Step 3

Step 4

Choose Bulk Administration > User Device Profiles > Delete UDP > Query .

The Find and List Device Profiles To Delete window displays.

From the Find drop-down list box, choose one of the following options:

• User

• Autogenerated

• All

From the first Device Profiles where drop-down list box, choose one of the following criteria:

• Profile Name

• Description

• Device Type

From the second Device Profiles where drop-down list box, choose one of the following criteria:

• begins with

• contains

• is exactly

• ends with

• is empty

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

349

User Device Profiles

Delete UDP Using Custom File

Step 5

Step 6

Step 7

Step 8

Step 9

Step 10

• is not empty

Specify the appropriate search text, if applicable.

Tip To find all UDPs that are registered in the database, click Find without entering any search text.

To further define your query and to add multiple filters, check the Search Within Results check box, choose

AND or OR from the drop-down box, and repeat

Step 2, on page 349

and

Step 5, on page 350

Click Find .

A list of discovered templates displays by:

• Device Profile Name

• Description

• Device Type

• Profile Type

In the Job Information area, enter the Job description.

Choose a delete method. Do one of the following: a) Click Run Immediately to delete UDP records immediately.

b) Click Run Later to delete UDP records at a later time.

Click Submit to create a job for deleting the phone records.

Use the Job Scheduler option in the Bulk Administration main menu to schedule and/or activate this job.

Caution If you do not enter any information in the query text box, the system deletes all UDP records.

Because the delete action is final, you cannot retrieve deleted records.

Related Topics

, on page 629

Delete UDP Using Custom File

You can create a custom file of UDPs that you want to delete using a text editor. You can have device profile name, device profile description, and directory number 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 UDPs with shared lines by using a custom file.

Note Do not use the insert or export transaction files that are created with bat.xlt for the delete transaction. Instead, you must create a custom file with details of the UDP records that need to be deleted. Use only this file for the delete transaction.

350

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

Topics Related to UDP Deletions

Before you begin

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

• Profile names

• Profile description

Note The custom file does not need a header, and you can enter values for name, description, or directory number.

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

Upload the custom files to the server first node.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Choose Bulk Administration > User Device Profiles > Delete User Device Profiles > Custom File .

The Delete User Device Profiles Custom Configuration window displays.

Click Delete .

In the Device Profiles where drop-down list box, choose the type of custom file that you have created from one of the following criteria:

• Profile Name

• Profile Description

• Directory Number

In the list of custom files, choose the filename of the custom file for this delete, then click Find .

A list of UDPs matching your search criteria displays.

Click Submit to create a job to delete the UDPs.

Use the Job Scheduler option in the Bulk Administration main menu to schedule and/or activate this job.

Related Topics

, on page 639

Delete UDP Using Query, on page 349

, on page 17

Topics Related to UDP Deletions

•

•

Delete UDP Using Custom File, on page 350

•

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

351

Topics Related to UDP Deletions

•

TAPS Overview, on page 613

•

•

All User Device Profile Details Format, on page 353

User Device Profiles

352

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

User Device Profile Exports

This chapter provides information to export user device profile records. You can choose between two file format names when you are exporting user device profile records:

• All User Device Profile Details: To export all the line attributes, services and User IDs that are associated with the user device profile.

• Specific User Device Profile Details: To export a limited set of details that are associated with the user device profile

•

•

Specific User Device Profile Format, on page 354

•

Export User Device Profile Records, on page 355

All User Device Profile Details Format

For phones that have different line configurations, such as multiple partitions or calling search spaces, use the All User Device Profile Details format.

The following table lists the fields that are exported when you choose the All User Device Profile Details file format.

Table 23: Exported Fields in the All User Device Profile Details File Format

Field Types

Device Fields

Exported Fields

User Device Profile Name, Description, Device Pool,

Calling Search Space, AAR Calling Search Space,

Media Resource Group List, User Hold Audio Service,

Network Hold Audio Source, Login User ID, User

Locale, Network Locale, Phone Button Template,

Expansion Module Type I, Expansion Module Type

II, Softkey Template, Phone Load Name, Module 1

Load Name, Module 2 Load Name, MLPP Indication,

MLPP Preemption, MLPP Domain

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

353

User Device Profiles

Specific User Device Profile Format

Field Types

Model Specific Device Fields

Line Fields

User Fields

Speed Dials

Services

Exported Fields

Information, Directory, Messages, Services,

Authentication Server, Proxy Server, Idle, Idle Timer,

Enable Extension Mobility, Logout Profile, Login

User ID, Login Time, Logout Time

Directory Number, Partition, Voice Mail Profile, Line

CSS, AAR Group, Line User Hold Audio Source,

Line Network Hold Audio Source, Auto Answer,

Forward All to Voice Mail, Forward All Destination,

Forward All CSS, Forward Busy External to Voice

Mail, Forward Busy External Destination, Forward

Busy External CSS, Forward No Answer External to

Voice Mail, Forward No Answer External Destination,

Forward No Answer External CSS, Forward On

Failure to Voice Mail, Forward On Failure

Destination, Forward on Failure CSS, Call pickup group, Forward Busy Internal to Voice Mail, Forward

Busy Internal Destination, Forward Busy Internal

CSS, Forward No Answer Internal to Voice Mail,

Forward No Answer Internal Destination, Forward

No Answer Internal CSS, Forward No Call Coverage

External to Voice Mail, Forward No Call Coverage

External Destination, Forward No Call Coverage

External CSS, Forward No Call Coverage Internal to

Voice Mail, Forward No Call Coverage Internal

Destination, Forward No Call Coverage Internal CSS,

Display, External Phone Number Mask, Message

Waiting Lamp Policy, Ring Setting When Idle, Line

Text Label, Ring Setting When Active, No Answer

Ring Duration, MLPP Target Destination, MLPP

Calling Search Space, MLPP No Answer Ring

Duration, Max Num Calls, Busy Trigger, Call Info

Display Mask, Alerting Name

User ID

Speed Dial Number, Speed Dial Label

Service Name, Subscribed Service Name, Parameter

Name, Parameter Value

Specific User Device Profile Format

To export a limited set of details that are associated with the user device profile, use the Default User Device

Profile format. You can choose specific query options to customize the export file.

The following table lists the fields that can be exported when you choose the Default User Device Profile format.

354

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

Export User Device Profile Records

Table 24: Exported Fields in the Default User Device Profile File Format

Field Types

Device Fields

Line Fields

Exported Fields

MAC Address, Description, Login User ID

Directory Number,Display,Line Text Label,Forward

Busy External,Forward Busy Internal,Forward No

Answer External,Forward No Answer

Internal,Forward No Coverage External,Forward No

Coverage Internal,Call pickup group

Export User Device Profile Records

You can export user device profiles from Cisco Unified Communications Manager

Procedure

Step 1

Step 2

Step 3

Choose one of the following options: a) Choose Bulk Administration > User Device Profiles > Export User Device Profiles > Specific Details .

The Find and List User Device Profiles To Export window displays.

b) Choose Bulk Administration > User Device Profiles > Export User Device Profiles > All Details .

The Export User Device Profiles Configuration window displays.

For All Details option, choose the type of device or specific model from the Device Type drop-down list box.

Skip to

Step 4, on page 356

For Specific Details option, you can customize the export file and set any of the following detail options: a) Choose Device Type and Device Protocol from the drop-down list boxes.

b) In the first Find a User Device Profile drop-down list box, choose from the following options:

• Profile Name

• Profile Description c) In the second drop-down list box, choose from the following options:

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty d) In the search field box, enter the value that you want to locate, such as a specific profile name or profile description.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

355

User Device Profiles

Export User Device Profile Records

Step 4

Step 5

Step 6

Step 7 e) You can click the Search Within Results check box and choose AND or OR to add multiple filters and repeat

3.b, on page 355

through

3.d, on page 355

to further define your query.

f) Click Find . The search results display.

g) Click Next .

h) Choose file format from the File Format drop-down list box.

In the File Name field, enter the file name that you want to use.

In the Job Information area, enter the Job description.

Choose an export method. Do one of the following: a) Click Run Immediately to export user device profiles immediately.

b) Click Run Later to export user device profiles at a later time.

Click Submit to create a job for exporting user device profiles.

Use the Job Scheduler option in the Bulk Administration main menu to schedule and/or activate this job.

Related Topics

Device and UDP Line Updates, on page 357

, on page 629

356

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

Line Attribute Updates for Devices and User

Device Profiles

This chapter provides information to use a query to update lines for devices and User Device Profiles.

•

•

Update Device and UDP Lines Using Query, on page 357

•

Device and UDP Line Updates

You can use a query to update lines for devices and User Device Profiles. 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.

Tip When a phone is deleted from the Cisco Unified Communications Manager 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.

Update Device and UDP Lines Using Query

Use a query to update lines in devices and user device profiles.

Procedure

Step 1

Step 2

Choose Bulk Administration > User Device Profiles > Add/Update Lines > Update Lines .

The Update Lines Query window displays.

Note You can update all lines by not specifying a query. Skip to 2 .

From the first Find Line where drop-down list box, choose one of the following criteria:

• Directory Number

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

357

User Device Profiles

Update Device and UDP Lines Using Query

Step 3

Step 4

Step 5

Step 6

Step 7

• Route Pattern

• Line Description

• Calling Search Space (Phone)

• Calling Search Space (Line)

• Device Pool

• Device Description

• Line Position

• Unassigned DN

• Call Pickup Group

Note To locate and delete orphaned directory numbers, use “Unassigned DN.”

From the second Find Line where drop-down list box, choose one of the following criteria:

• begins with

• contains

• is exactly

• ends with

• is empty

• is not empty

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.

Tip To find all lines that are registered in the database, click Find without entering any search text.

To further define your query and to add multiple filters, check the Search Within Results check box, choose

AND or OR from the drop-down box, and repeat

Step 2

and

Step 3 .

To display the records that are going to be affected, click Find .

A list of discovered lines displays by

• Pattern/Directory Number

• Partition

• Description

Click Next .

The Update Lines window shows the type of query that you chose at the top.

Tip If you want to change the type of query, click Back .

358

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

Topics Related to User Device Profile Line Updates

Step 8

Step 9

Step 10

Step 11

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

BAT Template Phone Line Field Descriptions, on page 61

for field descriptions.

Note Values that display in some fields display from Cisco Unified Communications Manager. You must configure these values by using Cisco Unified Communications Manager Administration.

In the Job Information area, enter the Job description.

Choose an insert method. Do one of the following: a) Click Run Immediately to insert lines immediately.

b) Click Run Later to insert lines at a later time.

Click Submit to create a job for inserting the phone records.

Use the Job Configuration window to schedule and

/ or activate this job.

Note If any information for a line record fails, Cisco Unified Communications Manager Bulk

Administration (BAT) does not update that line record.

Related Topics

, on page 639

Update Device and UDP Lines Using Query, on page 357

, on page 359

Topics Related to User Device Profile Line Updates

•

•

BAT Template Phone Line Field Descriptions, on page 61

•

•

Add Lines to Existing UDPs, on page 361

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

359

Topics Related to User Device Profile Line Updates

User Device Profiles

360

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

C H A P T E R

UDP Line Additions

This chapter provides information to add lines to a group of existing user device profiles. When you use the

BAT template to add new lines, you cannot change phone services or speed dials. Cisco Unified

Communications Manager Bulk Administration (BAT) ignores those fields in the BAT template when you add lines to existing devices.

•

•

Add Lines to Existing UDPs Using BAT Spreadsheet, on page 362

•

UDP Line Field Descriptions in BAT Spreadsheet, on page 363

•

Add Lines to Existing UDPs

You can to add lines to a group of existing user device profiles using a CSV data file. Cisco Unified

Communications Manager Bulk Administration (BAT) ignores changes to phone services and speed dials when you add lines to existing devices.

Before you begin

• You must have a BAT template for this transaction.

• You must have a CSV data file for this transaction.

Procedure

Step 1

Step 2

Step 3

Step 4

Step 5

Step 6

Choose Bulk Administration > User Device Profiles > Add/Update Lines > Add Lines .

The UDP Add Lines Configuration window displays.

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

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

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

In the Job Information area, enter the Job description.

Choose an insert method. Do one of the following: a) Click Run Immediately to insert the phone records immediately.

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

361

User Device Profiles

Add Lines to Existing UDPs Using BAT Spreadsheet

Step 7 b) Click Run Later to insert the phone records at a later time.

Click Submit to create a job for inserting the phone records.

Use the Job Scheduler option in the Bulk Administration main menu to schedule and/or activate this job.

, on page 24

Create User Device Profile CSV Data Files Using BAT Spreadsheet , on page 306

Table 25: Field Descriptions for Adding Lines to UDPs

, on page 629

Add Lines to Existing UDPs Using BAT Spreadsheet

• You must have a BAT template for this transaction.

• You must have a CSV data file for this transaction.

Use the BAT spreadsheet to create the CSV data file for adding lines to existing UDPs. Cisco Unified

Communications Manager Bulk Administration (BAT) ignores changes to phone services and speed dial fields in the template when you add lines to existing devices.

After you have finished editing the fields in the BAT spreadsheet, you can export the content to a CSV formatted data file. A default filename is assigned to the exported CSV formatted data file:

<tabname>-<timestamp>.txt

where

<tabname> represents the type of input file that you created, such as UDPs, 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.

Procedure

Step 1

Step 2

Step 3

Step 4

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

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

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

Select the appropriate radio button from the following options:

• Phones

• UDP

362

Bulk Administration Guide for Cisco Unified Communications Manager, Release 14SU1

User Device Profiles

UDP Line Field Descriptions in BAT Spreadsheet

Step 5

Step 6

Enter data for an individual device profile 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. See

Using the BAT Spreadsheet, on page 363

for field descriptions.

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

Format .

Tip 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.

The system saves the file using the default name

<tabname>-<timestamp>.txt

to C:\XLSDataFiles\ or you can use Browse to save your file in another existing folder on your local workstation.

What to do next

Upload the CSV file to Cisco Unified Communications Manager Server first node.

, on page 24

BAT Spreadsheet Data Collection for CSV Data File Creation

, on page 639

, on page 8

Create User Device Profile CSV Data Files Using BAT Spreadsheet

, on page 306