Table Of Contents

A - B - C - D - E - F - G - H - I - L - M - N - O - P - Q - R - S - T - U - V -

Index

A

adding lines

field descriptions for BAT spreadsheet 3-84

field descriptions for template 3-25

to existing phones 3-81

to existing phones using BAT spreadsheet 3-83

to existing user device profiles 3-81

to phone template 3-4

associating file format for text-based CSV file 3-55, 6-25

authentication proxy rights

adding phones with users 4-27

enable when adding users 4-7

updating users 4-14

auto-registration, enabled for Unified CM Auto-Register Phone Tool 12-3

auto-registration options, configuring 12-12

B

BAT

application overview 1-1

browser requirements 1-16

configuration process overview 1-3

error messages 13-3

installation overview 2-1

installing 2-2

location of export log files 10-18

location of report log files 11-15

log files location 13-1

logging on 1-17

online help 1-18

specifications 1-15

starting 1-16

stopping transactions 1-19

troubleshooting 13-3

troubleshooting performance 13-8

uninstalling 2-4

upgrading 2-2

user interface, navigating 1-17

using the menus 1-17

version 1-19

BAT.xlt, see BAT spreadsheet

BAT export utility, see exporting

BAT Performance 1

BAT spreadsheet

adding lines to existing phones 3-83

BAT.xlt file location 2-3

Catalyst 6000 FXS ports 7-20

Cisco Unified CallManager Assistant custom manager assistant for proxy mode 5-17

Cisco Unified CallManager Assistant default manager assistant 5-15

field descriptions

adding lines 3-84

updating users 4-12

user device profile 6-10

installing BAT.xlt 2-3

IP telephony devices 3-40

manager assistant associations 5-14

overview 1-11

phones 3-40

phones with users 4-24

user device profile 6-8

users 4-2

using for CSV data file 1-11

VG200 gateway (FXS or FXO) 7-11

VG200 gateway for T1 CAS or T1/E1 PRI 7-13

BAT spreadsheet (BAT.xlt) file location 2-3

browser requirements 1-16

C

calling party number modification

adding phones with users 4-27

enable when adding users 4-8

updating users 4-15

call park retrieval

adding phones with users 4-27

enable when adding users 4-7

updating users 4-14

Call Pickup Groups

BAT considerations 9-1

BAT settings for inserting CSV file (table) 9-9

creating a CSV file (BAT.xlt) 9-2

creating custom CSV file (text-based) A-31

CSV file settings (table) 9-6

inserting CSV file in BAT 9-8

updating existing CSV file 9-4

using query to delete call pickup groups 9-5

Catalyst 6000 FXS ports

creating CSV data file 7-20

creating template 7-19

deleting ports 7-25

field descriptions for template 7-62

inserting to Cisco Unified CallManager 7-22

overview 7-18, 7-19

text-based CSV file, creating A-25

text-based CSV file format A-26

updating 7-23

Cisco Catalyst 6000 FXS Analog Interface Modules, see Catalyst 6000 FXS ports

Cisco CRS

configuring Unified CM Auto-Register Phone Tool 12-8

required for Unified CM Auto-Register Phone Tool 12-2

troubleshooting Unified CM Auto-Register Phone Tool 13-10

uninstalling Unified CM Auto-Register Phone Tool 12-10

Cisco Customer Response Solutions, see Cisco CRS

Cisco Unified CallManager

configuring Unified CM Auto-Register Phone Tool 12-7

enable auto-registration for Unified CM Auto-Register Phone Tool 12-3

inserting

Catalyst 6000 FXS ports 7-22

Cisco Unified CallManager Assistant manager-assistant associations 5-19

CTI ports 3-57

H.323 clients 3-57

phones 3-57

phones with users 4-25

user device profiles 6-27

users 4-6

VG200 gateway (FXS or FXO) 7-15

VG200 gateway (T1 CAS or T1/E1 PRI) 7-15

overview of inserting records 1-13

phones

shared line example 5-13

Cisco Unified CallManager Assistant

assistant template for proxy mode 5-4

creating CSV data file 5-14

deleting assistants

described 5-25

using custom file 5-27

using query 5-25

deleting manager-assistant associations 5-20

deleting managers

described 5-22

using custom file 5-24

using query 5-22

generating reports 11-13

inserting manager-assistant associations 5-19

