This guide explains how to set up the correct device type in Cisco Unified Communications Manager to enable you to use the Jabber SDK. In brief, it involves creating a CSF device with the name ECP<yourusername>, but follow these detailed steps to ensure proper functionality.
Log into Cisco Unified Communications Manager Administration.
Choose Device > Phone.
The Find and List Phones window opens.
Click Add New.
The Add a New Phone window opens.
From the Phone Type drop-down list, select Cisco Unified Client Services Framework.
Click Next.
The Phone Configuration window opens.
In the Device Information section of the Phone Configuration window, set the following:
Device Name — By default, device name should be in ECP<username> format, for example: ECPjohndoe.
However, the SDK allows you to override the prefix to one of your own by passing in the devicePrefix field in the settings object. You can also use your own custom scheme for associating Cisco Unified Communication Manager device names with usernames by providing your own settings.predictDevice function.
The following are the limitations set for the device name:
- The device name is not case sensitive.
- The device name is created by placing the prefix in front of the username and then remove any characters which are not permitted. Do not use symbols such as dots, hyphens, underscores and any accented characters or non-Latin (English) characters.
- Cisco Unified Communications Manager accepts a maximum length of 15 characters, so the generated name must be truncated to this length.
- This may lead to some name clashes because names that are only unique in the 13th character and beyond become the same name when ECP is prepended and the total length is truncated to 15. Also, the names Joe.Bloggs and JoeBloggs both map to the same device name—ECPJoeBloggs. These ambiguities must be handled on a case-by-case basis and may require that the usernames be changed to make them unique.
- Similarly, the user Frédéric will have a device name of ECPFrdric. Dropping the non-Latin characters can lead to further name clashes.
Description — Enter a descriptive name, such as John Doe's Web Communicator.
Device Pool — Set to the desired device pool.
Phone Button Template — Set to Standard Client Services Framework.
In the Protocol Specific Information section of the Phone Configuration window set the following:
- Device Security Profile — Set to Cisco Unified Client Services Framework - Standard SIP Non- Secure.
- SIP Profile — Set to Standard SIP Profile.
Click Save.
Click Apply Config, if this button is available (and confirm when prompted).
To add a line for the Cisco Web Communicator device, click Line [1] - Add a New DN on the upper-left portion of the Phone Configuration window.
The Directory Number Configuration window opens.
Type in a Directory Number and click Save.
Click Apply Config if this button is available (and confirm when prompted). You should see the name of the softphone device in the Associated Devices box on the Directory Number Configuration page.
Scroll down to the bottom of the Directory Number Configuration page and click Associate End Users. The Find and List Users window opens.
Use the search criteria to find the user you want to associate with the directory number, then check the check box next to that user name and click Add Selected.
The Directory Number Configuration window should now show that the user is associated with the line. This information appears in the User Associated With Line section that is near the bottom of the window.
Click the username in the User Associated with Line section of the window.
The End User Configuration window opens.
Scroll down to the Direct Number Associations section of the window and choose the primary extension from the Primary Extension drop-down list. This is the directory number you configured in step 11.
In the Permissions Information section at the bottom of the End User Configuration window, click Add to User Group. The Find and List User Groups window appears.
Use the search criteria to find Standard CCM End Users.
Check the check box next to Standard CCM End Users, then click Add Selected.
The Standard CCM End Users group should now appear in the Permissions Information section at the bottom of the End User Configuration window.
Click Save.
The Cisco Web Communicator device is now configured in Cisco Unified Communications Manager.