Java with Oracle E-Business Suite Release 11i

Overview of Using Java with Oracle E-Business Suite Release 11i

Currently, the following versions of Java SE are certified for use with Oracle E-Business Suite Release 11i:
Java SE Version
   
Minimum Version of E-Business Suite 11i
   
Java SE Upgrade Required on HTTP/CP Tier
   
Java SE Upgrade Required on Admin/AD Utilities Tier
   
Java Upgrade Required on Browser
   
Sun Microsystems EOSL Date
6    

11.5.10 CU2 with ATG_PF.H.RUP5 or 11.5.9 CU2 with ATG_PF.H.RUP5
    yes     yes     JInitiator 1.3.1.x or JRE 1.5.0.x    

2010
5.0     11.5.10 CU1     yes     yes     JInitiator 1.3.1.x or JRE 1.5.0.x    

Oct 30, 2009
1.4.2     11.5.9     yes     conditional (see note)     conditional (see note)     Oct 30, 2008
1.3.1     any 11i     yes     optional     optional     December 2006

The latest certified version of Java SE is always recommended. It provides increased stability, performance, scalability, and OS vendor support compared with earlier versions of Java.
Note

Sun and other operating system vendors completed the End of Life process for J2SE 1.3 in December, 2006.  It may be possible for customers to purchase extended support from their operating system vendor for J2SE 1.3 beyond the published End of Life period.

Oracle strongly recommends that all E-Business Suite Release 11i customers upgrade their application tiers to J2SE 5.0 or higher (see Document below) at their earliest convenience.  Although Oracle will continue to provide best-efforts support for J2SE 1.3, subject to available resources and expertise, E-Business Suite Java-related issues that cannot be reproduced on J2SE 5.0 or higher will likely result in a recommendation to upgrade to the latest certified Java release.

Please choose one of the following OracleMetaLink documents for the appropriate Java SE upgrade:

    * Document 1: Using JDK 6 with Oracle E-Business Suite 11i, Release 11.5.10 & 11.5.9
Note

As with all technology upgrades, we recommend applying these instructions on a test instance first to verify that the implementation and customizations work properly, before upgrading any production instances.

The most current version of this document is always maintained as note 300482.1 on OracleMetaLink.

Using JDK Version 6 with Oracle E-Business Suite 11i, Releases 11.5.10

In This Document

    * Overview
    * Obtain and Install JDK 6 on all Application Tier Nodes
    * Obtain Applications Interoperability Patches
    * Prepare the Application Tier for Patching and Apply the Patches
    * Configure all Application Tier Nodes to Support JDK 6
    * Verify the Application Tier Node Configurations
    * Known Issues

The most current version of this document can be obtained in 401561.1

There is a change log at the end of this document.
Section 1: Overview

To find the latest version of Java certified with the E-Business Suite application tier, please see note 300482.1, titled "Overview of Using Java with Oracle E-Business Suite Release 11i". The latest Java version is recommended to provide increased stability, performance, scalability, and OS vendor support compared with earlier versions of Java.
NOTE: This document is only applicable to the internally-integrated Oracle E-Business Suite environment's Homes. For information and patch level requirements on running JDK 6.0 on externally-integrated Oracle Applications Server 10gAS instances, please see note 444462.1" titled, 'Upgrading to Java 6 on Oracle Application Server 10g Release 3 (10.1.3)'.

This procedure describes how to use the Java SE Development Kit (JDK) on the application tier of Oracle E-Business Suite 11i, Release 11.5.10. If another README in a patch included directions to implement this document, then the Java installation used with Oracle E-Business Suite (EBS) must be upgraded to JDK version 6 in order to use that patch.

Prerequisites

JDK 6 is certified for Oracle E-Business Suite 11i with the following minimum patch requirements;

    * Oracle Applications patch 10 (11.5.10) plus Maintenance Pack 11.5.10 CU2 or higher
          o Oracle Applications Technology 11i.ATG_PF.H Rollup 5 (RUP 5) (patch 5473858) or higher.

If you are in the middle of the Maintenance Pack 11.5.10.2 upgrade and have completed the Pre-Update Tasks of "Apply the AD Minipack" and "Update AutoConfig technology stack templates", you need to perform the JDK upgrade steps in this document before applying the corresponding Maintenance Pack and other update tasks. You should skip the following steps:

    * In Section 4 - Step 4.2: Apply 11i.ATG_PF.H.RUP5 or Higher (if required)
          o (11.5.10.2 already contains this release)
    * In Section 5 - Step 5.4: Restart all Application Tier Server Processes
    * All the steps in Section 6: Verify the Application Tier Node Configurations