manager and assistant line configurations, proxy mode 5-5

manager and assistant shared line configurations 5-13

manager template for proxy mode 5-4

overview 5-1

phones

assistant configuration options 5-7

manager configuration options 5-7

proxy line example 5-8

proxy lines on existing 5-10

proxy lines on new 5-9

proxy mode 5-2

shared line mode 5-11

setting up phones and lines 5-2

text-based CSV file, creating A-20

text-based CSV file custom format A-22

Cisco Unified CallManager Auto-Register Phone Tool

Cisco CRS required 12-2

Cisco Unified IP-IVR required 12-2

completing uninstallation 12-10

configuring auto-registration options 12-12

configuring in Cisco Unified CallManager 12-7

configuring on Cisco CRS server 12-8

enable auto-registration 12-3

installation overview 12-5

instructions for end-users 12-18

language prompts 12-5

adding 12-17

removing 12-18

log files location 13-8

overview 12-1

reloading configurations 12-4

requirements 12-2

securing directory numbers 12-4, 12-13

setting options for using 12-12

setting user locales 12-17

starting 12-11

stopping 12-11

troubleshooting 13-8

uninstalling 12-9

Cisco Unified IP-IVR

required for Unified CM Auto-Register Phone Tool 12-2

Cisco VG200 gateway, see VG200 gateway

Client Matter Codes

BAT considerations 8-3

BAT settings for inserting CSV file (table) 8-14

configuration checklist (table) 8-2

creating a CSV file (BAT.xlt) 8-4

creating custom CSV file (text-based) A-28

CSV file settings (table) 8-10

deleting code settings (BAT) 8-7

inserting CSV file in BAT 8-12

updating existing CSV file 8-6

configuring Cisco Unified CallManager records, process 1-3

copying

file format for text-based CSV 6-23

file format for text-based CSV file 3-53

phone template 3-8

template 6-6

Couldn 13-6

CSV, comma separated values text file 1-2, A-1

CSV, text-based

Catalyst 6000 FXS ports, creating A-25

Catalyst 6000 FXS ports format A-26

CMC

options 8-5

CPG

options 9-4

CTI ports format A-5

CTI ports-users format A-6

FAC

options 8-5

FXO or FXS ports format A-23

H.323 clients format A-5

H.323 client-users format A-6

IP phone, VGC phone, VGC Virtual Phone format A-4

manager assistant associations

creating A-20

custom format A-22

manager assistant default formats A-21

overview A-1

phones

creating A-2

export file, all details A-7

options 3-51

tips for creating A-3

with users format A-5

T1 CAS, T1/E1 PRI format A-24

user device profile format A-16

user device profile options 6-21

user device profiles

creating A-15

export file A-18

two lines format A-17

users

creating A-11

format A-12

updating A-13, A-30, A-31, A-33

VG200 gateways, creating A-22

CSV data file

adding new devices 1-7

overview 1-6

updating existing devices 1-7

using BAT spreadsheet (BAT.xlt) 1-11

CTI application use

adding phones with users 4-27

enable when adding users 4-7

phones 3-57

updating users 4-14

CTI ports

deleting 3-87

dummy MAC address, using 3-58, 4-26

enable CTI application use 3-57

text-based CSV format A-5

CTI ports-users

text-based CSV format A-6

custom file

deleting Cisco Unified CallManager Assistant managers 5-24, 5-27

deleting phones 3-89

deleting users 4-18

updating phones 3-61

using 1-8

using to reset password and PIN 4-21

D

deleting

call pickup groups 9-5

Catalyst 6000 FXS ports 7-25

Cisco Unified CallManager Assistant assistants 5-25

Cisco unified CallManager Assistant managers 5-22

file format for text-based CSV file 3-54, 6-25

manager-assistant associations 5-20

phones using custom files 3-89

phones using query 3-87

phone template 3-9

template 6-7

user device profiles 6-31

users 4-16

VG200 gateway 7-16

directory number

lifting restrictions 12-15

list of restricted 12-16

remove all restrictions from Unified CM Auto-Register Phone Tool 12-16

restricting from Unified CM Auto-Register Phone Tool 12-14

securing from Unified CM Auto-Register Phone Tool 12-13

template for gateway 7-3

downloading phone configuration using Unified CM Auto-Register Phone Tool 12-18

