Panasonic KX-HDV Serie de Teléfonos SIP

Product Technical Document

XML Application Developer’s Guide

Panasonic SIP Phone KX-HDV100, KX-HDV130, KX-HDV230, KX-HDV330, KX-HDV430, KX-TGP600 (Revisión 2.50)

Panasonic Business México Nuevo Logotipo Negro 2019 Conmutador IP PBX y Servidores de Comunicaciones

Serie de teléfonos de escritorio SIP Panasonic KX-HDV

Panasonic Telefonos SIP Serie HDV para Conmutadores y Servidores de Comunicaciones

 


CONTENTS

1. INTRODUCTION

2. OVERVIEW

2.1.A GENERAL SYSTEM DIAGRAM (NETWORK PHONEBOOK)

2.1.1. Easy operation of SIP Server Call Control (e.g. DND/CFWD)

2.1.2. Network Phonebook system example

2.2. BASIC OPERATION

2.2. XML DATA ACCESS FLOW

2.3. AVAILABLE MEDIA FORMAT

2.4. DISPLAYING PRIORITY

2.5. DISPLAY AREA

3. HTTP SERVER INTERFACE

3.1. GET XMLDATA

3.1.1. Structure of HTTP Server

3.1.2. HTTP POST/GET Request/Response from the phone to HTTP Server

3.2. PUSH XML DATA

3.2.2. Push Event Process

3.3. HTTP SEQUENCE EXAMPLE

3.3.1. GET XML method

3.3.2. Push method

3.3.3. GET PhoneBook method

4. PHONE CONFIGURATION AND OPERATION

4.1. WEB USER INTERFACE SETTING LIST –CONFIGURATION PARAMETER

4.2. COMMON CONFIGURATION AND OPERATION

4.2.1. Configuration Parameter

4.2.2. Remarks of Softkey and FFkey Operation(*1)

4.3. INITIATION METHODS OF XML APPLICATION(*1)

4.3.1. Acquiring XML data corresponding to the Phone Status - Configuration

4.3.1.1. Configuration Parameter

4.3.2. Network Phone Book Configuration and operation

4.3.2.1. Configuration Parameter

4.3.2.2. Configuration Parameter (other than LDAP server)

4.3.2.3. Network Phonebook operations

4.3.3. Application Menu Configuration and operation

4.3.3.1. Configuration Parameter

4.3.3.2. Application Menu operations

4.3.4. Call Log Menu Configuration and operation

4.3.4.1. Configuration Parameter

4.3.4.2. Call Log key operations

4.3.5. Initiation Key Configuration and operation

4.3.5.1. Configuration Parameter

4.3.5.2. Initiation key operations

4.3.6. Redial key Configuration and operation

4.3.6.1. Configuration Parameter

4.3.6.2. Redial key operations

4.3.7. Cursor skip Configuration and operation

4.3.7.1. Configuration Parameter

4.3.7.2. Cursor skip operation

5. XML STRUCTURE

5.1. XML DOCUMENT

5.1.1. XML Schema of the phone

5.1.2. Name Space of XML Document

5.1.3. Character reference

5.1.3.1. Predefined Entities in XML

5.1.3.2. Numeric Character Reference

5.1.4. XML Object Outline

5.2. XML OBJECT DEFINITION

5.2.1. ppxml

5.2.2. Screen

5.2.3. Components

5.2.4. Label

5.2.5. PictureBox

5.2.6. TextBox

5.2.7. Menu

5.2.8. PhoneBook

5.2.9. Events

5.2.10. SoftKeys

5.2.11. FFKeys

5.2.12. PageKeys (*1)

5.2.13. SetVariables

5.2.14. Timer

5.2.15. Execute

5.2.16. Trigger

5.2.17. Redialkey

6. APPENDIX

6.1. ERROR CODE REFERENCE

6.2. EDITING XML CONTENTS ON THE PC

 


ATTENTION

- This document is copyrighted by Panasonic System Networks Co., Ltd. (“PSN”) or its licensor, and is protected by the copyright laws and international treaty provisions, and all other applicable laws.

- All contents of this document are subject to change without notice.

- THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT ANY WARRANTY. PSN AND ITS AFFILIATE COMPANIES (“PANASONIC”) DOES NOT MAKE OR PASS ON TO YOU OR OTHER THIRD PARTY, ANY WARRANTY OR REPRESENTATION INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, PANASONIC DOES NOT WARRANT THAT THIS DOCUMENT WILL BE ERROR-FREE OR THAT IT WILL

MEET YOUR REQUIREMENTS. PANASONIC SHALL NOT BE LIABLE FOR ANY DAMAGE

SUFFERED BY YOU OR OTHER THIRD PARTY INCLUDING, BUT NOT LIMITED TO, CONSEQUENTIAL, INCIDENTAL, SPECIAL OR PUNITIVE DAMAGES, EVEN IF PANASONIC HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

 

1. Introduction

This document has described the technical information and specification for the XML application development of the TGP600, HDV100/130/230/330/430 (Represents as TGP/HDV).

The corresponding Administrator Guide Document Version is from 2016 and depends on each model.

It is able to acquire the latest firmware and the related documents from the following URL.

http://panasonic.net/pcc/support/sipphone/

 

2. Overview

2.1. A general System Diagram (Network Phonebook)

Various types of applications such as following examples can be developed by using XML API.

 

2.1.1. Easy operation of SIP Server Call Control (e.g. DND/CFWD)

 

2.1.2. Network Phonebook system example

 

2.2. Basic Operation

The phone translates XML data and generates GUI.
1) Parses XML data by using XML parser and analyze the meaning.
2) Creates Window for screen.
3) Prepare components.
    Attach event handler and action function.
    Create component image.
4) Place components on Window.
5) Show Window.

 

2.2. XML Data Access Flow

There are two methods to access XML Data.

 

2.3. Available Media Format

The following are available media format which can be supported in the phone. It is recommended to adjust the media quality/size suitably beforehand.

Media

Type

Format

Total Size Max.

Model

Remarks

Picture

BMP

