mycompany.com
Firmware- Grandstream Networks
Instruction Manual for GRANDSTREAM models including: GRP260X XML Based Idle Screen Customization, GRP260X, XML Based Idle Screen Customization, Idle Screen Customization, Screen Customization, Customization
GRP260x Idle Screen Customization Guide - ation Center
File Info : application/pdf, 29 Pages, 719.73KB
DocumentDocumentGrandstream Networks, Inc. XML Based Idle Screen Customization Guide GRP260X IP Phone GRP2601(P) GRP2603(P) GRP2 6 0 2 ( P / W / G ) GRP2 6 0 4 ( P ) INTRODUCTION The Grandstream GRP260X supports XML based idle screen customization. This XML API allows users to customize the idle screen layout as well as the logo, text or system variables to be displayed. The design of the display and layout depends highly upon personal preferences and requirements. This document specifies the Grandstream XML Customizable Screen API design that will be used on GRP260X. WHAT IS XML XML (eXtensible Markup Language) is a markup language* for documents and applications containing structured information. This information contains both content (text, pictures, input box and etc.) and an indication of what role that content plays (e.g. content in a section header is different from content in a footnote, or content in a figure caption, or content in a database table, and etc.). Almost all documents have certain kind of structure. *Note: A markup language is a mechanism to identify structures in a document. The XML specification defines a standard way to add markup to documents. WHY XML What benefits does XML provide to SIP endpoints? XML enables our SIP phones to serve as output devices where the phones could interact with external applications in a flexible and programmable manner. Two specific XML APIs supported by GRP260X are XML Custom Screen and XML Phonebook. XML API ARCHITECTURE The XML idle screen customization API on GRP260X could use HTTP/HTTPS or TFTP as the transport protocol. The following figure shows how it works via HTTP as an example. Basically, GRP260X initiates the HTTP GET Request to the HTTP server and waits for the response. Once the phone receives the response with XML content in BODY, it displays the information. Figure 1: GRP260X XML API via HTTP Two types of XML API architectures are introduced below, depending on whether the transaction is within a LAN or accessed via the Internet. 1. A transaction in LAN area may exchange information in the following manner. GRP260X sends request and accepts XML contents via HTTP/HTTPS/TFTP, directly communicating with the HTTP/HTTPS/TFTP Server. The Server will then handle the request and response via any protocols with the other application server to get the expected information for the XML idle screen display. The following figure shows downloading XML idle screen via HTTP within LAN. Figure 2: GRP260X XML API Structure - 1 2. If the above Web Server accesses Internet, it could interact with outside web server and respond realtime content to GRP260X. Figure 3: GRP260X XML API Structure - 2 As illustrated above, all the logic lies within the server side of the architecture. The GRP260X phone receives XML document and displays it accordingly. XML IDLE SCREEN DOWNLOADING CONFIGURATION FIRMWARE Before the XML idle screen customization is used on GRP260X, please make sure the firmware on the phone is upgraded to the latest version. Please refer to the following link for firmware upgrading information: http://www.grandstream.com/support/firmware GRP260X Graphic Display The following table lists all the GRP260x screen sizes. Table 1: GRP260X Idle Graphic Display Model GRP2601/GRP2601P GRP2602/GRP2602P/GRP2602W GRP2603/GRP2603P GRP2604/GRP2604P Graphic Display 132 x 48 (2.21'') LCD display 132 x 48 (2.21'') backlit graphical LCD display 132 x 64 backlit graphical LCD display 132 x 64 backlit graphical LCD display WEB GUI CONFIGURATION To download the XML idle screen file to GRP260X, firstly enable the Idle Screen XML Download and configure the Server Path under Web GUI->Settings->XML Applications page. Figure 4: Web GUI Configuration · Idle Screen XML Download The idle screen XML file could be downloaded via HTTP, HTTPS or TFTP. By default, it is "Disabled". · Download Screen XML at Boot-up If it's set to "Yes", when the phone boots up, it will send out request to download the XML idle screen file automatically. If it's set to "No", users would need go to LCD MENU->Preference->Download SCR XML to download the idle screen manually. Users could also erase the current downloaded idle screen by pressing MENU->Preference->Erase Custom SCR. By default, this option is set to "No". · Use Custom Filename If "Use custom filename" is set to "No", the XML file name must be idle_screen.xml. In this case, users only need to specify the folder path in "Idle Screen XML Server Path" where the idle_screen.xml is located (For example, 192.168.40.10/XMLscreendir). If "Use custom filename" is set to "Yes", users could name the file as preferred. In this case, the "Idle Screen XML Server Path" has to be specified to the name of the XML file (For example, 192.168.40.10/XMLscreendir/welcome.xml). · Idle Screen XML Server Path This specifies the path where the phone is going to download the XML file. Since downloading method is selected as "HTTP", "TFTP", or "HTTPS" already when enabling the XML idle screen download, users shall not specify the protocol in this path anymore. The accepted format are as follows: IP_address[:port]/dir IP_address[:port]/dir/filename Hostname[:port]/dir Hostname[:port]/dir/filename Examples: 192.168.40.10/XMLscreendir 192.168.40.10/XMLscreendir/welcome.xml 192.168.40.10:443/XMLscreendir 192.168.40.10:443/XMLscreendir/welcome.xml mycompany.com/gs_screen_dir mycompany.com:8080/idlescreen service.mycompany.com/XML/GRP260Xidle.xml service.mycompany.com:8080/XML/GRP260Xidle.xml Note: · If "[:port]" is not specified, port 80 will be used as default for HTTP; port 443 will be used as default for HTTPS; port 69 will be used as default for TFTP; · If "Use custom filename" is set to "No", the Server Path does not necessarily need to contain the destination file name. Users only need specify the directory path where the file is located. After the above configuration, click on "Save and Apply" in the web GUI page. The phone will apply and display the XML idle screen upon pressing MENU->Preference->Download XML SCR in phone's LCD or once the phone restarted if the option "Download Screen XML at Boot-up" is selected. Users may also use the XML configuration file to provision the phone with the above XML idle screen downloading options. In this case, GRP260X needs to be rebooted and provisioned. The corresponding P values are as below. · P340: Idle Screen XML Download. Possible values: 0 (Disabled) / 1 (HTTP) / 2 (TFTP) / 3 (HTTPS), other values are ignored; · P1349: Download Screen XML at Boot-up. Possible values: 0 (No) / 1 (Yes), other values are ignored; · P1343: Use custom filename. Possible values: 0 (No) / 1 (Yes), other values are ignored; · P341: Idle Screen XML Server Path. This is a string up to 128 characters. Note: · As you may know, it is also possible to enter the idle screen file server path into a web browser. In this way youll be able to see the exact XML document on your PC that your phone will be receiving; · The downloaded XML idle screen file can be displayed but won't be saved internally on the phone. It is recommended to save the XML idle screen file externally on your PC or server for your reference and future use. GRP260X IDLE SCREEN OVERVIEW Without XML idle screen customization or other configurations, a GRP260Xs default idle screen is like below. Press the softkey will toggle among the following different idle screens (vary among models): · Default idle screen when the phone boots up · IP Address and Extension Number Figure 5: GRP260X Default Idle Screen The idle screens for all models are specified in the table below. Although all the supported idle screens could be modified via the XML idle screen file, normally the idle screen 1 (default idle screen) is the only one user would need to customize for logo display, text display and etc. Table 2: GRP260X Idle Screens Overview Model GRP2601/GRP2601P GRP2602/GRP2602P/GRP2602W GRP2603/GRP2603P GRP2604/GRP2604P Idle Screen 1 Default Default Default Default Idle Screen 2 IP Address IP Address IP Address IP Address XML DOCUMENT FORMAT HEADER In the first line of the XML document, the following header can be set as XML declaration. It defines the XML version and encoding. On GRP260X, UTF-8 is used as encoding method for correct display. <?xml version="1.0" encoding="UTF-8"?> SPECIAL CHARACTERS As followed by the standard XML recommendation, some characters need to be escaped. The following table lists the characters with their escape sequence. Table 3: Special Characters in XML Document Characters Name Escape Sequence & Ampersand & " Quote " ,, Apostrophe &apos < Left Angle Bracket < > Right Angle Bracket > GRP260X SCREEN XML STRUCTURE The main structure of GRP260X idle screen template could be represented below. This provides users with an overview of the XML element and screen layout. For more details on element attributes and text information, please refer to section [GRP260X IDLE SCREEN XML ELEMENT]. GRP260X SCREEN XML MAIN STRUCTURE <Screens> <Screen model="GRP2603;GRP2604" width="132" height="64"> <!-- MAIN SCREEN-> <IdleScreen> </IdleScreen> <IdleScreen> </IdleScreen> <IdleScreen> <!-- DEFINE AVAILABLE SOFTEKEYS HERE-> </IdleScreen> <!-- DISPLAY IP ADDRESS AND EXTENSIONS-> <IdleScreen> </IdleScreen> </Screen> <Screen model="GRP2601,GRP2602" width="132" height="48"> <!-- MAIN SCREEN-> <IdleScreen> </IdleScreen> <IdleScreen> </IdleScreen> <IdleScreen> <!-- DEFINE AVAILABLE SOFTEKEYS HERE-> </IdleScreen> <!-- DISPLAY IP ADDRESS AND EXTENSIONS-> <IdleScreen> </IdleScreen> </Screen> </Screens> GRP260X IDLE SCREEN XML ELEMENT This section describes details of the XML element used in GRP260X XML idle screen customization. Please note that the element name is case-sensitive when being used in XML document. ROOT ELEMENT <Screen> <Screen> is the root element of the XML document. This element is mandatory. <Screen> All the information for screen display is here </Screen> <Screen> ELEMENT DETAILS The following tables shows child element and attribute for <Screen> element. Object Screen LeftStatusBar IdleScreen Position Root element Child element Child element Table 4: <Screen> Element Type Values Comments Mandatory - Root element of the XML document Optional - Defines account bar display Mandatory - Main customization area. Normally, only the 1st <IdleScreen> element needs customization for logo, text or variable display. Users usually could leave the other IdleScreen elements as default. <IdleScreen> ELEMENT This is the main customization section for the XML idle screen. GRP260X XML BASED IDLE SCREEN CUSTOMIZATION GUIDE 12 / 29 <IdleScreen> <ShowStatusLine>true/false</ShowStatusLine> <DisplayElement> Element display information here </DisplayElement> <DisplayBitmap > <DisplayString font="unifont"> </DisplayString> <SoftKeys> Softkey </SoftKeys> </IdleScreen> <IdleScreen> ELEMENT DETAILS Object IdleScreen ShowStatusLine Position Element Child element DisplayElement DisplayBitmap DisplayString Softkeys Child element Child element Child element Child element Table 5: <IdleScreen> Element Type Values Comments Mandatory - Mandatory - It could use "true" or "false" as its text. "true": the line label on the left side will always display. "false": the line label on the left side will not display. For the 1st <IdleScreen> section (default screen), it should be set to "true". Optional - Optional - Optional - Mandatory - <DisplayElement> ELEMENT This element contains all the contents to be displayed, i.e., string, picture and rectangle. GRP260X XML BASED IDLE SCREEN CUSTOMIZATION GUIDE 13 / 29 <DisplayElement> <DisplayString>String information</DisplayString> <DisplayBitmap>Image information</DisplayBitmap> <DisplayRectangle x="X location" y="Y location" bgcolor="Background color"/> </DisplayElement> width="Width" height="Height" <DisplayElement> ELEMENT DETAILS Object DisplayElement DisplayString DisplayBitmap DisplayRectangle Position Element Child element Child element Child element Table 6: <DisplayElement> Element Type Values Mandatory - Optional - Optional - Optional - Comments Displays string Displays bitmap picture Displays rectangle GRP260X XML BASED IDLE SCREEN CUSTOMIZATION GUIDE 14 / 29 <DisplayString> ELEMENT This element is used for displaying string information on the screen. <DisplayString font ="unifont/bold" width="width of the string" height="height of the string" halign=" center/left/right" color="color of the string" bgcolor="color of the background" > <X>X location</X> <Y>Y location </Y> <DisplayStr>Display String</DisplayStr> </DisplayString> <DisplayString> ELEMENT DETAILS Object DisplayString font width height align color bgcolor X Y DisplayStr displayCondition Table 7: <DisplayString> Element Position Type Values Comments Element Optional - <DisplayString> Attribute Optional "unifont" /"bold"/"time" /"time_14"/"ti me14_bold" Default font type is "unifont". time/time_14/time_14_bold:It used to display the time <DisplayString> Attribute <DisplayString> Attribute <DisplayString> Attribute <DisplayString> Attribute Optional Optional Optional Optional <DisplayString> Optional Attribute Child element Child element Child element Mandatory Mandatory Mandatory int int string string string int int string Child element Optional - Default value is "left" Default value is "Black" Only if set to White is White, all other colors are black. Default value is "White" Only if set to White is White, all other colors are black. Displays the string from X Displays the string from Y The string to be displayed. System variables can be used here The string will be displayed under certain condition. If not specified it's always displayed GRP260X XML BASED IDLE SCREEN CUSTOMIZATION GUIDE 15 / 29 <DisplayBitmap> ELEMENT This element is to display a bitmap picture in the screen, for example, to customize the logo. Inside the <Bitmap> tag, the picture must be encoded in base 64 format already. If you search "Base 64 Encoder" online, there are plenty of online tools as base 64 encoder to encode the .bmp picture. <DisplayBitmap isflash="true/false"> <Bitmap>Bitmap file encoded in base64 format</Bitmap> <X>X location</X> <Y>Y location</Y> </DisplayBitmap> <DisplayBitmap> ELEMENT DETAILS Object DisplayBitmap isflash X Y Bitmap Table 8: <DisplayBitmap> Element Position Type Values Element Optional - <DisplayBitmap> Attribute Optional "true"/ "false" Child element Mandatory int Child element Mandatory int Child element Mandatory string Comments Default value is "false". Displays the picture from X Displays the picture from Y The base-64 encoded .bmp file To create .bmp and display it on the phone: · Firstly, make sure the picture is in .bmp format and not exceed the LCD size of the phone. · Use a base-64 encoder to encode the picture. · Copy and paste and encoded result inside <Bitmap> tag. · Make sure the isfile attribute is set to "false" in <DisplayBitmap> element. GRP260X XML BASED IDLE SCREEN CUSTOMIZATION GUIDE 16 / 29 Example: <DisplayBitmap > <Bitmap>Qk3GAgAAAAAAAD4AAAAoAAAAqgAAABsAAAABAAEAAAAAAIgCAAAAAAAAA AAAAAAAAAAAAAAAAAAAAP///wD////////////////////////////AAAD////////////////////////////AAAD//////////////////////////// AAAD+D/wf/wAAwAfgAB8B/wPw/wA+AAHAAAD+B/wH8AAAAAAAAAAAH4DwPgAAAABAAAD+A/w D4H//wPwH//g4D4BwDgfgf//AAAD+A/wB4H//wHwP//B8D4AwBgPgf//AAAD+AfwB4H//wHwP//B8B8AY AwPgf//AAAD/APwB4D4HwHwHx/A8B8CAEAPgPAfAAAD/AHwA8D4H4D4Hgfg8B+BgCAHgPAfAAA D/ADwA8B8H4D4DgfgeD+BwDgHgHgfAAAD/ABwEfgAP4B/AAfwAAAA8D4H8AA/AAAD/AgwEPwA/8 B/wB/+AAAA/D8H/AD/AAAD/AwQGP///8B/////////////////AAAD/A4QGH///8B/////////////////AAAD/AcAGD///+B /////////////////AAAD/geAHB///+B/////////////////AAAD/geAHh///+A/////////////////AAAD/gfgHw////A/////////////////AAA D/gfgHwf///A/////////////////AAAAAAfwH4f///gf////////////////AAACAAfwH4P///gf////////////////AAADAA/4H8P//////// /////////////AAADgB/8H+P/////////////////////AAAD////////////////////////////AAAD////////////////////////////AAAD/////////////////// /////////AAAA= </Bitmap> <X>0</X> <Y>7</Y> </DisplayBitmap> <DisplayRectangle> ELEMENT This element is to render rectangle display. It could be used as a frame or background bar. <DisplayRectangle x="X location" y="Y location" width="Width" height="Height" bgcolor="Background color" border-color="Rectangle border color"/> GRP260X XML BASED IDLE SCREEN CUSTOMIZATION GUIDE 17 / 29 <DisplayRectangle> ELEMENT DETAILS Object DisplayRectangle x y width height bgcolor border-color Table 9: <DisplayRectangle> Element Position Type Values Comments Element Optional - Displays rectangle <DisplayRectangle> Attribute Optional int Default value is 0 <DisplayRectangle> Attribute Optional int Default value is 0 <DisplayRectangle> Attribute Mandatory int <DisplayRectangle> Attribute Mandatory int <DisplayRectangle> Attribute Optional <DisplayRectangle> Attribute Optional string string Default value is Black.Only if set to White is White, all other colors are black. Default value is None.Only if set to White is White, all other colors are black. GRP260X XML BASED IDLE SCREEN CUSTOMIZATION GUIDE 18 / 29 <SoftKeys> ELEMENT This element is the parent element for <SoftKey> element. The purpose is to set up the softkey display and action. This element is mandatory. <SoftKeys> <SoftKey > Softkey information here </SoftKey> </SoftKeys> <SoftKeys> ELEMENT DETAILS Object SoftKeys softkey Position Element Child element Table 10: <Softkeys> Element Type Values Comments Mandatory - Mandatory - Defines each softkey' s display and action <SoftKey> ELEMENT This element defines each softkey's label and action. This element is mandatory. The text for <Action> and <conditionType> are pre-defined in the firmware already so it's recommended to keep this section by default. <SoftKey> <Action> Pre-defined softkey actions here </Action> <displayCondition> <conditionType>Pre-defined condition Type here</conditionType> </displayCondition> </SoftKey> A new action type "Dial" is added with a different format. To configure a speed dial softkey, user can add a "Dial" softkey as a child element of <SoftKeys> element. GRP260X XML BASED IDLE SCREEN CUSTOMIZATION GUIDE 19 / 29 <SoftKey action="Dial" label="label name" commandId="Account index" commandArgs="The number to dial"/> Note: the object <label> defines the softkey display name on LCD; <commandId> specifies the account index to dial out the call from, starting from 0 for account 1; <commandArgs> specifics the phone number to dial. GRP260X XML BASED IDLE SCREEN CUSTOMIZATION GUIDE 20 / 29 <SoftKey> ELEMENT DETAILS Object SoftKey Action displayCondition Position Element Child Element Child Element Table 11: <SoftKey> Element Type Mandatory Mandatory Mandatory Values - Comments Softkey Action (pre-defined) Softkey display condition (pre-defined) Lists of the pre-defined softkey <Action> and <ConditionType> contents are described below. Please refer to full ConditionType listed in section "XML Idle Screen Display Condition Type". Softkey SwitchSCR Calls MissedCalls OutgoingCalls IncomingCalls FwdedCalls FwdAll CanclFwd Table 12: Pre-defined Softkey <Action> and <ConditionType> Action ConditionType Description <SwitchSCR/> SubScreen To switch among default idle screen and IP address screen <Calls/> <MissedCalls/> <OutgoingCalls> <IncomingCalls> <FwdedCalls/> <FwdAll/> <CancelFwd/> To display the records of call. missCall Displayed when there is new missed call. To display the records of outgoing call. hasFowardedCallLog callFwdCancelled callFwded To display the records of incoming call. Displayed when account1 is registered and "Enable Call Feature" is set to "Yes" Displayed when Account 1 is registered, "Enable Call Feature" is set to "Yes," ForwardALL softkey was not set as hidden and Account 1 forwardAll is not set Displayed when account1 has Call Forward All activated Redial <Redial/> hasDialedCalllog Displayed when there is dialed call GRP260X XML BASED IDLE SCREEN CUSTOMIZATION GUIDE 21 / 29 VoiceMail Phonebook BSCallCenter Call park LDAP Dial Login Logout <VoiceMail/> <PhoneBook/> <BSCallCenter/> <CallParked/> <LDAP/> <Dial> By default it's not specified and it will be always displayed. It could use "hasVoiceMail" so it will be displayed only when there is new voicemail. If not specified, it will be always displayed To display Voicemail softkey. To bring up phonebook entries bsCallCenter Displayed when Broadsoft Call Center is configured hasBWCallParks LDAPConfigured Display when Broadsoft Call park is configured Displayed when LDAP is configured Speed dial </Login> login Public mode Login </Logout> logout Public mode Logout Example 1: Speed dial <SoftKeys> <SoftKey action="Dial" label="SpeedDial" commandId="0" commandArgs="1002"/> <Softkeys> Note: The order of softkey displayed on the idle screen follows the same order of the <SoftKey> tag defined in the idle screen xml file. For example, in idle_screen.xml file, the action of the first four SoftKey are <SwitchSCR/> , "Dial" , "Calls" and "PhoneBook" . By loading this xml file, the softkeys of and Calls and PhoneBook will be placed on phone's first idle screen, in turn. , Dial GRP260X XML BASED IDLE SCREEN CUSTOMIZATION GUIDE 22 / 29 SYSTEM VARIABLES IN STRING DISPLAY In <DisplayString> element, the following system variables could be used to display the pre-defined values in XML customized idle screen. $String $a $b Table 13: System Variables for XML Idle Screen This variable is replaced with the configured account name N/A This variable is replaced with the current day of month with leading zero, possible $B values: 01, 02, ..., 31 This variable is replaced with DND (Do- $C Not-Disturb) label when DND is enabled This variable is replaced with the current This variable is replaced with Missed $c day of month with leading zero, possible Call string along with missed call count. $D values: 01, 02, ..., 31 This variable is replaced with the $E N/A $d current day of month with leading zero, possible values: 1, 2, ..., 31 This variable is replaced with the $f Month-week-date format based on the $F N/A configuration $g N/A This variable is replaced with the $G number of the Missed Call This variable is replaced with the This variable is replaced with the current current hour of day in 12-hour format hour of day in 24-hour representation $h $H with leading zero, possible values: 01, with leading zero, possible values: 00, 02, ..., 02, ..., 23 12 This variable is replaced with the This variable is replaced with the system $i $I system IPV6 Address IPV4 Address GRP260X XML BASED IDLE SCREEN CUSTOMIZATION GUIDE 23 / 29 This variable is replaced with "Keypad $k $J N/A is locked" $l N/A $K N/A This variable is replaced with the $m current $L N/A minute of hour with leading zero, possible values: 01, 02, ..., 59 This variable is replaced with the This variable is replaced with the current $n current month in number with leading $M month in English, possible values: zero, January, February, ..., December possible values: 1, 2, ..., 12 This variable is replaced with the This variable is replaced with the $o current month in number with leading $N configured SIP Display Name or account zero, name possible values: 01, 02, ..., 12 $p N/A $O N/A This variable is replaced with the This variable is replaced with the current $r volume $P AM/PM status in upper case, possible level values: AM, PM This variable is replaced with the $s current $R N/A second of minute with leading zero, possible values: 01, 02, ..., 59 $t N/A $S N/A This variable is replaced with 5V power This variable is replaced with the current $v usage alert message when incorrect hour:minute (am/pm) of the day, in which power is used ":" will flash per second. Depending on $T user's configuration, it will be displayed as 12 hour or 24 hour format. Possible values: 1:00pm, 13:00 $w N/A This variable is replaced with the $V configured Account SIP Server host GRP260X XML BASED IDLE SCREEN CUSTOMIZATION GUIDE 24 / 29 $x N/A This variable is replaced with the current day of week and has the following $W possible values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday This variable is replaced with the This variable is replaced with the $X $y current year in 2-digit number, for configured Account SIP User ID example: 06, 07 This variable is replaced with the This variable is replaced with the $Y current year in 4-digit number, for $-O account name of the first registered example: account 2006, 2007 ... Table 14: System Variables for XML Idle Screen ($+number) $+number This variable is replaced with Multi-language.Number indicates the translation ID to be obtained $+640 This variable is replaced with the "NETWORK STARTING" message $+161 $+339 This variable is replaced with the IP address This variable is replaced with the Account Name $+1512 $+1539 This variable is replaced with the "Enable Auto Recovery" message $+1226 This variable is replaced with the "NETWORK DOWN" message This variable is replaced with the "New IM(s)" message Note: To display "$", please use "$$" escape sequence. To display "$T", Some fonts contain "AM/PM", so you don't need an extra "$P". if the font is set to "time" or "time_12", it will display with "AM/PM" , so you need to remove "$P".And if is set to "time_14" you need to add "$P". GRP260X XML BASED IDLE SCREEN CUSTOMIZATION GUIDE 25 / 29 XML IDLE SCREEN DISPLAY CONDITION TYPE The following tables list all the available <ConditionType> in XML idle screen. They could be used for softkey display or string display. ConditionType SubScreen missCall hasFowardedCallLog callFwdCancelled callFwded hasDialedCalllog hasVoiceMail alwaysDisplay bsCallCenter hasBWCallParks LDAPConfigured keypadLock networkUp networkStart wrongPower hasIM login logout Table 15: ConditionType for XML Idle Screen Description for softkey/string display Displayed on idle screen and IP address screen. Displayed when there is new missed call Displayed when account1 is registered and "Enable Call Feature" is set to "Yes" Displayed when Account 1 is registered, "Enable Call Feature" is set to "Yes," ForwardALL softkey was not set as hidden and Account 1 forwardAll is not set Displayed when account1 has Call Forward All activated Displayed when there is dialed call Displayed when there is new voicemail. Default display if not specified Valid if Broadsoft call center is enabled Valid if Broadsoft Callpark is configured in any of the accounts Valid if LDAP server is configured Valid if keypad is currently locked Valid when the phone obtains an IP address (Either IPv4 or IPv6) Valid when the phone obtains an IPv4 address Valid when the phone used an incorrect power adapter Valid if there is a new instant message in Account 1 Public mode Login Public mode Logout GRP260X XML BASED IDLE SCREEN CUSTOMIZATION GUIDE 26 / 29 XML IDLE SCREEN EXAMPLE GRP260X COMPANY NAME EXAMPLE (/custom_name_GRP260X) In this example, the company name is added in the middle of the screen. The date element is displayed at the top right and the time at the top left. The second screen shows IP and account1 information. Figure 6: XML Idle Screen Example Company name (GRP2602W) Figure 7: XML Idle Screen Example Company name (GRP2604P) GRP260X XML BASED IDLE SCREEN CUSTOMIZATION GUIDE 27 / 29 GRP260X COMPANY LOGO EXAMPLE (/custom_logo_GRP260X) In this example, the company logo is added in the middle of the screen. The date element is displayed at the top right and the time at the top left. The second screen shows IP and account1 information. Figure 8: XML Idle Screen Example - Company Logo (GRP2602W) Figure 9: XML Idle Screen Example - Company Logo (GRP2604P) GRP260X XML BASED IDLE SCREEN CUSTOMIZATION GUIDE 28 / 29 GRP260X CUSTOM SOFTKEY EXAMPLE (/custom_softkey_GRP2602X) In this example, a custom softkey labeled "OutgoingCall" and "PhoneBook" are add to the softkey bar. The network status, date and time elements remain as default. The second screen shows IP and account1 information. Figure 10: XML Idle Screen Example - Custom softkey (GRP2602W) GRP260X XML BASED IDLE SCREEN CUSTOMIZATION GUIDE 29 / 29