Cisco Unified CallManager Administration Guide, Release 5.0(2)
Softkey Template Configuration
Downloads: This chapterpdf (PDF - 220.0KB) The complete bookPDF (PDF - 6.7MB) | Feedback

Softkey Template Configuration

Table Of Contents

Softkey Template Configuration

Finding a Softkey Template

Adding Nonstandard Softkey Templates

Adding Application Softkeys to Nonstandard Softkey Templates

Configuring Softkey Positions in a Nonstandard Softkey Template

Modifying Softkey Templates

Renaming a Softkey Template

Deleting a Softkey Template

Updating a Softkey Template

Assigning Softkey Templates to IP Phones

Related Topics


Softkey Template Configuration


Softkey template configuration allows the administrator to manage softkeys that the Cisco IP Phones (such as model 7960) support. Cisco Unified CallManager supports two types of softkey templates: standard and nonstandard. Applications that support softkeys can have one or more standard softkey templates that are associated with them; for example, Cisco Unified CallManager has the Standard Feature and the Standard User softkey templates that are associated with it. You cannot modify standard softkey templates.

The administrator can copy, update, or delete nonstandard softkey templates by using softkey template configuration.

The following sections provide details about softkey template configuration:

Finding a Softkey Template

Adding Nonstandard Softkey Templates

Adding Application Softkeys to Nonstandard Softkey Templates

Configuring Softkey Positions in a Nonstandard Softkey Template

Modifying Softkey Templates

Assigning Softkey Templates to IP Phones

Finding a Softkey Template

Because you might have several softkey templates in your network, Cisco Unified CallManager Administration lets you locate specific softkey templates on the basis of specific criteria. Use the following procedure to locate softkey templates.


Note During your work in a browser session, Cisco Unified CallManager Administration retains your softkey template search preferences. If you navigate to other menu items and return to this menu item, Cisco Unified CallManager Administration retains your softkey template search preferences until you modify your search or close the browser.


Procedure


Step 1 Choose Device > Device Settings > Softkey Template.

The Find and List Softkey Templates window displays. Use the three drop-down list boxes to search for a softkey template.

Step 2 From the first Find softkey templates where drop-down list box, choose one of the following criteria:

Name

Description


Note The criterion that you choose in this drop-down list box specifies how the list of softkey templates that your search generates will be sorted. For example, if you choose Description, the Description column will display as the left column of the results list.


From the second Find softkey templates where drop-down list box, choose one of the following criteria:

begins with

contains

ends with

is exactly

is empty

is not empty

From the third Find softkey templates where drop-down list box, choose one of the following criteria:

Both

Standard

Non-Standard

Step 3 Specify the appropriate search text, if applicable, and click Find. You can also specify how many items per page to display.


Tip To find all softkey templates that are registered in the database, click Find without entering any search text.


A list of discovered softkey templates displays by

Softkey Template Name

Description

Step 4 From the list of records, click the Softkey Template Name or the Description that matches your search criteria.

The window displays the softkey template that you choose.


Additional Information

See the "Related Topics" section.

Adding Nonstandard Softkey Templates

Cisco Unified CallManager includes standard softkey templates for call processing and applications. When creating custom, nonstandard softkey templates, copy the standard templates and make modifications as required.

Procedure


Step 1 Choose Device > Device Settings > Softkey Template.

The Find and List Softkey Templates window displays.

Step 2 Click the Add New.

The Softkey Template Configuration window displays.

Step 3 From the drop-down list box, choose a softkey template and click the Copy button to create a new template.

The Softkey Template Configuration window redisplays and contains the fields in which to enter a unique softkey template name, description, and application that are associated with the soft keys.

Step 4 In the Softkey Template Name field, enter a unique name to identify the softkey template.

Step 5 Enter a description that describes use of the template.

Step 6 Click the Save button.

The standard template gets copied, and the Softkey Template Configuration window redisplays.

