- Preface
-
- Manage User Device Profiles
- User Device Profile Templates
- User Device Profile File Format
- User Device Profile File Format Addition
- User Device Profile Validation
- UDP Generation
- User Device Profile Updates
- User Device Profile Deletions
- User Device Profile Exports
- Line Attribute Updates for Devices and User Device Profiles
- UDP Line Additions
- UDP Report Generation
- Intercom DN Additions and Updates for UDPs
- Text-Based CSV Files
- BAT Performance
- Index
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
- Update User Information in Cisco Unified Communications Manager Directory
- User Update Settings
- Topics Related to User Updates
Update User Information Using CSV Data File
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.
 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 . However, the controlled device is still listed on the end-user page. |
Retain Existing User Information During Update
userid,#,department,,,123456789012,
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:
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.
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 . However, the controlled device is still listed on the End User Configuration window in Cisco Unified Communications Manager Administration.
| Step 1 | Download and open the BAT.xlt file. |
| Step 2 | When prompted, click Enable Macros to use the spreadsheet capabilities. |
| Step 3 | To add user information, click the Update Users tab at the bottom of the spreadsheet. |
| Step 4 | 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. |
| Step 5 | 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. |
| Step 6 | 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
Update User Information in Cisco Unified Communications Manager Directory
You can update a group of user records in the Cisco Unified Communications Manager directory.
You must have a .csv data file with updated user information.
| Step 1 | Choose
.
The User Update Configuration window appears. | ||
| Step 2 | From the
File
Name drop-down list box, choose the .csv data file that you created
for this bulk transaction.
| ||
| Step 3 | From the User Template Name drop-down list box, choose the user template that you created for this bulk transaction. | ||
| Step 4 | 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.
| ||
| Step 5 | In the Job Information area, enter the Job description. | ||
| Step 6 | Choose a method to update user records. Do one of the following: | ||
| Step 7 | 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. |
User Update Settings
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 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. |
| Field | Description | ||||
|---|---|---|---|---|---|
| User Information |
|||||
Manager User ID |
Enter manager user ID, up to 128 characters, for the user of this phone. |
||||
Department |
Enter the department number, up to 64 characters, for the user of this phone. |
||||
Associated PC |
This field, which is required for Cisco SoftPhone and Cisco Unified Communications Manager Attendant Console users, displays after you add the user. |
||||
User Locale |
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. |
||||
Digest Credentials |
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. |
||||
Confirm Digest Credentials |
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.
|
||||
| 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.
|
||||
Assigned Presence Server |
Assign the end user to an IM and Presence Service server that is installed in the cluster if the system is non-balanced. 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. |
||||
UC Service Profile |
Select a UC service profile from the drop-down list box to associate with end users.
|
||||
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.
|
||||
Extension Mobility |
|||||
BLF Presence Group |
From the drop-down list, choose the BLF presence group that watches the status of the directory number, the presence entity. |
||||
SUBSCRIBE Calling Search Space |
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 menu to configure a calling search space specifically for this purpose . |
||||
Allow Control of Device from CTI |
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. |
||||
Enable Extension Mobility Cross Cluster |
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 EMCC login. |
||||
Mobility Information |
|||||
Enable Mobility |
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. |
||||
Enable Mobile Voice Access |
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. |
||||
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 must pick up a call that is transferred from the mobile phone to 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 at a later time. |
||||
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.
To update all users, select Find and do not specify a query.
| Step 1 | Select The Update Users Query window appears. | ||||
| Step 2 | From the first Find Phone where drop-down list, select one of the following criteria: | ||||
| Step 3 | From the second Find Users where drop-down list, select one of the following criteria: | ||||
| Step 4 | Specify the appropriate search text, if applicable.
| ||||
| Step 5 | 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.
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.
| Step 1 | 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. | ||
| Step 2 | 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.
| ||
| Step 3 | Update the required user parameters. See the "User update settings" topic. | ||
| Step 4 | In the Job Information area, enter the job description. | ||
| Step 5 | Select one of the following methods to update user records: | ||
| Step 6 | Select Submit. This action creates a job for updating the records.
|
Feedback