4bit grayscale (The color palette is not supported.)

132 x 64pixels

HDV130/230

Picture is displayed with

BW. (Black&White)

Picture

BMP

8 / 16 / 24bit

480 x 245pixels

HDV330/430

Picture is displayed as a

256 Color/High Color/

True Color

Text

TXT

UTF-8 plain text

128bytes

(Depends on

Models)

Character references are not supported except specific cords.

 

2.4. Displaying priority

The displayed objects are always overwritten in postscript information.

 

2.5. Display Area

HDV100/130/230 (4 line)

TGP600 (6 line)

HDV330/430 (6 line)

 

3. HTTP Server Interface

3.1. Get XML Data

3.1.1. Structure of HTTP Server

HTTP Server is installed in followings:
1) PC Server
2) Appliance Server
HTTP Server usually manages following directory. 

Static XML file. "Template" XML files may be prepared. "Template" means that almost definitions are static and only the part is replaced dynamically.

CGI for the phone usually processes along following steps.

 

3.1.2. HTTP POST/GET Request/Response from the phone to HTTP Server.

[HTTP POST/GET Request]
The phone sends HTTP POST/GET request to HTTP Server as the result of “SendRequest" Action. The format of HTTP POST/GET request is same as ordinary HTTP POST/GET request.

<Note1>
There are some values reserved values by the phone.
These values are automatically replaced by the phone and sent to HTTP Server.

[HTTP POST/GET Response]
TGP/HDV receives HTTP response including XML data from HTTP Server.

 

3.2. Push XML Data

3.2.1. Push Mechanism

Push may be kicked by PC Client which operator uses.
Push is achieved with 2 steps.
First step is to send trigger.
Second step is to get XML data. (This is same as the description of "Get XML data".)
HTTP Server sends a Link XML data as Trigger, which describes the behavior of TGP/HDV, to "Push Port" by using HTTP POST.
When TGP/HDV catches the Link XML data, TGP/HDV executes Push Event process. 

 

3.2.2. Push Event Process

When considering from the phone side, this process is separated to 2 phases. (Processing Trigger and Processing Service Content.)

This phase processes a trigger.
A TCP/IP connection is kept during following flow.

3.3. HTTP Sequence Example

The followings are some HTTP sequence example for reference. *For example: KX-HDV330

3.3.1. GET XML method

 

3.3.2. Push method

3.3.3. GET PhoneBook method

4. Phone Configuration and Operation

4.1. Web User Interface Setting List – Configuration Parameter

Network * For example: KX-HDV230

Menu Item

Section Title

Setting

 

Configuration Parameter

XML Application Settings

XML Application

Enable XMLAPP

 

XMLAPP_ENABLE

User ID

 

XMLAPP_USERID

Password

 

XMLAPP_USERPASS

Local XML Port

 

XML_HTTPD_PORT

Bootup URL

(*2)

XMLAPP_START_URL

Initial URL      

(*2)

XMLAPP_INITIAL_URL

Incoming Call URL

(*2)

XMLAPP_INCOMING_URL

Talking URL

(*2)

XMLAPP_TALKING_URL

Making Call URL

(*2)

XMLAPP_MAKECALL_URL

Call Log URL

(*2)

XMLAPP_CALLLOG_URL

Idling URL

(*2)

XMLAPP_IDLING_URL

Enable FF Key

(*2)

XMLAPP_FFKEY_ENABLE

Shortcut Key Settings (*1)

Soft Key A(Left)

 

XML_INITIATE_KEY_SOFT1

Soft Key B(Center)

 

XML_INITIATE_KEY_SOFT2

Soft Key C(Right)

 

XML_INITIATE_KEY_SOFT3

XML Phonebook

LDAP URL

 

XMLAPP_LDAP_URL

User ID

 

XMLAPP_LDAP_USERID

Password

 

XMLAPP_LDAP_USERPASS

Max Hits

 

XMLAPP_LDAP_MAXRECORD

Note.
(*1) HDV330/430 doesn’t support Shortcut Key Settings, since there are no Initiation Key.
(*2) Supported only HDV130/230/330/430.

 

4.2. Common Configuration and Operation

It is necessary to set this configuration parameter for activating XML application feature.

4.2.1. Configuration Parameter

Configuration parameters are as follows.

Configuration Parameter

Description

Format

Value Range

Default Value

XMLAPP_ENABLE

Set “Y” for activating XML application feature.

Boolean

Y/N

N

XMLAPP_USERID

Specify user ID for XML server authentication

String

Max. 128 characters

Empty

String

XMLAPP_USERPASS

Specify the Password for XML server authentication

String

Max. 128 characters

Empty

String

XML_HTTPD_PORT

Specify listen port number for receiving XML push event from XML server.

Integer

1 to 65535

6666

XML_ERROR_INFORMATION

Set “N” in order to inhibit displaying error information on the phone’s LCD.

Boolean

Y/N

Y

If it is necessary to access secure to the network phonebook server, it is able to use HTTPS protocol instead of HTTP.
For that, it is necessary to compose the following parameters in the addition. (C.f. Admin Guide)

Configuration Parameter

Description

Format

Value Range

Default Value

HTTP_SSL_VERIFY

Specifies whether to enable the verification of the root certificate.

-  0 (No verification)

-  1 (Simple verification)

