Installing the Enterprise Portal Java Client Applet

This document contains the following sections:

System requirements

A Java applet is a Java program run from a Web browser. Both Netscape Navigator and Microsoft Internet Explorer have a Java Runtime Environment (JRE) for running Java applets. However, EIP client uses recent additions to the Java language that might not be implemented by either Netscape Communicator or Microsoft Internet Explorer. Therefore, a JRE from Sun Microsystems, called Java Plug-in, is required. Java Plug-in provides a consistent JRE across browsers. Once installed, applets requiring Java Plug-in can use current Java features, for example, JDK 1.1.8 and swing. The EIP client applet requires Java Plug-in, the supported versions are 1.1.1, 1.1.2, or 1.1.3. We recommend using Java Plug-in 1.1.3.

Installing the EIP client applet: for administrators using a Web Server to deploy the applet

You can deploy the EIP applet one of two ways:
  1. Download the applet code from the Web server
    Note: Due to the size of the client code jar files and the server connector jar files required to run the client, this method is not recommended.
    or
  2. Install it on each client workstation

For instructions about downloading the applet code from a Web server, see:Deploying the EIP client applet from a Web Server with a browser

Deploying the EIP applet by installing the applet code on each client workstation

This section describes how you, as an administrator, can configure a Web server to allow browsers to execute the applet. After you configure the Web server, your users must install code required by the applet on their workstations.

These instructions assume all files referenced in these instructions are copied into the same Web server directory, and that the files in that directory are available via browsers using http. These instructions refer to that Web server directory as c:\webfiles\EIP, although you can choose any directory from which your Web server exports. The directory \cmbroot is the root directory where EIP is installed.

