Release Notes for Openwave SDK 6.2.2 WAP Simulator Plug-in

Installing the WAP Simulator Plug-in
Using the SDK
Using the Command-Line Arguments
Arguments and Parameters
Known Problems

The Openwave^TM SDK 6.2.2 WAP simulator plug-in is a package that includes the WAP version of the Openwave phone simulator including the Mobile Messaging client, release notes for the WAP version of the simulator, and supporting files. You must install Openwave SDK 6.2.2 before you can install the WAP simulator plug-in. These release notes describe how to install the Openwave SDK 6.2.2 WAP simulator plug-in and how to use the WAP version of the Openwave phone simulator. For more information about the Openwave SDK 6.2.2, including what's new in this release, see the Openwave SDK 6.2.2 Release Notes.

Installing the WAP Simulator Plug-in

Once you have downloaded and installed the Openwave SDK 6.2.2, as described in its Release Notes, you can install the WAP simulator plug-in.

To install the Openwave SDK 6.2.2 WAP simulator plug-in, download its InstallShield package from the Openwave Developer Program web site and install it in the same directory as you installed the Openwave SDK 6.2.2 package.

Using the SDK

Important: These release notes describe how to use the WAP version of the Openwave phone simulator. If you're using the HTTP version of the Openwave phone simulator, be sure to read the release notes for the HTTP version of the simulator: The file names, arguments, and parameters supported by the HTTP version are different than those supported by the WAP version. However, do read the HTTP release notes for information about new features and known problems with this release of the SDK.

When you install the Openwave SDK 6.2.2 WAP simulator plug-in, the installer creates an Openwave SDK 6.2.2 WAP menu item in the Start > Programs > Openwave SDK 6.2.2 menu. You can choose this menu item to start the SDK in its default configuration. This menu item is in fact a link to a batch file:

C:\Program Files\Openwave\SDK 6.2.2\program\OSDK62wap.bat

In release 6.1 and 6.2 of the SDK, you edited this batch file (or created another script) to configure the SDK. In 6.2.2, you configure the SDK with the graphical user interface available when you choose the SDK's Tools > Options command (the command-line options for configuring the SDK remain supported, for compatibility with any existing batch files or scripts you've created).

You can also control the SDK from another application, such as a third-party integrated development environment (IDE), using the Windows Command Processor. The commands and their arguments you use are described in the following sections of these release notes. Information on integrating the Openwave SDK with popular IDEs is available from the Openwave Developer Support web site.

When you install the Openwave SDK 6.2 WAP simulator plug-in with the default installation options, the WAP version of the Openwave phone simulator is installed in:

C:\Program Files\Openwave\SDK 6.2.2\program\wap\OSDK62wap.exe

When you start the SDK, the Openwave SDK 6.2.2 window opens, with a simulation of a mobile phone featuring keys you can click and a display for content, useful menu commands, and so on.

The simulator's View menu includes commands that display additional information in the Phone Information window. You can use the General tab of the window that opens when you choose the SDK's Tools > Options command to set whether the Phone Info window opens when you start the SDK, and how many lines of information it retains.

The Phone Information window displays a wide variety of information about the commands you execute and their results, including debugging information. The information displayed in the Phone Info window is also written to a log file, named sim.log, which is stored in the same directory as the SDK application file. Each time you start the SDK, a new sim.log file is created, and the log file from the last session is renamed sim.bck.

Note:The WAP simulator plug-in does not allow you to edit the User Agent string or to work with the Network Information window, features that are available with the HTTP version of the simulator.

Using the Command-Line Arguments

Keep the following in mind as you use the command-line tools to control the SDK.