dummy MAC address 3-42, 3-58, 4-26

generate a list 11-6

E

E1 PRI

creating CSV file for VG200 gateway 7-13

field descriptions for VG200 gateway template 7-46

text-based CSV file format A-24

endpoint identifiers, updating 7-9

error messages, BAT 13-3

exported fields

all phone details 10-4

all user device profile details 10-14

default phone details 10-3

default user device profile details 10-16

exporting

fields

all phone details 10-4

all user device profile details 10-14

default phone details 10-3

default user device profile details 10-16

locating log files 10-18

locating phone records 10-9

moving records from one Cisco Unified CallManager to another 10-2

overview 10-1

phone records options 10-3

phones with more than one user 10-9

steps for exporting phone records 10-7

user device profile options 10-17

user device profile records format 10-13

user records format 10-10

user records options 10-11

using export files 1-8

F

field descriptions

adding or updating lines 3-25

BAT spreadsheet

adding lines 3-84

updating users 4-12

user device profile 6-10

Catalyst 6000 FXS ports template 7-62

gateway directory number template 7-27

ground start 7-38

loop start 7-38

phone template 3-9

updating lines 3-73

updating users with BAT spreadsheet 4-12

user device profile template 6-3

VG200 gateway - FXO template 7-38

VG200 gateway- FXS template 7-36

VG200 gateway - T1/E1 PRI template 7-46

VG200 gateway - T1 CAS template 7-40

field descriptions for template 7-36

file format for text-based CSV file

associating 3-55, 6-25

copying 3-53, 6-23

creating phone 3-51

creating user device profile 6-22

deleting 3-54, 6-25

modifying 3-53, 6-24

overview 1-8

Forced Authorization Codes

BAT considerations 8-3

BAT settings for inserting CSV file (table) 8-14

configuration checklist (table) 8-2

creating a CSV file (BAT.xlt) 8-4

creating custom CSV file (text-based) A-28

CSV file settings (table) 8-10

deleting code settings (BAT) 8-7

inserting CSV file in BAT 8-12

updating existing CSV file 8-6

FXO

creating CSV file for VG200 gateways 7-11

field descriptions for template 7-38

inserting VG200 gateway to Cisco Unified CallManager 7-15

text-based CSV file format for VG200 gateway A-23

FXS

Catalyst 6000 ports

creating CSV data file 7-20

deleting 7-25

field descriptions for template 7-62

inserting to Cisco Unified CallManager 7-22

text-based CSV format A-26

updating 7-23

creating template for Catalyst 6000 ports 7-19

gateway directory number template, creating 7-3

VG200 gateways 7-36

creating CSV file 7-11

inserting to Cisco Unified CallManager 7-15

text-based CSV file format A-23

G

gateway directory number template

creating 7-3

field descriptions 7-27

gateways

Cisco Catalyst 6000 FXS ports overview 7-18

Cisco VG200 overview 7-1

ground start, field description 7-38

H

H.323 clients

deleting 3-87

text-based CSV format A-5

H.323 client-users

text-based CSV format A-6

help, online 1-18

I

inserting records to Cisco Unified CallManager, overview 1-13

installing

BAT overview 2-2

BAT prerequisites 2-2

no backward template migration 2-2

no template migration when upgrading from release 3.0(3) 2-2

overview 2-1

template migration during upgrade 2-2

Unified CM Auto-Register Phone Tool overview 12-5

Unified CM Auto-Register Phone Tool prerequisites 12-6

instructions, Unified CM Auto-Register Tool for end-users 12-18

IP telephony devices

supported with BAT 3-1

text-based CSV file format A-4

IP telephony devices, see phones

L

language prompts for Unified CM Auto-Register Phone Tool 12-5, 12-17

lines

adding or updating on template 3-4

field descriptions in template for adding or updating 3-25

master phone template 1-5

maximum number 3-5

updating 3-71

updating to user device profiles 6-31

log files

export log files 10-18

file naming convention 11-15, 13-2

locations 13-2

report log files 11-15

viewing 13-2

logging on to BAT 1-17

loop start, field description 7-38

LSC 3-94

M

master phone template 1-5

modifying

file format for text-based CSV 6-24

file format for text-based CSV file 3-53

phone template 3-7

N

NM-1V 7-5

NM-2V 7-5

