XML Application for UT248 KX-NS1000 V2.0 Rev1.0 30 Aug., 2012

XML Application for UT248

KX-NS1000 V2.0

Rev1.0 30 Aug., 2012

2

1. Overview of XML Application

2. Each Function overview

3. Connecting Way

4. System Diagram

5. XML Definition

6. Detailed explanation of each XML commands

You can download the Developer’s Guide and Schema from following Web.http://panasonic.net/pcc/support/sipphone/download/UT1/index.html

This document describes about XML application to control, customize, initiate action of phone.

Table of Contents

3

Chapter 1

Overview of XML Application

4

By using XML application, we can customize / control phone. Also phone can initiate specified action on event, and can access to remote phonebook via proxy tool.

XML ServerPhone (UT248)

XML Application

- Customizing of Menu (Soft Keys)- Display / Input Text on LCD.- Draw Bitmap Image on LCD.- By Timer Event.

Customizing menu, show text on LCD

- Access Remote Phonebook (via LDAP tool PC -> Server)

Access Remote phonebook

- Let Phone Access to specified URL- Reboot Phone.- Run / Stop XML application.

Remote Control of phone

- Phone can access specified URL when some event occurred. Example : When incoming call, access to specified URL.

Action by Event

1. Overview of XML Application

What can we do with XML Application?

5

Chapter 2

Each Function overview

6

Customizing menu, Display message


Soft1 Soft2 Soft3 Soft4

1.Menu A

2.Menu B

3.Menu C

4.Menu D

Welcome 2011/11/11 12:13:14

Menu Log

Customizing Menu, Soft Key, FF Key. Draw Bitmap, Show message.*grayscale (four-color) bitmap

Input : *****

Input Text Box.

URL

Timer Event

Example :Every 30 minutes.

Company Logo.*Displayed during idle state*grayscale (four-color) bitmap

7

http://xxxxx/xxx.php

Action triggered by Event

- Can executed action when specified event occurred. Like On Hang up, Talking, Make a Call, phone Send Request,

Example: On talking, access to specified URL

On Talking

Action by Event


8

-From XML Server phone can be controlled . Like Get Configuration info., Reboot, Access to specified URL

Example: Get Configuration information

UT248 XML Server

Get Configuration info.

Remote Control


9

HTTP LDAP

LDAP Server (V.3)LDAP Translation ToolOn PC

- It is able to get phone book items with LDAP via LDAP proxy tool on PC.- The item can be stored in local phone book.- It is able to search items by keyword same as local phone book.

UT248

Number Copy Search

John

123456789

Johnson

Jonny

1

Remote Phonebook


10

Chapter 3

Connecting Way

11

XML server

1. XML data (http with XML)

2. Response (http) 200 OK

1. Server Initiate (Push)

2. Client Initiate (Pull)

XML server

1. http-request (http with XML)


3. Connecting Way

General

12

- Connect to specified URL

- Run / Stop XML

- Reboot a UT

XML server

1.Send XML data (http with XML)

3.Response (http) 200 OK

XML server can send a request to UT.

When UT gets the request, UT will act as described in XML.

2. Act as requested

Action can be taken

3. Connecting Way

Case : Server Initiated action

13

-Start UP

-Setting Menu (Soft Key.

-Ringing / Talking / Calling

-Referring to call log / Phonebook

-Idling

XML server

2. Send http-request (http with XML)


It is able to set URL in configuration parameters at each event and connect to the URL to get a XML content.

When a event occurs, UT will send a http request to the URL.

1. Event : eg: make a call

Triggered event for connecting URL

3. Connecting Way

Case : Client Initiated action

14

Chapter 4

System Diagram

15

XML Parser

Web Server Socket（ http (port ： ex.6666))

[UT]

XML Engine

Call Control I/F

GUI I/F

Action(Ex. send http-req.)

Action（ Ex. Making call)

Action（ Ex. Display ）

Edit with Schema

[XML server]

[LDAP tool / Server]

http request I/F

- UT gets a XML content from XML server

- UT parse the XML content

- UT displays the content and / or set keys

Phonebook

4. System Diagram

System Diagram

16

Chapter 5

XML Definition

17

XML format is based on Panasonic SIP phone xml definition (ppxml).

Chaptor6 detailed information of each XML are described.

Example

5. XML Definition

General

<?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="2.0"> <Components> <Label name="lbl1" text="testes" /> </Components> </Screen></ppxml>

18

Chapter 6

Detailed explanation of each XML commands

19

Element Description

Menu Display strings and set soft keys to send a URL (http request)

Label Put strings on LCD

PictureBox Draw bitmap image data

TextBox Input text

Timer Occur timer event

Phonebook Get phone book items from LDAP


Customizing menu, show text/image

20

- Can customize Display menu items in each line.- Can customize soft key, ff key also.- Select the item with navigation keys and move to the XML content- Can Assign URL to send request into soft keys.

