User manual GRANDSTREAM GXP280 DATASHEET

[. . . ] The third architecture is in a closed network. An application in a closed network may exchange information in the following manner: Grandstream Networks XML Application Note ­ Version 1 Page 4 of 21 Revised: 9/2007 4. A fourth architecture enables the internal web server to interact with outside web server via HTTP. As illustrated above, all of the application logic lies within the server side of the architecture. This allows faster applications development and minimal phone side maintenance. [. . . ] The XML application is effective immediately after download. During this process the LCD will display a message to indicate the XML Phonebook download is in progress. NOTE: · · · The phonebook file name is fixed and cannot be changed based on personal preference. If the "Phonebook Download Interval" is set to a non-zero value x, the phonebook is automatically updated every x hours. If the "Remove manually edited entries on download" option is set to No (by default), the phone will keep ALL previously stored phonebook entries, insert the downloaded phonebook entries, and then save the phonebook. If set to Yes, the downloaded phonebook entries will replace the existing phonebook stored on the phone. At any time, you can immediately download the phonebook by choosing the "Download Phonebook" in the GUI Phone Book Menu (you can use the down arrow key when the phone is onhook). · Grandstream Networks XML Application Note ­ Version 1 Page 6 of 21 Revised: 9/2007 Grandstream XML Application Guide - PART B XML Syntax, Technical Detail, File Examples Part B of this application note will guide you through the technical details of our three applications: 1) XML Custom Screen, 2) XML Downloadable Phonebook and 3) Advanced XML Survey Application. Grandstream Networks XML Application Note ­ Version 1 Page 7 of 21 Revised: 9/2007 Application One: XML Custom Screen Details 1. XML Custom Screen Syntax XSD file <?xml version="1. 0"?> <xsd:schema xmlns:xsd="http://www. w3. org/2001/XMLSchema"> <xsd:element name="Screen"> <xsd:complexType> <xsd:sequence> <xsd:element name="IdleScreen" minOccurs="1" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:element name="ShowStatusLine" type="xsd:boolean" minOccurs="1" maxOccurs="1" default="true"/> <xsd:element name="DisplayBitmap" minOccurs="0" maxOccurs="unbounded" nillable="true"> <xsd:complexType> <xsd:sequence> <!-- We only accept Windows Monochrome Bitmap, max 130x64 pixels encoded by base64 --> <xsd:element name="Bitmap" type="xsd:base64Binary" minOccurs="1" maxOccurs="1"/> <xsd:element name="X" type="xsd:integer" minOccurs="1" maxOccurs="1" default="0"/> <xsd:element name="Y" type="xsd:integer" minOccurs="1" maxOccurs="1" default="0"/> </xsd:sequence> <xsd:attribute name="a1reg" type="xsd:boolean"/> </xsd:complexType> </xsd:element> <xsd:element name="DisplayString" minOccurs="0" maxOccurs="unbounded" nillable="true"> <xsd:complexType> <xsd:sequence> <xsd:element name="DisplayStr" type="xsd:string" minOccurs="1" maxOccurs="1"/> <xsd:element name="X" type="xsd:integer" minOccurs="1" maxOccurs="1" default="0"/> <xsd:element name="Y" type="xsd:integer" minOccurs="1" maxOccurs="1" default="0"/> </xsd:sequence> <xsd:attribute name="a1reg" type="xsd:boolean"/> <xsd:attribute name="font"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="f8"/> <xsd:enumeration value="f10"/> <xsd:enumeration value="f13h"/> <xsd:enumeration value="f13b"/> <xsd:enumeration value="f16"/> <xsd:enumeration value="f16b"/> <!-- f18c is a 18 point Comic font --> <xsd:enumeration value="f18c"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attribute name="halign"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="Left"/> <xsd:enumeration value="Center"/> <xsd:enumeration value="Right"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attribute name="valign"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="Top"/> <xsd:enumeration value="Center"/> <xsd:enumeration value="Bottom"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:schema> Grandstream Networks XML Application Note ­ Version 1 Page 8 of 21 Revised: 9/2007 2. Example Idle Screen File <?xml version="1. 0"?> <!-- This file creates identical result to GXP-2000 default behavior --> <Screen> <IdleScreen> <ShowStatusLine>true</ShowStatusLine> <DisplayString font="f8"> <DisplayStr>$W, $M $d</DisplayStr> <X>0</X> <Y>0</Y> </DisplayString> <DisplayString font="f13h" halign="Center" a1reg="false"> <DisplayStr>$N</DisplayStr> <X>65</X> <Y>12</Y> </DisplayString> <DisplayString font="f13b" halign="Center" a1reg="true"> <DisplayStr>$N</DisplayStr> <X>65</X> <Y>12</Y> </DisplayString> <DisplayString font="f13h" halign="Center" a1reg="false"> <DisplayStr>$X</DisplayStr> <X>65</X> <Y>26</Y> </DisplayString> <DisplayString font="f13b" halign="Center" a1reg="true"> <DisplayStr>$X</DisplayStr> <X>65</X> <Y>26</Y> </DisplayString> <DisplayString halign="Center" valign="Bottom"> <DisplayStr>$I</DisplayStr> <X>65</X> <Y>48</Y> </DisplayString> </IdleScreen> </Screen> 3. XML Explanation ROOT ELEMENT "SCREEN" The XML document has root element called Screen; it contains exactly 1 sub-element called IdleScreen. <xsd:element name="Screen"> <xsd:complexType> <xsd:sequence> <xsd:element name="IdleScreen" type="IdleScreenType" minOccurs="1" maxOccurs="1"/> </xsd:sequence> </xsd:complexType> </xsd:element> ELEMENT "IDLESCREENTYPE" This element defines three components that are makes up the idle screen. These components are defined as elements. <xsd:complexType name="IdleScreenType"> <xsd:sequence> <xsd:element name="ShowStatusLine" type="xsd:boolean" minOccurs="1" maxOccurs="1" default="true"/> <xsd:element name="DisplayBitmap" type="DisplayBitmapType" minOccurs="0" nillable="true"/> <xsd:element name="DisplayString" type="DisplayStringType" minOccurs="0" nillable="true"/> </xsd:sequence> </xsd:complexType> Note: ShowStatusLine must appear exactly once and any number of DisplayBitmap and DisplayString instances. Grandstream Networks XML Application Note ­ Version 1 Page 9 of 21 Revised: 9/2007 DISPLAY RULES When both DisplayBitmap and DisplayString elements are present, all bitmaps will be rendered before the strings are displayed. Note: When using the Center alignment, calculate the midpoint for the y-coordinate (4. 5. 3) in order for the width to be centered. element Y must be set to 32 to display a string that is aligned to the center of the LCD. Similarly, you will need to specify the right most point to render if you are using the Bottom valign method (set to 64). Grandstream Networks XML Application Note ­ Version 1 Page 12 of 21 Revised: 9/2007 Application 2: XML Phonebook Details 1. XML Phonebook Syntax XSD file <?xml version="1. 0"?> <xsd:schema xmlns:xsd="http://www. w3. org/2001/XMLSchema"> <xsd:element name="AddressBook"> <xsd:complexType> <xsd:sequence> <xsd:element name="Contact" minOccurs="1" maxOccurs="unbounded"> <xsd:complexType> <xsd:sequence> <xsd:element name="LastName" type="xsd:string" minOccurs="1"/> <xsd:element name="FirstName" minOccurs="0" type="xsd:string" nillable="true"/> <xsd:element name="Address" minOccurs="0" nillable="true"> <xsd:complexType> <xsd:sequence> <xsd:element name="address1" type="xsd:string" minOccurs="1" maxOccurs="1"/> <xsd:element name="address2" type="xsd:string" minOccurs="0" maxOccurs="1"/> <xsd:element name="city" type="xsd:string" minOccurs="1" maxOccurs="1"/> <xsd:element name="state" type="xsd:string" minOccurs="1" maxOccurs="1"/> <xsd:element name="zipcode" type="xsd:string" minOccurs="1" maxOccurs="1"/> <xsd:element name="country" type="xsd:string" minOccurs="1" maxOccurs="1"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="Phone"> <xsd:complexType> <xsd:sequence> <xsd:element name="phonenumber" type="xsd:string" minOccurs="1" maxOccurs="1"/> <xsd:element name="accountindex" type="xsd:integer" minOccurs="1" maxOccurs="1" default="1"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="Email" type="xsd:string" minOccurs="0" nillable="true"/> <xsd:element name="Department" type="xsd:string" minOccurs="0" nillable="true"/> <xsd:element name="Company" type="xsd:string" minOccurs="0" nillable="true"/> <xsd:element name="Icon" type="xsd:base64Binary" minOccurs="0" nillable="true"/> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:schema> 2. Example XML Phonebook File <?xml version="1. 0"?> <AddressBook> <Contact> <LastName>Doe</LastName> <FirstName>John</FirstName> <Phone> <phonenumber>8000</phonenumber> <accountindex>0</accountindex> </Phone> </Contact> <Contact> <LastName>Smith</LastName> <FirstName>Alan</FirstName> <Phone> <phonenumber>8001</phonenumber> <accountindex>0</accountindex> </Phone> </Contact> <Contact> <LastName>Lee</LastName> <FirstName>Lily</FirstName> <Phone> <phonenumber>6000</phonenumber> <accountindex>1</accountindex> </Phone> </Contact> </AddressBook> Grandstream Networks XML Application Note ­ Version 1 Page 13 of 21 Revised: 9/2007 Application Three: XML Call Center/Survey Details XML CALL CENTER / SURVEY DETAILS 1. XML Phonebook Syntax This section gives a brief overview of the screen layout and the XML syntax. Special Characters As followed by the standard XML recommendation, some characters need to be escaped. The following list the characters together with their escape sequence: Characters & " ` < > Name Ampersand Quote Apostrophe Left Angle Bracket Right Angle Bracket Escape Sequence &amp &quot &apos &lt; &gt; GRANDSTREAM XML OBJECT Line Keys Display Area GXP2020 XML Display 140 Pixels 20 Pixels Soft Key Area 100 Pixels 220 Pixels As illustrated above, XML content will be displayed in the 140 X 220 display area. Accordingly, the soft keys will be displayed in their respective area. A single XML object will represent the display area. This XML object takes precedence over the current display. [. . . ] Please make note that the account 1 page must be configured with a valid SIP account for the application to run. When the phone boots up, the first soft key will be "XML Service". It is also possible to enter the application server path into a web browser. This way you'll be able to see on your screen the exact XML that your phone is receiving also. [. . . ]