Jargon Reader^TM
Installation Instructions

After developing an application in Jargon Writer, you have several alternatives when deploying it.

• Jargon ReaderX is the ideal deployment product for use with clients running the Windows 95, 98, ME, XP, NT, 2000 and 2003 operating systems. However, because of the ActiveX-based architecture used in Jargon ReaderX, it cannot be used on Unix workstations and other non-Windows clients.

• For non-Windows clients, the Java-based Jargon Reader deployment product can be used, since it is designed to run on any client system that has a Java JRE 1.2 runtime engine. For sample Jargon Reader deployment scenarios, see Deployment Models for Jargon Writer™ Applications.

1. Installation procedures when running your app as a Java applet.

The following items must be installed on your host server(s). See the appropriate "Host Software Installation Instructions" for further details.

• The appropriate middleware and database software for your host environment
• A web server such as IIS or PWS for Windows NT/2000 systems, or apache for Unix systems
• Domain Name Service (DNS) for Unix systems
• The Jargon Software "jsi" host procedures
• The host procedures for your application
• The Jargon Reader "lib/jsi.jar", "system/*.xml" and "system/*.dtd" files
• Web page(s) that will start Jargon Reader as an applet and run your client procedures
• The xml procedures and image files for your application

When a client software "app" is being run as a Java applet, the only required client software is a Web browser that can run applets written for Java 1.2.

If the browser version being used does not have this capability, the Java Plug-in from Sun Microsystems must be installed. This plug-in contains a JRE (Java Runtime Environment) that supports the required Java version. When installed, this plug-in will be used to run applets instead of the built-in JRE in the Netscape Navigator and Microsoft Internet Explorer browsers. The Java 1.2 Plugin is included with the JRE 1.2 install file. It can also be downloaded from: http://java.sun.com/products/jdk/1.2/jre/download-windows.html

The Jargon Reader software and the application procedures ("xml" files) will be downloaded to the browser from the Web server on your intranet or on the Internet.

No other client installation steps are required. The applet will be started by clicking on a link in an HTML Web page designed for this purpose. If you are using Sun's Java Plug-in, consult their documentation to learn how to convert HTML pages to utilize the plugin (docs are on the same Web site listed above).

Optionally, you may tune the Java runtime environment on the client for better performance by doing the following steps:

1. Close all running Java programs.
2. Close all web browsers.
3. Go into the "Java Plugin Control Panel" (on the Windows start menu under "Programs").
4. In the "Java Runtime parameters" textbox type: "-ms8 -mx32" (without the quotes).
5. Press the "Apply" button.
6. Start your web browser and click the link to run the application.

Note that "-ms8"  will give the plugin 8MB of memory at startup and "-mx32" will allow the JVM to allocate up to a maximum of 32MB of memory if needed.

The following items must be installed on your host server(s). See the appropriate "Host Software Installation Instructions" for further details.

• The appropriate middleware and database software for your host environment
• Domain Name Service (DNS) for Unix systems
• The Jargon Software "jsi" host procedures
• The host procedures for your application

When a client software "app" is being run as a Java application, the required client software includes the following list of items. If the self installing CD from Jargon Software is used, these items will be installed automatically when you run the install program and respond to questions as prompted.

Otherwise, if you are installing Jargon Reader "by hand", use this checklist to install client software.

NOTE: the client software can be installed on a network drive (like G:), in which case the only software residing on the physical client system will be the shortcut or menu item to access the network directory.

• Install the latest Java Runtime Environment (JRE) on the client system. See the Java Installation instructions.
• Create a working directory for Jargon Reader. Example: "C:\Jargonsoft" on a Win9x PC.
• Unzip the "reader.zip" file from the CD into this working directory.
• Install your license file in the "system" subdirectory, replacing the evaluation license file.
• Make a copy of "system\preferences.ini" for your application and modify its startup parameters according to the notes found in it. For example, copy "system\preferences.ini" to "system\mysports.ini" and modify its parameters as needed to run the sports demo on your local host instead of the jargonsoft.com host.
• Create a shortcut or a choice off the "Start" menu on the client desktop.
• Set the properties of the shortcut or menu choice to specify the correct startup options. If a path contains embedded blanks (like "Program Files"), note that the entire path string must be enclosed in double quotes.
• The syntax of the startup command for an app installed on the client system is:

<jre_path>\javaw.exe -ms8m -classpath <classpath> Main [<iniFile> [<appFile>] ]

Notes:

• If the "appFile" is specified, the "ini file name" must also be specified.
• If the "appFile" is not specified, the appfile parameter in the "ini" file is used, if defined.
• If no "appFile" value is specified by either method, a control panel window will open from which you can open and run any local xml procedure.
• If the "iniFile" is not specified, a default of "system/preferences.ini" is used.

Example (all goes on one line):
C:\jre122\bin\javaw.exe -ms8m
-classpath C:\jre122\lib\rt.jar;.\lib\reader.jar;.\lib\aelfred.jar;.\lib\o4glrt.zip Main system/sports.ini

After the above items have been automatically or manually installed, next install the "xml" files for your app in the "xml" subdirectory of the Jargon Reader working directory or in the server download directory (such as "C:\inetpub\wwwroot\xml").

Also install any images used by your app in the "images" subdirectory of the Jargon Reader working directory or in the server download directory (such as "C:\inetpub\wwwroot\images").

Note that both xml and image files may be in subdirectories of their respective "root" directories. For example, an image file defined within an app as "demo/sports/next.gif" would be installed as "<reader working directory>\images\demo\sports\next.gif".

Notes for startup command:

• The entire startup command must be entered on one line, with spaces between parameters. The example above may be displayed on multiple lines only because it is too long to fit on one browser line or printed line.

 
• There are no spaces within the classpath; pathnames are separated by semicolons.

 
• The classpath includes four files: rt.jar, reader.jar, aelfred.jar and o4glrt.zip. Only "rt.jar" is in the Java jre directory, while the others are in the lib subdirectory of the Jargon Reader working directory.

 
• The -ms8m specifies an initial memory stack of 8 MB. This can be changed if needed (ex: -ms12m to begin with a 12 MB stack space). Larger values make  "garbage collection" occur less often, but it will take longer to execute when it does occur (resulting in a more noticeable pause).

 
• If the shortcut or menu choice does not work, the most likely problem is an incorrect pathname or an incorrectly formed classpath. Should this happen, double-check the pathname entries in the classpath and make sure that they are separated by semicolons without any spaces. Verify that the correct "jar" files exist in these directories. Also double-check the pathname and directory contents for the "javaw.exe" program.

 
• The "ini" file name must be the complete relative or absolute pathname of the "ini" file.

Notes for "ini" file values:

• Choices for Look & Feel are: windows, metal, motif. If this parameter is not specified, the  look and feel will be the default for the client platform (e.g. "windows" for Win95/98/NT systems). Also note that "windows" is the recommended choice as the Java implementations of the other two Look & Feel choices have more bugs than the windows implementation.

 
• There is NO slash at the end of the URL address.

 
• There are NO slashes at the start or end of the CGI, ISAPI or NSAPI script name.

If you have questions or problems not covered by this document, see the additional assistance section in the installation instructions index.