[Index]

Model: relation/SoftKeyTemplates

Softkey Templates

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

Introduction

Softkey templates manage softkeys that are used by the Cisco Unified CM IP Phones, for example 7970. There are two types of softkey templates:

VOSS Automate includes the following Unified CM system softkey templates, which cannot be modified or deleted:

A reseller administrator (or higher) can create customized softkey templates from the standard templates, make modifications as required and save them at the required hierarchy level, i.e. customer or higher.

How to Manage Customized Softkey Templates and Related Softkey Layout Configurations

Note

The following device models need to be imported from Unified CM post upgrade before Softkey Templates can be managed.

This can be done by either performing a full import of Unified CM or using the "CUCM Softkey Templates" Model Type List which is available from Release 19.3.1. See: Controlling a Data Sync with a Model Type List.

device/cucm/SoftKeyTemplate
device/cucm/SoftKey
device/cucm/SoftKeyCallState
device/cucm/SoftKeySet

  1. Browse to the required hierarchy.

  2. Click Add to add a new customized softkey template.

  3. From the Create a softkey template based on drop-down, choose an existing softkey template on which to base the customized template.

  4. Enter a unique Name and Description for the customized template. The description can be a maximum of 50 characters but cannot include ", %, &, <, or >.

  5. Select or clear the Is Default check box. If selected, this softkey template becomes the default standard softkey template.

  6. Click Save to save the customized softkey template and simultaneously add it to the Softkey Template list view.

  7. Select the newly created softkey template and configure the required softkey layout by modifying the designated softkeys for each call state.

    1. CUCM baseline softkey templates cannot be updated. Any change to such a template will result in a failed transaction.
    2. Some of the selected softkeys of the different call state are mandatory and cannot be removed from the CUCM standard set of templates. For example, template Standard User-Custom, Call State – On Hook, Softkey – NewCall.

    When a mandatory softkey is deleted, the transaction will be successful but the softkey will not be removed - when opening the template again it will still be there.

  8. Click Save when complete.

Note

To modify a customized softkey template, select it from the Softkey Template list view and update as described in the above procedure.

Before deleting a softkey template, which has been marked as Is Default, a different softkey template must first be set as Is Default.

This relation implements the workflows to manage SoftKey Templates.

Model Details: relation/SoftKeyTemplates

Title Description Details
Base Softkey Template Name *
  • Field Name: baseSoftkeyTemplateName
  • Type: String
  • Cardinality: [1..1]
Name *
  • Field Name: name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 100
Is Default
  • Field Name: isDefault
  • Type: Boolean
  • Cardinality: [0..1]
Description *
  • Field Name: description
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 100
Sks
  • Field Name: SKS
  • Type: Object
Name Not nullable.
  • Field Name: SKS.name
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 100
Call States
  • Field Name: callStates
  • Type: ["Object", "Null"]
  • Cardinality: [12..12]
Call State
  • Field Name: callState.[n]
  • Type: Array
  • Cardinality: [12..12]
Soft Keys List of mandatory keys for each callstate :: On Hook - NewCall Connected - End Call On Hold - Resume Off Hook - End Call Connected Transfer - Transfer Digits After First - Backward Connected Conference - Conference Ring Out - End Call Off Hook With Feature - End Call
  • Field Name: softKeys
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Soft Key
  • Field Name: softKey.[n]
  • Type: Array
Position Id Read-Only.The positionId has values starting with 0 and get incremented by 1 for each call state.
  • Field Name: SKS.callStates.callState.[n].softKeys.softKey.[n].positionId
  • Type: Integer
  • Cardinality: [0..1]
Softkey Name
  • Field Name: SKS.callStates.callState.[n].softKeys.softKey.[n].softKeyName
  • Type: String
  • Target: device/cucm/SoftKey
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Call State Name
  • Field Name: SKS.callStates.callState.[n].callStateName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Softkey Template Name
  • Field Name: SKS.softKeyTemplateName
  • Type: String
  • Cardinality: [0..1]
Add Call States
  • Field Name: addCallStates
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Call State
  • Field Name: callState.[n]
  • Type: Array
  • Cardinality: [1..n]
Soft Keys List of mandatory keys for each callstate :: On Hook - NewCall Connected - End Call On Hold - Resume Off Hook - End Call Connected Transfer - Transfer Digits After First - Backward Connected Conference - Conference Ring Out - End Call Off Hook With Feature - End Call
  • Field Name: softKeys
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Soft Key
  • Field Name: softKey.[n]
  • Type: Array
Position Id Read-Only.The positionId has values starting with 0 and get incremented by 1 for each call state.
  • Field Name: SKS.addCallStates.callState.[n].softKeys.softKey.[n].positionId
  • Type: Integer
  • Cardinality: [0..1]
Soft Key Name
  • Field Name: SKS.addCallStates.callState.[n].softKeys.softKey.[n].softKeyName
  • Type: String
  • Cardinality: [0..1]
Call State Name
  • Field Name: SKS.addCallStates.callState.[n].callStateName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Remove Call States
  • Field Name: removeCallStates
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Call State
  • Field Name: callState.[n]
  • Type: Array
  • Cardinality: [1..n]
Soft Keys List of mandatory keys for each callstate :: On Hook - NewCall Connected - End Call On Hold - Resume Off Hook - End Call Connected Transfer - Transfer Digits After First - Backward Connected Conference - Conference Ring Out - End Call Off Hook With Feature - End Call
  • Field Name: softKeys
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Soft Key
  • Field Name: softKey.[n]
  • Type: Array
Position Id Read-Only.The positionId has values starting with 0 and get incremented by 1 for each call state.
  • Field Name: SKS.removeCallStates.callState.[n].softKeys.softKey.[n].positionId
  • Type: Integer
  • Cardinality: [0..1]
Soft Key Name
  • Field Name: SKS.removeCallStates.callState.[n].softKeys.softKey.[n].softKeyName
  • Type: String
  • Cardinality: [0..1]
Call State Name
  • Field Name: SKS.removeCallStates.callState.[n].callStateName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]