NM-HDV 7-5

O

overriding template values 1-6

overview

BAT application 1-1

BAT spreadsheet 1-11

Catalyst 6000 FXS ports 7-19

Cisco Unified CallManager Assistant 5-1

CSV data file 1-6

exporting records 10-1

file formats for text-based CSV files 1-8

inserting records to Cisco Unified CallManager 1-13

installing BAT 2-1

reports 11-1

templates 1-5

text-based CSV files A-1

troubleshooting BAT and Cisco Unified CallManager Auto-Register Phone Tool 13-1

Unified CM Auto-Register Phone tool 12-1

user device profiles 6-1

users 4-1

validating 1-13

VG200 gateways and ports 7-2

P

passwords

phones with users, adding 4-27

resetting 4-19

phones

adding

IP services 3-5

lines 3-4

lines to existing 3-81

new 3-2

speed dial settings 3-6

with users 4-22

Cisco Unified CallManager Assistant 5-7

Cisco Unified CallManager Assistant manager configuration 5-7

configuring CAPF 3-93

upgrading LSC

   1

creating text-based CSV file A-2

deleting 3-87

dummy MAC address, using 3-42, 3-58, 4-26

dummy MAC addresses list 11-6

enable CTI application use 3-57

export file with all details A-7

exporting records options 10-3

exporting records steps 10-7

generating reports 11-1

insert to Cisco Unified CallManager 3-57

locating export records 10-9

proxy mode for Cisco Unified CallManager Assistant 5-2

reloading configurations 12-4

report options 11-3

steps for adding 3-2

template

copying 3-8

creating new 3-4

deleting 3-9

field descriptions 3-9

for IP telephony devices 3-4

modifying 3-7

text-based CSV format A-4

updating 3-59

updating lines 3-71

updating with custom file 3-61

updating with query 3-60

using Unified CM Auto-Register Phone Tool to configure 12-3

validating records 3-56

phones with users

inserting to Cisco Unified CallManager 4-25

text-based CSV format A-5

using BAT spreadsheet 4-24

validating records 4-24

PINs

phones with users, adding 4-27

resetting 4-19

prerequisites

BAT 2-2

Unified CM Auto-Register Phone Tool 12-6

Q

query

customizing a filter 1-7

deleting call pickup groups 9-5

deleting Cisco Unified CallManager Assistant assistants 5-25

deleting Cisco Unified CallManager Assistant managers 5-22

deleting phones 3-87

deleting users 4-16

updating lines 6-31

updating lines, using 3-71

updating phones 3-60

using to reset password and PIN 4-19

R

reports

Cisco Unified CallManager Assistant 11-13

dummy MAC addresses 11-6

locating log files 11-15

overview 11-1

phone options 11-3

phones 11-1

user device profile 11-8

user device profile options 11-10

users 11-6

VG200 gateway 11-11

resetting password and PIN

for all users 4-15

using custom file 4-21

using query 4-19

resetting phones

after update 3-90

using custom file 3-92

using query 3-91

restarting phones

after update 3-90

using custom file 3-92

using query 3-91

retaining user records when updating 4-11

S

securing directory numbers from Unified CM Auto-Register Phone Tool 12-4, 12-13

services, adding or updating 3-5

specifications for BAT 1-15

speed dial settings, adding or updating 3-6

starting

BAT 1-16

Unified CM Auto-Register Phone Tool 12-11

stopping

BAT transactions 1-19

Unified CM Auto-Register Phone Tool 12-11

sub-unit 7-6

T

T1 CAS

creating CSV data file for VG200 gateway 7-13

field descriptions for VG200 template 7-40

text-based CSV file format A-24

T1 PRI

creating CSV file for VG200 gateway 7-13

field descriptions for VG200 gateway template 7-46

text-based CSV file format A-24

template

migration during upgrade 2-2

no backward migration 2-2

templates

adding or updating IP services 3-5

adding or updating lines 3-4

adding or updating speed dial settings 3-6

BAT template overview 1-5

copying 6-6

copying phone 3-8

deleting 6-7

deleting phone 3-9

field descriptions

adding or updating lines 3-25

Catalyst 6000 FXS ports 7-62

gateway directory number 7-27

phone 3-9

user device profiles 6-3

VG200 gateway - FXO template 7-38

VG200 gateway - FXS 7-36