-  2 (Precise verification

Integer

0~2

0

CFG_ROOT_CERTIFICATE_PATH

Specifies the URI of the root certificate.

String

Max.384 characters

Empty

String

 

4.2.2. Remarks of Softkey and FFkey Operation (*1)

When XML contents are displayed, Softkeys and FFkeys are controlled according to its XML definition.
It means default Softkey and FFkey for phone use cannot be used in the XML contents.
It is able to exit from XML contents by using following methods.
- Press [Cancel] button.
- Off hook the handset
- [SP-PHONE] On.

Note. (*1) HDV330/430 are supported only FFKey Operation.TGP600 and HDV100 are not supported.

Configuration Parameter

Description

Format

Value Range

Default Value

XML_SOFT_KEY_NAMEx

x=1-3

Specifies the name of Soft Key A/B/C assigned XML application.

String

Max.16 characters

Empty

String

 

4.3. Initiation methods of XML application (*1)

The phone has six types of methods to access XML contents as follows.
- Phone Status (4.3.1)
- Phonebook menu (4.3.2)
- Application menu (4.3.3)
- Call log key (4.3.4)
- Initiation key (4.3.5)
- Redial key (4.3.6)
Please refer to each section for more detail.
Note. (*1) Supported only HDV130/230/330/430.

4.3.1. Acquiring XML data corresponding to the Phone Status - Configuration

It is able to acquire specified XML data linked to the status of the phone.
For example, company logo bitmap is display when the phone goes idle status.
Operations depend on the each XML data.

4.3.1.1. Configuration Parameter

Configuration parameters are as follows.

Configuration Parameter

Description

Format

Value Range

Default Value

XMLAPP_START_URL

Specify the XML URL to acquire when the phone starts up.

It is useful for displaying startup logo.

This is only once when the phone starts.

String

Max. 256 characters

Empty

String

XMLAPP_INITIAL_URL

Specifies the URL that is accessed when the application is started from the unit's menu, to check for XML data.

XMLAPP_INCOMING_URL

Specify the XML URL to acquire when the phone receives a call.

XMLAPP_TALKING_URL

Specify the XML URL to acquire when the phone goes talking.

XMLAPP_MAKECALL_URL

Specify the XML URL to acquire when the phone goes off-hook.

XMLAPP_CALLLOG_URL

Specifies the URL that is accessed when the call log is accessed, to check for XML data.

XMLAPP_IDLING_URL

Specify the XML URL to acquire when the phone is idle state.

It is useful for displaying company logo in the idle state.

XMLAPP_FFKEY_ENABLE

Specifies whether to use the XML application or operate normal telephone when the corresponding button is pressed. (FF Key and Page Key)

Y: XML Mode

N: Normal Telephone Mode

Boolean

Y/N

N

XMLAPP_STATUSBAR_ENABLE  

(*1)

Selects whether to enable or disable “Icon, Text, Clock on the Status Bar XML application feature.

Y: Enable Display “Icon, Text, Clock”  on Status Bar

N: Disable

Boolean

Y/N

Y

(*)It is not possible to notify internal variables, such as originating call number, to XML server dynamically. Note. (*1) Only HDV330/430 supports the “XMLAPP_STATUSBAR_ENABLE”

4.3.2. Network Phone Book Configuration and operation

It is able to use embedded “Network Phone Book “menu by configuring according to this section.

4.3.2.1. Configuration Parameter

Configuration parameters are as follows.

Configuration Parameter

Description

Format

Value Range

Default Value

XMLAPP_LDAP_URL

URL for Phonebook proxy server If the fixed parameters are necessary, you should include CGI parameter in this URL.

e.g.)

XMLAPP_LDAP_URL=”http://192.168.1.

10/get_ldap.cgi?model=hdv330

&max_rec=20”

String

Max.256 characters

Empty

String

XMLAPP_LDAP_USERID (*1)

ID for LDAP server connection. This parameter is automatically added to LDAP URL as a CGI parameter.

String

Max. 128 characters

Empty

String

XMLAPP_LDAP_USERPASS (*1)

Password for LDAP server connection. This parameter is automatically added to LDAP URL as a CGI parameter.

String

Max. 128 characters

Empty

String

XMLAPP_LDAP_MAXRECORD

Specifies the maximum number of search results to be returned by the LDAP server

Integer

20 to 500

20

Note. (*1) This function is supported by TGP600/HDV100/HDV130/HDV230/HDV330/HDV430.

 

4.3.2.2 Configuration Parameter (other than LDAP server)

Configuration parameters are as follows.

Configuration Parameter

Description

Format

Value Range

Default Value

XML_PHONEBOOK_URL

Specifies the URL for XML Phonebook file that is accessed.

String

Max.256 characters

Empty

String

XML_PHONEBOOK_CYCLIC_INT

VL

Specifies the interval, in minutes, between periodic checks for updates of the XML Phonebook  files. When the parameter is set to '0', the timing is the same updating of the configuration files.

Integer

0,

1 to 40320

0

Note. This function is supported by TGP600/HDV130/HDV230/HDV330/HDV430.

The further information of the XML file format is described on the

4.3.2.3. Network Phonebook operations

<TGP600, HDV100/HDV130/230>
The network phonebook operations are almost same as embedded local phonebook operations by using PhoneBook element. Please refer to the Operating Instructions for detailed operation of phonebook. (It is also possible to construct different user interface originally by using another element.)

If the above parameters are set, the following menu is displayed when the user press  key.

Please select [Remote Phonebook] menu, and press key.
Then the phone accesses to the phonebook server with the following URL.

http://192.168.0.10/get_ldap.cgi?model=hdv230&max_rec=20&name=

Note) ‘&name=’ part is added by the phone automatically. This name parameter is set for name query. 
However query parameter is set null in the first access.
The front part is same as configuration parameter.

 

If the query word is entered and pressed key, the phone access to the phonebook server with the following URL.

http://192.168.0.10/get_ldap.cgi?model=hdv230&max_rec=20&name=James

If there are acquiring data, the following screen is displayed.

If there are no acquired data, the following screen is displayed.

It is able to display acquired data by using [] or [ key.
It is able to search that key is pressed and please enter the search words.

<HDV330/430>

The network phonebook operations are almost same as embedded local phonebook operations by using PhoneBook element. Please refer to the Operating Instructions for detailed operation of phonebook.
(It is also possible to construct different user interface originally by using another element.)

If the above parameters are set, the [Phonebook] menu is displayed at the Top Menu.

Please select [Phonebook] menu, and press icon.

Then the phone accesses to the phonebook server with the following URL.

http://192.168.0.10/get_ldap.cgi?model=hdv330&max_rec=20&name=

Note) ‘&name=’ part is added by the phone automatically. This name parameter is set for name query.
However query parameter is set null in the first access.
The front part is same as configuration parameter.

