Views

optiPoint application module How to configure JAVA

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.

Revision as of 11:27, 26 September 2006 by Teamone.dtp (talk | contribs) (Requirements)
Jump to: navigation, search
Construction.png This article or section is currently under construction. In order to avoid editing conflicts, please wait until this message is removed or contact the author (--Horst.reinelt 16:57, 25 September 2006 (CEST)).

Overview

This document contains practical information on how to configure the Java platform on an optiPoint application module (via the "Programs" application).

Scope of document

This document describes how to configure your optiPoint telephone so you can install existing Java platform applications and use additional MIDlet applications on your optiPoint application module.

The following topics are not dealt with in this document:

  • Operating Java platform applications on an optiPoint application module
  • Programming Java MIDlets
  • Configuring further applications on an optiPoint application module

For further information on these topics, refer to the relevant documents listed in section 6, “References”.

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.

The trademarks used are the property of Siemens AG or their respective owners.

Java platform and Java file types

Java is an object-oriented programming language. It is not dependent on a specific operating system but does require a special runtime environment. The optiPoint application module features a suitable environment (referred to in the following as the Java platform). This technology (J2ME) is also provided on the latest mobile telephones. Therefore you can also run many of the Java MIDlets available on the Internet, for example, on your optiPoint application module.

In contrast to Java Applets, the archive file in Java MIDlets only contains the programming classes that are actually used for the specific application.

Each Java MIDlet includes a *.jad description file and a *.jar archive file.

You must always load the *.jad description file to install a Java MIDlet in the optiPoint application module. The *.jar file is installed automatically with the MIDlet.

For further information on .jad and .jar files, see section 2.3, “Contents of .jad and .jar Files”.

Benefits of a Java platform on an optiPoint application module

The most important benefits are:

  • Flexibility:

A Java platform enables you to use additional, customized functions on your optiPoint application module without having to modify the telephone software. You can simply remove applications you no longer need.

  • Variety:

You can add extra telephone functions (for example, the speed-dialing list in the preinstalled MIDlet), or use general functions such as a calculator.

  • Support for standard tools:

You can use the familiar, standardized Java programming tools to create your own applications or have them programmed to meet your specifications.

Requirements

The following requirements must be met before you start configuration:

  • The optiPoint application module must be connected to one of the following optiPoint telephones and operational:
  • optiPoint 410 advance (HFA)
  • optiPoint 420 standard (HFA)
  • optiPoint 420 advance (HFA)
You can also run the optiPoint application module on optiPoint 500 telephones, but these do not support the Java function.
  • To optimize browser-based administration:
  • You should know the IP address of the optiPoint telephone with the optiPoint application module you wish to configure.
  • You should have a PC with a Web browser that can access your optiPoint telephone (and the attached optiPoint application module) via LAN. You can also connect a PC (a laptop, for example) directly to one of the telephones listed above using a LAN cable (bw nw.png socket on the underside of the telephone).

See section 6, “References” to find out where you can obtain any additional information you need.

Configuration overview

The following table provides an overview of the sections in this document that describe how to administer the Java platform via a Web browser (WEB) and via the optiPoint application module (APM). At a glance, you can see which configuration options are available for each task.

Configuration task WEB APM
Change FTP server address Section 2.1 Section 2.2
Change FTP account name Section 2.1 Section 2.2
Change FTP user name Section 2.1 Section 2.2
Change FTP password Section 2.1 Section 2.2
Change FTP Java MIDlet file name Section 2.1 Section 2.2
Change FTP Java MIDlet directory name - Section 2.2
Load Java MIDlet by FTP Section 2.1 Section 2.2
Display Java MIDlet description file - Section 2.3
Delete Java MIDlet -1 Section 4
Delete all Java MIDlets -1 Section 4
Change Java HTTP gateway address Section 2.1.1 -
Change Java HTTP user name Section 2.1.1 Section 2.2.1
Change Java HTTP password Section 2.1.1 Section 2.2.1
Change FTP server address Section 2.1
1 Only possible after reset to factory default.

There are also other methods for administering the optiPoint application module such as the Deployment Tool or the Deployment Service. For further information on these, see section 6, “References”.

Installing Java MIDlets

The following section describes how to install an existing Java MIDlet (see section 2.3, “Creating Your Own Java MIDlets”) on an optiPoint application module.

A MIDlet can be installed using a Web browser or directly on the optiPoint application module. Installation via a Web browser is the more user-friendly and, therefore, recommended method.

You can also enter an HTTP proxy server. However, this is only necessary if:

  • You want to install Java MIDlets that use HTTP functions (a Web browser such as Java MIDlet, for example).
  • Direct access is not possible, for example, due to a firewall.

If this is the case, enter the proxy server via your Web browser or directly on the optiPoint application module, see section 2, “Configuring an HTTP proxy via Web browser” or section 2, “Configuring an HTTP proxy on an optiPoint application module”.

Java MIDlets can only be deleted directly on the optiPoint application module, see section 4, “Deleting Java MIDlets”.

For further information on starting and operating Java MIDlets, refer to the user manual, see section 6, “References”.

Check the requirements listed in section 1.4, “Requirements”.