Step 7 If you want to add additional application softkeys to the nonstandard softkey template, see the "Adding Application Softkeys to Nonstandard Softkey Templates" section.

Step 8 To configure the positions of the softkeys on the Cisco Unified IP Phone LCD screen, see the "Configuring Softkey Positions in a Nonstandard Softkey Template" section.

Step 9 To save your configuration, click the Save button.


Additional Information

See the "Related Topics" section.

Adding Application Softkeys to Nonstandard Softkey Templates

Cisco Unified CallManager includes standard softkey templates for call processing and applications. When creating custom, nonstandard softkey templates, copy the standard templates and make modifications as required. This procedure describes how to add application softkeys to a nonstandard softkey template that you created.

Procedure


Step 1 Find the softkey template by using the procedure in the "Finding a Softkey Template" section.

Step 2 From the list of matching records, choose the softkey template to which you want to add application softkeys.


Note You can modify only softkey templates that display a check box in the left column. All other softkey templates are standard, read-only templates.


The Softkey Template Configuration window displays.

Step 3 To add additional application softkeys to the nonstandard softkey template, click the Add Application button.

The Add Application window displays.

Step 4 Choose the standard softkey template that you want added to the nonstandard softkey template.

Step 5 Click the Insert button and click Close.

The softkeys that are associated with the standard softkey template that you chose get added at the end of the nonstandard softkey template. Duplicate softkeys automatically get deleted. If the number of softkeys for a particular call state exceeds 16, the optional softkeys for that call state will be removed (from the end to the front). If after the optional softkeys are removed, the number of softkeys still exceeds 16, a message displays.

Step 6 To save your softkey set configuration, click the Save button.

Step 7 To make the updates of the softkey template take effect on the phone, click the Restart Devices button.


Additional Information

See the "Related Topics" section.

Configuring Softkey Positions in a Nonstandard Softkey Template

Cisco Unified CallManager includes standard softkey templates for call processing and applications. When creating custom, nonstandard softkey templates, copy the standard templates and make modifications as required. This procedure describes how to configure softkey positions for each call state in a nonstandard softkey template that you created.

Procedure


Step 1 Find the softkey template by using the procedure in the "Finding a Softkey Template" section.

Step 2 From the list of matching records, choose the softkey template in which you want to configure softkey positions.


Note You can modify only softkey templates that display a check box in the left column. All other softkey templates are standard, read-only templates.


The Softkey Template Configuration window displays.

Step 3 To configure the positions of the softkeys on the Cisco Unified IP Phone LCD screen, choose Configure Softkey Layout from the Related Links drop-down list box.

The Softkey Layout Configuration window displays. The Select a Call State to Configure drop-down list box lists each Cisco Unified CallManager call state for an IP phone.

Step 4 To configure the softkey positions for a call state, choose the call state from the Select a Call State to Configure drop-down list box.

The Softkey Layout Configuration window redisplays, and the fields Unselected Softkeys and Selected Softkeys display softkeys that are applicable to the call state that you chose.


Tip To create a relative place holder for a softkey, add the Undefined softkey. This allows the softkey that you added to occupy the same softkey position in all call states.


Step 5 To move softkeys from one list to the other, use the right and left arrows.

Step 6 To rearrange the positions of the Selected Softkeys, use the up and down arrows.

Step 7 To save your softkey set configuration, click the Save button.

Step 8 To return to the Softkey Template Configuration window, choose the Softkey Template Configuration link from the Related Links drop-down list box in the top, right-hand corner.

Step 9 To save your configuration, click the Save button.

Step 10 To make the updates of the softkey template take effect on the phone, click the Restart Devices button.


Additional Information

See the "Related Topics" section.

Modifying Softkey Templates

You can make changes to custom, nonstandard softkey templates that you created:

Renaming a Softkey Template

Deleting a Softkey Template

Updating a Softkey Template

Additional Information

See the "Related Topics" section.

Renaming a Softkey Template

Use this procedure to rename a nonstandard softkey template that you created.

Procedure


