Download
Share
Print this page
Grandstream Networks XML Application Manual
  1. Manuals
  2. Brands
  3. Grandstream Networks Manuals
  4. Software
  5. XML
  6. Application manual
Grandstream Networks XML Application Manual

Grandstream Networks XML Application Manual

Part a – application explanations part b – xml syntax, technical detail, file examples
Hide thumbs

Advertisement

Quick Links

Download this manual
Grandstream XML Application Guide
Three XML Applications
PART A – Application Explanations
PART B – XML Syntax, Technical Detail, File Examples

Advertisement

loading

Related Manuals for Grandstream Networks XML

Summary of Contents for Grandstream Networks XML

  • Page 1 Grandstream XML Application Guide Three XML Applications PART A – Application Explanations PART B – XML Syntax, Technical Detail, File Examples...
  • Page 2 Grandstream XML Application Guide - PART A Three XML Applications Grandstream GXP Series supports both simple and advanced XML applications. Part A of this application note will describe Grandstream’s XML applications: 1) XML Custom Screen, 2) XML Downloadable Phonebook and 3) Advanced XML Survey Application.
  • Page 3 The XML infrastructure allows our phones to interact with external applications in a flexible and programmable manner. Three specific XML applications supported by Grandstream include XML Custom Screen, XML Phonebook, and XML Survey Application. The last application is a custom application where the XML framework is an interactive, real-time implementation and XML messaging is dynamic, depending on a configurable object set.
  • Page 4 2. Idle Screen XML Server Path (P341): This is a string of up to 128 characters that contains a path to the XML file. It must follow the host/path format. i.e. “directory.grandstream.com/engineering” The XML feature is activated when “Enable Idle Screen XML Download” is set to YES (HTTP or TFTP) and a valid “Idle Screen XML Server Path”...
  • Page 5 NOTE: As of April 2008 Grandstream Networks is working on a solution to be able to download phonebooks that are 100+ entries large. The phones currently only support 500 entries if they are entered manually. As a recommendation we suggest all XML phonebooks to be limited to 100 entries for the time being.
  • Page 6 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.
  • Page 7 </xs:sequence> <!-- This attribute is deprecated, please use the displayCondition element instead --> <xs:attribute name="a1reg" type="xs:boolean"/> <xs:attribute name="font" default="f8"> <xs:simpleType> <xs:restriction base="xs:string"> <xs:enumeration value="f8"/> Grandstream Networks, Inc. XML Application Guide Page 7 of 24 Last Updated: 3/2009...
  • Page 8 <xs:simpleType> <xs:restriction base="xs:string"> <!-- the UseURL option will also require the URL element and is not used now --> <xs:enumeration value="UseURL"/> <xs:enumeration value="NewCall"/> <xs:enumeration value="FwdAll"/> Grandstream Networks, Inc. XML Application Guide Page 8 of 24 Last Updated: 3/2009...
  • Page 9 <xs:enumeration value="CancelFwd"/> <xs:enumeration value="MissedCalls"/> <xs:enumeration value="CallReturn"/> <xs:enumeration value="PhoneBook"/> <xs:enumeration value="MainMenu"/> <xs:enumeration value="VoiceMail"/> </xs:restriction> </xs:simpleType> </xs:element> <xs:element name="displayCondition" type="IdleScreenConditionType" minOccurs="0" maxOccurs="1" nillable="true"/> </xs:sequence> </xs:complexType> </xs:schema> Grandstream Networks, Inc. XML Application Guide Page 9 of 24 Last Updated: 3/2009...
  • Page 10 <DisplayStr>$N</DisplayStr> <X>70</X> <Y>12</Y> </DisplayString> <DisplayString font="f13b" halign="Center" a1reg="true"> <DisplayStr>$N</DisplayStr> <X>70</X> <Y>12</Y> </DisplayString> <DisplayString font="f13h" halign="Center" a1reg="false"> <DisplayStr>$X</DisplayStr> <X>70</X> <Y>26</Y> </DisplayString> <DisplayString font="f13b" halign="Center" a1reg="true"> <DisplayStr>$X</DisplayStr> <X>70</X> Grandstream Networks, Inc. XML Application Guide Page 10 of 24 Last Updated: 3/2009...
  • Page 11 <Action> <MissedCalls/> </Action> <displayCondition> <conditionType>missCall</conditionType> </displayCondition> </SoftKey> <SoftKey> <Label>Cancel Fwd</Label> <Action> <CancelFwd/> </Action> <displayCondition> <conditionType>callFwded</conditionType> </displayCondition> </SoftKey> <SoftKey> <Label>Fwd All</Label> <Action> <FwdAll/> </Action> </SoftKey> </SoftKeys> </IdleScreen> </Screen> Grandstream Networks, Inc. XML Application Guide Page 11 of 24 Last Updated: 3/2009...
  • Page 12 When multiple instances of the same type (bitmap/string) are present, they are displayed in the order they appear in the XML and later objects (bitmap/string) may overwrite/corrupt previous objects. Grandstream Networks, Inc. XML Application Guide Page 12 of 24 Last Updated: 3/2009...
  • Page 13 This element carries the information on how a string is to be rendered on screen. It has three mandatory elements and four optional attributes: Element DisplayStr This element contains the string to be displayed <xsd:element name="DisplayStr" type="xsd:string" minOccurs="1" maxOccurs="1"/> Grandstream Networks, Inc. XML Application Guide Page 13 of 24 Last Updated: 3/2009...
  • Page 14 Account 1 is in REGISTERED state. When this attribute is present and the value is “false” then the string will be displayed only when SIP Account 1 is NOT in REGISTERED state. Grandstream Networks, Inc. XML Application Guide Page 14 of 24 Last Updated: 3/2009...
  • Page 15 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, Inc. XML Application Guide Page 15 of 24 Last Updated: 3/2009...

  • Page 16: Xml Phonebook

    </xsd:complexType> </xsd:element> </xsd:schema> XML P XAMPLE HONEBOOK <?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> </AddressBook> Grandstream Networks, Inc. XML Application Guide Page 16 of 24 Last Updated: 3/2009...
  • Page 17 A single XML object will represent the display area. This XML object takes precedence over the current display. It will also overwrite the soft keys functionality to give users control over the XML. Grandstream Networks, Inc. XML Application Guide Page 17 of 24 Last Updated: 3/2009...
  • Page 18 Grandstream GS_XML Object Descriptions Name Location Type Values Comments GS_XML_Application Root Mandatory Root element Display Root Body Optional Screen display SoftKeys Root Body Optional Programmable Softkey Events Root Body Optional Determines what action to be done when a local event...
  • Page 19 Action Event Body Mandatory Action to be taken if phone changes to that state An action is triggered only if the phone transition INTO such state. Grandstream Networks, Inc. XML Application Guide Page 19 of 24 Last Updated: 3/2009...
  • Page 20 </UseURL> </Action> </SoftKey> </SoftKeys> </GS_XML_Application > After receiving the 200 OK, the display and softkey area of the screen is changed to show the XML content:   Grandstream Networks, Inc. XML Application Guide Page 20 of 24 Last Updated: 3/2009...
  • Page 21 In this XML, note that the last word, “Survey”, displayed at the center of the screen is in a new Line element. Otherwise, it would be displayed off the screen and look like this screen:                 Grandstream Networks, Inc. XML Application Guide Page 21 of 24 Last Updated: 3/2009...

  • Page 22: Example Xml File

    </DisplayStr> </DisplayString> </Screen> </Display> <SoftKeys> <SoftKey> <Label>Dial</Label> <Action> <Dial> <Account>0</Account> <Number>3051</Number> </Dial> </Action> </SoftKey> </SoftKeys> <Events> <Event> <State>Onhook</State> <Action> <QuitApp/> Grandstream Networks, Inc. XML Application Guide Page 22 of 24 Last Updated: 3/2009...
  • Page 23   Pressing Dial dials 3051 with Account 1. After the survey is finished and the user hangs up, the survey is ended. The QuitApp action is triggered. Grandstream Networks, Inc. XML Application Guide Page 23 of 24 Last Updated: 3/2009...
  • Page 24 5. After completing one section of the survey, the user can jump to another category or automatically go to the next category by pressing the corresponding softkey. 6. After completing all the survey category’s the application will prompt the user to exit. Grandstream Networks, Inc. XML Application Guide Page 24 of 24 Last Updated: 3/2009...