A default MIDlet is preinstalled and delivered with the optiPoint application module. This MIDlet is overwritten by the installation procedure described here.

Installation via Web browser

Java MIDlets can be installed by administrators and users. The following describes the procedure for administrators (that is, in the administration area of your Web browser).

  1. Open a Web browser and enter the IP address of the optiPoint telephone on which you want to install the Java MIDlet:
    http://[IP-Adresse]:8085
    The telephone homepage is displayed.
  2. Click Administration.
    The browser prompts you to enter the administration password.
  3. Enter your password (default: 123456) and confirm by selecting Login.
    The administration menu is displayed.
  4. Select File transfer from the menu.
    An input form is displayed.
  5. TEnter the following parameters in the form or check that the existing entries are correct:
    • FTP server address: IP address of the FTP server.
    • FTP account name: account name for FTP server access.
    • FTP username: user name for FTP server access.
    • Only enter a password in both FTP password fields if the password has changed. The password is not displayed when entered in these fields.
    • Java midlet filename: Java MIDlet filename with the suffix .jad, for example, Speed-DialApplet.jad.
    Check that the .jar file specified under MIDlet-Jar-URL in the .jad file is present (these #: two files generally have the same name).
    • FTP path: file path starting at the directory entered as the FTP root on the FTP server.
    The default entry is a dot (.), which means that a path has not been entered.
  6. Select Download Java midlet from Action on submit.
  7. Click Submit.
The installation takes a few seconds. If it is successful, the browser returns to the administration menu. If it is not successful, you will see an error message.

Configuring an HTTP proxy via Web browser

  1. Open a Web browser and enter the IP address of the optiPoint telephone on which you want to install the Java MIDlet:
    http://[IP-Adresse]:8085
    The telephone homepage is displayed.
  2. Click Administration.
    You are prompted to enter the administration password.
  3. Enter the password (default: 123456) and confirm your entry with Login.
    The administration menu is displayed.
  4. In the menu select Java under Applications.
    An input form is displayed.
  5. Enter the following parameters in the form:
    • HTTP gateway/proxy address:: IP address of the HTTP proxy.
    • Port number:: port number of the HTTP proxy (default: 9200).
    • Username: user name for HTTP proxy access.
    • Only enter a password in the two password fields if the password has changed. The password is not displayed when entered in these fields.
  6. Click Submit.
You have now entered all data required for communication with the HTTP proxy on your telephone.

Installation on an optiPoint application module

  1. Click the system button home.png icon on the optiPoint application module display. The Applications overview is displayed.
  2. Click the Programs icon symb programs.png. Any existing MIDlets are displayed in a list.
  3. Click the appl button contextmenu.png icon to open the context menu and select Add MIDlet. An input form is displayed.
  4. Enter the following parameters in the form or check that the existing entries are correct:
    • Server: IP address of the FTP server.
    • User: user name for FTP server access.
    • Only enter an FTP password in the password field if the password has changed. When you have entered the password, it is masked by asterisks (*).
    • Account: account name for FTP server access.
  5. Click Next. The second part of the input form is displayed.
    • File: Java MIDlet file name with the suffix ".jad", for example, SpeedDialApplet.jad. Check that the .jar file specified under MIDlet-Jar-URL in the .jad file is present (these two files generally have the same name).
    • Directory: file path starting at the directory entered as the FTP root on the FTP server. The default entry is a dot (.), which means that a path has not been entered.
  6. Click Add MIDlet.

The installation takes a few seconds. If it is successful, the browser returns to the administration menu. If it is not successful, you will see an error message.

Configuring an HTTP proxy on an optiPoint application module

  1. Click the system button home.png icon on the optiPoint application module display. The Applications overview is displayed.
  2. Click the Prog symb programs.png icon . Gibt es bereits Midlets, werden diese in einer Liste angezeigt.
  3. Click the appl button contextmenu.png icon to open the context menu and select Web Settings. An input form is displayed.
  4. Enter the following parameters in the form:
    • User name: user name for HTTP proxy access.
    • Password: password for HTTP proxy access.
  5. Click Save.

You have now entered all data required for communication with the HTTP proxy on your telephone. The installation takes a few seconds. If it is successful, the browser returns to the administration menu. If it is not successful, you will see an error message.

Checking your installation

Once you have installed a MIDlet, you should always check whether it has been loaded correctly and can be started.

  1. Click the system button home.png icon in the optiPoint application module display. The Applications overview is displayed.
  2. Click the Programs symb programs.png icon . The installed MIDlet is displayed in the list of Java MIDlets.
  3. If there is only one MIDlet, the MIDlet you have just installed will be the only entry in the list. If there are several MIDlets, select the MIDlet you have just installed.
  4. Select Details to display information on this MIDlet. This is the same information contained in the .jad file, see section 5.1, “.jad files”.

Creating Your Own Java MIDlets

To create your own Java MIDlet you must be familiar with the Java programming language.

Siemens JAVA SDK is a complete package aimed at supporting you in Java MIDlet development.

The package includes:

  • Sample Java MIDlets such as speed-dialing lists, notes and various games.
  • Documentation for Siemens optipoint410 JDK and the classes used.
  • Sun's Java 2 Micro Edition Wireless Toolkit, including documentation.

Siemens JAVA SDK is available free of charge on the Internet, see section 5.2, “References”.

Deleting Java MIDlets

You can permanently delete unnecessary or incorrect MIDlets. Java MIDlets cannot be deleted via a Web browser.

Once you have deleted a Java MIDlet it cannot be retrieved from the memory. If you want to use a MIDlet again, you must reload it - see section 2, “Installing Java MIDlets”.

  1. Click the system button home.png icon in the optiPoint application module display. The Applications overview is displayed.
  2. Click the Prog icon symb programs.png. Installed MIDlets are displayed in a list.
  3. If there is only one MIDlet, the MIDlet you have just installed will be the only entry in the list. If there are several MIDlets, select the MIDlet you have just installed.
  4. Click the appl button contextmenu.png icon to open the context menu and select Delete Entry to delete the selected MIDlet, or Delete All to delete all installed MIDlets.
    If you select Delete All, the default SpeedDialApplet MIDlet will also be deleted (if previously installed).
  5. Confirm the security prompt by selecting Yes.
The selected MIDlet or all MIDlets are now deleted.

Contents of .jad and .jar Files

.jad files

A .jad file is an ASCII text file that contains information on the associated Java archive. The optiPoint application module evaluates this information when it is loaded. The information can be displayed on the application module.

You can also use a text editor to view this file before it is loaded. To do this, make a copy of the file and change the suffix from *.jad to *.txt. You can now open the file. The following is an example of the file content, taken from the SpeedDialApplet MIDlet:

MIDlet-Version: 1.0
MIDlet-Vendor: kvasg
MIDlet-Jar-URL: SpeedDialApplet.jar
MicroEdition-Configuration: CLDC-1.0
MicroEdition-Profile: MIDP-1.0
MIDlet-1: SpeedDialApplet, , com.siemens.op.applets.SpeedDialApplet
MIDlet-Jar-Size: 18608
MIDlet-Name: SpeedDialApplet

.jar files

A .jar file is an archive file that contains the actual program code and any further resources required for running a MIDlet. The code is divided into classes (*.class) and bundled into one file in binary form together with a description file (manifest.mf).

A Java archive can consist of several individual Java MIDlets. These can be accessed separately once the Java archive has been run on the optiPoint application module.

You can use WinZip, for example, to view the content of this file. To do this, make a copy of the file and change the suffix from *.jar to *.zip. You can now open the file using WinZip. The following is an example of the file content, taken from the SpeedDialApplet MIDlet:

com/siemens/op/applets/DialCanvas$Cell.class
com/siemens/op/applets/DialCanvas$GridLayout.class
com/siemens/op/applets/DialCanvas.class
com/siemens/op/applets/DialData$1.class
com/siemens/op/applets/DialData$EntryFilter.class
com/siemens/op/applets/DialData.class
com/siemens/op/applets/EntryDetails.class
com/siemens/op/applets/EntryEdit.class
com/siemens/op/applets/EntryList.class
com/siemens/op/applets/Showable.class
com/siemens/op/applets/SpeedDialApplet.class
com/siemens/op/applets/layout/Button.class
com/siemens/op/applets/layout/Cell.class
com/siemens/op/applets/layout/Grid.class
com/siemens/op/applets/layout/TitleBar.class
META-INF/MANIFEST.MF

References

The following list contains references and links to documentation and other sources of information. It is not exhaustive.

Documentation

Examples of Java MIDlets

Overview of Java MIDlets available for optiPoint application modules:

URL: http://www.siemens.com/hipath/ > Products, Solutions & Services > Clients & Devices

Configuration notes for IP terminals

Non application-specific information on configuring IP-based optiPoint terminals:

URL: http://www.siemens.com/hipath/ > Products, Solutions & Services > Clients & Devices

LDAP function on the optiPoint application module

Description of the "LDAP" application administrative function on the optiPoint application module.

URL: http://www.siemens.com/hipath/ > Products, Solutions & Services > Clients & Devices

WAP function on the optiPoint application module

Description of the "Browser" application administrative function on the optiPoint application module.

URL: http://www.siemens.com/hipath/ > Products, Solutions & Services > Clients & Devices

optiPoint application module user manual

Description of local and system-based operating procedures, explanation of user interface, etc.

URL: http://www.siemens.com/hipath/ > Downloads > User Guides

Ref. No.: A31003-A2056-M423-*-7619 (Search for „A31003-A2056-M423“)

optiPoint 410/420 family administration manual

Explanation of administrative tasks for startup and configuration.

URL: http://www.siemens.com/hipath/ > Downloads > Administration Guides

Ref. No.: A31003-A2056-B415-*-76A9 (Search for „A31003-A2056-B415“)

Software

Siemens JAVA SDK

Siemens software development toolkit for developing customized Java MIDlets.

URL: http://www.siemens.com/hipath/ > Downloads > Software > Developer Support > optiPoint 410 - JAVA SDK

Java MIDlets

Samples of Java MIDlets for download.

URL: http://www.siemens.com/hipath/ > Downloads > Software