Skip navigation FileNet logo
  Open Client Developer's Guide
  Search  |  Index  |  Glossary   |  
Open menu Overview
Open menu Open Client Architecture
Close menu Developing for Process
  Open menu Process Overview
  Close menu Preparing for Development
    Setup Checklist
    PJAC
    PJAC Files
    Close menu Installing the PDE
      Configuring the JRE
      Starting a Local Process Router
      Close menu Setting Up for JiGlue
        JiGlueand ASP.NET Issues
        Configuring the JiGlue COM Bridge
        JiGlue Java-COM Data Types
        JiGlue Programming Guidelines
  Open menu HTML Step and Launch Processors
  Java Processors
  Component-Integrator Work Performer
  Open menu Deploying Process Applications
Open menu Error and Exception Handling
Open menu Customizing the Framework
Globalization / Localization
Open menu General Information
   

Configuring the Java Runtime Environment (JRE)

Process Java API classes enable Process applications to access Process Engine workflow services. Before you can develop Process applications, you must install and configure the appropriate Java Development Kit(s) (JDK) to provide the JRE. The Process Java runtime APIs are provided in the pw.jar file. However, there are known issues associated with adding this JAR file to your system CLASSPATH.

Subtopics include:

Which JDK To Use

Which JDK to use varies according to your development platform and which FileNet Web application (FileNet Workplace, FileNet Web Services, or FileNet Open Client) you are using. The following table describes JRE/JDK requirements for Open Client:

Important Note: Versions shown in this table may be changed. For the latest information on which versions of software (including JDKs) are supported for Process Services, see the Process Compatibility/Dependency/Server Matrix document, located at http://www.css.filenet.com Web site (go to Product Tech Info > eProcess Services > Products - Compatibility & Dependency > Process Compatibility/Dependency/Hardware Matrix).

Client/Server For FileNet Open Client
Web Client Sun Microsystems JDK 1.4.0
Web Server Use the appropriate Sun Microsystems JDK for the Web server and its OS. (PJAC installs JRE 1.3.1.)
Process Engine server - Windows 2000 platform Sun Microsystems JDK 1.4.0 (installed by the Process Engine installer)
Process Engine server - Solaris platform Sun Microsystems JDK 1.4.0
Process Engine server - HP-UX platform HP JDK 1.3.1
Process Engine server - AIX platform IBM AIX JRE 1.4.1 for AIX 4.3 and higher.

Java SDK Configuration Procedure

On your development system(s), perform the following steps to configure the JRE:

  1. Install the appropriate JDK on your development system (see table above).
  2. On Windows, the default installation directory is <drive>...\jdk1.4.0; on Solaris, etc. <drive>:/j2sdk1.4.0 (for JDK 1.4.0), etc. (The remainder of this procedure assumes a Windows platform.) If you run the PJAC installer for FileNet Open Client, PJAC installs the Sun JDK 1.3.1 to the default directory. As a reminder, remember to add the JDK to your PATH variable.

    Caution: When installing the JDK, be sure to use the default settings. If you change default settings and you are using JRE 1.3.1, the security settings will not be correctly installed by the JDK installer (this is not a problem with JRE 1.4.x). To correct for JRE 1.3.1, make sure that both the <JRE>\bin and the <JRE>\bin\hotspot directories have both Read and Execute privileges assigned for the Users group and that these directories are in your CLASSPATH.

    Important Note: If you are planning to develop Process Java applications for FileNet Open Client with the JiGlue COM Bridge, you must install the JDK in the default directory.

  3. Create a local directory (in any location) called \pe. You will use this directory to hold the Process Development Environment files, including the pw.jar file.
  4. Copy the ...\Developer Files directory (includes the pw.jar file) from the PJAC and Toolkit Installation CD to the new \pe directory.
  5. For information on locating the ...\Developer Files directory on the CD (as well as additional information on the Process Development Environment's contents), see Installing the Process Development Environment - FileNet Open Client

  6. Use one of the three methods indicated in the subsection, Adding JAR Files to CLASSPATH Issues, which follows this step, to avoid conflict issues that can arise when adding these JAR files to your CLASSPATH.

Adding JAR Files to CLASSPATH Issues

A known issue associated with adding the pw.jar file to the system CLASSPATH is that this can cause security conflicts when attempting to run the out-of-the-box Java client applications on your development system. The conflict is caused when, for example, the Process Engine server sends the correct pw.jar, but the CLASSPATH statement forces the client application to use the pw.jar file from the specified location.

If you run the Java Plug-in console on a system attempting to run the out-of-the-box Java client application with the pw.jar file specified in the CLASSPATH, you will receive messages similar to the following:

java.security.AccessControlException:
access denied (java.lang.RuntimePermission modifyThreadGroup)
at java.security.AccessControlContext.checkPermission(Unknown Source)
at java.security.AccessController.checkPermission(Unknown Source)
at java.lang.SecurityManager.checkPermission(Unknown Source)
. . .

There are three ways to get around this behavior. Perform one of the following three workarounds, as is appropriate for your requirements:

  • Specify the pw.jar, etc. locations: Do not add the pw.jar file to the CLASSPATH. Instead, specify the correct location of the pw.jar file at the command line when you compile or run an application. For example, assuming the pw.jar file is located in the c:\jdk1.3.1\process directory, and you wanted to compile MainSample.java, you would cd to the directory containing the MainSample.java file and enter a command similar to (modify for your JDK):
    javac.exe -classpath .;c:\jdk1.3.1\process\pw.jar MainSample.java

    The disadvantage to this approach is that you have to specify the pw.jar file location each time you compile or run the application.

  • Create a batch file: Create a batch file that includes the pw.jar file location in the CLASSPATH variable. This is the recommended approach, unless you are using an IDE (see next bulleted item). For example, your batch file should contain a statement similar to:
  • set CLASSPATH=.;C:\<your directory>\pw.jar;%CLASSPATH%
    where:
    • You have installed the JDK in the default directory.
    • In this case, you are configuring the JDK on a Windows NT/2000 system.
    • You have not already set up the CLASSPATH for your JDK.

Note: The only portion of the CLASSPATH statement specific to Process application development is the location of the pw.jar file. If any of these assumptions are not correct for your development environment, refer to the Sun Microsystems Java Development Kit documentation (http://java.sun.com/) for additional information on setting up the CLASSPATH variable.

  • Use an IDE: Use an Integrated Development Environment (IDE) to compile and run your applications. If you are using an IDE (such as Visual Studio, JBuilder, IntelliJ IDEA), you need not modify the CLASSPATH. Instead of adding the pw.jar file to your system CLASSPATH, add the pw.jar, etc. locations to the specific project CLASSPATH or to the IDE global project setting. Refer to the documentation that came with your specific IDE for additional information.

    Note: If you are using an IDE, and you wish to use the Java Step Processor UI Toolkit Swing-based Java beans and interfaces to create user controls similar to the FileNet sample controls, add vwpanel to your project (the vwpanel.jar file is included with the Process Java Step Processor UI Toolkit). For information on the Process Java Step Processor UI Toolkit, see the Java Step Processor UI Toolkit Overview topic in the Help for Process Developers on the Process Documentation for FileNet Image Manager CD.

Start a Local Process Router

If you are developing on a system other than the Open Client Web server or the Process Engine server, you will need to start a Process router to communicate with the Process Engine. For information, see Starting a Local Process Router.