Howto:Deploy Phone Function Key Configuration Using Update Server

From innovaphone-wiki

Jump to: navigation, search

Configuration for phone function keys in V6 (and later version) is stored in XML User Config on the phone. It is possible to deploy the key configuration to the phones by using Update Server.


Contents

Applies To

This information applies to

  • IP 110, V6
  • IP 200, V6
  • IP 230, V6

Build 06-60184 and later.

More Information

System Requirements

A V6 innovaphone IP Phone.

HTTP-Server or Compact Flash

Configuration

The configuration is done by placing command lines to the update script polled by phones.

SYNOPSIS:

mod cmd PHONE USER-UI/<reg_id> fkey-del /id=<reg_id> /fkey_id <key_id> /op OK

mod cmd PHONE USER-UI/<reg_id> fkey-edit /id=<reg_id> /fkey_id <key_id> /fkey_type <fkey_type> [function specific settings] /op OK

<reg_id> - registration id from 0 to 5
<key_id> - key id from 0 to 4 on IP110, 0-5 on IP200, 0-120 on IP230
<fkey_type> - type of the function key to create

Delete Funktion Key

To delete a function key use fkey-del command.

This line will delete key number 3 on registration 1:

mod cmd PHONE USER-UI/0 fkey-del /id=0 /fkey_id 2 /op OK

Use this command only in case you just want to delete a key, without placing new function on this place. Otherwise its possible just tu set a new function on one existing, without deletion.


Create Function Key

Creating the function key is made in the same way, except you have to add more options to the command line.


For example to create a Dial key on Registration 1, Key 7 use:

mod cmd PHONE/USER-UI/0 fkey-edit /id 0 /fkey_id 6 /fkey_type dial /label Franz  /dial.e164 12345 /op OK

Additional options that you can place in the line before /op OK are:

/dial.h323 Franz
/icon smiley
/dial.prepare on
/dial.announce on
/dial.dtmf on

Available Options

Since there a lot of different function keys and possible options for every function key given it is not applicable and not necessary to list all possible options here.

To determinate what command line you have to use in your particular case proceed as follows:


  • go to the phones web interface under Registration X->Function Keys
  • open a new browser window with the same phones web interface under Diagnostics->Logging and check "Config Changes" only and start the log
  • now add some function key you want to deploy over update server and click OK
  • check the syslog entries for line ending with /op OK, you will find something like this:
20080414-191003 CMD 192.168.0.99 mod cmd PHONE/USER-UI/0 fkey-edit /xsl fkey_edit_dial.xsl /cmd fkey-edit \
/op show /fkey_id 7 /fkey_type dial

20080414-191015 CMD 192.168.0.99 mod cmd PHONE/USER-UI/0 fkey-edit /xsl fkey_edit_dial.xsl /cmd fkey-edit /id 0 \
 /fkey_id 7 /fkey_type dial /label Franz /icon list /dial.e164 12345 /dial.h323 Franz /dial.prepare on \
 /dial.announce on /dial.dtmf on /op OK

20080414-191015 CMD 192.168.0.99 mod cmd PHONE/USER-UI/0 reg-edit-fkey /xsl reg_edit_fkey.xsl /cmd reg-edit-fkey
  • this line is your friend, copy and paste it to your update server script
  • remove red colored parts of the line:
20080414-191015 CMD 192.168.0.99 mod cmd PHONE/USER-UI/0 fkey-edit /xsl fkey_edit_dial.xsl /cmd fkey-edit \
 /id 0 /fkey_id 7 /fkey_type dial /label Franz /icon list /dial.e164 12345 /dial.h323 Franz \
 /dial.prepare on /dial.announce on /dial.dtmf on /op OK
  • so you have finally a disired command line like this:
mod cmd PHONE/USER-UI/0 fkey-edit /id 0 /fkey_id 7 /fkey_type dial /label Franz /icon list \
 /dial.e164 12345 /dial.h323 Franz /dial.prepare on /dial.announce on /dial.dtmf on /op OK

Usage in Update Script

Cause we want to execute the commands only one time we have to use mod cmd UP1 check command:

mod cmd UP1 check ser 20080330-01
mod cmd PHONE/USER-UI/0 fkey-edit /id 0 /fkey_id 5 /fkey_type dial /label Franz  /dial.e164 12345 /op OK
mod cmd PHONE/USER-UI/0 fkey-edit /id 0 /fkey_id 6 /fkey_type dial /label Sisi  /dial.e164 6789 /op OK
config write
config activate
iresetn

Related Articles

For a generic way to achieve all effects that can be achieved with the administrative GUI programmtically, see Howto:Effect arbitrary Configuration Changes using a HTTP Command Line Client or from an Update.

Personal tools