Page 2
Revision Date Page Comments of revision 1.00 16 July, 2015 First Release 2.00 14 Sep, 2015 Add HDV330/430 models 08 Dec, 2015 2.10 Modify some contents for Enhanced feature on December/2015 18 May, 2016 2.20 Modify some contents for Enhanced feature on May/2016 16 Sep 2016 2.30 Modify some contents for Enhanced feature on Aug/2016...
[CONTENTS] 1. INTRODUCTION ......................2 2. OVERVIEW........................3 2.1. A ) ..........3 GENERAL YSTEM IAGRAM ETWORK HONEBOOK 2.1.1. Easy operation of SIP Server Call Control (e.g. DND/CFWD) ......... 3 2.1.2. Network Phonebook system example ................3 2.2. B ......................4 ASIC PERATION 2.2.
Page 4
5. XML STRUCTURE ......................27 5.1. XML D ......................27 OCUMENT 5.1.1. XML Schema of the phone ................... 27 5.1.2. Name Space of XML Document ..................28 5.1.3. Character reference ..................... 28 5.1.3.1. Predefined Entities in XML ..................28 5.1.3.2. Numeric Character Reference ................... 28 5.1.4.
Page 5
ATTENTION - This document is copyrighted by Panasonic Corporation 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.
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.
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) XML Server XML contents on the HTTP Server Display Menu Call Control Operation...
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.
2.2. XML Data Access Flow There are two methods to access XML Data. TGP/HDV SERVER HTTP GET/POST A. TGP/HDV GET/POST 200 OK + XML DATA HTTP POST Event Trigger 200 OK B. SERVER PUSH HTTP GET/POST EVENTMETHOD 200 OK + XML DATA 2.3.
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. Document Root Static XML file. CGI-bin Html *) "Template" xml files may be prepared. "Template"...
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. When definition of "Action"...
Page 13
[HTTP POST/GET Response] TGP/HDV receives HTTP response including XML data from HTTP Server. Receive HTTP response header. Check the HTTP result code. Other 200 OK Receive HTTP response content. Display GUI.
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"...
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. Specified by XML_HTTPD_PORT. Listen on Push Port. Default: 6666 HTTP GET /request.cgi Receive Link XML data.
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 XML Application Enable XMLAPP XMLAPP_ENABLE Settings User ID XMLAPP_USERID Password XMLAPP_USERPASS Local XML Port XML_HTTPD_PORT Bootup URL (*2)
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...
4.3. Initiation methods of XML application (* 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.
LDAP URL as a CGI parameter. XMLAPP_LDAP_MAXRECORD Specifies the maximum number of Integer 20 to 500 search results to be returned by the LDAP server Note. This function is supported by TGP600/HDV100/HDV130/HDV230/HDV330/HDV430. (*1) HTTP GET /get_ldap.cgi?...&userid=XMLAPP_LDAP_USERID &userpass=XMLAPP_LDAP_USERPASS XML Server LDAP Server For XML server authentication...
XML Phonebook files. When the parameter is set to '0', the timing is the same updating of the configuration files. Note. This function is supported by TGP600/HDV130/HDV230/HDV330/HDV430. HTTP GET /xml_phonebook http Server 200OK (includes phonebook data)
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.
Page 24
It is able to display acquired data by using [▲] or [▼] key. Search 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.
Page 25
[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.
4.3.3. Application Menu Configuration and operation 4.3.3.1. Configuration Parameter Configuration parameters are as follows. Configuration Parameter Description Format Value Default Range Value String Max. 256 Empty XMLAPP_INITIAL_URL Specify the XML URL to acquire when the characters String XML application starts up from [Application] menu.
Page 27
<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 Default Range Value XML_INITIATE_KEY_SOFT1 Enables initiation of XML application from Boolean Soft Key1.
Page 29
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 HTTP GET /xmlpath/xmlapl.cgi ?initiationkey=PK1 Model: HDV230 HTTP GET /xmlpath/xmlapl.cgi ?initiationkey=SOFT1 HTTP GET /xmlpath/xmlapl.cgi ?initiationkey=FF1 HTTP GET /xmlpath/xmlapl.cgi ?initiationkey=DSS1...
4.3.6. Redial key Configuration and operation 4.3.6.1. Configuration Parameter Configuration parameters are as follows. Configuration Parameter Description Format Value Default Range Value XMLAPP_URL_REDIAL_KEY Specify the XML URL to acquire when the String Max. 256 Empty characters String [REDIAL] key is selected. 4.3.6.2.
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="1.0" encoding="utf-8"?> <!-- Sample screen --> <ppxml xmlns="http://panasonic/sip_phone" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://panasonic/sip_phone.xsd sip_phone.xsd"> <Screen> ... </Screen> </ppxml> XML Instance [XML Declaration] XML version and character set are described.
B) "xsi" description obeys "http://www.w3.org/2001/XMLSchema-instance". C) "http://panasonic/sip_phone.xsd" name space is defined in "sip_phone.xsd" file. User has 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"...
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’ 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.
Child Attribute Value Element xmlns http://panasonic/sip_phone xmlns:xsi http://www.w3.org/2001/XMLSchema-instance xsi:schemaLocation http://panasonic/sip_phone sip_phone.xsd Screen Please refer to the element definition Trigger Please refer to the element definition SetVariables Please refer to the element definition SoftKeys Please refer to the element definition FFKeys...
Please refer to the element definition OnHungup Please refer to the element definition OnClicked Please refer to the element definition OnExpired Please refer to the element 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">...
As for popup/dialog "Components" are mandatory. [Definition] Child Element Functionality Label It displays the text string (TGP600 up to 16 strings/ HDVseries up to 32strings) PictureBox It displays BMP format data. TextBox It enables the user to enter and modify the text. SoftKeys Button is an object pushed by user.
Page 39
[Displayable Area] [4 line model] <HDV130/230> (id=1) Phone area (id=3) Soft 1 Soft 2 Soft 3 For Softkey label area [6 line model] <HDV330/430> Status bar For Status bar area (id=1) Phone area (id=6) Key label area for Softkey (Key1) (key2) (Key3)
“OK” Fixed character “OK” text Events Elements except these cannot be used OnClicked SendRequest [Syntax] <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="Screen" version="3.0"> <Components> <TextBox name="textBox" title=”Name” line="2" text="<Enter>" password="false"> <SoftKey id="2" name="sk2" text="OK"> HDV330/430 Soft key ID is 3 <Events>...
Page 42
</ppxml> In the following model, TextBox of above [Syntax] is as follows. <HDV330/430> Soft key ID is 3 <SoftKey id="3" name="sk3" text="OK"> [Displayable Area] c.f. 5.2.4. Label [LCD Image] <HDV130/230> mode = 1 : Character mode = 0 : Number Name <Enter>...
Page 43
HDV330/430 ignore designation of softkey. Always treat softkey3 as “OK”. <SoftKey id=" 2" name="sk2" text="OK"> <SoftKey id=" 3" name="sk3" text="OK"> <SoftKey id=" 2" name="sk2" text="OK"> HDV330/430 ignores this designation. User can use same designation of HDV130/230. So, No need to change XML server code.
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] Action of the key Navigator keys Only Up &...
Page 46
[Displayable Area] [4 line model] <HDV130/230> (id=1) Phone area (id=3) Soft 1 Soft 2 Soft 3 For Softkey label area [6 line model] <HDV330/430> Status bar For Status bar area (id=1) Phone area (id=6) Key label area for Softkey (Key1) (key2) (Key3) [LCD Image]...
Page 47
<HDV130/230> [4 line model] Cursor can move to this area (id=1) (id=1) (id=3) (id=3) Cursor CANNOT move to this area Soft 1 Soft 2 Soft 3 Soft 1 Soft 2 Soft 3 XML_CURSOR_SKIP_ENABLE=N(Default) XML_CURSOR_SKIP_ENABLE=Y [6 line model] <HDV330/430> Status bar Status bar This area is selectable.
[Syntax] 1. Event which caused by operation of menu and soft keys. <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> <!—Display Menu Item and assign function to FF Keys and Soft Keys --> <Menu name="MainMenu" area="Phone"> <MenuItems> <MenuItem name="Item1" text="123" selected="true" id="1">...
Page 51
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>...
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] Child Element 1 Child Element 2...
The phone acquires the XML file which URL is specified in the Source element value of the Trigger object. [Definition] Child Element 1 Attribute Value Functionality version "2.0", "3.0" (*1) Source URL of XML content 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>...
String Max. 24 characters. Events Only these elements can be described OnClicked SendRequest [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>...
Page 62
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] Child Child Child Attribute Value Functionality Element1 Element2 Element3 xml version "1.0"...
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...
Page 64
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...
Page 65
0C40 MakeCall NG 0C50 AnswerCall NG 0C60 HangupCall NG 0C80 SetXmlMode NG 0C90 Reboot NG Trigger 0D01 Wrong Element (Trigger) 0D02 Wrong Element (Source) 0D10 SendRequest NG Execute 0E01 Wrong Element (Execute) 0E20 SetXmlMode NG 0E30 Reboot NG Menu 0F01 Wrong Element (Element Name) 0F02 Wrong Element (Attribute area)
Page 66
1403 Wrong Element (Attribute text) 1404 Wrong Element (selected Attribute) 1410 Phone Display Area Error (Un Supported LCD) Phone Display Area Error (Illegal id) 1420 1421 Phone Display Area Error (Illegal textAlignment) 1422 Phone Display Area Error (Illegal selected) 1423 Phone Display Area Error (Illegal text) 1424 Phone Display Area Error (Error in saving selected id)
Page 67
6.2. Editing XML contents on the PC The PC free software, called ‘XML Notepad 2007’ made by Microsoft®, can check schema error on PC. It is useful for basic editing and checking contents before actually loading to the phone. Tool name: XML Notepad 2007 (Please obtain it from the Microsoft® website). All schema files of the phone must be copied onto the same folder as the XML contents folder beforehand to avoid schema errors.