# Configuring Key Templates

## Overview

Key templates contain line key settings that you can reuse when you provision a new user and device. Creating and applying templates is a fast way to assign a common button configuration to a large number of phones.

The system contains a single default key template, which you can modify. In addition, you can add new key templates for a variety of Mitel multiline telephones and generic SIP devices.

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.

NOTES

- 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.

- For networks that include various product interfaces for managing users and services, the Flow Through Provisioning solution allows the administrator to configure and manage users and phone and MiCollab services from a single location. See Adding Users and Services for more information.

## 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.

- 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. Once a new User and Service Template is created, you can click the Keys tab and either select an existing Key Template (default) or create a new one.

- 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.

- When adding a new user, the default key template is used if it is associated with the selected User and Service Template. The key programming can be changed for an existing phone service in a template.

- Data in key templates associated with a User Role are not imported. If you are importing users and specify a User Role in the spreadsheet, the role will survive the import but not the programming in the role's key template. Key programming will either need to be manually added in the Multiline Set Keys form after the user is imported or imported via the Key Assignment worksheet in the Import Spreadsheet.

## Programming

### Adding a Key Template

To add a key template:

1. Go to the Key Templates form.

2. Click Add.

3. Select a Device Type.

NOTE: In MiVoice Business Release 9.0 or later, unsupported devices are listed under the Unsupported Devices section within the Device Type drop-down list. Do not select an unsupported device type to create a key template.

4. Enter a Template Name or accept the default value: "Keys for <device-type>".

5. Program the keys. Assign a directory number (line appearance) or feature to each key, and assign a ring type to each line appearance.

6. Click Save.

7. Test the key template by applying it to a new user.

NOTES

- You can also create a new key template on the User and Service Templates form ( ). After selecting a Device Type, go to the Keys tab, select Create New Key Template, enter the new template's name, and program the keys. Then save your work to create the new key template for the device.

- 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.

### Changing a Key Template

To change a key template:

1. Go to the Key Templates form.

2. Select a key template by clicking the appropriate row in the Key Templates list. Select "Default Keys" if you wish to update the default template.

3. Click Change. A detailed Key Template dialog appears.

4. Modify the necessary field(s).

5. Click Save.

NOTE: You can also change an existing key template on the User and Service Templates form ( ). After selecting a Device Type, go to the Keys tab and modify the keys. Then save your work to update the key template for the device.

### Deleting a Key Template

NOTE: You can delete any key template except the Default Key Template.

To delete a key template:

1. Go to the Key Templates form.

2. Select a key template by clicking the appropriate row in the Key Templates list.

3. Click Delete.

4. Click OK.

Related Topics

- Configuring User Roles

- Configuring User and Service Templates