Cisco User Device Association Tool User Guide
First Published: October 06, 2014
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http://
www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership
relationship between Cisco and any other company. (1110R)
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network
topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional
and coincidental.
© 2014
Cisco Systems, Inc. All rights reserved.
CONTENTS
CHAPTER 1
Overview 1
User Device Association Tool Overview 1
System Requirements 1
Interface 2
CHAPTER 2
Prerequisite Tasks 3
Enable the AXL Web Service 3
Add AXL Service Privileges to Your Log-in Credentials 3
Prepare Licensing Information 4
CHAPTER 3
Getting Started 5
Extract and Run the Tool 5
Select Rules (Step 1) 5
Rules 6
Match File 6
Update System (Step 2) 7
APPENDIX A
UDAT FAQs 9
Cisco User Device Association Tool User Guide
iii
Contents
Cisco User Device Association Tool User Guide
iv
CHAPTER
1
Overview
• User Device Association Tool Overview, page 1
• System Requirements, page 1
• Interface, page 2
User Device Association Tool Overview
The Cisco User Device Association Tool (UDAT) is used by administrators to assign a user to a device in
Unified Communications Manager Releases 6.x to 10.x. The tool connects to Unified Communications
Manager and reads the configured devices that are unassigned to users. Using rules that you select, the tool
attempts to match users to unassigned devices. You can review the user-to-device matches, and then apply
the results into the Unified Communications Manager database.
This tool is useful if you have a large number of users without assigned devices. Devices are assigned to users
to facilitate self-care (or self-provisioning), as well as for aggregating devices for a user. For the purposes of
licensing, devices that users own share a license, instead of requiring a separate license for both a device and
a user.
For more information about Unified Communications Manager licensing, see the the “Licensing” chapter in
the Cisco Unified Communications Manager Features and Services Guide at the following URL:
http://www.cisco.com/c/en/us/support/unified-communications/unified-communications-manager-callmanager/
products-maintenance-guides-list.html
System Requirements
This tool is a standalone desktop executable that can run on a Windows PC or an Apple Mac computer.
• A Unified Communications Manager node, Release 6.x to 10.x, that is running AXL services (see “Enable
the AXL Web Service” in the Related Topics section)
• A PC that runs Windows 7, 8, or 8.1, or an Apple Mac computer that runs OS X
◦A minimum of 1 GB memory
◦A minimum of 100 MB free hard drive space
Cisco User Device Association Tool User Guide
1
Overview
Interface
◦Java 1.6 or later
◦A program that lets you view and edit spreadsheet files in .xls format
Related Topics
Enable the AXL Web Service, on page 3
Interface
The user interface contains integrated help content on each screen to guide you through your assignment tasks.
The tool also provides tooltips to explain the matching rules that you can run.
Cisco User Device Association Tool User Guide
2
CHAPTER
2
Prerequisite Tasks
• Enable the AXL Web Service, page 3
• Add AXL Service Privileges to Your Log-in Credentials, page 3
• Prepare Licensing Information, page 4
Enable the AXL Web Service
Step 1
Step 2
Step 3
From Cisco Unified Serviceability, choose Tools > Service Activation.
From the Server drop-down list, choose the server.
Under Database and Admin Services, check the Cisco AXL Web Service check box.
Step 4
Click Save.
Add AXL Service Privileges to Your Log-in Credentials
Step 1
Step 2
Step 3
Step 4
From Cisco Unified Communications Manager Administration, choose User Management > Application User.
Click Find.
Choose the application user you want to use for the UDAT.
Under Permission Information, add Standard AXL API Access to the Roles list.
Step 5
Click Save.
Cisco User Device Association Tool User Guide
3
Prerequisite Tasks
Prepare Licensing Information
Prepare Licensing Information
Unified Communications Manager licensing is based on the number of devices that are assigned to a user.
Before you run the UDAT, understand and prepare a snapshot of your system licensing requirements.
Important
After running the UDAT, device assignments that are provided to users in Unified Communications
Manager Releases 9.x and later might change your license requirements.
For Unified Communications Manager Releases 6.x to 8.x, Owner User ID settings for devices (users with
multiple devices) were not enforced. The same number of devices and users will require the same number of
device license units (DLUs).
For Unified Communications Manager Releases 9.x and later, the number of devices per user is enforced,
and the required user license types depend on the number of devices per user. Devices include soft clients,
mobile clients, physical phones, and video endpoints. For users with one device, the device is licensed per
device type. For users with two devices, an Enhanced Plus UCL license is required. For users with more than
two devices (and up to 10) a Cisco Unified Workspace License – Standard Edition or Professional Edition
license is required.
Step 1
Step 2
Step 3
Step 4
Understand your license requirements. Take a snapshot of your license usage from the UC Manager Administration –
License Usage Calculator. This report lists all devices and device license units (DLUs) that are required for each device.
Understand the number of users and devices and devices per user in your current system.
For the purposes of preparing for an upgrade or migration to Unified Communications Manager Release 9 or 10, if you
are running the User Device Association Tool on pre-9.x releases, prepare the following information:
a) Identify and list the public space, common area, or shared devices.
b) Manage the shared device list by setting the appropriate device descriptions.
c) Consider assigning a user ID of <none> or <anon> (anonymous) so that the shared devices are not selected as
unassigned devices.
Run the License Count Utility. Run a before and after snapshot to understand the number of users, number of devices,
and number of users with multiple devices.
You can download the License Count Utility at the following URL:
http://software.cisco.com/download/navigator.html
For more information about the License Count Utility, see Using Cisco Unified Communications Manager License Count
Utility at the following URL:
http://www.cisco.com/c/en/us/support/unified-communications/unified-communications-manager-callmanager/
products-maintenance-guides-list.html
Cisco User Device Association Tool User Guide
4
CHAPTER
3
Getting Started
• Extract and Run the Tool, page 5
Extract and Run the Tool
You download the tool as a zipped (.zip) file that contains an executable application (.jar) file.
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Download the zip file from [INSERT URL or SITE NAME HERE] to your desktop.
Open the zip file.
Extract the files to a folder that you can easily find, for example, on your desktop.
Close your zip program.
Open the folder that you created.
Double-click UdatApplication.jar.
The User Device Association Tool opens.
Step 7
Step 8
Enter the hostname or IP address of the Unified Communications Manager publisher.
Enter the login credentials for the AXL-enabled application user.
Select Rules (Step 1)
This first step lets you select the rules that you want to use to make user-device matches. The right column
has a default selection of the top three recommended matching rules. They are listed in the order that they are
run. Because the rules are run on the unassigned devices, the first rule is run and Owner User ID assigned
with the best match resulting from the rule. The next rule is run on the unassigned devices that remain from
the first rule run, and so on, until all the rules are run.
Cisco User Device Association Tool User Guide
5
Getting Started
Select Rules (Step 1)
Rules
Match by Control Device
If only one End User Configuration page references a device as a “Controlled Device,” this user will
be set as the owner.
Match by Primary Extension and Partition
If a Device Configuration page lists a number for line 1 that matches the primary extension listed on
an End User Configuration page, then that user is set as the owner for this device.
Match to User Associated with Line
If line 1 of a device lists only one user under Users associated with line, then that user will be set as
the owner.
Match by Telephone Number and Partition
If a Device Configuration page lists a number for line 1 that matches the telephone number listed on
an End User Configuration page, then that user is set as the owner for this device.
Options—Last (3–10) digits
Match to Alerting Name of Line
If a Device Configuration page lists an alerting name for line 1 that contains the user ID, extension
number, or first name and last name listed on an End User Configuration page, then that user is set
as the owner for this device.
Options—Last (3–10) digits, First name, Last name
Match to Line Display
If a Device Configuration page lists a display name for line 1 that contains the user ID, extension
number, or first name and last name listed on an End User Configuration page, then that user is set
as the owner for this device.
Options Last (3–10) digits, First name, Last name
Match to Device Description
If a Device Configuration page lists a device description that contains the user ID, extension number,
or first name and last name listed on an End User Configuration page, then that user is set as the
owner for this device.
Options—Last (3–10) digits, First name, Last name
Match File
The resulting match file can be saved to your hard drive. You should review it for quality and quantity of
matches.
You can run Step 1 as many times as you want with different rules and different priorities. You can also edit
the match file for manual user ID assignments to the Owner User ID field.
Cisco User Device Association Tool User Guide
6
Getting Started
Update System (Step 2)
Important
Note
Note the server name and time/date stamp of the match file with the final results so that you apply the
correct file to the Unified Communications Manager database in Step 2.
Manual assignments to the Owner User ID field in the match file will not be imported into the Unified
Communications Manager database until you run Step 2 to import the Owner User ID field into the
database. If you run subsequent rules through Step 1, manual assignments are not saved in the match file.
Update System (Step 2)
For Step 2, you can take any match files you created and import them into your Unified Communications
Manager publisher node.
Cisco User Device Association Tool User Guide
7
Getting Started
Update System (Step 2)
Cisco User Device Association Tool User Guide
8
APPENDIX
A
UDAT FAQs
Q. What is the best time to run the tool? Can I schedule updates?
A. You should run the tool outside of regular business hours, because the updates can take some time to
complete. You cannot schedule updates, because running the updates is a manual process that you initiate.
Q. What if I have multiple clusters? How do I run the tool for users and devices specific to that customer?
How are the rules effective for all users and devices?
A. The tool can be run for a specific publisher in a cluster each time to retrieve the devices that have no
owner user ID.
Q. I don't understand the order of the rules. What happens if I change the order?
A. The order of the rules are used mainly to prioritize the match. Administrators are allowed to change the
order of the rules to influence the matching results.
Q. How can I review the matches that are made?
A. After all of the selected rules are run, the tool will give you an option to save the results as a spreadsheet.
You can view the report and make changes if required.
Q. Can I review or edit the matches before I make user device assignments?
A. Yes. You can change the user ID that is matched from the selected rules after the report is saved.
Q. Do I need to reset any devices after I run the tool?
A. No. A device reset is not required.
Q. What if I receive errors during Step 1 (running the rules)?
A. If you receive an exception error, you must check the log file. If there is an error during the running of
the rules, the most likely error cause is either lost network connectivity or the AXL service going down.
If so, you can run the rules again.
Q. What if I receive errors during Step 2 (the assignment of the matches)?
Cisco User Device Association Tool User Guide
9
UDAT FAQs
A. If you receive an exception error, you must check the log file. If there are any issues with assigning
devices, they are logged and the assignment continues. At the end of the update, uoi will see the option
to save the log file with errors. Just like Step 1, the most likely error cause is either lost network
connectivity or the AXL service going down. If so, you can run the update again.
Q. What if I cancel the import?
A. If you cancel the import, the updates to the database are cancelled. But you cannot revert the updates
that were made while the import ran.
Q. What will happen to my licensing?
A. For Unified Communications Manager Releases 6.x to 8.x, Owner User ID settings for devices (users
with multiple devices) were not enforced. The same number of devices and users will require the same
number of device license units (DLUs).
For Unified Communications Manager Releases 9.x and later, the number of devices per user is enforced,
and the required user license types depend on the number of devices per user. Devices include soft
clients, mobile clients, physical phones, and video endpoints. For users with one device, the device is
licensed per device type. For users with two devices, an Enhanced Plus UCL license is required. For
users with more than two devices (and up to 10) a Cisco Unified Workspace License – Standard Edition
or Professional Edition license is required.
For more information about Unified Communications Manager licensing, see the the “Licensing” chapter
in the Cisco Unified Communications Manager Features and Services Guide at the following URL:
http://www.cisco.com/c/en/us/support/unified-communications/
unified-communications-manager-callmanager/products-maintenance-guides-list.html
Q. How are common area/public space/shared devices assigned?
A. These devices are assigned just like any other device. The UDAT does not differentiate the different
devices; if a device matches a rule, then an assignment is made. You can modify the spreadsheet before
the update if you want to change the assignment.
Cisco User Device Association Tool User Guide
10