Home

Documentation OpenStage 60/80

1. Command Default YES The Command is set as the default command in the optional context menu If more that one Command is set as the default command only the first one will be the default command NO Default value The Command is not set as the default command in the context menu Syntax lt IppCommand Type SELECT BACK UPDATE SCREEN CANCEL EXIT Priority Number Auto Number Key Key Value Value DisplayOn OPTIONS LISTITEM BOTH Select YES NO Default YES NO gt lt Label gt lt Label gt lt ScreenID gt lt ScreenID gt lt IppCommand gt Multiple occurrences of a type can appear on a screen In such cases the com mands should be distinguishable by the user element Label is missing a button is displayed with the Command type instead of If the Type attribute is missing or has an invalid value it is not displayed If the child a label e g SELECT Child elements e Label Contains the label for the menu item that is generated for the Command ScreenID Indicates which screen should be accessed next on activating a SCREEN Command The ScreenID is only appropriate if the Command type is SCREEN If the ScreenID is missing or invalid the current Screen will not be replaced but continue to be displayed November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 32 XML Object Reference Command Example lt xml version 1 0 encoding UTF 8 gt
2. gt lt xs restriction gt lt xs simpleType gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value BLACK gt lt xs enumeration value RED gt lt xs enumeration value GREEN gt lt xs enumeration value BROWN gt lt xs enumeration value BLUE gt lt xs enumeration value MAGENTA gt lt xs enumeration value CYAN gt lt xs enumeration value LIGHTGRAY gt lt xs enumeration value DARKGRAY gt lt xs enumeration value LIGHTRED gt lt xs enumeration value LIGHTGREEN gt lt xs enumeration value YELLOW gt lt xs enumeration value LIGHTBLUE gt lt xs enumeration value LIGHTMAGENTA gt lt xs enumeration value LIGHTCYAN gt lt xs enumeration value WHITE gt lt xs restriction gt lt xs simpleType gt lt xs union gt lt xs simpleType gt lt xs simpleType name gaugeTimeType gt lt xs union memberTypes xs nonNegativelInteger gt lt xs simpleType gt lt xs restriction base xs string gt lt xs pattern value d 2 d 2 gt lt xs restriction gt lt xs simpleType gt lt xs union gt lt xs simpleType gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 138 Appendix XML Schema lt xs simpleType name imagePath gt lt xs union gt lt xs simpleType gt lt xs restriction base xs string gt lt xs pattern value gt lt xs restriction gt lt xs simpleType gt lt xs simpleType gt
3. lt IppStringItem gt lt Label gt lt Label gt lt Text gt Record lt Text gt lt IppStringItem gt lt IppCommand Type SCREEN DisplayOn LISTITEM Pri ority 0 gt lt Label gt Select lt Label gt lt ScreenID gt 3 lt ScreenID gt lt IppCommand gt lt Ippitem gt lt IppForm gt lt IppScreen gt lt IppScreen ID 2 HiddenCount 1 CommandCount 2 gt lt IppPlayer State PLAYING Mode CALL Key Myplayer gt lt Url gt http subdomain domain path program lt Ur1 gt lt IppGauge Interactive AUTO Key Gl gt lt Label gt lt Label gt lt Maximum gt 100 lt Maximum gt lt Initial gt 0 lt Initial gt lt IppGauge gt lt IppPlayer gt lt IppScreen gt A31003 S2000 R100 7 7620 November 18 2009 103 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Player lt IppScreen ID 3 HiddenCount 1 CommandCount 2 gt lt IppPlayer State RECORDING Mode RECORD Key Myplayer gt lt Url gt http subdomain domain path program lt Ur1 gt lt IppGauge Interactive AUTO Key Gl gt lt Label gt Interactive Gauge lt Label gt lt Maximum gt 100 lt Maximum gt lt Initial gt 0 lt Initial gt lt IppGauge gt lt IppPlayer gt lt IppScreen gt lt IppDisplay gt lt IppPhone gt Screenshot 15 36 Wed 25 02 09 G 3338 Player Applications Settings 3400 Play Record Lucy Takeshi Play Record Mobility jm iw fu m lm November 18 200
4. lt Label gt String 2 Label lt Label gt lt Text gt String 2 Text lt Text gt lt IppStringItem gt lt IppForm gt lt IppCommand Type SELECT Priority 0 gt lt Label gt Select lt Label gt lt ScreenID gt 2 lt ScreenID gt lt IppCommand gt lt IppScreen gt lt IppDisplay gt lt IppPhone gt A31003 S2000 R100 7 7620 November 18 2009 71 OpenStage 60 80 XML Applications Developer s Guide Screenshot 10 43 Example Spacer Options String 1 Label String 2 Label November 18 2009 XML Object Reference Form Wed 09 05 07 4300 Applications Settings 3400 Lucy Takeshi String 1 Text String 2 Text Mobility Shift OpenStage 60 80 XML Applications Developer s Guide 72 XML Object Reference Form 4 13 4 Form TextField An entry field for user provided data is generated comparable to the lt input gt tag in HTML The entry field contains a label In addition the data type of the entry can be defined using the Constraint attribute The following attributes are available to the TextField element Attribute Value Function Remarks MaxSize Maximum number If the attribute is missing or the value is invalid the max optional of characters imum number of characters is limited by the capacity of the display and the buffer of the phone connected Missing negative Constrained by the display capabilities and buffers in or in
5. MidletName Name of the MIDlet Name of the application that is to be controlled by the Push request Depending on the type of Push request and the current state of the application the application may be started by the Push re quest This parameter is equivalent to the Appli cation name entered when the application was configured on the telephone see Section 3 1 Configuring an Application on the Phone ServerProtocol Communica tion protocol Indicates the protocol use by the server for com municating to the phone Examples http https future ServerContextKey Key The key for the key value pair that is returned to the program running on the server The server uses this key value pair to detect whether the XML document request goes back to the previous Push request that had been sent to the telephone ServerContextValue Value The value for the key value pair that is returned to the program running on the server Table 5 2 November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 110 Push Capability The Push Request A31003 S2000 R100 7 7620 November 18 2009 111 OpenStage 60 80 XML Applications Developers Guide Appendix Glossary 6 Appendix 6 1 Glossary Term Abbreviation Definition Description HFA HiPath Feature Access jad Java Application Descriptor Jar Java Archive File SIP Session Initiation Protocol Web Based Manager Telephone configuration pr
6. Using the Web Interface steps 1 to 5 2 Navigate to Network gt IP Configuration and enter the IP address of the proxy to be used IP configuration IP address 192 168 1 12 Subnetmask 255 255 255 0 Default route 192 168 1 251 DNS domain Primary DNS 192 168 1 105 Secondary DNS 194 25 0 53 Route 1 IP address Route 1 gateway Route 1 mask Route 2 IP address Route 2 gateway Route 2 mask VLAN discovery DHCP VLAN ID merw 3 Press Submit A31003 S2000 R100 7 7620 November 18 2009 13 OpenStage 60 80 XML Applications Developer s Guide Setup and Program Start Setting a Proxy 4 Navigate to Network gt Port Configuration and enter the port of the proxy to be used Port configuration SIP server 5060 SIP registrar 5060 SIP gateway 5060 SIP local 5060 Backup proxy 5060 RTP base 5010 Download server default 21 LDAP server 389 LAN port speed Automatic v PC port speed Automatic v PC pot mode disabled v PC port autoMDIX Oo 5 Press Submit The proxy is now configured 3 2 2 Using the Local Admin Menu 1 Repeat steps 1 4 in Section 3 1 3 Using the Local Admin Menu 2 With the TouchGuide navigate to the Network item To navigate you can either run your finger around the sensor ring or press the 4 or w key Press and navigate to the IP configuration item On the submenu opens 4 Navigate to HTTP
7. deactivated only by the user Missing negative or invalid Will default to FOREVER 45 A31003 S2000 R100 7 7620 November 18 2009 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Alert Syntax lt IppAlert Type ALARM CONFIRMATION ERROR INFO WARNING Delay Number FOREVER gt lt Title gt lt Title gt lt Url gt lt Url gt lt Text gt lt IppPhoneNumber gt lt IppPhoneNumber gt lt Text gt lt Image Cache n gt lt Image gt lt IppAlert gt Child elements e Title The title of the Alert is displayed in the title bar e Url This URL is used by a SELECT UPDATE or EXIT Command if such a Command is added to the alert Text Text in an Alert An IppPhoneNumber see Section 4 16 Phone Number can be con tained which enables the automatic translation of a phone number stored in the local phone book into an icon a picture clip or the name associated to the number e Image If an image is provided it will replace the standard symbol for the alert For more informa tion about the Image tag see Section 4 14 Image Please note that if the Text element contains an IppPhoneNumber the picture clip or phone type icon from the phonebook will override the image object Commands If one or more Commands are added to an Alert i e to the Screen containing the Alert these Commands will replace the implicit Dismiss command November 18 2009 O
8. record Table 4 6 The functions controlled by the TouchGuide are listed in the following table TouchGuide Button Function next first previous last cancel reset Long Press November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 100 XML Object Reference Player The following attributes are available to the TppPlayer element Attribute Value Function Remarks Mode CALL With this value the phone can be in Playing Edit mandatory and Stopped mode RECORD With this value the phone can be in Recording Stopped Record Edit Playback and Playback Re cording mode State PLAYING All buttons are displayed except for the Play button mandatory and the gauge is automatically updating STOPPED All buttons are displayed except for the Stop button and the gauge is not automatically updating RECORDING Only the Stop and the Delete button are displayed and the gauge is automatically updating Key Key for the Player Together with the function type of the player button mandatory that has been pressed the key forms a key value pair Please note that the Key must be unique within a Screen The following table shows the possible Player modes and their corresponding Interactive State and Mode values Player Mode Attributes Gauge State Mode Interactive Playing AUTO PLAYING C
9. Syntax lt IppTextField MaxSize Number Constraint ANY NUMERIC PASS WORD PHONENUMBER URL EMAILADDR PASSWORD YES NO Default NULL TEXT PHONENUMBER Key Key Uneditable YES NO gt lt Label gt lt Label gt lt Text gt lt Text gt lt IppTextField gt Child elements Label Label for identifying the entry field It is displayed in a two column layout the label is placed in the left column and the entry field is placed in the right column Text Text that is preset in the entry field Commands A Command is required to send the data to a server and initiate server action The Command can be displayed on the Options menu which is located underneath the Screen title or on the date field To achieve this both the field and the Command must be placed inside a Form Item has the focus Additionally the TouchGuide buttons are mapped in a different way If a Command is displayed on the Text Field an arrow is shown as soon as the field the key now opens the context menu so that only the key opens the editor For details please see Section Section 4 13 8 Form Item For details about the Command object see Section 4 6 Command November 18 2009 OpenStage 60 80 XML Applications Developers Guide 74 XML Object Reference Form Example lt xml version 1 0 encoding UTF 8 gt lt IppPhone gt lt IppDisplay gt lt IppScreen ID 1 HiddenCount 0 CommandCount 1
10. TRUE Key Key Value Value gt lt OptionText State GRAY NORMAL gt lt IppPhoneNumber gt lt IppPhoneNumber gt lt OptionText gt lt Image Cache Name gt lt Image gt lt Option gt lt IppList gt Child elements e Title Title text for the selection list e Url The URL to which the data of the selected option are sent If the URL is missing or is invalid the current screen will continue to be displayed unchanged November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 50 XML Object Reference List e Option This contains the data that are sent to the server It can also contain descriptive text OptionText and an image Image The following attributes are available to the element Attribute Value Function Selected FALSE Default value The option is not preselected optional TRUE The option is preselected When the IppList type is IMPLICIT the option is highlighted Key Key The key for the key value pair that is sent to the optional server as an HTTP POST request For selection lists of type IMPLICIT and EXCLUSIVE multiple options can have the same Key If the type is MUL TIPLE all the values must be different Value Value The value for the key value pair that is sent to the optional server as an HTTP POST request If the selection list type is MULTIPLE all the key value pairs are sent For selected options the value of the val
11. gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xS attribute ref Key use required gt lt xs attribute ref Value use required gt lt xs attribute ref FColor gt lt xs attribute ref TColor gt lt xs attribute ref SFColor gt lt xs attribute ref STColor gt lt xs complexType gt lt xs element gt A31003 S2000 R100 7 7620 November 18 2009 135 OpenStage 60 80 XML Applications Developer s Guide Appendix XML Schema lt xs element name OptionText gt lt xs complexType mixed true gt lt xs Sequence gt lt xs element ref IppPhoneNumber minOccurs 0 gt lt xs sequence gt lt xs attribute name State default NORMAL gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value NORMAL gt lt xs enumeration value GRAY gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs complexType gt lt xs element gt lt xs element name Text gt lt xs complexType mixed true gt lt xS Sequence gt lt xs element ref IppPhoneNumber minOccurs 0 gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name Time gt lt xs simpleType gt lt xs restriction base xs string gt lt xs pattern value d 2 d 2 d 2 d 3 gt lt xs restriction gt lt xs simpleType gt lt xs element gt lt xs element name Timezone
12. key toggles be tween the Settings menu the Applications menu and the applications currently running With the TouchGuide navigate to the Admin menu and press You are prompted to enter the administrator password If the password is numeric just type it using the number keys On typing the first digit an input text field will open up For entering non numeric characters press the key once or repeatedly depending on the desired character The key cycles around the input modes as follows Abc gt abc gt ABC gt 123 gt back to start To correct an entry use the key Press The admin menu opens A31003 S2000 R100 7 7620 November 18 2009 OpenStage 60 80 XML Applications Developer s Guide Setup and Program Start Configuring an Application on the Phone 5 With the TouchGuide navigate to the Applications item To navigate you can either run your finger around the sensor ring or press the 4 or key 6 Press to open the Applications item and select XML On Add application appears in the context menu 7 Press to open the menu for configuring new application 8 Inthe application menu enter the configuration data for details see Section 3 1 1 Re quired Data e Display name Application name for display e Application name Internal name for the application e Protocol Client server communication protocol HTTP or in the future HTTPS e Server address IP address of serv
13. lt IppPhone gt lt IppDisplay gt lt IppScreen ID 1 HiddenCount 0 CommandCount 2 gt lt IppList Type EXCLUSIVE Count 3 gt lt Title gt Command lt Title gt lt Url gt http subdomain domain path program lt Ur1 gt lt Option ID 1 Selected FALSE Key key Value 1 gt lt OptionText gt Option 1 lt OptionText gt lt Option gt lt Option ID 2 Selected TRUE Key key Value 2 gt lt OptionText gt Option 2 lt OptionText gt lt Option gt lt Option ID 3 Selected FALSE Key key Value 3 gt lt OptionText gt Option 3 lt OptionText gt lt Option gt lt IppList gt lt IppCommand Type SELECT DisplayOn BOTH Priority 1 gt lt Label gt Select lt Label gt lt ScreenID gt 2 lt ScreenID gt lt IppCommand gt lt IppScreen gt lt IppDisplay gt lt IppPhone gt A31003 S2000 R100 7 7620 November 18 2009 33 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Command Screenshot 13 23 Jes AA 4711 Alternate Examples Applications Command Repeat Dial Options Charlie B Option 1 Linus Option 2 C Option 3 Mobility November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 34 XML Object Reference Direct Keypad Input 4 7 Direct Keypad Input 4 7 1 Overview In addition to regular user input by the means of input fields it is possible to send keypad entries to the remote server in realtime or alternatively in bu
14. lt xs restriction base xs string gt lt xs pattern value file gt lt xs restriction gt lt xs simpleType gt lt xs simpleType gt lt xs restriction base xs string gt lt xs pattern value http gt lt xs restriction gt lt xs simpleType gt lt xs simpleType gt lt xs restriction base xs string gt lt xs pattern value map gt lt xs restriction gt lt xs simpleType gt lt xs union gt lt xs simpleType gt lt xs simpleType name timeZoneType gt lt xs union memberTypes xs string gt lt xs simpleType gt lt xs restriction base xs string gt lt xs pattern value GMT d gt lt xs restriction gt lt xs simpleType gt lt xs union gt lt xs simpleType gt lt xs schema gt A31003 S2000 R100 7 7620 November 18 2009 139 OpenStage 60 80 XML Applications Developer s Guide
15. name or the name of a servlet To start a tab on demand this parameter must contain the appro priate application name Tab 1 3 Application name see Section 3 1 Configuring an Applica tion on the Phone and Section 3 4 Application Suite Using Tabs On Demand Table 5 2 109 A31003 S2000 R100 7 7620 November 18 2009 OpenStage 60 80 XML Applications Developer s Guide Push Capability The Push Request Key Value Function RequestType active The XML document is loaded if the program is al ready started If the document contains a popup IppAlert or a player IppPlayer and no oth er popup or player is shown already the player or popup is displayed For detailed information see the table in Section 5 Active queue The program is started in the background and the XML document is loaded For detailed information see the table in Section 5 Queue indicate The program is started and the XML document is loaded If the document contains a popup IppA lert ora player IppPlayer and no other pop up or player is shown already the player or popup is displayed For detailed information see the ta ble in Section 5 Indicate force The program is started and the XML document is loaded It is displayed to the user with input focus unless a prompt e g incoming call Alert or Dialer is showing For detailed information see the table in Section 5 Force
16. unbounded gt lt XS curs unbounded gt lt XS curs unbounded gt lt XS curs unbounded gt lt XS bounded gt lt XS curs unbounded gt lt XS curs unbounded gt lt XS curs unbounded gt element can be removed from the XML document the XML document If they will be correctly ref IppButton minOccurs 0 maxOc element ref element element ref ref element ref element ref element ref element ref element lt xs choice gt lt xs sequence gt lt xs attribute name ItemCount type xs nonNegativelnteger use required gt November 18 2009 OpenStage 60 80 XML Applications Developers Guide ref IppImageItem IppItem IppSpacer IppChoiceGroup minOccurs 0 maxOc IppDateField minOccurs 0 maxOc ppGauge minOccurs 0 maxOc minOccurs 0 maxOc minOccurs 0 maxOccurs un minOccurs 0 maxOc IppStringItem minOccurs 0 maxOc IppTextField minOccurs 0 maxOc 122 Appendix XML Schema 123 lt xs attribute name Proportion use optional de fault 40 60 gt lt xs simpleType gt lt xs restriction base xs string gt lt XS lt XxXS enumeration lt XS lt XS lt XS lt XS lt XS enumeration enumeration enumeration enumeration enumeration enumeration lt xs restriction gt lt xs
17. 0 gt lt xs sequence gt lt xs attribute name MaxSize type xs nonNegativelInteger use optional gt lt xs attribute name Constraint use optional de fault ANY gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value ANY gt lt xs enumeration value NUMERIC gt lt xs enumeration value PASSWORD gt lt xs enumeration value PHONENUMBER gt lt xs enumeration value URL gt lt xs enumeration value EMATLADDR gt lt xs enumeration value VALIDATE gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs attribute name Password use optional default NO gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value YES gt lt xs enumeration value NO gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xS attribute name Uneditable use optional default NO gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value YES gt lt xs enumeration value NO gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs attribute ref Default use optional default NULL gt lt xs attribute ref Key use optional gt lt xs complexType gt lt xs element gt A31003 S2000 R100 7 7620 November 18 2009 133 OpenStage 60 80 XML Applications Developer s Guide Appendix XML Schema lt xs element name
18. 07 4300 E Example Wm Nee lier isle sul rec 3400 DateField Lucy Takeshi Time 13 00 Date 09 03 2007 Date and Time 09 09 2007 13 00 Mobility Shift November 18 2009 OpenStage 60 80 XML Applications Developers Guide 84 XML Object Reference Form 4 13 7 Form Button The Button object generates a clickable area When clicked the key value pair contained in the attributes of the IppButton element as well as the key value pairs of any Hidden objects in the XML document see Section 4 12 Hidden are immediately sent to the server The URL of the server side program is indicated in the Form element Adjacent buttons are placed vertically The following attributes are available to the TppButton element Attribute Value Function Type IMAGE Default value In the current versions this is the only optional possible value The button is represented by an im age Key Key The key for the key value pair that is sent to the serv mandatory er as an HTTP request Please note that the Key must be unique within a Screen Value Value The value for the key value pair that is sent to the mandatory server as an HTTP request Table 4 5 Syntax lt IppButton Type IMAGE Key Key Value Value gt lt Label gt lt Label gt lt Image Cache n gt lt Image gt lt IppButton gt Child elements e Label Generates a label for identifying the button e Image Links an image file The imag
19. IppTicker gt lt xs complexType gt lt xKS Sequence gt lt xs element ref Text minOccurs 0 gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name AltText type xs string gt lt xs element name Date gt lt xs simpleType gt lt xs restriction base xs string gt lt xS pattern value d 4 d 2 d 2 gt lt xs restriction gt lt xs simpleType gt lt xs element gt lt xs element name Image gt lt xs complexType gt lt xs simpleContent gt lt xs extension base imagePath gt lt xs attribute name Cache type xs string gt lt xs extension gt lt xs simpleContent gt lt xs complexType gt lt xs element gt lt xs element name Initial type gaugeTimeType gt lt xs element name Label type xs string gt lt xs element name Maximum type gaugeTimeType gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 134 Appendix XML Schema lt xs element name Option gt lt xs complexType gt lt XS sequence gt lt xs element ref OptionText maxOccurs 3 gt lt xs element ref Image minOccurs 0 gt lt xs sequence gt lt xS attribute name ID type xs nonNegativelnteger use optional gt lt xS attribute name Selected use required gt lt default FALSE gt gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value TRUE gt lt xs enumeration value FALSE
20. Number CommandCount Number gt lt IppKey gt IppAction gt IppCommand gt Alert gt ppList gt TextBox gt icker gt idden gt Form gt Player gt lt IppScreen gt lt IppPhone gt ANAAA AA AA D D D 1D T am TD TD November 18 2009 OpenStage 60 80 XML Applications Developers Guide 26 XML Object Reference Action 4 5 Action Actions provide a request mechanism to the phone to perform specified tasks For example make a call to a specified number and end the call Thus in order to be able to clear a call down the application must be running whilst the call is in progress If the application is stopped and restarted whilst the call is in progress the newly started application can not clear the call because it did not ini tiate it For security reasons an XML application can only clear a call that it has initiated switched on or off by a special action type If Xpressions is configured on the phone the LED on the message mode key can be Attribute Value Functionality Remarks TYPE MAKECALL A call to the telephone number specified in the child el mandatory ement lt Number gt is initiated The possible formats for the call number depend on the phone s dial settings Please refer to the Administration Manual of the phone chap 3 8 ENDCALL Ends the call made by a MAKECALL action TURNLEDON Turns on the LED on the message mo
21. and year The time is shown as two separate fields hours and minutes The user cannot enter seconds however seconds are returned with a default value of 00 000 If the key in a Date Field is invalid or not present the URL indicated in the form is opened but the data contained in the Date Field are not sent The following attributes are available to the IppDateField element Attribute Value Function Mode DATE Only the content of the Date field is submitted to the optional server TIME Only the content of the Time field is submitted to the server DATETIME Default value The contents of the Date field and of the Time field are submitted to the server Default NULL Default value The field is empty when the XML docu optional ment is loaded MODE The contents of Date or Time are displayed when the XML document is loaded DateKey Key for the date field Together with the content of the Date field this builds optional the key value pair to be sent to the server as an HTTP request TimeKey Key for the time field Together with the content of the Time field this builds optional the key value pair to be sent to the server as an HTTP request Syntax lt IppDateField Mode DATE TIME DATETIME Default NULL MODE DateKey Key TimeKey Key gt lt Label gt lt Label gt lt TimeZone gt lt TimeZone gt lt Date gt lt Date gt lt Time gt lt Time gt lt IppDateFie
22. are A new alert is cre When alerts are A new alertis cre pushed anew ated pushed anew ated alert is created alert is created Otherwise the Otherwise the existing alert is existing alert is overwritten overwritten Form An existing form A new form is cre An existing form A new form is cre is overwritten ated is overwritten ated List A new list is cre A new list is cre The existing listis A new list is cre ated ated reused ated Player The existing play A new player is The existing play A new player is er is overwriten created er is overwriten created Text Box The existing text A new text box is The existing text A new text box is box is overwrit created box is overwrit created ten ten Table 2 1 A31003 S2000 R100 7 7620 November 18 2009 7 OpenStage 60 80 XML Applications Developers Guide 3 3 1 Setup and Program Start Configuring an Application on the Phone Setup and Program Start Configuring an Application on the Phone For setting up an XML Application the WBM Web Based Manager the local admin menu or the DLS Deployment Service can be used For the latter please refer to the Deployment Ser vice Administration Manual A maximum number of 20 XML applications can be configured on OpenStage 60 80 phones Please ensure that the following prerequisites are fulfilled Firmware version SIP V1R3 x or higher or HFA V2R0 x or higher The terminal numbe
23. box using the v key and then open the text editor by pressing the key When the data input is completed the user can confirm his input by pressing the gt key and the key Predefined content a title for the textbox the permitted data types Constraint as wellasa server URL for data transmission can be specified The following attributes are available to the TppTextBox element Attribute Value Functionality Remarks MaxSize Maximum number If missing negative or invalid the maximum number of optional of characters characters is limited only by the capacity of the display and the buffer of the phone connected Constraint ANY Default value Any character string is permitted optional NUMERIC The data entered must be numeric Other entries are ig nored The valid data range is 2147483647 PASSWORD The data entered are treated as a password Asterisks are displayed instead of the characters ac tually entered PHONENUMBER The data entered must be in a telephone number for mat URL The data entered must represent a valid URL EMAILADDR The data entered must represent a valid e mail ad dress Password YES The data entered in the Text Box is confidential and optional should be obscured whenever possible NO Default Default NULL An empty Text Boxis displayed the content of the Text optional element is ignored TEXT The Text Box contains the content of the Text eleme
24. different types are 1 Active The request contains non essential information which should only be displayed if the required XML application is already running The information is displayed in a non in trusive manner If the required XML application is not running nothing changes as it is not started on Push 2 Queue The request contains information that does not have to be presented immediately to the user e g offers restaurant menu message of the day If the required XML appli cation is not running it is started on Push The user chooses when to display the informa tion 3 Indicate The request contains non essential information e g received new email update message playback progress If the required XML application is not running it is started on Push The information is displayed to the user in a non intrusive manner The user can choose to continue with the current application or switch to the new information November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 106 Push Capability Phone Number For most cases Indicate is the best option It is a compromise between displaying most information and limiting the interruption to the currently displayed application 4 Force The request contains urgent information that must be immediately displayed to the user The user is automatically switched from the current application telephony or XML to the required XML application This option should on
25. eee se a Rea ee he ed one he bee 61 4 13 FOMM goon een Os eh See hee a eee ore eee ia Ge eee eee Seren eee eee 63 AA AMAGe PT tah een en Rae oe Seema Bee ae bie A 96 415 Playe PPT eta tro woh a dB vn ico a Ba Ni E 0 Dm are Ah eh ete iraa 98 4 16 Phone Number ooo nien enn e thee dda aa A Oe AOR ed a ae eee hee aA 105 5 Push Capability ic sus ccc ect e ieee dd ede etek eee ee te eee E 106 5 1 The Push Request cece 4 Sais bou ss odes dbvadawwdebdasegeee hdaas ae an 109 Sees i ee eee ee 112 Del GIOSSANy wae mestna reana oud eeeseubnes Hacweteugteetaseneens case EREE 112 6 2 XML Schema 2 ani ta apercu sites mat neo 113 A31003 S2000 R100 7 7620 November 18 2009 1 OpenStage 60 80 XML Applications Developers Guide Introduction Overview 1 Introduction 1 1 Overview With the OpenStage 60 80 models a multitude of applications with GUI can be deployed As XML and HTTP serve as client server interface the technologies commonly used in web applications can be used Java Servlets JSP PHP CGI etc delivered by servers such as Tom cat Apache Microsoft IIS The Push feature enables the server side application to send data to the phone in an unsolic ited way The XML application interface is available in the SIP firmware from V1R3 x or the HFA firm ware from V2R0 x for OpenStage 60 80 phones This document describes the XML interface and the error handling in case the XML data is in valid Please note that the erro
26. enter a PIN The user presses a sequence of keypad digits terminated by The digits are buffered until the is detected After this all of the digits including the are sent en bloc to the remote program November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 36 XML Object Reference Direct Keypad Input 4 7 3 Typical Client Server Interactions This section describes typical interactions between the phone side XML application and the server side program with different keypad sending settings 4 7 3 1 Sending Keypad Keys Enabled and Immediate Submission In the following interaction the remote program enables send keypad input and disables buff ering As soon as the user presses a keypad key the screen updates User XML Application Remote Pro gram Request next XML docu gt ment Screen a XML document with key Send XML Updated pad sending enabled document SendKeys YES Keypad YES Keypad key Send keypad key op gt Process input tional IppHidden data Screen a XML document with key Send XML Updated pad sending enabled document SendKeys YES Keypad YES Keypad key Send keypad key op gt Process input tional IppHidden data A31003 S2000 R100 7 7620 November 18 2009 37 OpenStage 60 80 XML Applications Developer s Guide 4 7 3 2 Disable Sending Keypad Keys XML Object Reference Direct Keypad Input In the following interaction the remote XML application initially enables se
27. lt xs simpleType gt lt xs attribute gt lt xS attribute ref Key use required gt lt xs complexType gt lt xs element gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 124 Appendix XML Schema lt xs element name Ilpplmageltem gt lt xs complexType gt lt XS sequence gt lt xs element ref Label minOccurs 0 gt lt xs element ref Image minOccurs 0 gt lt xs element ref AltText minOccurs 0 gt lt xs sequence gt lt xs attribute name Layout use optional default CENTER gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value CENTER gt lt xs enumeration value DEFAULT gt lt xs enumeration value LEFT gt lt xs enumeration value NEWLINE AFTER gt lt xs enumeration value NEWLINE BEFORE gt lt xs enumeration value RIGHT gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs complexType gt lt xs element gt lt xs element name Ippitem gt lt xs complexType gt lt xsS Sequence gt lt xs choice gt lt xs element ref IppButton minOccurs 0 gt lt xs element ref IppChoiceGroup minOccurs 0 gt lt xs element ref IppDateField minOccurs 0 gt lt xs element ref IppGauge minOccurs 0 gt lt xs element ref IppImagelItem minOccurs 0 gt lt xs element ref IppSpacer minOccurs 0 gt lt xs element ref
28. lt xs enumeration value BOTH gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs complexType gt lt xs element gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 128 Appendix XML Schema lt xs element name IppPlayer gt lt xs complexType gt lt xs Sequence gt lt xs element ref Url minOccurs 0 gt lt xs element ref IppGauge minOccurs 0 gt lt xS sequence gt lt xS attribute name State use required gt lt default STOPPED gt gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value PLAYING gt lt xs enumeration value RECORDING gt lt xs enumeration value STOPPED gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xS attribute name Mode use required gt lt default CALL gt gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value CALL gt lt xs enumeration value RECORD gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xS attribute ref Key use required gt lt xs complexType gt lt xs element gt A31003 S2000 R100 7 7620 November 18 2009 129 OpenStage 60 80 XML Applications Developer s Guide Appendix XML Schema lt xs element name IppSpacer gt lt xs complexType gt lt xs attribute name NewLine use required gt lt default NEWLINE_BEF_AFT g
29. may contain none one or more Choice Groups The uniqueness of keys and values is not checked in the telephone The following attributes are available to the TppCho iceGroup element Attribute Value Function Type EXCLUSIVE Default value Exactly one option can be selected radio mandatory button function On submit only the key value pair se lected is sent to the server MULTIPLE One or more options can be selected On submit all the key value pairs are sent to the server For selected op tions the value of the value attribute is then sent for non selected options this value is prefixed with not_ POPUP On startup only the preselected option is shown On pressing a context menu containing all options opens up Acontext menu option is selected by pressing when it has the focus To submit the selection made in the context menu the SELECT command must be is sued just like with the other ChoiceGroup types Count Number of op Only as many options as indicated here are displayed mandatory tions If the actual number of options is greater all further op tions that exceed this setting are ignored 0 No options are displayed Syntax lt IppChoiceGroup Type EXCLUSIVE MULTIPLE POPUP Count Number gt lt Label gt lt Label gt lt Option Selected FALSE TRUE Key Key Value Value gt lt OptionText gt lt OptionText gt lt IppPhoneNumber gt lt IppPhoneNumber
30. on server Number of tabs 0 v Tab 1 Display Name Tab 1 Application Name Tab 2 Display Name Tab 2 Application Name Tab 3 Display Name Tab 3 Application Name Auto restart o 4 Press Delete to remove the application 3 3 2 Using the Local Admin Menu The basics for accessing the phone s local admin menu are described here For more detailed information please consult the user manual or the administration manual 3 3 2 1 Reconfigure 1 Repeat steps 1 5 in Section 3 1 3 Using the Local Admin Menu 2 Press to open the Applications item and select XML On Add application and the names of the previously configured applications appear in the context menu 3 Navigate to the program that you would like to reconfigure and press 4 Inthe application specific menu enter the data required for the configuration of a program see Section 3 1 1 Required Data 5 When the configuration data is correct and complete navigate to Save amp exit and press A31003 S2000 R100 7 7620 November 18 2009 17 OpenStage 60 80 XML Applications Developer s Guide Setup and Program Start Starting the Application 3 3 2 2 Removing 1 Repeat steps 1 5 in Section 3 1 3 Using the Local Admin Menu 2 Press to open the Applications item and select XML On Add application and the names of the previously configured applications appear in the context menu Navigate to the program t
31. phones On A31003 S2000 R100 7 7620 November 18 2009 97 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Player 4 15 Player streaming The XML document requests the setting up of a call for voice streaming and the displaying of the player from the server All player commands issued by the user are sent to the server which controls the streaming The Player is a special extension designed for applications that involve audio The Player is a transient screen replacing the current screen on the display However those parts of the current screen which are not covered by the player are still visible in the back ground The player displays the current progress through a media stream and offers the func tions Play Pause Stop Rewind Skip rewind Forward Skip forward Call and Delete similar to existing audio players The user interface consists of a gauge and a number of buttons The gauge may be interactive or non interactive The gauge value is automatically updated on the phone providing a time based maximum value is supplied For further information please refer to Section 4 13 9 Form Gauge The player has eight modes of operation which dictates the state behaviour and appearance of the player Playing Edit Stopped playing Recording Stopped record Playback recording Edit playback and Disabled The Disabled mode is controlled locally on the phone whereas the other seve
32. simpleType gt lt xs attribute gt lt xs attribute name Count type xs nonNegativelnteger use required gt lt xs attribute name Columns use optional default 1 gt lt xs simpleType gt lt xs restriction base xs nonNegativelnteger gt lt xs enumeration value 1 gt lt xs enumeration value 3 gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs attribute ref FColor gt lt xs attribute ref TColor gt lt xs attribute ref SFColor gt lt xs attribute ref STColor gt A31003 S2000 R100 7 7620 November 18 2009 127 OpenStage 60 80 XML Applications Developer s Guide Appendix XML Schema lt default 0 gt gt lt xs complexType gt lt xs element gt lt xs element name IppPhoneNumber gt lt xs complexType gt lt XS sequence gt lt xs element ref AltText minOccurs 0 gt lt xs sequence gt lt xs attribute name ImageType use optional default NOIM AGE gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value NOIMAGE gt lt xs enumeration value PHONETYPE gt lt xs enumeration value PICTURECLIP gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs attribute name NumberType use optional default NUM BER gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value NUMBER gt lt xs enumeration value NAME gt
33. the phone type according to the given optional phone number is displayed PICTURECLIP The picture clip associated to the participant is dis played if available NumberType NUMBER Only the number is displayed optional NAME Only the corresponding name in the Phone Book is displayed BOTH Both the number and the corresponding name in the Phone Book are displayed A31003 S2000 R100 7 7620 November 18 2009 105 OpenStage 60 80 XML Applications Developer s Guide Push Capability Phone Number For consistency with the style for presentations of call identities on OpenStage ImageType should equal PICTURECLIP and NumberType should equal NAME Syntax lt IppPhoneNumber ImageType PHONETYPE PICTURECLIP NumberType NUMBER NAME BOTH gt lt AltText gt lt AltText gt lt IppPhoneNumber gt Child elements e AltText In case the number does not exist in the Phone Book the alternative text is displayed in stead of the number name or picture clip 5 Push Capability A Push request is a specific HTTP or HTTPS future request that is sent from the remote serv er to the Web service of the telephone For further information see Section 5 1 The Push Request The server must communicate the nature of the unsolicited Push request There are four dif ferent types of Push The type influences when where and how the information is displayed to the user The four
34. type timeZoneType gt lt xs element name Title type xs string gt lt xs element name Url type xs anyURI gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 136 Appendix XML Schema 137 lt XS lt XS lt XS lt XS lt XS lt XS lt XS lt XS lt XS lt XS lt XS attribute name DateKey element name Value attribute name Default gt lt xs simpleType gt type xs string gt type xs string gt lt xs restriction base xs string gt lt xs enumeration value NULL gt lt xs enumeration value TEXT gt lt xs enumeration value PHONENUMBER gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt attribute attribute attribute attribute attribute attribute name FColor name Key name SFColor name STColor name TColor name TimeKey attribute attribute name Value name UrlKey type colourType gt type xs string gt type colourType gt type colourType gt type colourType gt type xs string gt type xs string gt type xs string gt A31003 S2000 R100 7 7620 November 18 2009 OpenStage 60 80 XML Applications Developer s Guide Appendix XML Schema lt xs simpleType name colourType gt lt xs union gt lt xs simpleType gt lt xs restriction base xs string gt lt xs pattern value 0 9ABCDEF 6
35. 20 lt Initial gt lt IppGauge gt lt IppForm gt lt IppCommand Type SELECT Priority 0 gt lt Label gt Select lt Label gt lt ScreenID gt 2 lt ScreenID gt lt IppCommand gt lt IppScreen gt lt IppDisplay gt lt IppPhone gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 94 XML Object Reference Form Screenshot 10 59 Wed 09 05 07 4300 E Example AE Er 3400 Interactive Gauge Lucy Takeshi Interactive Ga 95 Mobility Shift A31003 S2000 R100 7 7620 November 18 2009 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Image 4 14 Image The Image element is used to link an image The XML document specifies whether the image should be cached or not The image is downloaded from the server via HTTP analogous to images in HTML pages the source of the image file the cache name must be defined as well This is neces sary because specific areas in the cache are overwritten when sufficient memory is not available and new images are loaded When this occurs the previously cached images that have been overwritten must be reloaded Saving images in cache is explicitly indicated in the XML document In addition to The following attributes are available to the Image element Attribute Value Function Cache Name The image can be accessed in cache under the name optional indicated here If the attribute is invalid or no
36. 4 Appli cation Suite Using Predefined Tabs and Section 3 4 Application Suite Using Tabs On Demand e Restart after change If checked a running XML application is automatically restarted after it has been modified After the XML application has restarted this option is auto matically unchecked A31003 S2000 R100 7 7620 November 18 2009 9 OpenStage 60 80 XML Applications Developer s Guide Setup and Program Start Configuring an Application on the Phone 3 1 2 Using the Web Interface 1 Open your web browser MS Internet Explorer or Firefox and enter the transfer protocol IP address and port number of your phone If HTTP is used port 8085 must be added for example http 192 168 1 15 8085 For HTTPS the phone uses the standard port 443 If the browser displays a certificate notification confirm it The start page of the web inter face appears In the upper right corner the phone number the phone s IP address and the DNS name assigned to the phone are displayed The left column contains the user menu tree Phone IP Adr 192 168 1 15 SI E M E N S OpenStage 60 SIP Name 4711 DNS Name User Pages Administrator Pages User Login Date and time z Bluetooth User Login Audio Enter User password o User Configuration Phone Locality Security 2 Click on the Administrator Pages tab In the dialog box enter the administrator password Admin Login Enter Admin password 3 The admin
37. 5 Left column 75 right column 25 63 A31003 S2000 R100 7 7620 November 18 2009 OpenStage 60 80 XML Applications Developers Guide XML Object Reference Form Syntax lt IppForm ItemCount Number Proportions 0_100 15_85 25_75 40_60 50_50 60_40 75_25 gt lt Title gt lt Title gt Url gt lt Url gt IppStringItem gt Ipplmageltem gt ppSpacer gt ppTextField gt ppChoiceGroup gt IppDateField gt IppButton gt Ippitem gt lt IppGauge gt lt IppForm gt AN AAA AAA A A Child elements e Title Title of the Form yrl URL of the server to which the data is to be sent data to be sent to a server the screen will continue to be displayed unchanged If the URL indicated in the Ur1 element is missing or invalid thereby allowing no November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 64 XML Object Reference Form 4 13 1 Form Stringltem This object provides a read only text field The text field consists of a label and the actual text The label is displayed in the left column and the text is shown in the right column Syntax lt IppStringItem gt lt Label gt lt Label gt lt Text gt lt Text gt lt IppStringItem gt Child elements Label Label that precedes the text Text Content in the text field Commands A Stringltem can be made interactive by adding a Command To achieve this both the Stringltem and the Comman
38. 9 OpenStage 60 80 XML Applications Developer s Guide 104 XML Object Reference Phone Number 4 16 Phone Number This element enables the translation of a given phone number which is stored in the local phone book The phone number can be translated to e the name of the participant e the picture clip associated to the participant if available e or alternatively an icon of the phone type e g mobile number home number etc If the translation fails alternative text can be displayed instead of the phone number Depending on the GUI element wherein the Phone Number is placed some or all of the infor mation listed above may be displayed instead of or in addition to the phone number For example e An Alert can display the name number and picture clip of the participant if available or an icon of the phone type see Section 4 8 Alert top line and the number is placed immediately below it In alerts if the name and number are both displayed the name is placed on the e A single column List or the left hand column in a multiple column List can display a picture or an icon followed by the name or number see Section 4 9 List e Any other column in a multiple column List can only display the name or number see Sec tion 4 9 List The following attributes are available to the TppPhoneNumber element Attribute Value Function Remarks ImageType PHONETY PE The icon of
39. ALL Edit USER STOPPED CALL Stopped AUTO STOPPED CALL Recording AUTO RECORDING RECORD Stopped AUTO STOPPED RECORD Record Edit Playback USER STOPPED RECORD Playback Re AUTO PLAYING RECORD cording Table 4 7 A31003 S2000 R100 7 7620 November 18 2009 101 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Player Syntax lt IppPlayer State PLAYING STOPPED RECORDING Mode CALL RECORD Key Key gt lt Url gt lt Url gt lt IppGauge gt lt IppGauge gt lt IppPlayer gt Child Elements Url The URL invoked when a button is pressed IppGauge The Interactive attribute must be set to USER or AUTO according to the current state and mode of the Player For details please refer to Table 4 6 November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 102 XML Object Reference Player Example lt IppPhone gt lt IppDisplay InitialScreen 1 gt lt IppScreen ID 1 HiddenCount 0 CommandCount 2 gt lt IppForm ItemCount 2 gt lt Title gt Play Record lt Title gt lt Url gt http subdomain domain path program lt Ur1 gt lt IppiItem CommandCount 1 gt lt IppStringItem gt lt Label gt lt Label gt lt Text gt Play lt Text gt lt IppStringItem gt lt IppCommand Type SCREEN DisplayOn LISTITEM Priority 0 gt lt Label gt Select lt Label gt lt ScreenID gt 2 lt ScreenID gt lt IppCommand gt lt ITppltem gt lt Ippltem CommandCount 1 gt
40. Documentation OpenStage 60 80 XML Applications Developer s Guide A31003 S2000 R100 7 7620 Communication for the open minded Siemens Enterprise Communications SI E M E N S www siemens com open Copyright Siemens Enterprise Communications GmbH amp Co KG 2004 Hofmannstr 51 D 80200 M nchen Siemens Enterprise Communications GmbH amp Co KG is a Trademark Licensee of Siemens AG Reference No A31003 S2000 R100 7 7620 The information provided in this document contains merely general descriptions or characteristics of performance which in case of actual use do not always apply as described or which may change as a result of further development of the products An obligation to provide the respective characteristics shall only exist if expressly agreed in the terms of contract Availability and technical specifications are subject to change without notice OpenScape OpenStage and HiPath are registered trademarks of Siemens Enterprise Communications GmbH amp Co KG All other company brand product and service names are trademarks or registered trademarks of their respective holders 1 Introduction 4444 eee eee 2 Meth UE VIEW ra fo ea se E E ena MW cae steed am aoe Sse ee ee ee ea ene es ese wane E Ses 2 1 2 Prereq isit S oj LES ewe dees ose nde a Seek mak eh ee ce Se ee he Sa ee eS 3 2 Operating Mode and Features 4 24 Wier MMS Sr ae cn
41. Hidden elements and the key value pair associated with the Command if present are sent to the server As op posed to a SELECT Command no key value pairs from the current List TextBox Form or Player are sent to the server SCREEN Switches to the Screen specified in the child element ScreenID The server side program is not informed of this action If the data in ScreenID are missing or invalid the cur rent screen will continue to be displayed CANCEL Used to undo a selection made in selection lists List Form ChoiceGroup or an entry made in input fields TextBox Form TextField Form DateField The con tents of the current screen revert back to their default values cached on the phone EXIT Ends the program November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 30 XML Object Reference Command Priority optional Priority integer This determines the order of the Command objects whereby 0 represents the one with the highest priority followed by 1 and so on Auto optional Total duration in seconds The Command object is automatically executed after the specified time that is without the user doing any thing If multiple Command objects containing the Auto attribute exist the one that is set for the shortest total duration is executed This means that only one com mand per Screen is executed automatically 0 or missing or negative or inv
42. IppStringItem minOccurs 0 gt lt xs element ref IppTextField minOccurs 0 gt lt xs choice gt lt xs element ref IppCommand minOccurs 0 maxOccurs un bounded gt lt xSs sequence gt lt xs attribute name CommandCount type xs nonNegativelnte ger use required gt lt default 0 gt gt lt xs complexType gt lt xs element gt A31003 S2000 R100 7 7620 November 18 2009 125 OpenStage 60 80 XML Applications Developer s Guide Appendix XML Schema lt xs element name IppKey gt lt xs complexType gt lt xs attribute name Keypad use required gt lt default NO gt gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value NO gt lt xs enumeration value YES gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs attribute name SendKeys use required gt lt default NO gt gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value NO gt lt xs enumeration value YES gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs attribute name BufferKeys use optional default NO gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value NO gt lt xs enumeration value YES gt lt xs enumeration value SUBSEQUENT gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs attribute n
43. L Object Reference Form 4 13 2 Form Imageltem This object functions as a frame for linking an image in the Screen layout In case the image cannot be displayed an alternative text is shown instead if provided Also a label can be add ed which is displayed in the left column Syntax lt Ipplmageltem gt lt Label gt lt Label gt lt Image Cache Name gt lt Image gt lt AltText gt lt AltText gt lt IppImageItem gt Child elements e Label Label for the image it is displayed in the left column Image Links the image file For more information about the Image element see Section 4 14 Im age e AltText Alternative text that is displayed if the image cannot displayed Commands An Image Item can be made interactive by adding one or more Commands As a specific fea ture of Image Items the context menu will contain an additional Command for closing the con text menu This Command is labeled Exit menu To add a Command both the Image Item and the Command must be placed inside a Form Item For details please see Section 4 13 8 Form Item For details about the Command object see Section 4 6 Command November 18 2009 OpenStage 60 80 XML Applications Developers Guide 68 XML Object Reference Form Example lt xml version 1 0 encoding UTF 8 gt lt IppPhone gt lt IppDisplay gt lt IppScreen ID 1 HiddenCount 0 CommandCount 1 gt lt IppForm ItemCount 1 gt lt Title
44. NEWLINE BEFORE gt value RIGHT gt A31003 S2000 R100 7 7620 November 18 2009 OpenStage 60 80 XML Applications Developers Guide Appendix XML Schema lt xs element name IppChoiceGroup gt lt xs complexType gt lt xs Sequence gt lt xs element ref Label minOccurs 0 gt lt xs element ref Option minOccurs 0 maxOccurs un bounded gt lt xs sequence gt lt xs attribute name Numbered default NO gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value NO gt lt xs enumeration value YES gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs attribute name Type use required gt lt default EXCLUSIVE gt gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value EXCLUSIVE gt lt xs enumeration value MULTIPLE gt lt xs enumeration value POPUP gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs attribute name Count type xs nonNegativelnteger use required gt lt default 0 gt gt lt xs complexType gt lt xs element gt November 18 2009 OpenStage 60 80 XML Applications Developers Guide 118 Appendix XML Schema lt xs element name IppCommand gt lt xs complexType gt lt xs Sequence gt lt xs element name Label type xs string minOccurs 0 gt lt xs element name ScreenID type xs nonNegativelnteg
45. Number provides a connection to the local phone book If the TppPhoneNumber element contains a phone number that exists in the phone s local phone book the name and number of the participant are displayed Furthermore if available a picture clip or else an icon for the phone type in question e g mobile number home number etc are shown A picture clip from the phonebook will override an image object The translation of phone number to name number and picture icon is done on the phone If the translation fails alternative text may be displayed instead of the phone number The alternative text is sup plied in the XML document The IppPhoneNumber tag is defined in Section 4 16 Phone Number November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 44 XML Object Reference Alert The following attributes are available to the TppAlert element Attribute Value Functionality Remarks Type ALARM An alarm icon is displayed at the left side optional A gt CONFIRMATION A prompt for confirmation icon is displayed at the left side ERROR Default value An error icon is displayed at the left side INFO An info icon is displayed at the left side WARNING A warning icon is displayed at the left side Delay Timeout in After the specified time elapses the Alert disappears optional milliseconds and the previously displayed screen reappears FOREVER Default value The display of the Alert can be
46. Player on the phone When the cache is full all of the entries in the cache are shifted one position to the left and the new screen is added to the end If the cache consists of only one full screen and the rest alerts the shifting of the entries in the cache will retain the full screen so that there is a screen to go back to when all of the alerts have been dismissed Any screen in the cache may have links to other screens in the cache They are linked by BACK and SCREEN commands see Section 4 6 Command An alert or player is removed from the cache when there are no links to it from any other screens When new screens are received from the remote server the new screen may e Reuse the existing displayables of an existing screen in the cache e Overwrite an existing screen in the cache or e Create a new screen in the cache When a screen is overwritten the existing displayables are deleted and a new set of display ables are created for the new screen The following table details the list reuse and screen caching rules when a new screen is re ceived November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 6 Operating Mode and Features Cache Screen Type Has BACK Command No BACK Command Screen ID al ready exists in cache Screen ID does not exist in cache Screen ID al ready exists in cache Screen ID does not exist in cache Alert When alerts
47. RACTIVE AUTO The number indicated here determines the starting po sition of the status bar The value is given in mm ss or in ss format If the initial value is missing negative or invalid it will default to O 93 A31003 S2000 R100 7 7620 November 18 2009 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Form Commands A Command is required to send the Gauge data to a server and initiate server side action The Command can be displayed on the Options menu which is located underneath the Screen title or on the Gauge To achieve this both the Gauge object and the Command must be placed inside a Form Item different way the key now opens the context menu Thus the user must press the If a Command is displayed on the Gauge the TouchGuide buttons are mapped in a key first in order to change the value of an interactive gauge For details please see Section Section 4 13 8 Form Item For details about the Command object see Section 4 6 Command Example lt xml version 1 0 encoding UTF 8 gt lt IppPhone gt lt IppDisplay gt lt IppScreen ID 1 HiddenCount 0 CommandCount 1 gt lt IppForm ItemCount 1 gt lt Title gt Interactive Gauge lt Title gt lt Url gt http subdomain domain path program lt Url1 gt lt IppGauge Interactive USER Key Gl gt lt Label gt Interactive Gauge lt Label gt lt Maximum gt 100 lt Maximum gt lt Initial gt
48. Schema lt xs enumeration value YES gt lt xs enumeration value NO gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xS attribute name Default use optional default NO gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value YES gt lt xs enumeration value NO gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs attribute ref Key use optional gt lt xs attribute ref Value use optional gt lt xs complexType gt lt xs element gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 120 Appendix XML Schema lt xs element name IppDateField gt lt xs complexType gt lt xs sequence gt lt xs element lt xs element lt xs element lt xs element lt xs sequence gt ref Label minOccurs 0 gt ref Timezone ref Date ref Time minOccurs 0 gt minOccurs 0 gt minOccurs 0 gt lt xs attribute name Mode use optional default DATETIME gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value DATE gt lt xs enumeration value TIME gt lt xs enumeration value DATETIME gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs attribute name Default use optional lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value NULL gt lt xs enume
49. The function of this object is comparable to that of hidden entry fields in HTML This makes it possible to send and receive data from the server using key value pairs without this data being visible to the user The following attributes are available to the TppHidden element Attribute Value Function Type VALUE Default The value of the key value pair is the value mandatory saved in the Value child element PHONENUMBER The value of the key value pair is the telephone number of the phone connected IPADDRESS The value of the key value pair is the IP address of the phone connected Key Key Together with the content of the Value child element mandatory Key builds the key value pair to be sent as an HTTP POST request Please note that the Key must be unique within a Screen Syntax lt IppHidden Type VALUE PHONENUMBER IPADDRESS Key Key gt lt Value gt lt Value gt lt IppHidden gt Child elements e Value This contains the value that is sent to the server Together with the Key attribute of the IppHidden element the content of Value builds a key value pair Commands A Command is required to send the hidden data to a server and initiate server side action It can be displayed on the Options menu which is located underneath the Screen title or if the Screen contains a List on each individual item on the List If the Screen contains a Form Com mands can be displayed on individual Form ele
50. Therefore as the container for Screen objects it is comparable to cards in a WML document An XML document may contain up to 5 screens one of which may be the InitialScreen and another the UpdateScreen If there are more than 5 screens in the XML document the addi tional screens are ignored The following attributes are available to the IppDisplay element Attribute Value Functionality Remarks UpdateScreen ID of the sec Used when two Screens have to be updated simulta optional ond screen to neously Provides the ID of the second Screen to be up be updated dated integer Missing nega There is no second screen to update tive or invalid A31003 S2000 R100 7 7620 November 18 2009 23 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Display Syntax lt IppPhone gt lt IppDisplay UpdateScreen ID gt lt IppScreen gt lt IppScreen gt lt IppScreen gt lt IppScreen gt lt IppScreen gt lt IppDisplay gt lt IppPhone gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 24 XML Object Reference Screen 4 4 Screen The IppScreen element serves as a container for specified contents The ID attribute enables switching between different screens An XML document may contain up to 5 screens one of which may be the InitialScreen and another the UpdateScreen If there are more than 5 screens in the XML document the addi tional s
51. abs On Demand As an alternative to predefined tabs it is possible to start tabs on demand using Push requests Section 2 3 Push Mode and Section 5 1 The Push Request from the server Xpressions applications always use tabs on demand With tabs on demand there can be different content on every tab The first tab started uses the start URL configured on the phone The remaining tabs use the URL supplied by the remote server The focus is on the first tab started by the phone With Xpressions applications the M key is used for tab switching and with phonebook applications the key is used 3 5 Mobile Users And Privacy As some XML applications may process personal user data it is important that the remote application is aware of the user currently logged onto the phone This can be achieved by map ping the phone number against the phone s IP address Both parameters are available to the remote program as they are sent by the phone on application start Please note that this will not be the case if the program name has an xm1 suffix For details please see Section 3 4 Starting the Application A31003 S2000 R100 7 7620 November 18 2009 19 OpenStage 60 80 XML Applications Developers Guide XML Object Reference Mobile Users And Privacy 4 XML Object Reference This chapter describes the usage content and error handling for the individual XML objects The objects are comprised of a main element its attribute
52. actory reset or restart the phone When the first keypad key of a combination is pressed the corresponding value will be sent to the remote server However the subsequent key presses of the key combination will not be communi cated Certain keypad key combinations may be invoked on the phone to enter the admin input enabled sending keypad input will be automatically disabled Moreover it will stay disabled when the alert is dismissed and the list has focus To re enable send ing keypad input on the list the XML document for the list must be resent If an alert see Section 4 8 Alert is displayed over a list which had sending keypad A31003 S2000 R100 7 7620 November 18 2009 35 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Direct Keypad Input Buffering As an alternative to immediate sending and interaction with the server keypad input can be buffered and sent afterwards This is controlled by the BufferKeys element Depending on the settings of Buf ferLength and TermKey the data is submitted either when the key se quence has reached the predefined buffer length or when the predefined termination key is pressed If an application requires each keypad key press one at a time the remote server should re quest subsequent buffering see Section 4 7 3 4 Buffer Subsequent Keypad Key presses This ensures that no keypad key presses are thrown away when the user types keypad keys q
53. alid The Command is only invoked through user action Key optional Key The key for the key value pair that is sent to the server as a HTTP GET request Please note that the Key must be unique within a Screen Value optional Value The value for the key value pair that is sent to the server as a HTTP GET request DisplayOn optional OPTIONS Default value The Command is displayed from the Op tions bar LISTITEM The Command is displayed on a List item see Section 4 9 List or on an individual item in a Form if included in a Form Item see Section 4 13 8 Form Item BOTH The Command is displayed both on the Options bar and on List items or Form items Select optional YES The Command is set as the select command for an Im plicit List see Section 4 9 List If more than one Command is set as the Select command for an Implic it List only the first one will be used as the selection ac tion Pressing when the Options bar is highlighted re turns the key value pair for the Select command Press ing when an individual list item is highlighted returns the key value pairs for both the Select command and the highlighted list item NO Default value The Command is not set as the select command for an Implicit List 31 A31003 S2000 R100 7 7620 November 18 2009 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference
54. all within the given num ber of Commands ber are displayed within the IppItem Syntax lt Ippltem CommandCount Number of Commands gt IppStringItem gt Ippimageltem gt IppSpacer gt IppTextField gt IppDateField gt IppChoiceGroup gt A A A AAA November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 88 XML Object Reference Form lt IppGauge gt lt IppButton gt lt Ippitem gt Commands To add a Command to a Form Item just include an IppCommand The DisplayOn attribute must be set to LISTITEM or to BOTH In the latter case all Commands assigned to Form Items are available from the Options menu as well Note that the Command s Label functions as an identifier if two or more Commands added to Form Items have the same label only one Com mand will be displayed on the Options menu A31003 S2000 R100 7 7620 November 18 2009 89 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Example lt xml version 1 0 encoding UTF 8 gt lt IppPhone gt lt IppDisplay gt lt IppScreen ID 1 HiddenCount 1 CommandCount 2 gt lt IppForm ItemCount 2 gt lt Title gt Item lt Title gt lt Url gt http subdomain domain path program lt Url1 gt lt Ippltem CommandCount 1 gt lt IppStringItem gt lt Label gt Item 1 lt Label gt lt Text gt Command 1 lt Text gt Form lt IppStringItem gt lt IppCommand Type SELECT DisplayO
55. ame BufferLength use optional de fault 0 gt lt xs simpleType gt lt xs restriction base xs nonNegativelnteger gt lt xs simpleType gt lt xs attribute gt lt xs attribute name TermKey use optional default gt lt xs simpleType gt lt xs restriction base xs string gt lt xs pattern value 0 9 1 gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 126 Appendix XML Schema lt xs attribute ref UrlKey use required gt lt xs complexType gt lt xs element gt lt xs element name IppList gt lt xs complexType gt lt xs Sequence gt lt xs element ref Title minOccurs 0 gt lt xs element ref Url minOccurs 0 gt lt xs element ref Option minOccurs 0 maxOccurs un bounded gt lt xs sequence gt lt xS attribute name Numbered use optional default NO gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value NO gt lt xs enumeration value YES gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs attribute name Type use required gt lt default IMPLICIT gt gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value IMPLICIT gt lt xs enumeration value EXCLUSIVE gt lt xs enumeration value MULTIPLE gt lt xs restriction gt lt xs
56. ayeris cre Player is cre ment contains created and created or ated and dis ated and dis IppPlayer displayed if displayed played played program is already run ning XML Application gains screen No No No Yes XML tab focus is displayed Popup or Player shown to Yes if no No Yes if no Yes but not User other popup other popup while a or prompt is or promptis prompt e g showing showing incoming call Alert or Dialer is showing Popup or Player gains input Yes if shown No Yes if shown Yes focus Screensaver Stopped for No change Stopped Stopped popup or player Phone locked No change No change No change No change Table 5 1 November 18 2009 OpenStage 60 80 XML Applications Developers Guide 108 Push Capability The Push Request 5 1 The Push Request The Push request is an HTTP or HTTPS future request sent to the following phone side URL http lt ip address gt lt port number gt server_push html ServerPush Example http 137 223 234 11 8085 server_push html ServerPush The Push request must contain the following Information Key Value Function ServerAddr IP address IP address of the server where the program is lo cated ServerPort Port number Port number of the server where the program is lo cated ProgramName Resource name Entity part of the URI pointing to the server side program For instance this can be an XML file
57. creens are ignored If a new Screen is loaded whose Screen ID already exists elements of cached Screens may be overwritten For details see the table in Section 2 4 Cache The following attributes are available to the TppScreen element Attribute Value Functionality Remarks ID ID of the Enables referencing of the Screen object so that the optional screen ele Screen can be accessed directly ment If missing negative or invalid it will default to O integer HiddenCount Number of All Hidden objects are displayed mandatory Hidden objects 0 All Hidden objects are ignored If missing negative or invalid it will default to O A number All the Hidden objects that exceed the number indicated lesserthanthe are ignored actual number of Hidden ob jects CommandCount Number of All Command objects are displayed mandatory Command ob If missing negative or invalid it will default to O jects 0 All Command elements are ignored A number less All the Command elements that exceed the number in er than the ac dicated are ignored tual number of Command ob jects A31003 S2000 R100 7 7620 November 18 2009 25 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Screen Syntax The IppScreen element must contain one of the following elements e IppAlert e IppList e IppTextBox IppForm lt IppPhone gt lt IppScreen ID ID HiddenCount
58. ction 4 6 Command November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 82 XML Object Reference Form Example lt xml version 1 0 encoding UTF 8 gt lt IppPhone gt lt IppDisplay gt lt IppScreen ID 1 HiddenCount 0 CommandCount 1 gt lt IppForm ItemCount 3 gt lt Title gt DateField lt Title gt lt Url gt http subdomain domain path program lt Url1 gt lt IppDateField Mode TIME Default MODE DateKey DK1i TimeKey TK1 gt lt Label gt Time lt Label gt lt TimeZone gt GMT 1 lt TimeZone gt lt Time gt 13 00 00 000 lt Time gt lt IppDateField gt lt IppDateField Mode DATE Default MODE DateKey DK2 TimeKey TK2 gt lt Label gt Date lt Label gt lt TimeZone gt GMT 1 lt TimeZone gt lt Date gt 2007 09 03 lt Date gt lt IppDateField gt lt IppDateField Mode DATETIME Default MODE DateKey DK3 TimeKey TK3 gt lt Label gt Date and Time lt Label gt lt TimeZone gt GMT 1 lt TimeZone gt lt Date gt 2007 09 03 lt Date gt lt Time gt 13 00 00 000 lt Time gt lt IppDateField gt lt IppForm gt lt IppCommand Type SELECT Priority 0 gt lt Label gt Select lt Label gt lt ScreenID gt 2 lt ScreenID gt lt IppCommand gt lt IppScreen gt lt IppDisplay gt lt IppPhone gt A31003 S2000 R100 7 7620 November 18 2009 83 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Form Screenshot 10 51 Wed 09 05
59. ction list comparable to the lt select gt and lt option gt elements in HTML or WML A Screen can only contain one List object There are three types of selection lists TMPLICIT EXCLUSIVE and MULTIPLE While the types IMPLICIT and EXCLUSIVE permit the selection of only one single option the type MULTIPLE permits the selection of one or more options Depending on the type of list the list items are displayed as plain list IMPLICIT or with radio buttons EXCLUSIVE or checkboxes MULTIPLE Additionall images can be added to the list items see Screenshot The uniqueness of keys and values is not checked in the telephone If the URL indicated in the Ur1 element is missing or invalid thereby permitting no data to be sent to a server the screen will continue to be displayed unchanged The following attributes are available to the element Attribute Value Function Remarks Type mandatory IMPLICIT Default value As soon as an option has been selected the data are sent immediately to the URL specified Thus exactly one option can be selected and only the key value pair that has been selected is sent to the server EXCLUSIVE Exactly one option can be selected as with radio but tons Only the key value pair selected is sent to the server MULTIPLE One or more options can be selected All key value pairs present in the list are sent to the server For select ed options the va
60. d must be placed inside a Form Item For details please see Sec tion 4 13 8 Form ltem For details about the Command object see Section 4 6 Command A31003 S2000 R100 7 7620 November 18 2009 65 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Form Example lt xml version 1 0 encoding UTF 8 gt lt IppPhone gt lt IppDisplay gt lt IppScreen ID 1 HiddenCount 0 CommandCount 1 gt lt IppForm ItemCount 2 gt lt Title gt Form String lt Title gt lt Url gt http subdomain domain path program lt Url1 gt lt IppStringItem gt lt Label gt String 1 Label lt Label gt lt Text gt String 1 Text lt Text gt lt IppStringItem gt lt IppStringItem gt lt Label gt String 2 Label lt Label gt lt Text gt String 2 Text lt Text gt lt IppStringItem gt lt IppForm gt lt IppCommand Type SELECT Priority 0 gt lt Label gt Select lt Label gt lt ScreenID gt 2 lt ScreenID gt lt IppCommand gt lt IppScreen gt lt IppDisplay gt lt IppPhone gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 66 XML Object Reference Form Screenshot 10 35 Example Form String Options String 1 Label String 2 Label 67 Applications Settings Wed 09 05 07 4300 Lucy Takeshi String 1 Text String 2 Text Mobility Shift A31003 S2000 R100 7 7620 November 18 2009 OpenStage 60 80 XML Applications Developer s Guide XM
61. ddress and call number as well as the device type Example 137 223 238 174 serverProgram amp phonenumber 4711 amp devicetype OpenStage 4 The server side program generates an XML document which is valid according to the XML schema see Section 6 2 XML Schema The web server delivers the XML document to the phone over a HTTP connection N Q o In the phone the XML document is parsed and displayed on the graphic display The user enters commands and data using the phone s TouchGuide and keypad Listeners in the phone software recognize the commands and data entered by the user The phone transmits the user entries to the server side program in the form of key value pairs A31003 S2000 R100 7 7620 November 18 2009 OpenStage 60 80 XML Applications Developers Guide Operating Mode and Features Push Mode 2 3 Push Mode The push mode enables the server side program to control and start a phone side XML appli cation The basic operation of the Push capability can be described as follows A program running on a server calls a special URL of the phone which is based on the phone s IP address Through this a specific XML application on the phone is triggered to load an XML document from a URL given in the push request If the specific XML application is not already running on the phone it may be started automatically 2 4 Cache The cache stores up to 20 screens of any type e g Form List Text Box Alert or
62. de key Only available if Xpressions is configured TURNLEDOFF Turns off the LED on the message mode key Only available if Xpressions is configured Missing or invalid No action will be performed Syntax lt IppAction Type MAKECALL ENDCALL TURNLEDON TURNLEDOFF gt lt Number gt Phone Number lt Number gt lt IppAction gt Child elements e Number The telephone number to be dialed A31003 S2000 R100 7 7620 November 18 2009 27 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Action Example lt xml version 1 0 encoding UTF 8 gt lt IppPhone gt lt IppDisplay gt lt IppScreen ID 1 HiddenCount 0 CommandCount 0 gt lt IppAlert Type CONFIRMATION Delay FOREVER gt lt Title gt Dial a Number lt Title gt lt Text gt 3290 lt IppPhoneNumber ImageType PICTURECLIP NumberType NAME gt lt AltText gt No image available for this entry lt AltText gt lt IppPhoneNumber gt lt Text gt lt Image gt lt Image gt lt IppAlert gt lt IppAction Type MAKECALL gt lt Number gt 49897223290 lt Number gt lt IppAction gt lt IppScreen gt lt IppDisplay gt lt IppPhone gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 28 XML Object Reference Action Screenshot 13 06 Tue 04 09 07 4711 E Example MA TUE Settings Alternate XML Application Examples Repeat Dialling Options Start Charlie Brown Cu
63. e Modify application Select application Display name Application name HTTP Server address HTTP Server port Protocol Program name on server Use proxy XML Trace enabled Debug program on server Number of tabs Tab 1 Display Name Tab 1 Application Name Tab 2 Display Name Tab 2 Application Name Tab 3 Display Name Tab 3 Application Name Auto restart Examples Examples Examples 192 168 1 150 80 http ipp lt ML startxml No No 0 Setup and Program Start Reconfigure and Remove an Application 4 Change the data as desired When the configuration data is correct and complete click on Submit 3 3 1 2 Removing 1 Open the web interface as described in Section 3 1 2 Using the Web Interface steps 1 to 3 2 Navigate to Applications gt XML applications gt Modify application 3 Navigate to Applications gt XML applications gt Modify application and select the appli cation to be deleted November 18 2009 OpenStage 60 80 XML Applications Developers Guide 16 Setup and Program Start Reconfigure and Remove an Application Modify application Select application Examples Settings Display name Examples Application name Examples HTTP Server address 192 168 1 150 HTTP Server port 80 Protocol http v Program name on server ipp xML start xml Use proxy No v XML Trace enabled No M Debug program
64. e is used as a clickable area Commands If an additional Command is added to a Button using a Form Item see Section 4 13 8 Form Item an extra option labeled Select is inserted into the context menu A31003 S2000 R100 7 7620 November 18 2009 85 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Form Example lt xml version 1 0 encoding UTF 8 gt lt IppPhone gt lt IppDisplay gt lt IppScreen ID 1 HiddenCount 0 CommandCount 0 gt lt IppForm ItemCount 4 gt lt Title gt Button lt Title gt lt Url gt http subdomain domain path program lt Url1 gt lt IppButton Type IMAGE Layout CENTER Key keyl Value 1 gt lt Label gt Button 1 lt Label gt lt Image gt http subdomain domain path imagel png lt Im age gt lt IppButton gt lt IppButton Type IMAGE Layout CENTER Key key2 Value 2 gt lt Label gt Button 2 lt Label gt lt Image gt http subdomain domain path image2 png lt Im age gt lt IppButton gt lt IppButton Type IMAGE Layout CENTER Key key3 Value 3 gt lt Label gt Button 3 lt Label gt lt Image gt http subdomain domain path image3 png lt Im age gt lt IppButton gt lt IppButton Type IMAGE Layout CENTER Key key4 Value 4 gt lt Label gt Button 4 lt Label gt lt Image gt http subdomain domain path image4 png lt Im age gt lt IppButton gt lt IppForm gt lt IppScreen gt lt IppDisplay gt lt IppPho
65. e option The image is displayed in the left column For more infor mation about the Image object see Section 4 14 Image Commands A Command is required to send the data to a server and initiate server action The Command can be displayed on the Options menu which is located underneath the Screen title or on each individual Choice Group Option To achieve this both the Choice Group and the Command must be placed inside an Form Item For details please see Section 4 13 8 Form Item For details about the Command object see Section 4 6 Command November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 78 XML Object Reference Form Example lt xml version 1 0 encoding UTF 8 gt lt IppPhone gt lt IppDisplay gt lt IppScreen ID 1 HiddenCount 0 CommandCount 1 gt lt IppForm ItemCount 2 gt lt Title gt ChoiceGroup lt Title gt lt Url gt http subdomain domain path program lt Url1 gt lt IppChoiceGroup Type MULTIPLE Count 3 gt lt Label gt Choicel lt Label gt lt Option Selected TRUE Key key1 1 Value 1 gt lt OptionText gt Option 1 1 lt OptionText gt lt Image gt lt Image gt lt Option gt lt Option Selected FALSE Key key1 2 Value 2 gt lt OptionText gt Option 1 2 lt OptionText gt lt Image gt lt Image gt lt Option gt lt Option Selected FALSE Key key1 3 Value 3 gt lt OptionText gt Option 1 3 lt OptionText gt lt Image gt lt Image gt
66. e relative path to the servlet or to the first XML page of the server side program The relative path refers to the root directory for documents on the web server For instance if an XML document is saved in C Program Files Apache Group Apache htdocs ipp ippTest xml the entry is ipp ippTest xml The program name cannot be longer than 100 characters e Use proxy Enables or disables an HTTP proxy if desired Otherwise a direct connec tion is used For details see Section 3 2 Setting a Proxy e XML trace enabled Enables or disables the debugging of the XML application back to the designated program specified by Debug program name When enabled trace info of the XML elements and details of key internal objects are sent to the remote de bug program e Debug program name The relative path to a special program on the same server as the program specified by the Program name This program receives the debug infor mation e Number of tabs Required if the application has internal tabs Specifies the number of internal tabs for this application The maximum value is 3 e Tab 1 3 Display Name Required if the application has internal tabs Provides the la bel text for the specified tab e Tab 1 3 Application Name Required if the application has internal tabs Provides a unique name for the specified tab The remote program will use this name to provide the tab with specific content For more information please refer to Section 3
67. eType gt lt xs restriction base xs string gt lt xs enumeration value ANY gt lt xs enumeration value NUMERIC gt lt xs enumeration value PASSWORD gt lt xs enumeration value PHONENUMBER gt lt xs enumeration value URL gt lt xs enumeration value EMATLADDR gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs attribute name Password use optional default NO gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value YES gt lt xs enumeration value NO gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs attribute name Uneditable use optional default NO gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value YES gt lt xs enumeration value NO gt lt xs restriction gt A31003 S2000 R100 7 7620 November 18 2009 131 OpenStage 60 80 XML Applications Developer s Guide Appendix XML Schema lt xs simpleType gt lt xs attribute gt lt xs attribute ref Default use optional default NULL gt lt xs attribute ref Key use optional gt lt xs complexType gt lt xs element gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 132 Appendix XML Schema lt xs element name IppTextField gt lt xs complexType gt lt xs Sequence gt lt xs element ref Label minOccurs 0 gt lt xs element ref Text minOccurs
68. ebsphere Studio A31003 S2000 R100 7 7620 November 18 2009 3 OpenStage 60 80 XML Applications Developer s Guide Operating Mode and Features Infrastructure 2 Operating Mode and Features 2 1 Infrastructure The phones are connected to a LAN The application web server can be connected to the same LAN or alternatively be reachable via WAN internet Optionally the DLS Deployment Service can be used to configure XML applications on the phone The following diagram shows the communication between the components Application Server DLS Web Server November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 4 Operating Mode and Features Basic Operating Mode 2 2 Basic Operating Mode The following diagram shows the basic components involved in the operation Phone Server Phone s Java Display Environment Business and Logic Keyboard XML Application ee XML XML HTTP HTTPS future Parser Le gt Webserver The operation can be described as follows 1 The administrator configures an application on the OpenStage phone 2 The user selects a program from the list of available applications and starts it 3 The phone sends an HTTP request to the URL of the server side application The HTTP HTTPS future GET request sent by the phone on application startup contains the phone s IP a
69. en It provides basic information in the standard elements Title and Ur1 and represents a contain er for the following elements String Item see Section 4 13 1 Form Stringltem Image Item see Section 4 13 2 Form Imageltem Spacer see Section 4 13 3 Form Spacer Text Field see Section 4 13 4 Form TextField Choice Group see Section 4 13 5 Form ChoiceGroup Date Field see Section 4 13 6 Form DateField Button Section 4 13 7 Form Button Item Section 4 13 8 Form ltem Gauge see Section 4 13 9 Form Gauge A Form is divided into two columns The left column contains the Options label automatically created for Command elements as well as any label created for an element within the form The proportions of the columns can be modified using the Proportions attribute The following attributes and values are available to the TppForm element Attribute Value Function ItemCount Number of elements Indicates the number of specific elements contained mandatory contained Title and Url are not counted Missing negative or Defaults to 0 Any elements for items in the form will invalid be ignored Proportions 0_100 Left column 0 right column 100 optional 15 85 Left column 15 right column 85 25 75 Left column 25 right column 75 40_60 Left column 40 right column 60 50_50 Left column 50 right column 50 60_40 Left column 60 right column 40 45 2
70. er minOccurs 0 gt lt xS sequence gt lt xS attribute name Type use required gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value SELECT gt lt xs enumeration value BACK gt lt xs enumeration value UPDATE gt lt xs enumeration value SCREEN gt lt xs enumeration value CANCEL gt lt xs enumeration value EXIT gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xS attribute name Priority use optional default 0 gt lt xs simpleType gt lt xs restriction base xs nonNegativelnteger gt lt xs maxInclusive value 9 gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs attribute name Auto use optional default 0 gt lt xs simpleType gt lt xs restriction base xs nonNegativelnteger gt lt xs simpleType gt lt xs attribute gt lt xs attribute name DisplayOn use optional default OP TIONS gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value OPTIONS gt lt xs enumeration value LISTITEM gt lt xs enumeration value BOTH gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xS attribute name Select use optional default NO gt lt xs simpleType gt lt xs restriction base xs string gt A31003 S2000 R100 7 7620 November 18 2009 119 OpenStage 60 80 XML Applications Developer s Guide Appendix XML
71. er hosting the program e Server port number Server port used by the server side program e Program name Path to the server side program e Use proxy Use of a direct connection or proxy for client server communication e XML trace enabled optional Sending trace data to a debugging program e Debug program name optional Path to a server side debugging program e Number of tabs optional number of internal tabs for this application e Tab 1 3 Display Name optional Label text for the specified tab e Tab 1 3 Application Name optional Unique name for the specified tab e Restart after change optional If checked a running XML application is restarted au tomatically after it has been modified 9 When the configuration data is correct and complete navigate to Save amp exit and press 10 Press the key to activate the Applications tab If everything went well the new applica tion is listed here It can be started by pressing November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 12 Setup and Program Start Setting a Proxy 3 2 Setting a Proxy The HTTP data transfer between the phone and the server on which the remote program is run ning can be handled by an HTTP proxy if desired The use of a proxy can be enabled or dis abled separately for each application see Section 3 1 1 Required Data 3 2 1 Using the Web Interface 1 Open the web interface as described in Section 3 1 2
72. ffered mode In unbuffered mode the phone willimmediately send an HTTP GET request to the specified server when a keypad key has been pressed After this the phone will wait for a server response The request contains a key value pair wherein the key is predefined in the XML document and the value represents the value of the keypad key The phone itself will not generate audible or visual feedback to the user when the data is sent this must be handled by the remote server The feature is available for lists see Section 4 9 List with alerts forms text boxes or play ers only regular user input is supported To enable and configure direct key input the IppKey element is used To add context information IppHidden Section 4 12 Hidden elements can be used The key value pairs contained in the TppHidden elements will be sent along with each keypad in put For example the remote server may keep track of the entire digit sequence entered so far by including this digit sequence in an IppHidden element lock As the keypad input feature does not distinguish between short and long press these functions will occur in parallel with sending keypad input to the remote server If the remote server updates an XML application whilst the phone is locked the user does not see the updated screen until after the phone is unlocked Long presses of the and keypad keys toggle the ringing state and invoke phone menu invoke a f
73. gt lt Image Cache Name gt lt Image gt lt Option gt lt IppChoiceGroup gt A31003 S2000 R100 7 7620 November 18 2009 77 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Form Child elements e Option Stores the data to be sent to the server in attributes It can also contain descriptive text OptionText and an image Image Attribute Value Function Selected FALSE Default value The option is not preselected optional TRUE The option is preselected Key Key The key for the key value pair that is sent to the optional server For selection lists of type POPUP and EXCLUSIVE multiple options can have the same Key If the type is MULTIPLE all the values must be different Value Value The value for the key value pair that is sent to the optional server If the selection list type is MULTIPLE all the key value pairs are sent For selected options the value of the value attribute is then sent for non selected options this value is prefixed with not_ Table 4 4 If a key or value is missing or invalid nu11 is sent instead e OptionText Descriptive text for the option An IppPhoneNumber see Section 4 16 Phone Number can be contained which enables the automatic translation of a phone number stored in the local phone book into the name associated to the number and a picture clip or a phone type icon e Image Illustrative image for th
74. gt lt IppForm ItemCount 3 gt lt Title gt Form String lt Title gt lt Url gt http subdomain domain path program lt Ur1 gt lt IppTextField MaxSize 30 Constraint NUMERIC De fault TEXT Key TF1 gt lt Label gt Numeric Text lt Label gt lt Text gt 123456 lt Text gt lt IppTextField gt lt IppTextField MaxSize 30 Constraint ANY De fault TEXT Key TF2 gt lt Label gt Any Text lt Label gt lt Text gt abc123 lt Text gt lt IppTextField gt lt IppTextField MaxSize 30 Constraint PASSWORD De fault TEXT Key TF3 gt lt Label gt Password lt Label gt lt Text gt 999 lt Text gt lt IppTextField gt lt IppForm gt lt IppCommand Type SELECT Priority 0 gt lt Label gt Select lt Label gt lt ScreenID gt 2 lt ScreenID gt lt IppCommand gt lt IppScreen gt lt IppDisplay gt lt IppPhone gt A31003 S2000 R100 7 7620 November 18 2009 75 OpenStage 60 80 XML Applications Developer s Guide Screenshot Form String Options Numeric Text Any Text Password November 18 2009 Applications XML Object Reference Form Wed 09 05 07 4300 3400 Settings 123456 abe123 FAX Lucy Takeshi Mobility Shift OpenStage 60 80 XML Applications Developer s Guide 76 XML Object Reference Form 4 13 5 Form ChoiceGroup This object generates a selection list within a form comparable to the lt select gt and lt option gt elements in HTML and WML A Form
75. gt Imageltem lt Title gt lt Url gt http subdomain domain path program lt Ur1 gt lt IppimageiItem Layout CENTER gt lt Label gt A Flower lt Label gt lt Image gt http subdomain domain path image png lt Image gt lt AltText gt The image cannot be displayed lt AltText gt lt Tppimageltem gt lt IppForm gt lt IppCommand Type SELECT Priority 0 gt lt Label gt Select lt Label gt lt ScreenID gt 2 lt ScreenID gt lt IppCommand gt lt IppScreen gt lt IppDisplay gt lt IppPhone gt A31003 S2000 R100 7 7620 November 18 2009 69 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Form Screenshot 10 40 Wed 09 05 07 4300 Example Be re Era 3400 Imageltem Lucy Takeshi Options A Flower November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 70 XML Object Reference Form 4 13 3 Form Spacer The spacer generates an extra vertical space the height of a line between two elements Syntax lt IppSpacer gt Example lt xml version 1 0 encoding UTF 8 gt lt IppPhone gt lt IppDisplay gt lt IppScreen ID 1 HiddenCount 0 CommandCount 1 gt lt IppForm ItemCount 3 gt lt Title gt Spacer lt Title gt lt Url gt http subdomain domain path program lt Url gt lt IppStringItem gt lt Label gt String 1 Label lt Label gt lt Text gt String 1 Text lt Text gt lt IppStringItem gt lt IppSpacer gt lt IppStringItem gt
76. hat you would like to delete and press The Save amp exit option is highlighted Open the context menu by pressing the key 5 With the TouchGuide navigate to Remove amp exit and press 3 4 Starting the Application An XML application can be started by navigating to the applications menu using the key by configuring a programmable key for a specific application or in case of an Xpressions or phonebook application by the corresponding mode key For details please refer to the Open Stage User Manual and the OpenStage Administration Manual The HTTP GET request sent by the phone depends on the target URL If this URL has an xml extension the phone assumes to receive a static XML document e g from a web server The request URI will contain no additional information If the requested URL has no xm1 extension the phone assumes it is communicating with a dynamic application e g a servlet In this case the phone will include its IP address telephone number and device type using key value pairs in the request The request has the following format http lt server ip address gt lt port gt lt program name gt ipaddress lt phone IP gt amp phonenumber lt phone number gt amp devicetype OpenStage In both cases whether the request URL has an xml extension or not the current language is sent to the server in the Accept Language field of the HTTP request header for example Accept Language en Application Sui
77. in a ua do io Bae 4 2 2 Basic OperaingiMOde 2 cine ui ecoute sie ci cue Sees 5 2 3 Push Mode ie wage ele eee oa re ok oh Oey ee eal a ad rss codec 6 24 WAC a iy ae teeta gi ir ea a ene oh oe ah np ae we aah e E hg oe lnc gare ee nas 6 3 Setup and Program Start ows cece ieee eee eee eee ee ee 8 3 1 Configuring an Application on the Phone 8 3 2 Setting a Proxy ce we eee See ene oka ace ob Se eee Seer ee eee He 13 3 3 Reconfigure and Remove an Application 15 3 4 Starting the Application i cs saw eee gch een ed ea an ae eke mea b ni 18 3 5 Mobile Users And Pivacy san crude das Koes hbase eke ee eee eken eed 19 4 XML Object AGIETENER nn nanas eae ee ee ald ae ee 20 4 1 Encoding internationalizauion 2 54 4 lt s66seeeey eee bees ees ues ee ae sews 21 22 PHONG ss tesa dane am ce coureur CRE Ree eu m0 0 tac codes 21 MODS DEN RE ce add Eb ame cr do Med bien dance an Nr 23 4A SC Eeo raroa na E ae ee a nt EE A aea E eee ee ae 25 25 ACHON secaraa a a a a bE Seah ee bee eee eee ees 27 4 6 Command ie ac a aco ie thy oy oe eee a eh E e oe ee ee ae 30 4 7 Direct Keypad NOU 2 5 oud Moe Ron Ae ew eee Re Re Ne eee See ee 35 AG AIC ca Le Si sie de det ga k T ane De DORA D 0e coca Dai A 44 AS cree ce meee ae deedeadteaeraes Rade 49 4 NO T EXIBOX a ete a eq a cn ee a tere diode dead CN ae 54 GAD EEE areg oo n ek too oes Sa eo oa eae eo a we ke eee 59 Se MG tired oink cacti ss5
78. istration main page opens The navigation column to the left contains the menu tree If you click on an item which is printed in normal style the corresponding dialog opens in the center of the page If you click on an item printed in bold letters a sub menu opens in the navigation column November 18 2009 OpenStage 60 80 XML Applications Developers Guide 10 Setup and Program Start Configuring an Application on the Phone Navigate to Applications gt XML applications gt Add application and enter the required data see Section 3 1 1 Required Data When the configuration data is correct and com plete click on Submit Add application Display name Application name HTTP Server address HTTP Server port Protocol Program name on server Use proxy XML Trace enabled Debug program on server umber of tabs Tab 1 Display Name Tab 1 Application Name Tab 2 Display Name Tab 2 Application Name Tab 3 Display Name Tab 3 Application Name Auto restart O Now you can test the application Press the key on the phone to activate the Applications tab If everything went well the new application is listed and can be started by pressing 3 1 3 Using the Local Admin Menu The basics for accessing the phone s local admin menu are described here For more detailed information please consult the user manual or the administration manual 1 11 Press the key once or repeatedly until the Settings tab is active The
79. ld gt A31003 S2000 R100 7 7620 November 18 2009 81 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Form Child elements Label Generates a label for identifying the date and time fields The label is displayed in the left hand column e TimeZone Entry for the time zone corresponding to the date and time fields 7 Date Date entry The ordering and format for entry and display is set in the user menu under Locality gt Date format For indicating the date in the XML document the YYYY MM DD format is used Example 2007 11 20 Time Time data is entered in the order of hours minutes lowed by a period and the milliseconds For indicating the time in the XML document the HH MM SS format is used fol Example 13 00 00 000 Commands A Command is required to send the data to a server and initiate server action The Command can be displayed on the Options menu which is located underneath the Screen title or on the date field To achieve this both the field and the Command must be placed inside a Form Item has the focus Additionally the TouchGuide buttons are mapped in a different way If a Command is displayed on the Date Field an arrow is shown as soon as the field the key now opens the context menu so that only the key opens the editor For details please see Section Section 4 13 8 Form Item For details about the Command object see Se
80. lt Option gt lt IppChoiceGroup gt lt IppChoiceGroup Type EXCLUSIVE Count 2 gt lt Label gt Choice2 lt Label gt lt Option Selected FALSE Key key2 1 Value 4 gt lt OptionText gt Option 2 1 lt OptionText gt lt Image gt lt Image gt lt Option gt lt Option Selected TRUE Key key2 2 Value 5 gt lt OptionText gt Option 2 2 lt OptionText gt lt Image gt lt Image gt lt Option gt lt IppChoiceGroup gt lt IppForm gt lt IppCommand Type SELECT Priority 0 gt lt Label gt Select lt Label gt lt ScreenID gt 2 lt ScreenID gt lt IppCommand gt lt IppScreen gt lt IppDisplay gt lt IppPhone gt A31003 S2000 R100 7 7620 November 18 2009 79 OpenStage 60 80 XML Applications Developer s Guide Screenshot ChoiceGroup Options Choice Choicee November 18 2009 XML Object Reference Form Wed 09 05 07 Applications Settings M Option 1 1 C Option 1 2 Option 1 3 C Option 2 1 Option 2 2 4300 3400 Lucy Takeshi Mobility Shift OpenStage 60 80 XML Applications Developer s Guide 80 XML Object Reference Form 4 13 6 Form DateField This object generates a field in which date and time information can be prespecified or entered by the user The Date Field contains a label The data to be displayed date time date and time as well as the time zone can be specified On the display the date is shown as three separate fields day month
81. lue of the value attribute is then sent for non selected options this value is prefixed with not_ Count mandatory Number of op tions Only as many options as indicated here are displayed If the actual number of options exceeds this amount all further options are ignored No options are displayed 49 A31003 S2000 R100 7 7620 November 18 2009 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference List Columns Number of col A list may contain a single column or multiple columns optional umns max 3 of option text Currently three column lists are support ed The default value is 1 which results in a single col umn list A single column list occupies 100 of the item width in a Form The left middle and right columns in a three column list occupy 50 16 and 34 of the item width respectively Each option container must have the same number of OptionText elements as the number of columns The OptionText elements are displayed in order from the left to right column If Columns is missing negative or invalid or there is a mismatch between the number of columns and OptionText elements the list defaults to a single column list using only the first OptionText el ement in each container Syntax lt IppList Type IMPLICIT EXCLUSIVE MULTIPLE Count Number Columns Number gt lt Title gt lt Title gt lt Url gt lt Url gt lt Option Selected FALSE
82. ly be used when the XML application requires the user s attention to inform them of something or request their input This option is disruptive to the user if they are using another application The following table shows which actions are performed by which push request type consider ing the possible sub conditions Action sub Push Type condition Active Queue Indicate Force XML Applica Program is No Yes Yes Yes tion started on configured Push and not run ning Program is Error case The Push request is ignored not configured XML document loaded from Yes if pro Yes Yes Yes the nominated URL on the gram is server already run ning Table 5 1 A31003 S2000 R100 7 7620 November 18 2009 107 OpenStage 60 80 XML Applications Developer s Guide Push Capability Phone Number Action sub Push Type condition Active Queue Indicate Force XML docu XML docu Yes appropri Yes appropri Yes appropri Yes appropri ment ren ment contains ate tab ate tab ate tab ate tab dered IppList Ipp updated if updated updated updated TextBox orlp program is pForm already run ning XML docu Popup is only No popup is Popup is cre Popup is cre ment contains created and created or ated and dis ated and dis IppAlert displayed if displayed played played program is already run ning XML docu Player is only No player is Pl
83. ments For details please see Section 4 13 8 Form Item For details about Commands in general see Section 4 6 Command A31003 S2000 R100 7 7620 November 18 2009 61 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Hidden Example lt xml version 1 0 encoding UTF 8 gt lt IppPhone gt lt IppDisplay gt lt IppScreen ID 1 HiddenCount 1 CommandCount 1 gt lt IppList Type EXCLUSIVE Count 3 gt lt Title gt Hidden lt Title gt lt Url gt http subdomain domain path program lt Url1 gt lt Option ID 1 Selected FALSE Key keyl Value 1 gt lt OptionText gt Option 1 lt OptionText gt lt Option gt lt Option ID 2 Selected FALSE Key key2 Value 2 gt lt OptionText gt Option 2 lt OptionText gt lt Option gt lt Option ID 3 Selected FALSE Key key3 Value 3 gt lt OptionText gt Option 3 lt OptionText gt lt Option gt lt IppList gt lt IppCommand Type SELECT DisplayOn LISTITEM Priority 0 gt lt Label gt Select lt Label gt lt ScreenID gt 2 lt ScreenID gt lt IppCommand gt lt IppHidden Type VALUE Key hidden key gt lt Value gt hidden value lt Value gt lt IppHidden gt lt IppScreen gt lt IppDisplay gt lt IppPhone gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 62 XML Object Reference Form 4 13 Form The Form object is used to generate a frame that provides some layout options for a Scre
84. n LISTITEM Priori ty 0 gt lt Label gt Select lt Label gt lt ScreenID gt 1 lt ScreenID gt lt IppCommand gt lt Ippitem gt lt IppiItem CommandCount 1 gt lt IppStringItem gt lt Label gt Item 2 lt Label gt lt Text gt Command 2 lt Text gt lt IppStringItem gt lt IppCommand Type SELECT DisplayOn LISTITEM Prior ity 1 gt lt Label gt Select lt Label gt lt ScreenID gt 1 lt ScreenID gt lt IppCommand gt lt Ippitem gt lt IppForm gt lt IppScreen gt lt IppDisplay gt lt IppPhone gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 90 XML Object Reference Form Screenshot 10 51 Wed 09 05 07 4300 Example ie re SCA E 3400 Item Lucy Takeshi tem 1 Item 2 Command 2 Mobility Shift sj A31003 S2000 R100 7 7620 November 18 2009 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Form 4 13 9 Form Gauge A value or time interval is represented graphically using a horizontal status bar Information on what is shown on the gauge can be given in the label Depending on what is specified the Gauge can function as slider or as status bar For the former the value is set by the user and sent to a server For the latter the value is dependent on processes which last a longer period of time and the bar automatically grows from the left to the right The following attributes are available to the TppGauge element Attribu
85. n modes are controlled by the remote program Additionally three states are defined for the player PLAYING RECORDING and STOPPED The modes dictate which function buttons are displayed and their state the default highlighting and the type of gauge and its interaction The player buttons and the TouchGuide allow user interaction with the server side program Whenever the user presses a TouchGuide or player button a specific key value pair consisting of the player s Key attribute and the function type is immediately sent to the specified URL If for instance the value of the Key attribute is MyPlayer and the user presses the forward but ton the key value pair is MyPlayer forward Also the key value pairs of the gauge see Sec tion 4 13 9 Form Gauge and of any hiddens see Section 4 12 Hidden are sent to the URL November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 98 XML Object Reference Player The following table shows the buttons and the related function types i e the value of the key value pair whose key is the value of Key Player Button Function i delete rewind A skip _rewind i4 play P pause ii stop skip_forward pi forward 2 an call confirm Table 4 6 99 A31003 S2000 R100 7 7620 November 18 2009 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Player Player Button Function
86. n the screen and continually moves from right to left across the display It is positioned underneath the title bar Syntax lt IppTicker gt lt Text gt lt Text gt lt IppTicker gt If the text is missing or is invalid the ticker is not displayed at all Example lt xml version 1 0 encoding UTF 8 gt lt IppPhone gt lt IppDisplay gt lt IppScreen ID 1 HiddenCount 0 CommandCount 1 gt lt IppForm ItemCount 1 gt lt Title gt Ticker lt Title gt lt Url gt http subdomain domain path program lt Ur1 gt lt IppStringItem gt lt Label gt lt Label gt lt Text gt A ticker text is running lt Text gt lt IppStringItem gt lt IppForm gt lt IppCommand Type SELECT Priority 0 gt lt Label gt Select lt Label gt lt ScreenID gt 1 lt ScreenID gt lt IppCommand gt lt IppTicker gt lt Text gt Ticker Text Ticker Text lt Text gt lt IppTicker gt lt IppScreen gt lt IppDisplay gt lt IppPhone gt A31003 S2000 R100 7 7620 November 18 2009 59 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Ticker Screenshot 10 31 Wed 09 05 07 4300 Example ie re AE Ticker Text Ticker Text Ticker Text Ticker Options A ticker text is running 3400 Lucy Takeshil Mobility shift November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 60 XML Object Reference Hidden 4 12 Hidden
87. nd keypad input The user presses a keypad key which is sent to the remote program With the following XML docu ment the XML application disables send keypad input All subsequent keypad key presses are ignored User Screen Updated Keypad key Screen Updated Keypad key November 18 2009 XML Application Request next XML docu ment XML document with key pad sending enabled SendKeys YES Keypad YES Send keypad key op tional IppHidden XML document with key pad sending disabled SendKeys NO Keypad NO Ignore keypad key OpenStage 60 80 XML Applications Developer s Guide Remote Pro gram Send XML document Process input data Send XML document No input data from the key pad 38 XML Object Reference Direct Keypad Input 4 7 3 3 Buffer Initial Keypad Key Presses In the following interaction the remote program enables send keypad input and buffering with a buffer length greater than 1 When the user presses one or more keypad keys the key press es are buffered until the buffer is full i e the number of key presses equals the predefined buffer length After this the key data are sent en bloc to the remote XML application Alternatively a terminating keypad key is defined and the non terminating keypad key presses are buffered un til the terminating key is pressed After this the key data are sent en bloc including the termi nating keypad key User Sc
88. ne gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 86 XML Object Reference Form Screenshot 13 36 Thu 20 09 07 4711 Examples Applications J Button Button 1 Do Not Disturb Button 2 Button 3 Button 4 A31003 S2000 R100 7 7620 November 18 2009 87 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Form 4 13 8 Form Item This element enables to add Commands to individual items in a Form by grouping them as child elements When the user navigates to a Form Item and presses the key on the TouchGuide a context menu containing the Commands is opened The following objects can be contained in an Item e String Item see Section 4 13 1 Form Stringltem e Image Item see Section 4 13 2 Form Imageltem e Spacer see Section 4 13 3 Form Spacer e Text Field see Section 4 13 4 Form TextField e Choice Group see Section 4 13 5 Form ChoiceGroup e Date Field see Section 4 13 6 Form DateField e Button see Section 4 13 7 Form Button e Gauge see Section 4 13 9 Form Gauge The following attribute is available to the IppItem element Attribute Value Function Remarks CommandCount Number of Com The Commands are rendered correctly mandatory mands within the Ippitem 0 Any IppCommand elements will be ignored Missing negative or The value will default to O invalid Less than the num Only those Commands that f
89. ng the first key press are buffered BufferLength Number of key presses Defines the length of the buffer When the buffer optional to be buffered is full the digits are sent en bloc Default 0 TermKey 0 to 9 or left blank Defines the terminating keypad key which trig optional Default blank gers the submission of the buffered digits Please note that and are URL encoded when sent to the server UrlKey User defined string Defines the key part of the key value pair sent mandatory Default digit in the URL string to the remote server for the next XML document November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 42 XML Object Reference Direct Keypad Input Example lt xml version 1 0 encoding UTF 8 gt lt IppDisplay InitialScreen 1 gt lt IppScreen ID 1 HiddenCount 1 CommandCount 1 gt lt IppKey Keypad YES SendKeys YES BufferKeys YES Buffer Length 3 UrlKey mydigit gt lt IppList Type IMPLICIT Count 3 gt lt Title gt IppList lt Title gt lt Url gt http subdomain domain path program lt Ur1 gt lt Option ID 1 Selected FALSE Key 1 Value 1 gt lt OptionText gt Item 1 lt OptionText gt lt Image gt lt Option gt lt Option ID 2 Selected TRUE Key 2 Value 2 gt lt OptionText gt Item 2 lt OptionText gt lt Image gt lt Option gt lt Option ID 3 Selected FALSE Key 3 Value 3 gt lt OptionText gt Item 3 lt OptionText gt l
90. nt PHONENUMBER The Text Box contains the call number of the phone Key Key The value ofthis attribute is used as a key for submitting optional the data as an HTTP POST request The associated value is the content of the Text element Please note that the Key must be unique within a Screen Uneditable YES The Text Box cannot be edited by the user optional NO Default value The Text Box can be edited by the user November 18 2009 OpenStage 60 80 XML Applications Developers Guide 54 XML Object Reference TextBox 1 The validation of this constraint is not implemented yet A31003 S2000 R100 7 7620 November 18 2009 55 OpenStage 60 80 XML Applications Developers Guide XML Object Reference TextBox Syntax lt IppTextBox MaxSize Number Constraint ANY NUMERIC PASSWORD PHONENUMBER URL EMAILADDR Password YES NO Default NULL TEXT PHONENUMBER Key Key Uneditable YES NO gt lt Title gt lt Title gt lt Text gt lt Text gt lt Url gt lt Url gt lt IppTextBox gt Child elements e Title Title of the Text Box The title is displayed in the first line underneath the Applications tab Text Predefined text contained in the text box This is displayed if Default is set to TEXT Ur URL of the server to which the data are sent server the current screen will continue to be displayed unchanged If the URL is missing or is invalid thereby allowing no data to be sent t
91. nt 0 CommandCount 1 gt lt IppList Type IMPLICIT Count 3 gt lt Title gt Implicit List lt Title gt lt Url gt http subdomain domain path program lt Url1 gt lt Option Selected FALSE Key keyl Value 1 gt lt OptionText gt Item 1 lt OptionText gt lt Image gt http subdomain domain path imagel png lt Im age gt lt Option gt lt Option Selected TRUE Key key2 Value 2 gt lt OptionText gt Item 2 lt OptionText gt lt Image gt http subdomain domain path image2 png lt Im age gt lt Option gt lt Option Selected FALSE Key key3 Value 3 gt lt OptionText gt Item 3 lt OptionText gt lt Image gt http subdomain domain path image3 png lt Im age gt lt Option gt lt IppList gt lt IppCommand Type SELECT Priority 0 gt lt Label gt Select lt Label gt lt ScreenID gt 2 lt ScreenID gt lt IppCommand gt lt IppScreen gt lt IppDisplay gt lt IppPhone gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 52 XML Object Reference List Screenshot da 17 Tue 13 11 07 4300 Examples Applications 3400 Implicit List Lucy Takeshil Options 8 Item 1 Item 3 Mobilityl Shift A31003 S2000 R100 7 7620 November 18 2009 53 OpenStage 60 80 XML Applications Developer s Guide 4 10 TextBox XML Object Reference TextBox This element generates a text area for user input For inputting data the user must first navigate to the text
92. number entered here indicates the maximum val ue that can be sent to the server The range is 0 100 If the maximum value is set at under 100 for instance at 80 the slider bar will still reach to the right end of the scale If the user sets the slider to this position the specified maximum value will be sent to the server If the maximum value is missing negative invalid or greater than 100 it will de fault to 100 If the initial value is greater than the maximum value it will be set to the maximum value If INTERACTIVE AUTO If the type is non interactive the time duration is indi cated until the status bar has reached the right end The value is given in mm ss or in ss format like for instance 01 20 for one minute and 20 seconds The range is not limited If the maximum value is missing negative or invalid it will default to 100 seconds If the initial value is greater than the maximum value it will be set to the maximum value and there will be no automatic updates to the gauge Initial Data format and function are differentiated depending on the value of the Interactive attribute If INTERACTIVE USER The number indicated here determines the initial value and therefore the starting position of the slider bar The range is 0 100 If the value is 20 for instance the status bar is displayed at 20 of its total width If the value is O the bar is on the leftmost position If INTE
93. o the Commands A Command is required to send the text data to a server and initiate server side action The Command is added by inserting a Command object in the Screen see Example It is displayed on the Options menu which is located underneath the Screen title For details about the Com mand object see Section 4 6 Command November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 56 XML Object Reference TextBox Example lt xml version 1 0 encoding UTF 8 gt lt IppPhone gt lt IppDisplay gt lt IppScreen ID 1 HiddenCount 0 CommandCount 1 gt lt IppTextBox MaxSize 30 Constraint ANY Default TEXT Key TB1l gt lt Title gt Textbox lt Title gt lt Text gt add your text here lt Text gt lt Url gt http subdomain domain path program lt Ur1 gt lt IppTextBox gt lt IppCommand Type SELECT Priority 0 gt lt Label gt Select lt Label gt lt ScreenID gt 2 lt ScreenID gt lt IppCommand gt lt IppScreen gt lt IppDisplay gt lt IppPhone gt A31003 S2000 R100 7 7620 November 18 2009 57 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference TextBox Screenshot 10 30 Wed 09 05 07 4300 Applications Settings 3400 Textbox Lucy Takeshi add your text here Mobility Shift November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 58 XML Object Reference Ticker 4 11 Ticker Ticker text is displayed o
94. ogram that is used via a web browser November 18 2009 OpenStage 60 80 XML Applications Developers Guide 112 Appendix XML Schema 6 2 XML Schema This appendix contains the entire XML schema supported by the HFA and SIP variants of the OpenStage 60 80 You can download the current version of the XML schema here http wiki siemens enterprise com index php OpenStage_XML_Applications Resources lt xml version 1 0 encoding UTF 8 gt lt xs schema xmlns xs http www w3 org 2001 XMLSchema gt lt xs annotation gt lt xs documentation xml lang en gt XML Schema for Siemens IP Phone Generic MIDlet Version 5 0 Copyright 2007 Siemens Enterprise Communications Limited All rights reserved lt xs documentation gt lt xs annotation gt lt xs element name IppPhone gt lt xs complexType gt lt xs sequence gt lt xs choice gt lt xs element ref IppDisplay gt lt xs choice gt lt xS sequence gt lt xs complexType gt lt xs element gt lt xs element name IppDisplay gt lt xs complexType gt lt xs sequence gt lt xs element ref IppScreen maxOccurs 5 gt lt xS sequence gt lt xs attribute name InitialScreen type xs nonNegativelInte ger use optional gt lt xS attribute name UpdateScreen type xs nonNegativelnte ger use optional gt lt xs complexType gt lt xs element gt A31003 S2000 R100 7 7620 November 18 2009 113 OpenStage 60 80 XML Applications Develo
95. ot support UTF 8 files with BOM please make sure you use an editor that does not insert this mark The prob lem exists for instance with older versions of Notepad There are reportedly no problems with Notepad2 Notetab or Altova XML Spy Some text editors add the leading sequence 0xEF 0xBB 0xBF to an UTF 8 file This 4 2 Phone IppPhone is an optional root element which enables the integration of special objects in the XML application These objects are not displayed They will be available in future versions of the OpenStage 60 80 phone software Using IppPhone in current XML applications has the advantage of allowing easy extension in the future The use of IppPhone as the root element is not mandatory IppDisplay see Section 4 3 Display can also server as the root element of an XML application A31003 S2000 R100 7 7620 November 18 2009 21 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Phone Syntax lt IppPhone gt lt IppDisplay gt lt IppPhone gt November 18 2009 OpenStage 60 80 XML Applications Developers Guide 22 XML Object Reference Display 4 3 Display This object enables multiple Screens within a single XML document A Screen corresponds to the content that is simultaneously shown on the display comparable to a web page According ly the IppDisplay element functions as the root element of an XML document unless IppPhone is used see Section 4 2 Phone
96. penStage 60 80 XML Applications Developers Guide 46 XML Object Reference Alert Example lt xml version 1 0 encoding UTF 8 gt lt IppPhone gt lt IppDisplay gt lt IppScreen ID 1 HiddenCount 0 CommandCount 1 gt lt IppForm ItemCount 1 gt lt Title gt Confirmation Alert lt Title gt lt Url gt http subdomain domain path program lt Url gt lt IppStringItem gt lt Label gt Press Alert lt Label gt lt Text gt An alert will appear here lt Text gt lt IppStringItem gt lt IppForm gt lt IppCommand Type SCREEN Priority 0 gt lt Label gt Alert lt Label gt lt ScreenID gt 2 lt ScreenID gt lt IppCommand gt lt IppScreen gt lt IppScreen ID 2 HiddenCount 0 CommandCount 0 gt lt IppAlert Type CONFIRMATION Delay FOREVER gt lt Title gt Alert Title lt Title gt lt Text gt Alert Text lt Text gt lt IppAlert gt lt IppScreen gt lt IppDisplay gt lt IppPhone gt A31003 S2000 R100 7 7620 November 18 2009 47 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Alert Screenshot 9 50 Wed 09 05 07 4300 E Example IC re 3400 Confirmation Alert Lucy Takeshi Options Alert Press Alert An alert will appear here G Alert Title Alert Text Dismiss iOY Mobility Shift November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 48 XML Object Reference List 4 9 This object represents a sele
97. per s Guide Appendix XML Schema lt xs element name IppScreen gt lt xs complexType gt lt xs sequence gt lt xs element ref IppKey minOccurs 0 gt lt xs choice gt lt xs element ref IppAlert minOccurs 0 gt lt xs element ref IppList minOccurs 0 gt lt xs element ref IppTextBox minOccurs 0 gt lt xs element ref IppForm minOccurs 0 gt lt xs element ref IppPlayer minOccurs 0 gt lt xs choice gt lt xs element ref IppAction minOccurs 0 gt lt xs element ref IppCommand minOccurs 0 maxOc curs unbounded gt lt xs element ref IppHidden minOccurs 0 maxOccurs un bounded gt lt xs element ref IppTicker minOccurs 0 gt lt xs sequence gt lt xs attribute name HiddenCount type xs nonNegativelnte ger use required gt lt xs attribute name CommandCount type xs nonNegativelnte ger use required gt lt xs attribute name ID type xs nonNegativelnteger use optional default 0 gt lt xs attribute name Sound type xs string use optional lt default 0 gt gt lt default 0 gt gt lt xs complexType gt lt xs element gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 114 Appendix XML Schema lt xs element name IppAction gt lt xs complexType gt lt XS sequence gt lt xs element name Number minOccurs 0 gt lt xs simpleType gt lt xs
98. proxy and press In the phone s editor enter the IP address of the proxy For details about using the editor please refer to the Administration Manual chapter 3 1 step 5 6 When the configuration data is correct and complete navigate to Save amp exit and press November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 14 Setup and Program Start Reconfigure and Remove an Application 3 3 Reconfigure and Remove an Application 3 3 1 Using the Web Interface 3 3 1 1 Reconfigure 1 Open the web interface as described in Section 3 1 2 Using the Web Interface steps 1 to 3 2 Navigate to Applications gt XML applications gt Modify application and select the appli cation to be modified Modify application Select application Examples Settings Display name Examples Application name Examples HTTP Server address 192 168 1 150 HTTP Server port 80 Protocol http Program name on server lipp XML startxml Use proxy No XML Trace enabled No Debug program on server Number oftabs 0 Tab 1 Display Name Tab 1 Application Name Tab 2 Display Name Tab 2 Application Name Tab 3 Display Name Tab 3 Application Name Auto restart 3 Click on Modify The configuration data of the selected application is loaded into the input fields A31003 S2000 R100 7 7620 November 18 2009 15 OpenStage 60 80 XML Applications Developer s Guid
99. r handling is not visible to the user If for instance some ele ments of an object are missing the remaining objects are displayed anyhow It is recommended to validate the XML documents using the XML schema provided here see Section 6 2 XML Schema This document is aimed at Siemens and Third Party developers and covers the following areas e Operating Mode and Features e Setup and Program Start e XML Object Reference e Push Capability e Appendix November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 2 Introduction Prerequisites 1 2 Prerequisites For developing applications for OpenStage phones the following components and tools are re quired or recommended 1 OpenStage 60 80 SIP phone with appropriate firmware version V1R3 x or higher 2 Infrastructure e Connection to an IP network e Web browser to configure the application on the phone using the Web Based Manage ment Alternatively the phone s local admin menu can be used e Web server for the delivery of XML data like Tomcat Apache Microsoft IIS Please note that the MIME type for the XML documents has to be set to text xm1 on the server e Application platform running on the server for instance Java Servlet ASP CGI PHP 3 XML Editor A validating XML editor is recommended like Oxygen XMLWriter Editix XMLSpy 4 For developing Java Servlets An applicable development environment for instance Eclipse NetBeans IBM W
100. r is set for details see the Administration Guide chapter 2 3 2 Intranet internet access directly or via proxy For details about setting a proxy see the Administration Guide chapter 3 13 1 2 3 1 1 Required Data An XML application is configured by providing the following parameters e Display name Program name to be displayed on the phone The following criteria must be satisfied It must be unique on the phone It cannot contain the character It cannot be empty Its length cannot not exceed 20 characters e Application name This is used internally to identify the XML application running on the phone The application name must meet the following criteria It must be unique on the phone It cannot contain non alphanumeric characters spaces for instance The first character must be a letter It must not be empty Its length must not exceed 20 characters November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 8 Setup and Program Start Configuring an Application on the Phone e Protocol The protocol used for communication to the server HTTP or in the future HTTPS e Server address The IP address of the server that provides the application or the XML document Example 192 168 1 133 e Server port number The number of the port used by the server to provide the appli cation or XML document Examples 80 Apache default port 8080 Tomcat default port e Program name Th
101. ration value MODE gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt default NULL gt lt xs attribute ref DateKey lt xS attribute ref TimeKey lt xs complexType gt lt xs element gt 121 use optional gt use optional gt A31003 S2000 R100 7 7620 November 18 2009 OpenStage 60 80 XML Applications Developer s Guide Appendix XML Schema lt xs element name IppForm gt lt xs complexType gt lt XS Sequence gt lt xs element ref Title minOccurs 0 gt lt xs element ref Url minOccurs 0 gt lt IppForm may contain any combination of none one or more IppButton IppChoiceGroup IppDateField IppGauge IppImageItem Ippltem IppSpacer IppStringItem and Ipp TextField in any order The correct XML syntax should surround each one by lt ITppltem gt lt Ippltem gt However this increases the size of the XML document and has an impact on performance When validating a simple IppForm with only one type of element lt Ippltem gt lt Ippltem gt with many different types of elements be surrounded by lt Ippltem gt lt Ippltem gt each element does not have to be surrounded by When validating a complex IppForm each elements must When the XML document for a complex IppForm has been validated the Tppitem tags they remain in parsed gt lt xs choice gt lt XS curs unbounded gt lt XS curs
102. reen Updated Sequence of keypad key presses 1st key 2nd key 3rd key or Screen Updated 39 XML Application Request next XML docu ment XML document with key pad sending enabled Remote Pro gram gt Send XML document buffer keypad input en abled SendKeys YES Keypad YES BufferKeys YES BufferLength 3 or TermKey On terminating key or buffer full Send keypad Process input data keys optional IppHidden XML document Send XML document A31003 S2000 R100 7 7620 November 18 2009 OpenStage 60 80 XML Applications Developers Guide XML Object Reference Direct Keypad Input 4 7 3 4 Buffer Subsequent Keypad Key presses In the following interaction the remote program enables send keypad input and buffer subse quent keypad keys As soon as the user presses the first keypad key e g to enter the first letter of aname to be searched in a phonebook the key is sent to the server Subsequently the user types in some more letters or digits These characters will be buffered until e the buffer length is reached or e the terminating key if defined has been pressed As soon as one of these criteria is met and the response to the previous request issued with sending the first key has been received the buffered keys are sent to the server In the example interaction the response from the server is received first that is before the buffer length is reached or
103. restriction base xs string gt lt xs pattern value d gt lt xs restriction gt lt xs simpleType gt lt xs element gt lt xs sequence gt lt xs attribute name Type use required gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value MAKECALL gt lt xs enumeration value ENDCALL gt lt xs enumeration value TURNLEDON gt lt xs enumeration value TURNLEDOFF gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs complexType gt lt xs element gt A31003 S2000 R100 7 7620 November 18 2009 115 OpenStage 60 80 XML Applications Developer s Guide Appendix XML Schema lt xs element name IppAlert gt lt xs complexType gt lt XS sequence gt lt xs element ref Title minOccurs 0 gt lt xs element ref Url minOccurs 0 gt lt xs element ref Text minOccurs 0 gt lt xs element ref Image minOccurs 0 gt lt xs sequence gt lt xs attribute name Type use optional default ERROR gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value ALARM gt lt xs enumeration value CONFIRMATION gt lt xs enumeration value ERROR gt lt xs enumeration value INFO gt lt xs enumeration value WARNING gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs attribute name Delay use optional default FOREVER gt lt xs simpleType gt lt xS union memberT
104. rrent 4 5 Action MAKECALL Linus Dial a Number pie A31003 S2000 R100 7 7620 November 18 2009 29 OpenStage 60 80 XML Applications Developer s Guide 4 6 Command XML Object Reference Command Commands generally appear in context menus which are associated either with the Options menu or with the clickable area of a specific element However CANCEL and EXIT commands do not appear in the Options menu Some Commands are associated with TouchGuide keys on the phone With Alerts the commands are displayed at the bottom of the alert The following attributes are available to the TppCommana element Attribute Value Functionality Remarks Type SELECT mandatory This transmits the key value pairs from the current List Text Box Form or Player to the URL indicated there Key value pairs from Hidden elements and the key value pair associated with the Command if present are also sent to the server BACK Switches to the cached version of the Screen displayed previously The command will always go back to the pre vious full screen i e Form List or Text Box but not Alert or Player If there is only a single screen in the XML document no menu item is generated UPDATE Replaces the current Screen with the Screen specified in the current List Text Box Form or Player The data for this Screen is fetched from the server using the URL associated with the current screen Key value pairs from
105. s and one or more child elements and their attributes The names of the basic XML elements are prefixed with Ipp which stands for IP phone for example IppAction For each individual XML object an example is provided All examples from this document are available for download under http wiki siemens enterprise com images 0 04 OpenStage_XML_apps_examples zip The following table gives an overview of the individual objects and their functions Category Object Functional Description Basic XML Phone Optional root element for future objects not shown on structure the display Display Root element for objects within the display area Navigation Command BACK BACK Leads to the screen displayed previously SCREEN UP SCREEN Leads to a specific screen DATE UPDATE Reloads the screen from the server Form Form Form for sending the contents of data fields to the server Message win Alert Temporarily appears over the currently displayed dow screen and displays a message Ticker Ticker Ticker text displayed underneath the title bar Text layout Form Stringltem Shows text on the display image Image Links an image file Form Imageltem Positions an image Form Spacer Creates a vertical space Selection lists List List of selectable options Form ChoiceGroup List of selectable options Data input TextBox Text input field with multiple lines Form TextField Te
106. simpleType gt lt xs attribute gt lt default 0 gt gt lt xs complexType gt lt xs element gt value 40_60 gt value 50_50 gt value 60_40 gt value 75_25 gt value 25_75 gt value 15_85 gt value 0_100 gt A31003 S2000 R100 7 7620 November 18 2009 OpenStage 60 80 XML Applications Developer s Guide Appendix XML Schema lt xs element name IppGauge gt lt xs complexType gt lt xs Sequence gt lt xs element ref Label minOccurs 0 gt lt xs element ref Maximum minOccurs 0 gt lt xs element ref Initial minOccurs 0 gt lt xs sequence gt lt xs attribute name Interactive use optional default US ER gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value USER gt lt xs enumeration value AUTO gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xS attribute ref Key use optional gt lt xs complexType gt lt xs element gt lt xs element name IppHidden gt lt xs complexType gt lt xs sequence gt lt xs element ref Value minOccurs 0 gt lt xs sequence gt lt xs attribute name Type use required gt lt default VALUE gt gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value VALUE gt lt xs enumeration value PHONENUMBER gt lt xs enumeration value IPADDRESS gt lt xs restriction gt
107. t gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value NEWLINE_AFTER gt lt xs enumeration value NEWLINE BEFORE gt lt xs enumeration value NEWLINE_BEF_AFT gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs attribute name Height use optional default 0 gt lt xs simpleType gt lt xs restriction base xs nonNegativelnteger gt lt xs simpleType gt lt xs attribute gt lt xs attribute name Width use optional default 0 gt lt xs simpleType gt lt xs restriction base xs nonNegativelnteger gt lt xs simpleType gt lt xs attribute gt lt xs complexType gt lt xs element gt November 18 2009 OpenStage 60 80 XML Applications Developers Guide 130 Appendix XML Schema lt xs element name IppStringItem gt lt xs complexType gt lt xs sequence gt lt xs element ref Label minOccurs 0 gt lt xs element ref Text minOccurs 0 gt lt xS sequence gt lt xs complexType gt lt xs element gt lt xs element name IppTextBox gt lt xs complexType gt lt xs Sequence gt lt xs element ref Title minOccurs 0 gt lt xs element ref Text minOccurs 0 gt lt xs element ref Url minOccurs 0 gt lt xs sequence gt lt xs attribute name MaxSize type xs nonNegativelnteger use optional gt lt xs attribute name Constraint use optional de fault ANY gt lt xs simpl
108. t Image gt lt Option gt lt IppList gt lt IppCommand Type SELECT Priority 0 gt lt Label gt Main Screen lt Label gt lt ScreenID gt 2 lt ScreenID gt lt IppCommand gt lt IppHidden Type VALUE Key xmlobject gt lt Value gt _show lt Value gt lt IppHidden gt lt IppScreen gt lt IppDisplay gt A31003 S2000 R100 7 7620 November 18 2009 43 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Alert 4 8 Alert An Alert is a message window displayed on the bottom half of the current screen Different types of Alert can be selected using the Type attribute Title text and an image can be spec ified in the child elements When an Alert is created it implicitly has a special command present on it to close the Alert Screen This command has the label Dismiss If the Screen containing the Alert also includes a Command the Dismiss command is replaced by the Command added to the Screen More over the Alert is automatically turned into a modal Alert that can only be cleared by the user Hence its timeout value which controls the persistence on the display is always FOREVER The optional element Url enables explicitly added SELECT UPDATE and EXIT Commands see Section 4 6 Command to be returned to the application running on the server If the explicitly added Commands are only BACK SCREEN or CANCEL the Url element is not re quired Another optional element IppPhone
109. t present it is not cached Syntax lt Image Cache Name gt Ssource lt Image gt The content of the Image element indicates the source of the image to be displayed Depending on the situation this path may have various formats The source path of an image may take one of the following formats e URL for the image file http lt IP address gt lt Port gt lt filename gt e URL of a program on the server that sends the desired image file the key value pair iden tifies the image http lt IP address gt lt Port gt lt filename of the program gt lt key value pair gt If the source of the image file is missing but the Cache attribute exists and the image is cached the image in cache is displayed Images as Icons If an image is to be used as an icon for an interactive element it is recommended to choose an appropriate size The images should be in PNG format The following list provides size infor mation about the built in icons for OpenStage 60 80 e Icons for mode keys call states phone number identification presence media widget speller idle screen info bar and others 36px x 36px November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 96 XML Object Reference Image e Icons in popups and prompts 60px x 60px e Dial phone number icon 12px x 36px OpenStage 60 they will be resized correctly Generally images should be optimized for OpenStage 80
110. te Using Predefined Tabs In addition to single applications it is possible to run an application suite which is divided in up to 3 internal tabs With regular XML applications and phonebook applications these tabs can be predefined by the administrator For configuring an application suite please refer to Section 3 1 Configuring an Application on the Phone The HTTP GET requests sent by the phone depend on the target URL If this URL has an xml extension the phone will request the same XML document for each tab If it has no xm1 ex tension the phone will append the unique tab name to the request URI The request has the following format November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 18 Setup and Program Start Mobile Users And Privacy http lt server ip address gt lt port gt lt program name gt ipaddress lt phone IP gt amp phonenumber lt phone number gt amp devicetype OpenStage amp tab lt unique tab name gt Depending on how many tabs have been configured for the application the phone will send 1 or 2 further similar requests for the other tabs Each of these requests will be sent right after the response to the preceding request has been received With regular XML applications the user can switch between the tabs using the key With Xpressions applications the M key is used for tab switching and with phonebook applications the key is used Application Suite Using T
111. te Value Function Interactive USER Default value The user can change the value the optional changes are graphically represented by the bar The interactive gauge has a pre defined value range be tween 0 and 100 AUTO The user has no influence on the graphical bar The gauge increments every second The range and con sequently the time interval is specified by the content of the Maximum element and by the content of the Initial element Key Key for the cur Only effective if the value of the Interactive attribute optional rent value is USER Together with the value currently set value range 1 100 it forms a key value pair that can be sent to a server as an HTTP request If the key is invalid or not present the URL specified is opened but no data are sent to the server For sending data to the server the Screen must contain a SELECT command Please note that the key must be unique within a Screen Syntax lt IppGauge Interactive USER AUTO Key k gt lt Label gt lt Label gt lt Maximum gt lt Maximum gt lt Initial gt lt Initial gt lt IppGauge gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 92 XML Object Reference Form Child elements Label The label for giving information on what is displayed by the gauge Maximum Data format and function are differentiated depending on the value of the Interactive attribute If INTERACTIVE USER The
112. the user has typed in the terminating key User XML Application Remote Pro gram Request next XML docu ment Screen XML document with key Send XML Updated pad sending enabled document buffer keypad input en abled SendKeys YES Keypad YES BufferKeys SUBSEQUENT BufferLength 5 or TermKey 1st Keypad key Send keypad key op Process input tional IppHidden data and request next XML document p Buffer keys Screen XML document with key Send XML Updated pad sending enabled document November 18 2009 OpenStage 60 80 XML Applications Developers Guide 40 XML Object Reference Direct Keypad Input User XML Application Remote Pro gram Send buffered keypad a Process input keys optional data IppHidden Screen a XML document Send XML Updated document A31003 S2000 R100 7 7620 November 18 2009 41 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Direct Keypad Input The following attributes are available to the IppKey element Attribute Value Functionality Remarks Keypad YES Keypad key presses are handled mandatory NO Default value Keypad key presses are ignored SendKeys YES Key digits are sent mandatory NO Default value Key digits are not sent BufferKeys YES The key presses are buffered optional NO Default value The key presses are not buffered but immediately sent to the server SUBSEQUENT The key presses followi
113. ue attribute is then sent for non selected options this value is prefixed with not_ Table 4 2 If a key or value is missing or invalid nu11 is sent instead e OptionText 51 Descriptive text for the option An IppPhoneNumber see Section 4 16 Phone Number can be included which enables the automatic translation of a phone number stored in the local phone book into the name associated to the number and an icon or a picture clip The following attribute is available to the element Attribute Value Function State NORMAL The text is displayed in regular color optional GRAY The text is displayed in gray color Image Illustrative image for the option The image is displayed to the left of the text For more in formation about the Image element see Section 4 14 Image A31003 S2000 R100 7 7620 November 18 2009 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference List Commands Unless the List type is IMPLICIT a Command is required to send data to a server and initiate server side action A Command is added by inserting a Command object in the Screen see Example The Command can be displayed on the Options menu which is located underneath the Screen title or on each individual item on the List or both For details please see Section 4 6 Command Example lt xml version 1 0 encoding UTF 8 gt lt IppPhone gt lt IppDisplay gt lt IppScreen ID 1 HiddenCou
114. uicker than responses are received from the server Error Handling If there is a failure in the communication protocol between the phone and the remote server when sending keypad key presses to the remote server no error message is displayed to the user However if requested by the server via XML document the key presses will be buffered on the phone When the user presses the next keypad key and the connection is re estab lished that key press and all buffered key presses will be sent to the remote server 4 7 2 Possible Uses Potential example XML applications using sending keypad input are 1 A phonebook application in which the user initiates a search for the appropriate entry using the keypad keys The digits are sent to the remote program The remote program uses the digits as search criteria and returns a list of matching entries These entries are immedi ately displayed to the user If the user presses subsequent keypad keys after the first key pad digit and a response has not yet been received the keypad digits are buffered and sent en bloc to the remote program 2 Amenu application provides a sequence of numbered lists of options The user navigates in a list using the keypad keys The remote program requires single keypad digits to deter mine the next list Therefore multiple keypad digits or any subsequent keypad digits are ignored whilst the phone is waiting for server response 3 An application requests the user to
115. valid the phone Constraint ANY Default value Any character string is permitted optional NUMERIC The data entered must be numeric Other keyboard en tries are ignored PASSWORD The data entered are treated as a password Asterisks are displayed instead of the characters ac tually entered PHONENUMBER The data entered must be in a telephone number for mat URL The data entered must represent a valid URL EMAILADDR The data entered must represent a valid e mail address PASSWORD YES The data entered in the text field are confidential and optional should be obscured whenever possible NO Default value The data entered in the text field are not confidential Default NULL An empty entry field is displayed the content of the optional Text element is ignored TEXT The entry field contains the content of the Text ele ment PHONENUMBER The text field contains the phone s call number Key Key The value of this attribute is used as a key for submitting optional the data as an HTTP request The associated value is the content of the Text element Please note that the Key must be unique within a Screen Table 4 3 A31003 S2000 R100 7 7620 November 18 2009 73 OpenStage 60 80 XML Applications Developer s Guide XML Object Reference Form Attribute Value Function Remarks Uneditable YES The text field cannot be edited by the user optional NO Default value The text field can be edited by the user Table 4 3
116. xt input field with a single line Form DateField Date input field Form Gauge inter Entry of a numerical value using a horizontal slider active Table 4 1 November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 20 XML Object Reference Encoding Internationalization Category Object Functional Description Hidden data Hidden Invisible field for transmitting data between telephone transfer and server Visualization Form Gauge non Horizontal bar that grows every second of chronologi interactive cal processes Sending data Command SE The data contained in the entry fields on the screen are to the server LECT sent to the server Form Button Sends the data that is saved in attributes to the server Telephony Action MAKE Initiates a call to a specific telephone number CALL LED control Action TURNLE Turns on off the LED on the Message mode key DON or TURNLED OFF Table 4 1 4 1 Encoding Internationalization The OpenStage XML interface supports UTF 8 and ASCII If a different character set is used e g ISO 8859 1 special characters can be encoded by numeric character references Example amp 228 will be rendered as the german umlaut a For details see http www ws org TR 2000 REC xml 20001006 sec references is a byte order mark BOM which is conventionally used to indicate that the text is encoded as UTF 8 As the phone s XML parser does n
117. ypes xs positivelnteger gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value FOREVER gt lt xs restriction gt lt xs simpleType gt lt xs union gt lt xs simpleType gt lt xs attribute gt lt xs complexType gt lt xs element gt November 18 2009 OpenStage 60 80 XML Applications Developer s Guide 116 Appendix XML Schema lt xs element name IppButton gt lt xs complexType gt lt xs Sequence gt FAULT gt 117 lt xs element ref Label minOccurs 0 gt lt xs element ref Image minOccurs 0 gt lt xSs sequence gt lt xS attribute name Layout use optional default DE lt xs simpleType gt lt xs restriction base xs string gt lt XS lt XS enumeration enumeration lt XxXS lt XS lt XS lt XS enumeration enumeration enumeration enumeration lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xs attribute name Type use optional default IMAGE gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value IMAGE gt lt xs restriction gt lt xs simpleType gt lt xs attribute gt lt xS attribute ref Key use required gt lt xS attribute ref Value use required gt lt xs complexType gt lt xs element gt value CENTER gt value DEFAULT gt value LEFT gt value NEWLINE AFTER gt value

Documentation OpenStage 60/80

Contents

Download Pdf Manuals

Related Search

Related Contents