Create Text-Based CSV File for Phones
You can create a CSV text file for phones, IP telephony devices, and user combinations using a text editor, such as Notepad++.
Instead of using the BAT spreadsheet for data input when you are adding phones, you can create the comma-separated values (CSV) file using lines of ASCII text with values separated by commas. There are different CSV data file formats for different phone types. You must use the appropriate phone file format for the CSV text file.
![]() Note |
Cisco recommends uploading Text-Based CSV files saved in the UTF-8 format only, as characters other than ASCII characters can be stored in this format. Using a text editor, such as Notepad++, you can select encoding as UTF-8 without Byte Order Mark (BOM) from the Encoding drop-down. Text-Based CSV files saved in formats other than UTF-8 may render garbled when downloaded from Cisco Unified Communications Manager. |
Procedure
Step 1 |
Open a text editor or any application that allows you to export or create a text-based CSV file. |
Step 2 |
Use a separate line to enter the values for each phone, IP telephony device, or user combination that you want to add to Cisco Unified Communications Manager. You must create separate CSV files for each type of device. Keep in mind the following rules when you create the CSV data file.
|
What to do next
Upload the CSV file to the first node of Cisco Unified Communications Manager.
Phone CSV Data File Formats
Different types of phones require specific data formats. Keep in mind that fields that are labeled as optional in the phone file format become mandatory fields when certain conditions are met.
Phones with Users Combinations File Format
The following sample shows the field length and whether the field is optional or mandatory for a text-based CSV file for phones and the fixed user format.
First Name (Optional, up to 64 characters), Last Name (Mandatory, 1 to 64 characters), User ID (Mandatory, 1 to 128 characters), Password (Optional, up to 128 characters), Manager User ID (Optional, up to 128 characters, must use the ID that exists in global directory), Department (Optional, up to 64 characters), PIN (Optional, up to 20 numerals), Default Profile (Optional, up to 50 characters), User Locale (Optional, up to 50 characters), Telephone Number (Optional, up to 20 numerals), Primary Extension (Optional, up to 50 numerals), Associated PC (Optional, up to 50 characters), ICD Extension (Optional, up to 50 numerals), Mail ID (Optional, up to 255 characters), Presence Group (Optional, up to 50 characters), Subscribe Calling Search Space (Optional, up to 50 characters), MAC Address (Mandatory, up to 12 characters), Description (Optional, up to 50 characters), Location (Optional, up to 50 characters), Directory Number (Optional, up to 24 numerals and special characters), Display (Optional, up to 30 characters), Line Text Label (Optional, up to 30 characters), Forward Busy External (Optional, up to 50 numerals and special characters), Forward No Answer External (Optional, up to 50 numerals and special characters), Forward No Coverage External (Optional, up to 50 numerals and special characters), Forward Busy Internal (Optional, up to 50 numerals and special characters), Forward No Answer Internal (Optional, up to 50 numerals and special characters), Forward No Coverage Internal (Optional, up to 50 numerals and special characters), Call Pickup Group (Optional, up to 50 characters), Speed Dial (Optional, up to 50 numerals and special characters), Speed Dial Label (Optional, up to 30 characters)
Sample
John,Smith,johns,abcde,Daviss,12,12345,johnProfile,English United States,1,1231123245AB,Dallas,
9725557154,9725557154,Mike,9725557172,9725557196,9725557112,
9725557127,9725557158,9725557189,9725557121/TollByPass,1230000000,Helpdesk
CTI Ports/H.323 Clients File Format
The following sample shows the field length and whether the field is optional or mandatory for a text-based CSV file for CTI ports and H.323 clients format.
Device Name (Mandatory, up to 15 characters for CTI ports and up to 50 characters for H.323 Clients), Description (Optional, up to 50 characters) Location (Optional, up to 50 characters),User ID(Optional, 1 to 30 characters),Directory Number(Optional, up to 24 numerals and special characters),Display (Optional, up to 30 characters), Line Text Label (Optional, up to 30 characters), Forward Busy External(Optional, up to 50 numerals and special characters),Forward No Answer External (Optional, up to 50 numerals and special characters), Forward No Coverage External (Optional, up to 50 numerals and special characters), Forward Busy Internal (Optional, up to 50 numerals and special characters), Forward No Answer Internal (Optional, up to 50 numerals and special characters), Forward No Coverage Internal (Optional, up to 50 numerals and special characters), Call Pickup Group (Optional, up to 50/50 characters)
Sample
TAPS Port 1,CTI TAPS Port 1,Dallas,johns,9728437154,9728437154, Mike,9728437172,9728437196,9728437127,9728437154,9728437178, 9728437189,9728437121/TollByPass,1230000000,Helpdesk
CTI Ports-Users and H.323 Client-Users Combinations File Format
The following sample shows the field length and whether the field is optional or mandatory for a text-based CSV file for CTI ports with users and H.323 clients with users format.
First Name (Optional, up to 64 characters), Last Name (Mandatory, 1 to 64 characters), User ID (Mandatory, 1-128 characters), Password (Optional, up to 128 characters), Manager User ID (Optional, up to 128 characters, must use existing ID in global directory), Department (Optional, up to 64 characters), PIN (Optional, up to 128 numerals), Default Profile (Optional, up to 50 characters), User Locale (Optional, up to 50 characters), Telephone Number (Optional, up to 64 numerals), Primary Extension (Optional, up to 50 numerals), Associated PC (Optional, up to 50 characters), ICD Extension (Optional, up to 50 numerals), Mail ID (Optional, up to 255 characters), Presence Group (Optional, up to 50 characters), Subscribe Calling Search Space (Optional, up to 50 characters),Device Name (Mandatory, up to 15 characters for CTI ports-users combination and up to 50 characters for H.323client-users combinations),Description (Optional, up to 50 characters), Location (Optional, up to 50 characters), Directory Number (Optional, up to 24 numerals and special characters), Display (Optional, up to 30 characters), Line Text Label (Optional, up to 30 characters), Forward Busy External (Optional, up to 50 numerals and special characters), Forward No Answer External (Optional, up to 50 numerals and special characters), Forward No Coverage External (Optional, up to 50 numerals and special characters), Forward Busy Internal (Optional, up to 50 numerals and special characters), Forward No Answer Internal (Optional, up to 50 numerals and special characters), Forward No Coverage Internal (Optional, up to 50 numerals and special characters), Call Pickup Group (Optional, up to 50 characters)
Sample
John,Smith,johns,abcde,Daviss,12,12345,johnProfile,English United States,1,TAPS Port 1,CTI
TAPS Port 1,9725557154,9725557154,Mike,9725557172,9725557196,9725557112,9725557127,9725557158,
9725557189,9725557121/TollByPass,1230000000,Helpdesk
![]() Note |
If you use a comma or double quotes as part of the value in one of the fields, you must enclose the entire text value with double quotation marks to designate it as a single value. For example, if you entered John, Bill as a text value, then you must enter the value as "John,Bill". If you entered a double quote in a value, then you must replace the double quote with two consecutive double quotes and enclose the value with double quotes. For example you must enter John "Chief as “John""Chief". |
Export the Fields for All Phone Details Option
When you are using the export utility to generate a file that containing all the details for the phone records, the export file has the following format.
![]() Caution |
Cisco does not recommend editing the file that is generated with the export utility. The system dynamically generates fields, such as Logout time and Login time, that must not be edited at all. You must ensure that the login user ID and Product Specific XML fields are accurate for them to work properly, and you must not edit them. Use BAT to update the product specific configurations. |
Device Name,Description,Device Pool,Phone Template,CSS,AAR CSS,Location,Extension Mobility,Network Locale,Media Resource Group List,User Hold Audio Source,Network Hold Audio Source,Device User Locale,Signal Packet Capture Mode,Packet Capture Duration,Built in Bridge,Privacy,Retry Video Call as Audio,Ignore Presentation Indicators,Softkey Template,Module 1,Module 2,Phone Load Name,Module 1 Load Name,Module 2 Load Name,Information,Directory,Messages,Services,Authentication Server,Proxy Server,Idle,Idle Timer,MLPP Indication,MLPP Preemption,MLPP Domain,Device Type,User ID,Common Profile,Owner User ID,Allow CTI Control Flag,Device Presence Group,Security Profile,Device Subscribe CSS,Unattended Port,Require DTMF Reception,RFC2833 Disabled,Certificate Operation,Authentication String,Certification Operation Completion Time,Device Protocol,Secure Shell User,Secure Shell Password,XML,Dial Rules,CSS Reroute,CSS Refer,DTMF Signalling,Default DTMF Capability,SIP Profile,SIPCodec_MTPPreferredOrigCodec,Logout Profile,MTP Required,Digest User,Always Use Prime Line,Always Use Prime Line for Voice Messages,Geo Location
Directory Number,Partition,Voice Mail Profile,Line CSS,AAR Group,Line User Hold Audio Source,Line Network Hold Audio Source,Auto Answer,Forward All Voice Mail,Forward All Destination,Forward All CSS,Forward Busy Internal Voice Mail,Forward Busy Internal Destination,Forward Busy Internal CSS,Forward Busy External Voice Mail,Forward Busy External Destination,Forward Busy External CSS,Forward No Answer Internal Voice Mail,Forward No Answer Internal Destination,Forward No Answer Internal CSS,Forward No Answer External Voice Mail,Forward No Answer External Destination,Forward No Answer External CSS,Forward No Coverage Internal Voice Mail,Forward No Coverage Internal Destination,Forward No Coverage Internal CSS,Forward No Coverage External Voice Mail,Forward No Coverage External Destination,Forward No Coverage External CSS,Forward No Answer Ring Duration,Call Pickup Group,MLPP Target,MLPP CSS,MLPP No Answer Ring Duration,Line Text Label,External Phone Number Mask,Maximum Number of Calls,Busy Trigger,Message Waiting Lamp Policy,Ring setting (Phone Idle),Ring Setting (Phone Active),Caller Name,Caller Number,Redirected Number,Dialed Number,Line Description,Alerting Name,Alerting Name ASCII,Line Presence Group,Secondary CSS for Forward All,Forward on CTI Failure Voice Mail,Forward on CTI Failure Destination,Forward on CTI Failure CSS,Display,ASCII DisplayParty Entrance Tone,Log Missed Calls,Park Monitor Forward No Retrieve Ext Voice Mail,Park Monitor Forward No Retrieve Int Voice Mail,Park Monitor Forward No Retrieve Ext CSS,Park Monitor Forward No Retrieve Int CSS,Park Monitor Forward No Retrieve Ext Destination,Park Monitor Forward No Retrieve Int Destination,Park Monitor Reversion Timer
Speed Dial Number,Speed Dial Label,Speed Dial Label ASCII,Service Name,Subscribed Service Name,Subscribed Service Name ASCII,Parameter Name,Parameter Value,Busy Lamp Field Destination,Busy Lamp Field Directory Number,Busy Lamp Field Label,Busy Lamp Field Label ASCII
Phone CSV File Examples
The following list provides examples of commonly used phone CSV data files:
Using a Template Attribute-Forward Busy Destination
If Forward Busy Destination is 3001 on a phone template, all records in a CSV file that have no value for Forward Busy Destination use 3001.
1231123245AB,SEP1231123245AB,Dallas,johns,9728437154,9728437154,Mike,,9728437196,9728437127,
9728437154,9728437178,9728437189,9728437121/TollByPass,1230000000,Helpdesk
No Phone Description Entry
If the description for a phone is blank, use this format:
1231123245AB,,Dallas,johns,9728437154,9728437154,Mike,9728437172,9728437196,
9728437127,9728437154,9728437178,9728437189,9728437121/TollByPass,1230000000,Helpdesk
No Active Line or Location Entry
If no active line is required and the location is also blank, use this format:
1231123245AB,SEP1231123245AB,,,1230000000,HelpDesk
Two Active Lines
If two active lines are required, use this format:
1231123245AB,SEP1231123245AB,Dallas,johns,9725557154,9725557154,Mike,9725557172,9725557196,
9728437127,9728437154,9728437178,9728437189,9725557121/TollByPass,9725557155,9725557155,
Kelvin,9725557133,9725557196,9728437112,9728437145,9728437187,9728437198,9725557112/
TollByPass,1230000000,Helpdesk
![]() Note |
For the MAC Address, enter MAC address values or check the option for creating dummy MAC addresses. |
Mandatory Phone Entries
If one line is required and you want to include only the required values and none of the optional values, use this format:
1231123245AB,,,,9725557154,,,,,
Using Dummy MAC Address Option
If the option is checked for a dummy MAC address and you want one line, use this format:
,Dallas,9725557154,9725557154,Mike,9725557172,9725557196,9728437127,9728437154,9728437178,
9728437189,9725557121/TollByPass,johns,1230000000,Helpdesk