If there are phonebook data in the Network Phonebook, the following screen is displayed.

If there are not phonebook data in the Network Phonebook, the following screen is displayed.

If [Search] icon or [Edit Box] icon is tapped, the following screen is displayed.

If the query word is entered and tapped icon, the phone access to the phonebook server with the following URL.

http://192.168.0.10/get_ldap.cgi?model=hdv330&max_rec=20&name=James

If there are acquiring data, the following screen is displayed.

If there are no acquired data, the following screen is displayed.

It is able to display acquired data by using or icon.
It is able to search that  [search] icon is pressed and please enter the search words.

4.3.3. Application Menu Configuration and operation

4.3.3.1. Configuration Parameter

Configuration parameters are as follows.

Configuration Parameter

Description

Format

Value Range

Default Value

XMLAPP_INITIAL_URL

Specify the XML URL to acquire when the XML application starts up from [Application] menu.

*<HDV330/430>

[Application] menu

String

Max. 256 characters

Empty

String

 

4.3.3.2. Application Menu operations

<HDV130/230>
If the configuration parameter, “XMLAPP_INITIAL_URL”, is specified, the [Application] menu is displayed at  the bottom of setting menu.

<HDV330/430>
If the configuration parameter, “XMLAPP_INITIAL_URL”, is specified, the [Application] menu is displayed at the bottom of Top menu.

When [Application]menu is selected, the phone access to the URL which is specified in the XMLAPP_INITIAL_URL configuration parameter.
After that, it is able to construct various UI by using XML application interface.

 

4.3.4. Call Log Menu Configuration and operation

4.3.4.1. Configuration Parameter

Configuration parameters are as follows.

Configuration Parameter

Description

Format

Value Range

Default Value

XMLAPP_CALLLOG_URL

Specify the XML URL to acquire when the [Call Log] menu is selected.

*<HDV330/430>

[Call History] menu

String

Max. 256 characters

Empty

String

 

4.3.4.2. Call Log key operations

<HDV130/230>
If the configuration parameter, “XMLAPP_CALLLOG_URL”, is specified, and when key is pressed, the phone access to the above-mentioned URL.

<HDV330/430>

If the configuration parameter, “XMLAPP_CALLLOG_URL”, is specified, and when [Call History] icon is pressed, the phone access to the above-mentioned URL.

After that, it is able to construct various call log UI by using XML application interface.

4.3.5. Initiation Key Configuration and operation

4.3.5.1. Configuration Parameter

Configuration parameters are as follows.

Model: HDV130
The phone can access to initial URl by press softkey or program(flexible) key.

Configuration Parameter

Description

Format

Value Range

Default Value

XML_INITIATE_KEY_SOFT1

Enables initiation of XML application from Soft Key1.

Key information : SOFT1

Boolean

Y/N

N

XML_INITIATE_KEY_SOFT2

Enables initiation of XML application from Soft Key2.

Key information : SOFT3

Boolean

Y/N

N

XML_INITIATE_KEY_SOFT3

Enables initiation of XML application from Soft Key3.

Key information : SOFT3

Boolean

Y/N

N

FLEX_BUTTON_FACILITY_ACT1

Enables initiation of XML application from Program Key1.

Key information : PK1

String

*1

Null

FLEX_BUTTON_FACILITY_ACT2

Enables initiation of XML application from Program Key2.

Key information : PK2

String

*1

Null

Model: HDV230
The phone can access to initial URL by press softkey/ flexblekey/DSS key

Configuration Parameter

Description

Format

Value Range

Default Value

XML_INITIATE_KEY_SOFT1

Enables initiation of XML application from Soft Key1.

Key information : SOFT1

Boolean

Y/N

N

XML_INITIATE_KEY_SOFT2

Enables initiation of XML application from Soft Key2.

Key information : SOFT3

Boolean

Y/N

N

XML_INITIATE_KEY_SOFT3

Enables initiation of XML application from Soft Key3.

Key information : SOFT3

Boolean

Y/N

N

FLEX_BUTTON_FACILITY_ACTx

(X=1-24)

Enables initiation of XML application from Flexible key(1-24).

Key information : FF1 - FF24

String

*1

Null

DSS_BUTTON_FACILITY_ACTx

(x=1-200)

Enables initiation of XML application from DSS key(1-200).

Key information : DSS1 - 200

String

*1

Null

Model:HDV330/430
The phone can access by pressed flexblekey/DSS key

Configuration Parameter

Description

Format

Value Range

Default Value

FLEX_BUTTON_FACILITY_ACTx

(X=1-24)

Enables initiation of XML application from Flexible key(1-24).

Key information : FF1 - FF24

String

*1

Null

DSS_BUTTON_FACILITY_ACTx

(x=1-200)

Enables initiation of XML application from DSS key(1-200).

Key information : DSS1 - 200

String

*1

Null

*1 Set “X_PANASONIC_IPTEL_APPLICATION”(string) to this parameters,

4.3.5.2. Initiation key operations

If the configuration parameter, “XMLAPP_INITIAL_URL”, is specified, and if the above-mentioned parameter is set to “Y” or “X_PANASONIC_IPTEL_APPLICATION” , when the corresponding key is pressed, the phone accesses to the URL, “XMLAPP_INITIAL_URL”, adding CGI parameter of initiation key information.

e.g.)

Model: HDV130
HTTP GET /xmlpath/xmlapl.cgi ?initiationkey=SOFT1
or
HTTP GET /xmlpath/xmlapl.cgi ?initiationkey=PK1

Model: HDV230
HTTP GET /xmlpath/xmlapl.cgi ?initiationkey=SOFT1
or
HTTP GET /xmlpath/xmlapl.cgi ?initiationkey=FF1
or
HTTP GET /xmlpath/xmlapl.cgi ?initiationkey=DSS1

Model: HDV330/430
HTTP GET /xmlpath/xmlapl.cgi ?initiationkey=FF1
or
HTTP GET /xmlpath/xmlapl.cgi ?initiationkey=DSS1

