Difference between revisions of "How to set up an OpenStage XML Application"
The Wiki of Unify contains information on clients and devices, communications systems and unified communications. - Unify GmbH & Co. KG is a Trademark Licensee of Siemens AG.
(→Testing the XML Application) |
|||
(42 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
+ | {{Breadcrumb|0|0|{{dev-en}}|OpenStage|OpenStage XML Applications}} | ||
+ | |||
== Scope == | == Scope == | ||
− | Follow this step-by-step instructions to set up an example XML application on your [[OpenStage SIP|OpenStage]] 60/80. | + | Follow this step-by-step instructions to set up an example XML application on your [[OpenStage SIP|OpenStage]] 60/80. The application will display a weather forecast for a region of your own choice. |
== Prerequisites == | == Prerequisites == | ||
Line 10: | Line 12: | ||
== Set up an XML Application == | == Set up an XML Application == | ||
There are three ways to set up and configure an XML application on an OpenStage phone: | There are three ways to set up and configure an XML application on an OpenStage phone: | ||
− | * Local Phone Menu: The graphical user interface provided by OpenStage 60/80. | + | * [[#Setup Using the Local Phone Menu|Local Phone Menu]]: The graphical user interface provided by OpenStage 60/80. |
* [[WBM]] (Web Based Management): The web interface provided by all OpenStage phones. It allows the user and administrator to configure the phone using a web browser. | * [[WBM]] (Web Based Management): The web interface provided by all OpenStage phones. It allows the user and administrator to configure the phone using a web browser. | ||
− | * [[DLS]] (Deployment Service): A versatile | + | * [[DLS]] (Deployment Service): A versatile administration tool for IP phones. |
+ | |||
+ | === Setup Using the Web Interface ([[WBM]]) === | ||
+ | # Open your web browser and enter the transfer protocol, IP address and port number of your phone. If HTTP is used, port 8085 must be added, for example <tt>http://192.168.1.15:8085</tt>. For HTTPS, the phone uses the standard port (<tt>443</tt>), for example: <tt>https://192.168.1.15</tt>. If the browser displays a certificate notification, confirm it.<br>In the upper right corner of the web page, the phone's call number, IP address, and DNS name are displayed. The left column contains the user menu tree.[[Image:XML_apps-screenshot-wbm-homepage.gif|250px|none]]<br> | ||
+ | # Click on the <tt>Administrator Pages</tt> tab. In the dialog box, enter the admin password:[[Image:XML_apps-screenshot-wbm-admin-login.gif|250px|none]]<br> | ||
+ | # The administration main page opens. The left column now 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 right column.<br> | ||
+ | # Navigate to <tt>Applications</tt> > <tt>XML applications</tt> > <tt>Add application</tt> and enter the required data. [[Image:XML_apps-screenshot-add_application.png|250px|none]]The following settings are required to set up the application: | ||
+ | ## <tt>Display name</tt>: <tt>Weather</tt> | ||
+ | ## <tt>Application name</tt>: <tt>Weather</tt> | ||
+ | ## <tt>Server address</tt>: <tt>87.106.21.36</tt> | ||
+ | ## <tt>Server port</tt>: <tt>8080</tt> | ||
+ | ## <tt>Protocol</tt>: <tt>http</tt> | ||
+ | ## <tt>Program name</tt>: <tt>WR/WR</tt> | ||
+ | ## <tt>Use Proxy</tt>: <tt>Yes/No</tt> (Depends on your internet access configuration; if a proxy is needed, see for {{File-DL|Administration Manual OpenStage OpenScape Voice|pdf}}, chapter 3.12.1.2 for instructions) | ||
+ | # When the configuration data is correct and complete, click on <tt>Submit</tt>. Now you can [[#Testing_the_XML_Application|test]] the Application. | ||
+ | |||
=== Setup Using the Local Phone Menu === | === Setup Using the Local Phone Menu === | ||
− | # Press the menu | + | # Press the menu key [[Image:XML_apps-operakey_menu_wp3.jpg]] repeatedly until the <code>Settings</code> tab is active (the key toggles between the <code>Settings</code> menu, the <code>Applications</code> menu, and the applications currently running).<br>The key is located in the mode keys area: [[Image:Navkeys-menu.gif|250px|none]]<br> |
− | # With the [[TouchGuide]], navigate to the Admin menu and press | + | # With the [[TouchGuide]], navigate to the Admin menu and press <code>OK</code>. [[Image:XML_apps-screenshot-admin.png|250px|none]]<br> |
# You are prompted to enter the administrator password. <br>If the password is numeric, just type it using the number keys. On typing the first digit, an input text field will open up. <br>For entering non-numeric characters, press the [[Image:osk-rau.gif]] key once or repeatedly, depending on the desired character. The [[Image:osk-rau.gif]] key cycles around the input modes as follows: (Abc) -> (abc) -> (ABC) -> (123) -> back to start. [[Image:XML_apps-screenshot-password.png|250px|none]] To correct an entry, use this key on the [[TouchGuide]]: [[Image:XML_apps-touchguide-back.gif|100px|none]]<br> | # You are prompted to enter the administrator password. <br>If the password is numeric, just type it using the number keys. On typing the first digit, an input text field will open up. <br>For entering non-numeric characters, press the [[Image:osk-rau.gif]] key once or repeatedly, depending on the desired character. The [[Image:osk-rau.gif]] key cycles around the input modes as follows: (Abc) -> (abc) -> (ABC) -> (123) -> back to start. [[Image:XML_apps-screenshot-password.png|250px|none]] To correct an entry, use this key on the [[TouchGuide]]: [[Image:XML_apps-touchguide-back.gif|100px|none]]<br> | ||
− | # On pressing | + | # On pressing <code>OK</code>, the admin menu opens. With the TouchGuide, navigate to the Applications item.[[Image:XML_apps-screenshot-admin-applications.png|250px|none]] To navigate, you can either run your finger around the sensor ring, or press the up/down keys: [[Image:XML_apps-touchguide-up-down.gif|100px|none]]<br> |
− | # Press | + | # Press <code>OK</code> to open the Applications item and select <code>XML</code>. On pressing <code>OK</code> again, <code>Add application</code> appears in the context menu.[[Image:XML_apps-screenshot-admin-add_application.png|250px|none]] Press <code>OK</code> to open the XML application menu. |
− | # In the application menu, enter the data required to access the example application. For each parameter that must be entered, proceed as follows:<br>Navigate to the item to be configured and press OK. Use the keypad to enter data. To toggle between character and number modes, press the [[Image:osk-rau.gif]] key, as in step 3. To select special characters, press the [[Image:osk-ast.gif]] key. To enter a character, select it first by pressing the accordant keypad key as often as necessary. After a short time, the character is accepted in the parameter field. Thus the input procedure is similar to mobile phones. The screenshot shows the data entry in operation:[[Image:XML_apps-screenshot-dispkeypad.png|250px|none]](For more information about data entry, see the {{File-DL|User Manual OpenStage 60-80 SIP|pdf}})<br>The following settings are required to set up the application: | + | # In the application menu, enter the data required to access the example application. For each parameter that must be entered, proceed as follows:<br>Navigate to the item to be configured and press <code>OK</code>. Use the keypad to enter data. To toggle between character and number modes, press the [[Image:osk-rau.gif]] key, as in step 3. To select special characters, press the [[Image:osk-ast.gif]] key. To enter a character, select it first by pressing the accordant keypad key as often as necessary. After a short time, the character is accepted in the parameter field. Thus the input procedure is similar to mobile phones. The screenshot shows the data entry in operation:[[Image:XML_apps-screenshot-dispkeypad.png|250px|none]](For more information about data entry, see the {{File-DL|User Manual OpenStage 60-80 SIP|pdf}})<br>The following settings are required to set up the application: |
− | ## | + | ## <code>Display name</code>: <code>Weather</code> |
− | ## | + | ## <code>Application name</code>: <code>Weather</code> |
− | ## | + | ## <code>Server address</code>: <code>87.106.21.36</code> |
− | ## | + | ## <code>Server port</code>: <code>8080</code> |
− | ## | + | ## <code>Protocol</code>: <code>http</code> |
− | ## | + | ## <code>Program name</code>: <code>WR/WR</code> |
− | ## | + | ## <code>Use Proxy</code>: <code>Yes/No</code> (Depends on your internet access configuration; if a proxy is needed, see for {{File-DL|Administration Manual OpenStage OpenScape Voice|pdf}}, chapter 3.12.1.2 for instructions) |
− | + | # When finished, navigate to <code>Save & exit</code> and press <code>OK</code>. [[Image:XML_apps-screenshot-admin-add_weather.png|250px|none]] | |
<!--=== Setup Using the Web Interface ([[WBM]]) ===--> | <!--=== Setup Using the Web Interface ([[WBM]]) ===--> | ||
== Testing the XML Application == | == Testing the XML Application == | ||
− | # Press the menu | + | # Press the menu key [[Image:XML_apps-operakey_menu_wp3.jpg]] once or repeatedly until the <code>Applications</code> tab is active. <code>Weather</code> is available. |
− | # Start | + | # Start <code>Weather</code> by pressing <code>OK</code>. If everything went well, you see the start screen of the application. [[Image:XML_apps-screenshot-weather.png|250px|none]] |
+ | |||
+ | == See Also == | ||
+ | * [[OpenStage XML Applications]] | ||
+ | * {{File-DL|Administration Manual OpenStage OpenScape Voice|pdf}} - Chapter 3.12.1 explains the setup/configuration of XML applications via local phone menu | ||
+ | * {{File-DL|Deployment-Service en|pdf}} - Chapter 7.1.14.4 explains the setup/configuration of XML applications via local phone menu via [[DLS]] |
Latest revision as of 07:24, 28 April 2011
Contents
Scope
Follow this step-by-step instructions to set up an example XML application on your OpenStage 60/80. The application will display a weather forecast for a region of your own choice.
Prerequisites
For setting up and running the example XML application, you need the following:
- An OpenStage 60/80 phone with appropriate SIP firmware (version V1R3.x). (Currently, only the SIP variant supports XML applications.)
- Internet access for the phone, directly or via proxy. Connections to port 8080 over HTTP must be possible.
Set up an XML Application
There are three ways to set up and configure an XML application on an OpenStage phone:
- Local Phone Menu: The graphical user interface provided by OpenStage 60/80.
- WBM (Web Based Management): The web interface provided by all OpenStage phones. It allows the user and administrator to configure the phone using a web browser.
- DLS (Deployment Service): A versatile administration tool for IP phones.
Setup Using the Web Interface (WBM)
- Open your web browser 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), for example: https://192.168.1.15. If the browser displays a certificate notification, confirm it.
In the upper right corner of the web page, the phone's call number, IP address, and DNS name are displayed. The left column contains the user menu tree. - Click on the Administrator Pages tab. In the dialog box, enter the admin password:
- The administration main page opens. The left column now 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 right column.
- Navigate to Applications > XML applications > Add application and enter the required data. The following settings are required to set up the application:
- Display name: Weather
- Application name: Weather
- Server address: 87.106.21.36
- Server port: 8080
- Protocol: http
- Program name: WR/WR
- Use Proxy: Yes/No (Depends on your internet access configuration; if a proxy is needed, see for
Administration Manual OpenStage OpenScape Voice, chapter 3.12.1.2 for instructions)
- When the configuration data is correct and complete, click on Submit. Now you can test the Application.
Setup Using the Local Phone Menu
- Press the menu key
repeatedly until the
Settings
tab is active (the key toggles between theSettings
menu, theApplications
menu, and the applications currently running).
The key is located in the mode keys area: - With the TouchGuide, navigate to the Admin menu and press
OK
. - 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 thekey once or repeatedly, depending on the desired character. The
key cycles around the input modes as follows: (Abc) -> (abc) -> (ABC) -> (123) -> back to start. To correct an entry, use this key on the TouchGuide:
- On pressing
OK
, the admin menu opens. With the TouchGuide, navigate to the Applications item. To navigate, you can either run your finger around the sensor ring, or press the up/down keys: - Press
OK
to open the Applications item and selectXML
. On pressingOK
again,Add application
appears in the context menu. PressOK
to open the XML application menu. - In the application menu, enter the data required to access the example application. For each parameter that must be entered, proceed as follows:
Navigate to the item to be configured and pressOK
. Use the keypad to enter data. To toggle between character and number modes, press thekey, as in step 3. To select special characters, press the
key. To enter a character, select it first by pressing the accordant keypad key as often as necessary. After a short time, the character is accepted in the parameter field. Thus the input procedure is similar to mobile phones. The screenshot shows the data entry in operation:(For more information about data entry, see the
User Manual OpenStage 60-80 SIP)
The following settings are required to set up the application:-
Display name
:Weather
-
Application name
:Weather
-
Server address
:87.106.21.36
-
Server port
:8080
-
Protocol
:http
-
Program name
:WR/WR
-
Use Proxy
:Yes/No
(Depends on your internet access configuration; if a proxy is needed, see forAdministration Manual OpenStage OpenScape Voice, chapter 3.12.1.2 for instructions)
-
- When finished, navigate to
Save & exit
and pressOK
.
Testing the XML Application
- Press the menu key
once or repeatedly until the
Applications
tab is active.Weather
is available. - Start
Weather
by pressingOK
. If everything went well, you see the start screen of the application.
See Also
- OpenStage XML Applications
-
Administration Manual OpenStage OpenScape Voice - Chapter 3.12.1 explains the setup/configuration of XML applications via local phone menu
-
Deployment-Service en - Chapter 7.1.14.4 explains the setup/configuration of XML applications via local phone menu via DLS