When using these command-line tools in the Command Prompt window, you must first change to the same directory as the OSDK62wap.exe file (C:\Program Files\Openwave\SDK 6.2\program\wap\ by default) or include its absolute path name.
If you pass an invalid argument to OSDK62wap.exe, the argument is ignored and an error message appears in the Phone Info window.
When the SDK is running, you can only use one argument at a time.
If you open a modal dialog box in the SDK UI, such as the Open Configuration File dialog box, you can't control the SDK from the command line until you close the dialog box.
The SDK supports only HTTP-style slashes ( / ) in URLs or arguments for web sites and local files. The SDK does not support Windows-style slashes ( \ ).
For convenience, the SDK makes it possible for you to browse files on your local file system, by entering a path that starts with file:// in the SDK's Go field, or with such arguments as -reload and -go. However, you should not rely on this method to test your wireless applications, for a number of reasons, most notably:
- The SDK does not correctly cache information about the files you load using file://
- The SDK ignores any gateway or proxy you specify with the -g argument and loads files directly from your file system -- without any of the modifications that typical gateways make
To more accurately test your applications, host them on a web server and load them using the http:// prefix instead.
When using -go or another command-line argument to open a URL that includes the & character, you need to enclose the URL in quotation marks.

When using the command-line arguments to start the SDK:

When using these tools in batch files or scripts, use them as arguments to the Windows start command when starting the SDK: Otherwise your batch file or script will be blocked until you exit the SDK.
When starting the SDK, you can concatenate arguments. For example:
OSDK62wap.exe -g devgate2.openwave.com -anon -OPWV-SDK-62.pho -sethome http://developer.openwave.com/dhome5.cgi
However, not all combinations (particularly nonsensical combinations) have been tested.

Arguments and Parameters

The following run-time arguments to OSDK62wap.exe are supported by the SDK.

Argument	`-help`
Description	Displays a summary of SDK command-line arguments in the SDK's Phone Information window.
Example	`OSDK62wap.exe -help`

Argument	`-showphoneinfo`
Description	Opens the Phone Information window.
Example	`OSDK62http.exe -showphoneinfo`
Notes	This argument replaces the `-noconsole` argument from previous SDKs.

Argument	`-exit`
Description	Causes the SDK to exit.
Example	`OSDK62wap.exe -exit`
Notes	Equivalent to choosing the SDK's File > Exit command.

Argument	`<URL>`
Description	If the first string after the SDK executable does not start with a dash ( - ), the SDK tries to load that string as a URL, as if it were parameter of the `-reload` argument.
Example	`OSDK62wap.exe file://c:/mydecks/index.html` `OSDK62wap.exe http://developer.openwave.com/dhome5.cgi`

Argument	`-reload [<URL>]`
Description	When used without the optional URL, reloads the current URL in the SDK's simulator window. When used with a URL, marks that URL as invalid in the SDK's cache and then opens the specified URL.
Example	`OSDK62wap.exe -reload` `OSDK62wap.exe -reload file://c:/mydecks/index.html`
Notes	When used without a URL, equivalent to the SDK's Edit > Reload menu command (F9).

Argument	`-go <URL>`
Description	Opens the URL in the SDK's simulator window.
Example	`OSDK62wap.exe -go http://developer.openwave.com/dhome5.cgi OSDK62wap.exe -go developer.openwave.com/dhome5.cgi OSDK62wap.exe -go file://c:/myapplications/demo/index.html`
Notes	Equivalent to entering a URL or path in the SDK's Go field. For URLs, you can omit `http://`. For files, you must include `file://`. You can enter an absolute path name or a path name relative to the location of `OSDK62wap.exe`.

Argument	`-gohome`
Description	Opens the current home deck in the SDK's simulator window.
Example	`OSDK62wap.exe -gohome`
Notes	Equivalent to entering `device:home` in the SDK's Go field.

Argument	`-sethome <URL>`
Description	Sets the SDK's home deck.
Example	`OSDK62wap.exe -sethome http://developer.openwave.com/dhome5.cgi OSDK62wap.exe -sethome developer.openwave.com/dhome5.cgi OSDK62wap.exe -sethome file://c:/myapplications/demo/index.html`
Notes	For URLs, you can omit `http://`. For files, you must include `file://`. You can enter an absolute path name or a path name relative to the location of `OSDK62wap.exe`. This argument only sets the home deck, it does not instruct the SDK to open it as well.