If the Oracle E-Business Suite Release 11i system uses Oracle Portal 3.0.9.x, then the existing Oracle Portal functionality must be migrated to a standalone Oracle Application Server 10g running an Oracle Portal 10g instance to ensure compatibility with JDK 6 . For more details, please see 223927.1, titled "Oracle 9iAS Integration with Oracle E-Business Suite: Statement of Direction".

As with all technology upgrades, we recommend applying these instructions on a test instance first to verify that the implementation and customizations work properly, before upgrading any production instances.
Conventions

   
Meaning
[JDK60_TOP]     Denotes the top-level directory where the JDK 6 is to be installed.
[APPL_TOP]     Denotes the top-level Applications directory, or $APPL_TOP (%APPL_TOP% on Windows).
[COMMON_TOP]     Denotes the top-level directory containing other directories for files shared across products or used in conjunction with third-party products. Refer to Appendix A of Installing Oracle Applications for more details of this directory.

Replace any usage of these abbreviations with the actual paths for the corresponding components. See the Installing Oracle Applications manual for more information.

It is important to read and understand all tasks described here before running the JDK 6 upgrade.

The most current version of this document can be obtained in note 401561.1.

There is a change log at the end of this document that highlights any significant changes made since the initial release of the document.
Section 2: Obtain and Install JDK 6 on all Application Tier Nodes

The first step requires downloading and installing the new JDK. Some specific configuration changes may be necessary, depending on the operating system used. Follow the procedure below to download and install the new JDK on each application tier node.
Download JDK 6

Oracle E-Business Suite Release 11i is certified with the JDK maintenance releases listed in the table below. Download JDK 6 from the site corresponding to the operating system of the application tier node.
Attention: Download the 32 bit, Java SE Development Kit (JDK), and not the Java Runtime Environment (JRE) , Standard Edition. Do not use the 64-bit version, which is not supported. For maximum stability and supportability, Oracle recommends using the latest available patch release provided by the OS vendor. JDK maintenance releases are denoted by the first digit, which in this case is 6. Using SUN Java as an example, the latest updates of JDK are usually denoted by a fourth set of numbers in the version string, such as 1.6.0_02, or 1.6.0.02, or simply called JDK 6u2.


Operating System     Certified Version     JDK 6.0 Download Location
Sun Solaris (SPARC)     JDK 6u2 or higher     http://java.sun.com/javase/downloads/index.jsp
Linux                     JDK 6u2 or higher       http://java.sun.com/javase/downloads/index.jsp
Windows             JDK 6u2 or higher     http://java.sun.com/javase/downloads/index.jsp
HP/UX     JDK 6.0 (version 6.0.00 or higher)     http://www.hp.com/products1/unix/java/java2/jdkjre6_0/index.html
IBM AIX     JDK 6.0 version SR2 (fileset level 6.0.0.50) with IZ33606 or higher     http://www.ibm.com/developerworks/java/jdk/aix/service.html

The link in the table above directs you to the latest available JDK 6 version. If you wish to install an earlier version, please download it from the Sun Archive site at, http://java.sun.com/products/archive/.

Always review in detail the installation instructions and Release Notes for the vendor's JDK to ensure that the operating system version is supported with JDK 6. Before installing the latest JDK 6, it may be necessary to upgrade to a later, certified version of the operating system, or to apply operating system patches.
Install JDK 6

After downloading JDK 6, follow the installation instructions provided in the package to install the JDK for each application tier node. Make a note of the new JDK 6 installation top-level directory; the full path will be abbreviated as [JDK60_TOP] hereafter.
Note: On Windows, do not install JDK 6 into a directory with a space in its name, such as C:\Program Files, because the space will cause some E-Business Suite programs to work incorrectly. Install JDK 6 into a directory with no spaces, for example /usr/java/JDK60.

Verify the installation was successful with the appropriate command:
On UNIX:

[JDK60_TOP]/bin/java -version

On Windows:
[JDK60_TOP]\bin\java.exe -version
Section 3: Obtain Applications Interoperability Patches

Some E-Business Suite products require minor updates to work correctly with JDK 6. This section lists the required E-Business Suite interoperability patches. Download all of them now to save time later. Then apply them using the instructions in Section 4.
Step 3.1: Obtain and Install the Browser Plug-in

Since the AD utilities will use JDK 6, ensure that the Java version for the browser has been upgraded to JRE 1.5.0.x (Native Plug-in) or higher. We recommend upgrading the plug-in before upgrading the AD utilities to use JDK 6. For details on upgrading the JRE native plug-in, follow the instructions in note 290807.1 titled 'Upgrading Sun JRE (Native Plug-in) with Oracle Applications 11i for Windows Clients'.
Step 3.2: Obtain 11i.ATG_PF.H.RUP5 or Higher (if required)
Note: Skip this step if you have previously applied ATG_PF.H.RUP5 or higher. Go directly to Step 3.3 below.