Step 1 Find the softkey template by using the procedure in the "Finding a Softkey Template" section.

Step 2 From the list of matching records, choose the softkey template that you want to rename.


Note You can rename only softkey templates that display a check box in the left column. All other softkey templates are standard, read-only templates.


The Softkey Template Configuration page displays.

Step 3 In the Softkey Template Name field, enter the new name.

Step 4 Click the Save button.

The Softkey Template Configuration window redisplays with the new softkey template name.


Additional Information

See the "Related Topics" section.

Deleting a Softkey Template

Use this procedure to delete a nonstandard softkey template that you created.

Before You Begin

You cannot delete a nonstandard softkey template that is currently assigned to a device or device pool. To find out which devices and device pools are using the nonstandard softkey template, choose Dependency Records from the Related Links drop-down list box in the Softkey Configuration window and click Go. If the dependency records are not enabled for the system, the dependency records summary window displays a message. For more information about dependency records, see the "Accessing Dependency Records" section on page A-2. If you try to delete a nonstandard softkey template that is in use, Cisco Unified CallManager displays a message. Before deleting a nonstandard softkey template that is currently in use, you must perform either or both of the following tasks:

Assign a different softkey template to any devices or device pools that are using the nonstandard softkey template that you want to delete. See the "Deleting a Phone" section.

Delete the devices that are using the nonstandard softkey template that you want to delete. See the "Deleting a Phone" section.

Procedure


Step 1 Find the softkey template by using the procedure in the "Finding a Softkey Template" section.

Step 2 From the list of matching records, choose the softkey template that you want to delete.


Note You can delete only softkey templates that display a check box in the left column. All other softkey templates represent standard, read-only templates.


The Softkey Template Configuration window displays.

Step 3 Click the Delete button.


Note You can delete multiple softkey templates from the Find and List Softkey Templates window by checking the check boxes next to the appropriate softkey templates and clicking Delete Selected. You can delete all softkey templates in the window by clicking Select All and then clicking Delete Selected.


A message verifies that you want to delete the template.

Step 4 Click the OK button.

The Softkey Template Configuration window redisplays with the softkey template deleted.


Additional Information

See the "Related Topics" section.

Updating a Softkey Template

Use this procedure to update a nonstandard softkey template that you created. You can update the template name, description, application softkeys that are supported, and the softkey layout.

Procedure


Step 1 Find the softkey template by using the procedure in the "Finding a Softkey Template" section.

Step 2 From the list of matching records, choose the softkey template that you want to update.


Note You can update only softkey templates that display a check box in the left column. All other softkey templates represent standard, read-only templates.


The Softkey Template Configuration window displays.

Step 3 Update the settings that you want changed (such as adding an application softkey set or the softkey layout). See the "Adding Application Softkeys to Nonstandard Softkey Templates" section and the "Configuring Softkey Positions in a Nonstandard Softkey Template" section.

Step 4 Click the Save button.

The Softkey Template Configuration window redisplays with the softkey template updated.


Note After making updates to a softkey template, you must restart devices that are using the template.


Step 5 To apply the updated softkey template, click the Restart Devices button.


Additional Information

See the "Related Topics" section.

Assigning Softkey Templates to IP Phones

You can assign softkey templates to IP Phones when the phones are configured. You can assign standard and nonstandard softkey templates. Two ways to assign a softkey template to a phone exist:

Assign the softkey template to a device pool (one that you create or the default) and then assign the device pool to the phone in the Phone Configuration window.

Assign the softkey template to the phone in the softkey template field in the Phone Configuration window.

For more information about configuring device pools and phones, refer to the "Device Pool Configuration" section and the "Configuring Cisco Unified IP Phones" section.

Related Topics

Finding a Softkey Template

Adding Nonstandard Softkey Templates

Modifying Softkey Templates

Renaming a Softkey Template

Deleting a Softkey Template

"Assigning Softkey Templates to IP Phones" section

Softkey Templates, Cisco Unified CallManager System Guide