<Menu name="MainMenu"> <MenuItems> <MenuItem name=“Item1” text=“Menu A" value="123" selected="true" /> <MenuItem name=“Item2” text=“ Menu B" value="abc" /> <MenuItem name=“Item3” text=“ Menu C" value="456" /> <MenuItem name=“Item4” text=“ Menu D" value="def" /> </MenuItems> <SoftKeys>　　 <SoftKey id=“1” name=“sk1” text=“Soft1"> <Events> <OnClicked> <SendRequest url="http://192.168.0.200/Cancel.xml"/> </OnClicked> </Events>　　 </SoftKey> </SoftKeys>

Example

Soft1 Soft2 Soft3 Soft4

1.Menu A

2.Menu B

3.Menu C

LCD Image

4.Menu D


Menu

21

- Label is used to display text message.

Screen Title

2011/11/11 12:13:14

LCD Image

Example


<ppxml> <Screen version="2.0"> <Components>  <Label name="labelTitle" line="2" text="Screen title" textAlignment="Left" /> <Label name="labelTitle" line=“3" showDateTime=“true” textAlignment="Left" /> </Components> </Screen></ppxml>


Label

22

LCD Image

- Picture Box is used to display bitmap image by specifying URL.- Possible to draw bitmap and characters in a screen (*monochrome bitmap)


<ppxml> <Screen version="2.0"> <Components> <PictureBox name="pb1" left="30" top="30“ height="100" width="100“ source=“http://a.com/webServerPath/Screen/PictureBox_1.bmp" /> <Label name=“labelTitle” line=“4” text=“Welcome to Pana Hotel" textAlignment="Left" /> </Components> </Screen></ppxml>

Example

Welcome to Pana Hotel


Picture Box

23

- End User can input text by using Text Box.- Can set password mode then inputted text shown as “****”- Inputted text can be sent to server.

<ppxml> <Screen version="2.0"> <Components> <TextBox name="textBox1" line="2" text="" textAlignment="Left" password=“true" maxLength="10" />　　　　 <SoftKey id="4" name="sk4" text="ENTER"> 　　　　 <Events> 　　　　 <OnClicked> 　　　　 <SendRequest url="http://192.168.0.200" /> 　　　　 </OnClicked> 　　　　 </Events> 　　　　 </SoftKey> </Components> </Screen></ppxml>

Example

Clear A/a 1/A/? ENTER

LCD Image

Input : *****


Text Box

The number of characters in Text Box is maximum 24.

24

- By using Timer, can execute required event at specified timing.


<ppxml> <Screen version="2.0"> <Timer name="timer1" repeat="true" interval="30"> <Events> <OnExpired> <SendRequest url="http://aaa.ccc.com/GetXml.aspx?xml=HotelHome.xml" /> </OnExpired> </Events> </Timer> </Screen></ppxml>

Example

Example: Every 30 seconds phone access to URL

URL to get xml


Timer

25

Element Description

Event Execute Action when specific event occurred.


Action by Event

26

- Can executed action when specified event occurred. Event : On Talking, On Hung up, On Clicked, On Expired, Action: Send Request, Make a call, Answer, Hung up, Get Config….

<ppxml><Screen version="2.0"> <Components> <Label text="Transfer" top="10" left="30"/> </Components> <!– Access to specified URL when On Hungup --> <Events> <OnHungup> <SendRequest url="http://192.168.0.200/Hungup.xml"/> </OnHungup> </Events> </Screen></ppxml>

Example

On Hung upExample: On Hung up, access to specified URL

URL to get xml


Event

27

Element Description

Trigger Force phone to access to required URL.

Execute For getting configuration from phone. Rebooting phone.Set enable/disable XML feature.


Remote Control of phone

28

- Server can force phone to access to defined URL

Example

URL to get xml

Example: Trigger to access to specified URL

ServerRequest


Trigger


<!– Request client to access to screen.xml --><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="2.0"> <Source>@web_server_path/Screen.xml<Source /> </Trigger></ppxml>

29

- Execute is done by background operation of phone.

- Can Get configuration from the phone, Reboot the phone, set enable/disable XML feature.

Example


Execute


<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"> <GetConfig mode="IpAddressSetting" url=“http://xxx.com/GetXml.aspx?xml=test.xml" /></Execute>

<!– Phone send requested information to server by XML -->

</ppxml>

30

Element Description

Phonebook To access to phonebook of network.


Remote Phonebook

31

- It is able to get phone book items with LDAP via LDAP proxy tool.- The item can be stored in local phone book.- It is able to search items by keyword same as local phone book.

Example

Number Copy Search

John

123456789

Johnson

Jonny

1

LCD Image


Remote Phonebook

<?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="2.0"> <PhoneBook version="1.0"> <Personnel id="1"> <Name>yoshida taro</Name> <PhoneNum type="ext">3920</PhoneNum> <PhoneNum type="home">99998888</PhoneNum> </Personnel> <Personnel id="2"> <Name>George</Name> <PhoneNum type="ext">223</PhoneNum> <PhoneNum type="mobile">088011</PhoneNum> <PhoneNum type="campany">999</PhoneNum> </Personnel> </PhoneBook> </Screen></ppxml>

32

Thank you !The END

Developer’s Guide/Schema 入手先については紹介不要？http://panasonic.net/pcc/support/sipphone/download/UT1/index.html

Documents

XML Application for UT248 KX-NS1000 V2.0 Rev1.0 30 Aug., 2012