(An alternative to the following steps is to configure your Web server so that the directory where the EIP appletInstall.html is installed (\cmbroot\doc) is accessible via HTTP. For example, you could set an alias the address //host/eip to c:\cmbroot\doc. If you follow this alternative, ignore any of the following steps about copying files from \cmbroot\doc. Also, substitute \cmbroot\doc for c:\webfiles\eip in these instructions.)

  1. Copy the following files from \cmbroot\doc to c:\webfiles\eip:
    • appletInstall.html
    • basic.gif
    • advanced.gif
    • proxies.gif
    • CCApplet.html
    • ClientHelp.html
  2. Complete one of the following steps:
    1. Request that each user downloads Java Plug-in 1.1.3 from http://java.sun.com. The supported versions are 1.1.1, 1.1.2, or 1.1.3. We recommend using Java Plug-in 1.1.3.
    2. Download the Java Plug-in 1.1.3 for Windows to your Web server's c:\webfiles\EIP directory. Downloading from and intranet site is usually faster than downloading from an external site.

      In the Installing the EIP client applet: for users section of this document, replace:

      <A HREF="http://java.sun.com:80/products/plugin/index.html">Download Java Plug-in 1.1.3</A>
      
      with:
      <A HREF="plugin1_1_3-win.exe">Download Java Plug-in 1.1.3</A>
      
      where plugin1_1_3-win.exe is the downloaded file's name and you placed it in the same directory as appletInstall.html.
  3. Make the EIP product installation available for users accessing EIP using a browser.
    We suggest you create a self-extracting zip file from the EIP installation CD and make that file available on the web server for users to download. You will need to update the instructions for "Installing the EIP client applet: for users" based on how you implement the user install.
  4. Update CCApplet.html
    1. Change the following occurrences of cmbdb to your Enterprise Portal database.
      NAME = server VALUE  ="cmbdb"
      server = "cmbdb"
      
    2. By default, CCApplet.html launches the applet in a separate Java frame. If you prefer the applet to run inside it's own browser window, change yes to no in the following code:
      NAME = JAVA_WINDOW VALUE="yes">
      JAVA_WINDOW="yes"
      
    3. You need the following jar files to run the client application. You will need additional jar files depending on which Content Servers your application will connect to.
      1. cmbodc30.jar
      2. cmbclient30.jar
      3. cmb30.jar
      4. cmbcm30.jar
      5. cmbfedc30.jar
      6. cmbdlc30.jar
      7. cmbjdbcc30.jar

      Update the following archive parameters, adding the jar files required for the content servers your application is connecting to:

       
      NAME = "archive" VALUE=
      "cmbclient30.jar, cmb30.jar, cmbcm30.jar, cmbodc30.jar, cmbfedc30.jar , cmbdlc30.jar, cmbjdbc30.jar" 
      
      java_ARCHIVE="cmbclient30.jar, cmb30.jar,  cmbcm30.jar, cmbodc30.jar, cmbfedc30.jar , cmbdlc30.jar, cmbjdbcc30.jar" 
       
    4. Update the mime2app parameters. The mime2app parameter specifies the cmbmime2app.ini file.
       NAME = "mime2app" VALUE  ="http://ssanders2.stl.ibm.com//cmbmime2app.ini"
       mime2app="http://ssanders2.stl.ibm.com//cmbmime2app.ini"
       
    5. Update the clientUrlString parameters. The clientUrlString parameter specifies the cmbclient.ini file.
        NAME = "clientUrlString" VALUE  ="http://ssanders2.stl.ibm.com//cmbclient.ini"
        clientUrlString="http://ssanders2.stl.ibm.com//cmbclient.ini" 
        

  5. Publish a reference to the applet.
  6. Verify that the following files now exist in c:\webfiles\eip:
  7. Edit c:\webfiles\eip\appletInstall.html to tailor the applet setup instructions to your environment. For example, you may want to remove the installation instructions for the administrator since you completed that installation in the previous steps.

Installing the EIP client applet: for users of the Web Server deployed applet

The applet runs on Windows 95 and Windows NT, and only with either of the following browsers:

In order to run the applet, you must first complete the following steps:

  1. Download Java Plug-in 1.1.3 to a temporary directory. Note the name of the directory for the next step.

    If the download fails, try another browser. If you're still unable to download the file, contact the Web page administrator.

  2. Install Java Plug-in 1.1.3.

    From the taskbar, select Start->Run->Browse to find the downloaded file. Click the file and click OK.

  3. From the taskbar, select Start->Programs->Java Plug-in Control Panel. Specify settings on the three pages as shown.

    Click Apply. Close the the Java Plug-in Control Panel.

  4. Download IBM EIP product to a temporary folder. Note the name of the folder for the next step.

    If the download fails, try another browser. If you're still unable to download the file, contact the Web page administrator.

  5. Unzip the EIP product self-extracting zip file. From the taskbar, click Start->Run->Browse click the file and click OK.

  6. Install the EIP product. From the taskbar, click Start->Run->Browse to locate the setup.exe file extracted from the zip file in the above step, and click OK to start the install.

  7. In the Components window, ensure that only Client is selected. Select the appropriate viewer(s) based on the types of documents you intend to view.

  8. Restart your workstation.

    Ask your administrator for the address from which to launch the IBM EIP applet.

Installing the EIP client applet: for users without a Web Server

This section describes how to run the applet without a Web server.

  1. Install the IBM EIP client component and the necessary viewers.
  2. Update the file ccapplet.html and verify the parameters. The ccapplet.html file is installed in the cmbroot\docs directory. For instructions on updating the ccapplet.html file see: Update CCApplet.html
  3. Open a DOS window
  4. Set the classpath and path for EIP environment.

    The classpath and path environment variables may be set by running the bat file cmbenv.bat.

    If you have installed the toolkit on your workstation, the cmbenv.bat file is installed in the cmbroot install directory. If you have not installed the toolkit on your workstation you will not have the cmbenv.bat file installed and therefor we have included the bat file at the end of this document. See cmbenv.bat
    Edit cmbenv.bat and remove the REM on the line:
    set CLASSPATH=%CLASSPATH%;%JARDIR%\cmbclient30.jar
    Save the changes to cmbenv.bat.

  5. From the DOS window invoke cmbenv.bat.
  6. Invoke your browser from the DOS window.
    Example: c:\Program files\Netscape\Communicator\Program\netscape.exe" -browser
  7. From your browser use the File->Open Page option and load the updated ccapplet.html.

Deploying the EIP Java applet from a Web Server with a browser

This section describes how an administrator would deploy the applet so that the code is downloaded from the Web server by the browser.

  1. Obtain (or generate) a certificate and public/private key pair.
  2. Digitally sign all EIP jar files required for your application with the private key.
  3. Store the signed EIP jar files on Web server.
  4. Update the ccapplet.html file to reference the code on Web server.
  5. Import the certificate and public key into each browser user's Java security file.
step-by-step guide illustrates the above steps.

Note:Users must install the Java Plug-in to run the client application and they must install viewers to view documents. For more information on these topic please reference: "Deploying the EIP applet by installing the applet code on each client workstation".

CMBENV.BAT

@echo off @REM ---------------------------------------------------------------------------------------- @REM @copyright(disclaimer) @REM @REM IBM Enterprise Information Portal for Multiplatforms V6.1 (program number 5648-D03) @REM (c ) Copyright IBM Corp. 1998, 1999. All Rights Reserved. @REM IBM Content Manager for Multiplatforms V6.1 (program number 5648-D04) @REM (c ) Copyright IBM Corp. 1994, 1999. All Rights Reserved. @REM @REM US Government Users Restricted Rights @REM Use, duplication or disclosure restricted by GSA ADP Schedule @REM Contract with IBM Corp. Licensed Materials - Property of IBM @REM @REM DISCLAIMER OF WARRANTIES : @REM @REM Permission is granted to copy and modify this code, and to @REM distribute modified versions provided that both the copyright @REM notice and this permission notice appear in all copies and modified @REM versions. THIS SAMPLE CODE IS LICENSED TO YOU AS-IS. IBM DISCLAIMS @REM ALL WARRANTIES, EITHER EXPRESS OR IMPLIED, IN SUCH SAMPLE CODE. IBM @REM WILL NOT BE LIABLE FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE @REM OF THE CODE. @REM @REM @endCopyright @REM ---------------------------------------------------------------------------------------- @REM ************************************************************************************ @REM * Please modify this file to change the following variables: @REM * JAVAHOME @REM * DB2HOME @REM * CMBROOT @REM * before running it. @REM * @REM ************************************************************************************ if "%CMBROOT%"=="" set CMBROOT=c:\cmbroot if "%DB2HOME%"=="" set DB2HOME=c:\sqllib if "%JAVAHOME%"=="" set JAVAHOME=%CMBROOT%\JDK set IPHOME=%CMBROOT%\IP390 set VI400HOME=%CMBROOT%\VI400 set DDHOME=%CMBROOT%\DD60 set ODHOME=%CMBROOT%\OD set JARDIR=%CMBROOT%\lib set PATH=.;%CMBROOT%\BIN;%JAVAHOME%\bin;%IPHOME%\dll;%VI400HOME%\dll;%DDHOME%\dll;%ODHOME%\dll;%PATH% set CLASSPATH=.;%JARDIR%\cmb30.jar;%JARDIR%\cmbcm30.jar;%JARDIR%\cmbdl30.jar;%JARDIR%\cmbjdbc30.jar;%JARDIR%\cmbip30.jar set CLASSPATH=%CLASSPATH%;%JARDIR%\cmbv430.jar;%JARDIR%\cmbdd30.jar;%JARDIR%\cmbfed30.jar;%JARDIR%\cmbdes30.jar set CLASSPATH=%CLASSPATH%;%JARDIR%\cmbod30.jar;%JARDIR%\swingall.jar;%JARDIR%\ics.jar set CLASSPATH=%CLASSPATH%;%JAVAHOME%\lib\classes.zip;%DB2HOME%\JAVA\DB2JAVA.ZIP REM ******************************************************************************************** REM Uncomment out the following statement for running EIP Client Application set CLASSPATH=%CLASSPATH%;%JARDIR%\cmbclient30.jar REM ******************************************************************************************** REM Uncomment out the following statement for running Internet Application Toolkit Application REM set CLASSPATH=%CLASSPATH%;%JARDIR%\dtappsvr.jar;%JARDIR%\dtappclt.jar;%JARDIR%\qalmaden.jar;%JARDIR%\netdiver.jar;%JARDIR%\microline.jar REM ******************************************************************************************** REM Uncomment out the following statement for running EIP Administration Application REM set CLASSPATH=%CLASSPATH%;%JARDIR%\cmbfeadm.jar;%JARDIR%\cmbferes.jar;%JARDIR%\sacommon.jar;%JARDIR%\uamanager.jar set INCLUDE=.;%CMBROOT%\include;%JAVAHOME%\include;%JAVAHOME%\include\win32;%INCLUDE% set LIB=.;%CMBROOT%\lib;%JAVAHOME%\lib;%LIB% REM ******************************************************************************************** REM IP/390 environment if not yet set if "%EYPINIFILE%"=="" set EYPINIFILE=%IPHOME%\eypapi.ini if "%LOCPATH%"=="" set LOCPATH=%IPHOME%\locale REM ******************************************************************************************** REM VI/400 environment if not yet set if "%VI400_CONFIG_PATH%"=="" set VI400_CONFIG_PATH=%VI400HOME% if "%VI400_LOG_DATA%"=="" set VI400_LOG_DATA=yes @echo Environment has been setup for using IBM Enterprise Information Portal tools.