VG200 gateway - T1 CAS gateway 7-40

master phone 1-5

modifying 6-6

modifying phone 3-7

overriding values 1-6

template type

Catalyst 6000 FXS ports 7-19

Cisco Unified CallManager Assistant assistant for proxy mode 5-4

Cisco Unified CallManager Assistant manager for proxy mode 5-4

gateway directory number 7-3

IP telephony devices 3-4

phones 3-4

user device profiles 6-3

VG200 gateway 7-4

troubleshooting

BAT 13-3

BAT performance 13-8

Cisco Unified CallManager Auto-Register Phone Tool 13-8

overview 13-1

Troubleshooting message

Couldn't create user object. Check if DC Directory is running. 13-6

troubleshooting message

BAT.xlt spreadsheet will not work with Excel XP (Office XP) 13-6

BAT spreadsheet gives a compilation error while exporting data 13-3

CSV data files do not match phone template/sample file 13-4

errors occur when using dummy MAC address option 13-4

export to BAT does not work in BAT.xlt file 13-3

MAC address values are not allowed in CSV file if dummy MAC address option selected 13-6

port identifier contains invalid endpoint prefix 13-5

port identifier contains invalid port number 13-5

port number not configured in template 13-5

selected template does not contain DN details for directory number 13-5

the page cannot be displayed 13-4

when Cisco CRS starts, JTAPI shows partial service or out of service 13-10

when dialing Unified CM Auto-Register Phone Tool number, caller hears busy 13-9

U

UDP, see user device profiles

uninstalling

BAT 2-4

removing Unified CM Auto-Register Phone Tool from Cisco CRS server 12-10

Unified CM Auto-Register Phone Tool 12-9

Update Statistics 1

updating

lines to user device profiles 6-31

phone configuration using Unified CM Auto-Register PhoneTool 12-18

updating lines

field descriptions 3-73

upgrading BAT 2-2

user device profiles

adding lines to existing 3-81

BAT spreadsheet

field descriptions 6-10

using 6-8

creating CSV data file 6-8

deleting 6-31

export file format 10-13

export file with all details A-18

exporting record options 10-17

inserting to Cisco Unified CallManager 6-27

overview 6-1

removing 6-31

report options 11-10

reports, generating 11-8

steps for adding 6-1

template

copying 6-6

creating 6-3

deleting 6-7

modifying 6-6

text-based CSV file, creating A-15

text-based CSV file format A-16

updating lines 6-31

validating records 6-26

users

adding overview 4-1

adding with phones 4-22

authentication proxy rights 4-7

calling party number modification 4-8

call park retrieval 4-7

creating CSV data file 4-2

CTI application use 4-7

deleting 4-16

using custom file 4-18

using query 4-16

exported records format 10-10

exporting records 10-11

field descriptions for updating with BAT spreadsheet 4-12

generating reports 11-6

inserting to Cisco Unified CallManager 4-6

resetting passwords and PINs 4-19

retaining stored values 4-11

text-based CSV file, creating A-11

text-based CSV file,updating A-13, A-30, A-31, A-33

text-based CSV format A-12

updating 4-10

updating users field descriptions 4-12

users with phones

inserting to Cisco Unified CallManager 4-25

using BAT spreadsheet 4-24

validating records 4-24

V

validating

options 1-13

overview 1-13

phone and user records 4-24

phone records 3-56

user device profile records 6-26

version, finding 1-19

VG200 gateway

adding gateways and ports 7-2

creating CSV data file for FXS or FXO 7-11

creating CSV data file for T1 CAS or T1/E1 PRI 7-13

creating template 7-4

creating text-based CSV file A-22

deleting gateway 7-16

field descriptions

FXO template 7-38

FXS template 7-36

T1/E1 PRI template 7-46

T1 CAS template 7-40

generating reports 11-11

inserting to Cisco Unified CallManager (FXS or FXO) 7-15

inserting to Cisco Unified CallManager (T1 CAS or T1/E1 PRI) 7-15

overview 7-1

updating endpoint identifiers 7-9

VIC-2FXO 7-6

VIC-2FXS 7-6

viewing log files 13-2

VWIC-1MFT-E1 7-6

VWIC-1MFT-T1 7-6

VWIC-2MFT-E1 7-6

VWIC-2MFT-T1 7-6