This operation is only effective in the idle state of the phone.

4.3.6. Redial key Configuration and operation

4.3.6.1. Configuration Parameter

Configuration parameters are as follows.

Configuration Parameter

Description

Format

Value Range

Default Value

XMLAPP_URL_REDIAL_KEY

Specify the XML URL to acquire when the [REDIAL] key is selected.

String

Max. 256 characters

Empty

String

4.3.6.2. Redial key operations

<HDV130/230/330/430>
If the configuration parameter, “XMLAPP_URL_REDIAL_KEY”, is specified, and when [REDIAL]key is pressed, the phone access to the above-mentioned URL.

4.3.7. Cursor skip Configuration and operation

4.3.7.1. Configuration Parameter

Configuration parameters are as follows.

Configuration Parameter

Description

Format

Value Range

Default Value

XML_CURSOR_SKIP_ENABLE

Enables skip first line to display cursor, when showing XML Menu.

Boolean

Y/N

N

4.3.7.2. Cursor skip operation

Please refer 5.2.7.

5. XML Structure

5.1. XML Document

XML Document is consisted of XML declaration and instance. XML Document file has ".xml" extension.

[XML Declaration]
XML version and character set are described.  See below.

<?xml version="1.0" encoding="utf-8"?>

XML version must be "1.0".
Character set must be "UTF-8".

[XML Instance]
XML data defined by this document are described.

5.1.1. XML Schema of the phone

There are following XML schema which defines words and types, formats of all XMLobject.
XML schema file has ".xsd" extension and uses "http://www.w3.org/2001/XMLSchema" namespace. These schema files should be copied onto the same folder as the XML contents folder for editing.

NO

Schema File (.xsd)

Description

1

sip_phone

Common schema for all xml contents

2

value_restrict.xsd

This definition is included from sip_phone

3

common.xsd

This definition is included from sip_phone

4

Events.xsd

This definition is included from sip_phone

5

ppxml_contents.xsd

This definition is included from sip_phone

6

Key.xsd

This definition is included from sip_phone

7

Screen_object.xsd

This definition is included from sip_phone

 

5.1.2. Name Space of XML Document

Name Space is declared in ppxml node.
XML document uses each XML schema of the phone corresponding to itself.
The formula is following:

Userhas to change the description of A) and C) corresponding to target xml data.

5.1.3. Character reference

5.1.3.1. Predefined Entities in XML

The XML specification defines five "predefined entities" representing special characters, and requires that all XML processors honor them.

The table below lists the five XML predefined entities.
The "Name" column mentions the entity's name.
The "Character" column shows the character, if it is renderable. In order to render the character, the format &name; is used; for example, &amp; renders as &
The "Description" column cites the character via its canonical UCS/Unicode name, in English.

Character

Name

Description

"

&quot;

Quotation mark

&

&amp;

Ampersand

'

&apos;

Apostrophe

<

&lt;

Less-than sign

>

&gt;

Greater-than sign

 

5.1.3.2. Numeric Character Reference

A numeric character reference refers to a character by its Unicode (UTF-8) code point, and uses the following format

&#nnnn;
&#xhhhh;

nnnn is the code point in decimal form, and hhhh is the code point in hexadecimal form. The x must be lowercase in XML documents. The nnnn or hhhh may be any number of digits and may include leading zeros. The hhhh may mix uppercase and lowercase.

 

5.1.4. XML Object Outline

The following table is an outline of main XML objects.

Element

Functionality

ppxml

Root element

Screen

Screen object is same as Window of UI.

 

Components

Components object is correction of UI control object mainly.

 

Label

It displays the text string, date-time. (*1)

PictureBox

It displays BMP format data.

TextBox

It enables the user to enter and modify the text.

Softkeys

Soft keys definition.

FFKeys

FF keys definition.

Pagekeys

Page keys definition. 

Menu

It displays Menu items.

PhoneBook

It displays Network Phonebook using built in phonebook UI. (*1)

Softkeys

Soft keys definition.

FFKeys

FF keys definition.

Pagekeys

Page keys definition. (*2)

Events

Events are an object to catch events. Events can also have some "Actions".

Timer

It is able to define timer period and actions at the expiration. (*1)

Softkeys

Soft keys definition. 

FFKeys

FF keys definition. 

Pagekeys

Page keys definition. (*2)

Redialkey

Redial key definition.

Trigger

It is used for the Push Service initiated from the server. (*1)

SetVariables

It provides the global variable which is available until rebooting.

Execute

Execute defines the operations (Reboot, SetXmlMode).

Note.
(*1): TGP600 supports only these elements.
(*2): HDV230/330/430 supports only these elements.

*Screen version: TGP600 - 2.0, HDV100/130/230/330/430 - 2.0/3.0
*Trigger version: TGP600 - 2.0, HDV100/130/230/330/430 - 2.0/3.0

5.2. XML Object Definition

[Common Rule / Condition]

Item

Rule / Condition

Note

m/o

‘m/o’ means ‘mandatory / optional’.

element / attribute

Describe the capital letter and the small letter accurately regarding the elements and attributes.

name attribute

Only alphabets and numerals {A-Z, a-z, 0-9} can be used in the name attribute.