Download 11i.ATG_PF.H.RUP5, patch 5473858 or higher which contain the required configuration templates to support the JDK 6 upgrade.
Step 3.3: Obtain the JDK 6 Consolidated Patch and other EBS Interoperability Patch(es)

Obtain the following patches and their prerequisites for Oracle Applications 11.5.10CU2:

    * JDK 6 consolidated patch for 11.5.10CU2, patch 5622511
    * Contracts Core patch 5977502

Section 4: Prepare Application Tier Nodes for Patching and Apply the Patches

This section contains instructions on how to prepare all application tier nodes for patching, and how to apply the patches downloaded in Section 3 above. Apply all patches using AutoPatch. The readme.txt file in each patch will contain additional details, including any necessary prerequisite patches.

To prepare the application tier nodes for patching and apply the patches, perform the following steps:
Step 4.1: Stop all Application Tier Server Processes

Stop all applications tier server processes before applying the patches listed in this section. Type the appropriate commands:
On UNIX:

cd $COMMON_TOP/admin/scripts/<CONTEXT_NAME>

adstpall.sh <APPS username/APPS password>

On Windows:

cd %COMMON_TOP%\admin\scripts\<CONTEXT_NAME>

adstpall.cmd <APPS username/APPS password>
(An alternative on Windows is to stop the processes using the Services Control Panel located in Administrative Tools)
Step 4.2: Apply 11i.ATG_PF.H.RUP5 or Higher (if required)

(Skip this step if you have previously applied ATG_PF.H.RUP5 or higher or are running an 11.5.10.2 upgrade (which already contains this version) and go directly to Step 4.3 below)

    * Apply 11i.ATG_PF.H.RUP5 patch 5473858 or higher using AutoPatch.

Step 4.3: Apply JDK 6 Consolidated Patch 5622511 and other EBS Interoperability Patch(es)

Apply the following patches and their prerequisites, using AutoPatch:

    * JDK 6 consolidated patch 5622511
    * Contracts Core patch 5977502

Section 5: Configure all Application Tier Nodes to Support JDK 6

The configuration files in Oracle E-Business Suite Release 11.5.10 are maintained by the AutoConfig infrastructure. This section contains instructions to modify the configuration files using AutoConfig to support JDK 6. For more information about AutoConfig, see Note 165195.1 titled "Using AutoConfig to Manage System Configurations with Oracle Applications 11i".
Note: The steps in this section must be repeated for each [APPL_TOP].
Step 5.1: Execute the JDK 6 Upgrade Script to Update Configuration Files

Run the JDK 6 upgrade script to upgrade the configuration template files for each [APPL_TOP]. Enter the appropriate commands and follow the instructions given by the script:
On UNIX:

txkrun.pl -script=SetJDKCfg -contextfile=$CONTEXT_FILE -runautoconfig=Yes -appspass= <APPS_schema_passwd> -jdktop=[JDK60_TOP]

On Windows:

%ADPERLPRG% %FND_TOP%\bin\txkrun.pl -script=SetJDKCfg -contextfile=%CONTEXT_FILE% -runautoconfig=Yes -jdktop=[JDK60_TOP]

Alternatively, the script can also be run in interactive mode by typing;

On Unix:

txkrun.pl -script=SetJDKCfg

On Windows:

%ADPERLPRG% %FND_TOP%\bin\txkrun.pl -script=SetJDKCfg
(Enter Yes to the question "Run Autoconfig after Migration <Yes/No>?"))
Note: Running AutoConfig requires downtime of the Applications system. If AutoConfig is run as part of this step, skip Step 5.2 below. If there are any errors, correct them and follow the instructions given by the script.
Step 5.2: Run AutoConfig (optional)

If AutoConfig is not run in Step 5.1 above, run it now on each application tier node to update the system configuration to use JDK 6. Otherwise, skip this step and go to Step 5.3.
On UNIX:

$COMMON_TOP/admin/scripts/<CONTEXT_NAME> adautocfg.sh

On Windows:

%COMMON_TOP%\admin\scripts\<CONTEXT_NAME> adautocfg.cmd
Step 5.3: Regenerate the appsborg2.zip File & Product JAR Files

Perform the following procedure to refresh the environment variables by sourcing the appropriate environment file and regenerating the appsborg2.zip file and product JAR files.
Step 5.3.1: Source the Environment File
On Unix:

$APPL_TOP/APPS<CONTEXT_NAME>.env

On Windows:

%APPL_TOP%\envshell.cmd
Step 5.3.2: Regenerate the Jar Files

Run AD Administration, and choose "Generate Product JAR Files" from then" Generate Applications Files" menu to update appsborg2.zip to include the new JDBC Drivers for the JDK 6 library (jdbc14.zip) and to generate the product JAR files.
Note

