EasyUC
4.8.7

CUCM connection options

Naming rules for devices

Templates for the device description and the names of softphones, profiles and other device types.

EasyUC · Version 4.8.7

In EasyUC: EasyUC Cisco → Administration → CUCM & Provisioning → CUCM Connections → Actions → Device naming

Purpose

When EasyUC creates a device in the CUCM, it needs a device name and a description. Hardware phones are named after their MAC address. Softphones, device profiles, remote destinations, CTI route points and virtual devices have no MAC address. For these, EasyUC builds the name from the templates in this dialog. The Device Description template applies to the description of all devices.

A template consists of fixed text and placeholders in double curly braces. On creation, EasyUC replaces the placeholders with the data of the user and the device. For softphones, the CUCM device type requires a fixed prefix (TCT, BOT, CSF, TAB). The dialog shows it in front of the field; you enter only the part after it.

Saving does not change existing devices. The rules take effect when EasyUC creates a device. If CUCM Changes is switched on, EasyUC also sets the names again as soon as the data of a user changes in the CUCM.

Prerequisites

  • License with the cucm module and the provisioning feature. Without provisioning, the entry is missing from the Actions menu.
  • EasyUC account with the ROLE_APP_ADMIN role. Only administrators see the Administration menu.
  • The CUCM connection has been created and enabled. For a disabled connection, Actions shows only Enable Connection.
  • You know the naming convention of your CUCM. Device names must be unique in the CUCM. A template without a reference to the user leads to a name conflict with the second device.

Step by step

  1. In the header, select the EasyUC Cisco workspace.
  2. In the menu, open Administration → CUCM & Provisioning → CUCM Connections. The Manage CUCM Connections page lists all connections.
  3. In the row of the connection you want, click Actions. The Menu popover opens.
  4. Click Device Naming. The Device naming dialog opens.
  5. Read the list of placeholders in the information box at the top. It also contains the custom user attributes of your CUCM.
  6. Under Device Description, enter the template for the device description, for example {{phoneNumber}} {{firstName}} {{lastName}}.
  7. Adjust the templates for iPhone, Android, CSF and Tablet. Do not enter the prefix that is displayed.
  8. If required, adjust Device Profile, Remote Destination, Remote Destination Profile, Mobile Identity, CTI Route Point and Virtual Device.
  9. If certain words in the result are to be replaced, click Add in the Replace Naming Values area and fill in Text To Replace and Text To Replace With.
  10. Click Save (top right or at the bottom of the dialog). The dialog closes and EasyUC shows a success message (“Success”). Cancel closes the dialog without changes.
  11. Create a softphone for a test user and check the name and description in the CUCM.

Fields and options

Fields and options
Field / actionMeaning and use
Device DescriptionTemplate for the device description. Default: {{phoneNumber}} {{firstName}} {{lastName}}. The result is shortened to 128 characters. Required.
iPhoneName for Cisco Dual Mode for iPhone, prefix TCT. Default: {{userID}}. Required.
AndroidName for Cisco Dual Mode for Android, prefix BOT. Default: {{userID}}. Required.
CSFName for Cisco Unified Client Services Framework (Jabber/Webex on the PC), prefix CSF. Default: {{userID}}. Required.
TabletName for Cisco Jabber for Tablet, prefix TAB. Default: {{userID}}. Required.
Device ProfileName for device profiles (Extension Mobility). Default: {{location}}{{userID}}. Required.
Remote DestinationName of the remote destination. Default: RD{{userID}}. Required.
Remote Destination ProfileName of the remote destination profile. Default: RDP{{userID}}. Required.
Mobile IdentityName of the mobile identity. Default: RDMI{{userID}}{{deviceName}}. Required.
CTI Route PointName for CTI route points. Default: MS{{userID}}. Required.
Virtual DeviceName for virtual devices. Default: VD{{userID}}. Required.
Replace Naming ValuesList of replacements. Add creates a row, remove deletes it. The list applies to device names and line names alike. Both dialogs (Device Naming and Line Naming) edit the same list.
Text To ReplaceText that is searched for in the finished name. EasyUC replaces whole words only and ignores case. Required in every row.
Text To Replace WithText that is inserted instead. Required in every row.

Placeholders

Placeholders
Field / actionMeaning and use
`{{firstName}}`First name of the user.
`{{1FirstLetterFirstName}}`, `{{2FirstLetterFirstName}}`, `{{3FirstLetterFirstName}}`The first one, two or three letters of the first name.
`{{lastName}}`Last name of the user.
`{{userID}}`User ID in the CUCM.
`{{department}}`Department of the user.
`{{title}}`Title of the user.
`{{displayName}}`Display name of the user.
`{{deviceType}}`Phone type, for example “Cisco 8811”.
`{{deviceTypeShort}}`Short form of the phone type. “Cisco ” is cut off (8811), softphones become TCT, BOT, CSF or TAB.
`{{deviceName}}`Device name in the CUCM, for example SEP… or BOT….
`{{phoneNumber}}`Phone number. Only digits and the plus sign are used.
`{{location}}`Location of the user.
Dynamic Custom User FieldsIf the CUCM has its own user attributes (Custom User Fields), the dialog lists them as well. The placeholder is the attribute name in double curly braces.

Check the result and narrow down errors

  • Success: A newly created softphone has the expected name in the CUCM, for example CSFmmuster with the template {{userID}} and the user ID mmuster.
  • Message “This value should not be blank.” under a field: All templates are required. Every row under Replace Naming Values also needs both values.
  • Characters are missing from the name: In device names, EasyUC transliterates umlauts and special characters. Placeholders that EasyUC cannot resolve are removed from the description.
  • Existing devices keep their previous names: This is correct. Saving does not rename anything.
  • Creation fails because of a duplicate name: The template is not unique. Include {{userID}} or {{phoneNumber}} in the template.

Related chapters