Features/Mass Deployment/Setting Files/XML/Function Keys

From Snom User Wiki

Introduction

The function key settings XML (<functionKeys> or <function-keys>) tag contains the free programmable function key configuration parameters. This XML tag can be used either

• inside the <settings> tag or
• as an individual XML file whose URL is listed inside <setting-files> tag

Syntax

The following tags are equivalent:

• <functionKeys>
• <function-keys>

 <functionKeys>
  <fkey idx=="<function_key_index)>" context=="<function_key_context>" perm=="<permission flag>"><value></fkey>
  ...
  <fkey idx=="<function_key_index>" context=="<function_key_context>" perm=="<permission flag>"><value></fkey>
 </functionKeys>

• fkey tag contains a definition of one "Free Function Key":
  • idx string defines the free function key index n:
    • 0...n
    • n= {Number of integrated free function keys (snom300:6;snom320/360/370:12} + (Number of attached Expansion Modules * Number of expansion module keys))) - 1
    • n min (snom 320/360/370) = 11 (no expansion module attached)
    • n max (snom 320/360/370) = (12 + 3*Expansion Modules*42) -1 = 137 (3 expansion modules attached)
    • n min/max (snom300) = 5
  • context string defines the function_key_context
  • perm string defines the <permission flag>
  • value string defines the function key value

Example

• snom300 factory defaults:

<functionKeys>
 <fkey idx="0" context="active" perm="">line</fkey>
 <fkey idx="1" context="active" perm="">line</fkey>
 <fkey idx="2" context="active" perm="">keyevent F_REDIAL</fkey>
 <fkey idx="3" context="active" perm="">keyevent F_ADR_BOOK</fkey>
 <fkey idx="4" context="active" perm="">keyevent F_TRANSFER</fkey>
 <fkey idx="5" context="active" perm="">keyevent F_MUTE</fkey>
</functionKeys>

• snom3x0 with one Expansion Module (idx max = 53!!)

<functionKeys>
 <fkey idx=="0" context=="active" perm=="$">line</fkey>
 <fkey idx=="1" context=="1" perm=="&">dest &lt;sip:423@tst.org;user==phone&gt;</fkey>
 ...
 <fkey idx=="53" context=="12" perm=="!">line</fkey>
</functionKeys>