Even though the product JAR files may have been regenerated during the instructions given in the readme file from TXK AutoConfig Rollup Patch, "Generate product JAR files" must be run again. The JDK 6 upgrade script has updated the JDK 6 specific configuration information for the Applications system. Without regenerating the JAR files, the Applications system will not be configured correctly for use with JDK 6.

Since the AD utilities has been upgraded to use JDK 6, this step will ensure that the jar files are signed with the key store data that is valid for the new version of JDK.
Step 5.4: Restart all Application Tier Server Processes

Restart the application tier server processes using the appropriate commands:
On UNIX:

cd $COMMON_TOP/admin/scripts/<CONTEXT_NAME>

adstrtal.sh <APPS username/APPS password>

On Windows:

cd %COMMON_TOP%\admin\scripts\<CONTEXT_NAME>

adstrtal.cmd <APPS username/APPS password>

(An alternative on Windows is to start the processes using the 'Services Control Panel' located in 'Administrative Tools')

The E-Business Suite system is now configured to use JDK 6. Proceed to Section 6 to perform the verification steps.
Section 6: Verify the Application Tier Node Configurations
Note: The steps in this section must be performed on each application tier node.
Step 6.1: Verify Installations on all Web Server Nodes

Follow these steps to verify that JDK 6 has been successfully installed on all the Web Server node(s):
Step 6.1.1: Run the AOL/J test page from a web browser

Run the AOL/J test page from a web browser using the following URL:-

http://[web server]:[port]/OA_HTML/jsp/fnd/aoljtest.jsp
Step 6.1.2: Follow the instructions given by the JSP page

Once you are logged into the Oracle E-Business Suite database, look at the first page of the resulting pages to see the JDK version and the class path information.

The version should display "1.6.0-x", where x depends on the J2SE 6.0 patch level installed. Also verify that the necessary JDK 6 libraries (i.e. [JDK60_TOP]/lib/dt.jar, [JDK60_TOP]/lib/tools.jar, [JDK60_TOP]/jre/lib/rt.jar, and [JDK60_TOP]/jre/lib/charsets.jar) are included in the CLASSPATH.
Note (Optional): To create a simple JDK test page (without logging in to the Oracle E-Business Suite database), proceed with the following:

1. Change to the OA_HTML directory on the Web server.
2. Using a text editor, create a file called JDKtest.jsp with the following lines:

The JDK version is:<%= System.getProperty("java.version") %>
<p> </p>
The class path is:<%= System.getProperty("java.class.path") %>
3. Access this JSP from a web browser, using the URL:

http://[web server]:[port]/OA_HTML/JDKtest.jsp

The version should display "1.6.0-x", where x depends on the JDK 6 patch level installed. Also verify whether the necessary JDK 6 libraries (i.e.[JDK60_TOP]/lib/dt.jar, [JDK60_TOP]/lib/tools.jar, [JDK60_TOP]/jre/lib/rt.jar, and [JDK60_TOP]/jre/lib/charsets.jar) are included in the CLASSPATH.

The Web server node is now configured to use JDK 6. After a change to the system configuration, it is advisable to log in to Oracle E-Business Suite and carry out some routine tasks to ensure all functionality is as expected.
Step 6.2: Verify Configurations on all Application Tier Nodes

Follow these steps to determine that JDK 6 is running on all the application tier nodes:

Open the $APPL_TOP/admin/adovars.env file and ensure that the environment variables below are defined. Run the following commands to verify that the environment variables ADJVAPRG and AFJVAPRG point to the JDK 6 executable. The CLASSPATH and AF_CLASSPATH environment variables must contain the necessary JDK 6 libraries.

Note: If the AD utilities have not been upgraded to use JDK 6, do not run $ADJVAPRG -version (%ADJVAPRG% -version on Windows) and echo $CLASSPATH (echo %CLASSPATH% on Windows).
On UNIX:

$ADJVAPRG -version
echo $CLASSPATH

$AFJVAPRG -version
echo $AF_CLASSPATH

On Windows:

%ADJVAPRG% -version
echo %CLASSPATH%
%AFJVAPRG% -version
echo %AF_CLASSPATH%
NOTE: The output of the version check should display "Java Version Number: 1.6.0-x", where x depends on the JDK 6 patch level installed. The CLASSPATH and AF_CLASSPATH environment variable must contain the necessary JDK 6 libraries (including [JDK60_TOP]/lib/dt.jar, [JDK60_TOP]/lib/tools.jar, [JDK60_TOP]/jre/lib/rt.jar, and [JDK60_TOP]/jre/lib/charsets.jar).

Log in to E-Business Suite and select the "System Administrator" responsibility. Check the Concurrent/Manager/Administer form and make sure all managers have the corresponding numbers for their actual and target. For more details on how to manage the concurrent managers and the concurrent programs, refer to the chapters Managing Concurrent Programs and Reports and Managing Concurrent Processing in the Oracle Applications System Administrator’s Guide.