You can update existing user information that is in the Cisco Unified Communications Manager (Unified CM) 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.
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.
Create a CSV data file to define individual values for each user that you want to update.
Use Unified CM BAT to insert the updated user records that are in the Unified CM database.
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.
To identify the value to use to retain a stored value, use the following procedure.
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:
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.
You cannot upload a CSV filename that contains a comma (for example, abcd,e.txt) to the Unified CM 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 Cisco 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.
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 1.
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.
BAT spreadsheet update user data field descriptions
The following table provides the field descriptions for updating user details in the BAT spreadsheet.
Table 1 Field description in BAT spreadsheet for updating users
Enter the last name, from 1 to 128 characters, of the phone user.
Manager User ID
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.
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 end user.
Enter the end user e-mail address up to 255 characters.
BLF Presence Group
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 Cisco Unified Communications Manager Features and Services Guide.
SUBSCRIBE Calling Search Space
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 end 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 Administration Guide.
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 CM. 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.
The User Group fields appear when you set the Number of User Groups field 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.
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",Smith@test.com directory URI must be input as "Jared,""Jerry"",Smith@test.com" in the CSV file.
Update User Information in Cisco Unified Communications Manager Directory
Before You Begin
You must have a .csv data file with updated user information.
Values that appear in some fields display from
Unified CM. You must configure these values by using
Unified CM Administration.
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.
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 2 Field descriptions for update users
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.
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.
You must install a Unified CM IM and Presence node along with this Unified CM cluster.
You can only enable IM and Presence feature for users that have this Unified CM cluster marked as their home cluster.
Use the User Management > User Settings > UC Service menu to configure the IM and Presence feature.
UC Service Profile
Select a UC service profile from the drop-down list box to associate with end users.
Enter an appropriate job description.
Select 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 at a later time.