# Key Templates

## Purpose

You can program key templates with a subset of the customer data contained on the Multiline Set Keys form, and then reuse this data when adding new users.

Configure a key template for each device type you intend to use, including Mitel multiline telephones, 5560 IPTs, and generic SIP devices.

Use this form when performing the following tasks:

- Adding Key Templates

- Changing Key Templates

- Deleting Key Templates

## Conditions

- When the system is first installed, a key template named "Default Keys" is created. You can update the field values for this template, but you cannot rename or delete it.

- Templates and roles are shared. In a network of mixed releases, MiVoice Business (MiVB) Release 7.0 templates are shared only with MiVB 7.0 and up systems. However, Pre-7.0 (MCD 5.x and 6.x) templates are shared with and visible on all nodes (5.x, 6.x, 7.x and up). Once shared, a pre-7.0 template can be modified on a 7.x system (within its limitations, such as, one phone service per use) and still remain compatible with pre-7.0 systems. When a pre-7.0 template is copied on a 7.x system, the new copy becomes a 7.x template and is no longer shared with pre-7.0 systems.

MiVB 7.x User and Service Template can only use 7.x Key Template; however, the Default Key Template can be used for both 7.x User and Service Templates and pre-7.0 User and Device Templates.

- Multiple key templates can be created for the same device, but only one template at a time can be applied to a device. The desired key template can be chosen when the User and Service Template is being created or modified.

Pre-Release 7.0 User and Service Templates must use device-specific key templates.

- You must select a key template for each User and Service template and then select the appropriate User and Service template for each User Role to have the templates applied to new users.

- The key template settings are applied when the device type is selected for a new use. Changing the device type for an existing user has no impact.

- When adding a new service, the default key template is used, unless another template is selected. The key programming can be changed for an existing phone service in a template.

- DSS/BLF keys, or any other keys that are programmed with extension numbers, are not automatically removed from templates when the extensions are deleted. The keys must be manually deleted from the templates to avoid potential errors when new users are added.

- The system does not check (validate) key templates for invalid or incomplete key programming (such as a missing ring type in a DSS/BLF key) and will generate errors when you apply the template to a new user. No such errors are generated when you create the template in the Key Templates form. Therefore, ensure that you test all newly created key templates by applying them to a user. To resolve errors, remove the keys from the user's device profile in the User and Services Configuration form, delete the user, correct the key configuration in the Key Templates form, and then re-create the user.

- Key templates cannot be applied to Programmable Key Modules.

- All phones must have at least one (prime) line assigned to it. Typically, button 1 is used for this.

## Field Descriptions