Argument	`-pho <.pho file>`
Description	Changes the phone configuration file used by the SDK's simulator.
Example	`OSDK62wap.exe -pho OPWV-SDK-62.pho`
Notes	Equivalent to using the SDK's File > Open Configuration command to choose a phone configuration file. You can enter an absolute path for the phone configuration file. Or if the `.pho` file is in the `C:\Program Files\Openwave\SDK 6.2\program\devices` directory, you can just enter its file name.

Argument	`-clearcache`
Description	Clears the SDK's cache and then opens the home deck.
Example	`OSDK62wap.exe -clearcache`
Notes	Equivalent to using the SDK's Edit > Clear Cache command (F12).

The following command-line arguments for configuring the SDK have been replaced with the graphical user interface available when you choose the SDK's Tools > Options command, as described in the "What's New" section of see the Openwave SDK 6.2.2 Release Notes. These commands remain supported by the SDK to maintain compatibility with any existing scripts or batch files you created for earlier releases of the SDK.

Argument	`-g <gateway>`
Description	Specifies the gateway or other proxy the SDK uses to connect to web servers hosting wireless applications.
Example	`OSDK62wap.exe -g proxy.mydomain.com -clearcache`
Notes	You can only specify a gateway or other proxy that can accept a WAP connection, such as an Openwave Mobile Access Gateway (MAG). This argument is ignored if the SDK is already running. You can specify a host name or IP address, but in either case it must be for a host that your computer's DNS server can resolve. Important: When changing gateways with the `-g` argument, always use the `-clearcache` argument at the same time.

Argument	`-pg <port>`
Description	Specifies the WAP gateway port the SDK uses to make remote TCP/IP network requests.
Example	`OSDK62wap.exe -g proxy.mydomain.com -pg 9203 -secure -clearcache`
Notes	The port is secure or nonsecure depending on whether you use the `-secure` or `-nonsecure` argument when you start the SDK. The default secure port is 9203; the default nonsecure port is 9201. Only use the `-pg` argument to change the port if the WAP gateway is configured to use nonstandard ports. Otherwise, the SDK will not be able to connect to the gateway. This argument is ignored if the SDK is already running.

Argument	`-p <local port>`
Description	The port on your computer that the MAG or other gateway uses to communicate with the SDK. The default is port 8502.
Example	`OSDK62wap.exe -g proxy.mydomain.com -clearcache -p 1234`
Notes	This argument is ignored if the SDK is already running.

Argument	`-anon`
Description	Directs the SDK to connect to the gateway in anonymous mode.
Example	`OSDK62wap.exe -g proxy.mydomain.com -clearcache -anon`
Notes	This argument is ignored if the SDK is already running.

Argument	`-secure`
Description	Directs the SDK to connect to the gateway in provisioned, secure mode.
Example	`OSDK62wap.exe -g proxy.mydomain.com -clearcache -secure`
Notes	This argument is ignored if the SDK is already running.

Argument	`-nonsecure`
Description	Directs the SDK to connect to the gateway in provisioned, nonsecure mode.
Example	`OSDK62wap.exe -g proxy.mydomain.com -clearcache -nonsecure`
Notes	This argument is ignored if the SDK is already running.

Argument	`-clientid <hex string>`
Description	The ID of the subscriber provisioned on the gateway.
Example	`OSDK62wap.exe -g proxy.mydomain.com -clearcache -secure -clientid 0202010101040007050505010201020000`
Notes	This is the client ID in hexadecimal format, obtained when an administrator provisions a subscriber. The ID is available in the MAG administrative UI, except that you need to eliminate the first four digits from the ID displayed in the MAG administrative UI. This argument is ignored if the SDK is already running.

