(v5.5.10 and later) Providing a Java™ Runtime Environment during upgrade

You must provide a suitable Java environment, which is necessary to run the installers, services, and Java-based clients.

About this task

A Java™ runtime is not included in the FileNet Content Manager installation packages. You must provide a Java environment to run the installers, services, and tools.

If you plan to run applications that use the Content Engine or Process Engine Java APIs, you must also provide a Java environment for those applications. It is not necessary to match the Java environments of the applications and the installers.

Procedure

To enable the installer to find the Java with which it needs to run by searching the locations defined in the PATH environment variable.

  1. Identify the location of the Java executable to be used with the installer. For example, c:\Program Files\IBM\Java80\jre\bin .
    The supported Java environments are listed in this technical notice: https://www.ibm.com/support/pages/node/6846657

    If there is not already a supported Java environment present on the system, download and install one. Versions of the IBM Semeru Runtime Open Edition are freely available from IBM Semuru Runtime Downloads.

    If you plan to install on a system that hosts an application server, you can install with the Java that application server uses. Depending on the component being installed, additional rules apply:
    • Content Platform Engine server

      If your Content Platform Engine server is deployed into a WebSphere® Application Server instance, you must use the IBM Java version 8 that was installed as part of the application server. The file name and location for the Java executable that is mentioned in the below table are placed earlier in the PATH:

    Table 1. Java executable files
    File name (Environment) File Location
    java.exe (Windows) C:\Program Files\IBM\WebSphere\AppServer\java\8.0\jre\bin
    Java™ (Unix) /opt/IBM/WebSphere/AppServer/java/8.0/jre/bin

    If your Content Platform Engine server is deployed into an Oracle WebLogic Server instance, it normally runs with Oracle Java. The Java location for Oracle Java might already be present in the PATH. If not, you should be able to determine the location from the WebLogic startup script. Once you have determined the correct location, add the location earlier in the PATH or move it up if already present in the PATH value.

    • IBM Content Search Services

      The definition of JAVA_HOME must be “in scope” for both the process in which the installer runs and the process in which the server is started. For Windows, if you plan to configure IBM Content Search Services to run as a service, you should define JAVA_HOME in the global (system-wide) environment.

    • Content Platform Engine clients

      The definition of JAVA_HOME must be “in scope” for both the process in which the installer runs and the process in which the client application runs.

    If you are upgrading from V5.5.9 and earlier, you can use the Java that was part of the prior installation that is located in the _cejvm\bin subdirectory of the installation directory. However, in such cases, you need to maintain that Java installation. It is neither updated by the V5.5.10 or any later version installer, nor will updates be provided in any interim fixes.

  2. Make the location of the Java executable the first entry in the PATH environment variable.
  3. Set JAVA_HOME to reference the parent of the bin directory.
    For example, if the Java executable is in c:\Program Files\IBM\Java80\jre\bin, set JAVA_HOME to c:\Program Files\IBM\Java80\jre.

What to do next

Services and runtime components often use the same Java environment provided to run the installers. If the setup procedure is not described sufficiently to run the CE and FileNet Process Engine tools, read the topics about starting the tools that include instructions on how to specify the Java runtime location.

Follow the technote to use other Java environments when you are installing and by using FileNet Content Manager or IBM Content Foundation 5.5.10 or later: https://www.ibm.com/support/pages/node/6846657.