Parameter | Description | Default Value
Device Type | Displays the device type to which the template applies. To change the device type, select it, then choose another from the drop down list. NOTE: In MiVoice Business Release 9.0 or later, unsupported devices are listed under the Unsupported Devices section within the drop-down list. Do not select an unsupported device to create a key template. | No Device
Template Name | Displays the name of the existing templates. To edit a template name, select it, then type the new name in the field provided. NOTE: This field is not case sensitive. This means that "Keys for 5232 IP" and "KEYS FOR 5232 IP" are identical template names. | Blank
Programmable Keys
Button Number | System-generated, protected field. Displays digits in the range 1 to 192 depending on the number of programmable keys on the device. 1 to 4 (6905 IP Phone) 1 to 6 (5505 SIP Phone) 1 to 6 (5302 SIP Phone) 1 to 7 (5010 IP Phone, 5215 IP Phone and 5215 IP Phone Dual Mode) 1 to 8 (6910 IP Phone) 1 to 9 (5304 IP Phone, 5140 IP Phone, and 5240 IP Phone) 1 to 11 (5320/5320e IP Phone) 1 to 12 (Telematrix 3000IP Phone) 1 to 14 (5005 IP Phone, 5020 IP Phone, 5205 IP Phone, 5207 IP Phone, 5212 IP Phone, 5220 IP Phone, 5220 IP Phone (Dual Mode), 5312 IP Phone.) 1 to 18 (6920 IP Phone) 1 to 24 (5324 IP Phone, 5330/5330e IP Phone, 5224 IP Phone, Navigator, and Hot Desk user DNs), which designate the line select keys (2 indicates the lowermost programmable key). Key 1 is reserved for the set's prime directory number. 1 to 48 (5340/5340e IP Phone and 5360 IP Phone) 1 to 72 (6930 IP Phone) 1 to 96 (6940 IP Phone) 1 to 192 (5560 IPT) 1 to 96 (6970 IP Conference Phone) NOTE: During a copy operation, you can select buttons to copy. IP Phone Line Select Keys The line select keys on the IP Phones are numbered right to left and bottom to top. For examples, see 5010 IP Phone, 5215 IP Phone and 5215 IP Phone (Dual Mode) Line Select Key Numbering for numbering on phones with one row of keys and 5020 IP Phone, 5220 IP Phone and 5220 IP Phone (Dual Mode) for numbering on phones with two rows of keys. NOTE: 5320 and 5330 phones follow single-row numbering while the 5340 and 5360 follow double-row numbering. CITELlink Phone Line Select Keys To identify the location of the line select keys on a CITELlink Type1 or CITELlink Type2 phone, click on the model in the following table:
Norstar Phones | Meridian Phones
Model # | Device Type | Model # | Device Type
M7100 | CITELlink Type1 | A2008 | CITELlink Type2
M7208 | CITELlink Type1 | M2006 | CITELlink Type1
M7208N | CITELlink Type1 | M2008 | CITELlink Type1
M7310 | CITELlink Type2 | M2616 | CITELlink Type2
M7310N | CITELlink Type2 | M3110 | CITELlink Type1
M7324 | CITELlink Type2 | M3310 | CITELlink Type1
T7100 | CITELlink Type1 | M3820 | CITELlink Type2
T7208 | CITELlink Type1 | M3901 | CITELlink Type1
T7316 | CITELlink Type2 | M3902 | CITELlink Type1
T7406 | CITELlink Type2 | M3903 | CITELlink Type1
|  | M3904 | CITELlink Type1
SpectraLink Wireless Telephone Line Select Keys The SpectraLink Wireless Telephones use shortcut keys to emulate line select keys. To activate the assigned line appearance or feature, the user presses the LINE, FCN or MENU key plus a shortcut key. See SpectraLink Wireless Telephone Line Select Key Mapping. OpenPhone 27 In Release 2.0 of the OpenPhone 27, line select keys are not supported. |
Label | Enter an on-screen label to display next to the programmable key on the IP Phone. The field accepts 31 ASCII or 10 Simplified Chinese characters but the phone can only display 16 of the former and 10 of the latter. In case of 5340/5340e IP Phone, if opposing keys (e.g., keys 3 and 4 or 5 and 6) are labeled, then only a maximum of 10 ASCII characters or five Chinese characters can be displayed. A Button Label may be defined for a MiXML Application Feature assignment (optional). If you program this field on a 5220 (Dual Mode) phone, however, it will not be displayed. | Blank
Line Type | Enter a Line Type value. The line types associated with any given directory number must match in all forms where the numbers appear. See Line Type Values for more information. You can program speed call keys on a set by selecting "CDE Speedcall" in the Line Type field, and then entering the Speed Call Number (maximum of seven digits) in the Button Directory Number field. After a key is programmed as a CDE Speedcall, the user cannot reprogram the key from the set. You can program user speedcalls on a set from this form or users can program them directly from their sets. These speed call numbers appear on the form as "User Speedcall" in the Line Type field. If the user has designated the number as private, the Line Type field displays "User Speedcall - Private". A directory number must already exist in the system before a DSS or Secretarial Transfer key and busy lamp are programmed to monitor it. Attempting to commit the form when an unknown directory number or a directory number that translates to an ARS destination has been specified will result in the error message "Directory Number is invalid". NOTES If you have a 5330/5330e, 5340/5340e, or 5360 IP Phone with analog Line Interface Module (LIM), do not program feature key 2. This key is reserved for the LIM. Assigning the key another feature may result in an incorrect LED indication following a set reboot. HTML Toolkit Release 2.0 phone applications are only available to DNs licensed to use them. See Multiline IP Sets form for details. | Not Assigned
URL | Enter the URL of a web page to display on the set. Applies to sets with built-in web browsers. The only supported URL type is http. |
Button Number Str | Enter the directory number which is associated with the Line Select Key of the multiline set, the Trunk Number, in the form "Tnnnn" where "nnnn" is the trunk number which is associated with the line select key of the set. CDE Speedcalls can be a maximum of seven digits. User speedcalls can be a maximum of 26 digits. If the user has programmed a user speedcall and designated the number as private, "xxxxxxx" is displayed instead of the number. A directory number may appear on more than one key on any MiVoice IP Phone or generic SIP device. NOTES Refer to the feature description for the selected Line Type for specific conditions and restrictions regarding the assignment of directory numbers. On generic SIP devices, only the DN of the SIP device can be assigned to Button Directory Numbers to support the multicall feature. If a trunk number is programmed in the Directory Number field, it can be assigned as either a "key system" or "single line". A trunk assigned to a multiline set line cannot be in a trunk group. NOTE: The Button Directory Number field does not update when a directory number assigned to the Call Park and Call Park - Retrieve key is changed or removed in another form. If such a change or deletion occurs, attempts to use the feature key will result in invalid dialing treatment. Also, any subsequent data restore will not correct or remove the invalid key data. | Blank
Ring Type | Select whether and how to ring the line to signal a call. See Line Appearance Ring Types for a description of the choices. | Blank
MiXML Application Feature | Select a MiXML Application Feature for the button being changed from all the Third Party MiXML Applications that have been added to the system. The data displayed in this field, derived from MiXML Application Feature views, can differ from application to application. | Not Assigned
Phone Application Feature | (5320/5320e. 5330/5330e, 5340/5340e and 5360 IP Phones only) Select a Phone Application Feature to assign to the key from the list of all the applications built into the sets or added to the system (and subsequently to the sets) using the HtmlAppUpgrade Maintenance command. NOTE: The Phone Application list is not shared among cluster elements by SDS. It is up to the administrator to load the required applications on to each element so that devices can access them. |
Float | Select to make the line key a Float key. Float Keys are supported on the 5340, 5340e, 5360, 5560, 6930,and 6940 IP phones, the 6970 IP Conference phone, and for Single, Key system, Multicall, and Mobile line types. NOTE: All Float keys programmed in the USC form are the Float Immediate type. | Blank