Argument	`-charset <charsetcode>`
Description	Overrides the character set portion of the language settings you establish with the `-lang` argument or the graphical UI, setting the character set advertised in the simulator. The character set code can be any of those listed in the Character Set pop-up menu in the window that opens when you choose the SDK's Tools > Options command, click the Device tab, and press the Language button.
Example	`OSDK62http.exe -charset utf-8`
Notes	Unlike previous versions of the SDK, this argument does not need to follow a correct use of the `-lang` argument and can be used when the SDK is already running.

Argument	`-lang <language code>`
Description	Specifies the language and character set (or "script") that the SDK tells content servers it prefers to receive, for servers that can deliver content in more than one language or character set. The SDK's browser declares these preferences in HTTP accept headers, which it sends to content servers when it connects to them.
Example	`OSDK62wap.exe -lang zh-hk`
Notes	The SDK only accepts the `-lang` argument parameters from the following table. Unlike previous versions of the SDK, the `-lang` argument does not set the font used to display content in the simulator. The text in the SDK simulator's UI (softkeys, menus, the status bar, error messages, and so on) are presented in English, regardless of the language you specify. Only `zh-cn` and `zh-hk` add the country portion of the code to the HTTP header.

`-lang` parameter	Language	Charset	Script
`ar-sa`	Arabic	iso-8859-6	Arabic
`zh-cn`	Chinese (Simplified)	gb-2312	Chinese_GB2312
`zh-hk`	Chinese (Traditional)	big5	Chinese_BIG5
`cs-cz`	Czech	iso-8859-2	Latin2
`da-dk`	Danish	iso-8859-1	Western
`nl-nl`	Dutch	iso-8859-1	Western
`en`	English	iso-8859-1	Western
`fi-fi`	Finnish	iso-8859-1	Western
`fr-fr`	French	iso-8859-1	Western
`de-de`	German	iso-8859-1	Western
`el-gr`	Greek	iso-8859-7	Greek
`iw-il`	Hebrew	iso-8859-8	Hebrew
`hu-hu`	Hungarian	iso-8859-2	Latin2
`it-it`	Italian	iso-8859-1	Western
`ja-jp`	Japanese	Shift-JIS	Japanese
`ko-kr`	Korean	ks_c_5601	Hangul
`no-no`	Norwegian	iso-8859-1	Western
`pl-pl`	Polish	iso-8859-2	Latin2
`pt-pt`	Portuguese	iso-8859-1	Western
`ru-ru`	Russian	windows-1251	Cyrillic
`es-sp`	Spanish	iso-8859-1	Western
`sv-se`	Swedish	iso-8859-1	Western
`tr-tr`	Turkish	iso-8859-9	Latin5

Known Problems

See the Openwave SDK 6.2.2 Release Notes for a list of known problems in this release of the Openwave SDK.

Legal Notice

Openwave, the Openwave logo, and Services OS are registered trademarks and/or trademarks of Openwave Systems Inc. in various jurisdictions. All other trademarks are the property of their respective owners.

This Software shall not be shipped, transferred, exported or re-exported into any country or used in any manner prohibited by the United States Export Administration Act or any other export laws, restrictions or regulations (collectively the "Export Laws"). In addition, if this Software is identified as an export controlled item under the Export Laws, you represent and warrant that you are not located within an embargoed nation (including without limitation Cuba, Iran, Iraq, Libya, North Korea, Sudan and Syria) and that you are not otherwise prohibited under the Export Laws from receiving the Software. All rights to use the Software are granted on condition that such rights are forfeited if you fail to comply with the terms of this Agreement. Export or re-export of this software to the embargoed countries, and any other countries that the Bureau of Export Administration may subsequently add to the list of embargoed countries, is forbidden. In addition, this Software may not be sold as part of any product developed for or used exclusively by government agencies.

SDRN-622W-006
June 2003