All punctuation marks (!”#$%&’()-+=~/<>*...), space, and underscore cannot be used.

It should be unique over the entire xml contents. Especially, the name of the following elements must be absolutely unique.

Screen, Label, PictureBox, Textbox, SoftKey, FFKey, PageKey, Timer

Operation by hard key

The object operation with a hard key is invalid if there is no special description.

5.2.1. ppxml

[Overview]
"ppxml" object is root element.
This element is mandatory to define XML data.

[Definition]

Child Element

Attribute

Value

m/o

xmlns

http://panasonic/sip_phone

m

xmlns:xsi

http://www.w3.org/2001/XMLSchema-instance

m

xsi:schemaLocation

http://panasonic/sip_phone sip_phone.xsd

m

Screen

*Please refer to the element definition

o

Trigger

*Please refer to the element definition

o

SetVariables

*Please refer to the element definition

o

SoftKeys

*Please refer to the element definition

o

FFKeys

*Please refer to the element definition

o

PageKeys

*Please refer to the element definition

o

Execute

*Please refer to the element definition

o

Redialkey

*Please refer to the element definition

o

[Syntax]

<?xml version="1.0" encoding="utf-8"?>

<ppxml xmlns="http://panasonic/sip_phone"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://panasonic/sip_phone sip_phone.xsd">
<Screen>
<!-- Describe XML items -->
</Screen>
<SetVariables>
<SetVariable key="@MyNameSystemWideValue" value="MyName" />
</SetVariables>
</ppxml>

[LCD Image]
None

5.2.2. Screen

[Overview]
Screen object is same as Window of GUI.
This can have some components.

[Definition]


Note. (*1) .TGP600 supports only Version 2.0.

[Syntax]

<?xml version="1.0" encoding="utf-8"?>

<ppxml
xmlns="http://panasonic/sip_phone"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://panasonic/sip_phone sip_phone.xsd">

<Screen name="Screen1" version="3.0">
<Components>
<!-- Describe XML items -->
</Components>
</Screen>

</ppxml>

[LCD Image]
None

5.2.3. Components

[Overview]

Components object is correction of GUI control object mainly.

All GUI controls (Button, Checkbox etc.) are optional.
Components are optional for main XML screen.
As for popup/dialog "Components" are mandatory.

[Definition]

Child Element

m/o

Functionality

Label

o

It displays the text string

(TGP600 up to 16 strings/ HDVseries up to 32strings)

PictureBox

o

It displays BMP format data.

TextBox

o

It enables the user to enter and modify the text.

SoftKeys

o

Button is an object pushed by user.

FFKeys

o

Almost same as Button. Added attributes(border,margin,text)

PageKeys

o

It selects one from a mutually exclusive set of options.

Redialkey

o

When the user pushes the REDIAL key, the phone access to the outgoing log data that are stored on the XML server.

[Syntax]

<?xml version="1.0" encoding="utf-8"?>

<ppxml
xmlns="http://panasonic/sip_phone"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://panasonic/sip_phone sip_phone.xsd">

<Screen name="Screen1" version="3.0">
<Components>
<Label name="Label1" line="2" text="Label1" textAlignment="Left"area="Phone" />
<TextBox name="TextBox2" area="Phone" line="3" text="TextBox2" textAlignment="Left" />
<PictureBox name="PictureBox1" left="0" top="0" width="120" height="55" source="http://aaa/bbb/ccc/pic1.bmp" />
</Components>
</Screen>
<7/ppxml>

[LCD Image]
None

[Note]
In the following model, PictureBox of above [Syntax] is as follows.
<HDV330/430> * Height of status bar is 27 pixels.

<PictureBox name="PictureBox1" left="0" top="27" width="120" height="55" source="http://aaa/bbb/ccc/pic1.bmp" />

5.2.4. Label

[Overview]

A label is a user interface control which displays text on a form. It is usually a static control; having no interactivity.
A label is generally used to identify a nearby text box or other widget.

Label is able to display single line. Multiple line text can't.

Actual string display priority of label is shown as below:
Highest priority = showDateTime
Lowest priority = text

[Definition]

[Syntax]

[Displayable Area]

[4 line model]
<HDV130/230>

[6 line model]
<HDV330/430>

 

5.2.5. PictureBox

[Overview]
By using Picture Box, phone can display Images with BMP format data. It is able to display company logo.

[Syntax]

[Note]
In the following model, PictureBox of above [Syntax] is as follows.
<HDV330/430> * Height of status bar is 27 pixels.

5.2.6. TextBox

[Overview]
By using Text Box, user can enter and modify the text.
Text Box can enter single line text.
Password characters can be masked by '*'.

Input / modification of text box can be done through phone key operation.
The value input by Text Box can be sent to pre specified URL when user press [ENTER] Key.

[Definition]

 

[Syntax]

In the following model, TextBoxof above [Syntax] is as follows.
<HDV330/430>Soft key ID is 3
<SoftKey id="3" name="sk3" text="OK">

[Displayable Area]

[Displayable Area]

[4 line model]
<HDV130/230>

[6 line model]
<HDV330/430>

[LCD Image]
<HDV130/230> >
mode = 1 : Character 

mode = 0 : Number

<V330/430>
mode = 1 : Character

mode = 0 : Number

[Note]
<HDV130/230>
-Text box can be used as Only 1 line.
-Line number 2 ~ 3 is available to display input Text Box
-The maximum length can be input is the length phone can display in 1 line.

<HDV330/430>
-Text box can be used as Only 1 line at title bar. However, it could be changed as "Edit".
For example, <TextBox name="textBox1" -> “Edit” at title bar.
-The maximum length can be input is the length phone can display in 1 line.
32 characters / 1 line
24 characters / 1 text (Title bar)

HDV330/430 ignore designation of softkey. Always treat softkey3 as “OK”.

5.2.7. Menu

[Overview]
"Menu" element is able to link with flexible function key. When push the key, the phone will access to the defined url.
"Menu" element is used in Phone display area.

[Definition of Key Actions]

Key

Action of the key

Navigator keys

Only Up & Down key; move selecting item

Enter key

Select the item and execute it

Soft keys

Define soft key's action in XML content

A user can select the menu item to use navigation key (up & down) and execute it to use enter key.
Selecting item displays with monochrome reversed character at the line, which only in phone area.
The item top on the left side will be monochrome reversed when after moving menu page. FF keys and Soft keys have to be defined the action in XML content.

[Definition]

[Syntax]

[Displayable Area]

[4 line model]
<HDV130/230>

[6 line model]
<HDV330/430>

[LCD Image]
<HDV130/230>

<HDV330/430>

<HDV130/230> [4 line model]

<HDV330/430> [6 line model]

5.2.8. PhoneBook

[Overview]
It is able to perform the same operability as embedded phonebook to the network phonebook by using this element.

[Definition]

[Syntax]

[LCD Image]
c.f. 4.3.2.2. Network Phonebook Operations

5.2.9. Events

[Overview]
Events are an object to catch events.
The trigger of Events is raised from following cases:

- Normal Event:Respond to a user operation for components.

An event can have some "Actions".
Action is an object to define a process for an event.
An event can have the plural Actions. Each Action is sequentially executed. (The maximum actions allowed to 5, per event.)

[Definition]

[Syntax]

 

[Operations]

[SendRequest]

SendRequest is used to get XML data from Web Server.

SendRequest sends "HTTP GET Request" which has some parameters.

The format of the parameter is same as one of the <FORM> tag.

Components which can be the parameter are followings.

Components

Parameter Name

Parameter Value

TextBox

name

String

The scope of Names and Values which are sent by "SendRequest" is <Screen>.

[Restrictions]

1.         When a button is clicked, a new thread is created to process the actions.

If the actions have not completed, clicking the same button has no effect.

If the actions have not completed, clicking another button/control will trigger another button/control's actions.

2.         If multiple actions are declared within a button, the actions will always be executed in sequential manner.Asynchronize action must also be completed before next action can start.

[Reboot actions]

Reboot actions can be defined as following types.

Though these actions are processed as normal action, <Trigger> may be sent from Web Server by PUSH.

[Type 1]

<?xml version="1.0" encoding="utf-8"?>

<ppxml

xmlns="http://panasonic/sip_phone"

    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://panasonic/sip_phone sip_phone.xsd">

<Screen version=“3.0”>

<Events>

<OnHangup>

<Reboot />

</OnHangup>

</Events>

</Screen>

</ppxml>

[Type 2]

<?xml version="1.0" encoding="utf-8"?>

<ppxml

xmlns="http://panasonic/sip_phone"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://panasonic/sip_phone sip_phone.xsd"><Screen version="3.0">

<Timer name="Timer1" interval="60" repeat="false">

<Events>

<OnExpired>

          <Reboot />

</OnExpired>

</Events>

</Timer>

</Screen>

</ppxml>

[Type 3]

<?xml version="1.0" encoding="utf-8"?>

<ppxml

xmlns="http://panasonic/sip_phone"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://panasonic/sip_phone sip_phone.xsd">

<Execute>

<SetXmlMode mode="on" />

<Reboot />

</Execute>

</ppxml>

[Type 4]

<?xml version="1.0" encoding="utf-8"?>

<ppxml

xmlns="http://panasonic/sip_phone"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://panasonic/sip_phone sip_phone.xsd">

<Screen name="Screen1" version=“3.0”>

<Menu name="MainMenu" area="Phone">

<MenuItems>

<MenuItem name="Item4" text="222" id="5">

          <Events>

        <OnClicked>

              <Reboot />

            </OnClicked>

          </Events>

</MenuItem>

</MenuItems>

</Menu>

</Screen>

</ppxml>

5.2.10. SoftKeys

[Overview]

"SoftKeys" element has to include one or more "SoftKey" elements.

"SoftKey" element can define in the "Screen" or "Menu" element.

It will not act anything, when pushing Softkey which is not assigned any feature(URL) in XML application mode.

[Definition]

[Syntax]

Soft Key with “Cancel”.

<?xml version="1.0" encoding="utf-8"?>

<ppxml

xmlns="http://panasonic/sip_phone"

    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://panasonic/sip_phone sip_phone.xsd">

<Screen version="3.0">

<Components>

<SoftKey id="3" name="sk3" text="Cancel">

<Events>

          <OnClicked>

            <SendRequest url="http://192.168.0.200/Cancel.xml" />

          </OnClicked>

</Events>

</SoftKey>

</Components>

</Screen> </ppxml>

[LCD Image]

   (For example) SoftKey id="3" name="sk3" text="Cancel"

5.2.11. FFKeys

[Overview]

"FFKeys" element has to include one or more "FFKey" elements.

"FFKeys" element can define in the "Screen" or "Menu" element.

It will not act anything, when pushing FFkey which is not assigned any feature (URL) in XML application mode.

[Definition]

  

[Syntax]

<?xml version="1.0" encoding="utf-8"?>

<ppxml

xmlns="http://panasonic/sip_phone"

    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://panasonic/sip_phone sip_phone.xsd">

<Screen version="3.0">

<Components>

<FFKey id="4" name="ff4" text="Cancel">

<Events>

          <OnClicked>

            <SendRequest url="http://192.168.0.200/Cancel.xml" />

          </OnClicked>

</Events>

</FFKey>

</Components>

</Screen> </ppxml>

<HDV330/430>

 

id:8

 

id:1

 

 

The "id" of attribute and FFkey display is as follows.

5.2.12. PageKeys(*1)

[Overview]

"PageKeys" element has to include one or more "PageKey" elements.

"PageKeys" element can define in the "Screen" or "Menu" element.

It will not act anything, when pushing PageKey which is not assigned any feature (URL) in XML application mode.

(*1) Supported only HDV230/330/430.

[Definition]

[Syntax]

<?xml version="1.0" encoding="utf-8"?>

<ppxml

xmlns="http://panasonic/sip_phone"

    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://panasonic/sip_phone sip_phone.xsd">

<Screen version=“3.0”>

<Components>

<PageKey id="right" name="page1">

<Events>

          <OnClicked>

            <SendRequest url="http://192.168.0.200/page_pre.xml" />

          </OnClicked>

</Events>

</PageKey>

</Components>

</Screen> </ppxml>

5.2.13. SetVariables

[Overview]

SetVariable is used to create & update system wide read/write variable.

The variable will store a string value that can be referring back at the later stage.

This variable life span is until system reboot.

This variable is registrable by 16 kinds or less.

[Naming Rule of Variables] Rules of variable name:

-  Can be any combinations of String (alphabet + number + Multi-byte character code)

-  White space, symbol and special character are not allowed

-  Example of valid variable name: @MyVariable123, @aB12Cd, @textBox1

-  Example of invalid variable name: @MyName_Textbox, @Hello~!^%,

[Example usage of SetVariable]

-  Store the XML server URL path,

<SetVariable key="@serverPath" value="http://192.168.0.100/path" />

-  For referring the variables

Value which stored in variables can be referred by following way

<PictureBox name="PBox1" left="0" top="0" width="120" height="55" source="@serverPath/a.bmp" />

<HDV330/430>

<PictureBox name="PBox1" left="0" top="27" width="120" height="55" source="@serverPath/a.bmp" />

*Height of status bar is 27 pixels.

[Syntax]

[To Set variables]

<ppxml

xmlns="http://panasonic/sip_phone"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://panasonic/sip_phone sip_phone.xsd">

<Screen name="Screen1" version=“3.0”>

<Components>

<Label name="MyNameLabel" line="2" text="Label1"

textAlignment="Left" showDateTime="true" refreshDateTime="52" /></Components>

</Screen>

<SetVariables>

    <SetVariable key="@SystemValue" value="MyNameLabel" /></SetVariables>

</ppxml>

[To Refer variables]

<ppxml

xmlns="http://panasonic/sip_phone"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://panasonic/sip_phone sip_phone.xsd">    <Screen>

<Components>

<Label name="Label1" line="2" text="@SystemValue"

           textAlignment="Left" showDateTime="true" refreshDateTime="52" />

</Components>

   </Screen> </ppxml>

5.2.14. Timer

[Overview]

Developer can define a period of time, before the timer will trigger.

When timer triggers, developer can define any Actions (e.g. SendRequest, Make Call).

Timer will only stop if the current screen is being replaced.

Timer can only be exist one definition in XML content. Multiple timer event cannot executed

[Definition]

[Syntax]

<ppxml>

<Screen name=“Screen” version=“3.0”>

<Timer name="Timer1" repeat="false" interval="20">

<Events>

<OnExpired>

          <SendRequest url="http://aaa.ccc.com/GetXml.aspx?xml=HotelHome.xml"               method="GET" />

</OnExpired>

</Events>

</Timer>

</Screen>

</ppxml>

5.2.15. Execute

[Overview]

Execute defines the operations that can be executed in the phone.

[Definition]

[Syntax]

<?xml version=“3.0” encoding="utf-8"?>

<ppxml

xmlns="http://panasonic/sip_phone"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"        xsi:schemaLocation="http://panasonic/sip_phone sip_phone.xsd">

<Execute version="2.0">

  <SetXmlMode mode="on" />

<Reboot />

</Execute>

</ppxml>

5.2.16. Trigger

[Overview]

Trigger is usually used for Server Push request.

The phone acquires the XML file which URL is specified in the Source element value of the Trigger object.

[Definition]

Child Element 1

>Note. (*1) .TGP600 supports only Version 2.0.

[Syntax]

<?xml version="2.0" encoding="utf-8"?>

<ppxml

xmlns="http://panasonic/sip_phone"

    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://panasonic/sip_phone sip_phone.xsd">

<Trigger version=“3.0”>

<Source>http://www.aaa.ccc.com/Screen.xml</Source>

</Trigger>

</ppxml>

5.2.17. Redialkey

[Overview]

When the Redial key is pushed, the phone acquires the outgoing data those are stored on the XML server instead of executing Last Number Redial.

[Definition]

[Syntax]

<?xml version="1.0" encoding="utf-8"?>

<ppxml

    xmlns="http://panasonic/sip_phone"

    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://panasonic/sip_phone sip_phone.xsd">

<Screen version="3.0">

    <Components>

<RedialKey name="Call log">

<Events>

          <OnClicked>

            <SendRequest url="http://192.168.0.200/Call_log.xml" />

          </OnClicked>

</Events>

</RedialKey>

    </Components>

</Screen>

</ppxml>

5.2.18. PhoneBook(like XSI format)

[Overview]

It is able to perform the same operability as embedded phonebook to the network phonebook by using this element. This format is like XSI phonebook format.

[Definition]

[Syntax]

[LCD Image]
c.f. 4.3.2.2. Network Phonebook Operations

6. Appendix

6.1. Error Code Reference

The following is error code list which is displayed in the LCD of the phone.

Error Code (In Hex)

Error Description

Common

0001

Normally Completed

Parser Error

0101

Can not Receive Bitmap (Size Over)

0102

Wrong File (File type is not XML nor BMP)

0103

Can not handle elements (Too much Elements)

0104

Missing of '>' or '<'.

0105

Memory Allocation Error

0106

Cannot access to Network

01A0

File receiving error : cancel

01A1

File receiving error : Wrong Parameter

01A2

File receiving error : Illegal URL syntax

01A3

File receiving error : Connection error

01A4

File receiving error : Could not resolve the name

01A5

File receiving error : No response from Server

01A6

File receiving error : Receiving wrong message

01A7

File receiving error : Server response with error

01A8

File receiving error : File Not Found

01A9

File receiving error: Authentication failed.

01AA

File receiving error : SSL communication error

01AB

File receiving error : SSL certification error

01AC

File receiving error : Redirect with wrong protocol

01AD

File receiving error : File already exist without overwriting

01AE

File receiving error : system error

01AF

File receiving error : Socket Error

01B0

File receiving error : File error

01B1

File receiving error : Memory Error

01B2

File receiving error : Busy from Server

01BF

File receiving error : other error

01F0

Unexpected space is added (Software error)

01F1

Wrong in string (Software error)

ppxml

None

Screen

0301

Unsupported XML

SetVariable

0401

No elements

0402

Unsupported Key

Components

None

Timer

0801

Wrong attribute

0802

Failed to allocate timer

Label

 

0901

No Label Element

0902

Wrong name Attribute

0903

Wrong line Attribute

0904

Wrong area Attribute

0905

Wrong text Attribute

0906

Wrong textAlignment Attribute

0907

Wrong showDateTime Attribute

0908

Wrong refreshDateTime Attribute

PicureBox

0A01

No PictureBox Element

0A02

Wrong left Attribute

0A03

Wrong top Attribute

0A04

Wrong width Attribute

0A05

Wrong height Attribute

0A06